shiphawk 0.8.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 736c27fe2f846958539936391e0a082fa381e96e
+  data.tar.gz: ae41dfee86cd09abea89dab786e99195fe28f332
+SHA512:
+  metadata.gz: 461e92ec608a618284836d16e23d687238c13f2dcdce32235f3fc8831fe4af925a12565921e17840b5e69e320a6ed0de50fcc3c785338dd169d82a6c3a79bfe2
+  data.tar.gz: f4f20d8e2ede02b7a4658813afca83b305dab6db75676a7559d3607b853f1fd93900d256a91cf07d261f3c49d50b27aebf449daa7129441b31e11a50896564ea

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/.idea
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/EXAMPLES.md

@@ -0,0 +1,155 @@
+# Shiphawk::Client Gem Examples
+
+## Client Initialization
+
+To make a connection to a ShipHawk server, create a Client connection:
+
+```ruby
+    require 'rubygems'
+    require 'shiphawk'
+
+    # get an item based on item id
+    client = Shiphawk::Client.new(api_token: 'api_token')
+```
+
+Shiphawk::Client initialize takes a parameter hash to configure a connection. The parameters hash can consistent of:
+
+```ruby
+    PRODUCTION_API_HOST = 'https://shiphawk.com'
+    DEFAULT_API_VERSION = 'v3'
+
+    @api_token = @options.delete(:api_token) { |key| Shiphawk.api_token }
+    @api_version = @options.delete(:api_version) { |key| DEFAULT_API_VERSION }
+    @host_url = @options.delete(:host_url) { |key| PRODUCTION_API_HOST }
+    @adapter = @options.delete(:adapter) { |key| Faraday.default_adapter }
+```
+
+## Items retrieval and searching
+
+### Item retrieval
+
+Here's an example of retrieving an Item given the Item ID using the Shiphawk::Client API
+
+```ruby
+    require 'rubygems'
+    require 'shiphawk'
+
+    # get an item based on item id
+    client = Shiphawk::Client.new(api_token: 'api_token')
+    client.items_show 2335
+```
+
+## Notifications
+
+Currently undocumented on Shiphawk's api guide, so please disregard for now.
+
+```ruby
+    require 'rubygems'
+    require 'shiphawk'
+
+    # get an item based on item id
+    client = Shiphawk::Client.new(api_token: 'api_token')
+```
+
+## Products
+
+Implemented but undocumented. Not sure how this is supposed to work.
+
+```ruby
+    require 'rubygems'
+    require 'shiphawk'
+
+    # get an item based on item id
+    client = Shiphawk::Client.new(api_token: 'api_token')
+```
+
+## Rates
+
+Get a shipping quote. Documentation here: https://shiphawk.com/api-docs#!/rates/POST_api_version_rates_format
+
+Creating a quote
+```ruby
+    require 'rubygems'
+    require 'shiphawk'
+
+    client = Shiphawk::Client.new(api_token: 'api_token')
+
+    custom_attributes = {
+      value: declared_value_per_lot, quantity: lot_size, id: shiphawk_item_id,
+      width: width, length: depth, height: height, packed: is_packed?,
+      weight: shipping_weight_in_pounds, name: name, xid: barcode,
+    }
+
+    client.create_rate(data.merge(custom_attributes))
+
+```
+
+## Shipment Notes
+
+Create customer note about a shipment
+
+```ruby
+    require 'rubygems'
+    require 'shiphawk'
+
+    Shiphawk.notes_update(shipment_id, {body: "This is a classy note"})
+```
+
+## Shipment Tracking
+
+Subscribe to tracking notifications for a shipment.
+
+```ruby
+    require 'rubygems'
+    require 'shiphawk'
+
+    Shiphawk.shipments_status_update(shipment_id, {callback_url:  "www.someawesomecallback.com/shipment-tracking-callback/#{shipment_id}"})
+```
+
+## Shipments
+
+Create a shipment
+
+```ruby
+    require 'rubygems'
+    require 'shiphawk'
+
+    data = {
+      xid: buyer_invoice.to_s,
+      rate_id: shiphawk_quote_id,
+      destination_address:
+      {
+        first_name: user.first_name, last_name: user.last_name,
+        company: name, phone_num: user.phone, email: user.email,
+        address_line_1: address, address_line_2: floor_suite,
+        city: city, state: state, zipcode: zip
+      },
+      billing_address: shiphawk_region_rep,
+      origin_contact: shiphawk_region_rep,
+      accessorials: [],
+      order_email: shiphawk_region_rep[:email],
+      pickup_data: pickup_data  
+    }
+
+    Shiphawk.shipments_create(data)
+```
+
+## Shipments Status
+
+Update a number of shipments at once (need to confirm)
+
+```ruby
+    require 'rubygems'
+    require 'shiphawk'
+    Shiphawk.shipments_status_update({shipment_ids: [1,2,3], status: "in_transit"})
+```
+
+## Zip Codes
+
+Get all zip codes using pagination.
+
+```ruby
+    require 'rubygems'
+    require 'shiphawk'
+    Shiphawk.zip_codes_index
+```

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Hawk Applications Corp.
+
+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,42 @@
+# Shiphawk::Client
+
+Ruby wrapper for the ShipHawk V3 API. The ShipHawk::Client gem provides an easy-to-use wrapper for ShipHawk's REST APIs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shiphawk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shiphawk
+
+## Usage
+
+[View the Examples](EXAMPLES.md)
+
+## End points
+
+## Errors and Exceptions
+
+When an *error status* is received from the server, the gem will raise an error on the client side:
+
+* 400 raises Shiphawk::Errors::GeneralError
+* 401 raises Shiphawk::Errors::UnauthorizedError
+* 403 raises Shiphawk::Errors::AccessDeniedError
+* 404 raises Shiphawk::Errors::NotFoundError
+* 422 raises Shiphawk::Errors::UnprocessableEntityError
+* 500 raises Shiphawk::Errors::InformShiphawkError
+* 502 raises Shiphawk::Errors::UnavailableError
+* 503 raises Shiphawk::Errors::UnavailableError
+
+## Copyright
+
+Copyright (c) 2015 Hawk Applications Corp. See LICENSE for details.

data/Rakefile

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

data/history.txt

@@ -0,0 +1,5 @@
+=== 0.8.1 2015-11-03
+
+* Remove .gem file from repo (it's redundant and could get out of sync with the releases).
+* Fix README and EXAMPLES from referencing shiphawk-ruby to just shiphawk.
+* Fix copyright.

data/lib/shiphawk.rb

@@ -0,0 +1,43 @@
+module Shiphawk
+
+  class << self
+    # config/initializers/shiphawk.rb (for instance)
+    #
+    # ```ruby
+    # Shiphawk.configure do |config|
+    #   config.token = 'api_token'
+    # end
+    # ```
+    # elsewhere
+    #
+    # ```ruby
+    # client = ShiphawkClient::Client.new
+    # ```
+    #
+    # You can also chose to use the class as a singleton
+    #
+    # ```ruby
+    # Shiphawk.{method_name}
+    # ```
+
+    def configure
+      yield self
+      true
+    end
+
+    def method_missing(method, *args, &block)
+      return super unless self::Client.new.respond_to?(method)
+      self::Client.new.send(method, *args, &block)
+    end
+
+    attr_accessor :api_token, :sandbox
+  end
+
+  autoload :Api,     'shiphawk/api'
+  autoload :Client,  'shiphawk/client'
+  autoload :Mash,    'shiphawk/mash'
+  autoload :Errors,  'shiphawk/errors'
+  autoload :Helpers, 'shiphawk/helpers'
+  autoload :Version, 'shiphawk/version'
+
+end

data/lib/shiphawk/api.rb

@@ -0,0 +1,20 @@
+module Shiphawk
+  module Api
+
+    attr_accessor :params
+
+    # load dependent code
+    autoload :QueryHelpers,     'shiphawk/api/query_helpers'
+    autoload :Items,            'shiphawk/api/items'                # get /, get /search, get /:id
+    autoload :Categories,       'shiphawk/api/categories'           # get /, get /:id, post /, put /, delete /
+    autoload :Products,         'shiphawk/api/products'             # get /:id, post /, put /, delete /
+    autoload :Rates,            'shiphawk/api/rates'                # get :id, post /
+    autoload :ShipmentNotes,    'shiphawk/api/shipment_notes'       # get /:id/notes, post /:id/notes
+    autoload :ShipmentTracking, 'shiphawk/api/shipment_tracking'    # get /:id/tracking, put /:id/tracking
+    autoload :Shipments,        'shiphawk/api/shipments'            # get /, get :id, get :id/bol, get :id/bol.pdf, post /, put :id, delete :id
+    autoload :ShipmentsStatus,  'shiphawk/api/shipments_status'     # put /
+    autoload :ZipCodes,         'shiphawk/api/zip_codes'            # get /, get /search
+    autoload :Notifications,    'shiphawk/api/notifications'        # post /
+
+  end
+end

data/lib/shiphawk/api/api_keys.rb

@@ -0,0 +1,20 @@
+module Shiphawk
+  module Api
+
+    # ApiKeys API
+    #
+    # @see https://shiphawk.com/api-docs
+    #
+    # The following API actions provide the CRUD interface to managing api keys.
+    #
+    module ApiKeys
+
+      # Get all API keys for an account using an API key
+      def api_keys_index
+        get_request api_keys_path, {}
+      end
+
+    end
+
+  end
+end

data/lib/shiphawk/api/categories.rb

@@ -0,0 +1,34 @@
+module Shiphawk
+  module Api
+
+    # Categories API
+    #
+    # @see https://shiphawk.com/api-docs
+    #
+    # The following API actions provide the CRUD interface to managing categories.
+    #
+    module Categories
+
+      def categories_index
+        collection_request categories_path, 500
+      end
+
+      def categories_show category_id
+        entity_request_with_id categories_path, category_id
+      end
+
+      def categories_create options
+        post_request categories_path, options
+      end
+
+      def categories_update category_id, options
+        put_request categories_path(category_id), options
+      end
+
+      def categories_destroy category_id
+        delete_request categories_path, id: category_id
+      end
+    end
+
+  end
+end

data/lib/shiphawk/api/items.rb

@@ -0,0 +1,27 @@
+module Shiphawk
+  module Api
+
+    # Items API
+    #
+    # @see https://shiphawk.com/api-docs
+    #
+    # The following API actions provide the CRUD interface to managing items.
+    #
+    module Items
+
+      def items_index
+        collection_request items_path, 500
+      end
+
+      def items_show item_id
+        entity_request_with_id items_path, item_id
+      end
+
+      def items_search options
+        entity_request_with_options items_path('search'), q: options.fetch(:q, '')
+      end
+
+    end
+
+  end
+end

data/lib/shiphawk/api/notifications.rb

@@ -0,0 +1,19 @@
+module Shiphawk
+  module Api
+
+    # Items API
+    #
+    # @see https://shiphawk.com/api-docs
+    #
+    # The following API actions provide the CRUD interface to managing items.
+    #
+    module Notifications
+
+      def catalog_sale_create options
+        post_request catalog_sale_path, options
+      end
+
+    end
+
+  end
+end

data/lib/shiphawk/api/products.rb

@@ -0,0 +1,30 @@
+module Shiphawk
+  module Api
+
+    # Products API
+    #
+    # @see https://shiphawk.com/api-docs
+    #
+    # The following API actions provide the CRUD interface to managing products.
+    #
+    module Products
+
+      def products_show product_sku
+        entity_request_with_id products_path, product_sku
+      end
+
+      def products_create options
+        post_request products_path, options
+      end
+
+      def products_update product_sku, options
+        put_request products_path(product_sku), options
+      end
+
+      def products_destroy product_sku
+        delete_request products_path(product_sku), {}
+      end
+    end
+
+  end
+end

data/lib/shiphawk/api/query_helpers.rb

@@ -0,0 +1,74 @@
+module Shiphawk
+  module Api
+
+    module QueryHelpers
+
+      def items_path sub_path=nil
+        "items/#{sub_path}"
+      end
+
+      def categories_path sub_path=nil
+        "categories/#{sub_path}"
+      end
+
+      def products_path sub_path=nil
+        "products/#{sub_path}"
+      end
+
+      def rates_path sub_path=nil
+        "rates/#{sub_path}"
+      end
+
+      def notes_path id
+        shipments_path "#{id}/notes"
+      end
+
+      def tracking_path id
+        shipments_path "#{id}/tracking"
+      end
+
+      def shipments_path sub_path=nil
+        "shipments/#{sub_path}"
+      end
+
+      def status_path
+        shipments_path "status"
+      end
+
+      def notifications_path sub_path=nil
+        "notifications/#{sub_path}"
+      end
+
+      def catalog_sale_path
+        notifications_path "catalog_sale"
+      end
+
+      def zip_codes_path sub_path=nil
+        "zip_codes/#{sub_path}"
+      end
+
+      def collection_request path, count=100
+        page = 1
+        entities = []
+        loop do
+          response = get_request path, {page: page, per_page: count, api_token: self.api_token}
+          entities << response.body
+          entities = entities.flatten
+          break if entities.size >= response.headers['X-Total'].to_i
+          page += 1
+        end
+        entities
+      end
+
+      def entity_request_with_id path, id
+        get_request "#{path}#{id}", {}
+      end
+
+      def entity_request_with_options path, options
+        get_request path, options
+      end
+
+    end
+
+  end
+end

data/lib/shiphawk/api/rates.rb

@@ -0,0 +1,25 @@
+module Shiphawk
+  module Api
+
+    # Rates API
+    #
+    # @see https://shiphawk.com/api-docs
+    #
+    # The following API actions provide the CRUD interface to managing rates.
+    #
+    module Rates
+
+      # Retrieve rates using a Rates ID key
+      def rates_show rate_id
+        entity_request_with_id rates_path, rate_id
+      end
+
+      # Obtain rates given a source
+      def rates_create options
+        post_request rates_path, options
+      end
+
+    end
+
+  end
+end

data/lib/shiphawk/api/shipment_notes.rb

@@ -0,0 +1,23 @@
+module Shiphawk
+  module Api
+
+    # Company API
+    #
+    # @see https://shiphawk.com/api-docs
+    #
+    # The following API actions provide the CRUD interface to managing a company.
+    #
+    module ShipmentNotes
+
+      def shipment_notes_show shipment_id
+        get_request notes_path(shipment_id), {}
+      end
+
+      def shipment_notes_update shipment_id, options
+        put_request notes_path(shipment_id), options
+      end
+
+    end
+
+  end
+end

data/lib/shiphawk/api/shipment_tracking.rb

@@ -0,0 +1,23 @@
+module Shiphawk
+  module Api
+
+    # Company API
+    #
+    # @see https://shiphawk.com/api-docs
+    #
+    # The following API actions provide the CRUD interface to managing multiple shipments by setting status.
+    #
+    module ShipmentTracking
+
+      def shipments_status_show shipment_id
+        get_request tracking_path(shipment_id), {}
+      end
+
+      def shipments_status_update shipment_id, options
+        put_request tracking_path(shipment_id), options
+      end
+
+    end
+
+  end
+end

data/lib/shiphawk/api/shipments.rb

@@ -0,0 +1,43 @@
+module Shiphawk
+  module Api
+
+    # Shipments API
+    #
+    # @see https://shiphawk.com/api-docs
+    #
+    # The following API actions provide the CRUD interface to managing Shipments.
+    #
+    module Shipments
+
+      def shipments_index
+        collection_request shipments_path, 500
+      end
+
+      def shipments_show shipment_id
+        entity_request_with_id shipments_path, shipment_id
+      end
+
+      def shipments_bol shipment_id
+        get_request shipments_path("#{shipment_id}/bol"), {}
+      end
+
+      def shipments_bol_pdf shipment_id
+        get_request shipments_path("#{shipment_id}/bol.pdf"), {}
+      end
+
+      def shipments_create options
+        post_request shipments_path, options
+      end
+
+      def shipments_update shipment_id, options
+        put_request shipments_path(shipment_id), options
+      end
+
+      def shipments_destroy shipment_id
+        delete_request shipments_path(shipment_id), {}
+      end
+
+    end
+
+  end
+end

data/lib/shiphawk/api/shipments_status.rb

@@ -0,0 +1,19 @@
+module Shiphawk
+  module Api
+
+    # Company API
+    #
+    # @see https://shiphawk.com/api-docs
+    #
+    # The following API actions provide the CRUD interface to managing a shipment's tracking.
+    #
+    module ShipmentsStatus
+
+      def shipments_status_update options
+        put_request status_path, options
+      end
+
+    end
+
+  end
+end

data/lib/shiphawk/api/zip_codes.rb

@@ -0,0 +1,23 @@
+module Shiphawk
+  module Api
+
+    # Zip Codes API
+    #
+    # @see https://shiphawk.com/api-docs
+    #
+    # The following API actions provide the CRUD interface to managing zip codes.
+    #
+    module ZipCodes
+
+      def zip_codes_index
+        collection_request zip_codes_path, 1000
+      end
+
+      def zip_codes_search options
+        entity_request_with_options zip_codes_path('search'), q: options.fetch(:q, '')
+      end
+
+    end
+
+  end
+end

data/lib/shiphawk/client.rb

@@ -0,0 +1,31 @@
+module Shiphawk
+  class Client
+
+    PRODUCTION_API_HOST = 'https://shiphawk.com'
+    SANDBOX_API_HOST = 'https://sandbox.shiphawk.com'
+    DEFAULT_API_VERSION = 'v3'
+
+    include Shiphawk::Helpers::Request
+    include Shiphawk::Api::QueryHelpers
+    include Shiphawk::Api::Items
+    include Shiphawk::Api::Rates
+    include Shiphawk::Api::ShipmentNotes
+    include Shiphawk::Api::ShipmentTracking
+    include Shiphawk::Api::Shipments
+    include Shiphawk::Api::ShipmentsStatus
+    include Shiphawk::Api::ZipCodes
+    include Shiphawk::Api::Notifications
+
+    attr_reader :api_token, :options, :sandbox
+
+    def initialize(options={api_token: Shiphawk.api_token})
+      host = Shiphawk.sandbox ? SANDBOX_API_HOST : PRODUCTION_API_HOST
+      @options = options
+      @api_token = @options.delete(:api_token) { |key| Shiphawk.api_token }
+      @api_version = @options.delete(:api_version) { |key| DEFAULT_API_VERSION }
+      @host_url = @options.delete(:host_url) { |key| host }
+      @adapter = @options.delete(:adapter) { |key| Faraday.default_adapter }
+    end
+
+  end
+end

data/lib/shiphawk/errors.rb

@@ -0,0 +1,34 @@
+module Shiphawk
+  module Errors
+
+    class ShiphawkError < StandardError
+      attr_reader :data
+      def initialize(data)
+        @data = data
+        super
+      end
+    end
+
+    # Raised when a 401 response status code is received
+    class UnauthorizedError   < ShiphawkError; end
+
+    # Raised when a 400 response status code is received
+    class GeneralError        < ShiphawkError; end
+
+    # Raised when a 403 response status code is received
+    class AccessDeniedError   < ShiphawkError; end
+
+    # Raised when a 404 response status code is received
+    class NotFoundError       < ShiphawkError; end
+
+    # Raised when a 422 response status code is received
+    class UnprocessableEntityError  < ShiphawkError; end
+
+    # Raised when a 500 response status code is received
+    class InformShiphawkError < ShiphawkError; end
+
+    # Raised when a 502 or 503 response status code is received
+    class UnavailableError    < ShiphawkError; end
+
+  end
+end

data/lib/shiphawk/helpers.rb

@@ -0,0 +1,6 @@
+module Shiphawk
+  module Helpers
+    autoload :Request, 'shiphawk/helpers/request'
+    autoload :Response, 'shiphawk/helpers/response'
+  end
+end

data/lib/shiphawk/helpers/request.rb

@@ -0,0 +1,70 @@
+require 'faraday_middleware'
+require 'faraday/conductivity'
+
+module Shiphawk
+  module Helpers
+
+    module Request
+
+      APP_VERSION = IO.popen(['git', 'rev-parse', 'HEAD', :chdir => Rails.root]).read.chomp
+
+      DEFAULT_HEADERS = {
+          'x-li-format' => 'json'
+      }
+
+      API_PATH = '/api/'
+
+      attr_reader :connection, :host_url, :adapter, :api_version, :api_token
+
+      %w(get post put patch delete).each do |verb|
+        define_method("#{verb}_request") do |endpoint, params|
+          conn = get_connection
+          response = conn.send(verb, "#{API_PATH}#{api_version}/#{endpoint}", params)
+          raise_errors response
+          response
+        end
+      end
+
+      private
+
+      def get_connection
+        raise ArgumentError, 'Incorrect connection information' if host_url.nil? || adapter.nil?
+        @connection ||= Faraday.new(url: host_url) do |conn|
+          conn.request :multipart
+          conn.request :url_encoded
+
+          conn.request :user_agent, app: 'ShipHawk Client', version: APP_VERSION
+          conn.request :request_id
+          conn.request :request_headers, accept: 'application/json', 'X-API-KEY' => api_token
+
+          conn.use :extended_logging, logger: Rails.logger
+
+          conn.response :json, content_type: /\bjson$/
+
+          conn.adapter adapter
+        end
+      end
+
+      def raise_errors response
+        case response.status.to_i
+          when 401
+            fail Shiphawk::Errors::UnauthorizedError, "(#{response.status}): #{response.body['error']}"
+          when 400
+            fail Shiphawk::Errors::GeneralError, "(#{response.status}): #{response.body['error']}"
+          when 403
+            fail Shiphawk::Errors::AccessDeniedError, "(#{response.status}): #{response.body['error']}"
+          when 404
+            fail Shiphawk::Errors::NotFoundError, "(#{response.status}): #{response.body['error']}"
+          when 422
+            fail Shiphawk::Errors::UnprocessableEntityError, "(#{response.status}): #{response.body['error']}"
+          when 500
+            fail Shiphawk::Errors::InformShiphawkError, "ShipHawk had an internal error. Please send an email to api@shiphawk.com. (#{response.status}): #{response.body['error']}"
+          when 502..503
+            fail Shiphawk::Errors::UnavailableError, "(#{response.status}): #{response.body['error']}"
+        end
+      end
+
+    end
+
+  end
+end

data/lib/shiphawk/version.rb

@@ -0,0 +1,9 @@
+module Shiphawk
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 8
+    PATCH = 1
+    PRE = nil
+    STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
+  end
+end

data/shiphawk.gemspec

@@ -0,0 +1,35 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shiphawk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'shiphawk'
+  spec.version       = Shiphawk::VERSION::STRING
+  spec.authors       = ['Robert Schmitt']
+  spec.email         = ['bob.schmitt@shiphawk.com']
+  spec.summary       = %q{Ruby bindings for the ShipHawk API}
+  spec.description   = %q{ShipHawk, technology that delivers. See https://shiphawk.com for details.}
+  spec.homepage      = 'https://github.com/ShipHawk/shiphawk-ruby'
+  spec.license       = 'MIT'
+  spec.require_paths = ['lib']
+
+  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_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
+  spec.add_dependency 'faraday-conductivity'
+  spec.add_dependency 'httpclient'
+  spec.add_dependency 'typhoeus'
+  spec.add_dependency 'em-http-request'
+
+  spec.add_development_dependency 'bundler', '~> 1.9.4'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'pry'
+end

data/spec/shiphawk/api/rates_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Shiphawk::Api::Rates do
+
+  context 'POST to rates' do
+
+    before do
+      VCR.insert_cassette 'rates_create'
+    end
+
+    after do
+      VCR.eject_cassette
+    end
+
+    it 'returns rates based on rquest data' do
+      expect(true).to eql(true)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'shiphawk'
+require 'webmock'
+require 'vcr'
+require 'faraday'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+end

metadata

@@ -0,0 +1,244 @@
+--- !ruby/object:Gem::Specification
+name: shiphawk
+version: !ruby/object:Gem::Version
+  version: 0.8.1
+platform: ruby
+authors:
+- Robert Schmitt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-conductivity
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: ShipHawk, technology that delivers. See https://shiphawk.com for details.
+email:
+- bob.schmitt@shiphawk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- EXAMPLES.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- history.txt
+- lib/shiphawk.rb
+- lib/shiphawk/api.rb
+- lib/shiphawk/api/api_keys.rb
+- lib/shiphawk/api/categories.rb
+- lib/shiphawk/api/items.rb
+- lib/shiphawk/api/notifications.rb
+- lib/shiphawk/api/products.rb
+- lib/shiphawk/api/query_helpers.rb
+- lib/shiphawk/api/rates.rb
+- lib/shiphawk/api/shipment_notes.rb
+- lib/shiphawk/api/shipment_tracking.rb
+- lib/shiphawk/api/shipments.rb
+- lib/shiphawk/api/shipments_status.rb
+- lib/shiphawk/api/zip_codes.rb
+- lib/shiphawk/client.rb
+- lib/shiphawk/errors.rb
+- lib/shiphawk/helpers.rb
+- lib/shiphawk/helpers/request.rb
+- lib/shiphawk/version.rb
+- shiphawk.gemspec
+- spec/shiphawk/api/rates_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ShipHawk/shiphawk-ruby
+licenses:
+- MIT
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for the ShipHawk API
+test_files:
+- spec/shiphawk/api/rates_spec.rb
+- spec/spec_helper.rb