sports_south 3.0.2 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d132005031036050cb4e55d76aa4455d519fd69
-  data.tar.gz: 946d58824e49f0e1cce45a0dacc8353130bc91b4
+  metadata.gz: f72a7e530a665693c47a5b7da6ae000d965c44bd
+  data.tar.gz: d2f7c4c346b909c0bff5c9b0d5e5a6e6ee017068
 SHA512:
-  metadata.gz: b009cb4927ed59d0ca25afd0e5a74b7ae475f4438161b7d7ade10aec49a6fa583690cb80a4cda0031f60d29c6c16ab90c6b980bd828ce6dd9ccd31f214e1db54
-  data.tar.gz: e7878d0042ed306f8fdc67b10cbcb8c2b6d1c9dc47f6eeb5473d9534aceca9a55e3d2bb0902b241bf1dfe28bfb35c11e9de05303975dfd400baab0940061b8cc
+  metadata.gz: 0427e7620531e3cba9c3301e78ad73bcabaf07411ed6ad56c9070d76f566b511f301e02d9e1bfab63b331d7d2298bf20b3c5691751cd39ef6ca1b3a6a6e4bb10
+  data.tar.gz: be0a98dd98e6459103c059e14fb66ba7d93fb526c64ee21d45b0e358450cebde233ae3cf003f84b56673a159c6a5372dae831c0df223379ca0e391711404b763

data/.circleci/config.yml

@@ -0,0 +1,41 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.4.1-node-browsers
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "sports_south.gemspec" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+            
+            bundle exec rspec --format documentation $TEST_FILES

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+2.3.7

data/lib/sports_south.rb

@@ -1,8 +1,10 @@
 require 'sports_south/version'
 
+require 'cgi'
 require 'json'
 require 'net/http'
 require 'nokogiri'
+require 'tempfile'
 
 require 'sports_south/base'
 require 'sports_south/brand'

data/lib/sports_south/base.rb

@@ -1,5 +1,3 @@
-require 'cgi'
-
 module SportsSouth
   # Holds methods common to all classes.
   class Base
@@ -50,10 +48,12 @@ module SportsSouth
     #   http, request = get_http_and_request(<api_url>, <endpoint>)
     def self.get_http_and_request(api_url, endpoint)
       uri = URI([api_url, endpoint].join)
+
       http = Net::HTTP.new(uri.host, uri.port)
       http.read_timeout = TIMEOUT
+
       request = Net::HTTP::Post.new(uri.request_uri)
-      request['User-Agent'] = USER_AGENT
+      request['User-Agent']   = USER_AGENT
       request['Content-Type'] = CONTENT_TYPE
 
       return http, request
@@ -72,5 +72,34 @@ module SportsSouth
     end
     def sanitize_response(*args); self.class.sanitize_response(*args); end
 
+    def download_to_tempfile(http, request)
+      preformatted_tempfile = Tempfile.new(['preformatted-', '.txt'])
+
+      # Stream the response to disk.
+      # This file is not yet valid XML (the angle brackets are escaped).
+      http.request(request) do |response|
+        File.open(preformatted_tempfile, 'w') do |file|
+          response.read_body do |chunk|
+            file.write(chunk.force_encoding('UTF-8'))
+          end
+        end
+      end
+      preformatted_tempfile.close
+
+      # Now we need to read the file line-by-line and unescape the angle brackets.
+      # The new (properly formatted) XML will be in a secondary tempfile.
+      converted_tempfile = Tempfile.new(['formated-', '.xml'])
+
+      File.open(preformatted_tempfile, 'r') do |file|
+        file.each_line do |line|
+          converted_tempfile.puts CGI.unescapeHTML(line)
+        end
+      end
+
+      # Return the (still opened) tempfile
+      # Since it's sill open you may need to '#rewind' it first before usage
+      return converted_tempfile
+    end
+
   end
 end

data/lib/sports_south/catalog.rb

@@ -2,6 +2,7 @@ module SportsSouth
   class Catalog < Base
 
     API_URL = 'http://webservices.theshootingwarehouse.com/smart/inventory.asmx'
+    ITEM_NODE_NAME = 'Table'
 
     CATALOG_CODES = {
       'S' => :special,
@@ -35,7 +36,7 @@ module SportsSouth
       @brands     = SportsSouth::Brand.all(options)
     end
 
-    def self.all(options = {}, &block)
+    def self.all(options = {})
       requires!(options, :username, :password)
 
       if options[:last_updated]
@@ -46,16 +47,10 @@ module SportsSouth
 
       options[:last_item] ||= '-1'
 
-      new(options).all &block
+      new(options).all
     end
 
-    def self.get_description(item_number, options = {})
-      requires!(options, :username, :password)
-
-      new(options, :username, :password)
-    end
-
-    def all(&block)
+    def all
       http, request = get_http_and_request(API_URL, '/DailyItemUpdate')
 
       request.set_form_data(form_params(@options).merge({
@@ -63,12 +58,32 @@ module SportsSouth
         LastItem:   @options[:last_item].to_s
       }))
 
-      response = http.request(request)
-      xml_doc  = Nokogiri::XML(sanitize_response(response))
+      items    = []
+      tempfile = download_to_tempfile(http, request)
 
-      xml_doc.css('Table').map do |item|
-        yield(map_hash(item, @options[:full_product]))
+      tempfile.rewind
+
+      Nokogiri::XML::Reader.from_io(tempfile).each do |reader|
+        next unless reader.node_type == Nokogiri::XML::Reader::TYPE_ELEMENT
+        next unless reader.name == ITEM_NODE_NAME
+
+        node = Nokogiri::XML.parse(reader.outer_xml)
+
+        _map_hash = map_hash(node.css(ITEM_NODE_NAME), @options[:full_product])
+
+        items << _map_hash unless _map_hash.nil?
       end
+
+      tempfile.close
+      tempfile.unlink
+
+      assign_brand_names(items)
+    end
+
+    def self.get_description(item_number, options = {})
+      requires!(options, :username, :password)
+
+      new(options, :username, :password)
     end
 
     def get_description(item_number)
@@ -87,41 +102,29 @@ module SportsSouth
     protected
 
     def map_hash(node, full_product = false)
-      category = @categories.find { |category| category[:category_id] == content_for(node, 'CATID') }
-      brand    = @brands.find { |brand| brand[:brand_id] == content_for(node, 'ITBRDNO') }
-      features = self.map_features(category.except(:category_id, :department_id, :department_description, :description), node)
-
-      model      = content_for(node, 'IMODEL')
-      series     = content_for(node, 'SERIES')
-      mfg_number = content_for(node, 'MFGINO')
-
-      if features[:caliber]
-        caliber = features[:caliber]
-      elsif features[:gauge]
-        caliber = features[:gauge]
-      end
-
-      if features[:action]
-        action = features[:action]
-      end
-
-      if full_product
-        long_description = self.get_description(content_for(node, 'ITEMNO'))
-      end
+      category        = @categories.find { |category| category[:category_id] == content_for(node, 'CATID') }
+      features        = self.map_features(category.except(:category_id, :department_id, :department_description, :description), node)
+      model           = content_for(node, 'IMODEL')
+      series          = content_for(node, 'SERIES')
+      mfg_number      = content_for(node, 'MFGINO')
+      caliber         = features[:caliber].presence || features[:gauge].presence
+      action          = features[:action].presence
+      unit_of_measure = UNITS_OF_MEASURE.fetch(content_for(node, 'UOM'), nil)
 
       if features.respond_to?(:[]=)
         features[:series] = series
+        features[:unit_of_measure] = unit_of_measure
       end
 
       {
-        name:              "#{model} #{series} #{mfg_number}".gsub(/\s+/, ' ').rstrip,
+        name:              "#{model} #{series} #{mfg_number}".gsub(/\s+/, ' ').strip,
         model:             model,
         upc:               content_for(node, 'ITUPC').rjust(12, "0"),
         item_identifier:   content_for(node, 'ITEMNO'),
         quantity:          content_for(node, 'QTYOH').to_i,
         price:             content_for(node, 'CPRC'),
         short_description: content_for(node, 'SHDESC'),
-        long_description:  long_description,
+        long_description:  (full_product ? get_description(content_for(node, 'ITEMNO')) : nil),
         category:          category[:description],
         product_type:      ITEM_TYPES[content_for(node, 'ITYPE')],
         mfg_number:        mfg_number,
@@ -129,23 +132,23 @@ module SportsSouth
         caliber:           caliber,
         action:            action,
         map_price:         content_for(node, 'MFPRC'),
-        brand:             brand.present? ? brand[:name] : nil,
+        brand:             content_for(node, 'ITBRDNO').presence,
         features:          features,
-        unit_of_measure:   UNITS_OF_MEASURE.fetch(content_for(node, 'UOM'), nil)
+        unit_of_measure:   unit_of_measure,
       }
     end
 
     def map_features(attributes, node)
       features = {
-        attributes[:attribute_1] => content_for(node, 'ITATR1'),
-        attributes[:attribute_2] => content_for(node, 'ITATR2'),
-        attributes[:attribute_3] => content_for(node, 'ITATR3'),
-        attributes[:attribute_4] => content_for(node, 'ITATR4'),
-        attributes[:attribute_5] => content_for(node, 'ITATR5'),
-        attributes[:attribute_6] => content_for(node, 'ITATR6'),
-        attributes[:attribute_7] => content_for(node, 'ITATR7'),
-        attributes[:attribute_8] => content_for(node, 'ITATR8'),
-        attributes[:attribute_9] => content_for(node, 'ITATR9'),
+        attributes[:attribute_1]  => content_for(node, 'ITATR1'),
+        attributes[:attribute_2]  => content_for(node, 'ITATR2'),
+        attributes[:attribute_3]  => content_for(node, 'ITATR3'),
+        attributes[:attribute_4]  => content_for(node, 'ITATR4'),
+        attributes[:attribute_5]  => content_for(node, 'ITATR5'),
+        attributes[:attribute_6]  => content_for(node, 'ITATR6'),
+        attributes[:attribute_7]  => content_for(node, 'ITATR7'),
+        attributes[:attribute_8]  => content_for(node, 'ITATR8'),
+        attributes[:attribute_9]  => content_for(node, 'ITATR9'),
         attributes[:attribute_10] => content_for(node, 'ITATR10'),
         attributes[:attribute_11] => content_for(node, 'ITATR11'),
         attributes[:attribute_12] => content_for(node, 'ITATR12'),
@@ -164,5 +167,22 @@ module SportsSouth
       features.symbolize_keys!
     end
 
+    def assign_brand_names(items)
+      brand_ids = items.collect { |item| item[:brand] }.uniq.compact
+
+      brand_ids.each do |brand_id|
+        brand_name = @brands.find { |brand| brand[:brand_id] == brand_id }.try(:[], :name)
+
+        next if brand_name.nil?
+
+        items.map! do |item|
+          item[:brand] = brand_name if item[:brand] == brand_id
+          item
+        end
+      end
+
+      items
+    end
+
   end
 end

data/lib/sports_south/inventory.rb

@@ -2,6 +2,7 @@ module SportsSouth
   class Inventory < Base
 
     API_URL = 'http://webservices.theshootingwarehouse.com/smart/inventory.asmx'
+    ITEM_NODE_NAME = 'Onhand'
 
     def initialize(options = {})
       requires!(options, :username, :password)
@@ -18,7 +19,7 @@ module SportsSouth
       new(options).get_quantity_file
     end
 
-    def self.all(options = {}, &block)
+    def self.all(options = {})
       requires!(options, :username, :password)
 
       if options[:last_updated].present?
@@ -29,7 +30,7 @@ module SportsSouth
 
       options[:last_item] ||= '-1'
 
-      new(options).all(&block)
+      new(options).all
     end
 
     def self.get(item_identifier, options = {})
@@ -37,7 +38,7 @@ module SportsSouth
       new(options).get(item_identifier)
     end
 
-    def all(&block)
+    def all
       http, request = get_http_and_request(API_URL, '/IncrementalOnhandUpdate')
 
       request.set_form_data(form_params = form_params(@options).merge({
@@ -45,12 +46,26 @@ module SportsSouth
         LastItem:      @options[:last_item].to_s
       }))
 
-      response = http.request(request)
-      xml_doc  = Nokogiri::XML(sanitize_response(response))
+      items    = []
+      tempfile = download_to_tempfile(http, request)
 
-      xml_doc.css('Onhand').map do |item|
-        yield(self.map_hash(item))
+      tempfile.rewind
+
+      Nokogiri::XML::Reader.from_io(tempfile).each do |reader|
+        next unless reader.node_type == Nokogiri::XML::Reader::TYPE_ELEMENT
+        next unless reader.name == ITEM_NODE_NAME
+
+        node = Nokogiri::XML.parse(reader.outer_xml)
+
+        _map_hash = map_hash(node.css(ITEM_NODE_NAME))
+
+        items << _map_hash unless _map_hash.nil?
       end
+
+      tempfile.close
+      tempfile.unlink
+
+      items
     end
 
     def get_quantity_file
@@ -73,7 +88,7 @@ module SportsSouth
       tempfile.path
     end
 
-    def self.quantity(options = {}, &block)
+    def self.quantity(options = {})
       requires!(options, :username, :password)
 
       if options[:last_updated].present?
@@ -84,7 +99,7 @@ module SportsSouth
 
       options[:last_item] ||= '-1'
 
-      new(options).all(&block)
+      new(options).all
     end
 
     def get(item_identifier)

data/lib/sports_south/version.rb

@@ -1,3 +1,3 @@
 module SportsSouth
-  VERSION = '3.0.2'.freeze
+  VERSION = '5.0.1'.freeze
 end

data/sports_south.gemspec

@@ -4,8 +4,6 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'sports_south/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = '~> 2.0'
-
   spec.name          = "sports_south"
   spec.version       = SportsSouth::VERSION
   spec.authors       = ["Dale Campbell"]
@@ -22,10 +20,10 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "nokogiri", "~> 1.6"
 
-  spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "activesupport", "~> 5"
+  spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "net-http-spy", "~> 0.2"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.3"
   spec.add_development_dependency "webmock", "~> 1.20"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sports_south
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 5.0.1
 platform: ruby
 authors:
 - Dale Campbell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-17 00:00:00.000000000 Z
+date: 2020-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -25,33 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '5'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: net-http-spy
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +70,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -115,11 +115,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-gemset"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -150,9 +150,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -160,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: Sports South API Ruby library.

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.0
-before_install: gem install bundler -v 1.10.6