- Updated package info

Author: Herohtar

CHANGELOG.md

@@ -1,3 +1,8 @@
+## [v0.3.2](https://github.com/Herohtar/wordnik-dart/releases/tag/v0.3.2) - 2018-07-14
+
+* Improved example code
+* Added [`credentials_helper`](https://pub.dartlang.org/packages/credentials_helper) to work with the API key more easily
+
 ## [v0.3.1](https://github.com/Herohtar/wordnik-dart/releases/tag/v0.3.1) - 2018-07-11
 
 * Fixed return type for `getEtymologies()`

example/lib/example.dart

@@ -1,12 +1,14 @@
 // These aren't necessary for standard operation of the API;
 // they are only required for the API key import and some of the example code
 import 'dart:math';
-import 'package:credentials/credentials.dart';
+import 'package:credentials_helper/credentials_helper.dart';
 
 // Required imports
 import 'package:wordnik/wordnik.dart';
 
 void main() async {
+  Random random = Random();
+
   // This isn't required, but you'll need to provide the API key in some way
   Credentials credentials = Credentials.fromFile('credentials.json');
 
@@ -42,7 +44,7 @@ void main() async {
   print('The first one is: "${examples.examples.first.text}"\n');
 
   FrequencySummary frequencySummary = await wordnik.getWordFrequency(exampleWord.word);
-  Frequency frequency = frequencySummary.frequency[Random().nextInt(frequencySummary.frequency.length)];
+  Frequency frequency = frequencySummary.frequency[random.nextInt(frequencySummary.frequency.length)];
   print('${frequency.count} occurances from the year ${frequency.year}\n');
 
   List<Syllable> syllables = await wordnik.getHyphenation(exampleWord.word);
@@ -52,7 +54,7 @@ void main() async {
     exampleWord.word,
     limit: 10
   );
-  Bigram bigram = bigrams[Random().nextInt(bigrams.length)];
+  Bigram bigram = bigrams[random.nextInt(bigrams.length)];
   print('You might say "${bigram.gram1} ${bigram.gram2}".\n');
 
   List<TextPron> textProns = await wordnik.getTextPronunciations(exampleWord.word);
@@ -65,8 +67,8 @@ void main() async {
   );
   Related synonyms = relatedWords.firstWhere((word) => word.relationshipType == 'synonym');
   Related rhymes = relatedWords.firstWhere((word) => word.relationshipType == 'rhyme');
-  print('${synonyms.words.length} synonyms found, including "${synonyms.words[Random().nextInt(synonyms.words.length)]}".\n');
-  print('${rhymes.words.length} rhymes found, including "${rhymes.words[Random().nextInt(rhymes.words.length)]}".\n');
+  print('${synonyms.words.length} synonyms found, including "${synonyms.words[random.nextInt(synonyms.words.length)]}".\n');
+  print('${rhymes.words.length} rhymes found, including "${rhymes.words[random.nextInt(rhymes.words.length)]}".\n');
 
   Example example = await wordnik.getTopExample(exampleWord.word);
   print('The top example is: "${example.text}" from ${example.title}.\n');
@@ -128,7 +130,7 @@ void main() async {
 
   List<StringValue> wordsToDelete = List<StringValue>()
     ..add(StringValue(word: exampleWord.word))
-    ..add(StringValue(word: randomAdjectives[Random().nextInt(randomAdjectives.length)].word));
+    ..add(StringValue(word: randomAdjectives[random.nextInt(randomAdjectives.length)].word));
   await wordnik.deleteWordsFromWordList(
     authToken.token,
     createdWordList.permalink,
@@ -137,7 +139,7 @@ void main() async {
   print('Deleted ${wordsToDelete.length} words from "${createdWordList.name}".\n');
 
   WordList modifiedWordList = createdWordList
-    ..description = 'I feel like a ${randomAdjectives[Random().nextInt(randomAdjectives.length)].word} ${randomNoun.word} ${exampleWord.word}.';
+    ..description = 'I feel like a ${randomAdjectives[random.nextInt(randomAdjectives.length)].word} ${randomNoun.word} ${exampleWord.word}.';
   await wordnik.updateWordList(
     authToken.token,
     modifiedWordList.permalink,

example/pubspec.yaml

@@ -5,8 +5,7 @@ environment:
   sdk: ">=2.0.0-dev.58.0 <2.0.0"
 
 dependencies:
-  wordnik: ^0.2.0
+  wordnik: ^0.3.2
 
   # Used for the example, but not required for the API
-  credentials:
-    path: ../../credentials
+  credentials_helper: ^1.0.1

lib/wordnik.dart

@@ -77,7 +77,18 @@ class Wordnik {
 
   Wordnik(this.apiKey);
 
-  Future<String> _queryApi(String resource, String format, String operation, {String extraTerm, Map<String, String> queryParameters, ApiMethods method = ApiMethods.get, dynamic body, String authToken}) async {
+  Future<String> _queryApi(
+    String resource,
+    String format,
+    String operation,
+    {
+      String extraTerm,
+      Map<String, String> queryParameters,
+      ApiMethods method = ApiMethods.get,
+      dynamic body,
+      String authToken
+    }
+  ) async {
     List<String> segments = [
       'v$_apiVersion',
       '$resource.$format',

pubspec.yaml

@@ -1,6 +1,6 @@
 name: wordnik
 description: Wordnik API for Dart
-version: 0.3.1
+version: 0.3.2
 author: "Herohtar <[email protected]>"
 homepage: https://github.com/herohtar/wordnik-dart
 
@@ -13,8 +13,7 @@ dev_dependencies:
   test: ^1.2.0
   build_runner: ^0.9.1
   json_serializable: ^0.5.8
-  credentials:
-    path: ../credentials
+  credentials_helper: ^1.0.1
 
 environment:
   sdk: ">=2.0.0-dev.58.0 <2.0.0"

test/wordnik_test.dart

@@ -1,6 +1,6 @@
 import 'package:test/test.dart';
 import 'package:wordnik/wordnik.dart';
-import 'package:credentials/credentials.dart';
+import 'package:credentials_helper/credentials_helper.dart';
 
 void main() {
   Credentials credentials;