- Changed Credentials class to expect "api_key" as the JSON key, even…

… though the property is "apiKey"

- Added JSON example to README
- Updated package info

CHANGELOG.md

@@ -1,3 +1,8 @@
-## [1.0.0] - 2018-07-13
+## v1.0.1 - 2018-07-14
+
+* Changed Credentials class serializer to use "api_key" as the key name even though the property name is "apiKey"
+* Added JSON example to README
+
+## v1.0.0 - 2018-07-13
 
 * Initial release.

README.md

@@ -5,6 +5,16 @@ The idea behind this package is to provide a simple way to use various credentia
 You can store your API keys, usernames, passwords, etc. in a JSON file that is either listed in your `.gitignore` or completely outside the project directory and load them into this class. You could also retrieve them from other JSON sources.
 
 ## Example
+### credentials.json
+```json
+{
+ "api_key": "YOUR-API-KEY",
+ "username": "yourUsername",
+ "password": "yourPassword"
+}
+```
+
+### Dart code
 ```dart
 import 'package:credentials_helper/credentials_helper.dart';
 

lib/src/credentials.dart

@@ -8,23 +8,19 @@ part 'credentials.g.dart';
 /// Holds various types of credentials
 @JsonSerializable(includeIfNull: false)
 class Credentials extends Object with _$CredentialsSerializerMixin {
+ @JsonKey(name: 'api_key')
  final String apiKey;
 
  final String username;
 
  final String password;
 
  /// Constructs a new [Credentials] object.
- Credentials(
- {
- this.apiKey,
- this.username,
- this.password
- }
- );
+ Credentials({this.apiKey, this.username, this.password});
 
  /// Constructs a new [Credentials] object from a JSON map
- factory Credentials.fromJson(Map<String, dynamic> json) => _$CredentialsFromJson(json);
+ factory Credentials.fromJson(Map<String, dynamic> json) =>
+ _$CredentialsFromJson(json);
 
  /// Constructs a new [Credentials] object from a JSON file
  factory Credentials.fromFile(String fileName) {

pubspec.yaml

@@ -1,6 +1,6 @@
 name: credentials_helper
 description: Provides a helper class to simplify loading credentials from JSON
-version: 1.0.0
+version: 1.0.1
 author: "Herohtar <[email protected]>"
 homepage: https://github.com/herohtar/credentials_helper
 

test/credentials_helper_test.dart

@@ -9,7 +9,7 @@ void main() {
  const String username = 'testUserName';
  const String password = 'testPassword';
  const String fileName = 'test_credentials.json';
- const String jsonString = '{"apiKey":"$apiKey","username":"$username","password":"$password"}';
+ const String jsonString = '{"api_key":"$apiKey","username":"$username","password":"$password"}';
 
  test('tests the default constructor', () {
  Credentials credentials = Credentials(