aftership 1.0.3 → 3.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTU5ZDMxZjI0NWY3NWNkYjgxODM5YWM5NzMzZGY2YjIwOTliNzg2YQ==
+    YzUzZTRkZWFkYWJlNjIyYmEwNzU0MWY3NTcyZTdiOTJmZDg4ODVkOA==
   data.tar.gz: !binary |-
-    NDgyNGRlZThlNmViMzhlN2VjOWE5YmJmZTBmY2UxNzhlODM0YTIxZA==
-!binary "U0hBNTEy":
+    NTU5ODdmOWVlZDdlMWM3NjI0ZTY1MWZlYzBlYTE0YTc1MDQ3OGVmYg==
+SHA512:
   metadata.gz: !binary |-
-    ODgzMmY3NjBkMzU4ZDVkNGM5ODliYWZjNGQyNThkOWQ0YjdmZjg0Y2QwYzFi
-    Mjc0NTk4YzY5OTk2NzYzMzRjZDE0NjljNWFiMDYyMzcyMzZmOTQzM2IzY2M1
-    YzAyZjk1YWUzYTBkZWI5ODkwNjA5NmU5YjdjNGM1MDhhMjA0NmI=
+    NmNiMjBhMmYzMTAzMjE3NDBhNGE5MDI5NGM2NDE2ODU0ODFjYjE2OWQxY2Ey
+    ZTgxZDI3ZDdhZWZhMTVhODJlZTU0NzYyNWY1ZjJkNTYwN2I2YzFlNDJmYjJj
+    ODk2ODRlNjFmMGY1NWU4YzQzYWNmYTdmMzY0MDhjNjgyM2U2ZmY=
   data.tar.gz: !binary |-
-    ZWJhYzYxM2ZlZjA5YTFlMzJlMzhiMDkyMjdmZjk0MWFmMWJjOGUxMjBkNTIy
-    MTI5M2NjYzE3ZTE5ZmIwYmU5ZTVmMTkwODBkMTdiNDI5YmQ5YjU5NTcwODY3
-    ZWRkMjgyNmM0YmRlY2QyMDExMDJkZThkYzFmODc5MDNiNmZmMzU=
+    NGRmMjEzY2JlYmI4MGY4ZDAzNTE5OTUzZDM4ZWNlYmNmMzQ2NDJkYzUzZjNi
+    ZGVhNjE4MzM1NzQwMTc2NDc1YTQzNTY5OWI5NTY5NzM5ZTk3ZWZlYzgzY2Rj
+    NjM0ZWQ1MjI3ZjE0ZTFiNjNjODFkNjVjMGM4MDBmNDRhODNmM2Y=

data/lib/aftership.rb

@@ -2,13 +2,12 @@ $:.unshift File.dirname(__FILE__)
 
 require "aftership/courier"
 require "aftership/tracking"
+require "aftership/last_checkpoint"
 
 module AfterShip
   class << self;
     attr_accessor :api_key
   end
 
-  VERSION = "2"
   URL = "https://api.aftership.com"
-  FORMAT = "json"
 end

data/lib/aftership/base.rb

@@ -4,25 +4,31 @@ require 'json'
 HTTPI.log = false
 
 module AfterShip
-  module V2
+  module V3
     class Base
-      def self.call(http_verb_method, *args)
-        url = "#{AfterShip::URL}/v#{AfterShip::VERSION}/#{args.first.to_s}.#{AfterShip::FORMAT}"
-        req_body = {:api_key => AfterShip.api_key}
-        if args.last.is_a?(Hash)
-          args.last.each do |k, v|
-            HTTPI.logger.warn("this field #{k} should be array") if %w(emails smses).include?(k.to_s) && !v.is_a?(Array)
-          end
 
-          opt = {}
-          args.last.each {|k, v| v.is_a?(Array) ? opt["#{k}[]"] = v : opt[k] = v}
-          req_body.merge!(opt)
+      def self.call(http_verb_method, end_point, params = {}, body = {})
+        url = "#{AfterShip::URL}/v3/#{end_point.to_s}"
+        unless params.empty?
+          url += '?' + Rack::Utils.build_query(params)
+        end
+
+        unless body.empty?
+          body.each do |k, v|
+            HTTPI.logger.warn("the #{k} field  should be an array") if %w(emails smses).include?(k.to_s) && !v.is_a?(Array)
+          end
         end
 
         request = HTTPI::Request.new(url)
-        request.body = req_body
+        request.headers = {"aftership-api-key" => AfterShip.api_key}
+        request.body = body.to_json
+
+        puts "request"
+        puts request.url
+
         response = HTTPI.send(http_verb_method.to_sym, request)
 
+        # different
         if response.nil?
           raise(AfterShipError.new("response is nil"))
         else
@@ -31,6 +37,7 @@ module AfterShip
       end
 
       class AfterShipError < StandardError;
+
       end
     end
   end

data/lib/aftership/courier.rb

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

data/lib/aftership/last_checkpoint.rb

@@ -0,0 +1,17 @@
+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
+          call(:get, "last_checkpoint/#{slug}/#{tracking_number}")
+        end
+      end
+
+    end
+  end
+end

data/lib/aftership/tracking.rb

@@ -1,26 +1,59 @@
 require File.dirname(__FILE__) + '/base'
 
 module AfterShip
-  module V2
-    class Tracking < AfterShip::V2::Base
-      def self.create(tracking_number, courier, opt = {})
-        if tracking_number.empty? || courier.empty?
-          raise ArgumentError.new("both tracking_number and courier are necessary for this method call")
+  module V3
+    class Tracking < AfterShip::V3::Base
+
+      #POST /trackings
+      def self.create(tracking_number, params = {})
+        if tracking_number.empty?
+          raise ArgumentError.new("The tracking_number is required.")
+        else
+          query_hash = {:tracking_number => tracking_number}
+          query_hash.merge!(params)
+          body = {:tracking => query_hash}
+          call(:post, "trackings", {}, body)
+        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
+        call(:delete, "trackings/#{slug}/#{tracking_number}")
+      end
 
-        query_hash = {:tracking_number => tracking_number, :courier => courier}
-        query_hash.merge!(opt)
-        call(:post, "trackings", query_hash)
+      #GET /trackings
+      def self.get_multi(params = {})
+        call(:get, "trackings", params)
       end
 
-      def self.get(tracking_number, courier)
-        if tracking_number.empty? || courier.empty?
-          raise ArgumentError.new("both tracking_number and courier are necessary for this method call")
+      #GET /trackings/:slug/:tracking_number
+      def self.get(slug, tracking_number)
+        if slug.empty? || tracking_number.empty?
+          raise ArgumentError.new("slug and tracking_number are required.")
         end
+        call(:get, "trackings/#{slug}/#{tracking_number}")
+      end
 
-        query_hash = {:tracking_number => tracking_number, :courier => courier}
-        call(:get, "trackings", query_hash)
+      #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}
+        call(:put, "trackings/#{slug}/#{tracking_number}", {}, body)
       end
+
+      #POST /trackings/:slug/:tracking_number/reactivate
+      def self.reactivate(slug, tracking_number)
+        if slug.empty? || tracking_number.empty?
+          raise ArgumentError.new("slug and tracking_number are required.")
+        end
+        call(:post, "trackings/#{slug}/#{tracking_number}/reactivate")
+      end
+
     end
   end
 end

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: aftership
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 3.0.0
 platform: ruby
 authors:
-- LU Wenlong
+- AfterShip.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-27 00:00:00.000000000 Z
+date: 2014-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 description: Developed for easy integration with AfterShip
-email: wllu@aftership.com
+email: support@aftership.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -33,9 +33,11 @@ files:
 - lib/aftership.rb
 - lib/aftership/base.rb
 - lib/aftership/courier.rb
+- lib/aftership/last_checkpoint.rb
 - lib/aftership/tracking.rb
-homepage: http://www.aftership.com
-licenses: []
+homepage: https://www.aftership.com
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -54,8 +56,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - none
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Formerly known as aftership_ruby and a wrapper for AfterShip API
+summary: Formerly known as aftership_ruby and a wrapper for AfterShip API. Support
+  the latest V3 API
 test_files: []