aftership 4.1.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bd8c2c1d56f929b7428547ca2a26ed0f2ccaf913
-  data.tar.gz: d60ee98fd8c674f9cc08f3049cda733892eec988
+SHA256:
+  metadata.gz: 3511e0822f0b20e5cb61396d89191f215f3dc10ea98b8bd496d756e3992e115b
+  data.tar.gz: fe7997ade299d0171aa4c759b4cae347b342ee7f92d235404880a8661583b920
 SHA512:
-  metadata.gz: 79e2489cd19d91abb55d60ae855d8f7fc02e9e308ebf0d7a68b7b6862cc95b053735cf4a4c7e0af28e4bd85295cf9d9fd80794eefa04bdc3c73f1a118b551534
-  data.tar.gz: a54a20436876fec125d6ab026402a7e5db5df70d6786d0bbdbcbc98cb1cbe82c057b20374cfbf75b0263363491b5e3d9349abbca7adbfaa8d86184159428377d
+  metadata.gz: 5688761bfae46437bab5dba2ca5dd399cdd1bf131dc19401dc00bd09c76507fc980029117f05a4193484fc1dfd57e5444b78b8993eacaba65ba64237526e42c8
+  data.tar.gz: 1d9228cd05c2cc5e2b4d260d33e0aa3c5ff1c9f80169017a89e4eedd8a4d04978b14913df0c1d2e82d1bd742c481646932d47e189f1c6486548a7f0d4ecf2c52

data/README.md

@@ -9,6 +9,16 @@ 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.
 
 ### Changes
+* 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
 
 * 2014-10-31 Pump version to 4.1.0
   - Replaced HTTPI with HTTPClient
@@ -30,7 +40,7 @@ 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"
+    gem "aftership", "~> 4.3.1"
     ```
 
 2. Run bundler
@@ -93,26 +103,12 @@ AfterShip provides an automated way for online merchants to track packages and s
     AfterShip::V4::LastCheckpoint.get('ups', '1ZA6F598D992381375')
 	```
 
-	### V3
-
-    ```
-    require('aftership')
-    AfterShip.api_key = 'YOUR_API_KEY'
-
-    AfterShip::V3::Courier.get
-    AfterShip::V3::Courier.detect('1ZA6F598D992381375')
+## The License (MIT)
 
-    AfterShip::V3::Tracking.create('1ZA6F598D992381375', {'emails' => ['a@abcd.com', 'asdfasdfs@gmail.com']})
-    AfterShip::V3::Tracking.get('ups', '1ZA6F598D992381375')
-    AfterShip::V3::Tracking.get_multi
-    AfterShip::V3::Tracking.update('ups', '1ZA6F598D992381375', {:title => 'Testing'})
-    AfterShip::V3::Tracking.reactivate('ups', '1ZA6F598D992381375')
-    AfterShip::V3::Tracking.delete('ups', '1ZA6F598D992381375')
+Released under the MIT license. See the LICENSE file for the complete wording.
 
-    AfterShip::V3::LastCheckpoint.get('ups', '1ZA6F598D992381375')
 
-    ```
+## Contributor
 
-## The License (MIT)
+- Alex Topalov <me@alextopalov.com>
 
-Released under the MIT license. See the LICENSE file for the complete wording.

data/lib/aftership.rb

@@ -1,9 +1,5 @@
 $:.unshift File.dirname(__FILE__)
 
-require 'aftership/v3/courier'
-require 'aftership/v3/tracking'
-require 'aftership/v3/last_checkpoint'
-
 require 'aftership/v4/courier'
 require 'aftership/v4/tracking'
 require 'aftership/v4/last_checkpoint'
@@ -13,5 +9,5 @@ module AfterShip
     attr_accessor :api_key
   end
 
-  URL = 'https://api.aftership.com'
+  URL = ENV['AFTERSHIP_API_ENDPOINT'] || 'https://api.aftership.com'
 end

data/lib/aftership/v4/base.rb

@@ -1,47 +1,80 @@
-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 }
 
-				response = @client.send(http_verb_method, url, parameters)
+        cf_ray = ''
+        output = nil
+        uri = @client.build_url(end_point, query)
 
-				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, body, headers)
 
-			end
+          cf_ray = response.headers['CF-RAY'] if response.headers
 
-			private
+          if response.body
+            begin
+              output = response.body
+              @trial = MAX_TRIAL + 1
+            rescue StandardError
+              @trial += 1
 
-			def url
-				"#{AfterShip::URL}/v4/#{end_point.to_s}"
-			end
+              sleep CALL_SLEEP
 
-		end
-	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
+
+          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,64 +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.empty?
-					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.empty? || tracking_number.empty?
-					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.empty? || tracking_number.empty?
-					raise ArgumentError.new('slug and tracking_number are required.')
-				end
-				new(:delete, "trackings/#{slug}/#{tracking_number}").call
-			end
-
-			#GET /trackings/:slug/:tracking_number
-			def self.get(slug, tracking_number, params = {})
-				if slug.empty? || tracking_number.empty?
-					raise ArgumentError.new('slug and tracking_number are required.')
-				end
-				new(:get, "trackings/#{slug}/#{tracking_number}", 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.empty? || tracking_number.empty?
-					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.1.0
+  version: 4.4.0
 platform: ruby
 authors:
 - AfterShip Limited
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-31 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.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.5.2
+        version: 1.3.0
 - !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,16 +73,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/aftership/v3/base.rb
-- lib/aftership/v3/courier.rb
-- lib/aftership/v3/last_checkpoint.rb
-- lib/aftership/v3/tracking.rb
+- 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
@@ -79,18 +89,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: 2.4.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

data/lib/aftership/v3/base.rb

@@ -1,47 +0,0 @@
-require 'httpclient'
-require 'json'
-
-module AfterShip
-	module V3
-		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
-
-				@client = HTTPClient.new
-			end
-
-			def call
-				header = {'aftership-api-key' => AfterShip.api_key, 'Content-Type' => 'application/json'}
-
-				parameters = {
-					:query => query,
-					:body => body.to_json,
-					:header => header
-				}
-
-				response = @client.send(http_verb_method, url, parameters)
-
-				if response.body
-					JSON.parse(response.body)
-				else
-					raise(AfterShipError.new('response is nil'))
-				end
-
-			end
-
-			private
-
-			def url
-				"#{AfterShip::URL}/v3/#{end_point.to_s}"
-			end
-
-		end
-	end
-end

data/lib/aftership/v3/courier.rb

@@ -1,21 +0,0 @@
-require File.dirname(__FILE__) + '/base'
-
-module AfterShip
-	module V3
-		class Courier < AfterShip::V3::Base
-
-			def self.get
-				new(:get, 'couriers').call
-			end
-
-			def self.detect(tracking_number = '')
-				if tracking_number.empty?
-					raise ArgumentError.new('tracking_number is required.')
-				else
-					new(:get, "couriers/detect/#{tracking_number}").call
-				end
-			end
-
-		end
-	end
-end

data/lib/aftership/v3/last_checkpoint.rb

@@ -1,17 +0,0 @@
-require File.dirname(__FILE__) + '/base'
-
-module AfterShip
-	module V3
-		class LastCheckpoint < AfterShip::V3::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
-end

data/lib/aftership/v3/tracking.rb

@@ -1,61 +0,0 @@
-require File.dirname(__FILE__) + '/base'
-
-module AfterShip
-	module V3
-		class Tracking < AfterShip::V3::Base
-
-			#POST /trackings
-			def self.create(tracking_number, params = {})
-				if tracking_number.empty?
-					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
-
-			#DELETE /trackings/:slug/:tracking_number
-			def self.delete(slug, tracking_number)
-				if slug.empty? || tracking_number.empty?
-					raise ArgumentError.new('slug and tracking_number are required.')
-				end
-				new(:delete, "trackings/#{slug}/#{tracking_number}").call
-			end
-
-			#GET /trackings
-			def self.get_multi(params = {})
-				new(:get, 'trackings', params).call
-			end
-
-			#GET /trackings/:slug/:tracking_number
-			def self.get(slug, tracking_number, params = {})
-				if slug.empty? || tracking_number.empty?
-					raise ArgumentError.new('slug and tracking_number are required.')
-				end
-				new(:get, "trackings/#{slug}/#{tracking_number}", params).call
-			end
-
-			#PUT /trackings/:slug/:tracking_number
-			def self.update(slug, tracking_number, params = {})
-				if slug.empty? || tracking_number.empty?
-					raise ArgumentError.new('slug and tracking_number are required.')
-				end
-				body = {:tracking => params}
-				new(:put, "trackings/#{slug}/#{tracking_number}", {}, body).call
-			end
-
-			#POST /trackings/:slug/:tracking_number/reactivate
-			def self.reactivate(slug, tracking_number)
-				puts 'This method will be deprecate in AfterShipV4'
-
-				if slug.empty? || tracking_number.empty?
-					raise ArgumentError.new('slug and tracking_number are required.')
-				end
-				new(:post, "trackings/#{slug}/#{tracking_number}/reactivate").call
-			end
-
-		end
-	end
-end