aftership 3.0.3 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fa12d3da913fcd88b6191c4d3c285e14bbb3d00
-  data.tar.gz: 374b2612061e234145d99a5f4a7b91fffbfc51ea
+  metadata.gz: 95e99df0b3b1522828ddaf64e07858cd9d228f4a
+  data.tar.gz: c231c24fadd60141df19f072cfa2e695c779d34f
 SHA512:
-  metadata.gz: 056e48060167b9d88da6d4406cc1ef415efa7473590201f59d65377f4719f3084a6f508efd5de153079d2f05d05ee76f9f7f668a23305d2524d4886f39fad158
-  data.tar.gz: ebd2adcbec8f5f8ad16a66d3cde0dd8cc63fb9d71c765093e88ba54cd01cc26eebc31fc58c303271397a9518bc33251d0694a453f2d9366a865b01505281e735
+  metadata.gz: 38a094cd9ee88231bfccb13c34e8c14d53b236757f273b5ab4e0212aa637cfd23b8e2c7a7239614f45ae01de44a2781556c70020eb73782e93ac27d371d5029c
+  data.tar.gz: 51093f58e32cd3c1cf83a074371d8a79fbecb09ff1ed0dcbfe367162b431f170fd0999d4686c4dfae7189885f241adb86259569e1d90ed453096fff48db79da5

data/README.md

@@ -0,0 +1,96 @@
+## aftership-ruby
+
+Ruby Gem for AfterShip API.
+
+This extension helps developers to integrate with AfterShip easily.
+
+## About AfterShip
+
+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
+* 2014-10-28 Pump version to 4.0.0, support latest v4 api
+* Adding deprecation messages
+* Adding new api endpoints
+* Make all changes regarding new API version
+
+* 2014-04-11 Pump version to 3.0.1, support latest v3 api
+* Removed the debug message
+
+* 2014-04-11 Pump version to 3.0.0, support latest v3 api
+* Change license to MIT
+
+
+## Installation
+
+1. Add the following line to your application's Gemfile
+
+    ```
+    gem "aftership", "~> 3.0"
+    ```
+
+2. Run bundler
+
+    ```
+    bundle install
+    ```
+
+
+## Configuration
+
+1. Before you begin
+
+    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
+
+
+## Usage
+
+1. Setup
+    Before using API, please include the gem in your script
+
+	```
+	require 'rubygems'
+	require '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.
+	```
+
+
+2. Coding
+
+    ```
+    require('aftership')
+    AfterShip.api_key = 'YOUR_API_KEY'
+
+    AfterShip::V3::Courier.get
+    AfterShip::V3::Courier.detect('1ZA6F598D992381375')
+
+    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.delete('ups', '1ZA6F598D992381375')
+    AfterShip::V3::Tracking.update('ups', '1ZA6F598D992381375', {:title=>"Testing"})
+    AfterShip::V3::Tracking.reactivate('ups', '1ZA6F598D992381375')
+
+    AfterShip::V3::LastCheckpoint.get('ups', '1ZA6F598D992381375')
+
+    ```
+
+
+
+## The License (MIT)
+
+Released under the MIT license. See the LICENSE file for the complete wording.

data/lib/aftership.rb

@@ -1,8 +1,12 @@
 $:.unshift File.dirname(__FILE__)
 
-require "aftership/courier"
-require "aftership/tracking"
-require "aftership/last_checkpoint"
+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"
 
 module AfterShip
   class << self;
@@ -10,4 +14,4 @@ module AfterShip
   end
 
   URL = "https://api.aftership.com"
-end
+end

data/lib/aftership/{base.rb → v3/base.rb}

@@ -38,4 +38,4 @@ module AfterShip
       end
     end
   end
-end
+end

data/lib/aftership/{tracking.rb → v3/tracking.rb}

@@ -48,6 +48,8 @@ module AfterShip
 
       #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
@@ -56,4 +58,4 @@ module AfterShip
 
     end
   end
-end
+end

data/lib/aftership/v4/base.rb

@@ -0,0 +1,54 @@
+require 'httpi'
+require 'json'
+
+HTTPI.log = false
+
+module AfterShip
+  module V4
+    class Base
+      class AfterShipError < StandardError; end
+      attr_reader :http_verb_method, :end_point, :params, :body
+
+      def initialize(http_verb_method, end_point, params = {}, body = {})
+        @body = body
+        @params = params
+        @end_point = end_point
+        @http_verb_method = http_verb_method
+      end
+
+      def call
+        validate
+        if response = HTTPI.send(http_verb_method.to_sym, request)
+          return JSON.parse(response.raw_body)
+        else
+          raise(AfterShipError.new("response is nil"))
+        end
+      end
+
+      private
+
+      def validate
+        body.each do |key, value|
+          if %w(emails smses).include?(key.to_s) && !value.is_a?(Array)
+            HTTPI.logger.warn("the #{key} field  should be an array")
+          end
+        end
+      end
+
+      def url
+        api_url = "#{AfterShip::URL}/v4/#{end_point.to_s}"
+        if !params.empty?
+          api_url += '?' + Rack::Utils.build_query(params)
+        end
+        api_url
+      end
+
+      def request
+        req = HTTPI::Request.new(url)
+        req.headers = {"aftership-api-key" => AfterShip.api_key, 'Content-Type' => 'application/json'}
+        req.body = body.to_json
+        req
+      end
+    end
+  end
+end

data/lib/aftership/v4/courier.rb

@@ -0,0 +1,30 @@
+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.
+      def self.get
+        new(:get, "couriers").call
+      end
+
+      #GET /couriers/all
+      #Return a list of all couriers.
+      def self.get
+        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_number = '')
+        if tracking_number.empty?
+          raise ArgumentError.new("tracking_number is required.")
+        else
+          new(:get, "couriers/detect", {'tracking_number' => tracking_number}).call
+        end
+      end
+    end
+  end
+end

data/lib/aftership/v4/last_checkpoint.rb

@@ -0,0 +1,17 @@
+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
+end

data/lib/aftership/v4/tracking.rb

@@ -0,0 +1,70 @@
+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("The 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
+
+      #POST /trackings/batch
+      def self.create_in_batch(tracking_numbers)
+        raise ArgumentError.new("Not implemented yet")
+      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
+      #1_000_000 results is a limit
+      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 StandartError.new("This method is deprecated please use 'retrack' instead")
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: aftership
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 4.0.0
 platform: ruby
 authors:
 - AfterShip.com
+- Alex Topalov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-29 00:00:00.000000000 Z
+date: 2014-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpi
@@ -24,17 +25,66 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.2.7
+- !ruby/object:Gem::Dependency
+  name: rubyntlm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.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
+- !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
-email: support@aftership.com
+email:
+- support@aftership.com
+- me@alextopalov.com
 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
+- lib/aftership/v4/base.rb
+- lib/aftership/v4/courier.rb
+- lib/aftership/v4/last_checkpoint.rb
+- lib/aftership/v4/tracking.rb
 - lib/aftership.rb
-- lib/aftership/base.rb
-- lib/aftership/courier.rb
-- lib/aftership/tracking.rb
-- lib/aftership/last_checkpoint.rb
+- README.md
 homepage: https://www.aftership.com
 licenses:
 - MIT
@@ -60,5 +110,5 @@ rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Formerly known as aftership_ruby and a wrapper for AfterShip API. Support
-  the latest V3 API
+  the latest V3/V4 API
 test_files: []