bill_hicks 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 27f9faa7867304abe4e10327832c3149c0aa4d6c
+  data.tar.gz: c23114e4d48e20de341bbefb79f534f2e683d9ce
+SHA512:
+  metadata.gz: 3e1654caa5bf30a1efa071c02b728674d72157ac8ea182a16e13be6b10055aaeb727a1ba076767915f083b4ece635af6c2d8208d227c0d08acaeb56efab3a5f5
+  data.tar.gz: 0df57a670548257548f98773e42561db169c2fda0a00355b9b2f428ea2cc95a68e3c17b68d4ad48e57bc64474cc1e6b2a8e09194f7478f79df7e4819674216b9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+bill_hicks

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.13.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Dale Campbell
+
+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,124 @@
+# BillHicks
+
+Ruby library for Bill Hicks ERP system.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bill_hicks'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bill_hicks
+
+## Usage
+
+**Note:** Nearly all methods require `:username` and `:password` keys in the options hash.
+
+```ruby
+options = {
+  username: 'dealer@example.com',
+  password: 'sekret-passwd'
+}
+```
+
+### BillHicks::Catalog
+
+To get all items in the catalog:
+
+```ruby
+catalog = BillHicks::Catalog.all(options)
+```
+
+See `BillHicks::Catalog` for the response structure.
+
+### BillHicks::Inventory
+
+To get your inventory details (availability, price, etc.):
+
+```ruby
+inventory = BillHicks::Inventory.all(options)
+```
+
+See `BillHicks::Inventory` for the response structure.
+
+### BillHicks::Category
+
+Returns an array of category codes and descriptions.
+
+```ruby
+categories = BillHicks::Category.all(options)
+
+# [
+#   {:code=>"H648", :description=>"AIRGUNS"},
+#   {:code=>"H610", :description=>"AMMUNITION"},
+#   ...,
+# ]
+```
+
+### BillHicks::Order
+
+To build and submit an order, the basic steps are: 1) instantiate an Order object, 2) add header
+information, 3) add item information (multiple items if needed), 4) submit the order.
+
+```ruby
+# Instantiate the Order instance, passing in your :username and :password
+order = BillHicks::Order.new(options)
+
+# Add header information:
+header_opts = {
+  customer: '...',  # customer number
+  purchase_order: '...',  # application specific purchase order
+  ffl: '...',  # your FFL number
+  shipping: {  # shipping information (all fields except :address_2 are required)
+    name: '...',
+    address_1: '...',
+    address_2: '...',
+    city: '...',
+    state: '...',
+    zip: '...',
+  },
+
+  # Optional fields:
+  shipping_method: '...',
+  notes: '...',
+}
+order.add_header(header_opts)
+
+# Add item information:
+item_opts = {
+  item_number: '...',  # Bill Hicks item number
+  description: '...',
+  quantity: 1,
+  price: '123.45',  # Decimal formatted price, without currency sign
+}
+order.add_item(item_opts)  # Multiple items may be added, just call #add_item for each one.
+
+# Submit the order (returns true on success, raises an exception on failgure):
+order.submit!
+```
+
+See `BillHicks::Order` for details on required options.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ammoready/bill_hicks.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bill_hicks.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bill_hicks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bill_hicks"
+  spec.version       = BillHicks::VERSION
+  spec.authors       = ["Dale Campbell"]
+  spec.email         = ["oshuma@gmail.com"]
+
+  spec.summary       = %q{Ruby library for Bill Hicks ERP system}
+  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_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bill_hicks"
+
+# 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

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/bill_hicks.rb

@@ -0,0 +1,15 @@
+require 'bill_hicks/version'
+
+require 'csv'
+require 'net/ftp'
+
+require 'bill_hicks/base'
+require 'bill_hicks/catalog'
+require 'bill_hicks/category'
+require 'bill_hicks/inventory'
+require 'bill_hicks/order'
+
+module BillHicks
+  class InvalidOrder < StandardError; end
+  class NotAuthenticated < StandardError; end
+end

data/lib/bill_hicks/base.rb

@@ -0,0 +1,39 @@
+module BillHicks
+  class Base
+
+    FTP_HOST = 'billhicksco.hostedftp.com'
+    FTP_DIR  = 'AmmoReady'
+
+    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
+
+    def connect(options = {})
+      requires!(options, :username, :password)
+
+      Net::FTP.open(FTP_HOST, options[:username], options[:password]) do |ftp|
+        ftp.passive = true
+        yield ftp
+      end
+    rescue Net::FTPPermError
+      raise BillHicks::NotAuthenticated
+    end
+
+  end
+end

data/lib/bill_hicks/catalog.rb

@@ -0,0 +1,64 @@
+module BillHicks
+  # Catalog item response structure:
+  #
+  #   {
+  #     product_name:           "...",
+  #     universal_product_code: "...",
+  #     short_description:      "...",
+  #     long_description:       "...",
+  #     category_code:          "...",
+  #     category_description:   "...",
+  #     product_price:          "...",
+  #     small_image_path:       "...",
+  #     large_image_path:       "...",
+  #     product_weight:         "...",
+  #     marp:                   "...",
+  #     msrp:                   "...",
+  #     upc:                    "..."  # alias of ':universal_product_code'
+  #   }
+  class Catalog < Base
+
+    # FIXME: Change this back to the normal filename as soon as they fix the headers in this file.
+    # CATALOG_FILENAME = 'billhickscatalog.csv'
+    CATALOG_FILENAME = 'billhickscatalog-fixed.csv'
+
+
+    def initialize(options = {})
+      requires!(options, :username, :password)
+      @options = options
+    end
+
+    def self.all(options = {})
+      requires!(options, :username, :password)
+      new(options).all
+    end
+
+    # Returns an array of hashes with the catalog item details.
+    def all
+      catalog = []
+
+      connect(@options) do |ftp|
+        ftp.chdir(FTP_DIR)
+
+        lines = ftp.gettextfile(CATALOG_FILENAME, nil)
+
+        STDOUT.puts "-- DEBUG: #{self.class}: #{lines.inspect}"
+
+        CSV.parse(lines, headers: :first_row) do |row|
+          row_hash = {}
+
+          # Turn the row into a hash with header names as symbolized keys.
+          row.each { |r| row_hash[r.first.to_sym] = r.last }
+
+          # Alias the ':universal_product_code' as ':upc'.
+          row_hash[:upc] = row_hash[:universal_product_code]
+
+          catalog << row_hash
+        end
+      end
+
+      catalog
+    end
+
+  end
+end

data/lib/bill_hicks/category.rb

@@ -0,0 +1,40 @@
+module BillHicks
+  # Category item response structure:
+  #
+  #   {
+  #     code:        "...",  # ':category_code' in Catalog response.
+  #     description: "..."   # ':category_description' in Catalog response.
+  #   }
+  class Category < Base
+
+    def initialize(options = {})
+      requires!(options, :username, :password)
+      @options = options
+    end
+
+    def self.all(options = {})
+      requires!(options, :username, :password)
+      new(options).all
+    end
+
+    # Returns an array of hashes with category details.
+    def all
+      categories = []
+
+      # Categories are listed in catalog csv, so fetch that.
+      catalog = Catalog.all(@options)
+      catalog.each do |item|
+        categories << {
+          code: item[:category_code],
+          description: item[:category_description]
+        }
+      end
+
+      categories.uniq! { |c| c[:description] }
+      categories.sort_by! { |c| c[:description] }
+
+      categories
+    end
+
+  end
+end

data/lib/bill_hicks/inventory.rb

@@ -0,0 +1,46 @@
+module BillHicks
+  # Inventory item response structure:
+  #
+  #   {
+  #     product:  "...",
+  #     upc:      "...",
+  #     quantity: "..."
+  #   }
+  class Inventory < Base
+
+    INVENTORY_FILENAME = 'billhicksinventory.csv'
+
+
+    def initialize(options = {})
+      requires!(options, :username, :password)
+      @options = options
+    end
+
+    def self.all(options = {})
+      requires!(options, :username, :password)
+      new(options).all
+    end
+
+    # Returns an array of hashes with the inventory item details.
+    def all
+      inventory = []
+
+      connect(@options) do |ftp|
+        ftp.chdir(FTP_DIR)
+
+        lines = ftp.gettextfile(INVENTORY_FILENAME, nil)
+
+        CSV.parse(lines, headers: :first_row) do |row|
+          inventory << {
+            product: row.fetch('Product'),
+            upc: row.fetch('UPC'),
+            quantity: (Integer(row.fetch('Qty Avail')) rescue 0)
+          }
+        end
+      end
+
+      inventory
+    end
+
+  end
+end

data/lib/bill_hicks/order.rb

@@ -0,0 +1,120 @@
+module BillHicks
+  # To submit an order:
+  #
+  # * Instantiate a new Order, passing in `:username` and `:password`
+  # * Call {#add_header}
+  # * Call {#add_item} for each item on the order
+  # * Call {#submit!} to send the order
+  #
+  # See each method for a list of required options.
+  class Order < Base
+
+    ORDER_UPLOAD_DIR = [FTP_DIR, 'toBHC'].join('/')
+
+    # @option options [String] :username *required*
+    # @option options [String] :password *required*
+    def initialize(options = {})
+      requires!(options, :username, :password)
+      @options = options
+      @items = []
+    end
+
+    # @param [Hash] header
+    #   * :customer [String] *required*
+    #   * :purchase_order [String] *required*
+    #   * :ffl [String] *required*
+    #   * :shipping [Hash] *required*
+    #     * :name [String] *required*
+    #     * :address_1 [String] *required*
+    #     * :address_2 [String] optional
+    #     * :city [String] *required*
+    #     * :state [String] *required*
+    #     * :zip [String] *required*
+    def add_header(header = {})
+      requires!(header, :customer, :purchase_order, :ffl, :shipping)
+      requires!(header[:shipping], :name, :address_1, :city, :state, :zip)
+      @header = header
+    end
+
+    # @option item [String] :item_number *required*
+    # @option item [Integer] :quantity *required*
+    # @option item [String] :price *required* - Decimal formatted price, without currency sign
+    # @option item [String] :description optional
+    def add_item(item = {})
+      requires!(item, :item_number, :quantity, :price)
+      @items << item
+    end
+
+    def submit!
+      raise BillHicks::InvalidOrder.new("Must call #add_header before submitting") if @header.nil?
+      raise BillHicks::InvalidOrder.new("Must add items with #add_item before submitting") if @items.empty?
+
+      @order_filename = "#{@header[:purchase_order]}-order.txt"
+      @order_file = Tempfile.new(@order_filename)
+      begin
+        CSV.open(@order_file.path, 'w+') do |csv|
+          csv << header_names
+          csv << header_fields
+          csv << items_header
+          @items.each do |item|
+            csv << item_fields(item)
+          end
+        end
+
+        upload!
+      ensure
+        # Close and delete (unlink) file.
+        @order_file.close
+        @order_file.unlink
+      end
+
+      # TODO: Find some way of returning a meaningful true/false. Currently, if there's a problem, an exception is raised.
+      true
+    end
+
+    private
+
+    def header_names
+      ['HL', 'Customer#', 'Ship to Name1', 'Address 1', 'Address 2', 'city', 'state', 'zip', 'cust po', 'ship method', 'notes', 'FFL#']
+    end
+
+    def header_fields
+      [
+        'H',
+        @header[:customer],
+        @header[:shipping][:name],
+        @header[:shipping][:address_1],
+        @header[:shipping][:address_2],
+        @header[:shipping][:city],
+        @header[:shipping][:state],
+        @header[:shipping][:zip],
+        @header[:purchase_order],
+        @header[:shipping_method],
+        @header[:notes],
+        @header[:ffl],
+      ]
+    end
+
+    def items_header
+      ['LL', 'Item', 'Description', 'Qty', 'Price']
+    end
+
+    def item_fields(item)
+      [
+        'L',
+        item[:item_number],
+        item[:description],
+        item[:quantity],
+        item[:price],
+      ]
+    end
+
+    def upload!
+      connect(@options) do |ftp|
+        ftp.chdir(ORDER_UPLOAD_DIR)
+        ftp.puttextfile(@order_file.path, @order_filename)
+      end
+    end
+
+  end
+end

data/lib/bill_hicks/version.rb

@@ -0,0 +1,3 @@
+module BillHicks
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: bill_hicks
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Dale Campbell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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:
+- oshuma@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bill_hicks.gemspec
+- bin/console
+- bin/setup
+- lib/bill_hicks.rb
+- lib/bill_hicks/base.rb
+- lib/bill_hicks/catalog.rb
+- lib/bill_hicks/category.rb
+- lib/bill_hicks/inventory.rb
+- lib/bill_hicks/order.rb
+- lib/bill_hicks/version.rb
+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 Bill Hicks ERP system
+test_files: []