aftership 4.3.0 → 4.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 33d125b2602fb4ff8ed57a35cabd4b17b0e9dcfd
-  data.tar.gz: f7ecbfeb91774048f79a1b6b9bed8b18267081bb
+SHA256:
+  metadata.gz: 603b40007c2133ca42f0b9e18a84f08503946d862675f4a65741b2bc38f93ce0
+  data.tar.gz: 71eeb5782f1aab8d2dc55a003e18aabd449d92e68d9ee661447d8f6b7119157e
 SHA512:
-  metadata.gz: 837f6d803d6d1e82a7245871ffaecb0f7c1e01cf67d117f980bb9bfe7237359e373438662984486cfeed9f09284e64cc56279518137578fcdd4c454789c1ecad
-  data.tar.gz: ba8d921f5ef3cc54662d10afa5c230ce8e5aaafd36bb954f70ecafd4310c25c6d4a2ee3f5e5dbd945fd8d953e60ff0034e7ab851daf61e30c3358b4c92cd2505
+  metadata.gz: 15a3837d5e7b0921478665bf58467177a17c74848c995d79d63ac752ca417758f0cb3dd5258add15699c7251906b89fc13a8cece1d56d208ef13a4e69deb7a22
+  data.tar.gz: 680fb873eadb5f15b080109bae58685b21b0bab7f9561b94876d2390c497525ba04a43b394a78eb54172260a9b0512b200da0f524281436bccb75fa17a817e3f

data/README.md

@@ -8,12 +8,42 @@ 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.2+
+
+We suggest all users to upgrade your `aftership` gem to v4.5.2 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.
+
+If you want to use recent versions of Faraday, update your Gemfile as below:
+
+```ruby
+gem "aftership", "~> 4.5.2"
+gem 'faraday', '~> 1.3.0'
+```
+
 ### Changes
+* 2021-02-08 4.5.2
+  - Merged [#39](https://github.com/AfterShip/aftership-sdk-ruby/pull/39): Add compatibility for recent versions of Faraday
+
+* 2021-02-08 4.5.1
+  - Resolved [#31](https://github.com/AfterShip/aftership-sdk-ruby/issues/31): Deprecation of encryption algorithms below 256 bits
+
+* 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
+  - Required ruby version updated to 2.4.0+
+
+* 2016-01-11 4.3.1
+  - Updated gem `httpclient` version to 2.7.1
+
 * 2015-12-14 4.3.0
   - Added rescue methods for parsing JSON, and try to retrieve error codes from cloudflare
   - Added /trackings/exports method
   - Added auto-retry mechanism if invalid JSON response retrieved
-
+  
 * 2015-11-11 Pump version to 4.2.0
   - Removed v3 code, support ENV variable AFTERSHIP_API_ENDPOINT for testing
 
@@ -36,69 +66,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.1.0"
-    ```
+```ruby
+gem "aftership", "~> 4.5.2"
+```
 
 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)
 
@@ -107,5 +132,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.2'
 end

data/lib/aftership/v4/base.rb

@@ -1,10 +1,10 @@
-require 'httpclient'
-require 'json'
+require 'faraday'
+require 'faraday_middleware'
 
 module AfterShip
   module V4
     class Base
-      class AfterShipError < StandardError;
+      class AfterShipError < StandardError
       end
       attr_reader :http_verb_method, :end_point, :query, :body
 
@@ -18,75 +18,68 @@ module AfterShip
         @body = body
         @trial = 0
 
-        @client = HTTPClient.new
+        @client = Faraday.new do |faraday|
+          faraday.url_prefix = "#{AfterShip::URL}/v4/"
+          faraday.request :url_encoded
+          faraday.response :json, content_type: 'application/json'
+          faraday.adapter :net_http
+        end
       end
 
       def call
-
-        header = {'aftership-api-key' => AfterShip.api_key, 'Content-Type' => 'application/json'}
-
-        parameters = {
-            :query => query,
-            :body => body.to_json,
-            :header => header
+        headers = {
+          'aftership-api-key' => AfterShip.api_key,
+          content_type: 'application/json',
+          user_agent: "aftership-sdk-ruby #{AfterShip::VERSION} (#{RUBY_VERSION})"
         }
 
         cf_ray = ''
-        response = nil
+        output = nil
+        uri = @client.build_url(end_point, query)
+        request_body = body.empty? ? nil : body.to_json
 
         loop do
-          response = @client.send(http_verb_method, url, parameters)
-
-          if response.headers
-            cf_ray = response.headers['CF-RAY']
-          end
-
+          response = @client.run_request(http_verb_method, uri, request_body, 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
-              response = JSON.parse(response.body)
+              output = response.body
               @trial = MAX_TRIAL + 1
-            rescue
+            rescue StandardError
               @trial += 1
 
               sleep CALL_SLEEP
 
-              response = {
-                  :meta => {
-                      :code => 500,
-                      :message => 'Something went wrong on AfterShip\'s end.',
-                      :type => 'InternalError'
-                  },
-                  :data => {
-                      :body => response.body,
-                      :cf_ray => cf_ray
-                  }
+              output = {
+                meta: {
+                  code: 500,
+                  message: 'Something went wrong on AfterShip\'s end.',
+                  type: 'InternalError'
+                },
+                data: {
+                  body: response.body,
+                  cf_ray: cf_ray
+                }
               }
             end
           else
-            response = {
-                :meta => {
-                    :code => 500,
-                    :message => 'Something went wrong on AfterShip\'s end.',
-                    :type => 'InternalError'
-                },
-                :data => {
-                }
+            output = {
+              meta: {
+                code: 500,
+                message: 'Something went wrong on AfterShip\'s end.',
+                type: 'InternalError'
+              },
+              data: {
+              }
             }
           end
 
           break if @trial > MAX_TRIAL
         end
-
-        response
+        output
       end
-
-      private
-
-      def url
-        "#{AfterShip::URL}/v4/#{end_point.to_s}"
-      end
-
     end
   end
 end

data/lib/aftership/v4/courier.rb

@@ -3,26 +3,25 @@ require File.dirname(__FILE__) + '/base'
 module AfterShip
   module V4
     class Courier < AfterShip::V4::Base
-
-      #GET /couriers
-      #Return a list of couriers activated at your AfterShip account.
+      # GET /couriers
+      # Return a list of couriers activated at your AfterShip account.
       def self.get
         new(:get, 'couriers').call
       end
 
-      #GET /couriers/all
-      #Return a list of all couriers.
+      # GET /couriers/all
+      # Return a list of all couriers.
       def self.get_all
         new(:get, 'couriers/all').call
       end
 
-      #POST /couriers/detect
-      #Return a list of matched couriers based on tracking number format and selected couriers or a list of couriers.
+      # POST /couriers/detect
+      # Return a list of matched couriers based on tracking number format and selected couriers or a list of couriers.
       def self.detect(tracking = nil)
-        if tracking == nil
-          raise ArgumentError.new('tracking object is required.')
+        if tracking.nil?
+          raise ArgumentError, 'tracking object is required.'
         else
-          new(:post, 'couriers/detect', {}, {:tracking => tracking}).call
+          new(:post, 'couriers/detect', {}, { tracking: tracking }).call
         end
       end
     end

data/lib/aftership/v4/last_checkpoint.rb

@@ -3,15 +3,13 @@ require File.dirname(__FILE__) + '/base'
 module AfterShip
   module V4
     class LastCheckpoint < AfterShip::V4::Base
-
       def self.get(slug = '', tracking_number = '')
         if slug.empty? || tracking_number.empty?
-          raise ArgumentError.new('slug and tracking_number are required.')
+          raise ArgumentError, 'slug and tracking_number are required.'
         else
           new(:get, "last_checkpoint/#{slug}/#{tracking_number}").call
         end
       end
-
     end
   end
 end

data/lib/aftership/v4/tracking.rb

@@ -3,82 +3,83 @@ require File.dirname(__FILE__) + '/base'
 module AfterShip
   module V4
     class Tracking < AfterShip::V4::Base
-
-      #POST /trackings
+      # POST /trackings
       def self.create(tracking_number, params = {})
         if tracking_number.empty? || tracking_number.nil?
-          raise ArgumentError.new('tracking_number is required.')
+          raise ArgumentError, 'tracking_number is required.'
         else
-          query_hash = {:tracking_number => tracking_number}
+          query_hash = { tracking_number: tracking_number }
           query_hash.merge!(params)
-          body = {:tracking => query_hash}
+          body = { tracking: query_hash }
           new(:post, 'trackings', {}, body).call
         end
       end
 
-      #POST /trackings/:slug/:tracking_number/retrack
-      def self.retrack(slug, tracking_number)
+      # POST /trackings/:slug/:tracking_number/retrack
+      def self.retrack(slug, tracking_number, params = {})
         if slug.empty? || slug.nil? || tracking_number.empty? || tracking_number.nil?
-          raise ArgumentError.new('slug and tracking_number are required.')
+          raise ArgumentError, 'slug and tracking_number are required.'
         end
-        new(:post, "trackings/#{slug}/#{tracking_number}/retrack").call
+
+        new(:post, "trackings/#{slug}/#{tracking_number}/retrack", params).call
       end
 
-      #DELETE /trackings/:slug/:tracking_number
-      def self.delete(slug, tracking_number)
+      # DELETE /trackings/:slug/:tracking_number
+      def self.delete(slug, tracking_number, params = {})
         if slug.empty? || slug.nil? || tracking_number.empty? || tracking_number.nil?
-          raise ArgumentError.new('slug and tracking_number are required.')
+          raise ArgumentError, 'slug and tracking_number are required.'
         end
-        new(:delete, "trackings/#{slug}/#{tracking_number}").call
+
+        new(:delete, "trackings/#{slug}/#{tracking_number}", params).call
       end
 
-      #DELETE /trackings/:id
+      # DELETE /trackings/:id
       def self.delete_by_id(id)
-        if id.empty? || id.nil?
-          raise ArgumentError.new('id is required.')
-        end
+        raise ArgumentError, 'id is required.' if id.empty? || id.nil?
+
         new(:delete, "trackings/#{id}").call
       end
 
-      #GET /trackings/:slug/:tracking_number
+      # GET /trackings/:slug/:tracking_number
       def self.get(slug, tracking_number, params = {})
         if slug.empty? || slug.nil? || tracking_number.empty? || tracking_number.nil?
-          raise ArgumentError.new('slug and tracking_number are required.')
+          raise ArgumentError, 'slug and tracking_number are required.'
         end
+
         new(:get, "trackings/#{slug}/#{tracking_number}", params).call
       end
 
-      #GET /trackings/:id
+      # GET /trackings/:id
       def self.get_by_id(id, params = {})
-        if id.empty? || id.nil?
-          raise ArgumentError.new('id is required.')
-        end
+        raise ArgumentError, 'id is required.' if id.empty? || id.nil?
+
         new(:get, "trackings/#{id}", params).call
       end
 
-      #GET /trackings
+      # GET /trackings
       def self.get_all(params = {})
         new(:get, 'trackings', params).call
       end
 
-      #GET /trackings/exports
+      # GET /trackings/exports
       def self.export(params = {})
         new(:get, 'trackings/exports', params).call
       end
 
-      #PUT /trackings/:slug/:tracking_number
+      # PUT /trackings/:slug/:tracking_number
       def self.update(slug, tracking_number, params = {})
         if slug.empty? || slug.nil? || tracking_number.empty? || tracking_number.nil?
-          raise ArgumentError.new('slug and tracking_number are required.')
+          raise ArgumentError, 'slug and tracking_number are required.'
         end
-        body = {:tracking => params}
+
+        body = { tracking: params }
         new(:put, "trackings/#{slug}/#{tracking_number}", {}, body).call
       end
 
-      #Deprecated
-      #POST /trackings/:slug/:tracking_number/reactivate
-      def self.reactivate(slug, tracking_number)
-        raise StandardError.new('This method is deprecated, please use "retrack" instead')
+      # Deprecated
+      # POST /trackings/:slug/:tracking_number/reactivate
+      def self.reactivate(_slug, _tracking_number)
+        raise StandardError, 'This method is deprecated, please use "retrack" instead'
       end
     end
   end

metadata

@@ -1,43 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: aftership
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.5.2
 platform: ruby
 authors:
 - AfterShip Limited
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-15 00:00:00.000000000 Z
+date: 2021-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httpclient
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.2
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.2
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
-  type: :development
+        version: '1.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +58,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
 description: Developed for easy integration with AfterShip
 email:
 - support@aftership.com
@@ -77,7 +97,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -85,8 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - none
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Formerly known as aftership_ruby and a wrapper for AfterShip API. Support