fastbound-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf0dfc7f844190045d5c4014a46a84d5fa898d614e10ad15b919110a997221e5
+  data.tar.gz: 1f875a1df0916ef269723b58ed3e7bcb3d3bb4a7f4cafa57850d625d637b9b12
+SHA512:
+  metadata.gz: c003c356e3681e451a0e26b26d0a0b3326ad831c25227632dda3f7c22c29a60b9f828c2463982be6174560bcce69748ca472718ccc6a8587e6cf9d390f7c643a
+  data.tar.gz: 6863e30394b7bf0f5289c1309ade62f25be1accd51f427472173dc319cde3dbeadbca43d01253867e64f0f94f6acf8b9ffc70c866c4b61d68d82e7763f60be47

data/.gitignore

@@ -0,0 +1,67 @@
+*.rbc
+capybara-*.html
+.rspec
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/db/*.sqlite3-[0-9]*
+/public/system
+/coverage/
+/spec/tmp
+*.orig
+rerun.txt
+pickle-email-*.html
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# TODO Comment out this rule if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+config/master.key
+
+# Only include if you have production secrets in this file, which is no longer a Rails default
+# config/secrets.yml
+
+# dotenv
+# TODO Comment out this rule if environment variables can be committed
+.env
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalize the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv
+
+# Ignore Byebug command history file.
+.byebug_history
+
+# Ignore node_modules
+node_modules/
+
+# Ignore precompiled javascript packs
+/public/packs
+/public/packs-test
+/public/assets
+
+# Ignore yarn files
+/yarn-error.log
+yarn-debug.log*
+.yarn-integrity
+
+# Ignore uploaded files in development
+/storage/*
+!/storage/.keep

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fastbound-ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    fastbound-ruby (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coderay (1.1.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    hashdiff (1.0.1)
+    method_source (0.8.2)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    public_suffix (4.0.6)
+    rake (13.0.6)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    slop (3.6.0)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    yard (0.9.26)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  fastbound-ruby!
+  pry (~> 0.10.4)
+  rake (>= 12.3.3)
+  rspec (~> 3.1)
+  webmock (~> 1.20)
+  yard (~> 0.9.12)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+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,33 @@
+# FastBound
+
+FastBound API Ruby library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fastbound-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fastbound-ruby
+
+## Usage
+
+### Documentation
+
+The full documentation is located here: http://www.rubydoc.info/gems/fastbound-ruby
+
+## Contributing
+
+1. Fork it ( https://github.com/ammoready/fastbound-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fastbound-ruby"
+
+# 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.
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+bundle install

data/fastbound-ruby.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fastbound-ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fastbound-ruby"
+  spec.version       = FastBound::VERSION
+  spec.authors       = ["Jeffrey Dill"]
+  spec.email         = ["jeffdill2@gmail.com"]
+  spec.summary       = %q{FastBound API Ruby library.}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/ammoready/fastbound-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "pry", "~> 0.10.4"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "yard", "~> 0.9.12"
+end

data/lib/fastbound-ruby/account.rb

@@ -0,0 +1,23 @@
+require 'fastbound-ruby/api'
+
+module FastBound
+  class Account < Base
+
+    include FastBound::API
+
+    ENDPOINTS = {
+      fetch: "account".freeze,
+    }
+
+    def initialize(client)
+      @client = client
+    end
+
+    def fetch
+      endpoint = ENDPOINTS[:fetch]
+
+      get_request(@client, endpoint)
+    end
+
+  end
+end

data/lib/fastbound-ruby/acquisition.rb

@@ -0,0 +1,134 @@
+require 'fastbound-ruby/api'
+
+module FastBound
+  class Acquisition < Base
+
+    include FastBound::API
+
+    CREATE_AND_EDIT_ATTRS = {
+      permitted: %i(
+        external_id is_manufacturing_acquisition purchase_order_number
+        date type note invoice_number shipment_tracking_number
+      ).freeze,
+      required: %i( type ).freeze
+    }
+
+    ENDPOINTS = {
+      list:                 "acquisitions".freeze,
+      create:               "acquisitions".freeze,
+      edit:                 "acquisitions/%s".freeze,
+      fetch:                "acquisitions/%s".freeze,
+      fetch_by_external_id: "acquisitions/getbyexternalid/%s".freeze,
+      delete:               "acquisitions/%s".freeze,
+      commit:               "acquisitions/%s/commit".freeze,
+      create_and_commit:    "acquisitions/createandcommit".freeze,
+      create_item:          "acquisitions/%s/items".freeze,
+      edit_item:            "acquisitions/%s/items/%s".freeze,
+      fetch_item:           "acquisitions/%s/items/%s".freeze,
+      delete_item:          "acquisitions/%s/items/%s".freeze,
+      attach_contact:       "acquisitions/%s/attachcontact/%s".freeze
+    }
+
+    def initialize(client)
+      @client = client
+    end
+
+    def list(params = {})
+      endpoint = ENDPOINTS[:list] % convert_params_to_request_query(params)
+
+      get_request(@client, endpoint)
+    end
+
+    def create(acquisition_data)
+      requires!(acquisition_data, CREATE_AND_EDIT_ATTRS[:required])
+
+      endpoint = ENDPOINTS[:create]
+      acquisition_data = standardize_body_data(acquisition_data, CREATE_AND_EDIT_ATTRS[:permitted])
+
+      post_request(@client, endpoint, acquisition_data)
+    end
+
+    def edit(acquisition_id, acquisition_data)
+      endpoint = ENDPOINTS[:edit] % acquisition_id
+      acquisition_data = standardize_body_data(acquisition_data, CREATE_AND_EDIT_ATTRS[:permitted])
+
+      put_request(@client, endpoint, acquisition_data)
+    end
+
+    def fetch(acquisition_id)
+      endpoint = ENDPOINTS[:fetch] % acquisition_id
+
+      get_request(@client, endpoint)
+    end
+
+    def fetch_by_external_id(external_id)
+      endpoint = ENDPOINTS[:fetch_by_external_id] % external_id
+
+      get_request(@client, endpoint)
+    end
+
+    def delete(acquisition_id)
+      endpoint = ENDPOINTS[:delete] % acquisition_id
+
+      delete_request(@client, endpoint)
+    end
+
+    def commit(acquisition_id)
+      endpoint = ENDPOINTS[:commit] % acquisition_id
+
+      post_request(@client, endpoint)
+    end
+
+    def create_and_commit(acquisition_data, item_data, contact_data)
+      requires!(acquisition_data, CREATE_AND_EDIT_ATTRS[:required])
+      requires!(item_data, Item::CREATE_AND_EDIT_ATTRS[:required])
+      requires!(contact_data, Contact::CREATE_AND_EDIT_ATTRS[:required])
+
+      endpoint = ENDPOINTS[:create_and_commit]
+      acquisition_data = standardize_body_data(acquisition_data, CREATE_AND_EDIT_ATTRS[:permitted])
+      item_data = standardize_body_data(item_data, Item::CREATE_AND_EDIT_ATTRS[:permitted])
+      contact_data = standardize_body_data(contact_data, Contact::CREATE_AND_EDIT_ATTRS[:permitted])
+      request_data = acquisition_data.merge(
+        contact: contact_data,
+        items: [item_data]
+      )
+
+      post_request(@client, endpoint, request_data)
+    end
+
+    def create_item(acquisition_id, item_data)
+      requires!(item_data, Item::CREATE_AND_EDIT_ATTRS[:required])
+
+      endpoint = ENDPOINTS[:create_item] % acquisition_id
+      item_data = standardize_body_data(item_data, Item::CREATE_AND_EDIT_ATTRS[:permitted])
+
+      post_request(@client, endpoint, item_data)
+    end
+
+    def edit_item(acquisition_id, item_id, item_data)
+      endpoint = ENDPOINTS[:edit_item] % [acquisition_id, item_id]
+      item_data = standardize_body_data(item_data, Item::CREATE_AND_EDIT_ATTRS[:permitted])
+
+      put_request(@client, endpoint, item_data)
+    end
+
+    def fetch_item(acquisition_id, item_id)
+      endpoint = ENDPOINTS[:fetch_item] % [acquisition_id, item_id]
+
+      get_request(@client, endpoint)
+    end
+
+    def delete_item(acquisition_id, item_id)
+      endpoint = ENDPOINTS[:delete_item] % [acquisition_id, item_id]
+
+      delete_request(@client, endpoint)
+    end
+
+    def attach_contact(acquisition_id, contact_id)
+      endpoint = ENDPOINTS[:attach_contact] % [acquisition_id, contact_id]
+
+      put_request(@client, endpoint)
+    end
+
+  end
+end

data/lib/fastbound-ruby/api.rb

@@ -0,0 +1,121 @@
+require 'net/http'
+
+module FastBound
+  module API
+
+    ROOT_URL          = 'https://cloud.fastbound.com'.freeze
+    USER_AGENT        = "FastBoundRubyGem/#{FastBound::VERSION}".freeze
+    FILE_UPLOAD_ATTRS = {
+      permitted: %i( file_name file_type file_contents ).freeze,
+      reqired:   %i( file_type file_contents ).freeze,
+    }
+
+    def get_request(client, endpoint)
+      request = Net::HTTP::Get.new(request_url(client, endpoint))
+
+      submit_request(client, request)
+    end
+
+    def post_request(client, endpoint, data = {})
+      request = Net::HTTP::Post.new(request_url(client, endpoint))
+
+      submit_request(client, request, data)
+    end
+
+    def put_request(client, endpoint, data = {})
+      request = Net::HTTP::Put.new(request_url(client, endpoint))
+
+      submit_request(client, request, data)
+    end
+
+    def delete_request(client, endpoint)
+      request = Net::HTTP::Delete.new(request_url(client, endpoint))
+
+      submit_request(client, request)
+    end
+
+    def post_file_request(client, endpoint, file_data)
+      request = Net::HTTP::Post.new(request_url(client, endpoint))
+
+      submit_file_request(client, request, file_data)
+    end
+
+    private
+
+    def submit_request(client, request, data = {})
+      set_request_headers(client, request)
+
+      request.body = data.is_a?(Hash) ? data.to_json : data
+
+      process_request(request)
+    end
+
+    def submit_file_request(client, request, file_data)
+      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(client, request)
+      process_request(request)
+    end
+
+    def process_request(request)
+      uri = URI(request.path)
+
+      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+        http.request(request)
+      end
+
+      FastBound::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(client, request)
+      request['User-Agent'] = USER_AGENT
+      request['Authorization'] = ['Basic', Base64.strict_encode64(client.api_key + ':')].join(' ')
+      request['X-AuditUser'] = client.account_email
+    end
+
+    def request_url(client, endpoint)
+      [ROOT_URL, client.account_number, 'api', endpoint].join('/')
+    end
+
+    def standardize_body_data(submitted_data, permitted_data_attrs)
+      protected_attr_prefixes = %w( acquire destroyed dispose location theftLoss )
+      _submitted_data = submitted_data.deep_transform_keys(&:to_sym)
+      permitted_data = (_submitted_data.select! { |k, v| permitted_data_attrs.include?(k) } || _submitted_data)
+
+      permitted_data.deep_transform_keys do |k|
+        transformed_key = k.to_s.camelize(:lower)
+
+        if index_for_underscore = protected_attr_prefixes.find { |x| transformed_key.index(x) == 0 }&.length
+          transformed_key.insert(index_for_underscore, '_')
+        else
+          transformed_key
+        end
+      end
+    end
+
+    def convert_params_to_request_query(params)
+      params&.map { |k, v| [k.to_s.camelize(:lower), v].join('=') }&.join('&')
+    end
+
+  end
+end

data/lib/fastbound-ruby/attachment.rb

@@ -0,0 +1,23 @@
+require 'fastbound-ruby/api'
+
+module FastBound
+  class Attachment < Base
+
+    include FastBound::API
+
+    ENDPOINTS = {
+      download: "attachments/download/%s".freeze,
+    }
+
+    def initialize(client)
+      @client = client
+    end
+
+    def download(attachment_id)
+      endpoint = ENDPOINTS[:download] % attachment_id
+
+      get_request(@client, endpoint)
+    end
+
+  end
+end

data/lib/fastbound-ruby/base.rb

@@ -0,0 +1,24 @@
+module FastBound
+  class Base
+
+    protected
+
+    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
+
+  end
+end

data/lib/fastbound-ruby/client.rb

@@ -0,0 +1,59 @@
+require 'fastbound-ruby/api'
+require 'fastbound-ruby/account'
+require 'fastbound-ruby/acquisition'
+require 'fastbound-ruby/attachment'
+require 'fastbound-ruby/contact'
+require 'fastbound-ruby/disposition'
+require 'fastbound-ruby/item'
+require 'fastbound-ruby/smart_list'
+require 'fastbound-ruby/webhook'
+
+module FastBound
+  class Client < Base
+
+    include FastBound::API
+
+    attr_accessor :account_number, :api_key, :account_email
+
+    def initialize(options = {})
+      requires!(options, :account_number, :api_key, :account_email)
+
+      self.account_number = options[:account_number]
+      self.api_key = options[:api_key]
+      self.account_email = options[:account_email]
+    end
+
+    def account
+      @account ||= FastBound::Account.new(self)
+    end
+
+    def acquisition
+      @acquisition ||= FastBound::Acquisition.new(self)
+    end
+
+    def attachment
+      @attachment ||= FastBound::Attachment.new(self)
+    end
+
+    def contact
+      @contact ||= FastBound::Contact.new(self)
+    end
+
+    def disposition
+      @disposition ||= FastBound::Disposition.new(self)
+    end
+
+    def item
+      @item ||= FastBound::Item.new(self)
+    end
+
+    def smart_list
+      @smart_list ||= FastBound::SmartList.new(self)
+    end
+
+    def webhook
+      @webhook ||= FastBound::Webhook.new(self)
+    end
+
+  end
+end