ryanwood-mousetrap 0.5.6

data/lib/mousetrap.rb

@@ -0,0 +1,25 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+begin; require 'rubygems'; rescue LoadError; end
+require 'httparty'
+
+module Mousetrap
+  API_UNSUPPORTED = "CheddarGetter API doesn't support this."
+
+  class ApiDown < Exception
+  end
+
+  autoload :Customer,     'mousetrap/customer'
+  autoload :Plan,         'mousetrap/plan'
+  autoload :Resource,     'mousetrap/resource'
+  autoload :Invoice,      'mousetrap/invoice'
+  autoload :Subscription, 'mousetrap/subscription'
+
+  class << self
+    attr_accessor :product_code
+
+    def authenticate(user, password)
+      Resource.basic_auth user, password
+    end
+  end
+end

data/mousetrap.gemspec

@@ -0,0 +1,90 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mousetrap}
+  s.version = "0.5.6"
+
+  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{2010-05-20}
+  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/invoice.rb",
+     "lib/mousetrap/plan.rb",
+     "lib/mousetrap/resource.rb",
+     "lib/mousetrap/subscription.rb",
+     "mousetrap.gemspec",
+     "script/authenticate.rb",
+     "script/cheddar_getter.example.yml",
+     "script/console",
+     "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/fixtures.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.6}
+  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/fixtures.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.9"])
+      s.add_development_dependency(%q<factory_girl>, [">= 1.2.3"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0.4.2"])
+      s.add_dependency(%q<activesupport>, [">= 2.3.3"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<factory_girl>, [">= 1.2.3"])
+    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.9"])
+    s.add_dependency(%q<factory_girl>, [">= 1.2.3"])
+  end
+end
+

data/script/authenticate.rb

@@ -0,0 +1,3 @@
+settings = YAML.load_file(File.expand_path('../cheddar_getter.yml', __FILE__))
+Mousetrap.authenticate settings['user'], settings['password']
+Mousetrap.product_code = settings['product_code']

data/script/cheddar_getter.example.yml

@@ -0,0 +1,3 @@
+user: you@example.com
+password: abc123
+product_code: MOUSETRAP_TEST

data/script/console

@@ -0,0 +1 @@
+irb -r ubygems -r lib/mousetrap.rb -r factory_girl -r spec/support/random_data.rb -r script/authenticate.rb

data/spec/factories.rb

@@ -0,0 +1,34 @@
+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.company { 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_address "400 W 7th St\n#200"
+  f.billing_city 'Bloomington'
+  f.billing_state 'IN'
+  f.billing_country 'US'
+  f.billing_zip_code '47404'
+end
+
+Factory.define :alternate_subscription, :parent => :subscription, :default_strategy => :stub do |f|
+  f.credit_card_number '5555555555554444'
+  f.credit_card_expiration_month '7'
+  f.credit_card_expiration_year '2013'
+  f.billing_zip_code '12345'
+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,355 @@
+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 company" do
+      @api_customer.company.should == @customer.company
+    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
+
+shared_examples_for "an active Subscription record from CheddarGetter" do
+  describe "And I get the subscription" do
+    before :all do
+      @api_customer = Mousetrap::Customer[@customer.code]
+      @api_subscription = @api_customer.subscription
+    end
+
+    it "Then ID is set" do
+      @api_subscription.id.should be
+    end
+
+    it "Then canceled_at is not set" do
+      @api_subscription.canceled_at.should be_nil
+    end
+
+    it "Then created_at is set" do
+      @api_subscription.created_at.should be
+    end
+
+    it "Then I should see the credit card expiration" do
+      expiration_date_from_api = Date.parse(@api_subscription.credit_card_expiration_date)
+      expiration_date = Date.parse("#{@customer.subscription.credit_card_expiration_year}-#{@customer.subscription.credit_card_expiration_month}-31")
+      expiration_date_from_api.should == expiration_date
+    end
+
+    it "Then I should see the credit card last four digits" do
+      @api_subscription.credit_card_last_four_digits.should == @customer.subscription.credit_card_number[-4..-1]
+    end
+
+    it "Then I should see the credit card type" do
+      @api_subscription.credit_card_type.should == (@credit_card_type || 'visa')
+    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"
+        it_should_behave_like "an active Subscription record from CheddarGetter"
+      end
+
+      describe "When I create a customer with international card" do
+        before :all do
+          attributes = Factory.attributes_for :alt_new_customer
+          @customer = Mousetrap::Customer.create attributes_for
+        end
+
+        it_should_behave_like "a Customer record from CheddarGetter"
+        it_should_behave_like "an active Subscription 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 ".update" do
+      describe "Given a customer" do
+        before :all do
+          @customer = Factory :new_customer
+          @api_customer = nil
+
+          # TODO: figure out why multiple records are being created even though
+          # we use "before :all".  Until then, here's the kludge...
+          if Mousetrap::Customer.all.size == 1
+            @api_customer = Mousetrap::Customer.all.first
+            @customer = @api_customer
+          else
+            @customer.save
+            @api_customer = Mousetrap::Customer[@customer.code]
+          end
+        end
+
+        describe "When I update the customer, with only customer attributes" do
+          before :all do
+            @api_customer = Mousetrap::Customer[@customer.code]
+
+            updated_attributes = {
+              :first_name => 'new_first',
+              :last_name => 'new_last',
+              :email => 'new_email@example.com',
+              :company => 'new_company'
+            }
+
+            @customer = Mousetrap::Customer.new updated_attributes
+            @customer.code = @api_customer.code
+            @customer.id = @api_customer.id
+
+            Mousetrap::Customer.update(@api_customer.code, updated_attributes)
+          end
+
+          it_should_behave_like "a Customer record from CheddarGetter"
+        end
+
+        describe "When I update the customer, with customer and subscription attributes" do
+          before :all do
+            @api_customer = Mousetrap::Customer[@customer.code]
+
+            updated_attributes = {
+              :first_name => 'new_first',
+              :last_name => 'new_last',
+              :email => 'new_email@example.com',
+              :company => 'new_company',
+              :subscription_attributes => {
+                :plan_code                    => 'TEST',
+                :billing_first_name           => 'new_billing_first',
+                :billing_last_name            => 'new_billing_last',
+                :credit_card_number           => '5555555555554444',
+                :credit_card_expiration_month => '01',
+                :credit_card_expiration_year  => '2013',
+                :billing_zip_code             => '12345'
+              }
+            }
+
+            @credit_card_type = 'mc'
+
+            @customer = Mousetrap::Customer.new updated_attributes
+
+            # set up our test comparison objects as if they came from API gets
+            @customer.code = @api_customer.code
+            @customer.id = @api_customer.id
+            @customer.subscription.send(:id=, @api_customer.subscription.id)
+
+            Mousetrap::Customer.update(@api_customer.code, updated_attributes)
+          end
+
+          it_should_behave_like "a Customer record from CheddarGetter"
+          it_should_behave_like "an active Subscription record from CheddarGetter"
+        end
+      end
+    end
+
+    describe "#cancel" do
+      describe "Given a customer" do
+        before :all do
+          @customer = Factory :new_customer
+          @api_customer = nil
+
+          if Mousetrap::Customer.all.size == 1
+            @api_customer = Mousetrap::Customer.all.first
+            @customer = @api_customer
+          else
+            @customer.save
+            @api_customer = Mousetrap::Customer[@customer.code]
+          end
+        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 cancellation date on subscription" do
+              @api_customer.subscription.canceled_at.should be
+            end
+
+            describe "When I resubscribe them" do
+              before :all do
+                @customer = Factory :new_customer, :email => @api_customer.email, :code => @api_customer.email
+                @customer.save
+              end
+
+              it_should_behave_like "a Customer record from CheddarGetter"
+              it_should_behave_like "an active Subscription record from CheddarGetter"
+            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 "When 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.company = attributes[:company]
+            @customer.save
+          end
+
+          it_should_behave_like "a Customer record from CheddarGetter"
+        end
+
+        context "When I update subscription information" do
+          before :all do
+            @subscription = Mousetrap::Subscription.new(Factory.attributes_for(:alternate_subscription))
+            @credit_card_type = 'mc'
+            @customer.subscription = @subscription
+            @customer.save
+          end
+
+          it_should_behave_like "an active Subscription record from CheddarGetter"
+        end
+      end
+    end
+
+    describe '#switch_to_plan' do
+      describe "Given an existing CheddarGetter customer" do
+        before :all do
+          @customer = Factory :new_customer
+          @customer.save
+        end
+
+        describe 'When I switch plans' do
+          before :all do
+            @customer.switch_to_plan('TEST_2')
+          end
+
+          describe "And I get the customer" do
+            before :all do
+              @api_customer = Mousetrap::Customer[@customer.code]
+            end
+
+            it 'Then they should be on the new plan' do
+              @api_customer.subscription.plan.code.should == 'TEST_2'
+            end
+          end
+        end
+      end
+    end
+  end
+
+  describe Mousetrap::Subscription do
+    describe "Given a customer on CheddarGetter" do
+      before :all do
+        @customer = Factory :new_customer
+        violated "Use a visa for setup" unless @customer.subscription.credit_card_number == '4111111111111111'
+        @customer.save
+      end
+
+      describe "When I update a subscription field" do
+        before :all do
+          Mousetrap::Subscription.update @customer.code, :credit_card_number => '5555555555554444'
+        end
+
+        describe "And I get the customer" do
+          before :all do
+            @api_customer = Mousetrap::Customer[@customer.code]
+          end
+
+          it 'Then I should see the updated field' do
+            @api_customer.subscription.credit_card_last_four_digits.should == '4444'
+          end
+        end
+      end
+    end
+  end
+end

data/spec/integration/spike.rb

@@ -0,0 +1,108 @@
+# 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
+
+destroy_all_customers
+customer = Factory :new_customer
+customer.save
+
+api_customer = Mousetrap::Customer[customer.code]
+puts api_customer.to_yaml
+puts '-' * 80
+
+Mousetrap::Subscription.update customer.code, {
+  :billing_first_name => 'x',
+  :billing_last_name => 'y',
+  :credit_card_number => '5555555555554444',
+  :credit_card_expiration_month => '05',
+  :credit_card_expiration_year => '2013',
+  :billing_zip_code => '31415'
+}
+
+api_customer = Mousetrap::Customer[customer.code]
+puts api_customer.to_yaml
+puts '-' * 80
+
+#customer_only_fields = Mousetrap::Customer.new \
+  #:first_name => 'first',
+  #:last_name => 'last',
+  #:company => 'company',
+  #:email => 'random@example.com',
+  #:code => customer.code
+
+#customer_only_fields.save
+
+#api_customer = Mousetrap::Customer[customer.code]
+#puts api_customer.to_yaml
+
+
+#code = "rvhljmvenp@example.com"
+#api_customer = Mousetrap::Customer[code]
+##puts api_customer.to_yaml
+
+#customer = Factory :new_customer
+#customer.save
+#api_customer = Mousetrap::Customer[customer.code]
+
+#puts '-' * 80
+#p Mousetrap::Customer[customer.code]
+
+#puts '-' * 80
+#p Mousetrap::Customer.exists? customer.code
+
+#puts '-' * 80
+#p Mousetrap::Customer['cantfindme']
+
+#puts '-' * 80
+#p Mousetrap::Customer.exists? 'cantfindme'
+
+# 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
+
+