zanders 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 320b713912cf45d9193b127a38bfb51e5b5b91d6
+  data.tar.gz: 7736dcf3ffab83a65309c16cea0df56e8235bb5c
+SHA512:
+  metadata.gz: 3203095d5298e9e5ca76c00bcde33e576e5a549fe6e492844eda133d731bd0b7de5571fc65355b9794f2024b8a824aac45f397b4acbb75469d1b67c23eeaa334
+  data.tar.gz: 419adab7698aa2915f0703be0baef0efbded9b282c44fa0bc9f03d8e95edf8e094799b61c46ee4e85a9d9355a68a453778f5542756a2f8044c3157943b7b5efd

data/.gitignore

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

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+zanders

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 David Knight
+
+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 @@
+# Zanders

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 "zanders"
+
+# 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/zanders/address.rb

@@ -0,0 +1,88 @@
+module Zanders
+  class Address < SoapClient
+
+    attr_reader :username
+    attr_reader :password
+
+    # Public: Initializes a new Address with username
+    # and password
+    #
+    # username - A String username
+    # password - A String password
+    #
+    # Returns a new Address service interface
+    def initialize(options = {})
+      requires!(options, :username, :password)
+
+      @username = options[:username]
+      @password = options[:password]
+    end
+
+    def self.ship_to_number(address, options = {})
+      new(options).ship_to_number(address)
+    end
+
+    # Public: Get a shipToNumber for the address
+    # provided in `address`
+    #
+    # address - Hash of the address
+    #
+    # Returns Hash containing the ship to number, or an error
+    # code if the call failed
+    def ship_to_number(address)
+      request_data = build_request_data(address)
+
+      response = soap_client(ADDRESS_API_URL).call(:use_ship_to, message: request_data)
+      response = response.body[:use_ship_to_response][:return][:item]
+
+      # Successful call return_code is 0
+      if response.first[:value] == "0"
+        ship_to_number = Hash.new
+
+        # Let's dig to get to data we actually need. Yay, digging...
+        parts = ship_to_number[:ship_to_number] = response.last[:value].first[1]
+
+        # We only need the ship_to_number out of the data received
+        ship_to_number[:ship_to_number] = parts.find { |i| i[:key] == "ShipToNo" }[:value]
+
+        ship_to_number[:success] = true
+
+        ship_to_number
+      else
+        { success: false, error_code: response.first[:value] }
+      end
+    end
+
+    private
+
+    # Private: Combines request data with the username,
+    # password, and type-cast assignments
+    #
+    # hash - Hash of request data
+    #
+    # Returns merged Hash
+    def build_request_data(hash)
+      {
+        :attributes! => {
+          addressinfo: { "xsi:type" => "ns2:Map" },
+        },
+        username: @username,
+        password: @password,
+        addressinfo: {
+          item: [
+            { key: 'name',      value: hash[:name]      },
+            { key: 'address1',  value: hash[:address1]  },
+            { key: 'address2',  value: hash[:address2]  },
+            { key: 'city',      value: hash[:city]      },
+            { key: 'state',     value: hash[:state]     },
+            { key: 'zip',       value: hash[:zip]       },
+            { key: 'fflno',     value: hash[:fflno]     },
+            { key: 'fflexp',    value: hash[:fflexp]    }
+          ]
+        },
+        testing: true
+      }
+    end
+
+  end
+end

data/lib/zanders/base.rb

@@ -0,0 +1,43 @@
+module Zanders
+  class Base
+
+    def self.connect(options = {})
+      requires!(options, :username, :password)
+
+      Net::FTP.open(Zanders.config.ftp_host, options[:username], options[:password]) do |ftp|
+        ftp.passive = true
+        yield ftp
+      end
+    rescue Net::FTPPermError
+      raise Zanders::NotAuthenticated
+    end
+
+    protected
+
+    # Wrapper to `self.requires!` that can be used as an instance method.
+    def requires!(*args)
+      self.class.requires!(*args)
+    end
+
+    def self.requires!(hash, *params)
+      params.each do |param|
+        if param.is_a?(Array)
+          raise ArgumentError.new("Missing required parameter: #{param.first}") unless hash.has_key?(param.first)
+
+          valid_options = param[1..-1]
+          raise ArgumentError.new("Parameter: #{param.first} must be one of: #{valid_options.join(', ')}") unless valid_options.include?(hash[param.first])
+        else
+          raise ArgumentError.new("Missing required parameter: #{param}") unless hash.has_key?(param)
+        end
+      end
+    end
+
+    # Instance methods become class methods through inheritance
+    def connect(options)
+      self.class.connect(options) do |ftp|
+        yield ftp
+      end
+    end
+
+  end
+end

data/lib/zanders/inventory.rb

@@ -0,0 +1,54 @@
+module Zanders
+  class Inventory < Base
+
+    INVENTORY_FILENAME = "zandersinv.csv"
+    QUANTITY_FILENAME = "liveinv.csv"
+
+    def initialize(options = {})
+      requires!(options, :username, :password)
+
+      @options = options
+    end
+
+    def self.all(chunk_size = 15, options = {}, &block)
+      requires!(options, :username, :password)
+      new(options).all(chunk_size, &block)
+    end
+
+    def self.quantities(chunk_size = 15, options = {}, &block)
+      requires!(options, :username, :password)
+      new(options).quantities(chunk_size, &block)
+    end
+
+    def all(chunk_size, &block)
+      connect(@options) do |ftp|
+        csv_tempfile = Tempfile.new
+
+        ftp.chdir(Zanders.config.ftp_directory)
+        ftp.getbinaryfile(INVENTORY_FILENAME, csv_tempfile.path)
+
+        SmarterCSV.process(csv_tempfile, { :chunk_size => chunk_size, :convert_values_to_numeric => false }) do |chunk|
+          yield(chunk)
+        end
+
+        csv_tempfile.unlink
+      end
+    end
+
+    def quantities(chunk_size, &block)
+      connect(@options) do |ftp|
+        csv_tempfile = Tempfile.new
+
+        ftp.chdir(Zanders.config.ftp_directory)
+        ftp.getbinaryfile(QUANTITY_FILENAME, csv_tempfile.path)
+
+        SmarterCSV.process(csv_tempfile, { :chunk_size => chunk_size, :convert_values_to_numeric => false }) do |chunk|
+          yield(chunk)
+        end
+
+        csv_tempfile.unlink
+      end
+    end
+
+  end
+end

data/lib/zanders/item.rb

@@ -0,0 +1,105 @@
+module Zanders
+  class Item < SoapClient
+
+    attr_reader :username
+    attr_reader :password
+
+    # Public: Initialize a new Item interface with
+    # username and password
+    #
+    # options - Hash of username and password
+    #
+    # Returns a new Item service interface
+    def initialize(options = {})
+      requires!(options, :username, :password)
+
+      @username = options[:username]
+      @password = options[:password]
+    end
+
+    # Public: Get item info by item number
+    #
+    # item_number - Integer of the item number
+    #
+    # Returns Hash containing item info, or an error code if
+    # the call failed
+    def get_info(item_number)
+      request_data = build_request_data({ itemnumber: item_number })
+
+      response = soap_client(ITEM_API_URL).call(:get_item_info, message: request_data)
+      response = response.body[:get_item_info_response][:return][:item]
+
+      # Successful call return_code is 0
+      if response.first[:value] == "0"
+        info = Hash.new
+
+        # Let's toss the data we need into a ruby-ish hash
+        response.each do |info_part|
+          case info_part[:key]
+          when  "itemNumber"
+            info[:item_number] = info_part[:value]
+          when "itemDescription"
+            info[:description] = info_part[:value]
+          when "itemPrice"
+            info[:price] = info_part[:value]
+          when "itemWeight"
+            info[:weight] = info_part[:value]
+          when "numberAvailable"
+            info[:quantity] = info_part[:value]
+          else
+            next
+          end
+        end
+
+        info[:success] = true
+
+        info
+      else
+        { success: false, error_code: response.first[:value] }
+      end
+    end
+
+    # Public: Get item quantity by item number
+    #
+    # item_number - Integer of the item number
+    #
+    # Returns Hash containing item quantity, or an error code
+    # if the call failed
+    def get_quantity(item_number)
+      request_data = build_request_data({ itemnumber: item_number })
+
+      response = soap_client(ITEM_API_URL).call(:get_item_inventory, message: request_data)
+      response = response.body[:get_item_inventory_response][:return][:item]
+
+      # Successful call return_code is 0
+      if response.first[:value] == "0"
+        quantity = Hash.new
+
+        # We only need the quantity out of the data received
+        quantity[:quantity] = response.find { |i| i[:key] == "numberAvailable" }[:value]
+
+        quantity[:success] = true
+
+        quantity
+      else
+        { success: false, error_code: response.first[:value] }
+      end
+    end
+
+    private
+
+    # Private: Combines request data with the username and password
+    #
+    # hash - Hash of request data
+    #
+    # Returns merged Hash
+    def build_request_data(hash)
+      {
+        username: @username,
+        password: @password,
+        testing: true
+      }.merge(hash)
+    end
+
+  end
+end

data/lib/zanders/order.rb

@@ -0,0 +1,160 @@
+module Zanders
+  class Order < SoapClient
+
+    ##
+    # == Order Service
+    #
+    # Return Codes
+    # 0: Success
+    # 1: Username and/or Password were incorrect
+    # 2: There was a problem creating the order
+    # 5: Cannot create order with no items
+    # 9: Order not created because all items not available and not to be back ordered
+    # 10: Ship date cannot be before today
+    # 11: Ship date cannoy be more than 30days in the future
+    # 21: The order number is NOT connected to your customer number
+    # 31: Can NOT add item with quantity of less than 1
+    # 41: The item number requested is NOT connected to this order
+
+    attr_reader :username, :password, :options
+
+    # Public: Initialize a new Order
+    #
+    # options - Hash of username, password, and address information
+    #
+    # Returns an Order service interface
+    def initialize(options = {})
+      requires!(options, :username, :password)
+
+      @username = options[:username]
+      @password = options[:password]
+
+      @options = options
+    end
+
+    # Public: Create a new order
+    #
+    # items - Array of hashes containing item_number and quantity
+    #
+    # Returns an order_number
+    def create_order(items, address)
+      order = build_order_data
+      order_items = Array.new
+
+      items.each do |item|
+        order_items.push(item: [
+          { key: 'itemNumber', value: item[:item_number] },
+          { key: 'quantity', value: item[:quantity] },
+          { key: 'allowBackOrder', value: false }
+        ])
+      end
+
+      ship_to_number = Zanders::Address.ship_to_number(address, @options)
+
+      if ship_to_number[:success]
+        shipping_information = [
+          { key: 'shipToNo', value: ship_to_number[:ship_to_number] },
+          { key: 'shipDate', value: Time.now.strftime("%Y-%m-%d") },
+          # TODO-david
+          { key: 'ShipViaCode', value: 'UG' },
+          # TODO-david
+          { key: 'purchaseOrderNumber', value: '4567' }
+        ]
+
+        # NOTE-david
+        # order(ns2 map)
+        #   item
+        #     key
+        #     value(ns2map)
+        #       item  - order item
+        #       item  - order item
+        #   item
+        #     "
+        #   
+        order[:order] = Hash.new
+        order[:order][:item] = shipping_information
+
+        order_items = {item: order_items, attributes!: { item: { "xsi:type" => "ns2:Map"} }}
+
+        order[:order][:item].push({
+          key: 'items',
+          value: order_items
+        })
+
+        response = soap_client(ORDER_API_URL).call(:create_order, message: order)
+      end
+    end
+
+    # Public: Get order info
+    #
+    # order_number - The String order number
+    #
+    # Returns Hash containing order information, or an error
+    # code if the call failed
+    def get_order(order_number)
+      order = build_order_data.merge({ ordernumber: order_number })
+
+      response = soap_client(ORDER_API_URL).call(:get_order_info, message: order)
+      response = response.body[:get_order_info_response][:return][:item]
+
+      # Successful call return_code is 0
+      if response.first[:value] == "0"
+        info = Hash.new
+
+        # Just use the order number we already have
+        info[:order_number] = order_number
+
+        # Transform the response into a ruby-ish hash
+        response.each do |part|
+          case part[:key]
+          when "purchaseOrderNumber"
+            info[:purchase_order_number] = part[:value]
+          when "orderDate"
+            info[:order_date] = part[:value]
+          when "orderEnteredDate"
+            info[:ordered_entered_date] = part[:value]
+          when "orderShipDate"
+            info[:order_ship_date] = part[:value]
+          when "subtotal"
+            info[:subtotal] = part[:value]
+          when "freight"
+            info[:freight] = part[:value]
+          when "miscFee"
+            info[:misc_fee] = part[:value]
+          when "selectionCode"
+            info[:selection_code] = part[:value]
+          when "datePicked"
+            info[:date_picked] = part[:value]
+          when "grandTotal"
+            info[:grand_total] = part[:value]
+          end
+        end
+
+        info[:success] = true
+
+        info
+      else
+        { success: false, error_code: response.first[:value] }
+      end
+    end
+
+    private
+
+    # Private: Builds request data
+    #
+    # Returns Hash of username, password, and cast assignments
+    def build_order_data
+      hash = {
+        :attributes! => {
+          order: { "xsi:type" => "ns2:Map" }
+        },
+        username: @username,
+        password: @password,
+        testing: true
+      }
+
+      hash
+    end
+
+  end
+end

data/lib/zanders/soap_client.rb

@@ -0,0 +1,39 @@
+module Zanders
+  class SoapClient < Base
+
+    ##
+    # == Item Service
+    #
+    # Return Codes
+    # 0: Success
+    # 1: Username and/or Password were incorrect
+    # 2: There was a problem retrieving information on the item(s)
+
+    protected
+
+    def soap_client(api_url)
+      namespaces = {
+        "xmlns:env" => "http://www.w3.org/2003/05/soap-envelope",
+        "xmlns:xsd" => "http://www.w3.org/2001/XMLSchema",
+        "xmlns:xsl" => "http://www.w3.org/2001/XMLSchema-Instance",
+        "xmlns:ns2" => "http://xml.apache.org/xml-soap",
+        "xmlns:enc" => "http://www.w3.org/2003/05/soap-encoding"
+      }
+
+      @soap_client ||= Savon.client do
+        wsdl(api_url)
+        namespaces(namespaces)
+        namespace_identifier(:ns1)
+        strip_namespaces true
+        ssl_verify_mode :none
+
+        if DEBUG
+          log(true)
+          log_level(:debug)
+          pretty_print_xml(true)
+        end
+      end
+    end
+
+  end
+end

data/lib/zanders/version.rb

@@ -0,0 +1,3 @@
+module Zanders
+  VERSION = "0.1.5"
+end

data/lib/zanders.rb

@@ -0,0 +1,47 @@
+require "zanders/version"
+
+require 'net/ftp'
+require 'savon'
+# TODO-david
+require 'pp'
+
+require 'zanders/base'
+require 'zanders/soap_client'
+
+require 'zanders/address'
+require 'zanders/order'
+require 'zanders/item'
+require 'zanders/inventory'
+
+module Zanders
+
+  DEBUG = true
+
+  ADDRESS_API_URL = 'https://shop2.gzanders.com/webservice/shiptoaddresses?wsdl'
+  ORDER_API_URL   = 'https://shop2.gzanders.com/webservice/orders?wsdl'
+  ITEM_API_URL    = 'https://shop2.gzanders.com/webservice/items?wsdl'
+
+  class NotAuthenticated < StandardError; end
+
+  class << self
+    attr_accessor :config
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.configure
+    yield(config)
+  end
+
+  class Configuration
+    attr_accessor :ftp_host
+    attr_accessor :ftp_directory
+
+    def initialize
+      @ftp_host ||= "ftp.gzanders.com"
+      @ftp_directory ||= "Inventory/AmmoReady"
+    end
+  end
+end

data/zanders.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zanders/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zanders"
+  spec.version       = Zanders::VERSION
+  spec.authors       = ["David Knight"]
+  spec.email         = ["viacoffee@gmail.com"]
+
+  spec.summary       = %q{Ruby library for Zanders}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  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_dependency "nokogiri", "~> 1.6"
+  spec.add_dependency "savon", "~> 2.11.1"
+
+  spec.add_runtime_dependency "smarter_csv", "~> 1.1.4"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: zanders
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- David Knight
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.1
+- !ruby/object:Gem::Dependency
+  name: smarter_csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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:
+- viacoffee@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zanders.rb
+- lib/zanders/address.rb
+- lib/zanders/base.rb
+- lib/zanders/inventory.rb
+- lib/zanders/item.rb
+- lib/zanders/order.rb
+- lib/zanders/soap_client.rb
+- lib/zanders/version.rb
+- zanders.gemspec
+homepage: ''
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby library for Zanders
+test_files: []