shipwire 0.0.5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 390d86197ecf6da646f89f4a122ec6b2ce7bda5b
-  data.tar.gz: 5045260cd97ef4beeca3ff155afd44b457d14696
+  metadata.gz: 4e7c0ef34187f0e40074393f657184943067e12a
+  data.tar.gz: 526b213f274a53d38f09da6c3d4d84719fb30081
 SHA512:
-  metadata.gz: 52d11f15184c2f13719d341ab306ad8ad6fc78aacbd47eb74c061d2d899345939eb3d55dd1b11ff6db03c1955716e72ad20062748d20a368c709b5f24879a45d
-  data.tar.gz: 1de44e2d241d6d1ebbe75ea14661784c84493a4e6e74a68dc4fa01c099576aedcbeb59ee9674fb3bf08cd9f91672bda560226d4e70e229fac2c27be6704f79dc
+  metadata.gz: 65c8fcb56b8f080aaeeac6114a65dbecc02d6ae6b5f4bd36545c92db6e630542a27f9abfb728beeba132c4bd28d30baa144bf2cc10446c4a06f1b7c941593a5d
+  data.tar.gz: 27e0b51bc593d2f95e561a2b5c6d365abf3db9ac4a8f2271f5433180f36895d0707e0a0c8b3b58456d92e1a36a771a459f46daaea7a74ec7fdbcd08e0e962b3d

data/.gitignore

@@ -1,6 +1,5 @@
 *.rbc
 capybara-*.html
-.rspec
 /log
 /tmp
 /db/*.sqlite3
@@ -17,8 +16,9 @@ config/secrets.yml
 /.bundle
 /vendor/bundle
 
-# these should all be checked in to normalise the environment:
-# Gemfile.lock, .ruby-version, .ruby-gemset
+Gemfile.lock
+
+rspec.log
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order defined

data/.ruby-version

@@ -1 +1 @@
-ruby-2.1.2
+2.1.2

data/Gemfile

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

data/README.md

@@ -1,59 +1,83 @@
-Shipwire
-========
+# Shipwire
 
-Ruby gem to integrate with Shipwire's fulfillment API.
+Ruby gem to integrate with Shipwire's API.
 
 ## Installation
 
+Install locally with
+
+```
+gem install shipwire
+```
+
 Add this line to your application's Gemfile:
 
-  `gem 'shipwire'`
+```
+gem 'shipwire'
+```
+
+> Note: The master branch is not guaranteed to be in a fully functioning state. It is unwise to use this branch in a production environment.
+
+Run the bundle command:
+
+```
+bundle install
+```
+
+If you are using Rails, run the generator:
+
+```
+rails g shipwire:install
+```
 
-And then execute:
+## Configuration
 
-  `$ bundle`
+Basic configuration
 
-You can install it locally as:
+```
+Shipwire.configure do |config|
+  config.username = "<%= ENV['SHIPWIRE_USERNAME'] %>"
+  config.password = "<%= ENV['SHIPWIRE_PASSWORD'] %>"
+end
+```
 
-  `$ gem install shipwire`
+`username` - (required) Shipwire username (email address) used for basic auth login to Shipwire
 
-## Getting Started
+`password` - (required) Shipwire password used for basic auth login to Shipwire.
 
-Get a Shipwire sandbox account for development & testing:
+`open_timeout` - Read timeout in seconds. Default is `2`.
 
-  `http://beta.shipwire.com/`
+`timeout` - Open/read timeout in seconds. Default is `5`.
 
-Your credentials, endpoint, and sever environment variables need to be set:
+`endpoint` - Endpoint base URL to use for requests. Default is `https://api.shipwire.com`.
 
-  SHIPWIRE_USERNAME
-  
-  SHIPWIRE_PASSWORD
-  
-  SHIPWIRE_SERVER
-  
-  SHIPWIRE_ENDPOINT
+`logger` - Log requests to STDOUT. Default is `false`.
 
-SHIPWIRE_SERVER is either `Test` or `Production`.  SHIPWIRE_ENDPOINT is one of their API hosts:
+> Note: There is a difference between an account registered from [https://www.shipwire.com/](https://www.shipwire.com/) and one registered from [https://beta.shipwire.com/](https://beta.shipwire.com/). If you create an account from [https://www.shipwire.com/](https://www.shipwire.com/) and then request data from the beta URL, the API will throw errors about an invalid account. Accounts are only valid from that registration point.
 
-  `https://api.shipwire.com/exec/`
+## Testing
 
-Or
+Tests are using a throwaway Shipwire Beta account that is only meant for testing. A personal Shipwire Beta account of your own is not required.
 
-  `https://api.beta.shipwire.com/exec/`
+Tests require a product named `TEST-PRODUCT` and `TEST-PRODUCT2` to function properly.
 
-Use `api.beta` for any development or testing.
+```
+bundle exec rake spec
+```
 
-## Running Tests
+or
 
-If making contributions to this gem, make sure you write tests for any new functionality.  Contributions will be rejected if there are no tests or tests do not pass.
+```
+bundle exec rspec spec
+```
 
-#### Shipping Quotes
+## Contributions
 
-Shipwire relies on product SKUs being present to return a shipping quote.  In your Sandbox environment, create a test product with SKU `123456` to get quote tests to pass.
+If making contributions to this gem, make sure you write tests for any new functionality. Contributions will be rejected if there are no tests or tests do not pass.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/shipwire/fork )
+1. Fork it ( https://github.com/billr578/shipwire/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`)

data/Rakefile

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

data/lib/generators/shipwire/install/install_generator.rb

@@ -0,0 +1,13 @@
+module Shipwire
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_initializer_file
+        file = 'config/initializers/shipwire.rb'
+
+        copy_file(file, file)
+      end
+    end
+  end
+end

data/lib/generators/shipwire/install/templates/config/initializers/shipwire.rb

@@ -0,0 +1,27 @@
+Shipwire.configure do |config|
+  # Note there is a difference between an account registered from
+  # https://www.shipwire.com/ and one registered from https://beta.shipwire.com/
+  #
+  # If you create an account from https://www.shipwire.com/ and then request
+  # data from the beta URL, the API will throw errors about an invalid account.
+
+  #############################################################################
+
+  # Shipwire username (email address) used for basic auth login to Shipwire
+  config.username = "<%= ENV['SHIPWIRE_USERNAME'] %>"
+
+  # Shipwire password used for basic auth login to Shipwire.
+  config.password = "<%= ENV['SHIPWIRE_PASSWORD'] %>"
+
+  # Read timeout Integer in seconds. Default is 2 seconds
+  # config.open_timeout = 2
+
+  # Open/read timeout Integer in seconds. Default is 5 seconds
+  # config.timeout = 5
+
+  # Endpoint base URL to use for requests. Default is 'https://api.shipwire.com'
+  # config.endpoint = 'https://api.shipwire.com'
+
+  # Enable logging to the console. Default is false
+  # config.logger = false
+end

data/lib/shipwire.rb

@@ -1,47 +1,40 @@
+require 'deep_merge/rails_compat'
+require 'faraday'
+require 'faraday_middleware'
+require 'recursive_open_struct'
+
 require 'shipwire/version'
+require 'shipwire/api'
 require 'shipwire/configuration'
-
-require 'shipwire/service_request'
-require 'shipwire/fulfillment'
-require 'shipwire/shipping_rate'
-require 'shipwire/tracking'
-require 'shipwire/inventory'
+require 'shipwire/param_converter'
+require 'shipwire/request'
+require 'shipwire/response'
+require 'shipwire/utility'
+
+require 'shipwire/orders'
+require 'shipwire/products'
+require 'shipwire/rate'
+require 'shipwire/receivings'
+require 'shipwire/returns'
+require 'shipwire/secret'
+require 'shipwire/stock'
+require 'shipwire/webhooks'
+
+require 'shipwire/products/base'
+require 'shipwire/products/insert'
+require 'shipwire/products/kit'
+require 'shipwire/products/virtual_kit'
 
 module Shipwire
   class << self
     attr_accessor :configuration
 
-    def configure(&block)
-      @configuration = Configuration.new(&block)
+    def configure
+      yield(configuration)
     end
 
     def configuration
       @configuration ||= Configuration.new
     end
-
-    def endpoint
-      configuration.nil? ? nil : configuration.endpoint
-    end
-
-    def username
-      configuration.nil? ? nil : configuration.username
-    end
-
-    def password
-      configuration.nil? ? nil : configuration.password
-    end
-
-    def server
-      configuration.nil? ? nil : configuration.server
-    end
   end
-
-  class Error < Exception; end
-  class ApiEndpointNotSet < Error; end
-  class ApiUsernameNotSet < Error; end
-  class ApiPasswordNotSet < Error; end
-  class ApiServerNotSet < Error; end
-  class ServerErrorEncountered < Error; end
-  class AccessDenied < Error; end
-  class TrackingError < Error; end
 end

data/lib/shipwire/api.rb

@@ -0,0 +1,7 @@
+module Shipwire
+  class Api
+    def request(method, path, body: {}, params: {})
+      Request.send(method: method, path: path, body: body, params: params)
+    end
+  end
+end

data/lib/shipwire/configuration.rb

@@ -1,9 +1,19 @@
 module Shipwire
   class Configuration
-    attr_accessor :endpoint, :username, :password, :server
+    attr_accessor :username,
+                  :password,
+                  :open_timeout,
+                  :timeout,
+                  :endpoint,
+                  :logger
 
-    def initialize(&block)
-      block.call(self)
+    def initialize
+      @username     = nil
+      @password     = nil
+      @open_timeout = 2
+      @timeout      = 5
+      @endpoint     = "https://api.shipwire.com"
+      @logger       = false
     end
   end
 end

data/lib/shipwire/orders.rb

@@ -0,0 +1,39 @@
+module Shipwire
+  class Orders < Api
+    def list(params = {})
+      request(:get, 'orders', params: params)
+    end
+
+    def create(body)
+      request(:post, 'orders', body: body)
+    end
+
+    def find(id, params = {})
+      request(:get, "orders/#{id}/trackings", params: params)
+    end
+
+    def update(id, body, params = {})
+      request(:put, "orders/#{id}", body: body, params: params)
+    end
+
+    def cancel(id)
+      request(:post, "orders/#{id}/cancel")
+    end
+
+    def holds(id, params = {})
+      request(:get, "orders/#{id}/holds", params: params)
+    end
+
+    def items(id)
+      request(:get, "orders/#{id}/items")
+    end
+
+    def returns(id)
+      request(:get, "orders/#{id}/returns")
+    end
+
+    def trackings(id)
+      request(:get, "orders/#{id}/trackings")
+    end
+  end
+end

data/lib/shipwire/param_converter.rb

@@ -0,0 +1,39 @@
+module Shipwire
+  class ParamConverter
+    attr_reader :params
+
+    def initialize(params)
+      if params.is_a?(Array)
+        @params = params.each_with_object([]) do |item, hsh|
+          hsh << recursively_struct(item)
+        end
+      else
+        @params = recursively_struct(params)
+      end
+    end
+
+    def to_h
+      if params.is_a?(Array)
+        params.each_with_object([]) do |item, hsh|
+          hsh << with_object(item)
+        end
+      else
+        with_object(params)
+      end
+    end
+
+    private
+
+    def recursively_struct(item)
+      RecursiveOpenStruct.new(item, recurse_over_arrays: true).to_h
+    end
+
+    def with_object(item)
+      item.each_with_object({}) do |(original_key, value), hsh|
+        key = Utility.camelize(original_key.to_s, :lower).to_sym
+
+        hsh[key] = value.is_a?(Hash) ? with_object(value) : value
+      end
+    end
+  end
+end

data/lib/shipwire/products.rb

@@ -0,0 +1,53 @@
+module Shipwire
+  class Products < Api
+    def list(params = {})
+      request(:get, 'products', params: params_runner(params))
+    end
+
+    def create(body)
+      request(:post, 'products', body: body_runner(body))
+    end
+
+    def find(id)
+      request(:get, "products/#{id}")
+    end
+
+    def update(id, body)
+      request(:put, "products/#{id}", body: body_runner(body))
+    end
+
+    def retire(id)
+      request(:post, 'products/retire', body: retire_object(id))
+    end
+    alias_method :remove, :retire
+    alias_method :delete, :retire
+
+    protected
+
+    def product_classification
+      {}
+    end
+
+    private
+
+    def params_runner(params)
+      with_product_classification(params)
+    end
+
+    def body_runner(body)
+      [body].flatten.each_with_object([]) do |item, pl|
+        pl << with_product_classification(item)
+      end
+    end
+
+    def with_product_classification(body)
+      body.merge(product_classification)
+    end
+
+    def retire_object(obj)
+      retire_array = obj.is_a?(Array) ? obj : Utility.split_to_integers(obj)
+
+      { ids: retire_array }
+    end
+  end
+end