aftership 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 816eea3c35b379b4e3cd340278f68a0dcc2ae22d
-  data.tar.gz: 1dfdcd5fd8dc6f96dc8f882c61f0431369cbce52
+  metadata.gz: 33d125b2602fb4ff8ed57a35cabd4b17b0e9dcfd
+  data.tar.gz: f7ecbfeb91774048f79a1b6b9bed8b18267081bb
 SHA512:
-  metadata.gz: 5011017ab482f439d9a7aee133435186d0f162968d7d402326e56c3e8f94b82f2da049c8b4a3f8af72be57e6017f09ba641f466f8fda55877176fa56c6258d73
-  data.tar.gz: 71e62ff576f7f1b0d813bc80381be1da891ad1a9878918c3b57eb795389c8575952e300327847d20475acf3f01c59f93d3cf70a8f9760bcd2ee976f8b99b5de7
+  metadata.gz: 837f6d803d6d1e82a7245871ffaecb0f7c1e01cf67d117f980bb9bfe7237359e373438662984486cfeed9f09284e64cc56279518137578fcdd4c454789c1ecad
+  data.tar.gz: ba8d921f5ef3cc54662d10afa5c230ce8e5aaafd36bb954f70ecafd4310c25c6d4a2ee3f5e5dbd945fd8d953e60ff0034e7ab851daf61e30c3358b4c92cd2505

data/README.md

@@ -9,6 +9,11 @@ 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
+* 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
 

data/lib/aftership/v4/base.rb

@@ -2,46 +2,91 @@ require 'httpclient'
 require 'json'
 
 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 = HTTPClient.new
+      end
 
-				parameters = {
-					:query => query,
-					:body => body.to_json,
-					:header => header
-				}
+      def call
 
-				response = @client.send(http_verb_method, url, parameters)
+        header = {'aftership-api-key' => AfterShip.api_key, 'Content-Type' => 'application/json'}
 
-				if response.body
-					JSON.parse(response.body)
-				else
-					raise(AfterShipError.new('response is nil'))
-				end
+        parameters = {
+            :query => query,
+            :body => body.to_json,
+            :header => header
+        }
 
-			end
+        cf_ray = ''
+        response = nil
 
-			private
+        loop do
+          response = @client.send(http_verb_method, url, parameters)
 
-			def url
-				"#{AfterShip::URL}/v4/#{end_point.to_s}"
-			end
+          if response.headers
+            cf_ray = response.headers['CF-RAY']
+          end
 
-		end
-	end
+
+          if response.body
+            begin
+              response = JSON.parse(response.body)
+              @trial = MAX_TRIAL + 1
+            rescue
+              @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
+                  }
+              }
+            end
+          else
+            response = {
+                :meta => {
+                    :code => 500,
+                    :message => 'Something went wrong on AfterShip\'s end.',
+                    :type => 'InternalError'
+                },
+                :data => {
+                }
+            }
+          end
+
+          break if @trial > MAX_TRIAL
+        end
+
+        response
+      end
+
+      private
+
+      def url
+        "#{AfterShip::URL}/v4/#{end_point.to_s}"
+      end
+
+    end
+  end
 end

data/lib/aftership/v4/courier.rb

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

data/lib/aftership/v4/tracking.rb

@@ -1,80 +1,85 @@
 require File.dirname(__FILE__) + '/base'
 
 module AfterShip
-	module V4
-		class Tracking < AfterShip::V4::Base
+  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
+      def self.create(tracking_number, params = {})
+        if tracking_number.empty? || tracking_number.nil?
+          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
+      #POST /trackings/:slug/:tracking_number/retrack
+      def self.retrack(slug, tracking_number)
+        if slug.empty? || slug.nil? || tracking_number.empty? || tracking_number.nil?
+          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
+      #DELETE /trackings/:slug/:tracking_number
+      def self.delete(slug, tracking_number)
+        if slug.empty? || slug.nil? || tracking_number.empty? || tracking_number.nil?
+          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.blank? || tracking_number.blank?
-					raise ArgumentError.new('slug and tracking_number are required.')
-				end
-				new(:get, "trackings/#{slug}/#{tracking_number}", params).call
-			end
+      #DELETE /trackings/:id
+      def self.delete_by_id(id)
+        if id.empty? || id.nil?
+          raise ArgumentError.new('id is required.')
+        end
+        new(:delete, "trackings/#{id}").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/: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.')
+        end
+        new(:get, "trackings/#{slug}/#{tracking_number}", params).call
+      end
 
-			#GET /trackings
-			def self.get_all(params = {})
-				new(:get, 'trackings', params).call
-			end
+      #GET /trackings/:id
+      def self.get_by_id(id, params = {})
+        if id.empty? || id.nil?
+          raise ArgumentError.new('id is required.')
+        end
+        new(:get, "trackings/#{id}", 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
+      #GET /trackings
+      def self.get_all(params = {})
+        new(:get, 'trackings', params).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
+      #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.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
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: aftership
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.3.0
 platform: ruby
 authors:
 - AfterShip Limited
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-11 00:00:00.000000000 Z
+date: 2015-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.5.2
 - !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
 - !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'
 description: Developed for easy integration with AfterShip
@@ -59,12 +59,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 +75,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.8.7
 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: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Formerly known as aftership_ruby and a wrapper for AfterShip API. Support