rsr_group 1.0.0.pre → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c9bf20350d6ad63a809ab9b1ec14ed29dec0acb
-  data.tar.gz: 0cdadb5c40579b6abe6d28fa55e68dd486f9e27d
+  metadata.gz: 30aec6e206ed332500ce1beac071246a0ae65ebc
+  data.tar.gz: ff5b079c4316ed16e702dc950bed30f2be80f23e
 SHA512:
-  metadata.gz: d608e462128d6ab5e7dcef36f317c5b028e21ce9d47329c5b5b4eacff091a363028fa66b2b1afc505fb7faa7fabc83689848c6de0120d0061aaaa242d92e5d87
-  data.tar.gz: 1ecd0f05f172f4a071df7e5c74c16e4367ad2cc9e269f67011cdf3bbb853e7f5d7a2f369d68b87370665d470f4c7f5b1f9d0b2f3f2db07a686e024e620c0807c
+  metadata.gz: f4957378cc596059428bcb1d4f53f14565471cbab324b58418c49e1b460256ecce39555c118d33aefe9dcecc8cc0f4cee44ecfaef79a912f97b7fb34ecba161b
+  data.tar.gz: 103f0c0119ef13e4a22a6feadb55533fc9925467c194d646483850732e16bcab6ae5abba216a67e878295caa03cbded6a4c2e8ecbe7cb3689ddb553353e83473

data/lib/rsr_group.rb

@@ -5,12 +5,15 @@ require 'date'
 require 'net/ftp'
 
 require 'rsr_group/base'
+require 'rsr_group/constants'
+require 'rsr_group/data_row'
 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/response_file'
 require 'rsr_group/user'
 
 module RsrGroup
@@ -32,11 +35,13 @@ module RsrGroup
   class Configuration
     attr_accessor :ftp_host
     attr_accessor :submission_dir
+    attr_accessor :response_dir
     attr_accessor :vendor_email
 
     def initialize
       @ftp_host       ||= "ftp.rsrgroup.com"
       @submission_dir ||= File.join("eo", "incoming")
+      @response_dir   ||= File.join("eo", "outgoing")
       @vendor_email   ||= nil
     end
   end

data/lib/rsr_group/base.rb

@@ -1,24 +1,17 @@
 module RsrGroup
   class Base
 
-    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
+    def self.connect(options = {})
+      requires!(options, :username, :password)
 
-    def self.ftp_host
-      RsrGroup.config.ftp_host
+      Net::FTP.open(RsrGroup.config.ftp_host, options[:username], options[:password]) do |ftp|
+        ftp.passive = true
+        yield ftp
+      end
     end
 
+    protected
+
     def self.requires!(hash, *params)
       params.each do |param|
         if param.is_a?(Array)
@@ -32,20 +25,14 @@ 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|
-        ftp.passive = true
+    # Instance methods become class methods through inheritance
+    def connect(options)
+      self.class.connect(options) do |ftp|
         yield ftp
       end
     end

data/lib/rsr_group/constants.rb

@@ -0,0 +1,89 @@
+module RsrGroup
+
+  FILE_TYPES = {
+    "EERR"  => "Error",
+    "ECONF" => "Confirmation",
+    "ESHIP" => "Shipping",
+  }
+
+  LINE_TYPES = {
+    "00" => :file_header,
+    "10" => :order_header,
+    "11" => :ffl_dealer,
+    "20" => :order_detail,
+    "30" => :confirmation_header,
+    "40" => :confirmation_detail,
+    "50" => :confirmation_trailer,
+    "60" => :shipping_header,
+    "70" => :shipping_detail,
+    "80" => :shipping_trailer,
+    "90" => :order_trailer,
+    "99" => :file_trailer,
+  }
+
+  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"
+  }
+
+  ERROR_CODES = {
+    "00001" => "File Header record missing",
+    "00002" => "Invalid date",
+    "00003" => "Duplicate file",
+    "00004" => "Invalid Etailer number",
+    "00005" => "Empty file",
+    "00006" => "Invalid Sequence number",
+    "10001" => "Order Header record missing",
+    "10002" => "Invalid ship‐to name",
+    "10003" => "Missing ship‐to address",
+    "10004" => "Invalid ship‐to city",
+    "10005" => "Invalid ship‐to state",
+    "10006" => "Invalid ship‐to zip",
+    "10007" => "Invalid phone",
+    "10008" => "Invalid email option",
+    "10009" => "Invalid email address",
+    "10010" => "Duplicate order",
+    "10011" => "No orders found ",
+    "10012" => "Invalid ship‐to address ",
+    "10013" => "Invalid ship‐to county ",
+    "10014" => "Order Cancelled",
+    "10099" => "No quantity available",
+    "10999" => "Miscellaneous",
+    "11000" => "FFL Dealer record missing",
+    "11001" => "Account is not setup for firearm shipments",
+    "11002" => "Dealer FFL not found",
+    "11003" => "Dealer zip code mismatch",
+    "11004" => "Dealer name mismatch",
+    "11005" => "Dealer state mismatch",
+    "11006" => "Dealer FFL expired",
+    "11007" => "Firearms combined with accessories",
+    "11008" => "Dealer deactivated",
+    "11999" => "Miscellaneous",
+    "20001" => "Order Detail record missing",
+    "20002" => "Invalid RSR stock number",
+    "20003" => "Invalid quantity ordered",
+    "20004" => "Invalid shipping carrier",
+    "20005" => "Invalid shipping method",
+    "20006" => "Duplicate item in order",
+    "20007" => "Item out of stock",
+    "20008" => "Item prohibited",
+    "20009" => "Phone number required",
+    "20010" => "RSR allocated",
+    "20011" => "Case quantity required",
+    "20999" => "Miscellaneous",
+    "30001" => "OrderTrailerrecordmissing",
+    "30002" => "Invalid total order amount",
+    "30003" => "Mismatch on number of items ordered and number specified on order trailer record",
+    "99001" => "File Trailer record missing",
+    "99002" => "Invalid quantity ordered",
+    "99003" => "Mismatch on number of orders found and total quantity specified on file trailer record",
+  }
+
+end

data/lib/rsr_group/data_row.rb

@@ -0,0 +1,78 @@
+module RsrGroup
+  class DataRow < Base
+  
+    attr_reader :committed, :date_shipped, :error_code, :handling_fee,
+      :identifier, :licence_number, :line_type, :message, :name, 
+      :ordered, :quantity, :stock_id, :ship_to_name, :shipped, 
+      :shipping_carrier, :shipping_cost, :shipping_method, 
+      :rsr_order_number, :tracking_number, :zip
+
+    def initialize(line, has_errors: false)
+      points = line.split(";").map { |point| point.chomp }
+
+      @identifier = points[0]
+      @line_type  = LINE_TYPES[points[1]]
+
+      case @line_type
+      when :order_header
+        get_errors(points[-1]) if has_errors && points[-1] != "00000"
+        @ship_to_name = points[2]
+        @zip = points[8]
+      when :ffl_dealer # 11
+        get_errors(points[-1]) if has_errors && points[-1] != "00000"
+        @licence_number = points[2]
+        @name = points[3]
+        @zip  = points[4]
+      when :order_detail # 20
+        get_errors(points[-1]) if has_errors && points[-1] != "00000"
+        @quantity   = points[3].to_i
+        @stock_id   = points[2]
+        @shipping_carrier = points[4]
+        @shipping_method  = SHIPPING_METHODS[points[5]]
+      when :confirmation_header # 30
+        @rsr_order_number = points[2]
+      when :confirmation_detail # 40
+        @committed = points[4].to_i
+        @ordered   = points[3].to_i
+        @stock_id  = points[2]
+      when :confirmation_trailer # 50
+        @committed = points[3].to_i
+        @ordered   = points[2].to_i
+      when :shipping_header # 60
+        @date_shipped     = Time.parse(points[5])
+        @handling_fee     = points[7].to_i.to_s
+        @rsr_order_number = points[4]
+        @ship_to_name     = points[2]
+        @shipping_carrier = points[8]
+        @shipping_cost    = points[6].to_i.to_s
+        @shipping_method  = points[9]
+        @tracking_number  = points[3]
+      when :shipping_detail # 70
+        @ordered  = points[3].to_i
+        @shipped  = points[4].to_i
+        @stock_id = points[2]
+      when :shipping_trailer # 80
+        @ordered = points[2].to_i
+        @shipped = points[3].to_i
+      when :order_trailer # 90
+        @quantity = points[2].to_i
+      end
+    end
+
+    def to_h
+      @to_h ||= Hash[
+        instance_variables.map do |name|
+          [name.to_s.gsub("@", "").to_sym, instance_variable_get(name)]
+        end
+      ]
+    end
+
+    private
+
+    def get_errors(code)
+      @error_code = code
+      @message = ERROR_CODES[code]
+    end
+
+  end
+end

data/lib/rsr_group/order.rb

@@ -1,60 +1,76 @@
 module RsrGroup
+  # To submit an order:
+  #
+  # * Instantiate a new Order, passing in `:merchant_number`, `:username`, `:password`, `:sequence_number`, and `:identifier`
+  # * Call {#add_recipient}
+  # * Call {#add_item} for each item on the order
+  # * Call {#submit!} to send the order
   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"
-    }
-
+    # @param [Hash] options
+    # @option options [String]  :merchant_number *required*
+    # @option options [Integer] :sequence_number *required*
+    # @option options [String]  :username        *required*
+    # @option options [String]  :password        *required*
+    # @option options [String]  :identifier      *required*
     def initialize(options = {})
-      requires!(options, :sequence_number, :username, :password, :identifier)
+      requires!(options, :merchant_number, :sequence_number, :username, :password, :identifier)
 
       @credentials     = options.select { |k, v| [:username, :password].include?(k) }
       @identifier      = options[:identifier]
+      @merchant_number = options[:merchant_number]
       @sequence_number = "%04d" % options[:sequence_number] # Leading zeros are required
-      @timestamp       = Time.now.strftime("%Y%m%e")
-      @recipients      = options[:recipients] || []
+      @timestamp       = Time.now.strftime("%Y%m%d")
+      @items           = []
     end
 
-    def header
-      ["FILEHEADER", LINE_TYPES.key("file_header"), customer_number, @timestamp, @sequence_number].join(";")
+    # @param [Hash] shipping_info
+    # @option shipping_info [String] :shipping_name *required*
+    # @option shipping_info [String] :attn
+    # @option shipping_info [String] :address_one   *required*
+    # @option shipping_info [String] :address_two
+    # @option shipping_info [String] :city          *required*
+    # @option shipping_info [String] :state         *required*
+    # @option shipping_info [String] :zip           *required*
+    # @option shipping_info [String] :phone
+    # @option shipping_info [String] :email
+    #
+    # @param [Hash] ffl_options optional
+    # @option ffl_options [String] :licence_number *required*
+    # @option ffl_options [String] :name           *required*
+    # @option ffl_options [String] :zip            *required*
+    def add_recipient(shipping_info, ffl_options = {})
+      @recipient = OrderRecipient.new(shipping_info.merge(order_identifier: @identifier))
+      @ffl = OrderFFL.new(ffl_options.merge(order_identifier: @identifier)) if ffl_options.any?
     end
 
-    def footer
-      ["FILETRAILER", LINE_TYPES.key("file_trailer"), ("%05d" % recipients.length)].join(";")
+    # @param [Hash] item
+    # @option item [String]  :rsr_stock_number *required*
+    # @option item [Integer] :quantity         *required*
+    # @option item [String]  :shipping_carrier *required*
+    # @option item [String]  :shipping_method  *required*
+    def add_item(item)
+      @items << OrderDetail.new(item.merge(order_identifier: @identifier))
     end
 
     def filename
-      name = ["EORD", customer_number, timestamp, sequence_number].join("-")
+      name = ["EORD", @merchant_number, @timestamp, @sequence_number].join("-")
       [name, ".txt"].join
     end
 
-    def recipients
-      @recipients ||= []
-    end
-
     def to_txt
+      raise "Recipient is required!" unless @recipient
+      raise "Items are required!" unless @items.length > 0
+
       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"
+      txt += @recipient.to_single_line + "\n"
+      if @ffl
+        txt += (@ffl.to_single_line + "\n")
       end
+      @items.each do |item|
+        txt += (item.to_single_line + "\n")
+      end
+      txt += order_trailer + "\n"
       txt += footer
     end
 
@@ -68,16 +84,23 @@ module RsrGroup
           io.close
         end
       end
+      true
     end
 
     private
 
-    def customer_number
-      credentials[:username]
+    def header
+      ["FILEHEADER", LINE_TYPES.key(:file_header), @merchant_number, @timestamp, @sequence_number].join(";")
+    end
+
+    def footer
+      # NOTE: The 'Number of Orders in File' datum is hard-coded to 1
+      # For our purposes, only 1 recipient can ever be allowed in an RSR order
+      ["FILETRAILER", LINE_TYPES.key(:file_trailer), '00001'].join(";")
     end
 
-    def items
-      recipients.map(&:items).flatten.compact
+    def order_trailer
+      [@identifier, LINE_TYPES.key(:order_trailer), ("%07d" % @items.length)].join(";")
     end
 
   end

data/lib/rsr_group/order_detail.rb

@@ -17,7 +17,7 @@ module RsrGroup
     def to_single_line
       [
         order_identifier,
-        Order::LINE_TYPES.key("order_detail"),
+        LINE_TYPES.key(:order_detail),
         @rsr_stock_number,
         @quantity,
         @shipping_carrier, 

data/lib/rsr_group/order_ffl.rb

@@ -13,7 +13,7 @@ module RsrGroup
     def to_single_line
       [
         order_identifier,
-        Order::LINE_TYPES.key("ffl_dealer"),
+        LINE_TYPES.key(:ffl_dealer),
         @options[:licence_number],
         @options[:name],
         @options[:zip],

data/lib/rsr_group/order_recipient.rb

@@ -1,27 +1,17 @@
 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"),
+        @order_identifier,
+        LINE_TYPES.key(:order_header),
         @options[:shipping_name],
         @options[:attn],
         @options[:address_one],
@@ -29,27 +19,13 @@ module RsrGroup
         @options[:city],
         @options[:state],
         @options[:zip],
-        @options[:phone],
-        (@options[:email].nil? ? "N" : "Y"),
+        (@options[:phone].nil? ? '' : @options[:phone].gsub(/\D/, '')),
+        (@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/response_file.rb

@@ -0,0 +1,89 @@
+module RsrGroup
+  class ResponseFile < Base
+
+    attr_reader :filename
+
+    def initialize(options = {})
+      requires!(options, :username, :password, :filename)
+
+      @credentials = options.select { |k, v| [:username, :password].include?(k) }
+      @filename    = options[:filename]
+    end
+
+    FILE_TYPES.each do |key, value|
+      define_method("#{value.downcase}?".to_sym) do
+        response_type == value
+      end
+    end
+
+    def self.all(options = {})
+      requires!(options, :username, :password)
+
+      Base.connect(options) do |ftp|
+        ftp.chdir(RsrGroup.config.response_dir)
+        ftp.nlst("*.txt")
+      end
+    end
+
+    def content
+      return @content if @content
+      connect(@credentials) do |ftp|
+        ftp.chdir(RsrGroup.config.response_dir)
+        @content = ftp.gettextfile(@filename, nil)
+      end
+    end
+    alias get_content content
+
+    def response_type
+      FILE_TYPES[@filename.split("-").first]
+    end
+
+    def to_json
+      get_content
+
+      @json = {
+        response_type: response_type,
+        identifier: @content.lines[1].split(";")[0]
+      }
+
+      return parse_eerr  if error?
+      return parse_econf if confirmation?
+      return parse_eship if shipping?
+    end
+
+    private
+
+    def parse_eerr
+      errors = @content.lines[1..-2].map do |line|
+        DataRow.new(line, has_errors: true).to_h
+      end.compact
+
+      errors.select! { |e| !e[:error_code].nil? }
+
+      @json.merge!(errors: errors)
+    end
+
+    def parse_econf
+      details = @content.lines[2..-3].map do |line|
+        DataRow.new(line).to_h
+      end.compact
+
+      @json.merge!({
+        rsr_order_number: @content.lines[1].split(";")[2].chomp,
+        details: details
+      })
+    end
+
+    def parse_eship
+      details = @content.lines[1..-3].map do |line|
+        DataRow.new(line).to_h
+      end.compact
+
+      @json.merge!({
+        rsr_order_number: @content.lines[0].split(";")[3].chomp,
+        details: details
+      })
+    end
+
+  end
+end

data/lib/rsr_group/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsr_group
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre
+  version: 1.0.0
 platform: ruby
 authors:
 - Dale Campbell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-17 00:00:00.000000000 Z
+date: 2017-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,12 +87,15 @@ files:
 - config.rb.example
 - lib/rsr_group.rb
 - lib/rsr_group/base.rb
+- lib/rsr_group/constants.rb
+- lib/rsr_group/data_row.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/response_file.rb
 - lib/rsr_group/user.rb
 - lib/rsr_group/version.rb
 - rsr_group.gemspec
@@ -111,9 +114,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.7