blastramp 0.0.3 → 0.0.4

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    blastramp (0.0.2)
+    blastramp (0.0.3)
 
 GEM
   remote: http://rubygems.org/
   specs:
+    activesupport (3.0.8)
     builder (3.0.0)
     crack (0.1.8)
     diff-lcs (1.1.2)
@@ -39,6 +40,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport (~> 3.0.3)
   blastramp!
   mocha (~> 0.9.8)
   rspec (~> 2.3.0)

data/README.md

@@ -22,16 +22,13 @@ Usage example
     inventory_count.total_shipped
     
     # Create order:
-    order = Blastramp::OrderUpload.new
-    order.session = blastramp
+    order = Blastramp::Order.new
 
     order.order_id = '123'
     order.order_date = Time.now.strftime("%m/%d/%Y")
     order.start_date = Time.now.strftime("%m/%d/%Y")
     order.expiry_date = 1.month.from_now.strftime("%m/%d/%Y")
-    order.num_of_cartons = 1
-    order.weight = 1
-    order.ship_method = order.shipping_service
+    order.ship_method = 'UPS Worldwide Standard'
     order.warehouse_id = '0001'
 
     ship_address = Blastramp::Address.new
@@ -40,20 +37,20 @@ Usage example
     ship_address.line2 = 'Apt 205'
     ship_address.city = 'Springfield'
     ship_address.provstate = 'IL'
-    ship_address.postalcode = '45678'
     ship_address.country = 'USA'
     ship_address.phone = '555-555-5555'
     order.ship_address = ship_address
+    order.bill_address = ship_address
 
     order_item = Blastramp::OrderItem.new
     order_item.order_id = '123'
     order_item.sku = 'AAA-01-XX'
     order_item.quantity = 2
     order_item.item_value = 12.99
-    order_item.warehouse_id = '0001'
     order.order_items << order_item
 
-    order.save
+    order_upload = Blastramp::OrderUpload.new(blastramp, order)
+    order_upload.submit
     
 Credits
 -------

data/blastramp.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_development_dependency "activesupport", "~> 3.0.3"
   s.add_development_dependency "rspec", "~> 2.3.0"
   s.add_development_dependency "mocha", "~> 0.9.8"
   s.add_development_dependency "savon", "~> 0.8.0.beta.3"

data/lib/blastramp.rb

@@ -1,8 +1,15 @@
-$LOAD_PATH << File.expand_path(File.join(*%w[ .. lib ]), File.dirname(__FILE__))
+require 'active_support/ordered_hash'
 require 'savon'
+
+$LOAD_PATH << File.expand_path(File.join(*%w[ .. lib ]), File.dirname(__FILE__))
 require 'ext'
+require 'blastramp/entity'
+require 'blastramp/address'
 require 'blastramp/inventory_count'
 require 'blastramp/inventory_count_query'
+require 'blastramp/order'
+require 'blastramp/order_item'
+require 'blastramp/order_upload'
 require 'blastramp/session'
 
 module Blastramp

data/lib/blastramp/address.rb

@@ -0,0 +1,41 @@
+module Blastramp
+  class Address < Entity
+    has_properties :name, :line1, :line2, :line3, :city, :provstate, :country, :phone, :fax, :email, :web, :contact
+    
+    def initialize_defaults
+      self.name = '' # Name as it appears on the ship to address label.
+      self.line1 = '' # Street information (line 1) to appear on the ship to address label. Max total length of line1, line2 and line3 is 200 character
+      self.line2 = ''
+      self.line3 = ''
+      self.city = '' # City name as on the ship to address label
+      self.provstate = '' # Province/State as it appears on the ship to address label
+      self.country = 'CA' # Country name as it appears on the ship to address label.
+      self.phone = '--' # Phone number (any format). If not known submit "--"
+      self.fax = '--' # Fax number (any format). If not known submit "--"
+      self.email = '--' # Email address. If not known submit "--"
+      self.web = '--' # Web site URL If not known submit "--"
+      self.contact = '' # Contact person's full name at the location.
+    end
+    
+    # Returns OrderedHash with the properties of Address in the correct order, camelcased and ready
+    # to be sent via SOAP
+    def soap_data
+      data = ActiveSupport::OrderedHash.new
+      data['name'] = name 
+      data['line1'] = line1
+      data['line2'] = line2
+      data['line3'] = line3
+      data['city'] = city
+      data['provstate'] = provstate
+      data['country'] = country
+      data['phone'] = phone
+      data['fax'] = fax
+      data['email'] = email
+      data['web'] = web
+      data['contact'] = contact
+            
+      return data
+    end
+    
+  end
+end

data/lib/blastramp/entity.rb

@@ -0,0 +1,53 @@
+module Blastramp
+  class Entity
+    # Internal accessors
+    attr_accessor :session
+
+    class << self
+      def has_properties(*properties)
+        @properties = properties
+        properties.each do |property|
+          unless instance_methods.collect(&:to_s).include?(property.to_s)
+            # Create property accessors that loads the full Entity from the API if necessary
+            define_method "#{property}" do
+              instance_variable_get("@#{property}")
+            end
+          end
+
+          # Just use regular writers
+          attr_writer property
+        end
+      end
+
+      def properties
+        @properties || []
+      end
+    end
+
+    def initialize(values = {})
+      initialize_defaults
+      update_properties(values)
+    end
+
+    def initialize_defaults
+      nil
+    end
+
+    def inspect
+      props = self.class.properties.collect { |p| "#{p}=#{self.send(p).inspect}" }
+      "#<#{self.class}:#{self.object_id}, #{props.join(', ')}>"
+    end
+
+    # Updates properties of Entity with the values from hash
+    def update_properties(hash)
+      hash.each do |key, value|
+        self.send("#{key}=", value)
+      end
+    end
+  
+    # Returns OrderedHash with the data structure to send to the API
+    def soap_data
+    end
+    
+  end
+end

data/lib/blastramp/inventory_count_query.rb

@@ -16,7 +16,8 @@ module Blastramp
 
     def find(sku)
       # Get a list of InventoryCounts from Blastramp
-      response = session.request 'InventoryCountQuery' do
+      endpoint = "http://www.ioperate.net/ws/order/orderws.asmx?wsdl"
+      response = session.request endpoint, 'InventoryCountQuery' do
         http.headers["SOAPAction"] = "http://chrome52/webservices/InventoryCountQuery" 
         
         soap.body = {

data/lib/blastramp/order.rb

@@ -0,0 +1,65 @@
+module Blastramp
+  class Order < Entity
+    has_properties :order_id, :po, :order_date, :start_date, :expiry_date, :num_of_cartons, :weight, :ship_method, :order_terms, :order_type, :order_currency, :order_tax, :warehouse_currency, :warehouse_id, :note, :season
+    
+    # Associations
+    attr_accessor :order_items, :ship_address, :bill_address
+
+    def initialize
+      super
+      @order_items = []
+      @ship_address = Blastramp::Address.new
+      @bill_address = Blastramp::Address.new
+    end
+    
+    def initialize_defaults
+      self.order_id = 0 # The order number. If it is to be determined by Blastramp then submit "TBD"
+      self.po = 0 #  Customer purchase order number
+      self.order_date = Time.now.strftime("%m/%d/%Y") # The order date as dd/mm/yyyy
+      self.start_date = Time.now.strftime("%m/%d/%Y") # The orders start date as dd/mm/yyyy. The earliest date the order is expected to be released to the warehouse
+      self.expiry_date = (Time.now + 186400).strftime("%m/%d/%Y") #  The orders expiry date as dd/mm/yyyy. The latest date the order would be released to the warehouse
+      self.num_of_cartons = 0 #N umber of cartons expected in the order. Unknown (and default) is "0"
+      self.weight = 0.0 # Estimated weight of the order. Unknown (and default) is "0.0"
+      self.ship_method = nil #  Description of the desired shipping method. More detail is better: if known submit carrier, service description and service code. A list of valid values to be used must be provided to Blastramp
+      self.order_terms = "Terms Unknown" #  Description of the order terms. Unknown (and default) "Terms Unknown"
+      self.order_type = 'P' # P := Pick and Pack. C := Crossdock.
+      self.order_currency = 'CAD' #  IATA Currency of the order. Default is "CAD"
+      self.order_tax = nil # Tax rate to be applied to the order. Default is the current Canada GST rate.
+      self.warehouse_currency = 'CAD' # IATA used by the warehouse DC. Default is "CAD"
+      self.warehouse_id = '0001'  # The iOperate identifier for the DC handling the order. Default is "0001"
+      self.note = nil #  Other notes or instructions to be attached to the order
+      self.season = nil # The season code to which the order would apply. All available code must be provided to Chrome52
+    end
+    
+    # Returns OrderedHash with the properties of CurrentInvoice in the correct order, camelcased and ready
+    # to be sent via SOAP
+    def soap_data
+      data = ActiveSupport::OrderedHash.new
+      data['orderid'] = order_id
+      data['po'] = po
+      data['orderDate'] = order_date
+      data['startDate'] = start_date
+      data['expiryDate'] = expiry_date
+      data['numOfCartons'] = num_of_cartons
+      data['weight'] = weight
+      data['shipMethod'] = ship_method
+      data['orderTerms'] = order_terms
+      data['orderType'] = order_type
+      data['orderCurrency'] = order_currency
+      data['orderTax'] = order_tax
+      data['warehouseCurrency'] = warehouse_currency
+      data['warehouseid'] = warehouse_id
+      data['note'] = note
+      data['season'] = season
+      data['shipAddress'] = ship_address.soap_data
+      data['billAddress'] = bill_address.soap_data
+      data['orderItems'] = []
+      order_items.each do |i|
+        data['orderItems'] << {'OrderItem' => i.soap_data}
+      end
+      
+      return data
+    end
+    
+  end
+end

data/lib/blastramp/order_item.rb

@@ -0,0 +1,33 @@
+module Blastramp
+  class OrderItem < Entity
+    has_properties :order_id, :sku, :quantity, :item_value, :line_note, :carton, :warehouse_id, :category_id
+    
+    def initialize_defaults
+      self.order_id = 0 #  The orderID. Should equal the orderID in the Order
+      self.sku = 0 #  The item sku as in the item list as provided to Blastramp
+      self.quantity = 0 # Quantity of this item included in the order
+      self.item_value = 0.0 # Monetary value of each item in the order currency.
+      self.line_note = '' # Other notes or instructions attached to this order item.
+      self.carton = '' # Carton identifier for a cross dock order.
+      self.warehouse_id = '0001' #  The iOperate identifier for the DC handling the order (should be the same as in the order). Default is "0001"
+      self.category_id = '0001' #  The inventory category id to which this product type belongs. Default is "0001"
+    end
+    
+    # Returns OrderedHash with the properties of CurrentInvoice in the correct order, camelcased and ready
+    # to be sent via SOAP
+    def soap_data
+      data = ActiveSupport::OrderedHash.new
+      data['orderid'] = order_id
+      data['sku'] = sku
+      data['quantity'] = quantity
+      data['itemValue'] = item_value
+      data['lineNote'] = line_note
+      data['carton'] = carton
+      data['warehouseid'] = warehouse_id
+      data['categoryid'] = category_id
+
+      return data
+    end
+    
+  end
+end

data/lib/blastramp/order_upload.rb

@@ -0,0 +1,26 @@
+module Blastramp
+  class OrderUpload
+    # Associations
+    attr_reader :session
+    attr_reader :order
+
+    def initialize(session, order)
+      @session = session
+      @order = order
+    end
+    
+    def submit
+      # Submit order upload to Blastramp
+      endpoint = "http://www.ioperate.net/ws/order/orderws.asmx?wsdl"
+      response = session.request endpoint, 'OrderUpload' do
+        http.headers["SOAPAction"] = "http://chrome52/webservices/OrderUpload" 
+        
+        soap.body = {
+          'VendorCode' => session.vendor_code,
+          'VendorAccessKey' => session.vendor_access_key,
+          'Batch' => {:order => order.soap_data}
+        }
+      end
+    end
+  end
+end

data/lib/blastramp/session.rb

@@ -1,16 +1,19 @@
 module Blastramp
   class Session
     attr_accessor :vendor_code, :vendor_access_key
+    attr_accessor :endpoint
     
     def initialize(vendor_code, vendor_access_key)
       self.vendor_code = vendor_code
       self.vendor_access_key = vendor_access_key
+      self.endpoint = nil
     end
     
     # Returns the Savon::Client used to connect to Blastramp
     def client      
       @client ||= Savon::Client.new do
-        wsdl.document = "http://www.ioperate.net/ws/inventory/inventoryws.asmx?wsdl"
+        wsdl.document = self.endpoint
+        # wsdl.document = "http://www.ioperate.net/ws/inventory/inventoryws.asmx?wsdl"
         # 
         # wsdl.endpoint = "http://www.ioperate.net/ws/inventory/inventoryws.asmx"
         # wsdl.namespace = "http://chrome52/webservices"
@@ -22,7 +25,8 @@ module Blastramp
       @inventory_counts ||= InventoryCountQuery.new(self)
     end
     
-    def request(action, &block)
+    def request(ep, action, &block)
+      self.endpoint = ep
       response = client.request :soap, action, &block
       response_hash = response.to_hash
       action = action.snake_case

data/lib/blastramp/version.rb

@@ -1,3 +1,4 @@
 module Blastramp
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end
+

data/spec/blastramp/address_spec.rb

@@ -0,0 +1,10 @@
+require './spec/spec_helper'
+
+describe Blastramp::Address do
+  let(:session) { stub_session }
+  subject { Blastramp::Address }
+
+  it "inherits from Blastramp::Entity" do
+    Blastramp::Address.ancestors.should include(Blastramp::Entity)
+  end
+end

data/spec/blastramp/entity_spec.rb

@@ -0,0 +1,49 @@
+require './spec/spec_helper'
+
+class SpecEntity < Blastramp::Entity
+  has_properties :foo, :baz
+
+  def existing_method; end
+end
+
+describe Blastramp::Entity do
+  let(:session) { stub_session }
+
+  describe "class methods" do
+    subject { SpecEntity }
+
+    describe "new" do
+      subject { Blastramp::Entity.new }
+
+      it "creates a new instance" do
+        subject.should be_instance_of(Blastramp::Entity)
+      end
+
+      it "initializes the entity with values from the given hash" do
+        entity = SpecEntity.new(:foo => 'bar', :baz => 'qux')
+        entity.foo.should == 'bar'
+        entity.baz.should == 'qux'
+      end
+    end
+
+    describe "has_properties" do
+      it "creates getter for all properties" do
+        subject.expects(:define_method).with('name')
+        subject.expects(:define_method).with('age')
+        subject.has_properties :name, :age
+      end
+
+      it "creates setter for all properties" do
+        subject.expects(:attr_writer).with(:name)
+        subject.expects(:attr_writer).with(:age)
+        subject.has_properties :name, :age
+      end
+
+      it "does not clobber existing methods" do
+        subject.expects(:define_method).with('existing_method').never
+        subject.has_properties :existing_method
+      end
+
+    end
+  end
+end

data/spec/blastramp/order_item_spec.rb

@@ -0,0 +1,10 @@
+require './spec/spec_helper'
+
+describe Blastramp::OrderItem do
+  let(:session) { stub_session }
+  subject { Blastramp::OrderItem }
+
+  it "inherits from Blastramp::Entity" do
+    Blastramp::OrderItem.ancestors.should include(Blastramp::Entity)
+  end
+end

data/spec/blastramp/order_spec.rb

@@ -0,0 +1,16 @@
+require './spec/spec_helper'
+
+describe Blastramp::Order do
+  subject { Blastramp::Order.new }
+
+  it "inherits from Blastramp::Entity" do
+    Blastramp::Order.ancestors.should include(Blastramp::Entity)
+  end
+
+  describe "new" do
+    it "initializes order_items as an empty array" do
+      subject.order_items.should == []
+    end
+  end
+
+end

data/spec/blastramp/order_upload_spec.rb

@@ -0,0 +1,25 @@
+require './spec/spec_helper'
+
+describe Blastramp::OrderUpload do
+  let(:session) { stub_session }
+  let(:order) { stub_order }
+  subject { Blastramp::OrderUpload.new(session, order) }
+
+  describe "new" do
+    it "stores session" do
+      subject.session.should === session
+    end
+  end
+  
+  describe "order_upload" do
+
+    it "uses OrderUpload on API" do
+      savon.expects('OrderUpload').with(
+        'VendorCode' => 'ABC', 
+        'VendorAccessKey' => 'TWX45IX2R9G35394', 
+        'Batch' => {:order => order.soap_data}).returns(:success)
+      subject.submit
+    end    
+  end
+
+end

data/spec/fixtures/order_upload/success.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+  <soap:Body>
+    <OrderUploadResponse xmlns="http://chrome52/webservices/">
+      <OrderUploadResult>
+        <result>SUCCESS</result>
+        <error/>
+        <orderids>
+          <string>12345</string>
+          <string>67890</string>
+        </orderids>
+      </OrderUploadResult>
+    </OrderUploadResponse>
+  </soap:Body>
+</soap:Envelope>

data/spec/spec_helper.rb

@@ -34,3 +34,8 @@ end
 def stub_session
   Blastramp::Session.new('ABC', 'TWX45IX2R9G35394')
 end
+
+def stub_order
+  order = Blastramp::Order.new
+end
+

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - cnantais
@@ -18,9 +18,24 @@ date: 2011-06-29 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: activesupport
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -31,11 +46,11 @@ dependencies:
         - 0
         version: 2.3.0
   type: :development
-  version_requirements: *id001
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: mocha
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -46,11 +61,11 @@ dependencies:
         - 8
         version: 0.9.8
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: savon
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -63,11 +78,11 @@ dependencies:
         - 3
         version: 0.8.0.beta.3
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: savon_spec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -78,7 +93,7 @@ dependencies:
         - 6
         version: 0.1.6
   type: :development
-  version_requirements: *id004
+  version_requirements: *id005
 description: Blastramp Shipping Services Client Library for polling inventory and submitting shipping orders.
 email: 
 - cnantais@gmail.com
@@ -97,14 +112,25 @@ files:
 - Rakefile
 - blastramp.gemspec
 - lib/blastramp.rb
+- lib/blastramp/address.rb
+- lib/blastramp/entity.rb
 - lib/blastramp/inventory_count.rb
 - lib/blastramp/inventory_count_query.rb
+- lib/blastramp/order.rb
+- lib/blastramp/order_item.rb
+- lib/blastramp/order_upload.rb
 - lib/blastramp/session.rb
 - lib/blastramp/version.rb
 - lib/ext.rb
+- spec/blastramp/address_spec.rb
+- spec/blastramp/entity_spec.rb
 - spec/blastramp/inventory_count_query_spec.rb
+- spec/blastramp/order_item_spec.rb
+- spec/blastramp/order_spec.rb
+- spec/blastramp/order_upload_spec.rb
 - spec/blastramp/session_spec.rb
 - spec/fixtures/inventory_count_query/many.xml
+- spec/fixtures/order_upload/success.xml
 - spec/fixtures/wsdl.xml
 - spec/spec_helper.rb
 has_rdoc: true
@@ -140,8 +166,14 @@ signing_key:
 specification_version: 3
 summary: Blastramp Shipping Services Client Library
 test_files: 
+- spec/blastramp/address_spec.rb
+- spec/blastramp/entity_spec.rb
 - spec/blastramp/inventory_count_query_spec.rb
+- spec/blastramp/order_item_spec.rb
+- spec/blastramp/order_spec.rb
+- spec/blastramp/order_upload_spec.rb
 - spec/blastramp/session_spec.rb
 - spec/fixtures/inventory_count_query/many.xml
+- spec/fixtures/order_upload/success.xml
 - spec/fixtures/wsdl.xml
 - spec/spec_helper.rb