carousel-ruby-api 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OTI0ZWU1ZWU0NjFjY2QxOTkwN2RhMWM0ODUxMGM5NTY0ZWUyNjVlZA==
-  data.tar.gz: !binary |-
-    ZDUzOTJhODViOTUzZDE3MzhhY2FkMmQzMWQ1NjA2MDQ2MmFmOGY4YQ==
+SHA1:
+  metadata.gz: 0607f6afe1f613f3d1a4dd544943245a1369622c
+  data.tar.gz: 95e533b637628ccd13dcbfbca702b2bd210b5605
 SHA512:
-  metadata.gz: !binary |-
-    M2ZkOGYwYWFjMGRiOTYyOGFmZDRhZWNlN2M0Yjg1YmVhNzFhOWMxN2RlMjdm
-    MDRjOTdiYmE0ODliYzY4NDhkNjMwMWUyNzM4ZmRmNzMyNmU2YTlmNWMzYjE4
-    NDYzZTkwOWY2YjhhMjI1ODlmODMzZWJhZjgwYTE1ZTgwNzI3N2Q=
-  data.tar.gz: !binary |-
-    NjM0MzczY2Q5YjNhMTZkNzYyY2IzYjEzNjlkM2M5OTNkNWI4NTJkZmE4NmU4
-    MzYzNjUyNWU2NDg5NTI0NjFlM2UyMGUwZDQ0OGU4NmViMzk5OTczMjkxMDA1
-    ZjQ4ZGFiNThlMDdhOWUxZGZkNzE5MzgyZjg3OTg1NjZjZWU5ZDk=
+  metadata.gz: 6869340ee67affff0b03f571933e7a974bd4f8e175a64a376d859cd9d5678335fe7de31c8548e82472b205110df91b70594927ae4a9276f7e8b26602245659a0
+  data.tar.gz: 7e2e6c202c7185eaa8eb7ae8c96daa9b19d5fe060765286782962edee818bbb8bde40419b989a2a9836ec7abe16775627f65955ff557cf6c98bc7522a639860a

data/.travis.yml

@@ -6,15 +6,8 @@ matrix:
   allow_failures:
     - rvm: rbx-19mode
 
-services:
-  - redis
-
 script:
-- bundle exec rake
-
-# addons:
-#    code_climate:
-#      repo_token: f0884115cadbe82b33756e38a9cd32d5129304746a17126d6c7da02e7a69910a
+- CODECLIMATE_REPO_TOKEN=09bd983baf4d0c64d97c20a68baecde00cefb3db009a88792f23e3ce5eadf69a bundle exec rspec
 
 notifications:
   email:

data/README.md

@@ -1,7 +1,8 @@
 # Carousel
 
-[![Build Status](https://travis-ci.org/jGRUBBS/carousel-ruby-api.svg?branch=master)](https://travis-ci.org/jGRUBBS/carousel-ruby-api)
-[![Code Climate](https://codeclimate.com/github/jGRUBBS/carousel-ruby-api.png)](https://codeclimate.com/github/jGRUBBS/carousel-ruby-api)
+[![Build Status](https://travis-ci.org/jGRUBBS/carousel-ruby-api.svg)](https://travis-ci.org/jGRUBBS/carousel-ruby-api)
+[![Code Climate](https://codeclimate.com/github/jGRUBBS/carousel-ruby-api/badges/gpa.svg)](https://codeclimate.com/github/jGRUBBS/carousel-ruby-api)
+[![Test Coverage](https://codeclimate.com/github/jGRUBBS/carousel-ruby-api/badges/coverage.svg)](https://codeclimate.com/github/jGRUBBS/carousel-ruby-api)
 
 Ruby library for interfacing with the Carousel Fulfillment API
 

data/carousel.gemspec

@@ -19,8 +19,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "builder"
   spec.add_dependency "xml-simple"
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "debugger"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "hashie"
+  spec.add_development_dependency "codeclimate-test-reporter"
 end

data/lib/carousel/client.rb

@@ -11,7 +11,7 @@ module Carousel
     PORT      = 443
     KEYS_MAP  = { "stockid" => "upc" }
 
-    attr_accessor :username, :password, :response, :type, :request_uri, :path
+    attr_accessor :username, :password, :options, :response, :type, :request_uri, :path
 
     def initialize(username, password, options = {})
       raise "Username is required" unless username
@@ -30,7 +30,16 @@ module Carousel
     def get_inventory
       request = Inventory.new(self).build_inventory_request
       @path   = build_path(Inventory::PATH)
-      map_results(post(request).response['stock'])
+      inventory_response(request)
+    end
+
+    # gets the raw inventory response from the provider
+    # then converts provider specific language to match 
+    # a uniform API, stored on @response, and returns
+    def inventory_response(request)
+      response = post(request)
+      response.response = map_results(response.response['stock'])
+      response
     end
 
     def order_request(order)

data/lib/carousel/order.rb

@@ -13,7 +13,7 @@ module Carousel
           xml.customerref    order[:number]
           xml.ordernumber    order[:number]
           xml.shippingmethod Shipping.map(order[:shipping_method])
-          xml.giftnote       order[:gift_message] if order[:gift_message].present?
+          xml.giftnote       order[:gift_message] unless order[:gift_message].nil?
 
           build_address xml, order[:shipping_address], :shipping
           build_address xml, order[:billing_address], :billing

data/lib/carousel/response.rb

@@ -1,7 +1,7 @@
 module Carousel
   class Response
 
-    attr_accessor :response
+    attr_accessor :response, :raw_response
 
     def initialize(raw_response, type)
       @raw_response = raw_response
@@ -14,14 +14,26 @@ module Carousel
     end
 
     def success?
-      # FIXME: needs to give actual boolean parsed from response
-      # @response.parsed["#{@type}_response"]["#{@type}_result"][:status] == '0001'
-      true
+      status == "OK"
+    end
+
+    def status
+      if @kind == "stock"
+        @response.first["status"]
+      else
+        @response[@kind][0]["status"][0]
+      end
+    end
+
+    def message
+      @response["order"][0]["details"][0]
     end
 
     def parse_response(xml_response)
-      return nil if xml_response.blank?
-      XmlSimple.xml_in(xml_response)
+      return nil if xml_response.nil?
+      parsed = XmlSimple.xml_in(xml_response)
+      @kind  = parsed.first[0]
+      parsed
     end
 
   end

data/lib/carousel/version.rb

@@ -1,3 +1,3 @@
 module Carousel
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/fixtures/error_order_response.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<orders>
+  <order number="12345">
+    <status>ERROR</status>
+    <details>Bad postcode</details>
+  </order>
+</orders>

data/spec/fixtures/inventory_request.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<stock>
+  <user>the_username</user>
+  <password>the_password</password>
+</stock>

data/spec/fixtures/success_inventory_response.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<stocklines>
+  <stock>
+    <stockid>1000000003642</stockid>
+    <qty>3</qty>
+    <status>OK</status>
+    <details/>
+  </stock>
+  <stock>
+    <stockid>1000000003659</stockid>
+    <qty>2</qty>
+    <status>OK</status>
+    <details/>
+  </stock>
+  <stock>
+    <stockid>1000000003666</stockid>
+    <qty>2</qty>
+    <status>OK</status>
+    <details/>
+  </stock>
+</stocklines>

data/spec/fixtures/success_order_response.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<orders>
+  <order number="12345">
+    <status>OK</status>
+    <details></details>
+  </order>
+</orders>

data/spec/fixtures/test_address_builder.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<name>Stephen Jones</name>
+<addressline1>23 Victoria Street</addressline1>
+<addressline2></addressline2>
+<towncity>Windsor</towncity>
+<postcode>SL4 1HE</postcode>
+<country>UK</country>
+<contactphone>0123 336 6676</contactphone>

data/spec/fixtures/test_build_user.xml

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<user>the_username</user>
+<password>the_password</password>

data/spec/fixtures/test_line_items.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<orderline number="123456">
+  <ordernumber>123456</ordernumber>
+  <sku>100083</sku>
+  <qty>2</qty>
+</orderline>

data/spec/fixtures/test_order.xml

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<orders>
+  <order>
+    <user>the_username</user>
+    <password>the_password</password>
+    <customerref>123456</customerref>
+    <ordernumber>123456</ordernumber>
+    <shippingmethod>ECONOMY</shippingmethod>
+    <name>Stephen Jones</name>
+    <addressline1>23 Victoria Street</addressline1>
+    <addressline2></addressline2>
+    <towncity>Windsor</towncity>
+    <postcode>SL4 1HE</postcode>
+    <country>UK</country>
+    <contactphone>0123 336 6676</contactphone>
+    <invname>Stephen Jones</invname>
+    <invaddressline1>23 Victoria Street</invaddressline1>
+    <invaddressline2></invaddressline2>
+    <invtowncity>Windsor</invtowncity>
+    <invpostcode>SL4 1HE</invpostcode>
+    <invcountry>UK</invcountry>
+    <invcontactphone>0123 336 6676</invcontactphone>
+    <orderline number="123456">
+      <ordernumber>123456</ordernumber>
+      <sku>100083</sku>
+      <qty>2</qty>
+    </orderline>
+  </order>
+</orders>

data/spec/fixtures/test_request.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<order>
+  <test>test</test>
+</order>

data/spec/fixtures/test_shipping_address_builder.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<invname>Stephen Jones</invname>
+<invaddressline1>23 Victoria Street</invaddressline1>
+<invaddressline2></invaddressline2>
+<invtowncity>Windsor</invtowncity>
+<invpostcode>SL4 1HE</invpostcode>
+<invcountry>UK</invcountry>
+<invcontactphone>0123 336 6676</invcontactphone>

data/spec/lib/client_spec.rb

@@ -1,94 +1,290 @@
 require 'spec_helper'
 
 describe Carousel::Client do
-  before do
-    @client = Carousel::Client.new("the_username", "the_password")
+
+  let(:username) { "the_username" }
+  let(:password) { "the_password" }
+  let(:options)  { { verbose: true, test_mode: true } }
+  let(:client)   { Carousel::Client.new(username, password, options) }
+
+  describe '#initialize' do
+    it 'sets the @username, @password and @options' do
+      expect(client.username).to eq(username)
+      expect(client.password).to eq(password)
+      expect(client.options).to  eq(options)
+    end
   end
 
   describe '#send_order_request' do
-    it 'should send order request and return parsed respose' do
-      Carousel::Order.any_instance.should_receive(:build_order_request).with(order_hash)
-      @client.should_receive(:post)
-      @client.send_order_request(order_hash)
+    
+    let(:success_response) { read_xml(:success_order_response) }
+    let(:error_response)   { read_xml(:error_order_response) }
+    let(:response)         { client.send_order_request(order_hash) }
+
+    it 'parses a success response' do
+      stub_post("action=order").to_return(body: success_response)
+      expect(response.success?).to eq(true)
+    end
+
+    it 'parses an error response' do
+      stub_post("action=order").to_return(body: error_response)
+      expect(response.success?).to eq(false)
+      expect(response.message).to  eq('Bad postcode')
+    end
+  end
+
+  describe 'inventory methods' do
+
+    let(:success_response) { read_xml(:success_inventory_response) }
+    let(:response)         { client.get_inventory }
+    let(:expected_upcs)    { ['1000000003642', '1000000003659', '1000000003666'] }
+    let(:expected_qtys)    { ['3', '2', '2'] }
+    let(:raw_xml)          { read_xml(:inventory_request) }
+
+    before do
+      stub_post("action=stocklines").with(body: raw_xml, headers: xml_headers)
+        .to_return(body: success_response)
+    end
+
+    describe '#get_inventory' do
+
+      it 'parses success response and maps results to simple array of stock hashes' do
+        expect(response.response.collect{ |s| s["upc"] }).to eq(expected_upcs)
+        expect(response.response.collect{ |s| s["qty"] }).to eq(expected_qtys)
+        expect(response.success?).to eq(true)
+      end
+    end
+
+    describe '#inventory_response' do
+
+      it 'gets the raw inventory response from the provider' do
+        expect(response.raw_response).to eq(success_response)
+      end
+
+      it 'converts provider specific language to match a uniform API' do
+        original_response = client.send(:parse_response, success_response).response["stock"]
+        expect(original_response.first.keys).to include('stockid') 
+        expect(response.response.first.keys).to include('upc')
+      end
+
+      it 'returns a response' do
+        expect(response).to be_a(Carousel::Response)
+      end
+
+    end
+
+  end
+
+  describe '#order_request' do
+    it 'sets the path instance variable' do
+      client.order_request(order_hash)
+      expect(client.instance_variable_get(:@path)).to eq("/carouselwms/default.asp?action=order")
+    end
+    it 'returns a built request for Order' do
+      order_xml = read_xml(:test_order)
+      expect(client.order_request(order_hash)).to eq(order_xml)
+    end
+  end
+
+  describe '#build_path' do
+    it 'builds and returns the uri path' do
+      expect(client).to receive(:env_path).and_return("carouselwms")
+      expect(client.build_path("?action=stocklines")).to eq("/carouselwms/default.asp?action=stocklines")
+    end
+  end
+
+  describe '#upcs' do
+    it 'returns an array of the collected upcs' do
+      inventory = [{"upc" => "123"}, {"upc" => "123456"}]
+      expect(client.upcs(inventory)).to eq(["123", "123456"])
+    end
+  end
+
+  describe '#mapped_inventory' do
+    it 'converts provider specific terms into a uniform API' do
+      inventory = [{"upc" => "123", "qty" => "3"}, {"upc" => "123456", "qty" => "0"}]
+      upcs = ["123"]
+      expect(client.mapped_inventory(upcs, inventory)).to eq([{quantity: 3}])
+    end
+  end
+
+  describe '#request_uri' do
+    it 'returns the request uri based on host and path' do
+      client.path = "?action=stocklines"
+      expect(client.request_uri).to eq("https://web.carousel.eu?action=stocklines")
     end
   end
 
   describe 'private#default_options' do
-    it 'should return a hash' do
-      @client.send(:default_options).should be_a Hash
+    it 'returns the default options for a Client' do
+      default_options = {
+        verbose: true,
+        test_mode: false
+      }
+      expect(client.send(:default_options)).to eq(default_options)
     end
   end
 
   describe 'private#testing?' do
-    it 'should return boolean for test mode' do
-      @client.send(:testing?).should be_false
-      @client.instance_variable_set(:@options, { test_mode: true })
-      @client.send(:testing?).should be_true
+     context 'not in testing mode' do
+      it 'returns false' do
+        client.options[:test_mode] = false
+        expect(client.send(:testing?)).to eq(false)
+      end
+    end
+    context 'in testing mode' do
+      it 'returns true' do
+        expect(client.send(:testing?)).to eq(true)
+      end
     end
   end
 
   describe 'private#verbose?' do
-    it 'should return boolean for verbose mode' do
-      @client.send(:verbose?).should be_true
-      @client.instance_variable_set(:@options, { verbose: false })
-      @client.send(:verbose?).should be_false
+     context 'not in verbose mode' do
+      it 'returns false' do
+        client.options[:verbose] = false
+        expect(client.send(:verbose?)).to eq(false)
+      end
+    end
+    context 'in verbose mode' do
+      it 'returns true' do
+        expect(client.send(:verbose?)).to eq(true)
+      end
     end
   end
 
-  describe 'private#host' do
-    it 'should' do
-      @client.stub(:testing?).and_return(false)
-      @client.send(:host).should == Carousel::Client::LIVE_HOST
-      @client.stub(:testing?).and_return(true)
-      @client.send(:host).should == Carousel::Client::TEST_HOST
+  describe 'private#env_path' do
+    context 'not in testing mode' do
+      it 'returns the LIVE_PATH' do
+        client.options[:test_mode] = false
+        expect(client.send(:env_path)).to eq(Carousel::Client::LIVE_PATH)
+      end
+    end
+    context 'in testing mode' do
+      it 'returns TEST_PATH' do
+        expect(client.send(:env_path)).to eq(Carousel::Client::TEST_PATH)
+      end
     end
   end
 
-  describe 'private#path' do
-    it 'should' do
-      @client.stub(:testing?).and_return(false)
-      @client.send(:path).should == Carousel::Client::LIVE_PATH
-      @client.stub(:testing?).and_return(true)
-      @client.send(:path).should == Carousel::Client::TEST_PATH
+  describe 'private#host' do
+    context 'not in testing mode' do
+      it 'returns the LIVE_PATH' do
+        client.options[:test_mode] = false
+        expect(client.send(:host)).to eq(Carousel::Client::LIVE_HOST)
+      end
+    end
+    context 'in testing mode' do
+      it 'returns TEST_PATH' do
+        expect(client.send(:host)).to eq(Carousel::Client::TEST_HOST)
+      end
     end
   end
 
   describe 'private#log' do
+    before do
+      @message = "test"
+    end
     context 'not in verbose mode' do
-      it 'should not log message' do
-        @client.stub(:verbose?).and_return(false)
-        @client.should_not_receive(:puts)
-        @client.send(:log, "message")
+      it 'returns nil' do
+        expect(client.send(:log, @message)).to eq(nil)
       end
     end
     context 'in verbose mode' do
-      it 'should' do
-        @client.stub(:verbose?).and_return(true)
-        @client.should_receive(:puts).with("message")
-        @client.send(:log, "message")
+      it 'logs the message to STDOUT' do
+        client.options[:verbose] = true
+        output = capture_stdout { client.send(:log, @message) }
+        expect(output).to eq("test\n")
       end
     end
   end
 
+  describe 'private#http' do
+    it 'returns an instance of Net::HTTP' do
+      http = client.send(:http)
+      host = client.send(:host)
+      expect(http).to be_an_instance_of(Net::HTTP)
+      expect(http.address).to eq(host)
+      expect(http.port).to eq(Carousel::Client::PORT)
+    end
+  end
+
+  describe 'private#request' do
+
+    let(:success_response) { read_xml(:success_inventory_response) }
+    let(:request)          { read_xml(:inventory_request) }
+
+    it 'sets the ssl and verify mode, sends an http request, and returns a response object' do
+      client.path = "?action=stocklines"
+      expect(client.send(:http)).to receive(:request).and_return(success_response)
+      expect(client.send(:request, request)).to eq(success_response)
+      expect(client.send(:http).use_ssl?).to be(true)
+      expect(client.send(:http).verify_mode).to eq(OpenSSL::SSL::VERIFY_NONE)
+    end
+  end
+
   describe 'private#post' do
-    it 'should use net http to post xml request' do
-      path        = @client.send(:path)
-      xml_request = "xml_request"
-      response    = Carousel::Response.new("<xml>body</xml>", "new_request")
-      header      = {'Content-Type' => 'text/xml'}
-      Net::HTTP.any_instance.should_receive(:post).with(path, xml_request, header).and_return(response)
-      @client.should_receive(:parse_response).with(response, nil)
-      @client.should_receive(:log).with(response)
-      @client.send(:post, xml_request)
+    let(:request)   { read_xml(:inventory_request) }
+    let(:response)  { read_xml(:success_inventory_response) }
+
+    before do
+      client.path = "?action=stocklines"
+    end
+    
+    it 'sends a post request' do
+      expect(client).to receive(:request).and_return(fake_response)
+      client.send(:post, request)
+    end
+    it 'parses response into a Carousel::Response object' do
+      expect(client).to receive(:request).and_return(fake_response)
+      expect(client.send(:post, request)).to be_a(Carousel::Response)
     end
   end
 
   describe 'private#parse_response' do
-    it 'should use xml simple to parse the response' do
-      xml_response = "xml_response"
-      XmlSimple.should_receive(:xml_in).with(xml_response)
-      response = @client.send(:parse_response, xml_response)
-      response.should be_a Carousel::Response
+    let(:response) { read_xml(:success_inventory_response) }
+
+    it 'logs the response' do
+      client.options[:verbose] = true
+      expect(client).to receive(:log).with(response)
+      client.send(:parse_response, response)
+    end
+
+    it 'parses response into a Carousel::Response object' do
+      expect(client.send(:parse_response, response)).to be_a(Carousel::Response)
+    end
+  end
+
+  describe 'private#map_results' do
+    it 'flattens the results and maps them' do
+      results = [{test: [1,2,3]}, {example: [2,3,4]}, {test: [1,2,3], stockid: [5,6,7,8]}]
+      expected_result = [{test: 1}, {example: 2}, {test: 1, stockid: 5}]
+
+      expect(client).to receive(:flatten_results).and_return(expected_result)
+      expect(client.send(:map_results, results)).to eq(expected_result)
+    end
+  end
+
+  describe 'private#flatten_results' do
+    it 'sets the value for each hash key to the first item in the value array' do
+      results = [{test: [1,2,3]}, {example: [2,3,4]}, {test: [1,2,3], example: [5,6,7,8]}]
+      expected_result = [{test: 1}, {example: 2}, {test: 1, example: 5}]
+      expect(client.send(:flatten_results, results)).to eq(expected_result)
+    end
+  end
+
+  describe 'private#map_keys' do
+    context 'with a key in the KEYS_MAP' do
+      it 'returns the value for the given key' do
+        key = "stockid"
+        expect(client.send(:map_keys, key)).to eq(Carousel::Client::KEYS_MAP[key])
+      end
+    end
+    context 'without a key in the KEYS_MAP' do
+      it 'returns the key' do
+        key = "test"
+        expect(client.send(:map_keys, key)).to eq(key)
+      end
     end
   end
 

data/spec/lib/country_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Carousel::Country do
+
+  
+  describe '.map' do
+    context 'with the code in the COUNTRY_MAP' do
+      it 'returns the value for the given code' do
+        expect(Carousel::Country.map("US")).to eq("US")
+      end
+    end
+    context 'without the code in the COUNTRY_MAP' do
+      it 'returns the given code' do
+        expect(Carousel::Country.map("AAA")).to eq("AAA")
+      end
+    end
+  end
+end

data/spec/lib/inventory_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Carousel::Inventory do
+
+  let(:client)  { Carousel::Client.new("the_username", "the_password") }
+  let(:inventory_request) { Carousel::Inventory.new(client) }
+
+  describe '#build_inventory_request' do
+    it 'constructs xml for the user' do
+      expect(inventory_request.build_inventory_request).to eq(read_xml(:inventory_request))
+    end
+  end
+end