gentle 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 918ee2ec0b03488dd47d7ddff5c409f213c04773
+  data.tar.gz: fb0f8a52ab418098695258d41835330414b2ec63
+SHA512:
+  metadata.gz: 38aa3474fa3490a513fae74f594001836865a0735aa359d7fe7c18592c2348a4136b71abee70d75b313ae1cc467e5d5b50c94ca7acf94efa087992a31d42108b
+  data.tar.gz: f08640f2c2e6af32910c1bdc6d5cafbe72e1ab2dbe2a285c7da5b78831070c11c0cf7597b94bb95e1244196596701a837d3c7ff723d28f24b4acb11d9dc52316

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.byebug_history

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gentle.gemspec
+group :test do
+  gem 'pry-byebug'
+  gem 'm', github: 'qrush/m'
+end
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 DynamoMTL 
+
+MIT License
+
+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,64 @@
+# Gentle
+
+Client library for integrating with the [Quiet Logistics](http://quietlogistics.com) API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gentle'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gentle
+
+## Usage
+
+Basic usage for Gentle goes as follows:
+
+
+```ruby
+require 'gentle'
+require 'gentle/documents/request/shipment_order'
+
+credentials = {
+  access_key_id: 'AWS_ACCESS_KEY', secret_access_key: 'SECRET_ACCESS_KEY',
+  client_id: 'QUIET CLIENT ID', business_unit: 'QUIET BUSINESS UNIT',
+  warehouse: 'QUIET WAREHOUSE',
+  buckets: {
+    to: 'gentle-to-quiet',
+    from: 'gentle-from-quiet'
+  },
+  queues: {
+    to: 'http://queue.amazonaws/1234567890/gentle_to_quiet'
+    from: 'http://queue.amazonaws/1234567890/gentle_from_quiet'
+    inventory: 'http://queue.amazonaws/1234567890/gentle_inventory'
+  }
+}
+client = Gentle::Client.new(credentials)
+# Orders are expected to have similar attributes as Spree/Solidus::Shipment
+document = Gentle::Documents::Request::ShipmentOrder.new(client: client, shipment: shipment)
+
+blackboard = Gentle::Blackboard.new(client)
+queue = Gentle::Queue.new(client)
+
+message = blackboard.post(document)
+queue.send(message)
+
+response_message = queue.receive
+response_document = blackboard.fetch(message)
+process_document(response_document)
+blackboard.remove(message)
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs = ['lib', 'spec']
+  t.ruby_opts << '-rubygems'
+  t.verbose = true
+  t.test_files = FileList['spec/**/*_spec.rb']
+end

data/gentle.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gentle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gentle"
+  spec.version       = Gentle::VERSION
+  spec.authors       = ["DynamoMTL"]
+  spec.email         = [""]
+  spec.description   = "API Client for Quiet Logistics Services"
+  spec.summary       = "Integrates with QL Blackboard and work Queue"
+  spec.homepage      = "http://github.com/DynamoMTL/qls"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency('aws-sdk', '< 2.0')
+  spec.add_dependency('nokogiri')
+  spec.add_dependency('activesupport')
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", ">= 5.0.0"
+  spec.add_development_dependency "mocha"
+end

data/lib/gentle.rb

@@ -0,0 +1,8 @@
+require "nokogiri"
+require "gentle/documents/document"
+require "gentle/version"
+require "gentle/client"
+require "gentle/blackboard"
+require "gentle/queue"
+require "gentle/message"
+require "gentle/error_message"

data/lib/gentle/blackboard.rb

@@ -0,0 +1,44 @@
+require 'gentle/response'
+require 'gentle/request'
+module Gentle
+  class Blackboard
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def post(document)
+      bucket = client.to_quiet_bucket
+      if bucket.objects[document.filename].write(document.to_xml)
+        Message.new(:client => @client, :document => document)
+      end
+    end
+
+    def fetch(message)
+      bucket = client.from_quiet_bucket
+      contents = bucket.objects[message.document_name].read
+      build_document(message.document_type, contents)
+    end
+
+    def remove(message)
+      bucket = client.from_quiet_bucket
+      object = bucket.objects[message.document_name]
+      if object.exists?
+        object.delete
+        true
+      else
+        false
+      end
+    end
+
+    def build_document(type, contents)
+      namespace = if Response.valid_type?(type)
+        Documents::Response
+      elsif Request.valid_type?(type)
+        Documents::Request
+      end
+      namespace.const_get(type).new(:io => contents) if namespace
+    end
+  end
+end

data/lib/gentle/client.rb

@@ -0,0 +1,92 @@
+require 'aws/s3'
+require 'aws/sqs'
+require 'active_support/core_ext/hash/slice'
+require 'active_support/core_ext/hash/indifferent_access'
+
+module Gentle
+  class Client
+
+    class InitializationError < StandardError; end
+    class InvalidBucketError < StandardError; end
+    class InvalidQueueError < StandardError; end
+
+    attr_reader :client_id, :business_unit, :warehouse
+
+    def initialize(options = {})
+      options        = options.with_indifferent_access
+      @buckets       = options[:buckets]
+      @queues        = options[:queues]
+      @client_id     = options[:client_id]
+      @warehouse     = options[:warehouse]
+      @business_unit = options[:business_unit]
+      @credentials   = options.slice(:access_key_id, :secret_access_key)
+      verify!
+    end
+
+    def to_quiet_bucket
+      @to_quiet_bucket ||= fetch_bucket(@buckets[:to])
+    end
+
+    def from_quiet_bucket
+      @from_quiet_bucket ||= fetch_bucket(@buckets[:from])
+    end
+
+    def to_quiet_queue
+      @to_quiet_queue ||= fetch_queue(@queues[:to])
+    end
+
+    def from_quiet_queue
+      @from_quiet_queue ||= fetch_queue(@queues[:from])
+    end
+
+    def quiet_inventory_queue
+      @quiet_inventory_queue ||= fetch_queue(@queues[:inventory])
+    end
+
+    private
+    def sqs_client
+      @sqs_client ||= AWS::SQS.new(@credentials)
+    end
+
+    def s3_client
+      @s3_client ||= AWS::S3.new(@credentials)
+    end
+
+    def fetch_bucket(name)
+      bucket = s3_client.buckets[name]
+      raise(InvalidBucketError.new("#{name} is not a valid bucket")) unless bucket.exists?
+      bucket
+    end
+
+    def fetch_queue(url)
+      queue = sqs_client.queues[url]
+      raise(InvalidQueueError.new("#{url} is not a valid queue")) unless queue.exists?
+      queue
+    end
+
+    def verify!
+      raise(InitializationError.new("Credentials cannot be missing")) unless all_credentials?
+      raise(InitializationError.new("Both to and from buckets need to be set")) unless all_buckets?
+      raise(InitializationError.new("To, From and Inventory queues need to be set")) unless all_queues?
+      raise(InitializationError.new("client_id needs to be set")) unless @client_id
+      raise(InitializationError.new("business_unit needs to be set")) unless @business_unit
+      raise(InitializationError.new("warehouse needs to be set")) unless @warehouse
+    end
+
+    def all_credentials?
+      has_keys?(@credentials, [:access_key_id, :secret_access_key])
+    end
+
+    def all_buckets?
+      has_keys?(@buckets, [:from, :to])
+    end
+
+    def all_queues?
+      has_keys?(@queues, [:from, :to, :inventory])
+    end
+
+    def has_keys?(hash, keys)
+      keys.reduce(hash) {|result, key| result && hash[key]}
+    end
+  end
+end

data/lib/gentle/documents/document.rb

@@ -0,0 +1,15 @@
+module Gentle
+  module Documents
+    module  Document
+      DATEFORMAT = "%Y%m%d_%H%M%S"
+
+      def to_xml
+        raise NotImplementedError("To be implemented by subclasses")
+      end
+
+      def filename
+        @filename ||= "#{business_unit}_#{type}_#{document_number}_#{date.strftime(DATEFORMAT)}.xml"
+      end
+    end
+  end
+end

data/lib/gentle/documents/request/hash_converter.rb

@@ -0,0 +1,55 @@
+module Gentle
+  module Documents
+    module Request
+      module HashConverter
+        def part_line_item_hash(part)
+          {
+            'ItemNumber'      => part.variant.sku,
+            'Line'            => part.variant.id,
+            'QuantityOrdered' => part.line_item.quantity,
+            'QuantityToShip'  => part.line_item.quantity,
+            'UOM'             => 'EA',
+            'Price'           => part.variant.price
+          }
+        end
+
+        def line_item_hash(item)
+          {
+            'ItemNumber'      => item.sku,
+            'Line'            => item.id,
+            'QuantityOrdered' => item.quantity,
+            'QuantityToShip'  => item.quantity,
+            'UOM'             => 'EA',
+            'Price'           => item.price
+          }
+        end
+
+        def ship_to_hash
+          {
+            'Company'    => ship_address.company,
+            'Contact'    => full_name,
+            'Address1'   => ship_address.address1,
+            'Address2'   => ship_address.address2,
+            'City'       => ship_address.city,
+            'State'      => ship_address.state.name,
+            'PostalCode' => ship_address.zipcode,
+            'Country'    => ship_address.country.name
+          }
+        end
+
+        def bill_to_hash
+          {
+            'Company'    => bill_address.company,
+            'Contact'    => full_name,
+            'Address1'   => bill_address.address1,
+            'Address2'   => bill_address.address2,
+            'City'       => bill_address.city,
+            'State'      => bill_address.state.name,
+            'PostalCode' => bill_address.zipcode,
+            'Country'    => bill_address.country.name
+          }
+        end
+      end
+    end
+  end
+end

data/lib/gentle/documents/request/shipment_order.rb

@@ -0,0 +1,167 @@
+require 'forwardable'
+require 'gentle/documents/request/hash_converter'
+require 'gentle/phase_1_set'
+
+module Gentle
+  module Documents
+    module Request
+      class ShipmentOrder
+        include Gentle::Documents::Document
+        include Gentle::Documents::Request::HashConverter
+        extend Forwardable
+
+        NAMESPACE = "http://schemas.quietlogistics.com/V2/ShipmentOrder.xsd"
+
+        DATEFORMAT = "%Y%m%d_%H%M%S"
+
+        class MissingOrderError < StandardError; end
+        class MissingClientError < StandardError; end
+
+        attr_reader :shipment, :client
+
+        def_delegators :@client, :warehouse, :business_unit, :client_id
+
+        def initialize(options = {})
+          @client   = options.fetch(:client)
+          @shipment = options.fetch(:shipment)
+          @shipment_number = @shipment.number
+        end
+
+        def to_xml
+          builder = Nokogiri::XML::Builder.new do |xml|
+            xml.ShipOrderDocument('xmlns' => 'http://schemas.quietlogistics.com/V2/ShipmentOrder.xsd') {
+
+              xml.ClientID client_id
+              xml.BusinessUnit business_unit
+
+              xml.OrderHeader('OrderNumber' => @shipment_number,
+                              'OrderType'   => order_type,
+                              'OrderDate'   => @shipment.created_at.utc.iso8601) {
+
+                xml.Extension @shipment.order.number
+
+                xml.Comments @shipment.order.special_instructions
+
+                xml.ShipMode('Carrier'      => @shipment.shipping_method.carrier,
+                             'ServiceLevel' => @shipment.shipping_method.service_level)
+
+                xml.ShipTo(ship_to_hash)
+                xml.BillTo(bill_to_hash)
+
+                if @shipment.respond_to?(:value_added_services)
+                  @shipment.value_added_services.each do |service|
+                    xml.ValueAddedService('Service'     => service[:service],
+                                          'ServiceType' => service[:service_type])
+                  end
+                end
+              }
+
+              add_items_to_shipment_order(order_items, xml)
+            }
+          end
+          builder.to_xml
+        end
+
+        def add_items_to_shipment_order(items, xml)
+          item_hashes = convert_to_hashes(items)
+          grouped_items = group_items_by_sku(item_hashes)
+          grouped_items.each_with_index do |hash, index|
+            hash['Line'] = index + 1
+            xml.OrderDetails(hash)
+          end
+        end
+
+        def convert_to_hashes(items)
+          items.map do |item|
+            if Phase1Set.match(item)
+              add_individual_phase_1_items(item)
+            elsif contain_parts? item
+              add_item_parts(item.part_line_items)
+            else
+              line_item_hash(item)
+            end
+          end.flatten
+        end
+
+        def group_items_by_sku(item_hashes)
+          grouped = item_hashes.group_by {|hash| hash['ItemNumber'] }
+          grouped.values.map do |hashes|
+            hash = hashes.first
+            update_quantity(hash, total_quantity(hashes))
+          end
+        end
+
+        def contain_parts?(item)
+          item.part_line_items && !item.part_line_items.empty?
+        end
+
+        def add_item_parts(part_line_items)
+          part_line_items.map { |part| part_line_item_hash(part) }
+        end
+
+        def add_individual_phase_1_items(phase_1_item)
+          phase_1 = Phase1Set.new(phase_1_item).included_items
+          phase_1.map { |item| line_item_hash(item) }
+        end
+
+        def update_quantity(hash, quantity)
+          hash['QuantityOrdered'] = hash['QuantityToShip'] = quantity
+          hash
+        end
+
+        def total_quantity(hashes)
+          hashes.map{ |hash| hash['QuantityOrdered'] }.reduce(:+)
+        end
+
+        def order_items
+          @shipment.order.line_items
+        end
+
+        def order_type
+          'SO'
+        end
+
+        def ship_address
+          @shipment.address
+        end
+
+        def bill_address
+          @shipment.order.bill_address
+        end
+
+        def full_name
+          @shipment.address.full_name
+        end
+
+        def message
+          "Succesfully Sent Shipment #{@shipment_number} to Quiet Logistics"
+        end
+
+        def date_stamp
+          Time.now.strftime('%Y%m%d_%H%M%3N')
+        end
+
+        def type
+          'ShipmentOrder'
+        end
+
+        def document_number
+          @shipment_number
+        end
+
+        def date
+          @shipment.created_at
+        end
+
+        def filename
+          "#{business_unit}_#{type}_#{document_number}_#{date.strftime(DATEFORMAT)}.xml"
+        end
+
+        def message_id
+          SecureRandom.uuid
+        end
+
+      end
+    end
+  end
+end