sportsmans-supply 1.0.0.pre.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 14cb932f540318ae3a4406f2b310c298c63c092f62be52dd31a5296ddbc058b2
+  data.tar.gz: f89621f47f5018f2c1b16e0ff0a50fd276c5afebc5f548bc03c67ee9d7bedf07
+SHA512:
+  metadata.gz: fadcebdc50392fdd0686eec56b50d7a969f74d0aa32bd0a43a07ca50e07db932bee172c1d83aa344bf5822596108e55ad51259a28e97d90223b7656ecb668999
+  data.tar.gz: bbb4bd2ce0a8ec806a4354004cb219ab7a3563830aaac170537e9575b3e0ffbd33f0a797af3dec06b32fce4397e6b14c4ea9ef48fabf7110c8a1226001bb7a8f

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Jeffrey Dill
+
+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,34 @@
+# Sportsman's Supply
+
+Ruby library for Sportsman's Supply ERP system.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sportsmans-supply'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sportsmans-supply
+
+## 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/sportsmans-supply.
+
+
+## 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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sportsmans-supply"
+
+# 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,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/sportsmans-supply/base.rb

@@ -0,0 +1,48 @@
+module SportsmansSupply
+  class Base
+
+    def self.connect(options = {})
+      requires!(options, :username, :password)
+
+      Net::FTP.open(SportsmansSupply.config.ftp_host, options[:username], options[:password]) do |ftp|
+        yield(ftp)
+      end
+    end
+
+    protected
+
+    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)
+      self.class.connect(options) do |ftp|
+        begin
+          yield(ftp)
+        end
+      end
+    end
+
+    def get_file(filename, file_directory = nil)
+      connect(@options) do |ftp|
+        tempfile = Tempfile.new
+        ftp.getbinaryfile(File.join(file_directory, filename), tempfile.path)
+        tempfile
+      end
+    end
+
+  end
+end

data/lib/sportsmans-supply/catalog.rb

@@ -0,0 +1,82 @@
+module SportsmansSupply
+  class Catalog < Base
+
+    def initialize(options = {})
+      requires!(options, :username, :password)
+      @options = options
+    end
+
+    def self.all(options = {})
+      requires!(options, :username, :password)
+      new(options).all
+    end
+
+    def all
+      catalog_file = get_file(SportsmansSupply.config.catalog_filename, 'products')
+      inventory_file = get_file(SportsmansSupply.config.inventory_filename, 'pricing-availability')
+
+      inventory_data = {}
+      catalog_data = []
+
+      File.open(inventory_file).each_with_index do |row, i|
+        row = row.split(",").map(&:strip)
+
+        if i == 0
+          @headers = row.map(&:downcase)
+          next
+        end
+
+        inventory_data[row[@headers.index('sku')]] = {
+          price: row[@headers.index('rapid retail price')],
+          quantity: row[@headers.index('qty')].to_i
+        }
+      end
+
+      File.open(catalog_file).each_with_index do |row, i|
+        row = row.split("|").map(&:strip)
+
+        if i == 0
+          @headers = row.map(&:downcase)
+          next
+        end
+
+        description = row[@headers.index('description')]
+        sku = row[@headers.index('sku')]
+        inventory_datum = inventory_data[sku]
+
+        next if inventory_datum.nil?
+
+        catalog_data << {
+          mfg_number:        row[@headers.index('mpn')],
+          upc:               row[@headers.index('upc code')],
+          name:              description,
+          quantity:          inventory_datum[:quantity],
+          price:             inventory_datum[:price],
+          map_price:         row[@headers.index('map')],
+          msrp:              row[@headers.index('msrp')],
+          brand:             row[@headers.index('manufacturer')],
+          item_identifier:   sku,
+          category:          row[@headers.index('category')],
+          subcategory:       row[@headers.index('subcategory')],
+          short_description: description,
+          long_description:  row[@headers.index('detailed description')],
+          weight:            [row[@headers.index('weight')], row[@headers.index('weight units')]].join,
+          features:          {
+            dimension_length: row[@headers.index('dimensionl')],
+            dimension_width:  row[@headers.index('dimensionw')],
+            dimension_height: row[@headers.index('dimensionh')],
+            shipping_length:  row[@headers.index('shipping length')],
+            shipping_width:   row[@headers.index('shipping width')],
+            shipping_height:  row[@headers.index('shipping height')],
+            image_name:       row[@headers.index('image url')],
+          }
+        }
+      end
+
+      [catalog_file, inventory_file].each { |f| f.close; f.unlink }
+
+      catalog_data
+    end
+
+  end
+end

data/lib/sportsmans-supply/inventory.rb

@@ -0,0 +1,41 @@
+module SportsmansSupply
+  class Inventory < Base
+
+    def initialize(options = {})
+      requires!(options, :username, :password)
+      @options = options
+    end
+
+    def self.all(options = {})
+      requires!(options, :username, :password)
+      new(options).all
+    end
+    class << self; alias_method :quantity, :all; end
+
+    def all
+      inventory_file = get_file(SportsmansSupply.config.inventory_filename, 'pricing-availability')
+      inventory_data = []
+
+      File.open(inventory_file).each_with_index do |row, i|
+        row = row.split(",").map(&:strip)
+
+        if i == 0
+          @headers = row.map(&:downcase)
+          next
+        end
+
+        inventory_data << {
+          item_identifier: row[@headers.index('sku')],
+          quantity:        row[@headers.index('qty')].to_i,
+          price:           row[@headers.index('rapid retail price')].strip,
+        }
+      end
+
+      inventory_file.close
+      inventory_file.unlink
+
+      inventory_data
+    end
+
+  end
+end

data/lib/sportsmans-supply/invoice.rb

@@ -0,0 +1,41 @@
+module SportsmansSupply
+  class Invoice < Base
+
+    def initialize(options = {})
+      requires!(options, :username, :password)
+      @options = options
+    end
+
+    def self.all(options = {})
+      requires!(options, :username, :password)
+      new(options).all
+    end
+
+    def all
+      invoice_filename = connect(@options) { |ftp| ftp.nlst('/invoices/invoices*.csv').last }.split('/').last
+      invoice_file = get_file(invoice_filename, 'invoices')
+
+      invoice_data = []
+
+      File.open(invoice_file).each_with_index do |row, i|
+        row = row.split(",").map(&:strip)
+
+        if i == 0
+          @headers = row.map(&:downcase)
+          next
+        end
+
+        invoice_data << {
+          po_number:      row[@headers.index('order number')],
+          invoice_number: row[@headers.index('invoice number')]
+        }
+      end
+
+      invoice_file.close
+      invoice_file.unlink
+
+      invoice_data
+    end
+
+  end
+end

data/lib/sportsmans-supply/order.rb

@@ -0,0 +1,69 @@
+module SportsmansSupply
+  class Order < Base
+
+    HEADERS = [
+      'cust #', 'order id', 'status', 'order received date', 'ship method code', 'ship to name', 'ship to line 1',
+      'ship to line 2', 'ship to city', 'ship to state', 'ship to zip', 'ship to country', 'ship to phone', 'cost',
+      'sku/upc', 'quantity ordered'
+    ]
+
+    def initialize(options = {})
+      requires!(options, :username, :password)
+
+      @options = options
+      @items = []
+    end
+
+    def add_item(item = {})
+      requires!(item, :item_number, :quantity)
+
+      @items << item
+    end
+
+    def submit(options = {})
+      raise SportsmansSupply::InvalidOrder.new("Must add items with #add_item before submitting") if @items.empty?
+
+      requires!(options, :customer_number, :po_number, :shipping)
+      requires!(options[:shipping], :name, :address_1, :city, :state, :zip)
+
+      filename = [options[:customer_number], Time.now.strftime("%m%d%y%H%M%S"), options[:po_number]].join('_') + '.csv'
+      order_file = Tempfile.new(filename)
+
+      CSV.open(order_file.path, 'w+', col_sep: ",") do |csv|
+        csv << HEADERS
+
+        @items.each do |item|
+          item_data = [
+            options[:customer_number],
+            options[:po_number],
+            'NEW',
+            Time.now.strftime("%-m/%d/%Y"),
+            options[:shipping][:method_code] || 'Best Way',
+            options[:shipping][:name],
+            options[:shipping][:address_1],
+            options[:shipping][:address_2],
+            options[:shipping][:city],
+            options[:shipping][:state],
+            options[:shipping][:zip],
+            options[:shipping][:country] || 'USA',
+            options[:shipping][:phone],
+            '',
+            item[:item_number],
+            item[:quantity]
+          ]
+
+          csv << item_data
+        end
+      end
+
+      connect(@options) do |ftp|
+        ftp.chdir('orders')
+        ftp.puttextfile(order_file.path, filename)
+      end
+
+      order_file.close
+      order_file.unlink
+    end
+
+  end
+end

data/lib/sportsmans-supply/shipping.rb

@@ -0,0 +1,42 @@
+module SportsmansSupply
+  class Shipping < Base
+
+    def initialize(options = {})
+      requires!(options, :username, :password)
+      @options = options
+    end
+
+    def self.all(options = {})
+      requires!(options, :username, :password)
+      new(options).all
+    end
+
+    def all
+      tracking_filename = connect(@options) { |ftp| ftp.nlst('/shipping/tracking*.csv').last }.split('/').last
+      tracking_file = get_file(tracking_filename, 'shipping')
+
+      tracking_data = []
+
+      File.open(tracking_file).each_with_index do |row, i|
+        row = row.split(",").map(&:strip)
+
+        if i == 0
+          @headers = row.map(&:downcase)
+          next
+        end
+
+        tracking_data << {
+          po_number:       row[@headers.index('customer po#')],
+          tracking_number: row[@headers.index('tracking numbers')],
+          carrier:         row[@headers.index('actual shipping carrier')]
+        }
+      end
+
+      tracking_file.close
+      tracking_file.unlink
+
+      tracking_data
+    end
+
+  end
+end

data/lib/sportsmans-supply/user.rb

@@ -0,0 +1,22 @@
+module SportsmansSupply
+  class User < Base
+
+    def initialize(options = {})
+      requires!(options, :username, :password)
+      @options = options
+    end
+
+    def self.authenticated?(options = {})
+      requires!(options, :username, :password)
+      new(options).authenticated?
+    end
+
+    def authenticated?
+      connect(@options) { |ftp| ftp.pwd }
+      true
+    rescue SportsmansSupply::NotAuthenticated, Net::FTPPermError
+      false
+    end
+
+  end
+end

data/lib/sportsmans-supply/version.rb

@@ -0,0 +1,3 @@
+module SportsmansSupply
+  VERSION = '1.0.0-pre'.freeze
+end

data/lib/sportsmans-supply.rb

@@ -0,0 +1,43 @@
+require 'sportsmans-supply/version'
+
+require 'csv'
+require 'net/ftp'
+require 'tempfile'
+
+require 'sportsmans-supply/base'
+require 'sportsmans-supply/catalog'
+require 'sportsmans-supply/inventory'
+require 'sportsmans-supply/invoice'
+require 'sportsmans-supply/order'
+require 'sportsmans-supply/shipping'
+require 'sportsmans-supply/user'
+
+module SportsmansSupply
+  class InvalidOrder < StandardError; end
+  class NotAuthenticated < StandardError; end
+  class FileOrDirectoryNotFound < 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 :catalog_filename
+    attr_accessor :inventory_filename
+
+    def initialize
+      @ftp_host ||= 'www.rapidretail.net'
+      @catalog_filename ||= 'rr_products.csv'
+      @inventory_filename ||= 'rr_pricing_availability.csv'
+    end
+  end
+end

data/sportsmans-supply.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sportsmans-supply/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sportsmans-supply"
+  spec.version       = SportsmansSupply::VERSION
+  spec.authors       = ["Jeffrey Dill"]
+  spec.email         = ["jeffdill2@gmail.com"]
+
+  spec.summary       = %q{Ruby library for Sportsman's Supply 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 "activesupport", "~> 5"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rspec", "~> 3.5"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: sportsmans-supply
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.pre
+platform: ruby
+authors:
+- Jeffrey Dill
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: ''
+email:
+- jeffdill2@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sportsmans-supply.rb
+- lib/sportsmans-supply/base.rb
+- lib/sportsmans-supply/catalog.rb
+- lib/sportsmans-supply/inventory.rb
+- lib/sportsmans-supply/invoice.rb
+- lib/sportsmans-supply/order.rb
+- lib/sportsmans-supply/shipping.rb
+- lib/sportsmans-supply/user.rb
+- lib/sportsmans-supply/version.rb
+- sportsmans-supply.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: 1.3.1
+requirements: []
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: Ruby library for Sportsman's Supply ERP system
+test_files: []