after_ship 0.0.2 → 0.0.4

data/spec/units/request_spec.rb

@@ -0,0 +1,190 @@
+require 'spec_helper'
+
+RSpec.describe AfterShip::Request do
+  let(:response_401) do
+    '
+      {
+        "meta": {
+          "code": 401,
+          "message": "Invalid API Key.",
+          "type": "Unauthorized"
+        },
+        "data": {}
+      }
+    '
+  end
+
+  let(:response_200) do
+    '
+      {
+        "meta": {
+          "code": 200
+        },
+        "data": {
+          "tracking": {
+            "slug": "ups"
+          }
+        }
+      }
+    '
+  end
+
+  let(:typhoeus_response_timeout) do
+    typhoeus_response = double('Typhoeus response')
+    allow(typhoeus_response).to receive(:timed_out?).and_return(true)
+    allow(typhoeus_response).to receive(:effective_url)
+      .and_return('http://bla.bla/')
+    typhoeus_response
+  end
+
+  let(:typhoeus_response_401) do
+    typhoeus_response = double('Typhoeus response')
+    allow(typhoeus_response).to receive(:timed_out?).and_return(false)
+    allow(typhoeus_response).to receive(:body).and_return(response_401)
+    typhoeus_response
+  end
+
+  let(:typhoeus_response_200) do
+    typhoeus_response = double('Typhoeus response')
+    allow(typhoeus_response).to receive(:timed_out?).and_return(false)
+    allow(typhoeus_response).to receive(:body).and_return(response_200)
+    typhoeus_response
+  end
+
+  it 'initialize with missing :api_key raises an error' do
+    expect { AfterShip::Request.new(url: 'http://bla.bla/', method: :get) }
+      .to raise_error(KeyError)
+  end
+
+  it 'initialize with missing :url raises an error' do
+    expect { AfterShip::Request.new(api_key: 'key', method: :get) }
+      .to raise_error(KeyError)
+  end
+
+  it 'initialize with missing :method raises an error' do
+    expect { AfterShip::Request.new(api_key: 'key', url: 'http://bla.bla/') }
+      .to raise_error(KeyError)
+  end
+
+  it 'get' do
+    allow_any_instance_of(AfterShip::Request)
+      .to receive(:typhoeus_response).and_return(typhoeus_response_200)
+
+    args     = { api_key: 'key', url: 'http://bla.bla/' }
+    response = AfterShip::Request.get(args)
+    expected = {
+      meta: {
+        code: 200
+      },
+      data: {
+        tracking: {
+          slug: 'ups'
+        }
+      }
+    }
+
+    expect(response).to eq(expected)
+  end
+
+  it 'post' do
+    allow_any_instance_of(AfterShip::Request)
+      .to receive(:typhoeus_response).and_return(typhoeus_response_200)
+
+    args     = { api_key: 'key', url: 'http://bla.bla/' }
+    response = AfterShip::Request.post(args)
+    expected = {
+      meta: {
+        code: 200
+      },
+      data: {
+        tracking: {
+          slug: 'ups'
+        }
+      }
+    }
+
+    expect(response).to eq(expected)
+  end
+
+  it 'put' do
+    allow_any_instance_of(AfterShip::Request)
+      .to receive(:typhoeus_response).and_return(typhoeus_response_200)
+
+    args     = { api_key: 'key', url: 'http://bla.bla/' }
+    response = AfterShip::Request.put(args)
+    expected = {
+      meta: {
+        code: 200
+      },
+      data: {
+        tracking: {
+          slug: 'ups'
+        }
+      }
+    }
+
+    expect(response).to eq(expected)
+  end
+
+  it 'response raises an error on timeout' do
+    allow_any_instance_of(AfterShip::Request)
+      .to receive(:typhoeus_response).and_return(typhoeus_response_timeout)
+
+    args    = { api_key: 'key', url: 'http://bla.bla/', method: :get }
+    request = AfterShip::Request.new(args)
+
+    expect { request.response }.to raise_error(AfterShip::Error::Timeout)
+  end
+
+  it 'response loads data and raises an error' do
+    allow_any_instance_of(AfterShip::Request)
+      .to receive(:typhoeus_response).and_return(typhoeus_response_401)
+
+    args    = { api_key: 'key', url: 'http://bla.bla/', method: :get }
+    request = AfterShip::Request.new(args)
+
+    expect { request.response }.to raise_error(AfterShip::Error::Unauthorized)
+  end
+
+  it 'response without a block' do
+    allow_any_instance_of(AfterShip::Request)
+      .to receive(:typhoeus_response).and_return(typhoeus_response_200)
+
+    args     = { api_key: 'key', url: 'http://bla.bla/', method: :get }
+    request  = AfterShip::Request.new(args)
+    expected = {
+      meta: {
+        code: 200
+      },
+      data: {
+        tracking: {
+          slug: 'ups'
+        }
+      }
+    }
+
+    expect(request.response).to eq(expected)
+  end
+
+  it 'response with a block' do
+    allow_any_instance_of(AfterShip::Request)
+      .to receive(:typhoeus_response).and_return(typhoeus_response_200)
+
+    args     = { api_key: 'key', url: 'http://bla.bla/', method: :get }
+    request  = AfterShip::Request.new(args) do |response|
+      response[:data][:tracking]
+    end
+    expected = {
+      slug: 'ups'
+    }
+
+    expect(request.response).to eq(expected)
+  end
+
+  it 'typhoeus_response' do
+    allow_any_instance_of(Typhoeus::Request).to receive(:run)
+    args     = { api_key: 'key', url: 'http://bla.bla/', method: :get }
+    request  = AfterShip::Request.new(args)
+    expect { request.send(:typhoeus_response) }.to_not raise_error
+  end
+end

data/spec/units/tracking_spec.rb

@@ -0,0 +1,276 @@
+require 'spec_helper'
+
+RSpec.describe AfterShip::Tracking do
+  context 'Attributes' do
+    it 'created_at' do
+      data     = { created_at: '2014-10-30T10:05:48' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.created_at).to be_a(DateTime)
+      expect(tracking.created_at.to_s).to eq('2014-10-30T10:05:48+00:00')
+    end
+
+    it 'updated_at' do
+      data     = { updated_at: '2014-10-30T10:05:48' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.updated_at).to be_a(DateTime)
+      expect(tracking.updated_at.to_s).to eq('2014-10-30T10:05:48+00:00')
+    end
+
+    it 'id' do
+      data     = { id: '5457a109bb8bce546b7abafa' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.id).to eq('5457a109bb8bce546b7abafa')
+    end
+
+    it 'tracking_number' do
+      data     = { tracking_number: '1ZA2207X0444990982' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.tracking_number).to eq('1ZA2207X0444990982')
+    end
+
+    it 'tracking_postal_code' do
+      data     = { tracking_postal_code: '???' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.tracking_postal_code).to eq('???')
+    end
+
+    it 'tracking_ship_date' do
+      data     = { tracking_ship_date: '20141124' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.tracking_ship_date).to be_a(Date)
+      expect(tracking.tracking_ship_date.to_s)
+        .to eq('2014-11-24')
+    end
+
+    it 'tracking_account_number' do
+      data     = { tracking_account_number: '???' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.tracking_account_number).to eq('???')
+    end
+
+    it 'slug' do
+      data     = { slug: 'ups' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.slug).to eq('ups')
+    end
+
+    it 'courier' do
+      data     = { slug: 'ups' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.courier).to eq('UPS')
+    end
+
+    it 'active' do
+      data     = { active: false }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.active).to eq(false)
+    end
+
+    it 'android' do
+      data     = { android: [] }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.android).to eq([])
+    end
+
+    it 'custom_fields' do
+      data     = { custom_fields: [] }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.custom_fields).to eq([])
+    end
+
+    it 'customer_name' do
+      data     = { customer_name: nil }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.customer_name).to eq(nil)
+    end
+
+    it 'delivery_time' do
+      data     = { delivery_time: 4 }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.delivery_time).to eq(4)
+    end
+
+    it 'destination_country_iso3' do
+      data     = { destination_country_iso3: 'USA' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.destination_country_iso3).to eq('USA')
+    end
+
+    it 'emails' do
+      data     = { emails: [] }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.emails).to eq([])
+    end
+
+    it 'expected_delivery' do
+      data     = { expected_delivery: '2014-10-30T10:05:48+00:00' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.expected_delivery).to be_a(DateTime)
+      expect(tracking.expected_delivery.to_s)
+        .to eq('2014-10-30T10:05:48+00:00')
+    end
+
+    it 'ios' do
+      data     = { ios: [] }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.ios).to eq([])
+    end
+
+    it 'order_id' do
+      data     = { order_id: 'order-id' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.order_id).to eq('order-id')
+    end
+
+    it 'order_id_path' do
+      data     = { order_id_path: '???' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.order_id_path).to eq('???')
+    end
+
+    it 'origin_country_iso3' do
+      data     = { origin_country_iso3: 'IND' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.origin_country_iso3).to eq('IND')
+    end
+
+    it 'unique_token' do
+      data     = { unique_token: 'bk6ysTW1U' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.unique_token).to eq('bk6ysTW1U')
+    end
+
+    it 'shipment_package_count' do
+      data     = { shipment_package_count: 1 }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.shipment_package_count).to eq(1)
+    end
+
+    it 'shipment_type' do
+      data     = { shipment_type: 'UPS SAVER' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.shipment_type).to eq('UPS SAVER')
+    end
+
+    it 'shipment_weight' do
+      data     = { shipment_weight: 1 }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.shipment_weight).to eq(1)
+    end
+
+    it 'shipment_weight_unit' do
+      data     = { shipment_weight_unit: 'kg' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.shipment_weight_unit).to eq('kg')
+    end
+
+    it 'signed_by' do
+      data     = { signed_by: 'A GUPTA (OFFICE)' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.signed_by).to eq('A GUPTA (OFFICE)')
+    end
+
+    it 'smses' do
+      data     = { smses: [] }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.smses).to eq([])
+    end
+
+    it 'source' do
+      data     = { source: 'api' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.source).to eq('api')
+    end
+
+    it 'tag' do
+      data     = { tag: 'Delivered' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.tag).to eq('Delivered')
+    end
+
+    it 'status' do
+      data     = { tag: 'Delivered' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.status).to eq('Delivered')
+    end
+
+    it 'title' do
+      data     = { title: '1ZA2207X0444990982' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.title).to eq('1ZA2207X0444990982')
+    end
+
+    it 'tracked_count' do
+      data     = { tracked_count: 3 }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.tracked_count).to eq(3)
+    end
+
+    it 'checkpoints' do
+      data     = {
+        checkpoints: [
+          {
+            slug: 'ups'
+          }
+        ]
+      }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.checkpoints.size).to eq(1)
+    end
+  end
+
+  context 'status' do
+    it 'Pending' do
+      data     = { tag: 'Pending' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.status).to eq('Pending')
+    end
+
+    it 'InfoReceived' do
+      data     = { tag: 'InfoReceived' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.status).to eq('Info Received')
+    end
+
+    it 'InTransit' do
+      data     = { tag: 'InTransit' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.status).to eq('In Transit')
+    end
+
+    it 'OutForDelivery' do
+      data     = { tag: 'OutForDelivery' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.status).to eq('Out for Delivery')
+    end
+
+    it 'AttemptFail' do
+      data     = { tag: 'AttemptFail' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.status).to eq('Attempt Failed')
+    end
+
+    it 'Delivered' do
+      data     = { tag: 'Delivered' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.status).to eq('Delivered')
+    end
+
+    it 'Exception' do
+      data     = { tag: 'Exception' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.status).to eq('Exception')
+    end
+
+    it 'Expired' do
+      data     = { tag: 'Expired' }
+      tracking = AfterShip::Tracking.new(data)
+      expect(tracking.status).to eq('Expired')
+    end
+
+    it 'error' do
+      data = { tag: 'error' }
+      expect { AfterShip::Tracking.new(data) }.to raise_error(KeyError)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: after_ship
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Oldrich Vetesnik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-21 00:00:00.000000000 Z
+date: 2014-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: '1.20'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: '1.20'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.26'
+        version: '0.27'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.26'
+        version: '0.27'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -170,19 +170,28 @@ files:
 - after_ship.gemspec
 - lib/after_ship.rb
 - lib/after_ship/checkpoint.rb
+- lib/after_ship/core/attributes.rb
+- lib/after_ship/core/date_utils.rb
+- lib/after_ship/core/error.rb
+- lib/after_ship/core/error_handler.rb
+- lib/after_ship/core/request.rb
+- lib/after_ship/core/version.rb
+- lib/after_ship/courier.rb
 - lib/after_ship/tracking.rb
-- lib/after_ship/version.rb
-- lib/attributes.rb
-- lib/date_utils.rb
-- spec/lib/after_ship_spec.rb
-- spec/lib/checkpoint_spec.rb
-- spec/lib/date_utils_spec.rb
-- spec/lib/tracking_spec.rb
+- spec/integration/after_ship_spec.rb
 - spec/request_stubs.rb
-- spec/requests/tracking/delivered_ok.json
-- spec/requests/tracking/delivered_wild.json
-- spec/requests/tracking/in_transit.json
+- spec/requests/couriers.json
+- spec/requests/tracking/created.json
+- spec/requests/tracking/delivered.json
+- spec/requests/trackings.json
 - spec/spec_helper.rb
+- spec/units/after_ship_spec.rb
+- spec/units/checkpoint_spec.rb
+- spec/units/courier_spec.rb
+- spec/units/date_utils_spec.rb
+- spec/units/error_handler_spec.rb
+- spec/units/request_spec.rb
+- spec/units/tracking_spec.rb
 homepage: https://github.com/ollie/after_ship
 licenses:
 - MIT
@@ -203,18 +212,23 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
-summary: A smallish library to talking to AfterShip via v3 API.
+summary: A smallish library to talking to AfterShip via v4 API.
 test_files:
-- spec/lib/after_ship_spec.rb
-- spec/lib/checkpoint_spec.rb
-- spec/lib/date_utils_spec.rb
-- spec/lib/tracking_spec.rb
+- spec/integration/after_ship_spec.rb
 - spec/request_stubs.rb
-- spec/requests/tracking/delivered_ok.json
-- spec/requests/tracking/delivered_wild.json
-- spec/requests/tracking/in_transit.json
+- spec/requests/couriers.json
+- spec/requests/tracking/created.json
+- spec/requests/tracking/delivered.json
+- spec/requests/trackings.json
 - spec/spec_helper.rb
+- spec/units/after_ship_spec.rb
+- spec/units/checkpoint_spec.rb
+- spec/units/courier_spec.rb
+- spec/units/date_utils_spec.rb
+- spec/units/error_handler_spec.rb
+- spec/units/request_spec.rb
+- spec/units/tracking_spec.rb
 has_rdoc: 

data/lib/after_ship/version.rb

@@ -1,3 +0,0 @@
-class AfterShip
-  VERSION = '0.0.2'
-end

data/lib/attributes.rb

@@ -1,12 +0,0 @@
-# Extracted attributes loading.
-module Attributes
-  # Loop through the data hash and for each key call a setter with the value.
-  #
-  # @param data [Hash]
-  def load_attributes(data)
-    data.each do |attribute, value|
-      setter = "#{ attribute }="
-      send(setter, value) if respond_to?(setter)
-    end
-  end
-end

data/lib/date_utils.rb

@@ -1,61 +0,0 @@
-# Simple utility class for parsing dates and datetimes.
-class DateUtils
-  # Date:
-  #
-  # +YYYY-MM-DD+
-  DATE_REGEX = /
-                 \A
-                 \d{4}-\d{2}-\d{2}
-                 \Z
-               /x
-
-  # Datetime without zone:
-  #
-  # +YYYY-MM-DDTHH:MM:SS+
-  DATETIME_REGEX = /
-                     \A
-                     \d{4}-\d{2}-\d{2}
-                     T
-                     \d{2}:\d{2}:\d{2}
-                     \Z
-                   /x
-
-  # Datetime with zone:
-  #
-  # +YYYY-MM-DDTHH:MM:SSZ+
-  # +YYYY-MM-DDTHH:MM:SS+HH:MM+
-  # +YYYY-MM-DDTHH:MM:SS-HH:MM+
-  DATETIME_WITH_ZONE_REGEX = /
-                               \A
-                               \d{4}-\d{2}-\d{2}
-                               T
-                               \d{2}:\d{2}:\d{2}
-                               (Z|[+-]\d{2}:\d{2})
-                               \Z
-                             /x
-
-  # Try to parse a date or datetime from a string.
-  #
-  # @param value [String]
-  #   Empty String,
-  #   YYYY-MM-DD,
-  #   YYYY-MM-DDTHH:MM:SS,
-  #   YYYY-MM-DDTHH:MM:SSZ,
-  #   YYYY-MM-DDTHH:MM:SS+HH:MM or
-  #   YYYY-MM-DDTHH:MM:SS-HH:MM.
-  #
-  def self.parse(value)
-    case value
-    when ''
-      nil
-    when nil
-      nil
-    when DATE_REGEX
-      Date.parse(value)
-    when DATETIME_REGEX, DATETIME_WITH_ZONE_REGEX
-      DateTime.parse(value)
-    else
-      fail ArgumentError, "Invalid expected_delivery date #{ value.inspect }"
-    end
-  end
-end