aftership 4.2.0 → 4.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 816eea3c35b379b4e3cd340278f68a0dcc2ae22d
-  data.tar.gz: 1dfdcd5fd8dc6f96dc8f882c61f0431369cbce52
+SHA256:
+  metadata.gz: b78fa7173ef557fa6c2df76d316a358e2867871758c750b79d7062645ed2f59d
+  data.tar.gz: db3078d7dd058af8c0b1be409e305a153047bfb2af75488bf386e542d84e88f4
 SHA512:
-  metadata.gz: 5011017ab482f439d9a7aee133435186d0f162968d7d402326e56c3e8f94b82f2da049c8b4a3f8af72be57e6017f09ba641f466f8fda55877176fa56c6258d73
-  data.tar.gz: 71e62ff576f7f1b0d813bc80381be1da891ad1a9878918c3b57eb795389c8575952e300327847d20475acf3f01c59f93d3cf70a8f9760bcd2ee976f8b99b5de7
+  metadata.gz: 4ae37ae84e6aaecb78c7afbda1ebc0abeb0090d9b3ae45af345e2ccd94b88d4b2e36b1b1d55994d368e24c65c498f6bdede51a4d8f77fd1840f03ca80eee0dbc
+  data.tar.gz: be2b19159da6451ab0e5f767ffc67a1693b2b9d3e39e1f552b5edeb464c4ad67e9fe78f650e5f5dfa8441a44add1c9003860b651127eaac192730840f3ce2bab

data/README.md

@@ -8,7 +8,32 @@ 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.1+
+
+We suggest all users to upgrade your `aftership` gem to v4.5.1 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.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
 
@@ -31,69 +56,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.1"
+```
 
 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)
 
@@ -102,5 +122,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.1'
 end

data/lib/aftership/v4/base.rb

@@ -1,47 +1,85 @@
-require 'httpclient'
-require 'json'
+require 'faraday'
+require 'faraday_middleware'
 
 module AfterShip
-	module V4
-		class Base
-			class AfterShipError < StandardError;
-			end
-			attr_reader :http_verb_method, :end_point, :query, :body
+  module V4
+    class Base
+      class AfterShipError < StandardError
+      end
+      attr_reader :http_verb_method, :end_point, :query, :body
 
-			def initialize(http_verb_method, end_point, query = {}, body = {})
-				@http_verb_method = http_verb_method
-				@end_point = end_point
-				@query = query
-				@body = body
+      MAX_TRIAL = 3
+      CALL_SLEEP = 3
 
-				@client = HTTPClient.new
-			end
+      def initialize(http_verb_method, end_point, query = {}, body = {})
+        @http_verb_method = http_verb_method
+        @end_point = end_point
+        @query = query
+        @body = body
+        @trial = 0
 
-			def call
-				header = {'aftership-api-key' => AfterShip.api_key, 'Content-Type' => 'application/json'}
+        @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
 
-				parameters = {
-					:query => query,
-					:body => body.to_json,
-					:header => header
-				}
+      def call
+        headers = {
+          'aftership-api-key' => AfterShip.api_key,
+          content_type: 'application/json',
+          user_agent: "aftership-sdk-ruby #{AfterShip::VERSION} (#{RUBY_VERSION})"
+        }
 
-				response = @client.send(http_verb_method, url, parameters)
+        cf_ray = ''
+        output = nil
+        uri = @client.build_url(end_point, query)
+        request_body = body.empty? ? nil : body.to_json
 
-				if response.body
-					JSON.parse(response.body)
-				else
-					raise(AfterShipError.new('response is nil'))
-				end
+        loop do
+          response = @client.run_request(http_verb_method, uri, request_body, headers)
+          cf_ray = response.headers['cf-ray'] if response.headers
 
-			end
+          if response.body
+            # This try catch is actually useless (will improve in next major version.)
+            begin
+              output = response.body
+              @trial = MAX_TRIAL + 1
+            rescue StandardError
+              @trial += 1
 
-			private
+              sleep CALL_SLEEP
 
-			def url
-				"#{AfterShip::URL}/v4/#{end_point.to_s}"
-			end
+              output = {
+                meta: {
+                  code: 500,
+                  message: 'Something went wrong on AfterShip\'s end.',
+                  type: 'InternalError'
+                },
+                data: {
+                  body: response.body,
+                  cf_ray: cf_ray
+                }
+              }
+            end
+          else
+            output = {
+              meta: {
+                code: 500,
+                message: 'Something went wrong on AfterShip\'s end.',
+                type: 'InternalError'
+              },
+              data: {
+              }
+            }
+          end
 
-		end
-	end
+          break if @trial > MAX_TRIAL
+        end
+        output
+      end
+    end
+  end
 end

data/lib/aftership/v4/courier.rb

@@ -1,30 +1,29 @@
 require File.dirname(__FILE__) + '/base'
 
 module AfterShip
-	module V4
-		class Courier < AfterShip::V4::Base
+  module V4
+    class Courier < AfterShip::V4::Base
+      # GET /couriers
+      # Return a list of couriers activated at your AfterShip account.
+      def self.get
+        new(:get, 'couriers').call
+      end
 
-			#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.
+      def self.get_all
+        new(:get, 'couriers/all').call
+      end
 
-			#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.
-			def self.detect(tracking = nil)
-				if tracking == nil
-					raise ArgumentError.new('tracking object is required.')
-				else
-					new(:post, 'couriers/detect', {}, {:tracking => tracking}).call
-				end
-			end
-		end
-	end
+      # 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, 'tracking object is required.'
+        else
+          new(:post, 'couriers/detect', {}, { tracking: tracking }).call
+        end
+      end
+    end
+  end
 end

data/lib/aftership/v4/last_checkpoint.rb

@@ -1,17 +1,15 @@
 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.')
-				else
-					new(:get, "last_checkpoint/#{slug}/#{tracking_number}").call
-				end
-			end
-
-		end
-	end
+  module V4
+    class LastCheckpoint < AfterShip::V4::Base
+      def self.get(slug = '', tracking_number = '')
+        if slug.empty? || tracking_number.empty?
+          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

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

metadata

@@ -1,57 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: aftership
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.5.1
 platform: ruby
 authors:
 - AfterShip Limited
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-11 00:00:00.000000000 Z
+date: 2021-02-08 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.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.2
+        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.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !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
@@ -59,12 +73,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
+- lib/aftership.rb
 - lib/aftership/v4/base.rb
 - lib/aftership/v4/courier.rb
 - lib/aftership/v4/last_checkpoint.rb
 - lib/aftership/v4/tracking.rb
-- lib/aftership.rb
-- README.md
 homepage: https://www.aftership.com
 licenses:
 - MIT
@@ -75,18 +89,17 @@ require_paths:
 - lib
 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:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
 - none
-rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Formerly known as aftership_ruby and a wrapper for AfterShip API. Support