hushed 0.0.1

data/spec/unit/client_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+require 'hushed/client'
+require 'active_support/core_ext/hash/except'
+require 'active_support/core_ext/hash/keys'
+
+module Hushed
+  describe "Client" do
+    before do
+      AWS.config(:stub_requests => true)
+      @options = {
+        access_key_id: 'abracadabra',
+        secret_access_key: 'alakazam',
+        client_id: 'HUSHED',
+        business_unit: 'HUSHED',
+        warehouse: 'SPACE',
+        buckets: {
+          to: 'hushed-to-quiet',
+          from: 'hushed-from-quiet'
+        },
+        queues: {
+          to: 'http://queue.amazonaws.com/123456789/hushed_to_quiet',
+          from: 'http://queue.amazonaws.com/123456789/hushed_from_quiet',
+          inventory: 'http://queue.amazonaws.com/123456789/hushed_inventory'
+        }
+      }
+      @client = Client.new(@options)
+    end
+
+    after do
+      AWS.config(:stub_requests => false)
+    end
+
+    it "should be able to handle configuration that is passed in with keys as strings" do
+      client = Client.new(@options.stringify_keys)
+      assert_equal 'HUSHED', client.client_id
+      assert_equal 'HUSHED', client.business_unit
+    end
+
+    it "should not be possible to initialize a client without credentials" do
+      assert_raises Client::InitializationError do
+        Client.new(@options.except(:access_key_id, :secret_access_key))
+      end
+    end
+
+    it "should not be possible to initialize a client without a client_id" do
+      assert_raises Client::InitializationError do
+        Client.new(@options.except(:client_id))
+      end
+    end
+
+    it "should not be possible to initialize a client with a business_unit" do
+      assert_raises Client::InitializationError do
+        Client.new(@options.except(:business_unit))
+      end
+    end
+
+    it "should not be possible to initialize a client with missing bucket information" do
+      assert_raises Client::InitializationError do
+        Client.new(@options.except(:buckets))
+      end
+    end
+
+    it "should not be possible to initialize a client with partial bucket information" do
+      assert_raises Client::InitializationError do
+        buckets = {to: 'neato'}
+        Client.new(@options.merge(buckets: buckets))
+      end
+    end
+
+    it "should not be possible to initialize a client with missing queue information" do
+      assert_raises Client::InitializationError do
+        Client.new(@options.except(:queues))
+      end
+    end
+
+    it "should not be possible to initialize a client with partial queue information" do
+      assert_raises Client::InitializationError do
+        queues = {inventory: 'neato'}
+        Client.new(@options.merge(queues: queues))
+      end
+    end
+
+    it "should raise an error if the bucket names are invalid" do
+      AWS::S3::Bucket.any_instance.expects(:exists?).returns(false)
+      assert_raises Client::InvalidBucketError do
+        @client.to_quiet_bucket
+      end
+    end
+
+    it "should raise an error if the queue names are invalid" do
+      AWS::SQS::Queue.any_instance.expects(:exists?).returns(false)
+      assert_raises Client::InvalidQueueError do
+        @client.to_quiet_queue
+      end
+    end
+  end
+end

data/spec/unit/documents/document_spec.rb

@@ -0,0 +1,44 @@
+module Hushed
+  module Documents
+    module DocumentInterfaceTestcases
+
+      def test_it_should_be_able_to_generate_a_filename
+        assert bn = @object.business_unit
+        assert type = @object.type
+        assert number = @object.document_number
+        assert date = @object.date.strftime("%Y%m%d_%H%M%S")
+        expected_filename = "#{bn}_#{type}_#{number}_#{date}.xml"
+        assert_equal expected_filename, @object.filename
+      end
+
+      def test_it_should_respond_to_warehouse
+        assert @object.respond_to?(:warehouse), "#{@object.class} does not respond to #warehouse"
+      end
+
+      def test_it_should_be_initializable_with_a_hash
+        begin
+          @object.class.new(:thinger => 123)
+        rescue TypeError
+          flunk "It should be possible to initialize #{@object.class} with an args hash"
+        rescue StandardError
+        end
+      end
+
+    end
+  end
+
+  describe "DocumentDouble" do
+    include Documents::DocumentInterfaceTestcases
+
+    before do
+      @object = DocumentDouble.new(
+        :message_id => '1234567',
+        :date => Time.new(2013, 04, 05, 12, 30, 15).utc,
+        :client => @client,
+        :type => 'Thinger',
+        :business_unit => 'HUSHED',
+        :document_number => '123456'
+      )
+    end
+  end
+end

data/spec/unit/documents/request/shipment_order_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+require 'hushed/documents/request/shipment_order'
+
+module Hushed
+  module Documents
+    module Request
+      describe "ShipmentOrder" do
+        include Hushed::Documents::DocumentInterfaceTestcases
+
+        before do
+          @order = OrderDouble.example
+          @client = ClientDouble.new(:client_id => 'HUSHED', :business_unit => 'HUSHED', :warehouse => 'SPACE')
+          @object = @shipment_order = ShipmentOrder.new(:order => @order, :client => @client)
+        end
+
+        it "should be possible to initialize a ShipmentOrder" do
+          shipment_order = ShipmentOrder.new(:order => @order, :client => @client)
+          assert_equal @order, shipment_order.order
+        end
+
+        it "should raise an error if an order wasn't passed in" do
+          assert_raises ShipmentOrder::MissingOrderError do
+            ShipmentOrder.new
+          end
+        end
+
+        it "should be able to generate an XML document" do
+          message = ShipmentOrder.new(:order => @order, :client => @client)
+          document = Nokogiri::XML::Document.parse(message.to_xml)
+
+          expected_namespaces = {'xmlns' => ShipmentOrder::NAMESPACE}
+          assert_equal expected_namespaces, document.collect_namespaces()
+
+          assert_equal 1, document.css('ShipOrderDocument').length
+
+          assert_equal @client.client_id, document.css('ClientID').first.text
+          assert_equal @client.business_unit, document.css('BusinessUnit').first.text
+
+          assert_header(document.css('OrderHeader').first)
+          assert_equal @order.note, document.css('Comments').first.text
+
+          assert_shipping(document.css('ShipMode').first)
+
+          assert_address(@order.email, @order.shipping_address, document.css('ShipTo').first)
+          assert_address(@order.email, @order.billing_address, document.css('BillTo').first)
+
+          assert_equal @order.total_price.to_s, document.css('DeclaredValue').first.text
+
+          order_details = document.css('OrderDetails')
+          assert_equal 1, order_details.length
+          assert_line_item(@order.line_items.first, order_details.first)
+        end
+
+        private
+        def assert_header(header)
+          assert_equal "#{@order.id}", header['OrderNumber']
+          assert_equal @order.created_at.utc.to_s, header['OrderDate']
+          assert_equal @order.created_at.utc.to_s, header['ShipDate']
+          assert_equal @order.type, header['OrderType']
+        end
+
+        def assert_shipping(shipping)
+          assert_equal 'FEDEX', shipping['Carrier']
+          assert_equal 'GROUND', shipping['ServiceLevel']
+        end
+
+        def assert_line_item(expected_line_item, line_item)
+          assert_equal expected_line_item.id.to_s, line_item['ItemNumber']
+          assert_equal "1", line_item['Line']
+          assert_equal expected_line_item.quantity.to_s, line_item['QuantityOrdered']
+          assert_equal expected_line_item.quantity.to_s, line_item['QuantityToShip']
+          assert_equal expected_line_item.unit_of_measure, line_item['UOM']
+          assert_equal expected_line_item.price, line_item['Price']
+        end
+
+        def assert_address(email, address, node)
+          assert_equal address.company, node['Company']
+          assert_equal address.name, node['Contact']
+          assert_equal address.address1, node['Address1']
+          assert_equal address.address2, node['Address2']
+          assert_equal address.city, node['City']
+          assert_equal address.province_code, node['State']
+          assert_equal address.zip, node['PostalCode']
+          assert_equal address.country_code, node['Country']
+          assert_equal email, node['Email']
+        end
+      end
+    end
+  end
+end

data/spec/unit/documents/response/shipment_order_result_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'hushed/documents/response/shipment_order_result'
+
+module Hushed
+  module Documents
+    module Response
+      describe "ShipmentOrderResult" do
+        include Fixtures
+
+        it "should be able to successfully parse a response document" do
+          document = load_response('shipment_order_result')
+          order_result = ShipmentOrderResult.new(io: document)
+
+          assert_equal 'HUSHED', order_result.client_id
+          assert_equal 'HUSHED', order_result.business_unit
+          assert_equal 1, order_result.carton_count
+          assert_equal Time.new(2009, 9, 1, 0, 0, 0).utc, order_result.date_shipped
+
+          assert_equal "40000000000", order_result.tracking_number
+          assert_equal "FIRST", order_result.service_level
+          assert_equal "USPS", order_result.carrier
+        end
+      end
+    end
+  end
+end

data/spec/unit/message_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'hushed/message'
+
+module Hushed
+  describe "Message" do
+    include Fixtures
+    before do
+      prepare_models
+    end
+
+    it "should be possible to initialize a Message" do
+      message = Message.new(:document => @document, :client => @client)
+      assert_equal @document, message.document
+      assert_equal @client, message.client
+    end
+
+    it "should raise an error if the document is missing when trying to generate XML" do
+      message = Message.new(:client => @client)
+      assert_raises Message::MissingDocumentError do
+        message.to_xml
+      end
+    end
+
+    it "should raise an error if the client is missing when trying to generate XML" do
+      message = Message.new(:document => @document)
+      assert_raises Message::MissingClientError do
+        message.to_xml
+      end
+    end
+
+    it "should be possible to create a Message with XML and query it for information" do
+      message = Message.new(:xml => load_message('purchase_order_message'))
+
+      assert_equal 'PurchaseOrder', message.document_type
+      assert_equal 'HUSHED_PurchaseOrder_1234_20100927_132505124.xml', message.document_name
+    end
+
+    it "should be able to generate an XML document" do
+      message = Message.new(:document => @document, :client => @client)
+      document = Nokogiri::XML::Document.parse(message.to_xml)
+
+      expected_namespaces = {'xmlns' => Message::NAMESPACE}
+      assert_equal expected_namespaces, document.collect_namespaces()
+
+      assert node = document.css('EventMessage').first
+      assert_equal @document.type, node['DocumentType']
+      assert_equal @document.filename, node['DocumentName']
+      assert_equal @document.warehouse, node['Warehouse']
+      assert_equal @document.date.utc.to_s, node['MessageDate']
+      assert_equal @document.message_id, node['MessageId']
+
+      assert_equal @client.client_id, node['ClientId']
+      assert_equal @client.business_unit, node['BusinessUnit']
+    end
+
+    def prepare_models
+      @document = DocumentDouble.new(
+        type: "PurchaseOrder",
+        filename: "abracadabra.xml",
+        message_id: "alakazam",
+        warehouse: "Onett1",
+        date: Time.new(2013, 4, 1, 12, 30, 0)
+      )
+
+      @client = ClientDouble.new(
+        client_id: 'HUSHED',
+        business_unit: 'HUSHED'
+      )
+    end
+  end
+end

data/spec/unit/queue_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'hushed/queue'
+
+module Hushed
+  describe "Queue" do
+    include Fixtures
+    before do
+      @sqs_queue = mock()
+
+      @client = mock()
+      @client.stubs(:to_quiet_queue).returns(@sqs_queue)
+      @client.stubs(:from_quiet_queue).returns(@sqs_queue)
+      @client.stubs(:quiet_inventory_queue).returns(@sqs_queue)
+
+      @message = mock()
+
+      @queue = Queue.new(@client)
+    end
+
+    it "should be able to write a message to a queue" do
+      @message.stubs(:to_xml).returns('hello world')
+      @sqs_queue.expects(:send_message).with('hello world')
+
+      @queue.send(@message)
+    end
+
+    it "should return a message when receiving from a queue" do
+      @message.stubs(:body).returns(load_message('purchase_order_message'))
+      @sqs_queue.expects(:receive_message).yields(@message)
+
+      received_message = @queue.receive
+      assert_equal 'PurchaseOrder', received_message.document_type
+      assert_equal 'HUSHED_PurchaseOrder_1234_20100927_132505124.xml', received_message.document_name
+    end
+
+    it "should return a message when receiving even if the queue did not return anything" do
+      @sqs_queue.expects(:receive_message)
+
+      received_message = @queue.receive
+      assert_equal false, received_message.nil?
+    end
+
+    it "should be possible to get an approximate number of pending messages" do
+      @sqs_queue.expects(:approximate_number_of_messages).returns(10)
+      assert_equal 10, @queue.approximate_pending_messages
+    end
+  end
+end

metadata

@@ -0,0 +1,207 @@
+--- !ruby/object:Gem::Specification
+name: hushed
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Saunders
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: aws-sdk
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+    none: false
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: nokogiri
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: activesupport
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: bundler
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: rake
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: minitest
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    none: false
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: mocha
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+description: API Client for Quiet Logistics Services
+email:
+- chris.saunders@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hushed.gemspec
+- lib/hushed.rb
+- lib/hushed/blackboard.rb
+- lib/hushed/client.rb
+- lib/hushed/documents/document.rb
+- lib/hushed/documents/request/shipment_order.rb
+- lib/hushed/documents/response/shipment_order_result.rb
+- lib/hushed/message.rb
+- lib/hushed/queue.rb
+- lib/hushed/request.rb
+- lib/hushed/response.rb
+- lib/hushed/version.rb
+- spec/fixtures/credentials.yml
+- spec/fixtures/documents/responses/shipment_order_result.xml
+- spec/fixtures/messages/purchase_order_message.xml
+- spec/remote/blackboard_spec.rb
+- spec/remote/queue_spec.rb
+- spec/spec_helper.rb
+- spec/unit/blackboard_spec.rb
+- spec/unit/client_spec.rb
+- spec/unit/documents/document_spec.rb
+- spec/unit/documents/request/shipment_order_spec.rb
+- spec/unit/documents/response/shipment_order_result_spec.rb
+- spec/unit/message_spec.rb
+- spec/unit/queue_spec.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 757848764150941350
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 757848764150941350
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Integrates with QL Blackboard and work Queue
+test_files:
+- spec/fixtures/credentials.yml
+- spec/fixtures/documents/responses/shipment_order_result.xml
+- spec/fixtures/messages/purchase_order_message.xml
+- spec/remote/blackboard_spec.rb
+- spec/remote/queue_spec.rb
+- spec/spec_helper.rb
+- spec/unit/blackboard_spec.rb
+- spec/unit/client_spec.rb
+- spec/unit/documents/document_spec.rb
+- spec/unit/documents/request/shipment_order_spec.rb
+- spec/unit/documents/response/shipment_order_result_spec.rb
+- spec/unit/message_spec.rb
+- spec/unit/queue_spec.rb