parcel_api 0.4.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccdca5cd657ddcfb47012dc2c74f75093f77584c
-  data.tar.gz: 70cfd65377e6a41742aeec933cc3e7a123d2c732
+  metadata.gz: fdcd9ebea24a37f29ed1417078791e96ae59470b
+  data.tar.gz: 10626cce08a88d97bd32692ad2aeb0eb3b67f095
 SHA512:
-  metadata.gz: f37606c5c842c634eba7139fcc7447c855ca82981c4ad611a81dfe22dee7ac7333dbdb815b9902c27dcf757a6ed57d3c43fc9608f0525ff03d14abbe5435b328
-  data.tar.gz: 2393821656fd4c4de1672526f95f9290d97151bec8672e61400ba6f1b9340220c849aa7818016e399f0e8ba557bb892b8c1cf289c9397c22299c3d7abfd8da3b
+  metadata.gz: f959eed9357c58808b3305f5f5fbfb58fb32c7eec335c9614f40a9848af2d88bf02878fe0315478f13800e951428c4a1c9760373eb3555aad2831160607bc9e4
+  data.tar.gz: add3bf34df5be59889a28e7f091ac70547903f07fd914e7f671da025e149202d9be28679a909eaffbee0589dab2c72a3f96d8a6f58c86a1a1e45ab2d7d3b9a62

data/.travis.yml

@@ -6,3 +6,5 @@ rvm:
 addons:
   code_climate:
     repo_token: 71a1f8fa6b8f4bd0e13542f237fd8f060d4dab088c71e5f980ed6247197d1820
+services:
+  - redis-server

data/Gemfile.lock

@@ -1,16 +1,22 @@
 PATH
   remote: .
   specs:
-    parcel_api (0.4.1)
-      faraday (~> 0.9)
-      faraday_middleware (~> 0.9)
+    parcel_api (1.0.0)
+      activesupport (~> 4.2)
       oauth2 (~> 1.0)
       recursive-open-struct (~> 0.6)
+      redis (~> 3.2)
       thor (~> 0.19)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (4.2.7.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
     addressable (2.3.8)
     codeclimate-test-reporter (0.4.7)
       simplecov (>= 0.7.1, < 1.0.0)
@@ -21,10 +27,11 @@ GEM
     docile (1.1.5)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.10.0)
-      faraday (>= 0.7.4, < 0.10)
+    i18n (0.7.0)
+    json (1.8.3)
     jwt (1.5.6)
     method_source (0.8.2)
+    minitest (5.9.0)
     multi_json (1.11.0)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
@@ -41,6 +48,7 @@ GEM
     rack (1.6.4)
     rake (10.4.2)
     recursive-open-struct (0.6.5)
+    redis (3.3.1)
     rspec (3.2.0)
       rspec-core (~> 3.2.0)
       rspec-expectations (~> 3.2.0)
@@ -62,6 +70,9 @@ GEM
     simplecov-html (0.9.0)
     slop (3.6.0)
     thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
     vcr (2.9.3)
     webmock (1.21.0)
       addressable (>= 2.3.6)

data/README.md

@@ -50,9 +50,12 @@ client = ParcelApi::Client.new.tap do |config|
   config.username      = ENV['USERNAME']
   config.password      = ENV['PASSWORD']
   config.address       = 'https://api.uat.nzpost.co.nz/' # defaults to api.nzpost.co.nz
+  config.redis         = Redis.new(url: 'redis://:p4ssw0rd@10.0.1.1:6380/15') # defaults to Redis.new
 end
 ```
 
+Redis is currently required, Oauth2 `access_token`'s are cached in Redis and expired automatically. You can use an existing Redis connection.
+
 Client connections can be passed to each method:
 
 `ParcelApi::Address(client.connection)`

data/example/mock.rb

@@ -46,7 +46,7 @@ intl_details.to_h.each {|k, v| puts "#{k}: #{v}"}
 # Tracking Example
 
 tracking = ParcelApi::Track.new
-results = tracking.details('1818120002213401AKL003HN')
+results = tracking.details('8144152543878001AKL002PN')
 
 # example tracking output
 last_event = results.tracking_events.last
@@ -196,8 +196,9 @@ intl_label_options = {
       indicia_number: '123456',
       insurance_required: true,
       contains_only_documents: true,
-      export_type: 'Gift',
-      harmonised_system_tariff: '12121212'
+      export_type: 'Documents',
+      harmonised_system_tariff: '12121212',
+      user_reference_code: SecureRandom.hex(1),
     }
   ]
 }
@@ -219,7 +220,7 @@ File.open("#{intl.label_id}.pdf", 'w') do |f|
 end
 
 
-ShippingOptions Example
+## ShippingOptions Example
 
 shipping_options = ParcelApi::ShippingOptions.new
 
@@ -251,8 +252,7 @@ intl_options.to_h.each {|k, v| puts "#{k}: #{v}"}
 
 pickup_params = {
   carrier: 'CourierPost',
-  message_id: 'Test Message ID',
-  message_date_time: '2015-05-27T14:19:50',
+  caller: 'Test Caller',
   account_number: '91327067',
   pickup_address: {
     site_code: '28979',

data/lib/parcel_api.rb

@@ -1,9 +1,6 @@
-require 'faraday'
-require 'faraday_middleware'
 require 'recursive-open-struct'
 
 require 'parcel_api/version'
-require 'parcel_api/error'
 require 'parcel_api/address'
 require 'parcel_api/track'
 require 'parcel_api/label'

data/lib/parcel_api/address.rb

@@ -21,9 +21,8 @@ module ParcelApi
 
     def search(query, count=10)
       return [] if query.length < 4
-
-      response = @connection.get DOMESTIC_URL, { q: query, count: count }
-      addresses = response.body['addresses'].each do |a|
+      response = @connection.get DOMESTIC_URL, params: { q: query, count: count }
+      addresses = response.parsed['addresses'].each do |a|
         a['address_id'] = Integer(a['address_id'])
         a['dpid'] = Integer(a['dpid']) if a['dpid']
       end
@@ -37,7 +36,7 @@ module ParcelApi
     def details(address_id)
       details_url = File.join(DOMESTIC_URL, address_id.to_s)
       response = @connection.get details_url
-      OpenStruct.new(response.body['address'])
+      OpenStruct.new(response.parsed['address'])
     end
 
     # Search for an Australian Address
@@ -56,7 +55,7 @@ module ParcelApi
     def australian_details(address_id)
       details_url = File.join(AUSTRALIAN_URL, address_id.to_s)
       response = @connection.get details_url
-      RecursiveOpenStruct.new(response.body['address'], recurse_over_arrays: true)
+      RecursiveOpenStruct.new(response.parsed['address'], recurse_over_arrays: true)
     end
 
     # Search for an International Address
@@ -68,8 +67,8 @@ module ParcelApi
     def international_search(query, count=5, country_code=nil)
       return [] if query.length < 4
 
-      response = @connection.get INTERNATIONAL_URL, { q: query, count: count, country_code: country_code }
-      response.body['addresses'].map {|address| OpenStruct.new(address)}
+      response = @connection.get INTERNATIONAL_URL, params: { q: query, count: count, country_code: country_code }
+      response.parsed['addresses'].map {|address| OpenStruct.new(address)}
     end
 
     # Return international address details for a specific international address id
@@ -79,7 +78,7 @@ module ParcelApi
     def international_details(address_id)
       details_url = File.join(INTERNATIONAL_URL, address_id.to_s)
       response = @connection.get details_url
-      RecursiveOpenStruct.new(response.body['result'], recurse_over_arrays: true)
+      RecursiveOpenStruct.new(response.parsed['result'], recurse_over_arrays: true)
     end
 
   end

data/lib/parcel_api/client.rb

@@ -1,3 +1,9 @@
+require 'oauth2'
+require 'redis'
+
+require 'active_support'
+require 'active_support/core_ext/numeric/time'
+
 module ParcelApi
   class Client
 
@@ -6,7 +12,8 @@ module ParcelApi
       :username,
       :password,
       :address,
-      :auth_address
+      :auth_address,
+      :redis
 
     def self.connection
       @connection ||= new.connection
@@ -19,38 +26,25 @@ module ParcelApi
       @password      = password      || ENV['PASSWORD']
       @address       = address       || 'https://api.nzpost.co.nz'
       @auth_address  = auth_address  || 'https://oauth.nzpost.co.nz/as/token.oauth2'
+      @redis         = redis         || Redis.new
     end
 
     def connection
-      Faraday.new(url: @address) do |conn|
-        conn.authorization 'Bearer', token
-        conn.headers['client_id'] = @client_id
-        conn.request  :json
-        conn.response :json, :content_type => /\bjson$/
-        conn.use      FaradayMiddleware::RaiseHttpException
-        conn.adapter  Faraday.default_adapter
+      @access_token_cache ||= begin
+        if json = @redis.get(:parcel_api_access_token)
+          access_token = OAuth2::AccessToken.from_hash client, JSON.parse(json)
+        else
+          access_token = client.password.get_token @username, @password
+          @redis.set(:parcel_api_access_token, access_token.to_hash.to_json, ex: access_token.expires_in.seconds - 1.minute)
+          access_token
+        end
       end
     end
 
     private
 
-    def token
-      params = {
-        client_id:     @client_id,
-        client_secret: @client_secret,
-        username:      @username,
-        password:      @password,
-        grant_type:    'password',
-      }
-
-      auth_api = Faraday.new do |conn|
-        conn.request  :url_encoded
-        conn.response :json
-        conn.use      FaradayMiddleware::RaiseHttpException
-        conn.adapter  Faraday.default_adapter
-      end
-      response = auth_api.post @auth_address, params
-      response.body['access_token']
+    def client
+      OAuth2::Client.new(@client_id, @client_secret, site: @address, token_url: @auth_address, connection_opts: { headers: { 'client_id' => @client_id } })
     end
 
   end

data/lib/parcel_api/label.rb

@@ -18,8 +18,8 @@ module ParcelApi
 
     def create(label_options)
       domestic_url = File.join(LABEL_URL, 'domestic')
-      response = @connection.post domestic_url, label_options
-      labels = response.body['labels'].map {|label| OpenStruct.new(label)}
+      response = @connection.post domestic_url, body: label_options.to_json, headers: { 'Content-Type' => 'application/json' }
+      labels = response.parsed['labels'].map {|label| OpenStruct.new(label)}
       labels.first if labels.count == 1
     end
 
@@ -29,8 +29,8 @@ module ParcelApi
 
     def international_create(label_options)
       international_url = File.join(LABEL_URL, 'international')
-      response = @connection.post international_url, label_options
-      labels = response.body['labels'].map {|label| OpenStruct.new(label)}
+      response = @connection.post international_url, body: label_options.to_json, headers: { 'Content-Type' => 'application/json' }
+      labels = response.parsed['labels'].map {|label| OpenStruct.new(label)}
       labels.first if labels.count == 1
     end
 
@@ -41,7 +41,7 @@ module ParcelApi
     def details(label_id)
       details_url = File.join(LABEL_URL, "#{label_id}.json")
       response = @connection.get details_url
-      details = response.body.tap {|d| d.delete('success')}
+      details = response.parsed.tap {|d| d.delete('success')}
       OpenStruct.new(details)
     end
 

data/lib/parcel_api/pickup.rb

@@ -4,7 +4,7 @@ module ParcelApi
   # The integrator provides the pick up location in the form of a site id or an address to create the pick up record.
 
   class Pickup
-    PARCELPICKUP_URL = '/ParcelPickUp/2.0/bookings'
+    PARCELPICKUP_URL = '/ParcelPickUp/3.0/bookings'
 
     # Creates a new ParcelApi::Pickup instance.
 
@@ -17,8 +17,8 @@ module ParcelApi
     # @return Object of pickup details
 
     def create(pickup_options)
-      response = @connection.post PARCELPICKUP_URL, pickup_options
-      RecursiveOpenStruct.new(response.body, recurse_over_arrays: true)
+      response = @connection.post PARCELPICKUP_URL, body: pickup_options.to_json, headers: { 'Content-Type' => 'application/json' }
+      RecursiveOpenStruct.new(response.parsed, recurse_over_arrays: true)
     end
 
   end

data/lib/parcel_api/shipping_options.rb

@@ -19,8 +19,8 @@ module ParcelApi
     # @return [Array] return array of shipping options
 
     def get_domestic(parcel_params)
-      response = @connection.get DOMESTIC_URL, parcel_params
-      options = response.body.tap do |so|
+      response = @connection.get DOMESTIC_URL, params: parcel_params
+      options = response.parsed.tap do |so|
         so.delete('success')
         so.delete('message_id')
       end
@@ -32,8 +32,8 @@ module ParcelApi
     # @return [Array] return array of shipping options
 
     def get_international(parcel_params)
-      response = @connection.get INTERNATIONAL_URL, parcel_params
-      options = response.body.tap do |so|
+      response = @connection.get INTERNATIONAL_URL, params: parcel_params
+      options = response.parsed.tap do |so|
         so.delete('success')
         so.delete('message_id')
       end

data/lib/parcel_api/track.rb

@@ -4,7 +4,7 @@ module ParcelApi
   # return tracking information for a specific tracking reference.
 
   class Track
-    PARCELTRACK_URL = '/ParcelTrack/2.0/parcels'
+    PARCELTRACK_URL = '/ParcelTrack/3.0/parcels'
 
     # Creates a new ParcelApi::Track instance.
 
@@ -19,8 +19,7 @@ module ParcelApi
     def details(tracking_reference)
       details_url = File.join(PARCELTRACK_URL, tracking_reference.to_s)
       response = @connection.get details_url
-      events = response.body.tap do |d|
-        d.delete('success')
+      events = response.parsed['results'].tap do |d|
         d['tracking_events'].map {|e| e['event_datetime'] = Time.parse(e['event_datetime'])}
         d['tracking_events'].sort_by! {|k| k['event_datetime'].to_i}
       end

data/lib/parcel_api/version.rb

@@ -1,3 +1,3 @@
 module ParcelApi
-  VERSION = '0.4.1'
+  VERSION = '1.0.0'
 end

data/parcel_api.gemspec

@@ -19,9 +19,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'thor', '~> 0.19'
-  spec.add_dependency 'faraday', '~> 0.9'
-  spec.add_dependency 'faraday_middleware', '~> 0.9'
   spec.add_dependency 'oauth2', '~> 1.0'
+  spec.add_dependency 'redis', '~> 3.2'
+  spec.add_dependency 'activesupport', '~> 4.2'
   spec.add_dependency 'recursive-open-struct', '~> 0.6'
 
   spec.add_development_dependency 'bundler', '~> 1.8'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parcel_api
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Robert Coleman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-24 00:00:00.000000000 Z
+date: 2016-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -25,47 +25,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.19'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: oauth2
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: recursive-open-struct
   requirement: !ruby/object:Gem::Requirement
@@ -202,7 +202,6 @@ files:
 - lib/parcel_api/address.rb
 - lib/parcel_api/cli.rb
 - lib/parcel_api/client.rb
-- lib/parcel_api/error.rb
 - lib/parcel_api/label.rb
 - lib/parcel_api/pickup.rb
 - lib/parcel_api/shipping_options.rb

data/lib/parcel_api/error.rb

@@ -1,80 +0,0 @@
-# @private
-module FaradayMiddleware
-  # @private
-  class RaiseHttpException < Faraday::Middleware
-    def call(env)
-      @app.call(env).on_complete do |response|
-        case response[:status].to_i
-        when 400
-          raise ParcelApi::BadRequest, error_message_400(response)
-        when 404
-          raise ParcelApi::NotFound, error_message_400(response)
-        when 500
-          raise ParcelApi::InternalServerError, error_message_500(response, "Something is technically wrong.")
-        when 502
-          raise ParcelApi::BadGateway, error_message_500(response, "The server returned an invalid or incomplete response.")
-        when 503
-          raise ParcelApi::ServiceUnavailable, error_message_500(response, "NZ Post is rate limiting your requests.")
-        when 504
-          raise ParcelApi::GatewayTimeout, error_message_500(response, "504 Gateway Time-out")
-        end
-      end
-    end
-
-    def initialize(app)
-      super app
-      @parser = nil
-    end
-
-    private
-
-    def error_message_400(response)
-      "#{response[:method].to_s.upcase} #{response[:url].to_s} status: #{response[:status]}#{error_body(response[:body])}"
-    end
-
-    def error_body(body)
-      # body gets passed as a string, not sure if it is passed as something else from other spots?
-      if not body.nil? and not body.empty? and body.kind_of?(String)
-        body = ::JSON.parse(body)
-      end
-
-      if body.nil? || body['errors'].nil?
-        nil
-      else
-        body_errors = body['errors'].flat_map {|error| error.map {|k,v| "#{k}: #{v}" }}.compact.join(', ')
-        " - #{body_errors}"
-      end
-    end
-
-    def error_message_500(response, body=nil)
-      "#{response[:method].to_s.upcase} #{response[:url].to_s} status: #{[response[:status].to_s + ':', body].compact.join(' ')}"
-    end
-  end
-end
-
-module ParcelApi
-  # Custom error class for rescuing from all NZ Post errors
-  class Error < StandardError; end
-
-  # Raised when NZ Post returns the HTTP status code 400
-  class BadRequest < Error; end
-
-  # Raised when NZ Post returns the HTTP status code 404
-  class NotFound < Error; end
-
-  # Raised when NZ Post returns the HTTP status code 429
-  class TooManyRequests < Error; end
-
-  # Raised when NZ Post returns the HTTP status code 500
-  class InternalServerError < Error; end
-
-  # Raised when NZ Post returns the HTTP status code 502
-  class BadGateway < Error; end
-
-  # Raised when NZ Post returns the HTTP status code 503
-  class ServiceUnavailable < Error; end
-
-  # Raised when NZ Post returns the HTTP status code 504
-  class GatewayTimeout < Error; end
-
-end