Merge pull request #11 from contentstack/improvements

Improvements

Author: ishaileshmishra

AUTHERS.md

@@ -1,4 +1,4 @@
-## Below is a list of people and organizations that have contributed to the
+# Below is a list of people and organizations that have contributed to the
 
 [Contentstack LLC](http://contentstack.com/).
 

CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## `v0.3.0 - Package Improvements`
+
+### __JUN-05-2021__
+
+#### v0.3.0 Package Improvements
+
+- pub dependencies version mismach fixed
+- Included UTF-8 encoding
+- Removed unused dependencies
+
+_______________________
+
 ## `v0.2.0 - Support of IncludeEmbeddedItems()`
 
 ### __APR-05-2021__

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2012 - 2020 Contentstack. All rights reserved.
+Copyright (c) 2012 - 2021 Contentstack. All rights reserved.
 
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

analysis_options.yaml

@@ -31,11 +31,9 @@ linter:
     avoid_unused_constructor_parameters: true
     await_only_futures: true
     camel_case_types: true
-    # prefer_void_to_null: true
     cancel_subscriptions: true
     cascade_invocations: true
     comment_references: true
-    # constant_identifier_names: true
     control_flow_in_finally: true
     directives_ordering: true
     empty_catches: true

coverage.json

@@ -36,7 +36,7 @@ Add this to your package's pubspec.yaml file:
 
 ```dart
 dependencies:
-  contentstack: any
+  contentstack: latest
 ```
 
 You can install packages from the command line:
@@ -60,6 +60,14 @@ To initialize the SDK, specify application context, stack’s API Key, delivery
 import 'package:contentstack/contentstack.dart' as contentstack;
 final stack = contentstack.Stack("apiKey", "deliveryToken", "environment");
 ```
+
+## Initialize  by configuration
+
+```dart
+import 'package:contentstack/contentstack.dart' as contentstack;
+final stack = contentstack.Stack("apiKey", "deliveryToken", "environment", host: 'your_host', branch: 'development');
+```
+
 ## Basic Queries
 
 To retrieve a single entry from a content type use the code snippet given below:

example/example.md

@@ -1,6 +1,7 @@
 import 'dart:async';
 import 'dart:convert';
 
+import 'package:contentstack/constant.dart';
 import 'package:contentstack/contentstack.dart';
 import 'package:contentstack/src/stack.dart';
 import 'package:http/http.dart' as http;
@@ -9,8 +10,6 @@ class HttpClient extends http.BaseClient {
   final http.Client _client;
   final Stack stack;
   final Map<String, String> stackHeaders;
-  // Request timout period 30 Seconds
-  static const timeout = 30;
 
   factory HttpClient(Map<String, String> headers,
       {http.Client client, Stack stack}) {
@@ -29,11 +28,11 @@ class HttpClient extends http.BaseClient {
   }
 
   Future<T> sendRequest<T, K>(Uri uri) async {
-    stackHeaders['Content-Type'] = 'application/json';
-    stackHeaders['X-User-Agent'] = 'contentstack-dart/0.1.1';
+    stackHeaders[CONTENT_TYPE] = CONTENT_TYPE_VALUE;
+    stackHeaders[X_USER_AGENT] = X_USER_AGENT_VALUE;
     final response = await http
         .get(uri, headers: stackHeaders)
-        .timeout(const Duration(seconds: timeout));
+        .timeout(const Duration(seconds: TIMEOUT));
     Object bodyJson;
     try {
       bodyJson = jsonDecode(response.body);
@@ -46,7 +45,8 @@ class HttpClient extends http.BaseClient {
       rethrow;
     }
     if (response.statusCode == 200) {
-      final Map bodyJson = jsonDecode(response.body);
+      // Decode response to Utf8Codec
+      final Map bodyJson = json.decode(utf8.decode(response.bodyBytes));
       if (T == EntryModel && bodyJson.containsKey('entry')) {
         return fromJson<T, K>(bodyJson['entry']);
       } else if (K == EntryModel && bodyJson.containsKey('entries')) {
@@ -61,6 +61,7 @@ class HttpClient extends http.BaseClient {
         return fromJson<T, K>(bodyJson);
       }
     } else {
+      // Response code other than 200
       return bodyJson;
     }
   }

lib/client.dart

@@ -0,0 +1,7 @@
+const SDK_VERSION = '0.3.0';
+const SDK_NAME = 'contentstack-dart';
+const CONTENT_TYPE = 'Content-Type';
+const CONTENT_TYPE_VALUE = 'application/json';
+const X_USER_AGENT = 'X-User-Agent';
+const X_USER_AGENT_VALUE = '$SDK_NAME-v$SDK_VERSION';
+const TIMEOUT = 30;

lib/constant.dart

@@ -1,7 +1,7 @@
 import 'package:json_annotation/json_annotation.dart';
 part 'error.g.dart';
 
-/// If there is something wrong with the API request, 
+/// If there is something wrong with the API request,
 /// Contentstack returns an error.
 /// Learn more about [Errors](https://www.contentstack.com/docs/developers/apis/content-delivery-api/#errors).
 @JsonSerializable(createFactory: true)

lib/src/error/error.dart

@@ -17,6 +17,7 @@ class ImageTransformation {
   final HttpClient client;
   final Map<String, String> queryParameter = <String, String>{};
   final URLQueryParams query = URLQueryParams();
+
   ImageTransformation(this._imageUrl, this.client);
 
   /// The auto function lets you enable the functionality that automates