/spec/cheddargetter_spec.rb

require File.expand_path(File.dirname(__FILE__) + '/spec_helper')

describe "an instance of CheddarGetter" do
  before(:all) do
    CheddarGetter.stub!(:basic_auth)
    @cheddar_getter = CheddarGetter.new('my_username', 'my_password', 'MY_PRODUCT')
  end
  
  it "should use the supplied username and password for basic auth" do
    CheddarGetter.should_receive(:basic_auth).with('my_username', 'my_password')
    CheddarGetter.new('my_username', 'my_password', 'MY_PRODUCT')
  end
  
  describe 'calling #plans' do
    it "should return an empty array if there are no plans" do
      mock_request(:get, "/plans/get/productCode/MY_PRODUCT", "<plans></plans>")
      @cheddar_getter.plans.should == []
    end

    it "should return the plan in an array if there is one plan" do
      mock_request(:get, "/plans/get/productCode/MY_PRODUCT", "<plans><plan>plan1</plan></plans>")
      plans = @cheddar_getter.plans
      plans.length.should == 1
      plans.should include('plan1')
    end
    
    it "should return the plans in an array if there are multiple plans" do
      mock_request(:get, "/plans/get/productCode/MY_PRODUCT", "<plans><plan>plan1</plan><plan>plan2</plan></plans>")
      plans = @cheddar_getter.plans
      plans.length.should == 2
      plans.should include('plan1')
      plans.should include('plan2')
    end

    it "should raise if an error is returned" do
      mock_request(:get, "/plans/get/productCode/MY_PRODUCT", "<error>the message</error>")
      lambda { @cheddar_getter.plans }.should raise_error(CheddarGetter::Error, 'the message')
    end
  end
  
  describe 'calling #plan(plan_code)' do
    it "should return the requested plan if the plan code is valid" do
      (1..3).each do |i|
        mock_request(:get, "/plans/get/productCode/MY_PRODUCT/code/MY_PLAN#{i}", "<plans><plan>plan#{i}</plan></plans>")
        @cheddar_getter.plan("MY_PLAN#{i}").should == "plan#{i}"
      end
    end
    
    it "should raise if the plan code is not valid" do
      mock_request(:get, "/plans/get/productCode/MY_PRODUCT/code/BAD_CODE", "<error>bad code</error>")
      lambda { @cheddar_getter.plan('BAD_CODE') }.should raise_error(CheddarGetter::Error, 'bad code')
    end
  end

  describe 'calling #customers' do
    it "should return an empty array if there are no customers" do
      mock_request(:get, "/customers/get/productCode/MY_PRODUCT", "<customers></customers>")
      @cheddar_getter.customers.should == []
    end
    
    it "should return an empty array if there is a stupid, inconsistent error about there being no customers" do
      mock_request(:get, "/customers/get/productCode/MY_PRODUCT", "<error>Bad request: No customers found</error>")
      @cheddar_getter.customers.should == []
    end

    it "should return the customer in an array if there is one customer" do
      mock_request(:get, "/customers/get/productCode/MY_PRODUCT", "<customers><customer>customer1</customer></customers>")
      customers = @cheddar_getter.customers
      customers.length.should == 1
      customers.should include('customer1')
    end
    
    it "should return the customers in an array if there are multiple customers" do
      mock_request(:get, "/customers/get/productCode/MY_PRODUCT", "<customers><customer>customer1</customer><customer>customer2</customer></customers>")
      customers = @cheddar_getter.customers
      customers.length.should == 2
      customers.should include('customer1')
      customers.should include('customer2')
    end
    
    it "should raise if an error is returned" do
      mock_request(:get, "/customers/get/productCode/MY_PRODUCT", "<error>the message</error>")
      lambda { @cheddar_getter.customers }.should raise_error(CheddarGetter::Error, 'the message')
    end
  end

  describe 'calling #customer(customer_code)' do
    it "should return the requested customer if the customer code is valid" do
      (1..3).each do |i|
        mock_request(:get, "/customers/get/productCode/MY_PRODUCT/code/MY_CUSTOMER#{i}", "<customers><customer>customer#{i}</customer></customers>")
        @cheddar_getter.customer("MY_CUSTOMER#{i}").should == "customer#{i}"
      end
    end
    
    it "should raise if the customer code is not valid" do
      mock_request(:get, "/customers/get/productCode/MY_PRODUCT/code/BAD_CODE", "<error>bad code</error>")
      lambda { @cheddar_getter.customer('BAD_CODE') }.should raise_error(CheddarGetter::Error, 'bad code')
    end
  end
  
  describe 'calling #create_customer(attributes)' do
    it "should return the created customer" do
      mock_request(:post, "/customers/new/productCode/MY_PRODUCT", "<customers><customer>new customer</customer></customers>")
      @cheddar_getter.create_customer(:name => 'justin', :age => 12).should == "new customer"
    end
    
    it "should raise if an error is returned" do
      mock_request(:post, "/customers/new/productCode/MY_PRODUCT", "<error>failed create</error>")
      lambda { @cheddar_getter.create_customer(:name => 'justin') }.should raise_error(CheddarGetter::Error, 'failed create')
    end
  end
  
  describe 'calling #update_customer(customer_code, attributes)' do
    it "should return the updated customer" do
      mock_request(:post, "/customers/edit/productCode/MY_PRODUCT/code/MY_CUSTOMER", "<customers><customer>updated customer</customer></customers>")
      @cheddar_getter.update_customer('MY_CUSTOMER', :name => "new name").should == "updated customer"
    end
    
    it "should raise if an error is returned" do
      mock_request(:post, "/customers/edit/productCode/MY_PRODUCT/code/MY_CUSTOMER", "<error>failed update</error>")
      lambda { @cheddar_getter.update_customer('MY_CUSTOMER', :name => "new name") }.should raise_error(CheddarGetter::Error, 'failed update')
    end
  end
  
  describe 'calling #cancel_subscription(customer_code)' do
    it "should return the updated customer" do
      mock_request(:post, "/customers/cancel/productCode/MY_PRODUCT/code/MY_CUSTOMER", "<customers><customer>updated customer</customer></customers>")
      @cheddar_getter.cancel_subscription('MY_CUSTOMER').should == "updated customer"
    end
    
    it "should raise if an error is returned" do
      mock_request(:post, "/customers/cancel/productCode/MY_PRODUCT/code/MY_CUSTOMER", "<error>failed update</error>")
      lambda { @cheddar_getter.cancel_subscription('MY_CUSTOMER') }.should raise_error(CheddarGetter::Error, 'failed update')
    end
  end
  
  describe 'calling #update_subscription(customer_code, attributes)' do
    it "should return the updated customer" do
      mock_request(:post, "/customers/edit-subscription/productCode/MY_PRODUCT/code/MY_CUSTOMER", "<customers><customer>updated customer</customer></customers>")
      @cheddar_getter.update_subscription('MY_CUSTOMER', :ccNumber => 'new-credit-card').should == "updated customer"
    end
    
    it "should raise if an error is returned" do
      mock_request(:post, "/customers/edit-subscription/productCode/MY_PRODUCT/code/MY_CUSTOMER", "<error>failed update</error>")
      lambda { @cheddar_getter.update_subscription('MY_CUSTOMER', :ccNumber => 'new-credit-card') }.should raise_error(CheddarGetter::Error, 'failed update')
    end
  end
  
  describe 'calling #delete_all_customers' do
    it "should delete all the customers" do
      mock_request(:post, "/customers/delete-all/confirm/1/productCode/MY_PRODUCT", "")
      @cheddar_getter.delete_all_customers
    end
    
    it "should raise if an error is returned" do
      mock_request(:post, "/customers/delete-all/confirm/1/productCode/MY_PRODUCT", "<error>failed update</error>")
      lambda { @cheddar_getter.delete_all_customers }.should raise_error(CheddarGetter::Error, 'failed update')
    end
  end
  
  describe 'calling #delete_customer(customer_code)' do
    it "should delete the customer" do
      mock_request(:post, "/customers/delete/productCode/MY_PRODUCT/code/MY_CUSTOMER", "")
      @cheddar_getter.delete_customer('MY_CUSTOMER')
    end
    
    it "should raise if an error is returned" do
      mock_request(:post, "/customers/delete/productCode/MY_PRODUCT/code/MY_CUSTOMER", "<error>failed update</error>")
      lambda { @cheddar_getter.delete_customer('MY_CUSTOMER') }.should raise_error(CheddarGetter::Error, 'failed update')
    end
  end
  
  describe 'calling #add_item(customer_code, item_code, quantity)' do
    it "should return the updated customer" do
      mock_request(:post, "/customers/add-item-quantity/productCode/MY_PRODUCT/code/MY_CUSTOMER/itemCode/MY_ITEM", "<customers><customer>updated customer</customer></customers>")
      @cheddar_getter.add_item('MY_CUSTOMER', 'MY_ITEM').should == "updated customer"
    end
    
    it "should raise if an error is returned" do
      mock_request(:post, "/customers/add-item-quantity/productCode/MY_PRODUCT/code/MY_CUSTOMER/itemCode/MY_ITEM", "<error>failed update</error>")
      lambda { @cheddar_getter.add_item('MY_CUSTOMER', 'MY_ITEM') }.should raise_error(CheddarGetter::Error, 'failed update')
    end
  end
  
  describe 'calling #remove_item(customer_code, item_code, quantity)' do
    it "should return the updated customer" do
      mock_request(:post, "/customers/remove-item-quantity/productCode/MY_PRODUCT/code/MY_CUSTOMER/itemCode/MY_ITEM", "<customers><customer>updated customer</customer></customers>")
      @cheddar_getter.remove_item('MY_CUSTOMER', 'MY_ITEM').should == "updated customer"
    end
    
    it "should raise if an error is returned" do
      mock_request(:post, "/customers/remove-item-quantity/productCode/MY_PRODUCT/code/MY_CUSTOMER/itemCode/MY_ITEM", "<error>failed update</error>")
      lambda { @cheddar_getter.remove_item('MY_CUSTOMER', 'MY_ITEM') }.should raise_error(CheddarGetter::Error, 'failed update')
    end
  end
  
  describe 'calling #item_quantity(customer_code, item_code, quantity)' do
    it "should return the updated customer" do
      mock_request(:post, "/customers/set-item-quantity/productCode/MY_PRODUCT/code/MY_CUSTOMER/itemCode/MY_ITEM", "<customers><customer>updated customer</customer></customers>")
      @cheddar_getter.item_quantity('MY_CUSTOMER', 'MY_ITEM', 1).should == "updated customer"
    end
    
    it "should raise if an error is returned" do
      mock_request(:post, "/customers/set-item-quantity/productCode/MY_PRODUCT/code/MY_CUSTOMER/itemCode/MY_ITEM", "<error>failed update</error>")
      lambda { @cheddar_getter.item_quantity('MY_CUSTOMER', 'MY_ITEM', 1) }.should raise_error(CheddarGetter::Error, 'failed update')
    end
  end
  
  describe 'calling #add_charge(customer_code, item_code, charge_code, quantity, each_amount, description)' do
    it "should return the updated customer" do
      mock_request(:post, "/customers/add-charge/productCode/MY_PRODUCT/code/MY_CUSTOMER/itemCode/MY_ITEM", "<customers><customer>updated customer</customer></customers>")
      @cheddar_getter.add_charge('MY_CUSTOMER', 'MY_ITEM', 'charge_code', 5, 2, 'description').should == "updated customer"
    end
    
    it "should raise if an error is returned" do
      mock_request(:post, "/customers/add-charge/productCode/MY_PRODUCT/code/MY_CUSTOMER/itemCode/MY_ITEM", "<error>failed update</error>")
      lambda { @cheddar_getter.add_charge('MY_CUSTOMER', 'MY_ITEM', 'charge_code', 5, 2, 'description') }.should raise_error(CheddarGetter::Error, 'failed update')
    end
    
    it "should raise if charge code is out of bounds" do
      lambda { @cheddar_getter.add_charge('MY_CUSTOMER', 'MY_ITEM', 'the quick brown fox jumped over the lazy dog.  silly lazy dog, quit being so lazy', 5, 2, 'description') }.should raise_error(CheddarGetter::Error, 'charge code must be less than 36 characters long')
    end
    
    it "should raise if quantity is negative" do
      lambda { @cheddar_getter.add_charge('MY_CUSTOMER', 'MY_ITEM', 'the quick brown fox.', -1, 2, 'description') }.should raise_error(CheddarGetter::Error, 'quantity must be positive')
    end
  end
  
  def mock_request(method, request_path, response_xml)
    request_path.gsub!(/^\//, '')
    options = { :body => response_xml, :content_type =>  "text/xml" }
    FakeWeb.register_uri(method, "https://cheddargetter.com/xml/#{request_path}", options)
  end
end