aftership 4.3.1 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fcc3b043085339e0e1cb60f310a933893d00efa4
-  data.tar.gz: 3641f16ac1b4142cfcb2fa69bcca7e7abab61038
+SHA256:
+  metadata.gz: 3511e0822f0b20e5cb61396d89191f215f3dc10ea98b8bd496d756e3992e115b
+  data.tar.gz: fe7997ade299d0171aa4c759b4cae347b342ee7f92d235404880a8661583b920
 SHA512:
-  metadata.gz: 88c9cac67bbf63bc514a033b25198492cf92f547c6b724a9272ec22b777f2772189a1ceedc95e64f760d01b15a91800d4bc432d411608109aa0e00bc544c8072
-  data.tar.gz: e93c3e5e190cc98d6285ed8d5fdf43954371fca422dd3975867ed9f9d929f824c9433729fc0c29c6284da83ef44f6b2258ca92238c9b9235e18f4f1a30f82fae
+  metadata.gz: 5688761bfae46437bab5dba2ca5dd399cdd1bf131dc19401dc00bd09c76507fc980029117f05a4193484fc1dfd57e5444b78b8993eacaba65ba64237526e42c8
+  data.tar.gz: 1d9228cd05c2cc5e2b4d260d33e0aa3c5ff1c9f80169017a89e4eedd8a4d04978b14913df0c1d2e82d1bd742c481646932d47e189f1c6486548a7f0d4ecf2c52

data/README.md

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

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,63 @@ 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 }
 
         cf_ray = ''
-        response = nil
+        output = nil
+        uri = @client.build_url(end_point, query)
 
         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, body, headers)
 
+          cf_ray = response.headers['CF-RAY'] if response.headers
 
           if response.body
             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,43 @@
 --- !ruby/object:Gem::Specification
 name: aftership
 version: !ruby/object:Gem::Version
-  version: 4.3.1
+  version: 4.4.0
 platform: ruby
 authors:
 - AfterShip Limited
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-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.7.1
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.1
+        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
@@ -52,6 +52,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 +91,7 @@ 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:
   - - ">="
@@ -85,8 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - none
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Formerly known as aftership_ruby and a wrapper for AfterShip API. Support