seko 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ccf252a5f73196d16afac7f326d8fca9163f7dc
+  data.tar.gz: 2fb7c168442260f3b587d28e7823fb497bc98254
+SHA512:
+  metadata.gz: 1bd565235abd405f4f44d2bf98a1942770ca3b4252ddffd0d83affd78db0d0a1680de9661f0df2f6a2e19d7c5d820e2b9f25f062d9fa5fc9b1cc2f90b3146d3b
+  data.tar.gz: eafb4f39d5629a62b5554b09cbdf8678a810c1f65129693e0a95d1ec4f0312394e6cc9e42e9a617f814b8629651404c69c91f1654f0ed6338077385a28eaa336

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+rvm:
+  - 2.0.0
+
+matrix:
+  allow_failures:
+    - rvm: rbx-19mode
+
+script:
+- CODECLIMATE_REPO_TOKEN=dd4351c1e437fe6bb682de8e30eae582e627b4e0959ed3202839ad057af5d4d1 bundle exec rspec
+
+# addons:
+#    code_climate:
+#      repo_token: dd4351c1e437fe6bb682de8e30eae582e627b4e0959ed3202839ad057af5d4d1 
+
+notifications:
+  email:
+    - justin@jgrubbs.net
+
+gemfile:
+  - Gemfile
+
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Justin Grubbs
+
+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,210 @@
+# Seko
+
+[![Build Status](https://travis-ci.org/jGRUBBS/seko-ruby-api.svg?branch=master)](https://travis-ci.org/jGRUBBS/seko-ruby-api.svg?branch=master)
+[![Code Climate](https://codeclimate.com/github/jGRUBBS/seko-ruby-api/badges/gpa.svg)](https://codeclimate.com/github/jGRUBBS/seko-ruby-api)
+[![Test Coverage](https://codeclimate.com/github/jGRUBBS/seko-ruby-api/badges/coverage.svg)](https://codeclimate.com/github/jGRUBBS/seko-ruby-api)
+
+Ruby wrapper for Seko Logistics' SupplyStream iHub REST API v1
+
+[SupplyStream REST API Documentation](https://wiki.supplystream.com/GetFile.aspx?Page=MANUAL.Integration-Hub-Rest-APIs&File=integration-ihub-rest-apis-v1.4.pdf)
+
+## Integrations
+
+1.  **Inbound Product Master Upload and method**
+2.  **Inbound Companies Upload and method**
+3.  **Inbound Advanced Shipment Notification**
+4.  **Inbound Sales Order / Cancel Orders**
+5.  **Retrieve GRN’s**
+6.  **Retrieve Stock Quantity**
+7.  **Retrieve Tracking Details**
+8.  **Retrieve Sales Order Status**
+9.  **Retrieve Stock Adjustments**
+10. **Retrieve Stock Movements**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'seko'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install seko
+
+## Usage
+#### Configuration
+config/initializers/seko.rb
+```ruby
+Seko.configure(
+  token:                'SekoAPIToKeN'
+  supplier_code:        'DEFSUPLJLTD001',
+  supplier_description: 'Default Supplier LARSSON & JENNINGS LTD',
+  supplier_uom:         1,
+  warehouses: {
+    us: 'US123',
+    uk: 'UK123'
+  }
+)
+```
+
+#### Submit Product
+
+```ruby
+client   = Seko::Client.new(Seko.config[:token])
+response = client.submit_product(upc: "123456", description: 'A test product')
+```
+
+#### Submit Receipt
+
+```ruby
+line_items = [ { upc: "123456", quantity: 10 } ]
+warehouse  = Seko.config[:warehouses][:us]
+client     = Seko::Client.new(Seko.config[:token])
+response   = client.submit_receipt(line_item_array, warehouse)
+```
+
+#### Submit Company
+
+```ruby
+company_hash = {
+  code:        'IND001',
+  description: 'Indigina'
+}
+client     = Seko::Client.new(Seko.config[:token])
+response   = client.submit_company(company_hash)
+```
+
+#### Get Stock
+
+```ruby
+client   = Seko::Client.new(Seko.config[:token])
+response = client.get_inventory
+```
+
+#### Check GRN
+
+```ruby
+client   = Seko::Client.new(Seko.config[:token])
+response = client.check_grn('5b2dcd8e-52c3-4e27-a712-eaacda2dd8fe')
+```
+
+#### Order Status
+
+```ruby
+client   = Seko::Client.new(Seko.config[:token])
+response = client.order_status('5b2dcd8e-52c3-4e27-a712-eaacda2dd8fe')
+```
+
+#### Order Tracking
+
+```ruby
+client   = Seko::Client.new(Seko.config[:token])
+response = client.order_tracking('5b2dcd8e-52c3-4e27-a712-eaacda2dd8fe')
+```
+
+#### Cancel Order
+
+```ruby
+Seko::Order::CANCEL_CODES
+# => {
+#      "001" => "Customer Request", 
+#      "002" => "Order Delayed", 
+#      "003" => "Duplicate", 
+#      "004" => "Item not available", 
+#      "005" => "Cannot ship to address", 
+#      "006" => "Other"
+#    }
+
+client   = Seko::Client.new(Seko.config[:token])
+response = client.cancel_order('5b2dcd8e-52c3-4e27-a712-eaacda2dd8fe', '001')
+```
+
+#### Stock Movements
+
+```ruby
+client    = Seko::Client.new(Seko.config[:token])
+warehouse = Seko.config[:warehouses][:us]
+from      = 3.days.ago
+to        = Time.now
+response  = client.stock_movements(from, to, warehouse)
+```
+
+#### Stock Adjustments
+
+```ruby
+client    = Seko::Client.new(Seko.config[:token])
+warehouse = Seko.config[:warehouses][:us]
+from      = 3.days.ago
+to        = Time.now
+response  = client.stock_adjustments(from, to, warehouse)
+```
+
+#### Dispatch Statuses
+
+```ruby
+client    = Seko::Client.new(Seko.config[:token])
+warehouse = Seko.config[:warehouses][:us] # warehouse is optional
+from      = 3.days.ago
+to        = Time.now
+response  = client.dispatch_statuses(from, to, warehouse)
+
+# get collection of GUIDs dispatched
+guid_array = Seko::Dispatch.parse(response)
+# returns something like this
+# => ["2b5e52cc-fb6f-4ea4-b8cf-cf64e3a2b8db", "93e92ca2-725a-46f8-90dd-43a16105f78d"]
+```
+
+#### Submit Order
+
+```ruby
+order = {
+  shipping_address: {
+    first_name: "John",
+    last_name:  "Smith",
+    address1:   "123 Here Now",
+    address2:   "2nd Floor",
+    city:       "New York",
+    state:      "New York",
+    country:    "US",
+    zipcode:    "10012",
+    phone:      "123-123-1234"
+  },
+  email:        "someone@somehwere.com",
+  number:       "R123123123",
+  warehouse:    "DC123",
+  date:         "2013-12-12",
+  line_items: [
+    {
+      quantity: "1",
+      sku:      "123332211"
+    }
+  ]
+}
+
+client   = Seko::Client.new(Seko.config[:token])
+response = client.send_order_request(order)
+
+### NOTE you may want to store the GUID from the response
+### you need the guid for status updates, tracking, and canceling orders
+response.guid
+
+if response.success?
+  # DO SOMETHING
+else
+  # QUEUE REQUEST, STORE AND RAISE ERRORS
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/seko/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`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/seko/client.rb

@@ -0,0 +1,236 @@
+require 'net/https'
+require 'json'
+
+module Seko
+  class Client
+
+    PORT         = 443
+    TEST_HOST    = 'hubuat1.supplystream.com'
+    # api.supplystream.com
+    LIVE_HOST    = 'hub.supplystream.com'
+    API_PATH     = '/hub/api/'
+    API_VERSION  = 'v1'
+    CONTENT_TYPE = 'application/json'
+    KEYS_MAP     = { 
+      "FreeQuantity" => "qty", 
+      "ProductCode"  => "upc" 
+    }
+
+    attr_accessor :token, :response, :type, :request_uri, :path, :service, :endpoint, :options
+
+    def initialize(token, options = {})
+      raise "Token is required" unless token
+
+      @token   = token
+      @options = default_options.merge(options)
+    end
+
+    def send_order_request(order_hash)
+      @service  = 'salesorders'
+      @endpoint = 'websubmit'
+      post(Order.websubmit(order_hash))
+    end
+
+    def order_request(order_hash)
+      Order.websubmit(order_hash).to_json
+    end
+
+    def send_wholesale_request(order_hash)
+      @service  = 'salesorders'
+      @endpoint = 'submit'
+      post(Order.submit(order_hash))
+    end
+
+    def wholesale_request(order_hash)
+      Order.submit(order_hash).to_json
+    end
+
+    # FIXME: use this method once SS fixes their API
+    # for now we are manually sorting the distribution centre
+    # see #inventory_response below
+    #
+    # def get_inventory(warehouse = nil)
+    #   @service  = 'stock'
+    #   @endpoint = if warehouse.nil?
+    #     "all"
+    #   else 
+    #     "dc/#{warehouse}"
+    #   end
+    #   inventory_response
+    # end
+    #
+    # def inventory_response
+    #   response = get
+    #   response.parsed = map_results(Stock.parse(response))
+    #   response
+    # end
+
+    def get_inventory(warehouse = nil)
+      @service  = 'stock'
+      @endpoint = 'all'
+      inventory_response(warehouse)
+    end
+
+
+    def inventory_response(warehouse = nil)
+      response = get
+      response.parsed = map_results(Stock.parse(response)).select do |stock|
+        warehouse.nil? ? true : stock["DCCode"] == warehouse
+      end
+      response
+    end
+
+    def upcs(inventory)
+      inventory.collect { |s| s["upc"] }
+    end
+
+    def mapped_inventory(upcs, inventory)
+      inventory.collect do |stock| 
+        if upcs.include?(stock["upc"])
+          { quantity: stock["qty"].to_i }
+        end
+      end.compact
+    end
+
+    def map_results(results)
+      results.map { |h| h.inject({ }) { |x, (k,v)| x[map_keys(k)] = v; x } }
+    end
+
+    def map_keys(key)
+      KEYS_MAP[key] || key
+    end
+
+    def submit_product(product_hash)
+      @service  = 'products'
+      @endpoint = 'submit'
+      post(Product.format(product_hash))
+    end
+
+    def submit_receipt(line_item_array, warehouse)
+      @service  = 'receipts'
+      @endpoint = 'submit'
+      post(Receipt.format(line_item_array, warehouse))
+    end
+
+    def submit_company(company_hash)
+      @service  = 'companies'
+      @endpoint = 'submit'
+      post(Company.format(company_hash))
+    end
+
+    def check_grn(guid)
+      @service  = 'grns'
+      @endpoint = guid
+      get
+    end
+
+    def order_status(guid)
+      @service  = 'salesorders'
+      @endpoint = "#{guid}/status"
+      get
+    end
+
+    def order_tracking(guid)
+      @service  = 'salesorders'
+      @endpoint = "#{guid}/tracking"
+      get
+    end
+
+    def cancel_order(guid, reason_code)
+      @service  = 'salesorders'
+      @endpoint = "#{guid}/cancel/reasoncode/#{reason_code}"
+      post({'Cancel' => 'Order'})
+    end
+
+    def stock_adjustments(from, to, warehouse)
+      @service  = 'stock'
+      @endpoint = "adjustment/#{format_from_to(from, to)}"
+      get("#{request_uri}&dc=#{warehouse}")
+    end
+
+    def stock_movements(from, to, warehouse)
+      @service  = 'stock'
+      @endpoint = "movement/#{format_from_to(from, to)}"
+      get("#{request_uri}&dc=#{warehouse}")
+    end
+
+    def dispatch_statuses(from, to, warehouse = nil)
+      @service     = 'dispatches'
+      @endpoint    = "status/#{format_from_to(from, to)}"
+      request_url  = "#{request_uri}&status=Dispatched"
+      request_url += "&dc=#{warehouse}" unless warehouse.nil?
+      get(request_url)
+    end
+
+    def request_uri
+      "https://#{host}#{path}?token=#{token}"
+    end
+
+    def path
+      "#{API_PATH}#{service}/#{API_VERSION}/#{endpoint}.json"
+    end
+
+    private
+    def default_options
+      { 
+        verbose: false,
+        test_mode: true
+      }
+    end
+
+    def testing?
+      @options[:test_mode]
+    end
+
+    def verbose?
+      @options[:verbose]
+    end
+
+    def host
+      testing? ? TEST_HOST : LIVE_HOST 
+    end
+
+    def log(message)
+      return unless verbose?
+      puts message
+    end
+
+    def http
+      @http ||= Net::HTTP.new(host, PORT)
+    end
+
+    def build_request(type, url = request_uri)
+      request = Net::HTTP.const_get(type).new(url)
+      request.content_type = CONTENT_TYPE
+      request
+    end
+
+    def request(request, json_request = nil)
+      http.use_ssl     = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      response = http.request(request)
+      parse_response(response.body)
+    end
+
+    def get(url = request_uri)
+      request = build_request('Get', url)
+      request(request)
+    end
+
+    def post(json_request, url = request_uri)
+      request      = build_request('Post', url)
+      request.body = json_request.to_json
+      request(request)
+    end
+
+    def parse_response(json_response)
+      log(json_response)
+      @response = Response.new(json_response)
+    end
+
+    def format_from_to(from, to)
+      "#{from.strftime('%F')}T00:00:00Z/#{to.strftime('%F')}T00:00:00Z"
+    end
+
+  end
+end

data/lib/seko/company.rb

@@ -0,0 +1,33 @@
+module Seko
+  class Company
+
+    def self.format(company)
+      {
+        "Request" => {
+          "Company" => {
+            "CompanyCode"        => company[:code],
+            "CompanyDescription" => company[:description],
+            "CompanyType"        => "Ship To"
+          },
+          "List" => {
+            "Address" => address(company[:address])
+          }
+        }
+      }
+    end
+
+    def self.address(address)
+      {
+        "AddressLine1" => address[:address1],
+        "AddressLine2" => address[:address2],
+        "AddressLine3" => address[:address3],
+        "AddressType"  => "Delivery",
+        "City"         => address[:city],
+        "CountryCode"  => address[:country],
+        "County"       => address[:country_name],
+        "PostcodeZip"  => address[:zipcode]
+      }
+    end
+
+  end
+end

data/lib/seko/dispatch.rb

@@ -0,0 +1,22 @@
+module Seko
+  class Dispatch
+
+    def self.line_items(response)
+      response.root_response["List"]["DispatchLineItem"]
+    end
+
+    # returns array of GUIDs
+    def self.parse(response)
+      dispatches = line_items(response)
+      # API is flawed and returns an array if multiple dispatches
+      if dispatches.is_a?(Array)
+        dispatches.collect { |h| h["GUID"] }
+      else
+        # and a singular object otherwise
+        # so we wrap it as an array
+        Array(dispatches["GUID"])
+      end
+    end
+
+  end
+end

data/lib/seko/filter.rb

@@ -0,0 +1,9 @@
+module Seko
+  class Filter
+
+    def self.parse(text)
+      text.gsub('|', '-')
+    end
+
+  end
+end

data/lib/seko/order.rb

@@ -0,0 +1,77 @@
+module Seko
+  class Order
+
+    CANCEL_CODES = {
+      '001' => 'Customer Request',
+      '002' => 'Order Delayed',
+      '003' => 'Duplicate',
+      '004' => 'Item not available',
+      '005' => 'Cannot ship to address',
+      '006' => 'Other'
+    }
+
+    def self.websubmit(attributes)
+      build_request(attributes, "Web")
+    end
+
+    def self.submit(attributes)
+      build_request(attributes)
+    end
+
+    def self.build_request(attributes, type = nil)
+      formatted = format(attributes, type)
+      formatted["Request"].merge!(company(attributes[:company])) if attributes[:company]
+      formatted
+    end
+
+    def self.format(order, order_prefix = nil)
+      {
+        "Request" => {
+          "DeliveryDetails"      => address(order[:shipping_address], order[:email]),
+          "List" => {
+            "SalesOrderLineItem" => line_items(order[:line_items])
+          },
+          "SalesOrderHeader" => { "DCCode" => order[:warehouse] },
+          "#{order_prefix}SalesOrder" => {
+            "SalesOrderDate"     => order[:date],
+            "SalesOrderNumber"   => order[:number]
+          }
+        }
+      }
+    end
+
+    def self.address(address, email)
+      {
+        "City"         => address[:city],
+        "CountryCode"  => address[:country],
+        "EmailAddress" => email,
+        "FirstName"    => address[:first_name],
+        "LastName"     => address[:last_name],
+        "Line1"        => address[:address1],
+        "Line2"        => address[:address2],
+        "PhoneNumber"  => address[:phone],
+        "PostcodeZip"  => address[:zipcode]
+      }
+    end
+
+    def self.line_items(items)
+      items.collect.with_index do |line_item, index|
+        {
+          "LineNumber"  => index + 1,
+          "ProductCode" => line_item[:sku],
+          "Quantity"    => line_item[:quantity]
+        }
+      end
+    end
+
+    def self.company(company)
+      {
+        "ShipToCompany" => {
+          "CompanyCode"        => company[:code],
+          "CompanyDescription" => company[:description]
+        }
+      }
+    end
+
+  end
+end

data/lib/seko/product.rb

@@ -0,0 +1,27 @@
+module Seko
+  class Product
+
+    def self.supplier
+      {
+        "SupplierCode"        => Seko.config[:supplier_code],
+        "SupplierDescription" => Seko.config[:supplier_description],
+        "UOM"                 => Seko.config[:supplier_uom]
+      }
+    end
+
+    def self.format(attributes)
+      {
+        "Request" => {
+          "List" => {
+            "SupplierMapping" => supplier
+          },
+          "ProductMaster" => {
+            "ProductCode"        => attributes[:upc],
+            "ProductDescription" => Filter.parse(attributes[:description])
+          }
+        }
+      }
+    end
+
+  end
+end