shipvine 0.1.0

data/lib/shipvine/inbound_shipment.rb

@@ -0,0 +1,129 @@
+module Shipvine
+  class InboundShipment < Base
+
+    attr_reader :attributes
+
+    def initialize(attributes)
+      @attributes = attributes
+    end
+
+    def self.list(since, state = 'Complete')
+      request = self.client.request(
+        :get,
+        '/inbound-shipments/' + ERB::Util.url_encode(Shipvine.merchant_code),
+        {
+          'changed-since' => since,
+          'state' => state
+        }
+      )
+
+      response = self.xml_to_hash(request.body)
+
+      # the GET response only returns the identifiers, we have to make another call
+      # to pull all of the actual inbound shipments
+      merchant_identifiers = Array.wrap(response.dig(:inbound_shipments, :inbound_shipment)).map do |shipment_hash|
+        shipment_hash[:merchant_identifier]
+      end
+
+      merchant_identifiers.map do |identifier|
+        self.get(identifier)
+      end
+    end
+
+    def self.get(merchant_identifier)
+      request = self.client.request(
+        :get,
+        '/inbound-shipments/' + ERB::Util.url_encode(Shipvine.merchant_code) + '/' + ERB::Util.url_encode(merchant_identifier)
+      )
+
+      self.new(self.xml_to_hash(request.body))
+    end
+
+    def create
+      translated_payload = @attributes.deep_dup
+      merchant_identifier = translated_payload.delete(:merchant_identifier)
+
+      # `The /InboundShipment/ExpectedAt date is not in the expected format of yyyy-MM-dd (e.g., '2014-02-28')`
+      if translated_payload[:expected_at] !=~ /[0-9]{4}-[0-2]{2}-[0-9]{2}/
+        translated_payload[:expected_at] = DateTime.parse(translated_payload[:expected_at]).strftime('%Y-%m-%d')
+      end
+
+      preprocess_lines(translated_payload)
+      preprocess_metadata(translated_payload)
+
+      client.request(
+        :put,
+        '/inbound-shipments/' + ERB::Util.url_encode(Shipvine.merchant_code) + '/' + ERB::Util.url_encode(merchant_identifier),
+        request_body('InboundShipment', translated_payload)
+      )
+    end
+
+    def metadata
+      metadata_entries = self.attributes.dig(:inbound_shipment, :shipment_metadata, :metadata)
+
+      if metadata_entries.nil? || metadata_entries.empty?
+        return {}
+      end
+
+      # TODO cache the resulting hash here
+
+      metadata_entries = Array.wrap(metadata_entries)
+
+      metadata_entries.inject({}) do |h, sv_metadata_entry|
+        h[sv_metadata_entry[:name]] = sv_metadata_entry[:value]
+        h
+      end
+    end
+
+    protected
+
+      def preprocess_metadata(shipment_hash)
+        metadata = shipment_hash.delete(:metadata)
+
+        if metadata
+          shipment_hash[:shipment_metadata] = {
+            :metadata => metadata.map do |k, v|
+              {
+                name: k,
+                value: v
+              }
+            end
+          }
+        end
+      end
+
+      def preprocess_lines(order_hash)
+        items = order_hash.delete(:items)
+
+        order_hash[:lines] = {
+          :line => items.map do |item|
+            {
+              item: {
+                # TODO support other item keys, `sku`, `id`, etc
+                merchant_identifier: item[:product_id]
+              },
+              quantity_expected: item[:quantity],
+            }
+          end
+        }
+
+        order_hash
+      end
+
+      def build_sanitized_hash(resource_name, hash)
+        sanitized = hash.deep_compact!
+
+        # NOTE inbound shipments do not have a XSD!
+        #      also, the merchant code is specified in the URL in XML
+
+        {
+          resource_name => sanitized
+        }
+      end
+
+      def validate_xml!(xml)
+        # NOTE there is no XSD for inbound shipments!
+      end
+
+  end
+end

data/lib/shipvine/item.rb

@@ -0,0 +1,74 @@
+module Shipvine
+  class Item < Base
+    def self.get(item_group_merchant_identifier, item_merchant_identifier)
+      request = self.client.request(
+        :get,
+        # escape SKU?
+
+        '/item-groups/' +
+          Shipvine.merchant_code + '/' +
+          item_group_merchant_identifier + '/' +
+          'items/' +
+          item_merchant_identifier,
+        {},
+        exclude_merchant_code: true
+      )
+
+      self.new(self.xml_to_hash(request.body))
+    rescue Shipvine::Error => e
+      nil
+    end
+
+    def initialize(attributes)
+      @attributes = attributes
+    end
+
+    def create
+      translated_payload = @attributes.deep_dup
+
+      merchant_identifier = translated_payload.delete(:merchant_identifier)
+      group_merchant_identifier = translated_payload.delete(:group_merchant_identifier)
+
+      preprocess_metadata(translated_payload)
+
+      client.request(
+        :put,
+        '/item-groups/' +
+          Shipvine.merchant_code + '/' +
+          group_merchant_identifier + '/' +
+          'items/' +
+          merchant_identifier,
+        request_body('Item', translated_payload),
+        exclude_merchant_code: true
+      )
+    end
+
+    private
+
+      # NOTE there are no sequence limitations on the item API
+
+      # there is no XSD, and the merchant code is included the URL; simple strip nils
+      def build_sanitized_hash(resource_name, hash)
+        { resource_name => hash.deep_compact! }
+      end
+
+      def validate_xml!(xml)
+        # NOTE there is no XSD for item group!
+      end
+
+      def preprocess_metadata(item_hash)
+        metadata = item_hash.delete(:metadata)
+
+        if metadata
+          item_hash[:metadata] = {
+            :metadata => metadata.map do |k, v|
+              {
+                name: k,
+                value: v
+              }
+            end
+          }
+        end
+      end
+  end
+end

data/lib/shipvine/item_group.rb

@@ -0,0 +1,53 @@
+module Shipvine
+  class ItemGroup < Base
+
+    def self.get(item_merchant_identifier)
+      request = self.client.request(
+        :get,
+
+        # TODO escape SKU?
+
+        '/item-groups/' +
+          Shipvine.merchant_code + '/' +
+          item_merchant_identifier
+      )
+
+      self.new(self.xml_to_hash(request.body))
+    rescue Shipvine::Error => e
+      nil
+    end
+
+    attr_accessor :attributes
+
+    def initialize(attributes)
+      @attributes = attributes
+    end
+
+    def create
+      translated_payload = @attributes.deep_dup
+
+      merchant_identifier = translated_payload.delete(:merchant_identifier)
+
+      client.request(
+        :put,
+        '/item-groups/' +
+          Shipvine.merchant_code + '/' + merchant_identifier,
+        request_body('ItemGroup', translated_payload)
+      )
+    end
+
+    private
+
+      # NOTE there are no sequence limitations on the item API
+
+      # there is no XSD, and the merchant code is included the URL; simple strip nils
+      def build_sanitized_hash(resource_name, hash)
+        { resource_name => hash.deep_compact! }
+      end
+
+      def validate_xml!(xml)
+        # NOTE there is no XSD for item group!
+      end
+
+  end
+end

data/lib/shipvine/outbound_shipment.rb

@@ -0,0 +1,30 @@
+module Shipvine
+  class OutboundShipment < Base
+
+    def self.list(since)
+      request = self.client.request(:get, '/outbound-shipments', { 'created-since' => since })
+      response = self.xml_to_hash(request.body)
+
+      Array.wrap(response[:outbound_shipments][:outbound_shipment]).map do |shipment_hash|
+        self.new(shipment_hash)
+      end
+    end
+
+    attr_accessor :attributes
+
+    def initialize(shipment_hash)
+      @attributes = shipment_hash
+    end
+
+    def merchant_identifier
+      @attributes[:fulfillment_request][:merchant_identifier]
+    end
+
+    def wfs_identifier
+      @attributes[:fulfillment_request][:wfs_identifier]
+    end
+
+    alias_method :shipvine_identifier, :wfs_identifier
+
+  end
+end

data/lib/shipvine/version.rb

@@ -0,0 +1,3 @@
+module Shipvine
+  VERSION = "0.1.0"
+end

data/shipvine.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shipvine/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shipvine"
+  spec.version       = Shipvine::VERSION
+  spec.authors       = ["Michael Bianco"]
+  spec.email         = ["mike@cliffsidemedia.com"]
+
+  spec.summary       = %q{Shipvine API bindings}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/iloveitaly/shipvine-ruby"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'httparty', '~> 0.13.7'
+  spec.add_dependency 'gyoku', '~> 1.3.1'
+  spec.add_dependency 'nori', '~> 2.6.0'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: shipvine
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Bianco
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+- !ruby/object:Gem::Dependency
+  name: gyoku
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: nori
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- mike@cliffsidemedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- data/WarehouseFS-1.0.xsd
+- lib/shipvine.rb
+- lib/shipvine/base.rb
+- lib/shipvine/bill_of_lading.rb
+- lib/shipvine/client.rb
+- lib/shipvine/deep_compact.rb
+- lib/shipvine/error.rb
+- lib/shipvine/fulfillment_request.rb
+- lib/shipvine/inbound_shipment.rb
+- lib/shipvine/item.rb
+- lib/shipvine/item_group.rb
+- lib/shipvine/outbound_shipment.rb
+- lib/shipvine/version.rb
+- shipvine.gemspec
+homepage: https://github.com/iloveitaly/shipvine-ruby
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: Shipvine API bindings
+test_files: []