lipseys 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0e6d7c35268c59574518eea37ec94caedf6b103
+  data.tar.gz: 4eb87e7dc445f74eca9c80366e92e9b88ef3abe7
+SHA512:
+  metadata.gz: 31b27cb8d50003c6e6035d5417d49e250c55e031349615e05ee9f2af22aadeb9c796b0af023484fed18839aeb45c0ec5b97a867739452e4ea8dbb9ddeb8a4465
+  data.tar.gz: e3866541d78ed597bcf6263be502f0e7d4c8eef6436e62fa7e63bbadeaa277c293bd20dd01832f6e7ad62b0560f808ed84d115ea48321debe6b4d09d687414a5

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 @@
+lipseys

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 lipseys.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,39 @@
+# Lipsey's
+
+Ruby library for Lipsey's API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lipseys'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lipseys
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/lipseys.
+
+
+## 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 "lipseys"
+
+# 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/lipseys.rb

@@ -0,0 +1,17 @@
+require 'lipseys/version'
+
+require 'net/http'
+require 'nokogiri'
+require 'savon'
+
+require 'lipseys/base'
+require 'lipseys/soap_client'
+
+require 'lipseys/catalog'
+require 'lipseys/inventory'
+require 'lipseys/invoice'
+require 'lipseys/order'
+
+module Lipseys
+  class NotAuthenticated < StandardError; end
+end

data/lib/lipseys/base.rb

@@ -0,0 +1,47 @@
+module Lipseys
+  class Base
+
+    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 content_for(xml_doc, field)
+      node = xml_doc.css(field).first
+      node.nil? ? nil : node.content.strip
+    end
+
+    def get_response_xml(api_url, params)
+      uri = URI(api_url)
+      uri.query = URI.encode_www_form(params)
+
+      response = Net::HTTP.get_response(uri)
+      xml_doc = Nokogiri::XML(response.body)
+
+      raise Lipseys::NotAuthenticated if not_authenticated?(xml_doc)
+
+      xml_doc
+    end
+
+    def not_authenticated?(xml_doc)
+      msg = content_for(xml_doc, 'CatalogError')
+      msg =~ /Login failed/i
+    end
+
+  end
+end

data/lib/lipseys/catalog.rb

@@ -0,0 +1,127 @@
+module Lipseys
+  class Catalog < Base
+
+    API_URL = 'https://www.lipseys.com/API/catalog.ashx'
+
+
+    def initialize(options = {})
+      requires!(options, :email, :password)
+      @email = options[:email]
+      @password = options[:password]
+    end
+
+
+    def self.all(options = {})
+      new(options).all
+    end
+
+    def all
+      get_items
+    end
+
+    def self.firearms(options = {})
+      new(options).firearms
+    end
+
+    def firearms
+      get_items('FIREARM')
+    end
+
+    def self.nfa(options = {})
+      new(options).nfa
+    end
+
+    def nfa
+      get_items('NFA')
+    end
+
+    def self.optics(options = {})
+      new(options).optics
+    end
+
+    def optics
+      get_items('OPTIC')
+    end
+
+    def self.accessories(options = {})
+      new(options).accessories
+    end
+
+    def accessories
+      get_items('ACCESSORY')
+    end
+
+    private
+
+    def get_items(item_type = nil)
+      params = { email: @email, pass: @password }
+      params[:itemtype] = item_type unless item_type.nil?
+
+      xml_doc = get_response_xml(API_URL, params)
+
+      items = []
+
+      xml_doc.css('LipseysCatalog/Item').each do |item|
+        items << {
+          item_number: content_for(item, 'ItemNo'),
+          description_1: content_for(item, 'Desc1'),
+          description_2: content_for(item, 'Desc2'),
+          upc: content_for(item, 'UPC'),
+          manufacturer_model_number: content_for(item, 'MFGModelNo'),
+          msrp: content_for(item, 'MSRP'),
+          model: content_for(item, 'Model'),
+          caliber: content_for(item, 'Caliber'),
+          manufacturer: content_for(item, 'MFG'),
+          type: content_for(item, 'Type'),
+          action: content_for(item, 'Action'),
+          barrel: content_for(item, 'Barrel'),
+          capacity: content_for(item, 'Capacity'),
+          finish: content_for(item, 'Finish'),
+          length: content_for(item, 'Length'),
+          receiver: content_for(item, 'Receiver'),
+          safety: content_for(item, 'Safety'),
+          sights: content_for(item, 'Sights'),
+          stock_frame_grips: content_for(item, 'StockFrameGrips'),
+          magazine: content_for(item, 'Magazine'),
+          weight: content_for(item, 'Weight'),
+          image: "http://www.lipseys.net/images/#{content_for(item, 'Image')}",
+          chamber: content_for(item, 'Chamber'),
+          drilled_tapped: (content_for(item, 'DrilledTapped') == 'Y'),
+          rate_of_twist: content_for(item, 'RateOfTwist'),
+          item_type: content_for(item, 'ItemType'),
+          feature_1: content_for(item, 'Feature1'),
+          feature_2: content_for(item, 'Feature2'),
+          feature_3: content_for(item, 'Feature3'),
+          shipping_weight: content_for(item, 'ShippingWeight'),
+          bound_book: {
+            model: content_for(item, 'BoundBookModel'),
+            type: content_for(item, 'BoundBookType'),
+            manufacturer: content_for(item, 'BoundBookMFG'),
+          },
+          nfa: {
+            thread_pattern: content_for(item, 'NFAThreadPattern'),
+            attach_method: content_for(item, 'NFAAttachMethod'),
+            baffle: content_for(item, 'NFABaffle'),
+            can_disassemble: (content_for(item, 'NFACanDisassemble') == 'Y'),
+            construction: content_for(item, 'NFAConstruction'),
+            db_reduction: content_for(item, 'NFAdbReduction'),
+            diameter: content_for(item, 'NFADiameter'),
+            form_3_caliber: content_for(item, 'NFAForm3Caliber'),
+          },
+          optic: {
+            magnification: content_for(item, 'Magnification'),
+            maintube: content_for(item, 'Maintube'),
+            objective: content_for(item, 'Objective'),
+            adjustable_objective: (content_for(item, 'AdjustableObjective') == 'Y'),
+            optic_adjustments: content_for(item, 'OpticAdjustments'),
+            reticle: content_for(item, 'Reticle'),
+            illuminated_reticle: (content_for(item, 'IlluminatedReticle') == 'Y'),
+          }
+        }
+      end
+
+      items
+    end
+
+  end
+end

data/lib/lipseys/inventory.rb

@@ -0,0 +1,81 @@
+module Lipseys
+  class Inventory < Base
+
+    API_URL = 'https://www.lipseys.com/API/pricequantitycatalog.ashx'
+
+
+    def initialize(options = {})
+      requires!(options, :email, :password)
+      @email = options[:email]
+      @password = options[:password]
+    end
+
+
+    def self.all(options = {})
+      new(options).all
+    end
+
+    def all
+      get_items
+    end
+
+    def self.firearms(options = {})
+      new(options).firearms
+    end
+
+    def firearms
+      get_items('FIREARM')
+    end
+
+    def self.nfa(options = {})
+      new(options).nfa
+    end
+
+    def nfa
+      get_items('NFA')
+    end
+
+    def self.optics(options = {})
+      new(options).optics
+    end
+
+    def optics
+      get_items('OPTIC')
+    end
+
+    def self.accessories(options = {})
+      new(options).accessories
+    end
+
+    def accessories
+      get_items('ACCESSORY')
+    end
+
+    private
+
+    def get_items(item_type = nil)
+      params = { email: @email, pass: @password }
+      params[:itemtype] = item_type unless item_type.nil?
+
+      xml_doc = get_response_xml(API_URL, params)
+
+      items = []
+
+      xml_doc.css('LipseysInventoryPricing/Item').each do |item|
+        items << {
+          item_number: content_for(item, 'ItemNo'),
+          upc: content_for(item, 'UPC'),
+          manufacturer_model_number: content_for(item, 'MFGModelNo'),
+          quantity_on_hand: content_for(item, 'QtyOnHand'),
+          allocation: (content_for(item, 'Allocation') == 'Y'),
+          price: content_for(item, 'Price'),
+          on_sale: (content_for(item, 'OnSale') == 'Y'),
+          retail_map: content_for(item, 'RetailMAP')
+        }
+      end
+
+      items
+    end
+
+  end
+end

data/lib/lipseys/invoice.rb

@@ -0,0 +1,56 @@
+module Lipseys
+  class Invoice < SoapClient
+
+    def initialize(options = {})
+      requires!(options, :email, :password)
+      @email = options[:email]
+      @password = options[:password]
+
+      @order_number = options[:order_number]
+      @purchase_order = options[:purchase_order]
+      raise ArgumentError.new("Either :order_number or :purchase_order is required") if @order_number.nil? && @purchase_order.nil?
+    end
+
+
+    def self.all(*args)
+      new(*args).all
+    end
+
+    def all
+      response = soap_client.call(:get_invoices, message: build_inquiry_data)
+
+      raise Lipseys::NotAuthenticated if not_authenticated?(response)
+
+      invoice_result = response.body[:get_invoices_response][:get_invoices_result]
+
+      {
+        invoices_found: Integer(invoice_result[:invoices_found]),
+        description: invoice_result[:return_desc],
+
+        invoices: invoice_result[:invoices]
+      }
+    rescue Savon::Error => e
+      { success: false, description: e.to_s }
+    end
+
+    private
+
+    def build_inquiry_data
+      inquiry_data = {
+        EmailAddress: @email,
+        Password: @password
+      }
+
+      inquiry_data[:OrderNo] = @order_number unless @order_number.nil?
+      inquiry_data[:PONumber] = @purchase_order unless @purchase_order.nil?
+
+      { InquiryData: inquiry_data }
+    end
+
+    def not_authenticated?(response)
+      invoice_result = response.body[:get_invoices_response][:get_invoices_result]
+      invoice_result[:return_desc] =~ /Credentials Not Valid/i
+    end
+
+  end
+end

data/lib/lipseys/order.rb

@@ -0,0 +1,64 @@
+module Lipseys
+  class Order < SoapClient
+
+    def initialize(options = {})
+      requires!(options, :email, :password, :quantity, :purchase_order)
+      @email = options[:email]
+      @password = options[:password]
+      @quantity = options[:quantity]
+
+      @notify_by_email = (options[:notify_by_email] == true ? 'Y' : nil)
+      @purchase_order = options[:purchase_order]
+      @note = options[:note]
+
+      @item_number_or_upc = options[:item_number] || options[:upc]
+      raise ArgumentError.new("Either :item_number or :upc must be given") if @item_number_or_upc.nil?
+    end
+
+
+    def self.submit(*args)
+      new(*args).submit
+    end
+
+    def submit
+      response = soap_client.call(:submit_order, message: build_order_data)
+
+      raise Lipseys::NotAuthenticated if not_authenticated?(response)
+
+      order_result = response.body[:submit_order_response][:submit_order_result]
+
+      {
+        order_number: order_result[:order_no],
+        new_order: (order_result[:new_order] == 'Y'),
+        success: (order_result[:success] == 'Y'),
+        description: order_result[:return_desc],
+        quantity_received: Integer(order_result[:qty_received]),
+      }
+    rescue Savon::Error => e
+      { success: false, description: e.to_s }
+    end
+
+    private
+
+    def build_order_data
+      order_data = {
+        EmailAddress: @email,
+        Password: @password,
+        LipseysItemNumberOrUPC: @item_number_or_upc,
+        Qty: @quantity
+      }
+
+      order_data[:NotifyByEmail] = @notify_by_email unless @notify_by_email.nil?
+      order_data[:PONumber] = @purchase_order unless @purchase_order.nil?
+      order_data[:Note] = @note unless @note.nil?
+
+      { OrderData: order_data }
+    end
+
+    def not_authenticated?(response)
+      order_result = response.body[:submit_order_response][:submit_order_result]
+      order_result[:success] == 'N' && order_result[:return_desc] =~ /Credentials Not Valid/i
+    end
+
+  end
+end

data/lib/lipseys/soap_client.rb

@@ -0,0 +1,13 @@
+module Lipseys
+  class SoapClient < Base
+
+    API_URL = 'http://www.lipseys.com/webservice/LipseyAPI.asmx?WSDL'
+
+    protected
+
+    def soap_client
+      @soap_client ||= Savon.client(wsdl: API_URL, convert_request_keys_to: :none)
+    end
+
+  end
+end

data/lib/lipseys/version.rb

@@ -0,0 +1,3 @@
+module Lipseys
+  VERSION = "0.1.0"
+end

data/lipseys.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lipseys/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lipseys"
+  spec.version       = Lipseys::VERSION
+  spec.authors       = ["Dale Campbell"]
+  spec.email         = ["oshuma@gmail.com"]
+
+  spec.summary       = %q{Ruby library for Lipsey's API.}
+  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_dependency "nokogiri", "~> 1.6"
+  spec.add_dependency "savon", "~> 2.11.1"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: lipseys
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dale Campbell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.1
+- !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
+- bin/console
+- bin/setup
+- lib/lipseys.rb
+- lib/lipseys/base.rb
+- lib/lipseys/catalog.rb
+- lib/lipseys/inventory.rb
+- lib/lipseys/invoice.rb
+- lib/lipseys/order.rb
+- lib/lipseys/soap_client.rb
+- lib/lipseys/version.rb
+- lipseys.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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby library for Lipsey's API.
+test_files: []