rsr_group 0.1.6 → 1.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da0117d9236b24b6cc871f4076d6ef25ec407150
-  data.tar.gz: 67a6400b5a745cd85996619c79df541d80fcc5d8
+  metadata.gz: 7c9bf20350d6ad63a809ab9b1ec14ed29dec0acb
+  data.tar.gz: 0cdadb5c40579b6abe6d28fa55e68dd486f9e27d
 SHA512:
-  metadata.gz: 25e0da72c0ffd17fec273a2a7dce18853e04787d4906a22abde1b97addf7b999e56a29f8e2ce76ce3cd0c06282b8b66274ae235ff42e1365bda8fc2dd6724006
-  data.tar.gz: 747385a866206a1aa8e7ca927b6c4d14e5529fee074d186d3ea840310be804e2567d5f876ab7b2215f58512be107f7d14371ca4d3807b79c9974e6bc5d68fab2
+  metadata.gz: d608e462128d6ab5e7dcef36f317c5b028e21ce9d47329c5b5b4eacff091a363028fa66b2b1afc505fb7faa7fabc83689848c6de0120d0061aaaa242d92e5d87
+  data.tar.gz: 1ecd0f05f172f4a071df7e5c74c16e4367ad2cc9e269f67011cdf3bbb853e7f5d7a2f369d68b87370665d470f4c7f5b1f9d0b2f3f2db07a686e024e620c0807c

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+samples/*
+script/*

data/config.rb.example

@@ -0,0 +1,5 @@
+RsrGroup.configure do |config|
+  config.ftp_host       = "ftp.example.com"
+  config.submission_dir = File.join("htdocs", "eo", "incoming")
+  config.vendor_email   = "admin@example.com"
+end

data/lib/rsr_group.rb

@@ -7,9 +7,37 @@ require 'net/ftp'
 require 'rsr_group/base'
 require 'rsr_group/department'
 require 'rsr_group/inventory'
+require 'rsr_group/order'
+require 'rsr_group/order_detail'
+require 'rsr_group/order_ffl'
+require 'rsr_group/order_recipient'
 require 'rsr_group/user'
 
 module RsrGroup
   class NotAuthenticated < StandardError; end
   class UnknownDepartment < 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 :submission_dir
+    attr_accessor :vendor_email
+
+    def initialize
+      @ftp_host       ||= "ftp.rsrgroup.com"
+      @submission_dir ||= File.join("eo", "incoming")
+      @vendor_email   ||= nil
+    end
+  end
 end

data/lib/rsr_group/base.rb

@@ -1,13 +1,22 @@
 module RsrGroup
   class Base
 
-    FTP_HOST = 'ftp.rsrgroup.com'
+    SHIPPING_CARRIERS = %w(UPS USPS)
+
+    SHIPPING_METHODS = {
+      "Grnd" => "Ground",
+      "1Day" => "Next Day Air",
+      "2Day" => "2nd Day Air",
+      "3Day" => "3 Day Select", 
+      "NDam" => "Next Day Early AM",
+      "NDAS" => "Next Day Air Saver",
+      "PRIO" => "Priority"
+    }
 
     protected
 
-    # Wrapper to `self.requires!` that can be used as an instance method.
-    def requires!(*args)
-      self.class.requires!(*args)
+    def self.ftp_host
+      RsrGroup.config.ftp_host
     end
 
     def self.requires!(hash, *params)
@@ -23,16 +32,22 @@ module RsrGroup
       end
     end
 
+    def ftp_host
+      self.class.ftp_host
+    end
+
+    # Wrapper to `self.requires!` that can be used as an instance method.
+    def requires!(*args)
+      self.class.requires!(*args)
+    end
+
     def connect(options = {})
       requires!(options, :username, :password)
 
-      Net::FTP.open(FTP_HOST, options[:username], options[:password]) do |ftp|
+      Net::FTP.open(ftp_host, options[:username], options[:password]) do |ftp|
         ftp.passive = true
         yield ftp
       end
-    # TODO: Disable this rescue for now, so we can figure out what's happening when used in an actual app.
-    # rescue Net::FTPPermError
-    #   raise RsrGroup::NotAuthenticated
     end
 
   end

data/lib/rsr_group/order.rb

@@ -0,0 +1,84 @@
+module RsrGroup
+  class Order < Base
+
+    attr_reader :credentials
+    attr_reader :identifier
+    attr_reader :timestamp
+    attr_reader :sequence_number
+    attr_accessor :recipients
+
+    LINE_TYPES = {
+      "00" => "file_header",
+      "10" => "order_header",
+      "11" => "ffl_dealer",
+      "20" => "order_detail",
+      "90" => "order_trailer",
+      "99" => "file_trailer"
+    }
+
+    def initialize(options = {})
+      requires!(options, :sequence_number, :username, :password, :identifier)
+
+      @credentials     = options.select { |k, v| [:username, :password].include?(k) }
+      @identifier      = options[:identifier]
+      @sequence_number = "%04d" % options[:sequence_number] # Leading zeros are required
+      @timestamp       = Time.now.strftime("%Y%m%e")
+      @recipients      = options[:recipients] || []
+    end
+
+    def header
+      ["FILEHEADER", LINE_TYPES.key("file_header"), customer_number, @timestamp, @sequence_number].join(";")
+    end
+
+    def footer
+      ["FILETRAILER", LINE_TYPES.key("file_trailer"), ("%05d" % recipients.length)].join(";")
+    end
+
+    def filename
+      name = ["EORD", customer_number, timestamp, sequence_number].join("-")
+      [name, ".txt"].join
+    end
+
+    def recipients
+      @recipients ||= []
+    end
+
+    def to_txt
+      txt = header + "\n"
+      recipients.each do |recipient|
+        txt += (recipient.to_single_line + "\n")
+        if recipient.ffl
+          txt += (recipient.ffl.to_single_line + "\n")
+        end
+        recipient.items.each do |item|
+          txt += (item.to_single_line + "\n")
+        end
+        txt += recipient.trailer + "\n"
+      end
+      txt += footer
+    end
+
+    def submit!
+      connect(@credentials) do |ftp|
+        ftp.chdir(RsrGroup.config.submission_dir)
+        io = StringIO.new(to_txt)
+        begin
+          ftp.storlines("STOR " + filename, io)
+        ensure
+          io.close
+        end
+      end
+    end
+
+    private
+
+    def customer_number
+      credentials[:username]
+    end
+
+    def items
+      recipients.map(&:items).flatten.compact
+    end
+
+  end
+end

data/lib/rsr_group/order_detail.rb

@@ -0,0 +1,29 @@
+module RsrGroup
+  class OrderDetail < Base
+
+    attr_reader :order_identifier
+    attr_reader :quantity
+
+    def initialize(options = {})
+      requires!(options, :order_identifier, :rsr_stock_number, :quantity, :shipping_carrier, :shipping_method)
+
+      @order_identifier = options[:order_identifier]
+      @rsr_stock_number = options[:rsr_stock_number]
+      @quantity         = (options[:quantity].is_a?(Integer) ? ("%05d" % options[:quantity]) : options[:quantity])
+      @shipping_carrier = options[:shipping_carrier]
+      @shipping_method  = options[:shipping_method]
+    end
+
+    def to_single_line
+      [
+        order_identifier,
+        Order::LINE_TYPES.key("order_detail"),
+        @rsr_stock_number,
+        @quantity,
+        @shipping_carrier, 
+        @shipping_method
+      ].join(";")
+    end
+
+  end
+end

data/lib/rsr_group/order_ffl.rb

@@ -0,0 +1,24 @@
+module RsrGroup
+  class OrderFFL < Base
+
+    attr_reader :order_identifier
+
+    def initialize(options = {})
+      requires!(options, :order_identifier, :licence_number, :name, :zip)
+
+      @options = options
+      @order_identifier = options[:order_identifier]
+    end
+
+    def to_single_line
+      [
+        order_identifier,
+        Order::LINE_TYPES.key("ffl_dealer"),
+        @options[:licence_number],
+        @options[:name],
+        @options[:zip],
+      ].join(";")
+    end
+
+  end
+end

data/lib/rsr_group/order_recipient.rb

@@ -0,0 +1,55 @@
+module RsrGroup
+  class OrderRecipient < Base
+
+    attr_reader :order_identifier
+    attr_accessor :ffl
+    attr_accessor :items
+
+    def initialize(options = {})
+      requires!(options, :order_identifier, :shipping_name, :address_one, :city, :state, :zip)
+
+      @ffl = options[:ffl]
+      @items = options[:items] || []
+      @options = options
+      @order_identifier = options[:order_identifier]
+    end
+
+    def items
+      @items ||= []
+    end
+
+    def to_single_line
+      [
+        order_identifier,
+        Order::LINE_TYPES.key("order_header"),
+        @options[:shipping_name],
+        @options[:attn],
+        @options[:address_one],
+        @options[:address_two],
+        @options[:city],
+        @options[:state],
+        @options[:zip],
+        @options[:phone],
+        (@options[:email].nil? ? "N" : "Y"),
+        @options[:email],
+        RsrGroup.config.vendor_email,
+        nil
+      ].join(";")
+    end
+
+    def trailer
+      [
+        order_identifier,
+        Order::LINE_TYPES.key("order_trailer"),
+        ("%07d" % quantity_sum)
+      ].join(";")
+    end
+
+    private
+
+    def quantity_sum
+      items.map(&:quantity).map(&:to_i).inject(:+)
+    end
+
+  end
+end

data/lib/rsr_group/version.rb

@@ -1,3 +1,3 @@
 module RsrGroup
-  VERSION = "0.1.6"
+  VERSION = "1.0.0.pre"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsr_group
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 1.0.0.pre
 platform: ruby
 authors:
 - Dale Campbell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-15 00:00:00.000000000 Z
+date: 2016-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,10 +84,15 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- config.rb.example
 - lib/rsr_group.rb
 - lib/rsr_group/base.rb
 - lib/rsr_group/department.rb
 - lib/rsr_group/inventory.rb
+- lib/rsr_group/order.rb
+- lib/rsr_group/order_detail.rb
+- lib/rsr_group/order_ffl.rb
+- lib/rsr_group/order_recipient.rb
 - lib/rsr_group/user.rb
 - lib/rsr_group/version.rb
 - rsr_group.gemspec
@@ -106,9 +111,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.7