PostmatesRuby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 02f5131e6b17ffa920de136647548cb2f52e5b5e
+  data.tar.gz: d486955945ab482d8863a768e4d074d503c5b52b
+SHA512:
+  metadata.gz: 7de42deecd0a1fa0d25ed9a6bd9554361c0c98cfd00c288415ae36266582267ab3e1a0c8edcfe6639fbeb674f9bd4fc50df7b87969eabcabe0b07342b1953460
+  data.tar.gz: 58f08fcc6f669f8e94c84f5eac04af3fac31549d74fe940bc44799ec8d7a1b04c9d508c0079eb4167e7f1b3db8c98f5f162f6418a3d313e7164bade98eb8ed73

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea/
+.DS_Store

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/PostmatesRuby.gemspec

@@ -0,0 +1,25 @@
+# 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 |spec|
+  spec.name          = "PostmatesRuby"
+  spec.version       = Postmates::VERSION
+  spec.authors       = ["Matt Dunbar"]
+  spec.email         = ["matt@buildrx.com"]
+  spec.summary       = 'Ruby Gem providing a wrapper for the Postmates API.'
+  spec.homepage      = ""
+
+  spec.add_runtime_dependency('faraday', ['>= 0.7', '< 0.10'])
+  spec.add_runtime_dependency('faraday_middleware', ['>= 0.8', '< 0.10'])
+  spec.add_runtime_dependency('multi_json', '>= 1.0.3', '~> 1.0')
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/README.md

@@ -0,0 +1,20 @@
+# Postmates
+
+Overview here...
+
+## Usage
+
+Usage example(s) here...
+
+## Legal
+
+Portions of the codebase are from Instagram's Ruby Gem.
+
+As a result, the following may apply to parts or all of this gem:
+https://github.com/Instagram/instagram-ruby-gem/blob/master/PATENTS.md
+https://github.com/Instagram/instagram-ruby-gem/blob/master/LICENSE.md
+
+Consult your own legal counsel for clarification.
+
+Instagram Ruby Gem's remnants:
+Copyright (c) 2014, Facebook, Inc. All rights reserved.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/Postmates/client.rb

@@ -0,0 +1,23 @@
+require 'Postmates/connection'
+require 'Postmates/request'
+
+module Postmates
+  class Client
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each{|f| require f}
+
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    def initialize(options={})
+      options = Postmates.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    include Postmates::Connection
+    include Postmates::Request
+
+    include Postmates::Client::Delivery
+    include Postmates::Client::DeliveryQuote
+  end
+end

data/lib/Postmates/client/delivery.rb

@@ -0,0 +1,12 @@
+module Postmates
+  class Client
+    module Delivery
+      def create_delivery(options={})
+        post('deliveries', options)
+      end
+      def poll_delivery(delivery_id)
+        get("deliveries/#{delivery_id}")
+      end
+    end
+  end
+end

data/lib/Postmates/client/delivery_quote.rb

@@ -0,0 +1,9 @@
+module Postmates
+  class Client
+    module DeliveryQuote
+      def delivery_quote(options={})
+        post('delivery_quotes', options) # @TODO merge options with auth
+      end
+    end
+  end
+end

data/lib/Postmates/configuration.rb

@@ -0,0 +1,44 @@
+require 'faraday'
+require 'Postmates/version'
+
+module Postmates
+  module Configuration
+    VALID_OPTIONS_KEYS = [
+        :customer_id,
+        :api_key,
+        :adapter,
+        :endpoint,
+        :api_version
+    ].freeze
+
+    DEFAULT_CUSTOMER_ID = nil
+    DEFAULT_API_KEY = nil
+    DEFAULT_ADAPTER = Faraday.default_adapter
+    DEFAULT_ENDPOINT = 'https://api.postmates.com/v1/'.freeze
+    DEFAULT_API_VERSION = '20150117'.freeze
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    def reset
+      self.customer_id = DEFAULT_CUSTOMER_ID
+      self.api_key = DEFAULT_API_KEY
+      self.adapter = DEFAULT_ADAPTER
+      self.endpoint = DEFAULT_ENDPOINT
+      self.api_version = DEFAULT_API_VERSION
+    end
+  end
+end

data/lib/Postmates/connection.rb

@@ -0,0 +1,18 @@
+require 'faraday_middleware'
+Dir[File.expand_path('../../faraday/*.rb', __FILE__)].each{|f| require f}
+
+module Postmates
+  module Connection
+    private
+    def connection
+      conn = Faraday.new(:url => "#{endpoint}customers/#{customer_id}/") do |c|
+        c.use Faraday::Request::UrlEncoded
+        c.use FaradayMiddleware::Mashify
+        c.use Faraday::Response::ParseJson
+        c.use FaradayMiddleware::RaiseHttpException
+        c.adapter(adapter)
+      end
+      conn
+    end
+  end
+end

data/lib/Postmates/error.rb

@@ -0,0 +1,19 @@
+module Postmates
+  # Custom error class for rescuing from all errors
+  class Error < StandardError; end
+
+  # Raised when Postmates returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when Postmates returns the HTTP status code 401
+  class Unauthorized < Error; end
+
+  # Raised when Postmates returns the HTTP status code 404
+  class NotFound < Error; end
+
+  # Raised when Postmates returns the HTTP status code 500
+  class InternalServerError < Error; end
+
+  # Raised when Postmates returns the HTTP status code 503
+  class ServiceUnavailable < Error; end
+end

data/lib/Postmates/objects/base.rb

@@ -0,0 +1,16 @@
+module Postmates
+  module Objects
+    class Base
+      @@OBJECT_FIELDS = []
+      attr_accessor *@@OBJECT_FIELDS
+
+      def initialize data
+        data.each do |k,v|
+          if @@OBJECT_FIELDS.include?(k.to_sym)
+            send("#{k}=", v)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/Postmates/objects/delivery.rb

@@ -0,0 +1,23 @@
+module Postmates
+  module Objects
+    class Delivery < Postmates::Objects::Base
+      @@OBJECT_FIELDS = [
+          :created,
+          :updated,
+          :status,
+          :complete,
+          :pickup_eta,
+          :dropoff_eta,
+          :dropoff_deadline,
+          :quote_id,
+          :fee,
+          :currency,
+          :manifest,
+          :pickup,
+          :dropoff,
+          :courier
+      ].freeze
+      attr_accessor *@@OBJECT_FIELDS
+    end
+  end
+end

data/lib/Postmates/objects/delivery_quote.rb

@@ -0,0 +1,16 @@
+module Postmates
+  module Objects
+    class DeliveryQuote < Postmates::Objects::Base
+      @@OBJECT_FIELDS = [
+          :id,
+          :created,
+          :expires,
+          :fee,
+          :currency,
+          :dropoff_eta,
+          :duration
+      ].freeze
+      attr_accessor *@@OBJECT_FIELDS
+    end
+  end
+end

data/lib/Postmates/request.rb

@@ -0,0 +1,44 @@
+require 'Postmates/response'
+
+module Postmates
+  # Defines HTTP request methods
+  module Request
+    # Perform an HTTP GET request
+    def get(path, options={})
+      request(:get, path, options)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, options={})
+      request(:post, path, options)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path, options={})
+      request(:put, path, options)
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(path, options={})
+      request(:delete, path, options)
+    end
+
+    private
+
+    # Perform an HTTP request
+    def request(method, path, options)
+      conn = connection
+      conn.basic_auth(api_key, '')
+      response = conn.send(method) do |request|
+        case method
+          when :get, :delete
+            request.url(path, options)
+          when :post, :put
+            request.path = path
+            request.body = options unless options.empty?
+        end
+      end
+      Response.create( response.body )
+    end
+  end
+end

data/lib/Postmates/response.rb

@@ -0,0 +1,26 @@
+require 'json'
+require 'Postmates/error'
+Dir[File.expand_path('../objects/*.rb', __FILE__)].each{|f| require f}
+module Postmates
+  module Response
+    def self.create( object )
+      parse_object object
+    end
+
+    private
+    def self.parse_object object
+      case object['kind']
+        when 'delivery'
+          Postmates::Objects::Delivery.new(object)
+        when 'delivery_quote'
+          Postmates::Objects::DeliveryQuote.new(object)
+        when 'list'
+          object['list'].map{|obj| parse_object(obj)}
+        when 'error'
+          raise Postmates::Error, "#{object['code']}: #{object['message']} ---- #{object.inspect}"
+        else
+          raise Postmates::Error, 'Invalid Response Kind'
+      end
+    end
+  end
+end

data/lib/Postmates/version.rb

@@ -0,0 +1,3 @@
+module Postmates
+  VERSION = '0.0.1'.freeze
+end

data/lib/PostmatesRuby.rb

@@ -0,0 +1,20 @@
+require 'Postmates/version'
+require 'Postmates/configuration'
+require 'Postmates/client'
+
+module Postmates
+  extend Configuration
+
+  def self.client(options={})
+    Postmates::Client.new(options)
+  end
+
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  def self.respond_to?(method, include_all=false)
+    return client.respond_to?(method, include_all) || super
+  end
+end

data/lib/faraday/raise_http_exception.rb

@@ -0,0 +1,55 @@
+require 'faraday'
+
+# @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 Postmates::BadRequest, error_message_400(response)
+          when 401
+            raise Postmates::Unauthorized, error_message_400(response)
+          when 404
+            raise Postmates::NotFound, error_message_400(response)
+          when 500
+            raise Postmates::InternalServerError, error_message_500(response, "Something is technically wrong.")
+          when 503
+            raise Postmates::ServiceUnavailable, error_message_500(response, "Service is currently unavailable.")
+        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}: #{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)
+        # removed multi_json thanks to wesnolte's commit
+        body = ::JSON.parse(body)
+      end
+
+      if body.nil?
+        nil
+      elsif body['meta'] and body['meta']['error_message'] and not body['meta']['error_message'].empty?
+        ": #{body['meta']['error_message']}"
+      elsif body['error_message'] and not body['error_message'].empty?
+        ": #{body['error_type']}: #{body['error_message']}"
+      end
+    end
+
+    def error_message_500(response, body=nil)
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{[response[:status].to_s + ':', body].compact.join(' ')}"
+    end
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: PostmatesRuby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matt Dunbar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- matt@buildrx.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- PostmatesRuby.gemspec
+- README.md
+- Rakefile
+- lib/Postmates/client.rb
+- lib/Postmates/client/delivery.rb
+- lib/Postmates/client/delivery_quote.rb
+- lib/Postmates/configuration.rb
+- lib/Postmates/connection.rb
+- lib/Postmates/error.rb
+- lib/Postmates/objects/base.rb
+- lib/Postmates/objects/delivery.rb
+- lib/Postmates/objects/delivery_quote.rb
+- lib/Postmates/request.rb
+- lib/Postmates/response.rb
+- lib/Postmates/version.rb
+- lib/PostmatesRuby.rb
+- lib/faraday/raise_http_exception.rb
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby Gem providing a wrapper for the Postmates API.
+test_files: []