bws 0.2.1.pre

data/test/unit/test_bws_acknowledge_order.rb

@@ -0,0 +1,24 @@
+require 'helper'
+
+class TestBwsAcknowledgeOrder < Test::Unit::TestCase
+  def setup
+    FakeWeb.allow_net_connect = false
+  end
+
+  context "acknowledge success" do
+    setup do
+      @key = 'my_api_key'
+      @url_prefix = 'https://bws.bookrenter.com/v1'
+      @client = BWS::Client.new(@key)
+      @url = "/distributor_orders/BR-1234/acknowledge.xml"
+      fake_post("#{@url_prefix}#{@url}?api_key=#{@key}", 'acknowledge_success.xml')
+      @response = @client.acknowledge_order({'order' => 'data', 'public_id' => 'BR-1234', 'distributor_line_items' => {'distributor_line_item' => {'public_id' => 'some-line-item-public-id'}}})
+    end
+
+    context ".result" do
+      should "be true" do
+        assert_equal true, @response.result
+      end
+    end
+  end
+end

data/test/unit/test_bws_active_isbn_report.rb

@@ -0,0 +1,45 @@
+require 'helper'
+
+class TestBwsActiveIsbnReport < Test::Unit::TestCase
+  def setup
+    FakeWeb.allow_net_connect = false
+  end
+
+  context "active isbn report success" do
+    setup do
+      @key = 'my_api_key'
+      @url_prefix = 'https://bws.bookrenter.com/v1'
+      @client = BWS::Client.new(@key)
+      @url = "/reports/active_isbn_report.xml"
+    end
+
+    context "active_isbn_report with one isbn" do
+      setup do
+        @active_isbn_report_request_body_xml = File.read(File.join(File.dirname(__FILE__), '../fixtures', "active_isbn_report_with_one_isbn_request_body.xml"))
+        @active_isbn_report_hash = Hash.from_xml(@active_isbn_report_request_body_xml)["reports_active_isbn_report"]
+        fake_post("#{@url_prefix}#{@url}?api_key=#{@key}", 'active_isbn_report_with_one_isbn_success.xml')
+      end
+
+      should "title not nil" do
+        @response = @client.retrieve_active_isbn_report @active_isbn_report_hash
+        assert_equal 1, @response.active_isbns.size
+        assert_equal "Managerial Accounting", @response.active_isbns.first['title']
+      end
+    end
+
+    context "active_isbn_report with two isbns" do
+      setup do
+        @active_isbn_report_request_body_xml = File.read(File.join(File.dirname(__FILE__), '../fixtures', "active_isbn_report_with_two_isbns_request_body.xml"))
+        @active_isbn_report_hash = Hash.from_xml(@active_isbn_report_request_body_xml)["reports_active_isbn_report"]
+        fake_post("#{@url_prefix}#{@url}?api_key=#{@key}", 'active_isbn_report_with_two_isbns_success.xml')
+      end
+
+      should "title not nil" do
+        @response = @client.retrieve_active_isbn_report @active_isbn_report_hash
+        assert_equal 2, @response.active_isbns.size
+        assert_equal "Managerial Accounting", @response.active_isbns.first['title']
+        assert_equal "Managerial Accounting II", @response.active_isbns.last['title']
+      end
+    end
+  end
+end

data/test/unit/test_bws_checkout.rb

@@ -0,0 +1,117 @@
+require 'helper'
+
+class TestBwsCheckout < Test::Unit::TestCase
+  def setup
+    FakeWeb.allow_net_connect = false
+  end
+
+  context "checkout price order success" do
+    setup do
+      @key = 'my_api_key'
+      @url_prefix = 'https://bws.bookrenter.com/v1'
+      @client = BWS::Client.new(@key)
+      @price_order_request_body_xml = File.read(File.join(File.dirname(__FILE__), '../fixtures', "price_order_request_body.xml"))
+      @checkout_price_order_hash = Hash.from_xml(@price_order_request_body_xml)['checkout_price_order']
+      @url = "/checkout/price_order.xml"
+      fake_post("#{@url_prefix}#{@url}?api_key=#{@key}", 'price_order_response_success.xml')
+    end
+
+    context ".price_order" do
+      should "checkout_verification_code not nil" do
+        @response = @client.checkout_price_order @checkout_price_order_hash
+        assert_not_nil @response.price_order['checkout_verification_code']
+      end
+
+      should "customer_verification_code not nil" do
+        @response = @client.checkout_price_order @checkout_price_order_hash
+        assert_not_nil @response.price_order['customer']['customer_verification_code']
+      end
+
+      should "product_list_verification_code not nil" do
+        @response = @client.checkout_price_order @checkout_price_order_hash
+        assert_not_nil @response.price_order['product_list']['product_list_verification_code']
+      end
+
+      should "billing_address_verification_code not nil" do
+        @response = @client.checkout_price_order @checkout_price_order_hash
+        assert_not_nil @response.price_order['billing_address']['billing_address_verification_code']
+      end
+
+      should "shipping_address_verification_code not nil" do
+        @response = @client.checkout_price_order @checkout_price_order_hash
+        assert_not_nil @response.price_order['shipping_address']['shipping_address_verification_code']
+      end
+    end
+
+  end
+
+  context "checkout validate credit card success" do
+    setup do
+      @key = 'my_api_key'
+      @url_prefix = 'https://bws.bookrenter.com/v1'
+      @client = BWS::Client.new(@key)
+      @validate_credit_card_request_body_xml = File.read(File.join(File.dirname(__FILE__), '../fixtures', "validate_credit_card_request_body.xml"))
+      @checkout_validate_credit_card_hash = Hash.from_xml(@validate_credit_card_request_body_xml)['checkout_validate_credit_card']
+      @url = "/checkout/validate_credit_card.xml"
+      fake_post("#{@url_prefix}#{@url}?api_key=#{@key}", 'validate_credit_card_response_success.xml')
+    end
+
+    context ".validate_credit_card" do
+      should "checkout_verification_code not nil" do
+        @response = @client.checkout_validate_credit_card @checkout_validate_credit_card_hash
+        assert_not_nil @response.validate_credit_card['checkout_verification_code']
+      end
+
+      should "credit_card_verification_code not nil" do
+        @response = @client.checkout_validate_credit_card @checkout_validate_credit_card_hash
+        assert_not_nil @response.validate_credit_card['credit_card']['credit_card_verification_code']
+      end
+    end
+
+  end
+
+  context "checkout create order success" do
+    setup do
+      @key = 'my_api_key'
+      @url_prefix = 'https://bws.bookrenter.com/v1'
+      @client = BWS::Client.new(@key)
+      @create_order_request_body_xml = File.read(File.join(File.dirname(__FILE__), '../fixtures', "create_order_request_body.xml"))
+      @checkout_create_order_hash = Hash.from_xml(@create_order_request_body_xml)['checkout_create_order']
+      @url = "/checkout/create_order.xml"
+      fake_post("#{@url_prefix}#{@url}?api_key=#{@key}", 'create_order_response_success.xml')
+    end
+
+    context ".create_order" do
+      should "checkout_verification_code not nil" do
+        @response = @client.checkout_create_order @checkout_create_order_hash
+        assert_not_nil @response.create_order['checkout_verification_code']
+      end
+
+      should "public_id not nil" do
+        @response = @client.checkout_create_order @checkout_create_order_hash
+        assert_not_nil @response.create_order['order']['public_id']
+      end
+    end
+
+  end
+
+  context "checkout single post create order success" do
+    setup do
+      @key = 'my_api_key'
+      @url_prefix = 'https://bws.bookrenter.com/v1'
+      @client = BWS::Client.new(@key)
+      @single_post_create_order_request_body_xml = File.read(File.join(File.dirname(__FILE__), '../fixtures', "single_post_create_order_request_body.xml"))
+      @checkout_single_post_create_order_hash = Hash.from_xml(@single_post_create_order_request_body_xml)['checkout_single_post_create_order']
+      @url = "/checkout/single_post_create_order.xml"
+      fake_post("#{@url_prefix}#{@url}?api_key=#{@key}", 'single_post_create_order_response_success.xml')
+    end
+
+    context ".single_post_create_order" do
+      should "public_id not nil" do
+        @response = @client.checkout_single_post_create_order @checkout_single_post_create_order_hash
+        assert_not_nil @response.single_post_create_order['order']['public_id']
+      end
+    end
+
+  end
+end

data/test/unit/test_bws_client.rb

@@ -0,0 +1,370 @@
+require 'helper'
+require 'active_support/core_ext'
+
+class TestBwsClient < Test::Unit::TestCase
+  def setup
+    FakeWeb.allow_net_connect = false
+  end
+
+  context "initializing" do
+    should "accept and store an API KEY" do
+      client = BWS::Client.new('my_api_key')
+      assert_equal BWS::Client, client.class
+      assert_equal client.api_key, 'my_api_key'
+    end
+
+    should "accept an use an optional passed in base_uri" do
+      client = BWS::Client.new('my_api_key', 'http://some_uri.com')
+      assert_equal client.base_uri, 'http://some_uri.com'
+      BWS::Client.expects(:get).with('http://some_uri.com/distributor_orders/unacknowledged.xml?page=1&api_key=my_api_key', :timeout => 5)
+      client.unacknowledged_orders
+    end
+
+    should "raise an error if no API KEY is passed in" do
+      assert_raise(BWS::Client::MissingApiKey) { BWS::Client.new() }
+    end
+  end
+
+  context "with a working client" do
+    setup do
+      @key = 'my_api_key'
+      @url_prefix = 'https://bws.bookrenter.com/v1'
+      @client = BWS::Client.new(@key)
+    end
+
+    context "requesting unacknowledged orders" do
+      setup do
+        @url = "/distributor_orders/unacknowledged.xml?page=1"
+        fake_get("#{@url_prefix}#{@url}&api_key=#{@key}", 'unacknowledged_success.xml')
+      end
+
+      should "load the API page" do
+        @client.expects(:get).with(@url)
+        @client.unacknowledged_orders
+      end
+
+      should "return a BWS::UnacknowledgedOrders object" do
+        assert_equal BWS::UnacknowledgedOrders, @client.unacknowledged_orders.class
+      end
+
+      should "load subsequent pages" do
+        @client.expects(:get).with(@url.gsub!('page=1', 'page=3'))
+        @client.unacknowledged_orders(3)
+      end
+    end
+
+    context "requesting fillable orders" do
+      setup do
+        @url = "/distributor_orders/fillable.xml?page=1"
+        fake_get("#{@url_prefix}#{@url}&api_key=#{@key}", 'fillable_success.xml')
+      end
+
+      should "load the API page" do
+        @client.expects(:get).with(@url)
+        @client.fillable_orders
+      end
+
+      should "return a BWS::FillableOrders object" do
+        assert_equal BWS::FillableOrders, @client.fillable_orders.class
+      end
+
+      should "load subsequent pages" do
+        @client.expects(:get).with(@url.gsub!('page=1', 'page=3'))
+        @client.fillable_orders(3)
+      end
+    end
+
+    context "requesting an order" do
+      setup do
+        @order_id = 'test_order_id'
+        @url = "/distributor_orders/#{@order_id}.xml"
+        fake_get("#{@url_prefix}#{@url}?api_key=#{@key}", 'order_success.xml')
+      end
+
+      should "load the API page" do
+        @client.expects(:get).with(@url)
+        @client.order(@order_id)
+      end
+
+      should "raise an error if there is no order_id passed in" do
+        assert_raise(BWS::Client::BadParams) { @client.order }
+      end
+
+      should "return a BWS::Order object" do
+        assert_equal BWS::Order, @client.order(@order_id).class
+      end
+    end
+
+    context "acknowledging an order" do
+      setup do
+        @order_id = 'test_order_id'
+        @order_hash = {'order' => 'data', 'public_id' => @order_id, 'distributor_line_items' => {'distributor_line_item' => {'public_id' => 'some-line-item-public-id', 'status' => 'accepted'}}}
+        @url = "/distributor_orders/#{@order_id}/acknowledge.xml"
+        fake_post("#{@url_prefix}#{@url}?api_key=#{@key}", 'acknowledge_success.xml')
+      end
+
+      should "raise an error if there is no hash passed in" do
+        assert_raise(BWS::Client::BadParams) { @client.acknowledge_order }
+      end
+
+      should "post to the order acknowledge page" do
+        @client.expects(:post).with(@url, '<envelope><body><distributor_orders_acknowledge><distributor_order><public_id>test_order_id</public_id><distributor_line_items><distributor_line_item><public_id>some-line-item-public-id</public_id><status>accepted</status></distributor_line_item></distributor_line_items></distributor_order></distributor_orders_acknowledge></body></envelope>')
+        @client.acknowledge_order(@order_hash)
+      end
+
+      should "return a BWS::AcknowledgeOrder object" do
+        assert_equal BWS::AcknowledgeOrder, @client.acknowledge_order(@order_hash).class
+      end
+    end
+
+    context "creating a shipment" do
+      setup do
+        @order_id = 'test_order_id'
+        @order_hash = {'order' => 'data', 'public_id' => @order_id, 'distributor_line_items' => []}
+        @url = "/distributor_orders/#{@order_id}/distributor_outbound_shipments.xml"
+        fake_post("#{@url_prefix}#{@url}?api_key=#{@key}", 'create_shipment_success.xml')
+      end
+
+      should "raise an error if there is no hash passed in" do
+        assert_raise(BWS::Client::BadParams) { @client.create_shipment }
+      end
+
+      should "post to the order acknowledge page" do
+        @client.expects(:post).with(@url, '<envelope><body><distributor_outbound_shipments_create><distributor_outbound_shipment><shipping_method></shipping_method><carrier></carrier><distributor_line_items></distributor_line_items></distributor_outbound_shipment></distributor_outbound_shipments_create></body></envelope>')
+        @client.create_shipment(@order_hash)
+      end
+
+      should "return a BWS::CreateShipment object" do
+        assert_equal BWS::CreateShipment, @client.create_shipment(@order_hash).class
+      end
+    end
+
+    context "cancelling a line item" do
+      setup do
+        @order_id = 'test_order_id'
+        @order_hash = {'order' => 'data', 'public_id' => @order_id}
+        @url = "/distributor_line_items/#{@order_id}/reject.xml"
+        fake_post("#{@url_prefix}#{@url}?api_key=#{@key}", 'cancel_line_item_success.xml')
+      end
+
+      should "raise an error if there is no hash passed in" do
+        assert_raise(BWS::Client::BadParams) { @client.reject_line_item }
+      end
+
+      should "post to the order acknowledge page" do
+        @client.expects(:post).with(@url, '<envelope><body><distributor_line_items_reject><distributor_line_item><public_id>test_order_id</public_id><status>rejected</status><reject_reason></reject_reason></distributor_line_item></distributor_line_items_reject></body></envelope>')
+        @client.reject_line_item(@order_hash)
+      end
+
+      should "return a BWS::RejectLineItem object" do
+        assert_equal BWS::RejectLineItem, @client.reject_line_item(@order_hash).class
+      end
+    end
+
+    #
+    # This context concentrates on the inventory portion of the API
+    #
+    context "Acquiring Inventory" do
+      setup do
+        @url = "/inventory_books.xml"
+        fake_get("#{@url_prefix}#{@url}?api_key=#{@key}", 'inventory_success.xml')
+      end
+
+      should "Should return an BWS::Inventory object" do
+        assert_equal BWS::Inventory, @client.retrieve_inventory.class
+      end
+
+    end
+
+    context "Acquiring Inventory By ISBN" do
+      setup do
+        @isbn = "9780007138210"
+        @url = "/inventory_books/#{@isbn}.xml"
+        fake_get("#{@url_prefix}#{@url}?api_key=#{@key}", 'inventory_by_isbn_success.xml')
+      end
+
+      should "Should return an BWS::Inventory object" do
+        assert_equal BWS::Inventory, @client.retrieve_inventory_by_isbn(@isbn, nil).class
+      end
+
+    end
+
+    #
+    # This context concentrates on the order_events portion of the API
+    #
+    context "Acquiring OrderEvents" do
+      setup do
+        @url = "/order_events.xml"
+        fake_get("#{@url_prefix}#{@url}?api_key=#{@key}", 'order_events_success.xml')
+      end
+
+      should "Should return an BWS::OrderEvents object" do
+        assert_equal BWS::OrderEvents, @client.retrieve_order_events.class
+      end
+
+    end
+
+    context "Acquiring OrderEvents By Order" do
+      setup do
+        @br_order_id = 'BR-A07824046'
+        @url = "/order_events/#{@br_order_id}.xml"
+        fake_get("#{@url_prefix}#{@url}?api_key=#{@key}", 'order_events_by_order_success.xml')
+      end
+
+      should "Should return an BWS::OrderEvents object" do
+        assert_equal BWS::OrderEvents, @client.retrieve_order_events_by_order(nil, @br_order_id).class
+      end
+
+    end
+
+    #
+    # This context concentrates on the checkout price order portion of the API
+    #
+    context "checkout price order" do
+      setup do
+        @price_order_request_body_xml = File.read(File.join(File.dirname(__FILE__), '../fixtures', "price_order_request_body.xml"))
+        @checkout_price_order_hash = Hash.from_xml(@price_order_request_body_xml)['checkout_price_order']
+        @url = "/checkout/price_order.xml"
+        fake_post("#{@url_prefix}#{@url}?api_key=#{@key}", 'price_order_response_success.xml')
+      end
+
+      should "raise an error if there is no hash passed in" do
+        assert_raise(BWS::Client::BadParams) { @client.checkout_price_order }
+      end
+
+      should "post to the checkout_price_order" do
+        @client.checkout_price_order(@checkout_price_order_hash)
+      end
+
+      should "return a BWS::Checkout object" do
+        assert_equal BWS::Checkout, @client.checkout_price_order(@checkout_price_order_hash).class
+      end
+    end
+
+    #
+    # This context concentrates on the checkout validate credit card portion of the API
+    #
+    context "checkout validate credit card " do
+      setup do
+        @validate_credit_card_request_body_xml = File.read(File.join(File.dirname(__FILE__), '../fixtures', "validate_credit_card_request_body.xml"))
+        @checkout_validate_credit_card_hash = Hash.from_xml(@validate_credit_card_request_body_xml)['checkout_validate_credit_card']
+        @url = "/checkout/validate_credit_card.xml"
+        fake_post("#{@url_prefix}#{@url}?api_key=#{@key}", 'validate_credit_card_response_success.xml')
+      end
+
+      should "raise an error if there is no hash passed in" do
+        assert_raise(BWS::Client::BadParams) { @client.checkout_validate_credit_card }
+      end
+
+      should "post to the checkout_validate_credit_card" do
+        @client.checkout_validate_credit_card(@checkout_validate_credit_card_hash)
+      end
+
+      should "return a BWS::Checkout object" do
+        assert_equal BWS::Checkout, @client.checkout_validate_credit_card(@checkout_validate_credit_card_hash).class
+      end
+    end
+
+    #
+    # This context concentrates on the checkout create order portion of the API
+    #
+    context "checkout create order" do
+      setup do
+        @create_order_request_body_xml = File.read(File.join(File.dirname(__FILE__), '../fixtures', "create_order_request_body.xml"))
+        @checkout_create_order_hash = Hash.from_xml(@create_order_request_body_xml)['checkout_create_order']
+        @url = "/checkout/create_order.xml"
+        fake_post("#{@url_prefix}#{@url}?api_key=#{@key}", 'create_order_response_success.xml')
+      end
+
+      should "raise an error if there is no hash passed in" do
+        assert_raise(BWS::Client::BadParams) { @client.checkout_create_order }
+      end
+
+      should "post to the checkout_create_order" do
+        @client.checkout_create_order(@checkout_create_order_hash)
+      end
+
+      should "return a BWS::Checkout object" do
+        assert_equal BWS::Checkout, @client.checkout_create_order(@checkout_create_order_hash).class
+      end
+    end
+
+    #
+    # This context concentrates on the checkout create order portion of the API
+    #
+    context "checkout single post create order" do
+      setup do
+        @single_post_create_order_request_body_xml = File.read(File.join(File.dirname(__FILE__), '../fixtures', "single_post_create_order_request_body.xml"))
+        @checkout_single_post_create_order_hash = Hash.from_xml(@single_post_create_order_request_body_xml)['checkout_single_post_create_order']
+        @url = "/checkout/single_post_create_order.xml"
+        fake_post("#{@url_prefix}#{@url}?api_key=#{@key}", 'single_post_create_order_response_success.xml')
+      end
+
+      should "raise an error if there is no hash passed in" do
+        assert_raise(BWS::Client::BadParams) { @client.checkout_single_post_create_order }
+      end
+
+      should "post to the checkout_single_post_create_order" do
+        @client.checkout_single_post_create_order(@checkout_single_post_create_order_hash)
+      end
+
+      should "return a BWS::Checkout object" do
+        assert_equal BWS::Checkout, @client.checkout_single_post_create_order(@checkout_single_post_create_order_hash).class
+      end
+    end
+
+    #
+    # This context concentrates on the orders portion of the API
+    #
+    context "Acquiring Orders by public_id" do
+      setup do
+        @public_id = "public_id"
+        @url = "/orders/#{@public_id}.xml"
+        fake_get("#{@url_prefix}#{@url}?api_key=#{@key}", 'orders_show_success.xml')
+      end
+
+      should "Should return an BWS::Orders object" do
+        assert_equal BWS::Orders, @client.retrieve_orders_show(@public_id).class
+      end
+
+    end
+
+    context "Acquiring Orders By external_order_id" do
+      setup do
+        @external_order_id = "external_order_id"
+        @url = "/orders/#{@external_order_id}.xml"
+        fake_get("#{@url_prefix}#{@url}?api_key=#{@key}", 'orders_show_success.xml')
+      end
+
+      should "Should return an BWS::Orders object" do
+        assert_equal BWS::Orders, @client.retrieve_orders_show(@external_order_id).class
+      end
+
+    end
+
+    #
+    # This context concentrates on the active isbn report portion of the API
+    #
+    context "active isbn report" do
+      setup do
+        @active_isbn_report_request_body_xml = File.read(File.join(File.dirname(__FILE__), '../fixtures', "active_isbn_report_with_one_isbn_request_body.xml"))
+        @active_isbn_report_hash = Hash.from_xml(@active_isbn_report_request_body_xml)["reports_active_isbn_report"]
+        @url = "/reports/active_isbn_report.xml"
+        fake_post("#{@url_prefix}#{@url}?api_key=#{@key}", 'active_isbn_report_with_one_isbn_success.xml')
+      end
+
+      should "raise an error if there is no hash passed in" do
+        assert_raise(BWS::Client::BadParams) { @client.retrieve_active_isbn_report }
+      end
+
+      should "post to active_isbn_report" do
+        @client.retrieve_active_isbn_report(@active_isbn_report_hash)
+      end
+
+      should "return a BWS::Checkout object" do
+        assert_equal BWS::ActiveIsbnReport, @client.retrieve_active_isbn_report(@active_isbn_report_hash).class
+      end
+    end
+
+  end
+end