hushed 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chris Saunders
+
+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 @@
+# Hushed
+
+Client library for integrating with the Quiet Logistics API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hushed'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hushed
+
+## Usage
+
+Basic usage for Hushed goes as follows:
+
+
+```ruby
+require 'hushed'
+require 'hushed/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: 'hushed-to-quiet',
+    from: 'hushed-from-quiet'
+  },
+  queues: {
+    to: http://queue.amazonaws/1234567890/hushed_to_quiet
+    from: http://queue.amazonaws/1234567890/hushed_from_quiet
+    inventory: http://queue.amazonaws/1234567890/hushed_inventory
+  }
+}
+client = Hushed::Client.new(credentials)
+order = Order.new # Orders are expected to have similar attributes as ShopifyAPI::Order
+document = Hushed::Documents::Request::ShipmentOrder.new(client: client, order: order)
+
+blackboard = Hushed::Blackboard.new(client)
+queue = Hushed::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/hushed.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hushed/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hushed"
+  spec.version       = Hushed::VERSION
+  spec.authors       = ["Chris Saunders"]
+  spec.email         = ["chris.saunders@shopify.com"]
+  spec.description   = "API Client for Quiet Logistics Services"
+  spec.summary       = "Integrates with QL Blackboard and work Queue"
+  spec.homepage      = ""
+  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', '~> 1.10.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/hushed.rb

@@ -0,0 +1,6 @@
+require "nokogiri"
+require "hushed/documents/document"
+require "hushed/version"
+require "hushed/client"
+require "hushed/blackboard"
+require "hushed/queue"

data/lib/hushed/blackboard.rb

@@ -0,0 +1,44 @@
+require 'hushed/response'
+require 'hushed/request'
+module Hushed
+  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/hushed/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 Hushed
+  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
+      @sqs_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/hushed/documents/document.rb

@@ -0,0 +1,15 @@
+module Hushed
+  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/hushed/documents/request/shipment_order.rb

@@ -0,0 +1,89 @@
+module Hushed
+  module Documents
+    module Request
+      class ShipmentOrder
+        include Hushed::Documents::Document
+        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 :order, :client
+
+        def_delegators :@client, :warehouse, :business_unit, :client_id
+
+        def initialize(options = {})
+          @order = options[:order] || raise(MissingOrderError.new("order cannot be missing"))
+          @client = options[:client] || raise(MissingClientError.new("client cannot be missing"))
+        end
+
+        def to_xml
+          builder = Nokogiri::XML::Builder.new do |xml|
+            xml.ShipOrderDocument(xmlns: NAMESPACE) do
+              xml.ClientID client_id
+              xml.BusinessUnit business_unit
+              xml.OrderHeader(order_header_attributes) do
+                xml.Comments @order.note
+                xml.ShipMode(shipping_attributes(@order.shipping_lines.first))
+                xml.ShipTo(address_attributes(@order.shipping_address))
+                xml.BillTo(address_attributes(@order.billing_address))
+                xml.DeclaredValue @order.total_price
+                @order.line_items.each.with_index(1) do |line_item, index|
+                  xml.OrderDetails(line_item_attributes(line_item, index))
+                end
+              end
+            end
+          end
+          builder.to_xml
+        end
+
+        def type
+          'ShipmentOrder'
+        end
+
+        def document_number
+          @order.id
+        end
+
+        def order_type
+          'SO'
+        end
+
+        def date
+          @order.created_at.utc
+        end
+
+        def filename
+          "#{business_unit}_#{type}_#{document_number}_#{date.strftime(DATEFORMAT)}.xml"
+        end
+
+        def order_header_attributes
+          {OrderNumber: document_number, OrderType: order_type, OrderDate: date, ShipDate: date}
+        end
+
+        def shipping_attributes(shipping_line)
+          {Carrier: shipping_line.carrier, ServiceLevel: shipping_line.service_level}
+        end
+
+        def address_attributes(address)
+          {
+            Company: address.company, Contact: address.name, Address1: address.address1, Address2: address.address2,
+            City: address.city, State: address.province_code, PostalCode: address.zip, Country: address.country_code,
+            Email: @order.email
+          }
+        end
+
+        def line_item_attributes(line_item, line_number)
+          {
+            ItemNumber: line_item.id, Line: line_number, QuantityOrdered: line_item.quantity,
+            QuantityToShip: line_item.quantity, UOM: line_item.unit_of_measure, Price: line_item.price
+          }
+        end
+      end
+    end
+  end
+end

data/lib/hushed/documents/response/shipment_order_result.rb

@@ -0,0 +1,56 @@
+require 'time'
+module Hushed
+  module Documents
+    module Response
+      class ShipmentOrderResult
+        attr_reader :io
+
+        def initialize(options = {})
+          @io = options[:io]
+          @document = Nokogiri::XML::Document.parse(@io)
+        end
+
+        def client_id
+          @client_id ||= so_result['ClientID']
+        end
+
+        def business_unit
+          @business_unit ||= so_result['BusinessUnit']
+        end
+
+        def date_shipped
+          @date_shipped ||= Time.parse(so_result['DateShipped']).utc
+        end
+
+        def order_number
+          @order_number ||= so_result['OrderNumber']
+        end
+
+        def carton_count
+          @carton_count ||= so_result['CartonCount'].to_i
+        end
+
+        def carrier
+          @carrier ||= carton['Carrier']
+        end
+
+        def service_level
+          @service_level ||= carton['ServiceLevel']
+        end
+
+        def tracking_number
+          @tracking_number ||= carton['TrackingId']
+        end
+
+        def so_result
+          @so_result ||= @document.css('SOResult').first
+        end
+
+        def carton
+          @carton ||= @document.css('Carton').first
+        end
+
+      end
+    end
+  end
+end