gentle 0.1.0

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

@@ -0,0 +1,56 @@
+require 'time'
+module Gentle
+  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

data/lib/gentle/error_message.rb

@@ -0,0 +1,19 @@
+module Gentle
+  class ErrorMessage
+    attr_reader :xml
+
+    def initialize(options = {})
+      @xml = Nokogiri::XML::Document.parse(options[:xml]) if options[:xml]
+    end
+
+    def to_xml
+      @xml.serialize(encoding: "UTF-8")
+    end
+
+    def shipment_number
+      result_description = @xml.css("ErrorMessage").first["ResultDescription"]
+      match_data = result_description.match(/(.+)_(.+)_(.+)_.*.xml/) unless result_description.nil?
+      match_data[2] unless match_data.nil?
+    end
+  end
+end

data/lib/gentle/message.rb

@@ -0,0 +1,43 @@
+module Gentle
+  class Message
+
+    NAMESPACE = "http://schemas.quietlogistics.com/V2/EventMessage.xsd"
+
+    class MissingDocumentError < StandardError; end
+    class MissingClientError < StandardError; end
+
+    attr_reader :client, :document, :xml
+
+    def initialize(options = {})
+      @xml = Nokogiri::XML::Document.parse(options[:xml]) if options[:xml]
+      @client = options[:client]
+      @document = options[:document]
+    end
+
+    def to_xml
+      builder = Nokogiri::XML::Builder.new do |xml|
+        xml.EventMessage(attributes)
+      end
+      builder.to_xml
+    end
+
+    def document_type
+      @document ? @document.type : @xml.css('EventMessage').first['DocumentType']
+    end
+
+    def document_name
+      @document ? @document.filename : @xml.css('EventMessage').first['DocumentName']
+    end
+
+    def attributes
+      raise(MissingClientError.new("client cannot be missing")) unless @client
+      raise(MissingDocumentError.new("document cannot be missing")) unless @document
+      {
+        ClientId: @client.client_id, BusinessUnit: @client.business_unit,
+        DocumentName: @document.filename, DocumentType: @document.type,
+        Warehouse: @document.warehouse, MessageDate: @document.date.utc.iso8601,
+        MessageId: @document.message_id, xmlns: NAMESPACE
+      }
+    end
+  end
+end

data/lib/gentle/phase_1_set.rb

@@ -0,0 +1,53 @@
+module Gentle
+  class Phase1Set
+
+    SKUS = {
+      "GPS1-5" => "GPST100 - 2",
+      "GPS2-5" => "GPST200 - 2",
+      "GPS3-5" => "GPST300",
+      "GPS4-5" => "GPST400",
+      "GPS5-5" => "GPST500"
+    }
+
+    def initialize(item)
+      @item = item
+    end
+
+    def self.match(item)
+      SKUS.key? item.sku
+    end
+
+    def included_items
+      [
+        milky_jelly,
+        priming_moisturizer,
+        balm_dotcom,
+        skin_tint
+      ]
+    end
+
+    def milky_jelly
+      line_item(97 , "GMJC100", 18.0)
+    end
+
+    def priming_moisturizer
+      line_item( 3, "GPM100", 25.0)
+    end
+
+    def balm_dotcom
+      line_item(96, "GBD100-3", 12.0)
+    end
+
+    def skin_tint
+      line_item(6, SKUS[@item.sku], 26.0)
+    end
+
+    def line_item(id, sku, price)
+      LineItem.new(sku, id, @item.quantity, price)
+    end
+
+  end
+
+  class LineItem < Struct.new(:sku, :id, :quantity, :price)
+  end
+end

data/lib/gentle/queue.rb

@@ -0,0 +1,40 @@
+module Gentle
+  class Queue
+    attr_reader :client
+    def initialize(client)
+      @client = client
+    end
+
+    def send(message)
+      queue = client.to_quiet_queue
+      queue.send_message(message.to_xml)
+    end
+
+    def receive
+      queue = client.from_quiet_queue
+      message = nil
+      queue.receive_message do |msg|
+        message = build_message(msg)
+      end
+      message || Message.new
+    end
+
+    def approximate_pending_messages
+      client.from_quiet_queue.approximate_number_of_messages
+    end
+
+  private
+
+    def build_message(msg)
+      if received_error? msg
+        ErrorMessage.new(xml: msg.body)
+      else
+        Message.new(xml: msg.body)
+      end
+    end
+
+    def received_error?(msg)
+      msg.body.include? "<ErrorMessage"
+    end
+  end
+end

data/lib/gentle/request.rb

@@ -0,0 +1,11 @@
+require 'gentle/documents/request/shipment_order'
+
+module Gentle
+  module Request
+    VALID_REQUEST_TYPES = %w(ShipmentOrder)
+
+    def self.valid_type?(type)
+      VALID_REQUEST_TYPES.include?(type)
+    end
+  end
+end

data/lib/gentle/response.rb

@@ -0,0 +1,11 @@
+require 'gentle/documents/response/shipment_order_result'
+
+module Gentle
+  module Response
+    VALID_RESPONSE_TYPES = %w(ShipmentOrderResult)
+
+    def self.valid_type?(type)
+      VALID_RESPONSE_TYPES.include?(type)
+    end
+  end
+end

data/lib/gentle/version.rb

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

data/spec/fixtures/credentials.yml

@@ -0,0 +1,12 @@
+access_key_id: abracadabra
+secret_access_key: alakazam
+client_id: Gentle
+business_unit: Gentle
+warehouse: SPACE
+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

data/spec/fixtures/documents/responses/shipment_order_result.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="utf-8"?>
+<SOResult
+  xmlns="http://schemas.quiettechnology.com/V2/SOResultDocument.xsd"
+  ClientID="Gentle"
+  BusinessUnit="Gentle"
+  CartonCount="1"
+  DateShipped="2009-09-01T04:00:00Z"
+  FreightCost="10.00"
+  OrderNumber="1234567890">
+  <Line Line="1" Quantity="1" />
+  <Line Line="2" Quantity="1" />
+  <Carton
+    Carrier="USPS"
+    CartonId="S12345678901"
+    CartonNumber="1"
+    FreightCost="10.00"
+    ServiceLevel="FIRST"
+    TrackingId="40000000000"
+    Weight="0.66">
+    <Content Line="1"Quantity="1" />
+    <Content Line="2"Quantity="1" />
+  </Carton>
+</SOResult>

data/spec/fixtures/messages/error_message.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ErrorMessage
+  xmlns="http://schemas.quietlogistics.com/V2/EventMessageErrorResponse.xsd"
+  OriginalMessageId="ab6e7e7a-6d45-4c75-9fec-e08dba4a9c31"
+  ResponseDate="2009-09-01T12:00:00Z"
+  ClientId="Gentle"
+  BusinessUnit="Gentle"
+  ResultCode="1030"
+  ResultDescription="Document: Gentle_ShipmentOrder_H123456789_20160229_135723.xml - Error: An error has occured">
+</ErrorMessage>

data/spec/fixtures/messages/purchase_order_message.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="utf-8"?>
+<EventMessage
+  xmlns="http://schemas.quietlogistics.com/V2/EventMessage.xsd"
+  ClientId="Gentle"
+  BusinessUnit="Gentle"
+  DocumentName="Gentle_PurchaseOrder_1234_20100927_132505124.xml"
+  DocumentType="PurchaseOrder"
+  MessageId="EF1CE966-38A2-428b-BA67-EFF23AF22F57"
+  Warehouse="CORP1"
+  MessageDate="2009-09-01T12:00:00Z">
+</EventMessage>

data/spec/remote/blackboard_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'gentle'
+require 'gentle/blackboard'
+
+module Gentle
+  describe "BlackboardRemote" do
+    include Configuration
+    include Fixtures
+
+    before do
+      AWS.config(stub_requests: false)
+      @client = Client.new(load_configuration)
+      @blackboard = Blackboard.new(@client)
+      @document = DocumentDouble.new(
+        message_id: '1234567',
+        date: Time.new(2013, 04, 05, 12, 30, 15).utc,
+        filename: 'neat_beans.xml',
+        client: @client,
+        type: 'ShipmentOrderResult'
+      )
+    end
+
+    after do
+      buckets = [@client.to_quiet_bucket, @client.from_quiet_bucket]
+      buckets.each { |bucket| bucket.objects.delete_all }
+    end
+
+    it "should be able to write a document to an S3 bucket" do
+      message = @blackboard.post(@document)
+      file = message.document_name
+      bucket = @client.to_quiet_bucket
+      assert bucket.objects[file].exists?, "It appears that #{file} was not written to S3"
+    end
+
+    it "should be able to fetch a document from an S3 bucket when given a message" do
+      expected_contents = load_response('shipment_order_result')
+      @client.from_quiet_bucket.objects[@document.filename].write(expected_contents)
+      message = MessageDouble.new(document_name: @document.filename, document_type: @document.type)
+      document = @blackboard.fetch(message)
+      assert_equal expected_contents, document.io
+    end
+  end
+end

data/spec/remote/queue_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+require 'openssl'
+require 'gentle'
+require 'gentle/message'
+
+module Gentle
+  describe "QueueRemote" do
+    include Configuration
+
+    before do
+      AWS.config(:stub_requests => false)
+      @client = Client.new(load_configuration)
+      @sqs_queues = [@client.to_quiet_queue, @client.from_quiet_queue]
+      @default_wait_time = @sqs_queues.map(&:wait_time_seconds).max
+      @sqs_queues.each { |queue| queue.wait_time_seconds = 1 }
+
+      @document = DocumentDouble.new(
+        :message_id => '1234567',
+        :date => Time.new(2013, 04, 05, 12, 30, 15).utc,
+        :filename => 'neat_beans.xml',
+        :client => @client,
+        :type => 'Thinger'
+      )
+
+      @message = Message.new(:client => @client, :document => @document)
+      @queue = Queue.new(@client)
+    end
+
+    after do
+      @sqs_queues.each do |queue|
+        flush(queue)
+      end
+      @sqs_queues.each { |queue| queue.wait_time_seconds = @default_wait_time }
+    end
+
+    it "should be able to push a message onto the queue" do
+      expected_md5 = OpenSSL::Digest::MD5.new.hexdigest(@message.to_xml)
+      sent_message = @queue.send(@message)
+      # NOTE: This is failing, but the message is getting sent
+      # assert_equal 1, @client.to_quiet_queue.approximate_number_of_messages
+      assert_equal expected_md5, sent_message.md5
+    end
+
+    it "should be able to fetch a message from the queue" do
+      @client.from_quiet_queue.send_message(@message.to_xml)
+      message = @queue.receive
+
+      assert_equal @message.document_type, message.document_type
+      assert_equal @message.document_name, message.document_name
+    end
+
+    private
+    def flush(queue)
+      pending_messages = queue.approximate_number_of_messages
+      while pending_messages > 0
+        queue.receive_message do |message|
+          message.delete
+          pending_messages -= 1
+        end
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,323 @@
+require 'minitest/autorun'
+require 'nokogiri'
+require 'yaml'
+require 'mocha/setup'
+require 'gentle'
+require 'pry'
+
+module Fixtures
+  def load_fixture(path)
+    File.open(path, 'rb').read
+  end
+
+  def load_response(response_name)
+    load_fixture("spec/fixtures/documents/responses/#{response_name}.xml")
+  end
+
+  def load_message(message_name)
+    load_fixture("spec/fixtures/messages/#{message_name}.xml")
+  end
+end
+
+module Configuration
+  def load_configuration
+    test_credentials_file = ENV['HOME'] + '/.gentle/credentials.yml'
+    test_credentials_file = "spec/fixtures/credentials.yml" unless File.exists?(test_credentials_file)
+    YAML.load(File.open(test_credentials_file, 'rb'))
+  end
+end
+
+class VariantDouble
+  DEFAULT_OPTIONS = {
+    id: 112233,
+    sku: "ABC-123",
+    price: '6.95'
+  }
+
+  attr_reader :id, :sku, :price
+  def initialize(options = {})
+    @id = options[:id]
+    @sku = options[:sku]
+    @price = options[:price]
+  end
+
+  def self.example(options = {})
+    self.new(DEFAULT_OPTIONS.merge(options))
+  end
+end
+
+class LineItemDouble
+  DEFAULT_OPTIONS = {
+    id: 123456,
+    quantity: 1,
+    price: '12.95',
+    sku: "ABC-123",
+    part_line_items: []
+  }
+
+  attr_reader :id, :quantity, :price, :sku, :product, :part_line_items
+  def initialize(options = {})
+    @id = options[:id]
+    @quantity = options[:quantity]
+    @price = options[:price]
+    @sku = options[:sku]
+    @product = options[:product]
+
+    @part_line_items = options[:part_line_items].map do |part|
+      PartLineItemDouble.example(
+        id: part.id,
+        variant: part.variant,
+        line_item: LineItemDouble.example(quantity: @quantity)
+      )
+    end
+  end
+
+  def self.example(options = {})
+    self.new(DEFAULT_OPTIONS.merge(options))
+  end
+end
+
+class PartLineItemDouble
+  DEFAULT_OPTIONS = {
+    id: 444555,
+    variant: VariantDouble.example,
+    line_item: LineItemDouble.example
+  }
+
+  attr_reader :id, :variant, :line_item
+  def initialize(options = {})
+    @id = options[:id]
+    @variant = options[:variant]
+    @line_item = options[:line_item]
+  end
+
+  def self.example(options = {})
+    self.new(DEFAULT_OPTIONS.merge(options))
+  end
+end
+
+class StateDouble
+  DEFAULT_OPTIONS = {
+    iso_name: "CANADA",
+    name: "Ontario",
+    abbr: "ON",
+  }
+
+  attr_reader :name
+
+  def initialize(options = {})
+    @name = options[:name]
+  end
+
+  def self.example(options = {})
+    self.new(DEFAULT_OPTIONS.merge(options))
+  end
+end
+
+class CountryDouble
+  DEFAULT_OPTIONS = {
+    iso_name: "CANADA",
+    name: "Canada",
+    iso: "CA"
+  }
+
+  attr_reader :name
+
+  def initialize(options = {})
+    @name = options[:name]
+  end
+
+  def self.example(options = {})
+    self.new(DEFAULT_OPTIONS.merge(options))
+  end
+
+end
+
+class AddressDouble
+  DEFAULT_OPTIONS = {
+    company: 'Shopify',
+    name: 'John Smith',
+    address1: '123 Fake St',
+    address2: 'Unit 128',
+    city: 'Ottawa',
+    country: CountryDouble.example,
+    state: StateDouble.example,
+    zipcode: 'K1N 5T5'
+  }
+
+  attr_reader :company, :name, :address1, :address2, :city, :country, :state, :zipcode
+
+  def initialize(options = {})
+    @company = options[:company]
+    @name = options[:name]
+    @address1 = options[:address1]
+    @address2 = options[:address2]
+    @city = options[:city]
+    @country = options[:country]
+    @state = options[:state]
+    @zipcode = options[:zipcode]
+  end
+
+  def full_name
+    name
+  end
+
+  def self.example(options = {})
+    self.new(DEFAULT_OPTIONS.merge(options))
+  end
+end
+
+class ShippingLineDouble
+  def initialize(options = {})
+    @options = options
+  end
+
+  def carrier
+    @options[:code].split('_').first
+  end
+
+  def service_level
+    @options[:code].split('_').last
+  end
+end
+
+class ShippingMethodDouble
+  DEFAULT_OPTIONS = {
+    name: "UPS Ground",
+    admin_name: "fed001",
+    code: "fedex",
+    carrier: "FEDEX",
+    service_level: "GROUND"
+  }
+
+  attr_reader :name, :admin_name, :code, :carrier, :service_level
+
+  def initialize(options = {})
+    @name = options[:name]
+    @admin_name = options[:admin_name]
+    @code = options[:code]
+    @carrier = options[:carrier]
+    @service_level = options[:service_level]
+  end
+
+  def self.example(options = {})
+    self.new(DEFAULT_OPTIONS.merge(options))
+  end
+end
+
+class OrderDouble
+  DEFAULT_OPTIONS = {
+    number: "GLO#{rand.to_s[2..11]}",
+    line_items: [LineItemDouble.example],
+    ship_address: AddressDouble.example,
+    bill_address: AddressDouble.example,
+    note: 'Happy Birthday',
+    created_at: Time.new(2013, 04, 05, 12, 30, 00),
+    id: 123456,
+    email: 'john@smith.com',
+    total_price: '123.45'
+  }
+
+  attr_reader :line_items, :ship_address, :bill_address, :note, :email
+  attr_reader :total_price, :email, :id, :type, :created_at, :shipping_lines
+  attr_reader :number
+
+  def initialize(options = {})
+    @line_items = options[:line_items]
+    @ship_address = options[:ship_address]
+    @bill_address = options[:bill_address]
+    @note = options[:note]
+    @created_at = options[:created_at]
+    @id = options[:id]
+    @shipping_lines = options[:shipping_lines]
+    @email = options[:email]
+    @total_price = options[:total_price]
+    @number = options[:number]
+  end
+
+  def self.example(options = {})
+    self.new(DEFAULT_OPTIONS.merge(options))
+  end
+
+  def special_instructions
+    @note
+  end
+
+  def shipping_address
+    @ship_address
+  end
+
+  def billing_address
+    @bill_address
+  end
+
+  def type
+    @type || "SO"
+  end
+end
+
+class ShipmentDouble
+  DEFAULT_OPTIONS = {
+    shipping_method: ShippingMethodDouble.example,
+    number: "H#{rand.to_s[2..11]}",
+    order: OrderDouble.example,
+    address: AddressDouble.example,
+    state: "pending",
+    created_at: Time.new(2013, 04, 06, 13, 45, 00)
+  }
+
+  attr_reader :order, :number, :address, :shipping_method, :created_at
+
+  def initialize(options = {})
+    @order = options[:order]
+    @number = options[:number]
+    @address = options[:address]
+    @shipping_method = options[:shipping_method]
+    @created_at = options[:created_at]
+  end
+
+  def self.example(options = {})
+    self.new(DEFAULT_OPTIONS.merge(options))
+  end
+end
+
+class DocumentDouble
+  include Gentle::Documents::Document
+  attr_accessor :type, :message_id, :warehouse, :date, :client
+  attr_accessor :business_unit, :document_number, :io
+
+  def initialize(options = {})
+    options.each do |key, value|
+      self.public_send("#{key}=".to_sym, value)
+    end
+  end
+
+  def to_xml
+    builder = Nokogiri::XML::Builder.new do |xml|
+      xml.DocumentDouble 'Hello World'
+    end
+    builder.to_xml
+  end
+
+  def filename=(filename)
+    @filename = filename
+  end
+end
+
+class MessageDouble
+  attr_accessor :document_name, :document_type
+
+  def initialize(options = {})
+    @document_name = options[:document_name]
+    @document_type = options[:document_type]
+  end
+end
+
+class ClientDouble
+  attr_accessor :client_id, :business_unit
+
+  def initialize(options = {})
+    @client_id = options[:client_id]
+    @business_unit = options[:business_unit]
+  end
+end