rex11 0.0.2 → 0.1.0

data/spec/lib/client_spec.rb

@@ -0,0 +1,341 @@
+require 'spec_helper'
+
+describe Rex11::Client do
+  before do
+    @client = Rex11::Client.new("the_username", "the_password", "the_web_address")
+  end
+
+  context "authenticate" do
+    context "request" do
+      it "should form correct request" do
+        @client.should_receive(:commit).with(squeeze_xml(xml_fixture("authentication_token_get_request"))).and_return(xml_fixture("authentication_token_get_response_success"))
+        @client.authenticate
+      end
+    end
+
+    context "response" do
+      context "success" do
+        before do
+          @client.should_receive(:commit).and_return(xml_fixture("authentication_token_get_response_success"))
+        end
+
+        it "should set auth_token" do
+          @client.authenticate
+          @client.auth_token.should == "4vxVebc3D1zwsXjH9fkFpgpOhewauJbVu25WXjQ1gOo="
+        end
+
+        it "should return true" do
+          @client.authenticate.should be_true
+        end
+      end
+
+      context "error" do
+        it "should raise error and not set auth_token" do
+          @client.should_receive(:commit).and_return(xml_fixture("authentication_token_get_response_error"))
+
+          lambda {
+            @client.authenticate
+          }.should raise_error("Failed Authentication due invalid username, password, or endpoint")
+          @client.auth_token.should be_nil
+        end
+      end
+    end
+  end
+
+  context "add_style" do
+    before do
+      @item = {
+          :style => "the_style",
+          :upc => "the_upc",
+          :size => "the_size",
+          :price => "the_price",
+          :color => "the_color",
+          :description => "the_description"
+      }
+
+      @client.auth_token = "4vxVebc3D1zwsXjH9fkFpgpOhewauJbVu25WXjQ1gOo="
+    end
+
+    it "should require_auth_token" do
+      @client.should_receive(:commit).and_return(xml_fixture("style_master_product_add_response_success"))
+      @client.should_receive(:require_auth_token)
+      @client.add_style(@item)
+    end
+
+    context "request" do
+      it "should form correct request" do
+        @client.should_receive(:commit).with(squeeze_xml(xml_fixture("style_master_product_add_request"))).and_return(xml_fixture("style_master_product_add_response_success"))
+        @client.add_style(@item)
+      end
+    end
+
+    context "response" do
+      context "when success" do
+        it "should return true" do
+          @client.should_receive(:commit).and_return(xml_fixture("style_master_product_add_response_success"))
+          @client.add_style(@item).should == true
+        end
+      end
+
+      context "when error" do
+        it "should raise error" do
+          @client.should_receive(:commit).and_return(xml_fixture("style_master_product_add_response_error"))
+          lambda {
+            @client.add_style(@item)
+          }.should raise_error("Error 31: COLOR[item 1] is not valid. Error 43: PRICE[item 1] is not valid. Error 31: COLOR[item 2] is not valid. Error 31: COLOR[item 4] is not valid. ")
+        end
+      end
+    end
+  end
+
+  context "create_pick_ticket" do
+    before do
+      @items = [
+          {:upc => "the_upc1", :quantity => 1},
+          {:upc => "the_upc2", :quantity => 2}
+      ]
+
+      @ship_to_address = {:first_name => "the_ship_to_first_name",
+                          :last_name => "the_ship_to_last_name",
+                          :company_name => "the_ship_to_company_name",
+                          :address1 => "the_ship_to_address1",
+                          :address2 => "the_ship_to_address2",
+                          :city => "the_ship_to_city",
+                          :state => "the_ship_to_state",
+                          :zip => "the_ship_to_zip",
+                          :country => "the_ship_to_country",
+                          :phone => "the_ship_to_phone",
+                          :email => "the_ship_to_email"
+      }
+
+      @pick_ticket_options = {
+          :pick_ticket_id => "23022012012557",
+          :warehouse => "the_warehouse",
+          :payment_terms => "NET",
+          :use_ups_account => "1",
+          :ship_via_account_number => "1AB345",
+          :ship_via => "UPS",
+          :ship_service => "UPS GROUND - Commercial",
+          :billing_option => "PREPAID",
+          :bill_to_address => {
+              :first_name => "the_bill_to_first_name",
+              :last_name => "the_bill_to_last_name",
+              :company_name => "the_bill_to_company_name",
+              :address1 => "the_bill_to_address1",
+              :address2 => "the_bill_to_address2",
+              :city => "the_bill_to_city",
+              :state => "the_bill_to_state",
+              :zip => "the_bill_to_zip",
+              :country => "the_bill_to_country",
+              :phone => "the_bill_to_phone",
+              :email => "the_bill_to_email"
+          }
+      }
+
+      @client.auth_token = "4vxVebc3D1zwsXjH9fkFpgpOhewauJbVu25WXjQ1gOo="
+    end
+
+    it "should require_auth_token" do
+      @client.should_receive(:commit).and_return(xml_fixture("pick_ticket_add_response_success"))
+      @client.should_receive(:require_auth_token)
+      @client.create_pick_ticket(@items, @ship_to_address, @pick_ticket_options)
+    end
+
+    context "request" do
+      it "should form correct request" do
+        @client.should_receive(:commit).with(squeeze_xml(xml_fixture("pick_ticket_add_request"))).and_return(xml_fixture("pick_ticket_add_response_success"))
+        @client.create_pick_ticket(@items, @ship_to_address, @pick_ticket_options)
+      end
+    end
+
+    context "response" do
+      context "when success" do
+        it "should return true" do
+          @client.should_receive(:commit).and_return(xml_fixture("pick_ticket_add_response_success"))
+          @client.create_pick_ticket(@items, @ship_to_address, @pick_ticket_options).should == true
+        end
+      end
+
+      context "when error" do
+        it "should raise error" do
+          @client.should_receive(:commit).and_return(xml_fixture("pick_ticket_add_response_error"))
+          lambda {
+            @client.create_pick_ticket(@items, @ship_to_address, @pick_ticket_options)
+          }.should raise_error("Error 56: PickTicket/ShipVia is not valid. Error 61: PickTicket/ShipService is not valid. Error 10: State for ShipToAddress is required for USA. ")
+        end
+      end
+    end
+  end
+
+  context "cancel pick ticket" do
+    before do
+      @pick_ticket_id = "the_pick_ticket_id"
+      @client.auth_token = "4vxVebc3D1zwsXjH9fkFpgpOhewauJbVu25WXjQ1gOo="
+    end
+
+    it "should require_auth_token" do
+      @client.should_receive(:commit).and_return(xml_fixture("cancel_pick_ticket_response_success"))
+      @client.should_receive(:require_auth_token)
+      @client.cancel_pick_ticket(@pick_ticket_id)
+    end
+
+    context "request" do
+      it "should form correct request" do
+        @client.should_receive(:commit).with(squeeze_xml(xml_fixture("cancel_pick_ticket_request"))).and_return(xml_fixture("cancel_pick_ticket_response_success"))
+        @client.cancel_pick_ticket(@pick_ticket_id)
+      end
+    end
+
+    context "response" do
+      context "when success" do
+        it "should return hash" do
+          @client.should_receive(:commit).and_return(xml_fixture("cancel_pick_ticket_response_success"))
+          @client.cancel_pick_ticket(@pick_ticket_id).should == true
+        end
+      end
+
+      context "when error" do
+        it "should raise error" do
+          @client.should_receive(:commit).and_return(xml_fixture("cancel_pick_ticket_response_error"))
+          lambda {
+            @client.cancel_pick_ticket(@pick_ticket_id)
+          }.should raise_error("Error 45: PickTicket can not be cancelled. Error 45: PickTicket does not exist. ")
+        end
+      end
+    end
+  end
+
+  context "pick_ticket_by_number" do
+    before do
+      @pick_ticket_id = "the_pick_ticket_id"
+      @client.auth_token = "4vxVebc3D1zwsXjH9fkFpgpOhewauJbVu25WXjQ1gOo="
+    end
+
+    it "should require_auth_token" do
+      @client.should_receive(:commit).and_return(xml_fixture("get_pick_ticket_object_by_bar_code_response_success"))
+      @client.should_receive(:require_auth_token)
+      @client.pick_ticket_by_number(@pick_ticket_id)
+    end
+
+    context "request" do
+      it "should form correct request" do
+        @client.should_receive(:commit).with(squeeze_xml(xml_fixture("get_pick_ticket_object_by_bar_code_request"))).and_return(xml_fixture("get_pick_ticket_object_by_bar_code_response_success"))
+        @client.pick_ticket_by_number(@pick_ticket_id)
+      end
+    end
+
+    context "response" do
+      context "when success" do
+        it "should return hash" do
+          @client.should_receive(:commit).and_return(xml_fixture("get_pick_ticket_object_by_bar_code_response_success"))
+          @client.pick_ticket_by_number(@pick_ticket_id).should == {
+              :pick_ticket_id => "the_pick_ticket_id",
+              :pick_ticket_status => "the_pick_ticket_status",
+              :pick_ticket_status_code => "the_pick_ticket_status_code",
+              :tracking_number => "the_tracking_number",
+              :shipping_charge => nil
+
+          }
+
+        end
+      end
+
+      context "when error" do
+        it "should raise error" do
+          @client.should_receive(:commit).and_return(xml_fixture("get_pick_ticket_object_by_bar_code_response_error"))
+          lambda {
+            @client.pick_ticket_by_number(@pick_ticket_id)
+          }.should raise_error("Error 83: BarCode doesn't exist. ")
+        end
+      end
+    end
+  end
+
+  context "create_receiving_ticket" do
+    before do
+      @items = [{:style => "the_style1",
+                 :upc => "the_upc1",
+                 :size => "the_size1",
+                 :color => "the_color1",
+                 :description => "the_description1",
+                 :quantity => "the_quantity1",
+                 :comments => "the_comments1",
+                 :shipment_type => "the_shipment_type1"
+                },
+                {:style => "the_style2",
+                 :upc => "the_upc2",
+                 :size => "the_size2",
+                 :color => "the_color2",
+                 :description => "the_description2",
+                 :quantity => "the_quantity2",
+                 :comments => "the_comments2",
+                 :shipment_type => "the_shipment_type2"
+                }
+      ]
+
+      @receiving_ticket_options = {
+          :warehouse => "the_warehouse",
+          :carrier => "the_carrier",
+          :memo => "the_memo",
+          :supplier => {:company_name => "the_supplier_company_name",
+               :address1 => "the_supplier_address1",
+               :address2 => "the_supplier_address2",
+               :city => "the_supplier_city",
+               :state => "the_supplier_state",
+               :zip => "the_supplier_zip",
+               :country => "the_supplier_country",
+               :phone => "the_supplier_phone",
+               :email => "the_supplier_email"
+              }
+      }
+
+      @client.auth_token = "4vxVebc3D1zwsXjH9fkFpgpOhewauJbVu25WXjQ1gOo="
+    end
+
+    it "should require_auth_token" do
+      @client.should_receive(:commit).and_return(xml_fixture("receiving_ticket_add_response_success"))
+      @client.should_receive(:require_auth_token)
+      @client.create_receiving_ticket(@items, @receiving_ticket_options)
+    end
+
+    context "request" do
+      it "should form correct request" do
+        @client.should_receive(:commit).with(squeeze_xml(xml_fixture("receiving_ticket_add_request"))).and_return(xml_fixture("receiving_ticket_add_response_success"))
+        @client.create_receiving_ticket(@items, @receiving_ticket_options)
+      end
+    end
+
+    context "response" do
+      context "when success" do
+        it "should return the receiving ticket id" do
+          @client.should_receive(:commit).and_return(xml_fixture("receiving_ticket_add_response_success"))
+          @client.create_receiving_ticket(@items, @receiving_ticket_options).should == {:receiving_ticket_id => "the_receiving_ticket_id"}
+        end
+      end
+
+      context "when error" do
+        it "should raise error" do
+          @client.should_receive(:commit).and_return(xml_fixture("receiving_ticket_add_response_error"))
+          lambda {
+            @client.create_receiving_ticket(@items, @receiving_ticket_options)
+          }.should raise_error("Error 12: ReceivingTicket/SupplierDetails/Country is not valid. Error 32: ReceivingTicket/Shipmentitemslist/Size[item 1] is not valid. ")
+        end
+      end
+    end
+  end
+
+  context "require_auth_token" do
+    it "should raise error if auth_token is not set" do
+      lambda {
+        @client.send("require_auth_token")
+      }.should raise_error("Authentication required for api call")
+    end
+
+    it "should not raise error if auth_token is set" do
+      @client.auth_token = "something"
+      lambda {
+        @client.send("require_auth_token")
+      }.should_not raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rex11'
+
+def xml_fixture(path) # where path is like 'authentication_token_get_response_success'
+  open(File.join(File.dirname(__FILE__), 'fixtures', "#{path}.xml")) { |f| f.read }
+end
+
+def squeeze_xml(xml)
+  xml.gsub("\n", ' ').squeeze(' ').gsub("> <","><")
+end

data/spec/support/spec_helper_methods.rb

@@ -0,0 +1,6 @@
+module SpecHelperMethods
+  def xml_fixture(path) # where path is like 'authentication_token_get_response_success'
+    open(File.join(File.dirname(__FILE__),'fixtures',"#{path}.xml")) {|f| f.read}
+  end
+end
+

data/spec/test_run.rb

@@ -0,0 +1,125 @@
+require 'rex11'
+
+USERNAME = "xx"
+PASSWORD = "xx"
+WEB_ADDRESS = "xx"
+TESTING = true
+
+item = {
+    :style => "ABC123",
+    :upc => "ABC123",
+    :size => "LARGE",
+    :price => "100.0",
+    :color => "Black",
+    :description => "Chanel Red Skirt"
+}
+
+item2 = {
+    :style => "DEF123",
+    :upc => "DEF123",
+    :size => "LARGE",
+    :price => "100.0",
+    :color => "Purple",
+    :description => "Chanel Red Blouse"
+}
+
+items = [
+    {:style => "ABC123",
+     :upc => "ABC123",
+     :size => "LARGE",
+     :color => "Black",
+     :description => "Chanel Red Skirt",
+     :quantity => "1",
+     :comments => "These are the comments.",
+     :shipment_type => "GOH"
+    },
+    {:style => "DEF123",
+     :upc => "DEF123",
+     :size => "SMALL",
+     :color => "Blue",
+     :description => "Balenciaga Purple Blouse",
+     :quantity => "1",
+     :comments => "Slightly damaged",
+     :shipment_type => "FLAT"
+    }
+]
+
+ship_to_address = {:first_name => "Joe",
+                   :last_name => "Shmoe",
+                   :company_name => "Time Magazine",
+                   :address1 => "1271 Avenue of the Americas",
+                   :city => "New York",
+                   :state => "NY",
+                   :zip => "10020",
+                   :country => "US",
+                   :phone => "212-522-1212",
+                   :email => "time@magazine.com"
+}
+
+pick_ticket_id = "23022012012557"
+pick_ticket_options = {
+    :pick_ticket_id => pick_ticket_id,
+    :warehouse => "BERGEN LOGISTICS NJ",
+    :payment_terms => "NET",
+    :use_ups_account => "0",
+    #:ship_via_account_number => "1AB345",
+    :ship_via => "UPS",
+    :ship_service => "UPS GROUND - Commercial",
+    :billing_option => "THIRD PARTY",
+    :bill_to_address => {
+        :first_name => "Jane",
+        :last_name => "Smith",
+        :company_name => "Netaporter",
+        :address1 => "725 Darlington Avenue",
+        :city => "Mahwah",
+        :state => "NJ",
+        :zip => "07430",
+        :country => "US",
+        :phone => "212-522-1212",
+        :email => "net@netaporter.com"
+    }
+}
+
+receiving_ticket_options = {
+    :warehouse => "BERGEN LOGISTICS NJ",
+    :carrier => "the_carrier",
+    :memo => "the_memo",
+    :supplier => {:company_name => "Netaporter",
+                  :address1 => "725 Darlington Avenue",
+                  :city => "Mahwah",
+                  :state => "NJ",
+                  :zip => "07430",
+                  :country => "US",
+                  :phone => "212-522-1212",
+                  :email => "net@netaporter.com"
+    }
+}
+
+puts "Authenticating..."
+client = Rex11::Client.new(USERNAME, PASSWORD, WEB_ADDRESS, TESTING, :logging => false)
+result = client.authenticate
+puts "Authenticated: #{result}\n\n"
+
+puts "Creating Style Master..."
+result = client.add_style(item)
+puts "Added Style Master: #{result}"
+
+puts "Creating Style Master..."
+result = client.add_style(item2)
+puts "Added Style Master: #{result}\n\n"
+
+puts "Creating Pick Tickets.."
+response = client.create_pick_ticket(items, ship_to_address, pick_ticket_options)
+puts "Created Pick Tickets: #{response}\n\n"
+
+puts "Canceling Pick Ticket.."
+response = client.cancel_pick_ticket(pick_ticket_id)
+puts "Canceled Pick Ticket: #{response}\n\n"
+
+puts "Getting Pick Tickets by number.."
+response = client.pick_ticket_by_number(pick_ticket_id)
+puts "Completed Pick Tickets by number: #{response}\n\n"
+
+puts "Creating Receiving Ticket.."
+response = client.create_receiving_ticket(items, receiving_ticket_options)
+puts "Created Receiving Ticket: #{response}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rex11
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,15 +9,112 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-26 00:00:00.000000000 Z
-dependencies: []
-description: Ruby client for REX11
-email: andy@vaunte.com
+date: 2013-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby Library for REX11 Warehouse Management System
+email:
+- andrewkshin@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
 - lib/rex11.rb
+- lib/rex11/client.rb
+- lib/rex11/version.rb
+- rex11.gemspec
+- spec/fixtures/authentication_token_get_request.xml
+- spec/fixtures/authentication_token_get_response_error.xml
+- spec/fixtures/authentication_token_get_response_success.xml
+- spec/fixtures/cancel_pick_ticket_request.xml
+- spec/fixtures/cancel_pick_ticket_response_error.xml
+- spec/fixtures/cancel_pick_ticket_response_success.xml
+- spec/fixtures/get_pick_ticket_object_by_bar_code_request.xml
+- spec/fixtures/get_pick_ticket_object_by_bar_code_response_error.xml
+- spec/fixtures/get_pick_ticket_object_by_bar_code_response_success.xml
+- spec/fixtures/pick_ticket_add_request.xml
+- spec/fixtures/pick_ticket_add_response_error.xml
+- spec/fixtures/pick_ticket_add_response_success.xml
+- spec/fixtures/receiving_ticket_add_request.xml
+- spec/fixtures/receiving_ticket_add_response_error.xml
+- spec/fixtures/receiving_ticket_add_response_success.xml
+- spec/fixtures/style_master_product_add_request.xml
+- spec/fixtures/style_master_product_add_response_error.xml
+- spec/fixtures/style_master_product_add_response_success.xml
+- spec/fixtures/text.xml
+- spec/lib/client_spec.rb
+- spec/spec_helper.rb
+- spec/support/spec_helper_methods.rb
+- spec/test_run.rb
 homepage: https://www.vaunte.com
 licenses: []
 post_install_message: 
@@ -41,5 +138,28 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Ruby client for REX11
-test_files: []
+summary: This is a library for interfacing with REX11 Warehouse Management System
+test_files:
+- spec/fixtures/authentication_token_get_request.xml
+- spec/fixtures/authentication_token_get_response_error.xml
+- spec/fixtures/authentication_token_get_response_success.xml
+- spec/fixtures/cancel_pick_ticket_request.xml
+- spec/fixtures/cancel_pick_ticket_response_error.xml
+- spec/fixtures/cancel_pick_ticket_response_success.xml
+- spec/fixtures/get_pick_ticket_object_by_bar_code_request.xml
+- spec/fixtures/get_pick_ticket_object_by_bar_code_response_error.xml
+- spec/fixtures/get_pick_ticket_object_by_bar_code_response_success.xml
+- spec/fixtures/pick_ticket_add_request.xml
+- spec/fixtures/pick_ticket_add_response_error.xml
+- spec/fixtures/pick_ticket_add_response_success.xml
+- spec/fixtures/receiving_ticket_add_request.xml
+- spec/fixtures/receiving_ticket_add_response_error.xml
+- spec/fixtures/receiving_ticket_add_response_success.xml
+- spec/fixtures/style_master_product_add_request.xml
+- spec/fixtures/style_master_product_add_response_error.xml
+- spec/fixtures/style_master_product_add_response_success.xml
+- spec/fixtures/text.xml
+- spec/lib/client_spec.rb
+- spec/spec_helper.rb
+- spec/support/spec_helper_methods.rb
+- spec/test_run.rb