carousel-ruby-api 0.0.2 → 0.0.3

data/spec/lib/order_spec.rb

@@ -1,34 +1,39 @@
 require 'spec_helper'
 
 describe Carousel::Order do
-
-  before do
-    @client       = Carousel::Client.new("the_username", "the_password")
-    @order_client = Carousel::Order.new(@client)
-    @xml          = Builder::XmlMarkup.new
-  end
+  let(:client)  { Carousel::Client.new("the_username", "the_password") }
+  let(:order_request) { Carousel::Order.new(client) }
 
   describe '#build_order_request' do
-    it 'should' do
-      response = @order_client.build_order_request(order_hash)
-      @client.type.should == "new_order_entry"
-      request_body = xml_order_request_string(order_hash)
-      response.should == xml_string("new_order_entry", request_body)
+    it 'builds an xml file based on the order' do
+      expect(order_request.build_order_request(order_hash)).to eq(read_xml(:test_order))
     end
   end
 
   describe 'private#build_address' do
-    it 'should build the proper address xml' do
-      type    = "CUSTOMER"
-      request = @order_client.send(:build_address, @xml, type, order_hash[:shipping_address])
-      request.should == xml_address_string(type, order_hash[:shipping_address])
+    before do
+      @xml = ::Builder::XmlMarkup.new :indent => 2
+      @xml.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
+    end
+
+    context 'given a billing address' do
+      it 'adds the address tags with the "inv" prefix' do
+        expect(order_request.send(:build_address, @xml, address_hash, :billing)).to eq(read_xml(:test_shipping_address_builder))
+      end
+    end
+    context 'given any other address' do
+      it 'adds the address tags to the xml file' do
+        expect(order_request.send(:build_address, @xml, address_hash, "shipping")).to eq(read_xml(:test_address_builder))
+      end
     end
   end
 
   describe 'private#build_line_items' do
-    it 'should build the proper line items xml' do
-      request = @order_client.send(:build_line_items, @xml, order_hash)
-      request.should == xml_line_items_string(order_hash)
+    it 'adds the line_items tags to the xml file under orderline' do
+      xml = ::Builder::XmlMarkup.new :indent => 2
+      xml.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
+      order_request.send(:build_line_items, xml, order_hash)
+      expect(xml.target!).to eq(read_xml(:test_line_items))
     end
   end
 

data/spec/lib/request_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Carousel::Request do
+
+  let(:client)  { Carousel::Client.new("the_username", "the_password") }
+  let(:request) { Carousel::Request.new(client) }
+
+  describe '#initialize' do
+    it 'sets the client' do
+      expect(request.instance_variable_get(:@client)).to eq(client)
+    end
+  end
+
+  describe '#construct_xml' do
+    it 'creates xml with a given block' do
+      expect(request.construct_xml("order"){|xml| xml.test "test"}).to eq(read_xml(:test_request))
+    end
+  end
+
+  describe '#build_user' do
+    it 'adds user and password to xml file' do
+      xml = ::Builder::XmlMarkup.new :indent => 2
+      xml.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
+      expect(request.build_user(xml)).to eq(read_xml(:test_build_user))
+    end
+  end
+end

data/spec/lib/response_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Carousel::Response do
+  
+  let(:raw_xml)               { read_xml(:success_order_response) }
+  let(:raw_fail_xml)          { read_xml(:error_order_response) }
+  let(:failed_response)       { Carousel::Response.new(raw_fail_xml, "order") }
+  let(:successful_response)   { Carousel::Response.new(raw_xml, "order") }
+  let(:message)               { {"order"=>[{"number"=>"12345", "status"=>["OK"], "details"=>[{}]}]} }
+
+  describe '#initialize' do
+    it 'sets the raw_response. response, and type' do
+      expect(successful_response.instance_variable_get(:@raw_response)).to eq(raw_xml)
+      expect(successful_response.instance_variable_get(:@type)).to eq("order")
+      expect(successful_response.response).to eq(message)
+    end
+  end
+
+  describe '#failure?' do
+    context 'the status is "OK"' do
+      it 'returns false' do
+        expect(successful_response.failure?).to eq(false)
+      end
+    end
+    context 'the status is not "OK"' do
+      it 'returns true' do
+        expect(failed_response.failure?).to eq(true)
+      end
+    end
+  end
+
+  describe '#success?' do
+    context 'the status is "OK"' do
+      it 'returns true' do
+        expect(successful_response.success?).to eq(true)
+      end
+    end
+    context 'the status is not "OK"' do
+      it 'returns false' do
+        expect(failed_response.success?).to eq(false)
+      end
+    end
+  end
+
+  describe '#status' do
+    context 'with a successful response' do
+      it 'returns succesful status code' do
+        expect(successful_response.status).to eq("OK")
+      end
+    end
+    context 'with an failed response' do
+      it 'returns a failed status code' do
+        expect(failed_response.status).to eq("ERROR")
+      end
+    end
+  end
+
+  describe '#message' do
+    it 'returns the details from the response' do
+      expect(successful_response.message).to eq({})
+    end
+  end
+
+  describe '#parse_response' do
+    it 'returns the parsed xml' do
+      expect(successful_response.parse_response(raw_xml)).to eq(message)
+    end
+  end
+end

data/spec/lib/shipping_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Carousel::Shipping do
+  describe '.map' do
+    context 'with the code within the shipping map' do
+      it 'returns the value for the given key' do
+        expect(Carousel::Shipping.map("standard")).to eq("ECONOMY")
+      end
+    end
+    context 'with the code not in the shipping map' do
+      it 'returns the given code' do
+        expect(Carousel::Shipping.map("first-class")).to eq("first-class")
+      end
+    end
+  end
+end

data/spec/lib/tracking_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Carousel::Tracking do
+
+  let(:tracking) { Carousel::Tracking.new('carousel', '123456')}
+  
+  describe '#initialize' do
+    it 'sets the carrier and tracking number' do
+      expect(tracking.instance_variable_get(:@carrier)).to eq("carousel")
+      expect(tracking.instance_variable_get(:@tracking_number)).to eq("123456")
+    end
+  end
+
+  describe '#carrier_destination' do
+    context 'when carrier is FedEx' do
+      it 'returns the FedEx tracking url' do
+        tracking.carrier = "fedex"
+        expect(tracking.url).to eq("http://www.fedexuk.net/accounts/QuickTrack.aspx?consignment=123456")
+      end
+    end
+    context 'when carrier is Carousel' do
+      it 'returns the Carousel tracking url' do
+        expect(tracking.url).to eq("https://web.carousel.eu/easyweb/default.asp?action=clienttrack&type=Carousel&acct1=BEC01&reference=123456")
+      end
+    end
+  end
+  describe '#url' do
+    context 'when carrier is FedEx' do
+      it 'returns the FedEx tracking url including the tracking number' do
+        tracking.carrier = "fedex"
+        expect(tracking.url).to eq("http://www.fedexuk.net/accounts/QuickTrack.aspx?consignment=123456")
+      end
+    end
+    context 'when carrier is Carousel' do
+      it 'returns the Carousel tracking url including the tracking number' do
+        expect(tracking.url).to eq("https://web.carousel.eu/easyweb/default.asp?action=clienttrack&type=Carousel&acct1=BEC01&reference=123456")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,129 +1,189 @@
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# Require this file using `require "spec_helper"` to ensure that it is only
-# loaded once.
-
-require 'rubygems'
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
 require 'bundler/setup'
-Bundler.require(:default, :development)
-require 'hashie'
 require 'carousel'
+require 'rspec'
+require 'webmock/rspec'
+require 'hashie'
+
+Bundler.setup
+
+WebMock.disable_net_connect!(:allow => "codeclimate.com")
 
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
-  config.order = 'random'
-end
-
-def xml_string(type, body)
-  xml  = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>"
-  xml += "<s:Envelope xmlns:s=\"http://www.w3.org/2003/05/soap-envelope\" xmlns:a=\"http://www.w3.org/2005/08/addressing\">"
-  xml += xml_header_string(type)
-  xml += "<s:Body><#{type} xmlns=\"SII\">"
-  xml += xml_user_string
-  xml += body
-  xml += "</#{type}></s:Body></s:Envelope>"
-end
-
-def xml_header_string(type)
-  xml  = "<s:Header><a:Action s:mustUnderstand=\"1\">SII/ISIIService/#{type}</a:Action>"
-  xml += "<a:MessageID>urn:uuid:56b55a70-8bbc-471d-94bb-9ca060bcf99f</a:MessageID>"
-  xml += "<a:ReplyTo><a:Address>http://www.w3.org/2005/08/addressing/anonymous</a:Address></a:ReplyTo>"
-  xml += "<a:To s:mustUnderstand=\"1\">https://www.carousel.us/webservices/SIIService.svc</a:To></s:Header>"
-end
-
-def xml_user_string
-  xml  = "<user xmlns:b=\"http://schemas.datacontract.org/2004/07/\" xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\">"
-  xml += "<b:user_name>&lt;![CDATA[the_username]]&gt;</b:user_name><b:user_password>&lt;![CDATA[the_password]]&gt;</b:user_password></user>"
-end
-
-def xml_address_string(type, address)
-  full_name = "#{address[:first_name]} #{address[:last_name]}"
-  xml  = "<b:#{type}_NAME>&lt;![CDATA[#{full_name}]]&gt;</b:#{type}_NAME>"
-  xml += "<b:#{type}_ADDRESS_1>&lt;![CDATA[#{address[:address1]}]]&gt;</b:#{type}_ADDRESS_1>"
-  xml += "<b:#{type}_ADDRESS_2>&lt;![CDATA[#{address[:address2]}]]&gt;</b:#{type}_ADDRESS_2>"
-  xml += "<b:#{type}_ADDRESS_3>&lt;![CDATA[#{address[:address3]}]]&gt;</b:#{type}_ADDRESS_3>"
-  xml += "<b:#{type}_ADDRESS_CITY>#{address[:city]}</b:#{type}_ADDRESS_CITY>"
-  xml += "<b:#{type}_ADDRESS_COUNTRY>#{address[:country]}</b:#{type}_ADDRESS_COUNTRY>"
-  xml += "<b:#{type}_ADDRESS_STATE>#{address[:state]}</b:#{type}_ADDRESS_STATE>"
-  xml += "<b:#{type}_ADDRESS_ZIP>#{address[:zipcode]}</b:#{type}_ADDRESS_ZIP>"
-  xml += "<b:#{type}_TELEPHONE>#{address[:phone]}</b:#{type}_TELEPHONE>"
-end
-
-def xml_line_items_string(order)
-  xml  = "<b:Order_Details>"
-  order[:line_items].each do |line_item|
-    xml += "<b:Order_Detail_New>"
-    xml += "<b:PRICE>#{line_item[:price]}</b:PRICE>"
-    xml += "<b:QUANTITY>#{line_item[:quantity]}</b:QUANTITY>"
-    xml += "<b:SIZE>#{line_item[:size]}</b:SIZE>"
-    xml += "<b:sku>#{line_item[:sku]}</b:sku>"
-    xml += "</b:Order_Detail_New>"
-  end
-  xml += "</b:Order_Details>"
-end
-
-def xml_order_request_string(order)
-  xml  = "<ohn xmlns:b=\"http://schemas.datacontract.org/2004/07/\" xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\">"
-  xml += "<b:SERVICE>90</b:SERVICE>"
-  xml += "<b:USER1>&lt;![CDATA[http://example.com/R123123123/invoice]]&gt;</b:USER1>"
-  xml += "<b:CARRIER>FEDEX</b:CARRIER>"
-  xml += "<b:CUSTOMER_CODE/><b:DELIVERY_GIFT_WRAP/>"
-  xml += "<b:DELIVERY_MESSAGE>&lt;![CDATA[Happy Birthday!]]&gt;</b:DELIVERY_MESSAGE>"
-  xml += "<b:EMAIL>someone@somehwere.com</b:EMAIL>"
-  xml += "<b:ORDER_ID>R123123123</b:ORDER_ID>"
-  xml += "<b:ORDER_TYPE>OO</b:ORDER_TYPE>"
-  xml += "<b:DELIVERY_FROM i:nil=\"true\"/><b:DELIVERY_TO i:nil=\"true\"/>"
-  xml += "<b:DELIVERY_ID i:nil=\"true\"/><b:FREIGHT_ACCOUNT i:nil=\"true\"/>"
-  xml += xml_address_string("CUSTOMER", order[:billing_address])
-  xml += xml_address_string("DELIVERY", order[:shipping_address])
-  xml += xml_line_items_string(order)
-  xml += "</ohn>"
+  config.include WebMock::API
+  config.before(:all, &:silence_output)
+  config.after(:all,  &:enable_output)
 end
 
-def order_hash
-{
-  carrier: "FEDEX",
-  billing_address:  { 
-    first_name: "John",
-    last_name:  "Smith",
-    address1:   "123 Here Now",
-    address2:   "2nd Floor",
-    address3:   "",
-    city:       "New York",
-    state:      "New York",
-    country:    "US",
-    zipcode:    "10012",
-    phone:      "123-123-1234"
-  },
-  shipping_address: {
-    first_name: "John",
-    last_name:  "Smith",
-    address1:   "123 Here Now",
-    address2:   "2nd Floor",
-    address3:   "",
-    city:       "New York",
-    state:      "New York",
-    country:    "US",
-    zipcode:    "10012",
-    phone:      "123-123-1234"
-  },
-  gift_wrap:    "true",
-  gift_message: "Happy Birthday!",
-  email:        "someone@somehwere.com",
-  number:       "R123123123",
-  type:         "OO",
-  line_items: [
+def read_xml(type)
+  File.read( File.expand_path("spec/fixtures/#{type}.xml") )
+end
+
+def fixture(type)
+  XmlSimple.xml_in( read_xml(type) )
+end
+
+def base_url
+  'https://web.carousel.eu/carouselwms/default.asp?'
+end
+
+def stub_get(path)
+  stub_request(:get, "#{base_url}#{path}")
+end
+
+def stub_post(path)
+  stub_request(:post, "#{base_url}#{path}")
+end
+
+def xml_headers
+  {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/xml', 'User-Agent'=>'Ruby'}
+end
+
+def json_post_headers
+  {
+    'Accept'          => '*/*', 
+    'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 
+    'Content-Type'    => 'application/json', 
+    'User-Agent'      => 'Ruby'
+  }
+end
+
+def success_response
+  {
+    'Response' => {
+      'CallStatus' => {
+        'Code'     => 0,
+        'Message'  => {},
+        'Success'  => true
+      }
+    }
+  }
+end
+
+def error_product_response
+  {
+    'CallStatus' => {
+      'Success' => false,
+      'Code'    => 100,
+      'Message' => 'Error Submitting Product Master: LJ-W-BERN-S-GW - Error. Product Code already exists.'
+    }
+  }
+end
+
+def configuration
+  { 
+    supplier_code:        'Supplier1', 
+    supplier_description: 'My Supplier', 
+    supplier_uom:         1,
+    warehouses:           {},
+    token: 'token123'
+  }
+end
+
+def address_hash
+  {
+    city:       'Windsor',
+    country:    'GB',
+    first_name: 'Stephen',
+    last_name:  'Jones',
+    address1:   '23 Victoria Street',
+    address2:   '',
+    phone:      '0123 336 6676',
+    zipcode:    'SL4 1HE'
+  }
+end
+
+def line_items_array
+  [
     {
-      price:    "127.23",
-      quantity: "1",
-      sku:      "123332211",
-      size:     "XS"
+      sku:      100083,
+      quantity: 2
     }
-  ],
-  shipping_code: "90",
-  invoice_url:   "http://example.com/R123123123/invoice"
-}
+  ]
+end
+
+def company_hash
+  {
+    code:        'IND001',
+    description: 'Indigina'
+  }
+end
+
+def order_hash
+  {
+    number:           123456,
+    email:            'stephen.jones@gmail.com',
+    shipping_address: address_hash,
+    billing_address:  address_hash,
+    line_items:       line_items_array,
+    warehouse:        'DC123',
+    date:             '2013-12-12',
+    shipping_method:  'standard'
+  }
+end
+
+def company_order_hash
+  order_hash.merge(company: company_hash)
+end
+
+def company_address_hash
+  {
+    city:         'High Wycombe',
+    country:      'GB',
+    country_name: 'Buckinghamshire',
+    address1:     'The Farthings',
+    address2:     'Sandpits Lane',
+    address3:     'Beaconsfield',
+    zipcode:      'HP8 TTT'
+  }
+end
+
+def company_submit_hash
+  {
+    code: 123456,
+    description: 'My Test company',
+    address: company_address_hash
+  }
+end
+
+def fake_response
+  Hashie::Mash.new( {body: read_xml(:success_order_response)} )
+end
+
+
+public
+# Redirects stderr and stout to /log/spec.log
+def silence_output
+  # Store the original stderr and stdout in order to restore them later
+  @original_stderr = $stderr
+  @original_stdout = $stdout
+
+  # Redirect stderr and stdout
+  $stderr = File.new(log_file, 'w')
+  $stdout = File.new(log_file, 'w')
+end
+
+def log_file
+  File.join(File.dirname(__FILE__), 'logs', 'spec.log')
+end
+
+# Replace stderr and stdout so anything else is output correctly
+def enable_output
+  $stderr = @original_stderr
+  $stdout = @original_stdout
+  @original_stderr = nil
+  @original_stdout = nil
+  `rm #{log_file} && touch #{log_file}`
+end
+
+def capture_stdout(&block)
+  original_stdout = $stdout
+  $stdout = fake = StringIO.new
+  begin
+    yield
+  ensure
+    $stdout = original_stdout
+  end
+  fake.string
 end