ryanwood-mousetrap 0.5.6

data/spec/mousetrap/customer_spec.rb

@@ -0,0 +1,437 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Mousetrap::Customer do
+  include Fixtures
+
+  def customer_attributes_for_api(customer)
+    {
+      :firstName => customer.first_name,
+      :lastName => customer.last_name,
+      :email => customer.email,
+      :company => customer.company,
+      :code => customer.code,
+      :subscription => {
+        :planCode     => customer.subscription.plan_code,
+        :ccFirstName  => customer.subscription.billing_first_name,
+        :ccLastName   => customer.subscription.billing_last_name,
+        :ccNumber     => customer.subscription.credit_card_number,
+        :ccExpMonth   => customer.subscription.credit_card_expiration_month,
+        :ccExpYear    => customer.subscription.credit_card_expiration_year,
+        :ccZip        => customer.subscription.billing_zip_code,
+        :ccCountry    => customer.subscription.billing_country,
+        :ccAddress    => customer.subscription.billing_address,
+        :ccCity       => customer.subscription.billing_city,
+        :ccState      => customer.subscription.billing_state
+      }
+    }
+  end
+
+  describe "when having multiple subscriptions" do
+    it "returns the latest one" do
+      Mousetrap::Customer.new_from_api(full_customer).subscription.should_not be_nil
+    end
+  end
+
+  describe '.all' do
+    before do
+      Mousetrap::Customer.stub :build_resources_from
+    end
+
+    it "gets all customers" do
+      Mousetrap::Customer.should_receive(:get_resources).with('customers').and_return('some hash')
+      Mousetrap::Customer.all
+    end
+
+    it "handles kludgy 'no customers found' response" do
+      Mousetrap::Customer.stub :get_resources => {
+        'error' => 'Resource not found: No customers found.'
+      }
+      Mousetrap::Customer.all.should == []
+    end
+
+    it "raises error if response has one" do
+      expect do
+        Mousetrap::Customer.stub :get_resources => { 'error' => "some other error" }
+        Mousetrap::Customer.all
+      end.to raise_error(RuntimeError, "some other error")
+    end
+
+    it "builds resources from the response" do
+      Mousetrap::Customer.stub :get_resources => 'some hash'
+      Mousetrap::Customer.should_receive(:build_resources_from).with('some hash')
+      Mousetrap::Customer.all
+    end
+  end
+
+  describe '.create' do
+    before do
+      @customer_hash = Factory.attributes_for :new_customer
+      @customer = Mousetrap::Customer.new @customer_hash
+      @customer.stub :create
+      Mousetrap::Customer.stub(:new => @customer)
+      Mousetrap::Customer.stub(:build_resource_from => stub(:id => 0))
+    end
+
+    it 'instantiates a customer with a hash of attributes' do
+      Mousetrap::Customer.should_receive(:new).with(@customer_hash).and_return(@customer)
+      Mousetrap::Customer.create(@customer_hash)
+    end
+
+    it 'creates the new customer instance' do
+      @customer.should_receive :create
+      Mousetrap::Customer.create(@customer_hash)
+    end
+
+    it 'returns an instance of Mousetrap::Customer' do
+      Mousetrap::Customer.create(@customer_hash).should be_instance_of(Mousetrap::Customer)
+    end
+  end
+
+  describe ".new" do
+    subject do
+      Mousetrap::Customer.new \
+        :first_name => 'Jon',
+        :last_name => 'Larkowski',
+        :email => 'lark@example.com',
+        :code => 'asfkhw0'
+    end
+
+    it { should be_instance_of(Mousetrap::Customer) }
+    it { should be_new_record }
+
+    describe "sets" do
+      it 'first_name' do
+        subject.first_name.should == 'Jon'
+      end
+
+      it 'last_name' do
+        subject.last_name.should == 'Larkowski'
+      end
+
+      it 'email' do
+        subject.email.should == 'lark@example.com'
+      end
+
+      it 'code' do
+        subject.code.should == 'asfkhw0'
+      end
+    end
+  end
+
+  describe '.update' do
+    def do_update
+      Mousetrap::Customer.update('some customer code', 'some attributes')
+    end
+
+    it "makes a new customer from the attributes" do
+      Mousetrap::Customer.should_receive(:new).with('some attributes').and_return(stub(:null_object => true))
+      do_update
+    end
+
+    it "sets the new customer code to the argument" do
+      customer = mock
+      customer.stub :update
+      Mousetrap::Customer.stub :new => customer
+      customer.should_receive(:code=).with('some customer code')
+      do_update
+    end
+
+    it "calls #update" do
+      customer = mock(:null_object => true)
+      Mousetrap::Customer.stub :new => customer
+      customer.should_receive :update
+      do_update
+    end
+  end
+
+  describe '#cancel' do
+    context "for existing records" do
+      it 'cancels' do
+        customer = Factory :existing_customer
+        customer.should_receive(:member_action).with('cancel')
+        customer.cancel
+      end
+    end
+
+    context "for new records" do
+      it "does nothing" do
+        customer = Factory.build :new_customer
+        customer.should_not_receive(:member_action).with('cancel')
+        customer.cancel
+      end
+    end
+  end
+
+  describe "#new?" do
+    it "looks up the customer on CheddarGetter" do
+      c = Mousetrap::Customer.new :code => 'some_customer_code'
+      Mousetrap::Customer.should_receive(:[]).with('some_customer_code')
+      c.new?
+    end
+
+    context "with an existing CheddarGetter record" do
+      before do
+        Mousetrap::Customer.stub(:[] => stub(:id => 'some_customer_id'))
+      end
+
+      it "grabs the id from CheddarGetter and assigns it locally" do
+        c = Mousetrap::Customer.new :code => 'some_customer_code'
+        c.should_receive(:id=).with('some_customer_id')
+        c.new?
+      end
+
+      it "is false" do
+        c = Mousetrap::Customer.new
+        c.should_not be_new
+      end
+    end
+
+    context "without a CheddarGetter record" do
+      before do
+        Mousetrap::Customer.stub :[] => nil
+      end
+
+      it "is true" do
+        c = Mousetrap::Customer.new
+        c.should be_new
+      end
+    end
+  end
+
+  describe '#save' do
+    context "for existing records" do
+      before do
+        @customer = Factory :existing_customer
+        @customer.stub :new? => false
+      end
+
+      context "with subscription association set up" do
+        it 'posts to edit action' do
+          attributes_for_api = customer_attributes_for_api(@customer)
+
+          # We don't send code for existing API resources.
+          attributes_for_api.delete(:code)
+
+          @customer.class.should_receive(:put_resource).with('customers', 'edit', @customer.code, attributes_for_api).and_return({:id => 'some_id'})
+          @customer.save
+        end
+      end
+
+      context "with no subscription association" do
+        it 'posts to edit action' do
+          attributes_for_api = customer_attributes_for_api(@customer)
+
+          # We don't send code for existing API resources.
+          attributes_for_api.delete(:code)
+
+          attributes_for_api.delete(:subscription)
+          @customer.subscription = nil
+
+          @customer.class.should_receive(:put_resource).with('customers', 'edit-customer', @customer.code, attributes_for_api).and_return({:id => 'some_id'})
+          @customer.save
+        end
+      end
+    end
+
+    context "for new records" do
+      it 'calls create' do
+        customer = Factory :new_customer
+        customer.stub :new? => true
+        Mousetrap::Customer.stub :exists? => false
+        customer.should_receive(:create)
+        customer.save
+      end
+    end
+  end
+
+  describe "#switch_to_plan" do
+    it "raises an error if not existing CheddarGetter customer" do
+      c = Mousetrap::Customer.new :code => 'some_customer_code'
+      c.stub :exists? => false
+      expect { c.switch_to_plan 'some_plan_code' }.to raise_error(/existing/)
+    end
+
+    it "puts a subscription with a plan code" do
+      c = Mousetrap::Customer.new :code => 'some_customer_code'
+      c.stub :exists? => true
+      c.class.should_receive(:put_resource).with(
+        'customers', 'edit-subscription', 'some_customer_code', { :planCode => 'some_plan_code' })
+      c.switch_to_plan 'some_plan_code'
+    end
+  end
+
+  describe "protected methods" do
+    describe "#create" do
+      before do
+        @customer = Mousetrap::Customer.new
+        @customer.stub :attributes_for_api_with_subscription => 'some_attributes'
+      end
+
+      it "posts a new customer" do
+        @customer.class.should_receive(:post_resource).with('customers', 'new', 'some_attributes').and_return({:id => 'some_id'})
+        @customer.class.stub :build_resource_from => stub(:id => 'some_id')
+        @customer.send :create
+      end
+
+      it "raises error if CheddarGetter reports one" do
+        @customer.class.stub :post_resource => {'error' => 'some error message'}
+        expect { @customer.send(:create) }.to raise_error('some error message')
+      end
+
+      it "builds a customer from the CheddarGetter return values" do
+        @customer.class.stub :post_resource => 'some response'
+        @customer.class.should_receive(:build_resource_from).with('some response').and_return(stub(:id => 'some_id'))
+        @customer.send :create
+      end
+
+      it "grabs the id from CheddarGetter and assigns it locally" do
+        @customer.class.stub :post_resource => {}
+        @customer.class.stub :build_resource_from => stub(:id => 'some_id')
+        @customer.should_receive(:id=).with('some_id')
+        @customer.send :create
+      end
+
+      it "returns the response" do
+        @customer.class.stub :post_resource => { :some => :response }
+        @customer.class.stub :build_resource_from => stub(:id => 'some_id')
+        @customer.send(:create).should == { :some => :response }
+      end
+    end
+
+    describe "#update" do
+      context "when there's a subscription instance" do
+        let(:customer) { Mousetrap::Customer.new :code => 'some code' }
+
+        it "puts the customer with subscription when there's a subscription instance" do
+          customer.stub :subscription => stub
+          customer.stub :attributes_for_api_with_subscription => 'some attributes with subscription'
+          customer.class.should_receive(:put_resource).with('customers', 'edit', 'some code', 'some attributes with subscription').and_return({:id => 'some_id'})
+          customer.send :update
+        end
+
+        it "puts just the customer when no subscription instance" do
+          customer.stub :subscription => nil
+          customer.stub :attributes_for_api => 'some attributes'
+          customer.class.should_receive(:put_resource).with('customers', 'edit-customer', 'some code', 'some attributes').and_return({:id => 'some_id'})
+          customer.send :update
+        end
+
+        it "raises error if CheddarGetter reports one" do
+          customer.class.stub :put_resource => {'error' => 'some error message'}
+          expect { customer.send(:update) }.to raise_error('some error message')
+        end
+      end
+    end
+  end
+
+  describe '#add_custom_charge' do
+    context "when there's a subscription instance" do
+      before :all do
+        @customer = Factory(:new_customer)
+      end
+
+      it "should not raise an error with CheddarGetter" do
+        @customer.class.should_receive(:put_resource).with('customers', 'add-charge', @customer.code, { :eachAmount => 45.00, :chargeCode => 'BOGUS', :quantity => 1, :description => nil }).and_return({ :id => 'some_id' })
+        @customer.add_custom_charge('BOGUS', 45.00, 1, nil)
+      end
+    end
+
+    context "with there is not a subscription" do
+      before :all do
+        @customer = Mousetrap::Customer.new
+      end
+
+      it "should raise an error with CheddarGetter" do
+        @customer.class.stub :put_resource => { 'error' => 'some error message' }
+        expect { @customer.add_custom_charge('BOGUS') }.to raise_error('some error message')
+      end
+    end
+  end
+
+  # describe '#update_tracked_item_quantity' do
+  #   context "when there's a subscription instance" do
+  #     before do
+  #       @customer = Factory(:new_customer)
+  #     end
+  # 
+  #     it "should not raise an error with CheddarGetter" do
+  #       @customer.class.should_receive(:put_resource).with('customers', 'add-item-quantity', @customer.code, { :quantity => 1, :itemCode => 'BOGUS' }).and_return({ :id => 'some_id' })
+  #       @customer.update_tracked_item_quantity('BOGUS', 1).should_not raise_error
+  #     end
+  #   end
+  # end
+end
+
+
+__END__
+
+customers:
+  customer:
+    company:
+    lastName: cgejerpkyw
+    code: krylmrreef@example.com
+    subscriptions:
+      subscription:
+        plans:
+          plan:
+            name: Test
+            setupChargeAmount: "42.00"
+            code: TEST
+            recurringChargeAmount: "13.00"
+            billingFrequencyQuantity: "1"
+            trialDays: "0"
+            id: 8e933180-08b5-102d-a92d-40402145ee8b
+            billingFrequency: monthly
+            createdDatetime: "2009-10-12T19:28:09+00:00"
+            recurringChargeCode: TEST_RECURRING
+            isActive: "1"
+            billingFrequencyUnit: months
+            description: This is my test plan. There are many like it, but this one is mine.
+            billingFrequencyPer: month
+            setupChargeCode: TEST_SETUP
+        gatewayToken:
+        id: 7ccea6de-0a4d-102d-a92d-40402145ee8b
+        createdDatetime: "2009-10-14T20:08:14+00:00"
+        ccType: visa
+        ccLastFour: "1111"
+        ccExpirationDate: "2012-12-31T00:00:00+00:00"
+        canceledDatetime:
+        invoices:
+          invoice:
+          - number: "5"
+            transactions:
+              transaction:
+                response: approved
+                code: ""
+                amount: "42.00"
+                memo: This is a simulated transaction
+                id: 7ce53c78-0a4d-102d-a92d-40402145ee8b
+                createdDatetime: "2009-10-14T20:08:14+00:00"
+                transactedDatetime: "2009-10-14T20:08:14+00:00"
+                parentId:
+                charges:
+                  charge:
+                    code: TEST_SETUP
+                    quantity: "1"
+                    id: 7ce2cb6e-0a4d-102d-a92d-40402145ee8b
+                    createdDatetime: "2009-10-14T20:08:14+00:00"
+                    type: setup
+                    eachAmount: "42.00"
+                    description:
+                gatewayAccount:
+                  id: ""
+            billingDatetime: "2009-10-14T20:08:14+00:00"
+            id: 7cd25072-0a4d-102d-a92d-40402145ee8b
+            createdDatetime: "2009-10-14T20:08:14+00:00"
+            type: setup
+          - number: "6"
+            billingDatetime: "2009-11-14T20:08:14+00:00"
+            id: 7cd4253c-0a4d-102d-a92d-40402145ee8b
+            createdDatetime: "2009-10-14T20:08:14+00:00"
+            type: subscription
+    gatewayToken:
+    id: 7ccd6e5e-0a4d-102d-a92d-40402145ee8b
+    createdDatetime: "2009-10-14T20:08:14+00:00"
+    modifiedDatetime: "2009-10-14T20:08:14+00:00"
+    firstName: wqaqyhjdfg
+    email: krylmrreef@example.com

data/spec/mousetrap/plan_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Mousetrap::Plan do
+  # name: Test
+  # billingFrequencyQuantity: "1"
+  # code: TEST
+  # recurringChargeAmount: "42.00"
+  # createdDatetime: "2009-08-25T04:24:34+00:00"
+  # id: 5fbb9a84-e27f-102c-a92d-40402145ee8b
+  # isActive: "1"
+  # billingFrequency: monthly
+  # description: Test
+  # trialDays: "0"
+  # setupChargeCode: TEST_SETUP
+  # recurringChargeCode: TEST_RECURRING
+  # billingFrequencyUnit: months
+  # setupChargeAmount: "0.00"
+  # billingFrequencyPer: month
+
+  describe ".all" do
+    before do
+      Mousetrap::Plan.stub :build_resources_from
+    end
+
+    it "gets all plans" do
+      Mousetrap::Plan.should_receive(:get_resources).with('plans').and_return('some hash')
+      Mousetrap::Plan.all
+    end
+
+    it "handles no-plans case" do
+      Mousetrap::Plan.stub :get_resources => { 'plans' => nil }
+      Mousetrap::Plan.all.should == []
+    end
+
+    it "builds resources from the response" do
+      Mousetrap::Plan.stub :get_resources => { 'plans' => 'some hash' }
+      Mousetrap::Plan.should_receive(:build_resources_from).with({ 'plans' => 'some hash' })
+      Mousetrap::Plan.all
+    end
+  end
+end

data/spec/mousetrap/resource_spec.rb

@@ -0,0 +1,188 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+module Mousetrap
+  class Widget < Resource
+    attr_accessor :id
+    attr_accessor :code
+
+
+    protected
+
+    def self.attributes_from_api(attributes)
+      {
+        :id   => attributes['id'],
+        :code => attributes['code'],
+      }
+    end
+
+    def self.plural_resource_name
+      'widgets'
+    end
+
+    def self.singular_resource_name
+      'widget'
+    end
+  end
+end
+
+describe Mousetrap::Resource do
+  before do
+    Mousetrap.product_code = 'my_product_code'
+  end
+
+  subject { Mousetrap::Resource }
+
+  describe "class" do
+    it "sets the base URI" do
+      subject.default_options[:base_uri].should == 'https://cheddargetter.com'
+    end
+
+    it "set the header to our client name" do
+      subject.headers['User-Agent'].should == 'Mousetrap Ruby Client'
+    end
+  end
+
+  describe ".[]" do
+    before do
+      customer_hash = Factory.attributes_for :existing_customer
+      customer_hash = HashWithIndifferentAccess.new customer_hash
+      @code = customer_hash[:code]
+      @server_response_hash = { 'widgets' => { 'widget' => customer_hash } }
+      Mousetrap::Widget.stub(:get_resource => @server_response_hash)
+    end
+
+    it "gets a resource with widget code" do
+      Mousetrap::Widget.should_receive(:get_resource).with('widgets', @code).and_return(@server_response_hash)
+      Mousetrap::Widget[@code]
+    end
+
+    context "returned widget instance" do
+      subject { Mousetrap::Widget[@code] }
+      it { should be_instance_of(Mousetrap::Widget) }
+      it { should_not be_new_record }
+      it { subject.code.should == @code }
+    end
+
+    context "when there's errors" do
+      it "handles kludgy 'Resource not found' response" do
+        Mousetrap::Widget.stub :get_resource => {
+          'error' => 'Resource not found: Customer not found for code=cantfindme within productCode=MOUSETRAP_TEST'
+        }
+        Mousetrap::Widget['cantfindme'].should be_nil
+      end
+
+      it "raises error if response has one" do
+        expect do
+          Mousetrap::Widget.stub :get_resource => { 'error' => 'some other error' }
+          Mousetrap::Widget['some_resource_code'].should be_nil
+        end.to raise_error(RuntimeError, 'some other error')
+      end
+    end
+  end
+
+  describe ".destroy_all" do
+    it "destroys each resource" do
+      all_widgets = [stub, stub, stub]
+      Mousetrap::Widget.stub :all => all_widgets
+      all_widgets.each { |w| w.should_receive :destroy }
+      Mousetrap::Widget.destroy_all
+    end
+  end
+
+  describe ".exists?" do
+    it "gets by code" do
+      Mousetrap::Widget.should_receive(:[]).with('some_resource_code')
+      Mousetrap::Widget.exists? 'some_resource_code'
+    end
+
+    it "returns true when resource exists" do
+      Mousetrap::Widget.stub :[] => stub('some_widget')
+      Mousetrap::Widget.exists?('some_resource_code').should be_true
+    end
+
+    it "returns false when resource doesn't exist" do
+      Mousetrap::Widget.stub :[] => nil
+      Mousetrap::Widget.exists?('some_resource_code').should be_false
+    end
+  end
+
+  describe '#destroy' do
+    context "for existing records" do
+      it 'destroys' do
+        widget = Mousetrap::Widget.new
+        widget.stub :new_record? => false
+        widget.should_receive(:member_action).with('delete')
+        widget.destroy
+      end
+    end
+
+    context "for new records" do
+      it "does nothing" do
+        widget = Mousetrap::Widget.new
+        widget.stub :new_record? => true
+        Mousetrap::Customer.should_not_receive(:member_action)
+        widget.destroy
+      end
+    end
+  end
+
+  describe "#exists?" do
+    it "calls .exists? with code" do
+      Mousetrap::Widget.should_receive(:exists?).with('some_resource_code')
+      r = Mousetrap::Widget.new :code => 'some_resource_code'
+      r.exists?
+    end
+  end
+
+  describe '#new?' do
+    it 'is true if id is nil' do
+      s = Mousetrap::Widget.new
+      s.should be_new
+    end
+
+    it 'is false if id exists' do
+      s = Mousetrap::Widget.new
+      s.stub :id => 'some_id'
+      s.should_not be_new
+    end
+  end
+
+  describe "protected methods" do
+    describe ".delete_resource" do
+      it "gets /xml/<resource>/delete/productCode/<my_product_code>/code/<resource_code>" do
+        subject.should_receive(:post).with('/xml/widgets/delete/productCode/my_product_code/code/some_resource_code')
+        subject.delete_resource 'widgets', 'some_resource_code'
+      end
+    end
+
+    describe ".get_resource" do
+      it "gets /xml/<resource>/get/productCode/<my_product_code>/code/<resource_code>" do
+        subject.should_receive(:get).with('/xml/widgets/get/productCode/my_product_code/code/some%2Bresource%2Bcode')
+        subject.get_resource 'widgets', 'some+resource+code'
+      end
+    end
+
+    describe ".get_resources" do
+      it "gets /xml/<resource>/get/productCode/<my_product_code>" do
+        subject.should_receive(:get).with('/xml/widgets/get/productCode/my_product_code')
+        subject.get_resources 'widgets'
+      end
+    end
+
+    describe ".post_resource" do
+      it "posts to /xml/<resource>/<action>/productCode/<product_code>" do
+        subject.should_receive(:post).with('/xml/widgets/some_action/productCode/my_product_code', :body => 'some_hash')
+        subject.post_resource 'widgets', 'some_action', 'some_hash'
+      end
+    end
+
+    describe ".put_resource" do
+      it "puts to /xml/<resource>/<action>/productCode/<product_code>/code/<resource_code>" do
+        subject.should_receive(:post).with(
+          '/xml/widgets/some_action/productCode/my_product_code/code/some_widget_code',
+          :body => 'some_hash')
+        subject.put_resource 'widgets', 'some_action', 'some_widget_code', 'some_hash'
+      end
+    end
+  end
+end