mousetrap 0.3.3

data/mousetrap.gemspec

@@ -0,0 +1,83 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mousetrap}
+  s.version = "0.3.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jon Larkowski", "Sandro Turriate", "Wolfram Arnold", "Corey Grusden"]
+  s.date = %q{2009-10-12}
+  s.description = %q{CheddarGetter API Client in Ruby}
+  s.email = %q{jonlarkowski@gmail.com}
+  s.extra_rdoc_files = [
+    "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "MIT-LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "lib/mousetrap.rb",
+     "lib/mousetrap/customer.rb",
+     "lib/mousetrap/plan.rb",
+     "lib/mousetrap/resource.rb",
+     "lib/mousetrap/subscription.rb",
+     "mousetrap.gemspec",
+     "spec/factories.rb",
+     "spec/integration/settings.example.yml",
+     "spec/integration/smoke_test.rb",
+     "spec/integration/spike.rb",
+     "spec/mousetrap/customer_spec.rb",
+     "spec/mousetrap/plan_spec.rb",
+     "spec/mousetrap/resource_spec.rb",
+     "spec/mousetrap/subscription_spec.rb",
+     "spec/mousetrap_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/support/random_data.rb"
+  ]
+  s.homepage = %q{http://github.com/hashrocket/mousetrap}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{CheddarGetter API Client in Ruby}
+  s.test_files = [
+    "spec/factories.rb",
+     "spec/integration/smoke_test.rb",
+     "spec/integration/spike.rb",
+     "spec/mousetrap/customer_spec.rb",
+     "spec/mousetrap/plan_spec.rb",
+     "spec/mousetrap/resource_spec.rb",
+     "spec/mousetrap/subscription_spec.rb",
+     "spec/mousetrap_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/support/random_data.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0.4.2"])
+      s.add_development_dependency(%q<activesupport>, [">= 2.3.3"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.8"])
+      s.add_development_dependency(%q<thoughtbot-factory_girl>, [">= 1.2.2"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0.4.2"])
+      s.add_dependency(%q<activesupport>, [">= 2.3.3"])
+      s.add_dependency(%q<rspec>, [">= 1.2.8"])
+      s.add_dependency(%q<thoughtbot-factory_girl>, [">= 1.2.2"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0.4.2"])
+    s.add_dependency(%q<activesupport>, [">= 2.3.3"])
+    s.add_dependency(%q<rspec>, [">= 1.2.8"])
+    s.add_dependency(%q<thoughtbot-factory_girl>, [">= 1.2.2"])
+  end
+end

data/spec/factories.rb

@@ -0,0 +1,22 @@
+Factory.define :new_customer, :class => Mousetrap::Customer, :default_strategy => :stub do |f|
+  f.email { random_email_address }
+  f.first_name { random_string }
+  f.last_name { random_string }
+  f.code { |me| me.email }
+  f.add_attribute :id, nil
+  f.subscription_attributes { Factory.attributes_for :subscription }
+end
+
+Factory.define :existing_customer, :parent => :new_customer, :default_strategy => :stub do |f|
+  f.add_attribute :id, '2d1244e8-e338-102c-a92d-40402145ee8b'
+end
+
+Factory.define :subscription, :class => Mousetrap::Subscription, :default_strategy => :stub do |f|
+  f.plan_code 'TEST'
+  f.billing_first_name { random_string }
+  f.billing_last_name { random_string }
+  f.credit_card_number '4111111111111111'
+  f.credit_card_expiration_month '12'
+  f.credit_card_expiration_year '2012'
+  f.billing_zip_code '90210'
+end

data/spec/integration/settings.example.yml

@@ -0,0 +1,6 @@
+# Replace user and password with your CheddarGetter credentials.
+user: 'lark@example.com'
+password: 'abc123'
+
+# Go create a product in the CheddarGetter web admin interface named "mousetrap_test".
+product_code: 'mousetrap_test'

data/spec/integration/smoke_test.rb

@@ -0,0 +1,149 @@
+require File.expand_path('../../../lib/mousetrap', __FILE__)
+
+require 'spec'
+require 'spec/autorun'
+require 'factory_girl'
+require 'active_support'
+require 'yaml'
+
+Dir["#{File.dirname(__FILE__)}/../support/**/*.rb"].each {|f| require f}
+
+settings = YAML.load_file(File.dirname(__FILE__) + '/settings.yml')
+Mousetrap.authenticate(settings['user'], settings['password'])
+Mousetrap.product_code = settings['product_code']
+
+Spec::Runner.configure do |config|
+  config.before :suite do
+    begin
+      Mousetrap::Customer.destroy_all
+    rescue
+    end
+  end
+end
+
+shared_examples_for "a Customer record from CheddarGetter" do
+  describe "And I get the customer" do
+    before :all do
+      @api_customer = Mousetrap::Customer[@customer.code]
+    end
+
+    it "Then I should see first name" do
+      @api_customer.first_name.should == @customer.first_name
+    end
+
+    it "And I should see last name" do
+      @api_customer.last_name.should == @customer.last_name
+    end
+
+    it "And I should see the code" do
+      @api_customer.code.should == @customer.code
+    end
+
+    it "And I should see the ID" do
+      @api_customer.id.should == @customer.id
+    end
+  end
+end
+
+describe "The Wrapper Gem" do
+  describe Mousetrap::Customer do
+    describe ".all" do
+      describe "Given a few customers on CheddarGetter" do
+        before :all do
+          3.times { Factory(:new_customer).save }
+          violated "Couldn't save customers" unless Mousetrap::Customer.all.size == 3
+        end
+
+        describe "When I call .all" do
+          before :all do
+            @all_customers = Mousetrap::Customer.all
+          end
+
+          it "Then I should get all the customers" do
+            @all_customers.size.should == 3
+          end
+        end
+      end
+    end
+
+    describe ".create" do
+      describe "When I create a customer" do
+        before :all do
+          attributes = Factory.attributes_for :new_customer
+          @customer = Mousetrap::Customer.create attributes
+        end
+
+        it_should_behave_like "a Customer record from CheddarGetter"
+      end
+    end
+
+    describe ".destroy_all" do
+      describe "Given a few customers on CheddarGetter" do
+        before :all do
+          Mousetrap::Customer.destroy_all
+          3.times { Factory(:new_customer).save }
+          violated "Couldn't save customers" unless Mousetrap::Customer.all.size == 3
+        end
+
+        describe "When I call .destroy_all" do
+          before :all do
+            Mousetrap::Customer.destroy_all
+          end
+
+          it "Then there should be no customers" do
+            Mousetrap::Customer.all.size.should == 0
+          end
+        end
+      end
+    end
+
+    describe "#cancel" do
+      describe "Given a customer" do
+        before :all do
+          @customer = Factory :new_customer
+          @customer.save
+          @api_customer = Mousetrap::Customer[@customer.code]
+        end
+
+        describe "When I cancel" do
+          before :all do
+            @api_customer.cancel
+          end
+
+          describe "And I get the customer" do
+            before :all do
+              @api_customer = Mousetrap::Customer[@customer.code]
+            end
+
+            it "Then I should see a cancelation date on subscription" do
+              @api_customer.subscription.canceled_at.should be
+            end
+          end
+        end
+      end
+    end
+
+    describe "#save" do
+      describe "When I save a customer" do
+        before :all do
+          @customer = Factory :new_customer
+          @customer.save
+        end
+
+        it_should_behave_like "a Customer record from CheddarGetter"
+
+        describe "And I save it again, with different attributes" do
+          before :all do
+            attributes = Factory.attributes_for :new_customer
+            @customer.first_name = attributes[:first_name]
+            @customer.last_name = attributes[:last_name]
+            @customer.email = attributes[:email]
+            @customer.save
+          end
+
+          it_should_behave_like "a Customer record from CheddarGetter"
+        end
+      end
+    end
+  end
+end

data/spec/integration/spike.rb

@@ -0,0 +1,53 @@
+# This script is for hacking and playing around.
+
+require File.dirname(__FILE__) + '/../../lib/mousetrap'
+require 'activesupport'
+require 'factory_girl'
+require 'ruby-debug'
+require 'yaml'
+
+Dir["#{File.dirname(__FILE__)}/../support/**/*.rb"].each {|f| require f}
+
+settings = YAML.load_file(File.dirname(__FILE__) + '/settings.yml')
+Mousetrap.authenticate(settings['user'], settings['password'])
+Mousetrap.product_code = settings['product_code']
+
+
+def plans
+  all_plans = Mousetrap::Plan.all
+  puts all_plans.to_yaml
+
+  test_plan = Mousetrap::Plan['TEST']
+  puts test_plan.to_yaml
+end
+
+def all_customers
+  all_customers = Mousetrap::Customer.all
+  puts all_customers.to_yaml
+end
+
+def create_customer
+  customer = Factory :new_customer
+  customer.save
+
+  api_customer = Mousetrap::Customer[customer.code]
+  puts api_customer.to_yaml
+end
+
+def destroy_all_customers
+  Mousetrap::Customer.destroy_all
+end
+
+# create_customer
+
+code = 'igcuvfehrc@example.com'
+api_customer = Mousetrap::Customer[code]
+puts api_customer.to_yaml
+puts '-' * 80
+puts 'cancel'
+puts api_customer.cancel
+puts '-' * 80
+api_customer = Mousetrap::Customer[code]
+puts api_customer.to_yaml
+
+

data/spec/mousetrap/customer_spec.rb

@@ -0,0 +1,209 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Mousetrap::Customer do
+  # customers: 
+  #   customer: 
+  #     firstName: nvnawrelyv
+  #     lastName: vklidifvfd
+  #     email: bvvljaeegs@example.com
+  #     code: ablntsorai@example.com
+  #     company: 
+  #     gatewayToken: 
+  #     id: eac1cf0e-fc5b-102c-a92d-40402145ee8b
+  #     createdDatetime: "2009-09-27T02:16:15+00:00"
+  #     modifiedDatetime: "2009-09-27T02:16:16+00:00"
+  #     subscriptions: 
+  #       subscription: 
+  #         gatewayToken: 
+  #         id: eac26b4e-fc5b-102c-a92d-40402145ee8b
+  #         createdDatetime: "2009-09-27T02:16:15+00:00"
+  #         ccType: visa
+  #         ccLastFour: "1111"
+  #         ccExpirationDate: "2012-12-31T00:00:00+00:00"
+  #         canceledDatetime: 
+  #         plans: 
+  #           plan: 
+  #             name: Test
+  #             setupChargeAmount: "0.00"
+  #             code: TEST
+  #             recurringChargeAmount: "42.00"
+  #             billingFrequencyQuantity: "1"
+  #             trialDays: "0"
+  #             id: 5fbb9a84-e27f-102c-a92d-40402145ee8b
+  #             billingFrequency: monthly
+  #             createdDatetime: "2009-08-25T04:24:34+00:00"
+  #             recurringChargeCode: TEST_RECURRING
+  #             isActive: "1"
+  #             billingFrequencyUnit: months
+  #             description: Test
+  #             billingFrequencyPer: month
+  #             setupChargeCode: TEST_SETUP
+  #         invoices: 
+  #           invoice: 
+  #             number: "2"
+  #             billingDatetime: "2009-10-27T02:16:15+00:00"
+  #             id: eac74d62-fc5b-102c-a92d-40402145ee8b
+  #             createdDatetime: "2009-09-27T02:16:15+00:00"
+  #             type: subscription
+  
+  def customer_attributes_for_api(customer)
+    {
+      :firstName => customer.first_name,
+      :lastName => customer.last_name,
+      :email => customer.email,
+      :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,
+      }
+    }
+  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(:save)
+      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 'saves the new customer instance' do
+      @customer.should_receive(:save)
+      Mousetrap::Customer.create(@customer_hash)
+    end
+
+    it 'sets the id of the newly created customer' do
+      Mousetrap::Customer.stub(:build_resource_from => stub(:id => 1))
+      @customer.should_receive(:id=).with(1)
+      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 '#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 '#save' do
+    context "for existing records" do
+      before do
+        @customer = Factory :existing_customer
+      end
+
+      it 'posts to edit-customer 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', @customer.code, attributes_for_api)
+        @customer.save
+      end
+    end
+
+    context "for new records" do
+      it 'calls create' do
+        customer = Factory :new_customer
+        customer.should_receive(:create)
+        customer.save
+      end
+    end
+  end
+end