shipwire 0.0.5 → 2.0.0

data/lib/shipwire/products/base.rb

@@ -0,0 +1,9 @@
+module Shipwire
+  class Products::Base < Products
+    protected
+
+    def product_classification
+      { classification: "baseProduct" }
+    end
+  end
+end

data/lib/shipwire/products/insert.rb

@@ -0,0 +1,9 @@
+module Shipwire
+  class Products::Insert < Products
+    protected
+
+    def product_classification
+      { classification: "marketingInsert" }
+    end
+  end
+end

data/lib/shipwire/products/kit.rb

@@ -0,0 +1,9 @@
+module Shipwire
+  class Products::Kit < Products
+    protected
+
+    def product_classification
+      { classification: "kit" }
+    end
+  end
+end

data/lib/shipwire/products/virtual_kit.rb

@@ -0,0 +1,9 @@
+module Shipwire
+  class Products::VirtualKit < Products
+    protected
+
+    def product_classification
+      { classification: "virtualKit" }
+    end
+  end
+end

data/lib/shipwire/rate.rb

@@ -0,0 +1,7 @@
+module Shipwire
+  class Rate < Api
+    def find(body)
+      request(:post, 'rate', body: body)
+    end
+  end
+end

data/lib/shipwire/receivings.rb

@@ -0,0 +1,50 @@
+module Shipwire
+  class Receivings < Api
+    def list(params = {})
+      request(:get, 'receivings', params: params)
+    end
+
+    def create(body)
+      request(:post, 'receivings', body: body)
+    end
+
+    def find(id, params = {})
+      request(:get, "receivings/#{id}", params: params)
+    end
+
+    def update(id, body, params = {})
+      request(:put, "receivings/#{id}", body: body, params: params)
+    end
+
+    def cancel(id)
+      request(:post, "receivings/#{id}/cancel")
+    end
+
+    def labels_cancel(id)
+      request(:post, "receivings/#{id}/labels/cancel")
+    end
+    alias_method :label_cancel, :labels_cancel
+
+    def holds(id, params = {})
+      request(:get, "receivings/#{id}/holds", params: params)
+    end
+
+    def instructions_recipients(id)
+      request(:get, "receivings/#{id}/instructionsRecipients")
+    end
+    alias_method :instructions, :instructions_recipients
+    alias_method :recipients, :instructions_recipients
+
+    def items(id)
+      request(:get, "receivings/#{id}/items")
+    end
+
+    def shipments(id)
+      request(:get, "receivings/#{id}/shipments")
+    end
+
+    def trackings(id)
+      request(:get, "receivings/#{id}/trackings")
+    end
+  end
+end

data/lib/shipwire/request.rb

@@ -0,0 +1,73 @@
+module Shipwire
+  class Request
+    def self.send(**args)
+      new(**args).send
+    end
+
+    API_VERSION = 3
+
+    attr_reader :method, :path, :params, :body
+
+    def initialize(method: :get, path: '', params: {}, body: {})
+      @method = method
+      @path = path
+      @params = params
+      @body = body
+
+      @connection = build_connection
+    end
+
+    def send
+      Response.new(underlying_response: make_request)
+    rescue Faraday::ConnectionFailed
+      Response.new(error_summary: 'Unable to connect to Shipwire')
+    rescue Faraday::TimeoutError
+      Response.new(error_summary: 'Shipwire connection timeout')
+    end
+
+    private
+
+    def build_connection
+      Faraday.new(url: base_url) do |connection|
+        connection.request(:basic_auth, username, password)
+        connection.request(:json)
+        connection.request(:url_encoded)
+
+        if Shipwire.configuration.logger
+          connection.response(:logger)
+        end
+
+        connection.adapter(Faraday.default_adapter)
+      end
+    end
+
+    def make_request
+      @connection.public_send(@method, full_path) do |request|
+        request.params = params unless params.empty?
+        request.options.open_timeout = Shipwire.configuration.open_timeout
+        request.options.timeout = Shipwire.configuration.timeout
+        request.body = body unless body.empty?
+      end
+    end
+
+    def base_url
+      Shipwire.configuration.endpoint.chomp("/")
+    end
+
+    def full_path
+      "/api/v#{API_VERSION}/#{@path}"
+    end
+
+    def params
+      Utility.camel_case(@params)
+    end
+
+    def username
+      Shipwire.configuration.username
+    end
+
+    def password
+      Shipwire.configuration.password
+    end
+  end
+end

data/lib/shipwire/response.rb

@@ -0,0 +1,79 @@
+require 'json'
+
+module Shipwire
+  class Response
+    attr_reader :error_summary, :validation_errors, :warnings, :body
+
+    def initialize(underlying_response: nil, error_summary: nil)
+      @error_summary = error_summary
+
+      @validation_errors = []
+      @warnings = []
+
+      if underlying_response
+        load_response(underlying_response)
+      end
+    end
+
+    def ok?
+      !has_error_summary? && !has_validation_errors?
+    end
+
+    def has_error_summary?
+      !error_summary.nil?
+    end
+
+    def has_validation_errors?
+      !validation_errors.empty?
+    end
+
+    def has_warnings?
+      !warnings.empty?
+    end
+
+    def error_report
+      report_lines = []
+
+      if has_error_summary?
+        report_lines << 'Error summary:'
+        report_lines << error_summary
+      end
+
+      if has_validation_errors?
+        report_lines << 'Validation errors:'
+        report_lines << validation_errors.pretty_inspect.rstrip
+      end
+
+      report_lines.join("\n")
+    end
+
+    private
+
+    def load_response(response)
+      @body = JSON.parse(response.body)
+      @warnings = parse_warnings_from(body)
+      @error_summary = parse_error_summary_from(body)
+      @validation_errors = parse_validation_errors_from(body)
+    end
+
+    # Errors because of a 40x or 50x error
+    def parse_error_summary_from(body)
+      if (400..599).include?(body['status']) && body.key?('message')
+        body['message']
+      else
+        nil
+      end
+    end
+
+    # Errors specified in Shipwire response body
+    def parse_validation_errors_from(body)
+      body.fetch('errors', {})
+    end
+
+    def parse_warnings_from(body)
+      body.fetch('warnings', []).map do |warning|
+        warning.fetch('message')
+      end
+    end
+  end
+end

data/lib/shipwire/returns.rb

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

data/lib/shipwire/secret.rb

@@ -0,0 +1,20 @@
+module Shipwire
+  class Secret < Api
+    def list
+      request(:get, 'secret')
+    end
+
+    def create
+      request(:post, 'secret')
+    end
+
+    def find(id)
+      request(:get, "secret/#{id}")
+    end
+
+    def remove(id)
+      request(:delete, "secret/#{id}")
+    end
+    alias_method :delete, :remove
+  end
+end

data/lib/shipwire/stock.rb

@@ -0,0 +1,7 @@
+module Shipwire
+  class Stock < Api
+    def list(params = {})
+      request(:get, 'stock', params: params)
+    end
+  end
+end

data/lib/shipwire/utility.rb

@@ -0,0 +1,22 @@
+module Shipwire
+  module Utility
+    def self.camel_case(options)
+      ParamConverter.new(options).to_h
+    end
+
+    def self.split_to_integers(str, separator = ",")
+      str.to_s.split(separator).map(&:to_i)
+    end
+
+    def self.camelize(term, first_letter = :upper)
+      terms = term.split('_')
+
+      case first_letter
+      when :upper
+        terms.map(&:capitalize!).join
+      when :lower
+        ([terms.first] + terms.drop(1).map(&:capitalize!)).join
+      end
+    end
+  end
+end

data/lib/shipwire/version.rb

@@ -1,3 +1,3 @@
 module Shipwire
-  VERSION = "0.0.5"
+  VERSION = "2.0.0"
 end

data/lib/shipwire/webhooks.rb

@@ -0,0 +1,24 @@
+module Shipwire
+  class Webhooks < Api
+    def list
+      request(:get, 'webhooks')
+    end
+
+    def create(body)
+      request(:post, 'webhooks', body: body)
+    end
+
+    def find(id)
+      request(:get, "webhooks/#{id}")
+    end
+
+    def update(id, body)
+      request(:put, "webhooks/#{id}", body: body)
+    end
+
+    def remove(id)
+      request(:delete, "webhooks/#{id}")
+    end
+    alias_method :delete, :remove
+  end
+end

data/shipwire.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Shipwire::VERSION
   spec.authors       = ["Bill Rowell"]
   spec.email         = ["billr578@gmail.com"]
-  spec.summary       = %q{Exchange data with Shipwire fullfillment}
-  spec.description   = %q{Provides a wrapper for API calls to Shipwire fullfillment}
+  spec.summary       = 'Exchange data with Shipwire fullfillment'
+  spec.description   = 'Provides a wrapper for API calls to Shipwire'
   spec.homepage      = "https://github.com/morbid-enterprises/shipwire"
   spec.license       = "MIT"
 
@@ -18,18 +18,15 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "faraday"
-  spec.add_dependency "nokogiri"
+  spec.add_dependency "deep_merge", "~> 1.0.0"
+  spec.add_dependency "faraday", "~> 0.9.1"
+  spec.add_dependency "faraday_middleware", "~> 0.10.0"
+  spec.add_dependency "recursive-open-struct", "~> 0.6.4"
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "mocha"
-  spec.add_development_dependency "rack-test"
-
-  spec.add_development_dependency "dotenv"
-
-  spec.add_development_dependency "webmock"
-  spec.add_development_dependency "vcr"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec",  "~> 3.2.0"
+  spec.add_development_dependency "ffaker", "~> 2.0.0"
+  spec.add_development_dependency "simplecov", "~> 0.10.0"
+  spec.add_development_dependency "vcr", "~> 2.9.3"
+  spec.add_development_dependency "webmock", "~> 1.21.0"
+  spec.add_development_dependency "pry", "~> 0.10.1"
 end

data/spec/features/access_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+RSpec.describe "General access", type: :feature, vcr: true do
+  describe 'with missing credentials' do
+    before do
+      Shipwire.configuration.username = nil
+      Shipwire.configuration.password = nil
+    end
+
+    it "raises an error" do
+      VCR.use_cassette("credentials_missing") do
+        response = Shipwire::Secret.new.list
+
+        expect(response.ok?).to be_falsy
+        expect(response.error_summary).to eq(
+          'Please include a valid Authorization header (Basic)'
+        )
+      end
+    end
+  end
+
+  describe "with incorrect credentials" do
+    before do
+      Shipwire.configuration.username = 'fake@email.com'
+      Shipwire.configuration.password = 'fake-password'
+    end
+
+    it "raises an error" do
+      VCR.use_cassette("credentials_incorrect") do
+        response = Shipwire::Secret.new.list
+
+        expect(response.ok?).to be_falsy
+        expect(response.error_summary).to eq(
+          'Please include a valid Authorization header (Basic)'
+        )
+      end
+    end
+  end
+
+  describe "with incorrect base endpoint" do
+    before { Shipwire.configuration.endpoint = 'https://api.fake.shipwire.com' }
+
+    it "raises an error" do
+      response = Shipwire::Secret.new.list
+
+      expect(response.ok?).to be_falsy
+      expect(response.error_summary).to eq 'Unable to connect to Shipwire'
+    end
+  end
+
+  describe "with API timeout" do
+    before { Shipwire.configuration.timeout = 0.0001 }
+
+    it "raises an error" do
+      response = Shipwire::Secret.new.list
+
+      expect(response.ok?).to be_falsy
+      expect(response.error_summary).to eq 'Shipwire connection timeout'
+    end
+  end
+end