silencer_shop 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0fb38ed07576442bf645ab679d4b0faa38f2de8ed7fcee2bb06ec7f948f82058
+  data.tar.gz: 498e71ac8fb336bafd44c76b3e6efff98029675b210fe5e730398719becdbd1e
+SHA512:
+  metadata.gz: 457c9c8bf80466b5e470bed00b1208bb9f1adb974776ed78c624e44d201c6bb0f9bc219b312c8e019232df2b65fe5639133095b8471f361a19c12516f4c3c1cd
+  data.tar.gz: 22a8ea41b9da4ba5adb06f85eb4366fb5c18393e50e87a8582c714749a6ea6a4dec49bc45c1fbe033e9285af099401c6f782eaccd0d2a8914002b0623ef10043

data/.gitignore

@@ -0,0 +1 @@
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in silencer_shop.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 @@
+# Silencer Shop
+
+Ruby library for Silencer Shop API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'silencer_shop'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install silencer_shop
+
+## 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/silencer_shop.
+
+
+## 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 "silencer_shop"
+
+# 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/silencer_shop.rb

@@ -0,0 +1,39 @@
+require 'silencer_shop/base'
+require 'silencer_shop/version'
+
+require 'silencer_shop/api'
+require 'silencer_shop/catalog'
+require 'silencer_shop/client'
+require 'silencer_shop/dealer'
+require 'silencer_shop/error'
+require 'silencer_shop/inventory'
+require 'silencer_shop/order'
+require 'silencer_shop/product_feed'
+require 'silencer_shop/response'
+require 'silencer_shop/user'
+
+module SilencerShop
+
+  class << self
+    attr_accessor :config
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.configure
+    yield(config)
+  end
+
+  class Configuration
+    attr_accessor :proxy_address
+    attr_accessor :proxy_port
+
+    def initialize
+      @proxy_address ||= nil
+      @proxy_port    ||= nil
+    end
+  end
+
+end

data/lib/silencer_shop/api.rb

@@ -0,0 +1,123 @@
+require 'net/http'
+
+module SilencerShop
+  module API
+
+    ROOT_API_URL = 'https://silencershopportaldebug.azurewebsites.net/api'.freeze
+    USER_AGENT = "SilencerShopRubyGem/#{SilencerShop::VERSION}".freeze
+
+    FILE_UPLOAD_ATTRS = {
+      permitted: %i( file_name file_type file_contents ).freeze,
+      reqired:   %i( file_type file_contents ).freeze,
+    }
+
+    def get_request(endpoint, headers = {}, root_url = nil)
+      request = Net::HTTP::Get.new(request_url(endpoint, root_url))
+
+      submit_request(request, {}, headers)
+    end
+
+    def post_request(endpoint, data = {}, headers = {}, root_url = nil)
+      request = Net::HTTP::Post.new(request_url(endpoint, root_url))
+
+      submit_request(request, data, headers)
+    end
+
+    def post_file_request(endpoint, file_data, headers = {}, root_url = nil)
+      request = Net::HTTP::Post.new(request_url(endpoint, root_url))
+
+      submit_file_request(request, file_data, headers)
+    end
+
+    private
+
+    def submit_request(request, data, headers)
+      set_request_headers(request, headers)
+
+      request.body = data.is_a?(Hash) ? data.to_json : data
+
+      process_request(request)
+    end
+
+    def submit_file_request(request, file_data, headers)
+      boundary = ::SecureRandom.hex(15)
+
+      headers.merge!(content_type_header("multipart/form-data; boundary=#{boundary}"))
+
+      build_multipart_request_body(request, file_data, boundary)
+      set_request_headers(request, headers)
+      process_request(request)
+    end
+
+    def process_request(request)
+      uri = URI(request.path)
+
+      response = Net::HTTP.start(uri.host, uri.port, SilencerShop.config.proxy_address, SilencerShop.config.proxy_port, use_ssl: true) do |http|
+        http.request(request)
+      end
+
+      SilencerShop::Response.new(response)
+    end
+
+    def build_multipart_request_body(request, file_data, boundary)
+      file_type     = file_data[:file_type]
+      file_contents = file_data[:file_contents]
+      file_name     = file_data[:file_name] || "ffl-document.#{file_type}"
+      content_type  = "application/#{file_data[:file_type]}"
+
+      body = []
+      body << "--#{boundary}\r\n"
+      body << "Content-Disposition: form-data; name=\"file\"; filename=\"#{file_name}\"\r\n"
+      body << "Content-Type: #{content_type}\r\n"
+      body << "\r\n"
+      body << "#{file_contents}\r\n"
+      body << "--#{boundary}--\r\n"
+
+      request.body = body.join
+    end
+
+    def set_request_headers(request, headers)
+      request['User-Agent'] = USER_AGENT
+
+      headers.each { |header, value| request[header] = value }
+    end
+
+    def auth_header(token)
+      { 'Authorization' => "Bearer #{token}" }
+    end
+
+    def content_type_header(type)
+      { 'Content-Type' => type }
+    end
+
+    def request_url(endpoint, root_url = nil)
+      root_url ||= ROOT_API_URL
+
+      [root_url, endpoint].join('/')
+    end
+
+    def standardize_body_data(submitted_data, permitted_data_attrs)
+      _submitted_data = submitted_data.deep_transform_keys(&:to_sym)
+      permitted_data = {}
+
+      _submitted_data.each do |k1, v1|
+        if permitted_data_attrs.include?(k1)
+          if v1.is_a?(Array)
+            permitted_data[k1] = []
+
+            v1.each do |sub_data|
+              permitted_sub_data = {}
+              sub_data.each { |k2, v2| permitted_sub_data[k2] = v2 if permitted_data_attrs.include?(k2) }
+              permitted_data[k1] << permitted_sub_data
+            end
+          else
+            permitted_data[k1] = v1
+          end
+        end
+      end
+
+      permitted_data.deep_transform_keys { |k| k.to_s.camelize(:lower) }
+    end
+
+  end
+end

data/lib/silencer_shop/base.rb

@@ -0,0 +1,26 @@
+module SilencerShop
+  class Base
+
+    protected
+
+    def requires!(*args)
+      self.class.requires!(*args)
+    end
+
+    def self.requires!(hash, *params)
+      hash_keys = hash.collect { |k, v| v.is_a?(Array) ? [k, v.collect(&:keys)] : k }.flatten
+
+      params.each do |param|
+        if param.is_a?(Array)
+          raise ArgumentError.new("Missing required parameter: #{param.first}") unless hash_keys.include?(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_keys.include?(param)
+        end
+      end
+    end
+
+  end
+end

data/lib/silencer_shop/catalog.rb

@@ -0,0 +1,55 @@
+module SilencerShop
+  class Catalog < Base
+
+    def initialize(options = {})
+      requires!(options, :username, :password)
+
+      @client = SilencerShop::Client.new(username: options[:username], password: options[:password])
+    end
+
+    def self.all(options = {})
+      requires!(options, :username, :password)
+
+      new(options).all
+    end
+
+    def all
+      @client.product_feed.catalog.body.map { |item| map_hash(item) }
+    end
+
+    private
+
+    def map_hash(item)
+      {
+        name: item[:ShortDescription],
+        model: item[:Model],
+        upc: item[:UniversalProductCode],
+        item_identifier: item[:DealerPartNumber],
+        long_description: item[:LongDescription],
+        short_description: item[:ShortDescription],
+        category: item[:CategoryCode],
+        price: item[:Price],
+        map_price: item[:MARP],
+        msrp: item[:MSRP],
+        quantity: item[:Quantity],
+        weight: item[:Weight],
+        brand: item[:Make],
+        mfg_number: item[:ManufacturerPartNumber],
+        features: {
+          length: item[:Length],
+          width: item[:Width],
+          height: item[:Height],
+          other_info: item[:OtherInfo],
+          firearm_type: item[:FirearmType],
+          allow_backorder: item[:AllowBackorder],
+          restrictions_info: item[:RestrictionsInfo],
+          size_info: item[:SizeInfo],
+          is_restricted: item[:IsRestricted],
+          dropship_ok: item[:DropShipOk],
+          image_name: item[:LargeImagePath].split('/')[-1]
+        }
+      }
+    end
+
+  end
+end

data/lib/silencer_shop/client.rb

@@ -0,0 +1,57 @@
+require 'silencer_shop/api'
+require 'silencer_shop/dealer'
+require 'silencer_shop/order'
+require 'silencer_shop/product_feed'
+
+module SilencerShop
+  class Client < Base
+
+    include SilencerShop::API
+
+    attr_accessor :access_token
+
+    def initialize(options = {})
+      requires!(options, :username, :password)
+      @options = options
+
+      authenticate!
+    end
+
+    def product_feed
+      @product_feed ||= SilencerShop::ProductFeed.new(self)
+    end
+
+    def order
+      @order ||= SilencerShop::Order.new(self)
+    end
+
+    def dealer
+      @dealer ||= SilencerShop::Dealer.new(self)
+    end
+
+    private
+
+    def authenticate!
+      request_data = [
+        ['resource', CGI.escape('https://silencershopstaging.onmicrosoft.com/SilencerShop.Portal')],
+        ['grant_type', 'client_credentials'],
+        ['client_id', CGI.escape(@options[:username])],
+        ['client_secret', CGI.escape(@options[:password])]
+      ].map { |a| a.join('=') }.join('&')
+
+      response = post_request(
+        'silencershopstaging.onmicrosoft.com/oauth2/token',
+        request_data,
+        content_type_header('application/x-www-form-urlencoded'),
+        'https://login.microsoftonline.com'
+      )
+
+      if response[:access_token].present?
+        self.access_token = response[:access_token]
+      else
+        raise SilencerShop::Error::NotAuthorized.new(response.body)
+      end
+    end
+
+  end
+end

data/lib/silencer_shop/dealer.rb

@@ -0,0 +1,25 @@
+require 'silencer_shop/api'
+
+module SilencerShop
+  class Dealer < Base
+
+    include SilencerShop::API
+
+    ENDPOINTS = {
+      confirmed: "dealer/login".freeze
+    }
+
+    def initialize(client)
+      @client = client
+    end
+
+    def confirmed?(dealer_username: '', dealer_password: '')
+      post_request(
+        ENDPOINTS[:confirmed],
+        { username: dealer_username, password: dealer_password },
+        auth_header(@client.access_token)
+      ).success?
+    end
+
+  end
+end

data/lib/silencer_shop/error.rb

@@ -0,0 +1,11 @@
+module SilencerShop
+  class Error < StandardError
+
+    class NoContent < SilencerShop::Error; end
+    class NotAuthorized < SilencerShop::Error; end
+    class NotFound < SilencerShop::Error; end
+    class RequestError < SilencerShop::Error; end
+    class TimeoutError < SilencerShop::Error; end
+
+  end
+end

data/lib/silencer_shop/inventory.rb

@@ -0,0 +1,32 @@
+module SilencerShop
+  class Inventory < Base
+
+    def initialize(options = {})
+      requires!(options, :username, :password)
+
+      @client = SilencerShop::Client.new(username: options[:username], password: options[:password])
+    end
+
+    def self.all(options = {})
+      requires!(options, :username, :password)
+
+      new(options).all
+    end
+    class << self; alias_method :quantity, :all; end
+
+    def all
+      @client.product_feed.availability.body.map { |item| map_hash(item) }
+    end
+
+    private
+
+    def map_hash(item)
+      {
+        item_identifier: item[:DealerPartNumber],
+        quantity: item[:Quantity],
+        price: item[:Price],
+      }
+    end
+
+  end
+end

data/lib/silencer_shop/order.rb

@@ -0,0 +1,58 @@
+require 'silencer_shop/api'
+
+module SilencerShop
+  class Order < Base
+
+    include SilencerShop::API
+
+    SUBMIT_ATTRS = {
+      permitted: %i(
+        purchase_order account_number other_information notes customer_email customer_phone
+        customer_name company_name address_line_1 address_line_2 ffl_information city state
+        zip shipping_method sales_tax_collected line_items dealer_part_number quantity price
+        universal_product_code description
+      ).freeze,
+      required: %i(
+        purchase_order ffl_information customer_email customer_phone customer_name
+        address_line_1 city state zip line_items dealer_part_number quantity
+      ).freeze
+    }
+
+    ENDPOINTS = {
+      submit:  "commerce/order".freeze,
+      fetch:   "commerce/order/%s?emailAddress=%s".freeze,
+      invoice: "commerce/order/pdf/%s?emailAddress=%s".freeze
+    }
+
+    def initialize(client)
+      @client = client
+    end
+
+    def submit(order_data)
+      requires!(order_data, *SUBMIT_ATTRS[:required])
+
+      endpoint = ENDPOINTS[:submit]
+      headers = [
+        *auth_header(@client.access_token),
+        *content_type_header('application/json'),
+      ].to_h
+
+      order_data = standardize_body_data(order_data, SUBMIT_ATTRS[:permitted])
+
+      post_request(endpoint, order_data, headers)
+    end
+
+    def fetch(order_id, customer_email)
+      endpoint = ENDPOINTS[:fetch] % [order_id, customer_email]
+
+      get_request(endpoint, auth_header(@client.access_token))
+    end
+
+    def invoice(order_id, customer_email)
+      endpoint = ENDPOINTS[:invoice] % [order_id, customer_email]
+
+      get_request(endpoint, auth_header(@client.access_token))
+    end
+
+  end
+end

data/lib/silencer_shop/product_feed.rb

@@ -0,0 +1,26 @@
+require 'silencer_shop/api'
+
+module SilencerShop
+  class ProductFeed < Base
+
+    include SilencerShop::API
+
+    ENDPOINTS = {
+      catalog:      "productfeed/catalog".freeze,
+      availability: "productfeed/availability".freeze
+    }
+
+    def initialize(client)
+      @client = client
+    end
+
+    def catalog
+      get_request(ENDPOINTS[:catalog], auth_header(@client.access_token))
+    end
+
+    def availability
+      get_request(ENDPOINTS[:availability], auth_header(@client.access_token))
+    end
+
+  end
+end

data/lib/silencer_shop/response.rb

@@ -0,0 +1,45 @@
+module SilencerShop
+  class Response
+
+    def initialize(response)
+      @response = response
+
+      case @response
+      when Net::HTTPUnauthorized
+        SilencerShop::Error::NotAuthorized.new(@response.body)
+      when Net::HTTPNotFound
+        SilencerShop::Error::NotFound.new(@response.body)
+      when Net::HTTPNoContent
+        SilencerShop::Error::NoContent.new(@response.body)
+      when Net::HTTPOK, Net::HTTPSuccess
+        _data = (JSON.parse(@response.body) if @response.body.present?)
+
+        @data = case
+        when _data.is_a?(Hash)
+          _data.deep_symbolize_keys
+        when _data.is_a?(Array)
+          _data.map(&:deep_symbolize_keys)
+        end
+      else
+        raise SilencerShop::Error::RequestError.new(@response.body)
+      end
+    end
+
+    def [](key)
+      @data&.[](key)
+    end
+
+    def body
+      @data
+    end
+
+    def fetch(key)
+      @data.fetch(key)
+    end
+
+    def success?
+      !!self[:success] && self[:errors].empty?
+    end
+
+  end
+end

data/lib/silencer_shop/user.rb

@@ -0,0 +1,15 @@
+module SilencerShop
+  class User < Base
+
+    def initialize(options = {})
+      requires!(options, :username, :password)
+
+      @client = SilencerShop::Client.new(username: options[:username], password: options[:password])
+    end
+
+    def authenticated?
+      @client.access_token.present?
+    end
+
+  end
+end

data/lib/silencer_shop/version.rb

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

data/silencer_shop.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'silencer_shop/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "silencer_shop"
+  spec.version       = SilencerShop::VERSION
+  spec.authors       = ["Jeffrey Dill"]
+  spec.email         = ["jeffdill2@gmail.com"]
+
+  spec.summary       = %q{Ruby library for Silencer Shop 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_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.0"
+  spec.add_development_dependency "webmock", "~> 2.3"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: silencer_shop
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jeffrey Dill
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-05-26 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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: ''
+email:
+- jeffdill2@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/silencer_shop.rb
+- lib/silencer_shop/api.rb
+- lib/silencer_shop/base.rb
+- lib/silencer_shop/catalog.rb
+- lib/silencer_shop/client.rb
+- lib/silencer_shop/dealer.rb
+- lib/silencer_shop/error.rb
+- lib/silencer_shop/inventory.rb
+- lib/silencer_shop/order.rb
+- lib/silencer_shop/product_feed.rb
+- lib/silencer_shop/response.rb
+- lib/silencer_shop/user.rb
+- lib/silencer_shop/version.rb
+- silencer_shop.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: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Ruby library for Silencer Shop API.
+test_files: []