aftership 4.4.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3511e0822f0b20e5cb61396d89191f215f3dc10ea98b8bd496d756e3992e115b
-  data.tar.gz: fe7997ade299d0171aa4c759b4cae347b342ee7f92d235404880a8661583b920
+  metadata.gz: e290f58d38534b293261b1dcc9bdde6c4db06663c73eebc277db93939533f173
+  data.tar.gz: 4a848b707e8a6dd8c56130f8937a93e70f9d04b094911b844e1167bcd92d3266
 SHA512:
-  metadata.gz: 5688761bfae46437bab5dba2ca5dd399cdd1bf131dc19401dc00bd09c76507fc980029117f05a4193484fc1dfd57e5444b78b8993eacaba65ba64237526e42c8
-  data.tar.gz: 1d9228cd05c2cc5e2b4d260d33e0aa3c5ff1c9f80169017a89e4eedd8a4d04978b14913df0c1d2e82d1bd742c481646932d47e189f1c6486548a7f0d4ecf2c52
+  metadata.gz: 27e51d324f901739b724e28a3e51416c51c8a46404b56d43cfae82a421fb6f99fcb15e263f5340efdd265c0bc9a178b0b90f0b286d85351ed4ba0d1755b4c9ce
+  data.tar.gz: 9302f3835df2bf1dbf80b4ab7bad7b598fe7aff0a8cc1afb2fa6106f60c04ee437e32f06224cc705ecbc38df14196f55b6728cb51dd60569eed36dce402267b9

data/README.md

@@ -8,7 +8,22 @@ This extension helps developers to integrate with AfterShip easily.
 
 AfterShip provides an automated way for online merchants to track packages and send their customers delivery status notifications. Customers no longer need to deal with tracking numbers and track packages on their own. With AfterShip, online merchants extend their customer service after the point of purchase by keeping their customers actively informed, while saving time and money by reducing customers’ questions about the status of their purchase delivery.
 
+## Migration to 4.5.0+
+
+We suggest all users to upgrade your `aftership` gem to v4.5.0 as any earlier versions are NOT maintained, which also means you will need to upgrade your ruby version to at least 2.3.0 to be able to use `faraday` the new http client of the revamped `aftership` gem.
+
 ### Changes
+* 2021-02-08 4.5.0
+  - Downgraded `faraday` to `1.0.1` that accepts ruby 2.3.0+ as required version.
+  - Updated request User agent to follow AfterShip SDK guideline.
+  - Required ruby version is now 2.3.0+
+
+* 2021-02-08 4.4.0
+  - Removed `httpclient` and used `faraday` 1.3 as http client
+  - Polished project with prettified formatting
+  - Resolved [#31](https://github.com/AfterShip/aftership-sdk-ruby/issues/31): Deprecation of encryption algorithms below 256 bits
+  - Required ruby version updated to 2.4.0+
+
 * 2016-01-11 4.3.1
   - Updated gem `httpclient` version to 2.7.1
 
@@ -39,69 +54,64 @@ AfterShip provides an automated way for online merchants to track packages and s
 
 1. Add the following line to your application's Gemfile
 
-    ```
-    gem "aftership", "~> 4.3.1"
-    ```
+```ruby
+gem "aftership", "~> 4.5"
+```
 
 2. Run bundler
 
-    ```
-    bundle install
-    ```
+```shell
+bundle install
+```
 
 ## Configuration
 
 1. Before you begin
 
-    You'll need to have a AfterShip account
-
-    http://www.aftership.com
+You'll need to have a AfterShip account: http://www.aftership.com
 
 
 2. Setup the API Key
 
-    You can retrieve your api key at
-
-    https://www.aftership.com/apps/api
+You can retrieve your api key at: https://admin.aftership.com/settings/api-keys
 
 ## Usage
 
 1. Setup
-    Before using API, please include the gem in your script
+    
+Before using API, please include the gem in your script.
 
-	```
-	require 'rubygems'
-	require 'aftership'
-	```
+```ruby
+require 'rubygems'
+require 'aftership'
+```
 
-    You should set you API key before making any request to AfterShip.
+You should set you API key before making any request to AfterShip.
 
-	```
-	AfterShip.api_key = 'YOUR_API_KEY' #Replace "YOUR_API_KEY" to your AfterShip api key.
-	```
+```ruby
+AfterShip.api_key = 'YOUR_API_KEY' # Replace "YOUR_API_KEY" to your AfterShip api key.
+```
 
 
 2. Coding
 
+```ruby
+require('aftership')
+AfterShip.api_key = 'YOUR_API_KEY'
 
-	### V4
-	```
- 	require('aftership')
-    AfterShip.api_key = 'YOUR_API_KEY'
-
-    AfterShip::V4::Courier.get
-    AfterShip::V4::Courier.get_all
-    AfterShip::V4::Courier.detect({:tracking_number => 'EJ276142450JP'})
+AfterShip::V4::Courier.get
+AfterShip::V4::Courier.get_all
+AfterShip::V4::Courier.detect({:tracking_number => 'EJ276142450JP'})
 
-    AfterShip::V4::Tracking.create('1ZA6F598D992381375', {:emails => ['a@abcd.com', 'asdfasdfs@gmail.com']})
-    AfterShip::V4::Tracking.get('ups', '1ZA6F598D992381375')
-    AfterShip::V4::Tracking.get_all
-    AfterShip::V4::Tracking.update('ups', '1ZA6F598D992381375', {:title => 'Testing'})
-    AfterShip::V4::Tracking.retrack('ups', '1ZA6F598D992381375')
-    AfterShip::V4::Tracking.delete('ups', '1ZA6F598D992381375')
+AfterShip::V4::Tracking.create('1ZA6F598D992381375', {:emails => ['a@abcd.com', 'asdfasdfs@gmail.com']})
+AfterShip::V4::Tracking.get('ups', '1ZA6F598D992381375')
+AfterShip::V4::Tracking.get_all
+AfterShip::V4::Tracking.update('ups', '1ZA6F598D992381375', {:title => 'Testing'})
+AfterShip::V4::Tracking.retrack('ups', '1ZA6F598D992381375')
+AfterShip::V4::Tracking.delete('ups', '1ZA6F598D992381375')
 
-    AfterShip::V4::LastCheckpoint.get('ups', '1ZA6F598D992381375')
-	```
+AfterShip::V4::LastCheckpoint.get('ups', '1ZA6F598D992381375')
+```
 
 ## The License (MIT)
 
@@ -110,5 +120,6 @@ Released under the MIT license. See the LICENSE file for the complete wording.
 
 ## Contributor
 
+- Ryan Zou [twitter:renyuanz](https://twitter.com/ry_zou)
 - Alex Topalov <me@alextopalov.com>
 

data/lib/aftership.rb

@@ -5,9 +5,10 @@ require 'aftership/v4/tracking'
 require 'aftership/v4/last_checkpoint'
 
 module AfterShip
-  class << self;
+  class << self
     attr_accessor :api_key
   end
 
   URL = ENV['AFTERSHIP_API_ENDPOINT'] || 'https://api.aftership.com'
+  VERSION = '4.5.0'
 end

data/lib/aftership/v4/base.rb

@@ -27,18 +27,23 @@ module AfterShip
       end
 
       def call
-        headers = { 'aftership-api-key' => AfterShip.api_key }
+        headers = {
+          'aftership-api-key' => AfterShip.api_key,
+          content_type: 'application/json',
+          user_agent: "aftership-sdk-ruby #{AfterShip::VERSION} (#{RUBY_VERSION})"
+        }
 
         cf_ray = ''
         output = nil
         uri = @client.build_url(end_point, query)
 
         loop do
-          response = @client.run_request(http_verb_method, uri, body, headers)
+          response = @client.run_request(http_verb_method, uri, body.to_json, headers)
 
-          cf_ray = response.headers['CF-RAY'] if response.headers
+          cf_ray = response.headers['cf-ray'] if response.headers
 
           if response.body
+            # This try catch is actually useless (will improve in next major version.)
             begin
               output = response.body
               @trial = MAX_TRIAL + 1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aftership
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.5.0
 platform: ruby
 authors:
 - AfterShip Limited
@@ -14,28 +14,28 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
@@ -91,7 +91,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="