after_ship 0.0.2

data/spec/lib/date_utils_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+RSpec.describe DateUtils do
+  context 'parse' do
+    it 'empty string' do
+      date = DateUtils.parse('')
+      expect(date).to be_nil
+    end
+
+    it 'nil' do
+      date = DateUtils.parse(nil)
+      expect(date).to be_nil
+    end
+
+    it 'YYYY-MM-DD' do
+      date     = DateUtils.parse('2014-07-29')
+      expected = Date.parse('2014-07-29')
+      expect(date).to eq(expected)
+      expect(date.to_s).to eq('2014-07-29')
+      expect(date.strftime('%Y-%m-%d %H:%M:%S')).to eq('2014-07-29 00:00:00')
+    end
+
+    it 'YYYY-MM-DDTHH:MM:SS' do
+      date     = DateUtils.parse('2014-07-29T16:08:23')
+      expected = DateTime.parse('2014-07-29T16:08:23')
+      expect(date).to eq(expected)
+      expect(date.to_s).to eq('2014-07-29T16:08:23+00:00')
+      expect(date.strftime('%Y-%m-%d %H:%M:%S')).to eq('2014-07-29 16:08:23')
+    end
+
+    it 'YYYY-MM-DDTHH:MM:SSZ' do
+      date     = DateUtils.parse('2014-07-29T16:08:23Z')
+      expected = DateTime.parse('2014-07-29T16:08:23Z')
+      expect(date).to eq(expected)
+      expect(date.to_s).to eq('2014-07-29T16:08:23+00:00')
+      expect(date.strftime('%Y-%m-%d %H:%M:%S')).to eq('2014-07-29 16:08:23')
+    end
+
+    it 'YYYY-MM-DDTHH:MM:SS+HH:MM' do
+      date     = DateUtils.parse('2014-07-29T16:08:23+02:00')
+      expected = DateTime.parse('2014-07-29T16:08:23+02:00')
+      expect(date).to eq(expected)
+      expect(date.to_s).to eq('2014-07-29T16:08:23+02:00')
+      expect(date.strftime('%Y-%m-%d %H:%M:%S')).to eq('2014-07-29 16:08:23')
+    end
+
+    it 'YYYY-MM-DDTHH:MM:SS-HH:MM' do
+      date     = DateUtils.parse('2014-07-29T16:08:23-02:00')
+      expected = DateTime.parse('2014-07-29T16:08:23-02:00')
+      expect(date).to eq(expected)
+      expect(date.to_s).to eq('2014-07-29T16:08:23-02:00')
+      expect(date.strftime('%Y-%m-%d %H:%M:%S')).to eq('2014-07-29 16:08:23')
+    end
+
+    it 'everything else raises an error' do
+      expect { DateUtils.parse('xxx') }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/lib/tracking_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+RSpec.describe AfterShip::Tracking do
+  before do
+    @client = AfterShip.new(api_key: 'key')
+  end
+
+  context 'Real data' do
+    it 'builds delivered Tracking (simple)' do
+      tracking = @client.tracking('delivered-ok', 'ups')
+      expect(tracking).to be_a(AfterShip::Tracking)
+      expect(tracking.checkpoints.size).to eq(15)
+    end
+
+    it 'builds delivered Tracking (quite crazy)' do
+      tracking = @client.tracking('delivered-wild', 'ups')
+      expect(tracking).to be_a(AfterShip::Tracking)
+      expect(tracking.checkpoints.size).to eq(41)
+    end
+
+    it 'builds in-transit Tracking' do
+      tracking = @client.tracking('in-transit', 'usps')
+      expect(tracking).to be_a(AfterShip::Tracking)
+      expect(tracking.checkpoints.size).to eq(27)
+      expect(tracking.expected_delivery.to_s).to eq('2014-07-02T00:00:00+00:00')
+    end
+  end
+
+  it 'has courier' do
+    data     = { slug: 'ups' }
+    tracking = AfterShip::Tracking.new(data)
+    expect(tracking.courier).to eq('UPS')
+  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

data/spec/request_stubs.rb

@@ -0,0 +1,133 @@
+# trackings
+WebMock.stub_request(
+  :get,
+  'https://api.aftership.com/v3/trackings'
+  ).with(
+    body:    '{}',
+    headers: { 'Aftership-Api-Key' => 'key' }
+  ).to_return(
+    status: 200,
+    body:   %({"meta":{"code":200},"data":{"trackings":[{"slug":"ups"}]}})
+  )
+
+# tracking with real delivered data (simple)
+WebMock.stub_request(
+  :get,
+  'https://api.aftership.com/v3/trackings/ups/delivered-ok'
+  ).with(
+    body:    '{}',
+    headers: { 'Aftership-Api-Key' => 'key' }
+  ).to_return(
+    status: 200,
+    body:   File.open('spec/requests/tracking/delivered_ok.json')
+  )
+
+# tracking with real delivered data (a lot of checkpoints)
+WebMock.stub_request(
+  :get,
+  'https://api.aftership.com/v3/trackings/ups/delivered-wild'
+  ).with(
+    body:    '{}',
+    headers: { 'Aftership-Api-Key' => 'key' }
+  ).to_return(
+    status: 200,
+    body:   File.open('spec/requests/tracking/delivered_wild.json')
+  )
+
+# tracking with real in-transit data
+WebMock.stub_request(
+  :get,
+  'https://api.aftership.com/v3/trackings/usps/in-transit'
+  ).with(
+    body:    '{}',
+    headers: { 'Aftership-Api-Key' => 'key' }
+  ).to_return(
+    status: 200,
+    body:   File.open('spec/requests/tracking/in_transit.json')
+  )
+
+# tracking
+WebMock.stub_request(
+  :get,
+  'https://api.aftership.com/v3/trackings/ups/ABC123'
+  ).with(
+    body:    '{}',
+    headers: { 'Aftership-Api-Key' => 'key' }
+  ).to_return(
+    status: 200,
+    body:   %({"meta":{"code":200},"data":{"tracking":{}}})
+  )
+
+[201, 400, 401, 402, 404, 409, 429, 500, 502, 503, 504, 666].each do |code|
+  WebMock.stub_request(
+    :get,
+    "https://api.aftership.com/v3/trackings/ups/#{ code }"
+    ).with(
+      body:    '{}',
+      headers: { 'Aftership-Api-Key' => 'key' }
+    ).to_return(
+      status: 200,
+      body:   %({"meta":{"code":#{code}},"data":{"tracking":{"slug":"ups"}}})
+    )
+end
+
+# create_tracking
+WebMock.stub_request(
+  :post,
+  'https://api.aftership.com/v3/trackings'
+  ).with(
+    body:    %({"tracking":{"tracking_number":"ABC123","slug":"ups"}}),
+    headers: { 'Aftership-Api-Key' => 'key' }
+  ).to_return(
+    status: 200,
+    body:   %({"meta":{"code":200},"data":{"tracking":{"slug":"ups"}}})
+  )
+
+WebMock.stub_request(
+  :post,
+  'https://api.aftership.com/v3/trackings'
+  ).with(
+    body:    %({"tracking":{"tracking_number":"ABC123","slug":"ups","order_id":"1234"}}), # rubocop:disable Metrics/LineLength
+    headers: { 'Aftership-Api-Key' => 'key' }
+  ).to_return(
+    status: 200,
+    body:   %({"meta":{"code":200},"data":{"tracking":{"slug":"ups"}}})
+  )
+
+# update_tracking
+
+WebMock.stub_request(
+  :put,
+  'https://api.aftership.com/v3/trackings/ups/ABC123'
+  ).with(
+    body:    %({"tracking":{"order_id":"1234"}}),
+    headers: { 'Aftership-Api-Key' => 'key' }
+  ).to_return(
+    status: 200,
+    body:   %({"meta":{"code":200},"data":{"tracking":{"slug":"ups"}}})
+  )
+
+## App-specific AfterShip tests
+
+# create_tracking
+WebMock.stub_request(
+  :post,
+  'https://api.aftership.com/v3/trackings'
+  ).with(
+    body:    %({"tracking":{"tracking_number":"ABC123","slug":"ups","order_id":"1234"}}), # rubocop:disable Metrics/LineLength
+    headers: { 'Aftership-Api-Key' => 'key' }
+  ).to_return(
+    status: 200,
+    body:   %({"meta":{"code":200},"data":{"tracking":{"slug":"ups"}}})
+  )
+
+WebMock.stub_request(
+  :post,
+  'https://api.aftership.com/v3/trackings'
+  ).with(
+    body:    %({"tracking":{"tracking_number":"EXISTING","slug":"ups","order_id":"1234"}}), # rubocop:disable Metrics/LineLength
+    headers: { 'Aftership-Api-Key' => 'key' }
+  ).to_return(
+    status: 200,
+    body:   %({"meta":{"code":409}})
+  )

data/spec/requests/tracking/delivered_ok.json

@@ -0,0 +1,263 @@
+{
+  "meta": {
+    "code": 200
+  },
+  "data": {
+    "tracking": {
+      "created_at": "2014-05-05T13:50:27+00:00",
+      "updated_at": "2014-07-18T08:04:49+00:00",
+      "tracking_number": "1ZA2207X6791425225",
+      "slug": "ups",
+      "active": false,
+      "custom_fields": {
+      },
+      "customer_name": null,
+      "destination_country_iso3": "USA",
+      "emails": [
+
+      ],
+      "expected_delivery": null,
+      "order_id": "PL-55120855",
+      "order_id_path": null,
+      "origin_country_iso3": "IND",
+      "shipment_package_count": 0,
+      "shipment_type": "EXPEDITED",
+      "signed_by": "FRONT DOOR",
+      "smses": [
+
+      ],
+      "source": "api",
+      "tag": "Delivered",
+      "title": "1ZA2207X6791425225",
+      "tracked_count": 29,
+      "unique_token": "xJ8CBha3T",
+      "checkpoints": [
+        {
+          "slug": "ups",
+          "city": null,
+          "created_at": "2014-05-05T13:50:27+00:00",
+          "country_name": "IN",
+          "message": "BILLING INFORMATION RECEIVED",
+          "country_iso3": "IND",
+          "tag": "InfoReceived",
+          "checkpoint_time": "2014-05-04T14:06:23",
+          "coordinates": [
+
+          ],
+          "state": null,
+          "zip": null
+        },
+        {
+          "slug": "ups",
+          "city": "MUMBAI",
+          "created_at": "2014-05-05T18:19:57+00:00",
+          "country_name": "IN",
+          "message": "PICKUP SCAN",
+          "country_iso3": null,
+          "tag": "InTransit",
+          "checkpoint_time": "2014-05-05T19:56:00",
+          "coordinates": [
+
+          ],
+          "state": null,
+          "zip": null
+        },
+        {
+          "slug": "ups",
+          "city": "MUMBAI",
+          "created_at": "2014-05-06T00:30:19+00:00",
+          "country_name": "IN",
+          "message": "ORIGIN SCAN",
+          "country_iso3": null,
+          "tag": "InTransit",
+          "checkpoint_time": "2014-05-06T03:43:00",
+          "coordinates": [
+
+          ],
+          "state": null,
+          "zip": null
+        },
+        {
+          "slug": "ups",
+          "city": "MUMBAI",
+          "created_at": "2014-05-06T00:30:19+00:00",
+          "country_name": "IN",
+          "message": "DEPARTURE SCAN",
+          "country_iso3": null,
+          "tag": "InTransit",
+          "checkpoint_time": "2014-05-06T05:44:00",
+          "coordinates": [
+
+          ],
+          "state": null,
+          "zip": null
+        },
+        {
+          "slug": "ups",
+          "city": "MUMBAI",
+          "created_at": "2014-05-06T04:37:39+00:00",
+          "country_name": "IN",
+          "message": "ARRIVAL SCAN",
+          "country_iso3": null,
+          "tag": "InTransit",
+          "checkpoint_time": "2014-05-06T06:11:00",
+          "coordinates": [
+
+          ],
+          "state": null,
+          "zip": null
+        },
+        {
+          "slug": "ups",
+          "city": "MUMBAI",
+          "created_at": "2014-05-06T13:23:12+00:00",
+          "country_name": "IN",
+          "message": "DEPARTURE SCAN",
+          "country_iso3": null,
+          "tag": "InTransit",
+          "checkpoint_time": "2014-05-06T15:43:00",
+          "coordinates": [
+
+          ],
+          "state": null,
+          "zip": null
+        },
+        {
+          "slug": "ups",
+          "city": "KOELN (COLOGNE)",
+          "created_at": "2014-05-06T21:53:37+00:00",
+          "country_name": "DE",
+          "message": "ARRIVAL SCAN",
+          "country_iso3": null,
+          "tag": "InTransit",
+          "checkpoint_time": "2014-05-06T20:30:00",
+          "coordinates": [
+
+          ],
+          "state": null,
+          "zip": null
+        },
+        {
+          "slug": "ups",
+          "city": "KOELN (COLOGNE)",
+          "created_at": "2014-05-07T04:08:35+00:00",
+          "country_name": "DE",
+          "message": "DEPARTURE SCAN",
+          "country_iso3": null,
+          "tag": "InTransit",
+          "checkpoint_time": "2014-05-07T05:30:00",
+          "coordinates": [
+
+          ],
+          "state": null,
+          "zip": null
+        },
+        {
+          "slug": "ups",
+          "city": "PHILADELPHIA",
+          "created_at": "2014-05-07T13:04:20+00:00",
+          "country_name": "US",
+          "message": "ARRIVAL SCAN",
+          "country_iso3": null,
+          "tag": "InTransit",
+          "checkpoint_time": "2014-05-07T08:05:00",
+          "coordinates": [
+
+          ],
+          "state": "PA",
+          "zip": null
+        },
+        {
+          "slug": "ups",
+          "city": "PHILADELPHIA",
+          "created_at": "2014-05-07T17:36:54+00:00",
+          "country_name": "US",
+          "message": "IMPORT SCAN",
+          "country_iso3": null,
+          "tag": "InTransit",
+          "checkpoint_time": "2014-05-07T10:31:00",
+          "coordinates": [
+
+          ],
+          "state": "PA",
+          "zip": null
+        },
+        {
+          "slug": "ups",
+          "city": "PHILADELPHIA",
+          "created_at": "2014-05-08T08:54:42+00:00",
+          "country_name": "US",
+          "message": "DEPARTURE SCAN",
+          "country_iso3": null,
+          "tag": "InTransit",
+          "checkpoint_time": "2014-05-08T02:52:00",
+          "coordinates": [
+
+          ],
+          "state": "PA",
+          "zip": null
+        },
+        {
+          "slug": "ups",
+          "city": "PHILADELPHIA",
+          "created_at": "2014-05-08T08:54:42+00:00",
+          "country_name": "US",
+          "message": "ARRIVAL SCAN",
+          "country_iso3": null,
+          "tag": "InTransit",
+          "checkpoint_time": "2014-05-08T03:13:00",
+          "coordinates": [
+
+          ],
+          "state": "PA",
+          "zip": null
+        },
+        {
+          "slug": "ups",
+          "city": "PHILADELPHIA",
+          "created_at": "2014-05-08T13:22:52+00:00",
+          "country_name": "US",
+          "message": "OUT FOR DELIVERY",
+          "country_iso3": null,
+          "tag": "OutForDelivery",
+          "checkpoint_time": "2014-05-08T06:35:00",
+          "coordinates": [
+
+          ],
+          "state": "PA",
+          "zip": null
+        },
+        {
+          "slug": "ups",
+          "city": "PHILADELPHIA",
+          "created_at": "2014-05-08T16:41:11+00:00",
+          "country_name": "US",
+          "message": "DESTINATION SCAN",
+          "country_iso3": null,
+          "tag": "InTransit",
+          "checkpoint_time": "2014-05-08T06:35:00",
+          "coordinates": [
+
+          ],
+          "state": "PA",
+          "zip": null
+        },
+        {
+          "slug": "ups",
+          "city": "PHILADELPHIA",
+          "created_at": "2014-05-08T16:41:11+00:00",
+          "country_name": "US",
+          "message": "DELIVERED",
+          "country_iso3": null,
+          "tag": "Delivered",
+          "checkpoint_time": "2014-05-08T12:31:00",
+          "coordinates": [
+
+          ],
+          "state": "PA",
+          "zip": "19106"
+        }
+      ]
+    }
+  }
+}