postmates 0.1.0

data/lib/postmates/error.rb

@@ -0,0 +1,9 @@
+module Postmates
+  class Error       < StandardError; end # custom Postmates error class
+  class BadRequest          < Error; end # 400
+  class Unauthorized        < Error; end # 401
+  class Forbidden           < Error; end # 403
+  class NotFound            < Error; end # 404
+  class InternalServerError < Error; end # 500
+  class ServiceUnavailable  < Error; end # 503
+end

data/lib/postmates/quote.rb

@@ -0,0 +1,23 @@
+require_relative 'utils'
+
+module Postmates
+  class Quote
+    include Postmates::Utils
+    attr_reader :id, :created_at, :expires_at, :fee,
+                :currency, :dropoff_eta, :duration
+
+    def initialize(hash)
+      @id          =         hash['id']
+      @fee         =         hash['fee']
+      @currency    =         hash['currency']
+      @duration    =         hash['duration']
+      @created_at  = timeify hash['created']
+      @expires_at  = timeify hash['expires']
+      @dropoff_eta = timeify hash['dropoff_eta']
+    end
+
+    def expired?
+      Time.now.utc.to_datetime > expires_at
+    end
+  end
+end

data/lib/postmates/request.rb

@@ -0,0 +1,28 @@
+require_relative 'response'
+
+module Postmates
+  module Request
+    def get(path, options = {})
+      request(:get, path, options)
+    end
+
+    def post(path, options = {})
+      request(:post, path, options)
+    end
+
+    private
+
+    def request(method, path, options)
+      response = connection.send(method) do |request|
+        case method
+        when :get 
+          request.url(path, options)
+        when :post
+          request.path = path
+          request.body = options unless options.empty?
+        end
+      end
+      raw_response ? response : Response.build(response.body)
+    end
+  end
+end

data/lib/postmates/response.rb

@@ -0,0 +1,27 @@
+require_relative 'utils'
+require_relative 'quote'
+require_relative 'delivery'
+
+module Postmates
+  module Response
+    class << self
+      include Postmates::Utils
+
+      def build(body)
+        kind = body['object'] || body['kind']
+        case kind
+        when 'list'
+          body['data'].map { |del| Delivery.new(del) }.tap do |list|
+            list.instance_variable_set(:@total_count, body['total_count'])
+            list.instance_variable_set(:@next_href, urlify(body['next_href']))
+            list.class.module_eval { attr_reader :total_count, :next_href }
+          end
+        when 'delivery'
+          Delivery.new(body)
+        when 'delivery_quote'
+          Quote.new(body)
+        end
+      end
+    end
+  end
+end

data/lib/postmates/utils.rb

@@ -0,0 +1,14 @@
+require 'uri'
+require 'date'
+
+module Postmates
+  module Utils
+    def urlify(href)
+      URI(href) if href
+    end
+
+    def timeify(timestamp)
+      DateTime.iso8601 timestamp if timestamp
+    end
+  end
+end

data/lib/postmates/version.rb

@@ -0,0 +1,14 @@
+module Postmates
+  class Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    PRE   = nil
+
+    class << self
+      def to_s
+        [MAJOR, MINOR, PATCH, PRE].compact.join('.')
+      end
+    end
+  end
+end

data/postmates.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'postmates/version'
+
+Gem::Specification.new do |s|
+  s.name                  = 'postmates'
+  s.version               = Postmates::Version
+  s.authors               = ['Rahul Horé']
+  s.email                 = ['hore.rahul@gmail.com']
+  s.summary               = %q{Ruby wrapper for the Postmates API}
+  s.description           = %q{Ruby client for the Postmates API}
+  s.homepage              = 'https://github.com/O-I/postmates'
+  s.license               = 'MIT'
+  s.files                 = `git ls-files -z`.split("\x0")
+  s.test_files            = s.files.grep(%r{^(test|spec|features)/})
+  s.files                 = s.files - s.test_files
+  s.require_paths         = ['lib']
+  s.required_ruby_version = Gem::Requirement.new(">= 1.9.3")
+
+  s.add_runtime_dependency     'faraday', ['< 0.10', '>= 0.7']
+  s.add_runtime_dependency     'faraday_middleware', ['< 0.10', '>= 0.8']
+  s.add_development_dependency 'bundler', '~> 1.7'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'webmock', '~> 1.0'
+  s.add_development_dependency 'simplecov', '~> 0.9.0'
+  s.add_development_dependency 'coveralls', '~> 0.7.0'
+end

data/spec/client_spec.rb

@@ -0,0 +1,116 @@
+describe Postmates::Client do
+  let(:client) { postmates_test_client }
+  let(:customer_id) { client.customer_id }
+
+  context 'Customer Delivery endpoints' do
+
+    describe '#quote' do
+      let(:path) { path_to 'delivery_quotes' }
+      let(:params) { payload 'quote_params.json' }
+      before { stub_post path, params.merge(returns: 'quote.json') }
+
+      it 'fetches a delivery quote' do
+        expect(client.quote(params).id).to eq 'dqt_K9LFfpSZCdAJsk'
+        expect(client.quote(params).fee).to eq 1350
+        expect(client.quote(params).expired?).to be true
+      end
+
+      it 'returns a Postmates::Quote' do
+        expect(client.quote(params)).to be_a Postmates::Quote
+      end
+    end
+
+    describe '#create' do
+      let(:path) { path_to 'deliveries' }
+      let(:params) { payload 'create_params.json' }
+      before { stub_post path, params.merge(returns: 'delivery.json') }
+
+      it 'creates a delivery' do
+        expect(client.create(params).id).to eq 'del_K9LFxVVbl5sac-'
+        expect(client.create(params).quote_id).to eq 'dqt_K9LFfpSZCdAJsk'
+        expect(client.create(params).status).to eq 'pending'
+        expect(client.create(params).manifest['description'])
+          .to eq 'a box of kittens'
+        expect(client.create(params).delivered?).to be false
+      end
+
+      it 'returns a Postmates::Delivery' do
+        expect(client.create(params)).to be_a Postmates::Delivery
+      end
+    end
+
+    describe '#list' do
+      let(:path) { path_to 'deliveries' }
+      before { stub_get path, returns: 'deliveries.json' }
+
+      it 'fetches a list of deliveries' do
+        expect(client.list.size).to eq 6
+        expect(client.list.first(3).map(&:id))
+          .to eq %w(del_K9LFxVVbl5sac- del_K9FmiEl7tKY2i- del_K9Fm9OU1DhW3x-)
+        expect(client.list.map(&:status).uniq).to eq %w(delivered canceled)
+      end
+
+      it 'returns an array of Postmates::Delivery objects' do
+        expect(client.list).to be_an Array
+        expect(client.list.first).to be_a Postmates::Delivery
+      end
+    end
+
+    describe '#retrieve' do
+      let(:delivery_id) { 'del_K9LFxVVbl5sac-' }
+      let(:path) { path_to "deliveries/#{delivery_id}" }
+      before { stub_get path, returns: 'delivery.json' }
+
+      it 'fetches a single delivery by id' do
+        expect(client.retrieve(delivery_id).id).to eq 'del_K9LFxVVbl5sac-'
+        expect(client.retrieve(delivery_id).quote_id).to eq 'dqt_K9LFfpSZCdAJsk'
+        expect(client.retrieve(delivery_id).status).to eq 'pending'
+        expect(client.retrieve(delivery_id).manifest['description'])
+          .to eq 'a box of kittens'
+        expect(client.retrieve(delivery_id).delivered?).to be false
+      end
+
+      it 'returns a Postmates::Delivery' do
+        expect(client.retrieve(delivery_id)).to be_a Postmates::Delivery
+      end
+    end
+
+    describe '#cancel' do
+      let(:delivery_id) { 'del_K9LFxVVbl5sac-' }
+      let(:path) { path_to "deliveries/#{delivery_id}/cancel" }
+      before { stub_post path, returns: 'delivery.json' }
+
+      it 'cancels a single delivery by id' do
+        expect(client.cancel(delivery_id).id).to eq 'del_K9LFxVVbl5sac-'
+        expect(client.cancel(delivery_id).quote_id).to eq 'dqt_K9LFfpSZCdAJsk'
+        expect(client.cancel(delivery_id).status).to eq 'pending'
+        expect(client.cancel(delivery_id).manifest['description'])
+          .to eq 'a box of kittens'
+        expect(client.cancel(delivery_id).delivered?).to be false
+      end
+
+      it 'returns a Postmates::Delivery' do
+        expect(client.cancel(delivery_id)).to be_a Postmates::Delivery
+      end
+    end
+
+    describe '#return' do
+      let(:delivery_id) { 'del_K9LFxVVbl5sac-' }
+      let(:path) { path_to "deliveries/#{delivery_id}/return" }
+      before { stub_post path, returns: 'delivery.json' }
+
+      it 'returns a single delivery by id' do
+        expect(client.return(delivery_id).id).to eq 'del_K9LFxVVbl5sac-'
+        expect(client.return(delivery_id).quote_id).to eq 'dqt_K9LFfpSZCdAJsk'
+        expect(client.return(delivery_id).status).to eq 'pending'
+        expect(client.return(delivery_id).manifest['description'])
+          .to eq 'a box of kittens'
+        expect(client.return(delivery_id).delivered?).to be false
+      end
+
+      it 'returns a Postmates::Delivery' do
+        expect(client.return(delivery_id)).to be_a Postmates::Delivery
+      end
+    end
+  end
+end

data/spec/error_spec.rb

@@ -0,0 +1,82 @@
+describe Postmates::Error do
+  let(:client) { postmates_test_client }
+  let(:customer_id) { client.customer_id }
+
+  context 'A request' do
+    describe 'with invalid parameters' do
+      let(:params) { {} }
+      before do
+        stub_post(path_to('deliveries'),
+                  params.merge(response_code: 400,
+                               returns: 'invalid_params.json'))
+      end
+
+      it 'raises Postmates::BadRequest' do
+        expect { client.create }
+          .to raise_error Postmates::BadRequest
+      end
+    end
+
+    describe 'with incorrect authentication' do
+      let(:bad_client) { Postmates.new }
+      before do
+        stub_get(path_to('deliveries'),
+                 response_code: 401, returns: 'unauthorized.json')
+      end
+
+      it 'raises Postmates::Unauthorized' do
+        expect { bad_client.list }
+          .to raise_error Postmates::Unauthorized
+      end
+    end
+
+    describe 'Forbidden' do
+      let(:bad_client) { Postmates.new }
+      before do
+        stub_get(path_to('deliveries'),
+                 response_code: 403, returns: 'forbidden.json')
+      end
+
+      it 'raises Postmates::Forbidden' do
+        expect { bad_client.list }
+          .to raise_error Postmates::Forbidden
+      end
+    end
+
+    describe 'for a non-existent resource' do
+      before do
+        stub_get(path_to('deliveries/bad-id'),
+                 response_code: 404, returns: 'not_found.json')
+      end
+
+      it 'raises Postmates::NotFound' do
+        expect { client.retrieve('bad-id') }
+          .to raise_error Postmates::NotFound
+      end
+    end
+
+    describe 'when there is a problem processing the request' do
+      before do
+        stub_get(path_to('deliveries'),
+                 response_code: 500, returns: 'server_error.json')
+      end
+
+      it 'raises Postmates::InternalServerError' do
+        expect { client.list }
+          .to raise_error Postmates::InternalServerError
+      end
+    end
+
+    describe 'when service is unavailable' do
+      before do
+        stub_get(path_to('deliveries'),
+                 response_code: 503, returns: 'service_unavailable.json')
+      end
+
+      it 'raises Postmates::ServiceUnavailable' do
+        expect { client.list }
+          .to raise_error Postmates::ServiceUnavailable
+      end
+    end
+  end
+end

data/spec/fixtures/create_params.json

@@ -0,0 +1,14 @@
+{
+  "manifest": "a box of kittens",
+  "pickup_name": "The Warehouse",
+  "pickup_address": "20 McAllister St, San Francisco, CA",
+  "pickup_phone_number": "555-555-5555",
+  "pickup_business_name": "Optional Pickup Business Name, Inc.",
+  "pickup_notes": "Optional note that this is Invoice #123",
+  "dropoff_name": "Alice",
+  "dropoff_address": "101 Market St, San Francisco, CA",
+  "dropoff_phone_number": "415-555-1234",
+  "dropoff_business_name": "Optional Dropoff Business Name, Inc.",
+  "dropoff_notes": "Optional note to ring the bell",
+  "quote_id": "dqt_K9LFfpSZCdAJsk"
+}

data/spec/fixtures/deliveries.json

@@ -0,0 +1,242 @@
+{
+  "url": "/v1/customers/cus_K8HxOXUT-7afSV/deliveries",
+  "total_count": 6,
+  "object": "list",
+  "data": [
+    {
+      "status": "delivered",
+      "dropoff": {
+        "phone_number": "415-555-1234",
+        "notes": "Optional note to ring the bell",
+        "location": {
+          "lat": 37.7930812,
+          "lng": -122.395944
+        },
+        "name": "Alice, Optional Dropoff Business Name, Inc.",
+        "address": "101 Market Street"
+      },
+      "updated": "2015-01-01T18:27:03Z",
+      "fee": 1350,
+      "quote_id": "dqt_K9LFfpSZCdAJsk",
+      "complete": true,
+      "courier": null,
+      "created": "2015-01-01T18:24:54Z",
+      "kind": "delivery",
+      "manifest": {
+        "description": "a box of kittens"
+      },
+      "currency": "usd",
+      "pickup": {
+        "phone_number": "555-555-5555",
+        "notes": "Optional note that this is Invoice #123",
+        "location": {
+          "lat": 37.7811372,
+          "lng": -122.4123037
+        },
+        "name": "The Warehouse, Optional Pickup Business Name, Inc.",
+        "address": "20 McAllister Street"
+      },
+      "dropoff_deadline": "2015-01-01T19:24:54Z",
+      "live_mode": false,
+      "pickup_eta": null,
+      "dropoff_eta": null,
+      "id": "del_K9LFxVVbl5sac-"
+    },
+    {
+      "status": "delivered",
+      "dropoff": {
+        "phone_number": "555-555-5555",
+        "notes": "Optional note that this is Invoice #123",
+        "location": {
+          "lat": 37.7811372,
+          "lng": -122.4123037
+        },
+        "name": "The Warehouse, Optional Pickup Business Name, Inc.",
+        "address": "20 McAllister Street"
+      },
+      "updated": "2014-12-31T17:32:49Z",
+      "fee": 1350,
+      "quote_id": "dqt_K9Fmi-hAt07qS-",
+      "complete": true,
+      "courier": null,
+      "created": "2014-12-31T17:30:32Z",
+      "kind": "delivery",
+      "manifest": {
+        "description": "a box of kittens"
+      },
+      "currency": "usd",
+      "pickup": {
+        "phone_number": "415-555-1234",
+        "notes": "Optional note to ring the bell",
+        "location": {
+          "lat": 37.7930812,
+          "lng": -122.395944
+        },
+        "name": "Alice, Optional Dropoff Business Name, Inc.",
+        "address": "101 Market Street"
+      },
+      "dropoff_deadline": "2014-12-31T18:31:32Z",
+      "live_mode": false,
+      "pickup_eta": null,
+      "dropoff_eta": null,
+      "id": "del_K9FmiEl7tKY2i-"
+    },
+    {
+      "status": "delivered",
+      "dropoff": {
+        "phone_number": "415-555-1234",
+        "notes": "Optional note to ring the bell",
+        "location": {
+          "lat": 37.7930812,
+          "lng": -122.395944
+        },
+        "name": "Alice, Optional Dropoff Business Name, Inc.",
+        "address": "101 Market Street"
+      },
+      "updated": "2014-12-31T17:30:09Z",
+      "fee": 1350,
+      "quote_id": "dqt_K9Fln3UUgk4WG-",
+      "complete": true,
+      "courier": null,
+      "created": "2014-12-31T17:28:09Z",
+      "kind": "delivery",
+      "manifest": {
+        "description": "a box of kittens"
+      },
+      "currency": "usd",
+      "pickup": {
+        "phone_number": "555-555-5555",
+        "notes": "Optional note that this is Invoice #123",
+        "location": {
+          "lat": 37.7811372,
+          "lng": -122.4123037
+        },
+        "name": "The Warehouse, Optional Pickup Business Name, Inc.",
+        "address": "20 McAllister Street"
+      },
+      "dropoff_deadline": "2014-12-31T18:28:09Z",
+      "live_mode": false,
+      "pickup_eta": null,
+      "dropoff_eta": null,
+      "id": "del_K9Fm9OU1DhW3x-"
+    },
+    {
+      "status": "canceled",
+      "dropoff": {
+        "phone_number": "415-555-1234",
+        "notes": "Optional note to ring the bell",
+        "location": {
+          "lat": 37.7930812,
+          "lng": -122.395944
+        },
+        "name": "Alice, Optional Dropoff Business Name, Inc.",
+        "address": "101 Market Street"
+      },
+      "updated": "2014-12-31T03:36:10Z",
+      "fee": 1350,
+      "quote_id": "dqt_K9Cir_jMr6pQD-",
+      "complete": true,
+      "courier": null,
+      "created": "2014-12-31T03:35:32Z",
+      "kind": "delivery",
+      "manifest": {
+        "description": "a box of kittens"
+      },
+      "currency": "usd",
+      "pickup": {
+        "phone_number": "555-555-5555",
+        "notes": "Optional note that this is Invoice #123",
+        "location": {
+          "lat": 37.7811372,
+          "lng": -122.4123037
+        },
+        "name": "The Warehouse, Optional Pickup Business Name, Inc.",
+        "address": "20 McAllister Street"
+      },
+      "dropoff_deadline": "2014-12-31T04:35:32Z",
+      "live_mode": false,
+      "pickup_eta": null,
+      "dropoff_eta": null,
+      "id": "del_K9Cj0ADtceFwZV"
+    },
+    {
+      "status": "delivered",
+      "dropoff": {
+        "phone_number": "415-555-1234",
+        "notes": "Optional note to ring the bell",
+        "location": {
+          "lat": 37.7930812,
+          "lng": -122.395944
+        },
+        "name": "Alice, Optional Dropoff Business Name, Inc.",
+        "address": "101 Market Street"
+      },
+      "updated": "2014-12-26T01:57:57Z",
+      "fee": 1350,
+      "quote_id": "dqt_K8mzmLxTbVBc--",
+      "complete": true,
+      "courier": null,
+      "created": "2014-12-26T01:56:08Z",
+      "kind": "delivery",
+      "manifest": {
+        "description": "a box of kittens"
+      },
+      "currency": "usd",
+      "pickup": {
+        "phone_number": "555-555-5555",
+        "notes": "Optional note that this is Invoice #123",
+        "location": {
+          "lat": 37.7811372,
+          "lng": -122.4123037
+        },
+        "name": "The Warehouse, Optional Pickup Business Name, Inc.",
+        "address": "20 McAllister Street"
+      },
+      "dropoff_deadline": "2014-12-26T02:56:08Z",
+      "live_mode": false,
+      "pickup_eta": null,
+      "dropoff_eta": null,
+      "id": "del_K8n-DBrcvQXVGV"
+    },
+    {
+      "status": "delivered",
+      "dropoff": {
+        "phone_number": "415-555-1234",
+        "notes": "Optional note to ring the bell",
+        "location": {
+          "lat": 37.7930812,
+          "lng": -122.395944
+        },
+        "name": "Alice, Optional Dropoff Business Name, Inc.",
+        "address": "101 Market Street"
+      },
+      "updated": "2014-12-26T00:30:24Z",
+      "fee": 1350,
+      "quote_id": "dqt_K8mf7VkEo5-n-V",
+      "complete": true,
+      "courier": null,
+      "created": "2014-12-26T00:28:12Z",
+      "kind": "delivery",
+      "manifest": {
+        "description": "a box of kittens"
+      },
+      "currency": "usd",
+      "pickup": {
+        "phone_number": "555-555-5555",
+        "notes": "Optional note that this is Invoice #123",
+        "location": {
+          "lat": 37.7811372,
+          "lng": -122.4123037
+        },
+        "name": "The Warehouse, Optional Pickup Business Name, Inc.",
+        "address": "20 McAllister Street"
+      },
+      "dropoff_deadline": "2014-12-26T02:28:12Z",
+      "live_mode": false,
+      "pickup_eta": null,
+      "dropoff_eta": null,
+      "id": "del_K8mfb4I7idlgh-"
+    }
+  ],
+  "next_href": null
+}