ship_hero 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 110a9abe4cc19477e7a0239aa11711d73a16f1ba96eff67bc39050bbd1a1c85d
+  data.tar.gz: 69b1eda95a8413f8a0c238aa091faf6178b23e6d78095c3843ab6b6026125db0
+SHA512:
+  metadata.gz: 9e2e99bc0b9255400eb8c9887eb6f5be586921786e5e0e33255791e2194915ff6943761d04719b22affee12564df8114ad6afd50c69d4f7ce80efa57425f420c
+  data.tar.gz: 29bb465391ec4b1802bfd6f5e2ec20e6423ca699d6414468d344049494381fe2822d0221fff8c8e1e1a12ecfcacf47dbbb4543c2873aab05d393747a9a4bda85

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ship_hero.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    ship_hero (0.1.1)
+      hashie (>= 1.2.0, < 4.0)
+      json (~> 1.8, >= 1.8.1)
+      mime-types (>= 1.25.1, < 4.0)
+      rest-client (>= 1.6.7, < 4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    hashie (3.6.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    json (1.8.6)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.0331)
+    netrc (0.11.0)
+    rake (10.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  ship_hero!
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Kyle Schutt
+
+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,39 @@
+# ShipHero
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ship_hero`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ship_hero'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ship_hero
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ship_hero.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ship_hero"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ship_hero.rb

@@ -0,0 +1,57 @@
+require "ship_hero/version"
+require 'rubygems'
+require 'rest_client'
+require 'json'
+require 'hashie'
+require 'openssl'
+require 'base64'
+
+module ShipHero
+  autoload :Api, 'ship_hero/api'
+  autoload :VERSION, 'ship_hero/version'
+
+  # Models
+  autoload :Base, 'ship_hero/models/base'
+  autoload :Image, 'ship_hero/models/image'
+  autoload :Product, 'ship_hero/models/product'
+  autoload :ProductVariant, 'ship_hero/models/product_variant'
+  autoload :Order, 'ship_hero/models/order'
+  autoload :OrderHistory, 'ship_hero/models/order_history'
+  autoload :OrderLineItem, 'ship_hero/models/order_line_item'
+  autoload :OrderLineItemProductShot, 'ship_hero/models/order_line_item_product_shot'
+  autoload :OrderNote, 'ship_hero/models/order_note'
+  autoload :OrderShippingAddress, 'ship_hero/models/order_shipping_address'
+  autoload :OrderShippingLines, 'ship_hero/models/order_shipping_lines'
+  autoload :Webhook, 'ship_hero/models/webhook'
+
+  module Services
+    autoload :BaseService, 'ship_hero/services/base_service'
+    autoload :OrderService, 'ship_hero/services/order_service'
+    autoload :ProductService, 'ship_hero/services/product_service'
+    autoload :ShipmentService, 'ship_hero/services/shipment_service'
+    autoload :WebhookService, 'ship_hero/services/webhook_service'
+  end
+
+  module Responses
+    autoload :General, 'ship_hero/models/responses/general'
+    autoload :CreateOrder, 'ship_hero/models/responses/create_order'
+    autoload :GetOrder, 'ship_hero/models/responses/get_order'
+    autoload :GetWebhooks, 'ship_hero/models/responses/get_webhooks'
+  end
+
+  module Requests
+    autoload :GetOrder, 'ship_hero/models/requests/get_order'
+    autoload :GetOrders, 'ship_hero/models/requests/get_orders'
+    autoload :GetProduct, 'ship_hero/models/requests/get_product'
+    autoload :GetShipment, 'ship_hero/models/requests/get_shipment'
+  end
+
+  module Util
+    autoload :Config, 'ship_hero/util/config'
+    autoload :Helpers, 'ship_hero/util/helpers'
+  end
+
+  module Exceptions
+    autoload :ServiceException, 'ship_hero/exceptions/service_exception'
+  end
+end

data/lib/ship_hero/api.rb

@@ -0,0 +1,59 @@
+#
+# api.rb
+# ShipHero
+#
+# Copyright (c) 2018 Kyle Schutt. All rights reserved.
+
+module ShipHero
+  class Api
+    attr_accessor :api_key
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    # Product Services
+    def get_products(request)
+      ShipHero::Services::ProductService.new(@api_key).get_products(request)
+    end
+    def create_product(request)
+      ShipHero::Services::ProductService.new(@api_key).create_product(request)
+    end
+
+    # Order Services
+    def get_orders(request)
+      ShipHero::Services::OrderService.new(@api_key).get_orders(request)
+    end
+    def get_order(request)
+      ShipHero::Services::OrderService.new(@api_key).get_order(request)
+    end
+    def create_order(request)
+      ShipHero::Services::OrderService.new(@api_key).create_order(request)
+    end
+    def update_order(request)
+      ShipHero::Services::OrderService.new(@api_key).update_order(request)
+    end
+    def create_order_historye(request)
+      ShipHero::Services::OrderService.new(@api_key).create_order_historye(request)
+    end
+
+    # Shipment Services
+    def get_shipments(request)
+      ShipHero::Services::ShipmentService.new(@api_key).get_shipments(request)
+    end
+    def create_shipment(request)
+      ShipHero::Services::ShipmentService.new(@api_key).create_shipment(request)
+    end
+
+    # Webhook Services
+    def get_webhooks
+      ShipHero::Services::WebhookService.new(@api_key).get_webhooks
+    end
+    def register_webhook(request)
+      ShipHero::Services::WebhookService.new(@api_key).register_webhook(request)
+    end
+    def unregister_webhook(request)
+      ShipHero::Services::WebhookService.new(@api_key).unregister_webhook(request)
+    end
+  end
+end

data/lib/ship_hero/exceptions/service_exception.rb

@@ -0,0 +1,11 @@
+#
+# service_exception.rb
+# ShipHero
+#
+# Copyright (c) 2018 Kyle Schutt. All rights reserved.
+
+module ShipHero
+  module Exceptions
+    class ServiceException < Exception; end
+  end
+end

data/lib/ship_hero/models/base.rb

@@ -0,0 +1,13 @@
+module ShipHero
+  class Base < Hashie::Dash
+    include Hashie::Extensions::Dash::Coercion
+    include Hashie::Extensions::Dash::PropertyTranslation
+
+    property :token, coerce: String
+
+    def initialize(hash = {})
+      # ensure we symbolize keys 
+      super(Hashie.symbolize_keys!(hash))
+    end
+  end
+end

data/lib/ship_hero/models/image.rb

@@ -0,0 +1,6 @@
+module ShipHero
+  class Image < ShipHero::Base
+    property :src, coerce: String, required: true
+    property :position, coerce: Integer
+  end
+end

data/lib/ship_hero/models/order.rb

@@ -0,0 +1,22 @@
+module ShipHero
+  class Order < ShipHero::Base
+    property :email, coerce: String
+    property :total_tax, coerce: String
+    property :order_id, coerce: String
+    property :profile, coerce: String
+    property :subtotal_price, coerce: String
+    property :created_at, coerce: String
+    property :fulfillment_status, coerce: String
+    property :required_ship_date, coerce: String
+    property :total_discounts, coerce: String
+    property :total_price, coerce: String
+    property :default_warehouse, coerce: String
+
+    property :line_items, coerce: Array[ShipHero::OrderLineItem]
+    property :shipping_lines, coerce: ShipHero::OrderShippingLines
+    property :note_attributes, coerce: ShipHero::OrderNote
+    property :shipping_address, coerce: ShipHero::OrderShippingAddress
+    property :billing_address, coerce: ShipHero::OrderShippingAddress
+    property :tags, coerce: Array[String]
+  end
+end

data/lib/ship_hero/models/order_history.rb

@@ -0,0 +1,7 @@
+module ShipHero
+  class OrderHistory < ShipHero::Base
+    property :order_id, coerce: Integer
+    property :username, coerce: String, default: '-1'
+    property :information, coerce: String
+  end
+end

data/lib/ship_hero/models/order_line_item.rb

@@ -0,0 +1,16 @@
+module ShipHero
+  class OrderLineItem < ShipHero::Base
+    property :sku, coerce: String
+    property :name, coerce: String
+    property :title, coerce: String
+    property :price, coerce: String
+    property :barcode, coerce: String
+    property :variant_title, coerce: String
+    property :quantity, coerce: String
+    property :id, coerce: String
+    property :product_id, coerce: String
+    property :default_warehouse, coerce: String
+
+    property :product_shots, coerce: Array[ShipHero::OrderLineItemProductShot]
+  end
+end

data/lib/ship_hero/models/order_line_item_product_shot.rb

@@ -0,0 +1,6 @@
+module ShipHero
+  class OrderLineItemProductShot < ShipHero::Base
+    property :url, coerce: String
+    property :sort, coerce: String
+  end
+end

data/lib/ship_hero/models/order_note.rb

@@ -0,0 +1,6 @@
+module ShipHero
+  class OrderNote < ShipHero::Base
+    property :name, coerce: String
+    property :value, coerce: String
+  end
+end

data/lib/ship_hero/models/order_shipping_address.rb

@@ -0,0 +1,16 @@
+module ShipHero
+  class OrderShippingAddress < ShipHero::Base
+    property :province, coerce: String
+    property :city, coerce: String
+    property :first_name, coerce: String
+    property :last_name, coerce: String
+    property :zip, coerce: String
+    property :province_code, coerce: String
+    property :country, coerce: String
+    property :company, coerce: String
+    property :phone, coerce: String
+    property :country_code, coerce: String
+    property :address1, coerce: String
+    property :address2, coerce: String
+  end
+end

data/lib/ship_hero/models/order_shipping_lines.rb

@@ -0,0 +1,8 @@
+module ShipHero
+  class OrderShippingLines < ShipHero::Base
+    property :title, coerce: String
+    property :price, coerce: String
+    property :method, coerce: String
+    # property :carrier, coerce: String
+  end
+end

data/lib/ship_hero/models/product.rb

@@ -0,0 +1,21 @@
+module ShipHero
+  class Product < ShipHero::Base
+    property :title, coerce: String, required: true
+    property :brand, coerce: String
+    property :sku, coerce: String, required: true
+    property :type, coerce: String, default: :configurable
+    property :warehouse, coerce: String
+    property :tariff_code, coerce: String
+    property :customs_description, coerce: String
+    
+    property :available_inventory, coerce: Integer
+
+    property :price, coerce: Float
+    property :customs_value, coerce: Float
+
+    coerce_key :track_inventory, ->(v){ Util::Helpers.to_bool(v) }
+
+    property :images, coerce: Array[Image], required: true
+    property :variants, coerce: Array[ProductVariant]
+  end
+end

data/lib/ship_hero/models/product_variant.rb

@@ -0,0 +1,20 @@
+module ShipHero
+  class ProductVariant < ShipHero::Base
+    property :sku, coerce: String, required: true
+    property :parent_sku, coerce: String
+    property :title, coerce: String, required: true
+    property :available_inventory, coerce: Integer
+    property :bin, coerce: String
+    property :barcode, coerce: Integer
+    property :price, coerce: Float, required: true
+    property :value, coerce: Float
+    property :customs_value, coerce: String
+    property :customs_description, coerce: String
+    property :height, coerce: String
+    property :width, coerce: String
+    property :length, coerce: String
+    property :weight, coerce: String
+
+    property :images, coerce: Array[Image], required: true
+  end
+end

data/lib/ship_hero/models/requests/get_order.rb

@@ -0,0 +1,8 @@
+module ShipHero
+  module Requests
+    class GetOrder < ShipHero::Base
+      property :id, coerce: String
+      property :order_number, coerce: String
+    end
+  end
+end

data/lib/ship_hero/models/requests/get_orders.rb

@@ -0,0 +1,11 @@
+module ShipHero
+  module Requests
+    class GetOrders < ShipHero::Base
+      property :page, coerce: String
+      property :from, coerce: String
+      property :to, coerce: String
+      property :all_orders, coerce: Integer
+      property :warehouse_id, coerce: Integer
+    end
+  end
+end

data/lib/ship_hero/models/requests/get_product.rb

@@ -0,0 +1,9 @@
+module ShipHero
+  module Requests
+    class GetProduct < ShipHero::Base
+      property :sku, coerce: String
+      property :page, coerce: Integer
+      property :count, coerce: Integer
+    end
+  end
+end

data/lib/ship_hero/models/requests/get_shipment.rb

@@ -0,0 +1,10 @@
+module ShipHero
+  module Requests
+    class GetShipment < ShipHero::Base
+      property :page, coerce: String
+      property :from, coerce: String
+      property :to, coerce: String
+      property :filter_on, coerce: String, default: 'order' # also allows `shipment`
+    end
+  end
+end

data/lib/ship_hero/models/responses/create_order.rb

@@ -0,0 +1,9 @@
+module ShipHero
+  module Responses
+    class CreateOrder < ShipHero::Base
+      property :order_id, coerce: String
+      property :message, coerce: String
+      property :response, coerce: ShipHero::Order
+    end
+  end
+end

data/lib/ship_hero/models/responses/error.rb

@@ -0,0 +1,4 @@
+module ShipHero
+  class Error < Hashie::Mash
+  end
+end

data/lib/ship_hero/models/responses/general.rb

@@ -0,0 +1,11 @@
+module ShipHero
+  module Responses
+    class General < ShipHero::Base
+      property :status
+      property :code
+      property :results
+      property :Message, coerce: String
+      property :message, coerce: String
+    end
+  end
+end

data/lib/ship_hero/models/responses/get_order.rb

@@ -0,0 +1,10 @@
+module ShipHero
+  module Responses
+    class GetOrder < ShipHero::Base
+      property :Message
+      property :message, coerce: String
+      property :code
+      property :orders
+    end
+  end
+end

data/lib/ship_hero/models/responses/get_webhooks.rb

@@ -0,0 +1,10 @@
+module ShipHero
+  module Responses
+    class GetWebhooks < ShipHero::Base
+      property :code
+      property :Message, coerce: String
+      property :message, coerce: String
+      property :webhooks, coerce: Array[ShipHero::Webhook]
+    end
+  end
+end

data/lib/ship_hero/models/shipment.rb

@@ -0,0 +1,9 @@
+module ShipHero
+  class Shipment < ShipHero::Base
+    property :warehouse, coerce: String, required: true
+    property :profile, coerce: String, required: true
+
+    property :create_shipment, coerce: Integer, default: 0
+    property :notify_customer_via_store, coerce: Integer, default: 0
+  end
+end

data/lib/ship_hero/models/webhook.rb

@@ -0,0 +1,9 @@
+module ShipHero
+  class Webhook < ShipHero::Base
+    # Options: Inventory Update , Shipment Update , Order Canceled , Capture Payment , PO Update , Return Update 
+    property :name, coerce: String
+    property :url, coerce: String
+    # Options: shopify , magento , bigcommerce , amazon , ebay , api (for custom integrations) , Manuel Order , woocommerce , mystoreno , walmart , etsy
+    property :source, coerce: String
+  end
+end

data/lib/ship_hero/services/base_service.rb

@@ -0,0 +1,90 @@
+#
+# ShipHero
+#
+# Copyright (c) 2018 Kyle Schutt. All rights reserved.
+
+module ShipHero
+  module Services
+    class BaseService
+      attr_accessor :api_key
+
+      def initialize(api_key)
+        @api_key = api_key
+      end
+
+      protected
+
+      def get(path, params = {}, response_type = ShipHero::Responses::General)
+        url = URI::join(Util::Config.get('endpoints.base_url'), path).to_s
+        url = build_url(url, params)
+        response = RestClient.get(url, get_headers())
+        begin
+          response_type.new JSON.parse(response.body)
+        rescue
+          Hashie::Mash.new JSON.parse(response.body)
+        end
+      end
+
+      def post(path, body = {}, params = {}, response_type = ShipHero::Responses::General)
+        url = URI::join(Util::Config.get('endpoints.base_url'), path).to_s
+        url = build_url(url, params)
+        if body.is_a?(Hash)
+          body[:token] = @api_key
+        elsif body.is_a?(Array)
+          body.each do |m|
+            if m.is_a?(Hash)
+              m[:token] = @api_key
+            end
+          end
+        end
+        response = begin
+          RestClient.post(url, body.to_h.to_json, get_headers())
+        rescue => e
+          e.try(:response)
+        end
+        
+        begin
+          response_type.new JSON.parse(response.body)
+        rescue
+          Hashie::Mash.new JSON.parse(response.body)
+        end
+      end
+
+      # Return required headers for making an http request with Iterable
+      # @param [String] content_type - The MIME type of the body of the request, default is 'application/json'
+      # @return [Hash] - authorization headers
+      def get_headers(content_type = 'application/json')
+        {
+          :content_type           => content_type,
+          :accept                 => 'application/json',
+          :user_agent             => "ShipHero Ruby SDK v#{ShipHero::VERSION} (#{RUBY_DESCRIPTION})",
+          :x_ctct_request_source  => "sdk.ruby.#{ShipHero::VERSION}",
+          'x-api-key'             => @api_key
+        }
+      end
+
+      # Build a url from the base url and query parameters hash. Query parameters
+      # should not be URL encoded because this method will handle that
+      # @param [String] url - The base url
+      # @param [Hash] params - A hash with query parameters
+      # @return [String] - the url with query parameters hash
+      def build_url(url, params = nil)
+        if params.respond_to? :each
+          params.each do |key, value|
+            # Convert dates to CC date format
+            if value.respond_to? :iso8601
+              params[key] = value.iso8601
+            end
+
+            if key.to_s == 'next' && value.match(/^.*?next=(.*)$/)
+              params[key] = $1
+            end
+          end
+        else
+          params ||= {}
+        end
+        url + '?token=' + api_key + '&' + Util::Helpers.http_build_query(params)
+      end
+    end
+  end
+end

data/lib/ship_hero/services/order_service.rb

@@ -0,0 +1,36 @@
+#
+# order_service.rb
+# ShipHero
+#
+# Copyright (c) 2017 Kyle Schutt. All rights reserved.
+
+module ShipHero
+  module Services
+    class OrderService < BaseService
+      def get_orders(request = ShipHero::Requests::GetOrders.new)
+        raise Exceptions::ServiceException, "Must be a ShipHero::Requests::GetOrders" unless request.is_a?(ShipHero::Requests::GetOrders)
+        get(Util::Config.get('endpoints.get_orders'), request, ShipHero::Responses::GetOrder)
+      end
+
+      def get_order(request = ShipHero::Requests::GetOrder.new)
+        raise Exceptions::ServiceException, "Must be a ShipHero::Requests::GetOrder" unless request.is_a?(ShipHero::Requests::GetOrder)
+        get(Util::Config.get('endpoints.get_order'), request, ShipHero::Responses::GetOrder)
+      end
+      
+      def create_order(request)
+        raise Exceptions::ServiceException, "Must be a ShipHero::Order" unless request.is_a?(ShipHero::Order)
+        post(Util::Config.get('endpoints.create_order'), request, nil, ShipHero::Responses::CreateOrder)
+      end
+      
+      def update_order(request)
+        raise Exceptions::ServiceException, "Must be a ShipHero::Order" unless request.is_a?(ShipHero::Order)
+        post(Util::Config.get('endpoints.update_order'), request)
+      end
+      
+      def create_order_history(request)
+        raise Exceptions::ServiceException, "Must be a ShipHero::OrderHistory" unless request.is_a?(ShipHero::OrderHistory)
+        post(Util::Config.get('endpoints.create_order_history'), request)
+      end
+    end
+  end
+end

data/lib/ship_hero/services/product_service.rb

@@ -0,0 +1,21 @@
+#
+# product_service.rb
+# ShipHero
+#
+# Copyright (c) 2018 Kyle Schutt. All rights reserved.
+
+module ShipHero
+  module Services
+    class ProductService < BaseService
+      def get_products(request = ShipHero::Requests::GetProduct.new)
+        raise Exceptions::ServiceException, "Must be a ShipHero::Requests::GetProduct" unless request.is_a?(ShipHero::Requests::GetProduct)
+        get(Util::Config.get('endpoints.get_products'), request)
+      end
+
+      def create_product(product)
+        raise Exceptions::ServiceException, "Must be a ShipHero::Product" unless product.is_a?(ShipHero::Product)
+        post(Util::Config.get('endpoints.create_product'), [product])
+      end
+    end
+  end
+end

data/lib/ship_hero/services/shipment_service.rb

@@ -0,0 +1,21 @@
+#
+# shipment_service.rb
+# ShipHero
+#
+# Copyright (c) 2017 Kyle Schutt. All rights reserved.
+
+module ShipHero
+  module Services
+    class ShipmentService < BaseService
+      def get_shipments(request = ShipHero::Requests::GetShipment.new)
+        raise Exceptions::ServiceException, "Must be a ShipHero::Requests::GetShipment" unless request.is_a?(ShipHero::Requests::GetShipment)
+        get(Util::Config.get('endpoints.get_shipments'), request)
+      end
+
+      def create_shipment(shipment)
+        raise Exceptions::ServiceException, "Must be a ShipHero::Shipment" unless shipment.is_a?(ShipHero::Shipment)
+        post(Util::Config.get('endpoints.create_shipment'), shipment)
+      end
+    end
+  end
+end

data/lib/ship_hero/services/webhook_service.rb

@@ -0,0 +1,25 @@
+#
+# webhook_service.rb
+# ShipHero
+#
+# Copyright (c) 2017 Kyle Schutt. All rights reserved.
+
+module ShipHero
+  module Services
+    class WebhookService < BaseService
+      def get_webhooks()
+        get(Util::Config.get('endpoints.get_webhooks'), nil, ShipHero::Responses::GetWebhooks)
+      end
+
+      def register_webhook(request)
+        raise Exceptions::ServiceException, "Must be a ShipHero::Webhook" unless request.is_a?(ShipHero::Webhook)
+        post(Util::Config.get('endpoints.register_webhook'), request)
+      end
+
+      def unregister_webhook(request)
+        raise Exceptions::ServiceException, "Must be a ShipHero::Webhook" unless request.is_a?(ShipHero::Webhook)
+        post(Util::Config.get('endpoints.unregister_webhook'), request)
+      end
+    end
+  end
+end

data/lib/ship_hero/util/config.rb

@@ -0,0 +1,81 @@
+#
+# config.rb
+# ShipHero
+#
+# Copyright (c) 2018 Kyle Schutt. All rights reserved.
+
+module ShipHero
+  module Util
+    class Config
+
+      # Return a hash of configuration strings
+      # @return [Hash] - hash of configuration properties
+      @props = {
+        # REST endpoints
+        :endpoints => {
+          :base_url                       => 'https://api-gateway.shiphero.com/v1.2/general-api/',
+
+          # products
+          :get_products     => 'get-product',
+          :create_product   => 'product-creation',
+
+          # orders
+          :get_orders             => 'get-orders',
+          :get_order              => 'get-order',
+          :create_order           => 'order-creation',
+          :update_order           => 'order-update',
+          :create_order_history   => 'order-history-creation',
+
+          # shipments
+          :get_shipments          => 'get-shipments',
+          :create_shipment        => 'shipment-creation',
+
+          # webhooks
+          :get_webhooks         => 'get-webhooks',
+          :register_webhook     => 'register-webhook',
+          :unregister_webhook   => 'unregister-webhook',
+        },
+
+        # Authorization related configuration options
+        :auth => {
+          :api_key                       => ''
+        },
+
+        # Errors to be returned for various exceptions
+        :errors => {
+          :api_key_missing      => 'api_key required either explicitly or in configuration.',
+        }
+      }
+
+      class << self
+        attr_accessor :props
+
+        def configure
+          yield props if block_given?
+        end
+
+        # Get a configuration property given a specified location, example usage: Config::get('auth.token_endpoint')
+        # @param [String] index - location of the property to obtain
+        # @return [String]
+        def get(index)
+          properties = index.split('.')
+          get_value(properties, props)
+        end
+
+        private
+
+        # Navigate through a config array looking for a particular index
+        # @param [Array] index The index sequence we are navigating down
+        # @param [Hash, String] value The portion of the config array to process
+        # @return [String]
+        def get_value(index, value)
+          index = index.is_a?(Array) ? index : [index]
+          key = index.shift.to_sym
+          value.is_a?(Hash) and value[key] and value[key].is_a?(Hash) ?
+          get_value(index, value[key]) :
+          value[key]
+        end
+      end
+    end
+  end
+end

data/lib/ship_hero/util/helpers.rb

@@ -0,0 +1,44 @@
+#
+# helpers.rb
+# ShipHero
+#
+# Copyright (c) 2018 Kyle Schutt. All rights reserved.
+
+module ShipHero
+  module Util
+    class Helpers
+      class << self
+
+        # Build the HTTP query from the given parameters
+        # @param [Hash] params
+        # @return [String] query string
+        def http_build_query(params)
+          params.collect{ |k,v| "#{k}=#{encode(v)}" }.reverse.join('&')
+        end
+
+        # Escape special characters
+        # @param [String] str
+        def encode(str)
+          CGI.escape(str).gsub('.', '%2E').gsub('-', '%2D')
+        end
+
+        # String to bool
+        # @param [String] str
+        def to_bool(str)
+          return true if str == true || str =~ (/(true|t|yes|y|1)$/i)
+          return false if str == false || str == nil || str == '' || str =~ (/(false|f|no|n|0)$/i)
+        end
+
+        # String to DateTime
+        # @param [String] str
+        def to_date_time(str)
+          begin 
+            Time.parse(str)
+          rescue
+            str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ship_hero/version.rb

@@ -0,0 +1,3 @@
+module ShipHero
+  VERSION = "0.1.2".freeze
+end

data/ship_hero.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ship_hero/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ship_hero"
+  spec.version       = ShipHero::VERSION
+  spec.authors       = ["Kyle Schutt"]
+  spec.email         = ["kyle@revv.co"]
+
+  spec.summary       = 'ShipHero API gives you the ability to integrate ShipHero with your custom e-commerce solution.'
+  spec.homepage      = "https://github.com/revvco/ship_hero"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  
+  spec.add_runtime_dependency("rest-client", '< 4.0', '>= 1.6.7')
+  spec.add_runtime_dependency("json", '~> 1.8', '>= 1.8.1')
+  spec.add_runtime_dependency('mime-types', '< 4.0', '>= 1.25.1')
+  spec.add_runtime_dependency('hashie', '< 4.0', '>= 1.2.0')
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: ship_hero
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Kyle Schutt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.25.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.25.1
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- kyle@revv.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ship_hero.rb
+- lib/ship_hero/api.rb
+- lib/ship_hero/exceptions/service_exception.rb
+- lib/ship_hero/models/base.rb
+- lib/ship_hero/models/image.rb
+- lib/ship_hero/models/order.rb
+- lib/ship_hero/models/order_history.rb
+- lib/ship_hero/models/order_line_item.rb
+- lib/ship_hero/models/order_line_item_product_shot.rb
+- lib/ship_hero/models/order_note.rb
+- lib/ship_hero/models/order_shipping_address.rb
+- lib/ship_hero/models/order_shipping_lines.rb
+- lib/ship_hero/models/product.rb
+- lib/ship_hero/models/product_variant.rb
+- lib/ship_hero/models/requests/get_order.rb
+- lib/ship_hero/models/requests/get_orders.rb
+- lib/ship_hero/models/requests/get_product.rb
+- lib/ship_hero/models/requests/get_shipment.rb
+- lib/ship_hero/models/responses/create_order.rb
+- lib/ship_hero/models/responses/error.rb
+- lib/ship_hero/models/responses/general.rb
+- lib/ship_hero/models/responses/get_order.rb
+- lib/ship_hero/models/responses/get_webhooks.rb
+- lib/ship_hero/models/shipment.rb
+- lib/ship_hero/models/webhook.rb
+- lib/ship_hero/services/base_service.rb
+- lib/ship_hero/services/order_service.rb
+- lib/ship_hero/services/product_service.rb
+- lib/ship_hero/services/shipment_service.rb
+- lib/ship_hero/services/webhook_service.rb
+- lib/ship_hero/util/config.rb
+- lib/ship_hero/util/helpers.rb
+- lib/ship_hero/version.rb
+- ship_hero.gemspec
+homepage: https://github.com/revvco/ship_hero
+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.7.6
+signing_key: 
+specification_version: 4
+summary: ShipHero API gives you the ability to integrate ShipHero with your custom
+  e-commerce solution.
+test_files: []