postmates 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7cf00b57dc6151452b0a344584891a6428e8bb25
+  data.tar.gz: 8639fcb84ca1e2c4d15ab8703848c37027be5239
+SHA512:
+  metadata.gz: f603412097d99cb59f93589e0a9fa43939241e7626c646606be5c5b4b4377b6f46818dfdce7de4f238f86528d397445ad9348a35bd0286b85fa898202fc30b80
+  data.tar.gz: 221fd57a328ef694ebd35a978cfcabb3cf81fb2ae418fe022cddf7009567e192c323f100d78ce304ad808d58f79c2cc5d3c7c1d81f208edf92d96a32b8bff0f6

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.gem
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--order random
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - jruby-19mode
+  - jruby-head
+  - rbx-2
+  - ruby-head
+
+env:
+  global:
+    - JRUBY_OPTS="$JRUBY_OPTS --debug"
+
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: rbx-2
+    - rvm: ruby-head
+  fast_finish: true

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in postmates.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Rahul Horé
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,137 @@
+# Postmates
+[![Build Status](https://travis-ci.org/O-I/postmates.svg?branch=master)](https://travis-ci.org/O-I/postmates)
+[![Coverage Status](https://img.shields.io/coveralls/O-I/postmates.svg)](https://coveralls.io/r/O-I/postmates?branch=master)
+
+Ruby wrapper for the [Postmates API](https://postmates.com/developer/docs).
+
+## Installation
+
+`gem install 'postmates'` or add `gem 'postmates'` to your Gemfile and `bundle`.
+
+## Configuration
+
+You'll need an API key and your customer ID. You can sign up to register your app [here](https://postmates.com/developer/register). Just want to test things out? Postmates has you covered with a [test key and customer account](https://postmates.com/developer/testing).
+
+```ruby
+# Create a new Postmates client
+@client = Postmates.new
+
+# Set basic config variables
+@client.configure do |config|
+  config.api_key = 'YOUR_API_KEY'
+  config.customer_id = 'YOUR_CUSTOMER_ID'
+end
+
+# Or do some more advanced stuff
+@client.configure do |config|
+  # Get full Faraday responses instead of Ruby objects representing the body
+  config.raw_response = true
+  # Ensure consistent fields & formats by specifying a version in the header
+  config.headers.merge!('X-Postmates-Version' => 20140825)
+  # Work with a possible future version of the API
+  config.api_url = 'https://api.postmates.com/v2/'
+end
+
+# And switch back to the defaults easily
+@client.reset
+```
+
+## Usage
+
+Descriptions and examples of the supported actions are below. For a more detailed explanation of available endpoints and an exhaustive list of the properties each response returns, check out the official Postmates developer [documentation](https://postmates.com/developer/docs).
+
+### Customer Deliveries Endpoints
+
+#### POST /v1/customers/:customer_id/delivery_quotes
+
+Get a delivery quote. Returns a `Postmates::Quote` object.
+
+```ruby
+from  = "20 McAllister St, San Francisco, CA"
+to    = "101 Market St, San Francisco, CA"
+quote = @client.quote(pickup_address: from, dropoff_address: to)
+
+quote.fee                          # => 1350
+quote.currency                     # => "usd"
+format = '%m/%d/%Y %I:%M:%S%p'     # all times are returned in UTC
+quote.expires_at.strftime(format)  # => "01/05/2015 09:35:28PM"
+quote.expired?                     # => false
+```
+
+#### POST /v1/customers/:customer_id/deliveries
+
+Create a delivery. Returns a `Postmates::Delivery` object.
+
+```ruby
+# all fields required except where noted
+package = { 
+            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" # optional
+          }
+delivery = @client.create(package)
+
+delivery.id         # => "del_K9gEsDNuPJ-lLV"
+delivery.status     # => "pending"
+delivery.delivered? # => false
+delivery.pickup     # a hash representing pickup information
+delivery.dropoff    # a hash representing dropoff information
+```
+
+#### GET /v1/customers/:customer_id/deliveries
+
+Fetch a list of all deliveries for a customer. Returns an array of `Postmates::Delivery` objects.
+
+```ruby
+my_deliveries = @client.list
+my_ongoing_deliveries = @client.list(filter: 'pending')
+
+# If the result is too large for one response
+# there are a few meta-attributes you can call on the returned array
+# Here's a simulated example of a paginated response:
+deliveries = @client.list(limit: 2)
+deliveries.size        # => 2 (number of deliveries in the returned array)
+deliveries.total_count # => 6 (number of total deliveries)
+deliveries.next_href   # a URI object representing the path to the next page
+```
+
+#### GET /v1/customers/:customer_id/deliveries/:delivery_id
+
+Fetch a single delivery by id. Returns a `Postmates::Delivery` object.
+
+```ruby
+@client.retrieve('del_K9gEsDNuPJ-lLV')
+```
+
+#### POST /v1/customers/:customer_id/deliveries/:delivery_id/cancel
+
+Cancel an ongoing delivery prior to pickup. Returns a `Postmates::Delivery` object.
+
+```ruby
+@client.cancel('del_K9gEsDNuPJ-lLV')
+```
+
+#### POST /v1/customers/:customer_id/deliveries/:delivery_id/return
+
+Cancel an ongoing delivery that was already picked up and create a delivery that is a reverse of the original. The items will get returned to the original pickup location. Returns a `Postmates::Delivery` object.
+
+```ruby
+@client.cancel('del_K9gEsDNuPJ-lLV')
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/postmates/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/lib/faraday/raise_http_exception.rb

@@ -0,0 +1,28 @@
+require 'json'
+require 'faraday'
+require_relative '../postmates/error'
+
+module FaradayMiddleware
+  class RaiseHTTPException < Faraday::Middleware
+    def call(env)
+      @app.call(env).on_complete do |response|
+        response_hash = JSON.parse(response.body)
+        msg = "#{response[:status]} #{response_hash['message']}"
+
+        case response[:status]
+        when 400 ; raise Postmates::BadRequest,          msg
+        when 401 ; raise Postmates::Unauthorized,        msg
+        when 403 ; raise Postmates::Forbidden,           msg
+        when 404 ; raise Postmates::NotFound,            msg
+        when 500 ; raise Postmates::InternalServerError, msg
+        when 503 ; raise Postmates::ServiceUnavailable,  msg
+        end
+      end
+    end
+
+    def initialize(app)
+      super app
+      @parser = nil
+    end
+  end
+end

data/lib/postmates.rb

@@ -0,0 +1,19 @@
+require_relative 'postmates/client'
+
+module Postmates
+  class << self
+
+    def new
+      @client ||= Postmates::Client.new
+    end
+
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private = false)
+      new.respond_to?(method, include_private) || super
+    end
+  end
+end

data/lib/postmates/client.rb

@@ -0,0 +1,81 @@
+require_relative 'request'
+require_relative 'connection'
+require_relative 'configuration'
+
+module Postmates
+  class Client
+    include Postmates::Request
+    include Postmates::Connection
+    include Postmates::Configuration
+
+    def initialize
+      reset
+    end
+
+    # POST /v1/customers/:customer_id/delivery_quotes
+    #
+    # pickup_address="20 McAllister St, San Francisco, CA"
+    # dropoff_address="101 Market St, San Francisco, CA"
+    #
+    # Returns a Quote object or the raw Faraday response
+    # if raw_response = true
+    def quote(options = {})
+      post("customers/#{customer_id}/delivery_quotes", options)
+    end
+
+    # POST /v1/customers/:customer_id/deliveries
+    #
+    # 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=qUdje83jhdk
+    #
+    # Returns a Delivery object or the raw Faraday response
+    # if raw_response = true
+    def create(options = {})
+      post("customers/#{customer_id}/deliveries", options)
+    end
+
+    # GET /v1/customers/:customer_id/deliveries
+    #
+    # ?filter=ongoing
+    #
+    # Returns a list of Delivery objects or the raw Faraday response
+    # if raw_response = true
+    def list(options = {})
+      get("customers/#{customer_id}/deliveries", options)
+    end
+
+    # GET /v1/customers/:customer_id/deliveries/:delivery_id
+    #
+    # Returns a Delivery object or the raw Faraday response
+    # if raw_response = true
+    def retrieve(delivery_id)
+      get("customers/#{customer_id}/deliveries/#{delivery_id}")
+    end
+
+    # POST /v1/customers/:customer_id/deliveries/:delivery_id/cancel
+    #
+    # Returns a Delivery object or the raw Faraday response
+    # if raw_response = true
+    def cancel(delivery_id)
+      post("customers/#{customer_id}/deliveries/#{delivery_id}/cancel")
+    end
+
+    # POST /v1/customers/:customer_id/deliveries/:delivery_id/return
+    #
+    # Returns a Delivery object or the raw Faraday response
+    # if raw_response = true
+    def return(delivery_id)
+      post("customers/#{customer_id}/deliveries/#{delivery_id}/return")
+    end
+  end
+end

data/lib/postmates/configuration.rb

@@ -0,0 +1,30 @@
+require_relative 'version'
+
+module Postmates
+  module Configuration
+
+    VALID_CONFIGURATION_KEYS = [:headers, :api_url, :api_key,
+                                :customer_id, :raw_response]
+
+    attr_accessor *VALID_CONFIGURATION_KEYS
+
+    DEFAULT_API_URL = 'https://api.postmates.com/v1/'
+    DEFAULT_HEADERS = {
+                        accept: 'application/json',
+                        user_agent: "postmates gem #{Postmates::Version}"
+                      }
+
+    def configure
+      yield self
+    end
+
+    def reset
+      self.headers      = DEFAULT_HEADERS
+      self.api_url      = DEFAULT_API_URL
+      self.api_key      = nil
+      self.customer_id  = nil
+      self.raw_response = false
+      self
+    end
+  end
+end

data/lib/postmates/connection.rb

@@ -0,0 +1,25 @@
+require 'faraday_middleware'
+require_relative '../faraday/raise_http_exception'
+
+module Postmates
+  module Connection
+
+    private
+
+    def connection
+      options = {
+        headers: headers,
+        ssl: { verify: false },
+        url: api_url
+      }
+
+      Faraday.new(options) do |connection|
+        connection.use Faraday::Request::UrlEncoded
+        connection.use Faraday::Request::BasicAuthentication, api_key, ''
+        connection.use Faraday::Response::ParseJson
+        connection.use FaradayMiddleware::RaiseHTTPException
+        connection.adapter(Faraday.default_adapter)
+      end
+    end
+  end
+end

data/lib/postmates/delivery.rb

@@ -0,0 +1,33 @@
+require_relative 'utils'
+
+module Postmates
+  class Delivery
+    include Postmates::Utils
+    attr_reader :id, :created_at, :updated_at, :status, :complete,
+                :pickup_eta, :dropoff_eta, :dropoff_deadline,
+                :quote_id, :fee, :currency, :manifest, :pickup,
+                :dropoff, :courier, :image_url
+
+    def initialize(hash)
+      @id          =         hash['id']
+      @status      =         hash['status']
+      @complete    =         hash['complete']
+      @quote_id    =         hash['quote_id']
+      @fee         =         hash['fee']
+      @currency    =         hash['currency']
+      @manifest    =         hash['manifest']
+      @pickup      =         hash['pickup']
+      @dropoff     =         hash['dropoff']
+      @courier     =         hash['courier']
+      @image_url   =  urlify hash['image_href']
+      @created_at  = timeify hash['created']
+      @updated_at  = timeify hash['updated']
+      @pickup_eta  = timeify hash['pickup_eta']
+      @dropoff_eta = timeify hash['dropoff_eta']
+    end
+
+    def delivered?
+      status == 'delivered'
+    end
+  end
+end