mousetrap 0.3.3

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,132 @@
+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
+  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 '#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 ".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

data/spec/mousetrap/subscription_spec.rb

@@ -0,0 +1,42 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+FULL_CUSTOMER ={"company"=>nil, "lastName"=>"LasterName1255024322", "code"=>"1255024322", "gatewayToken"=>nil, "createdDatetime"=>"2009-10-08T17:55:30+00:00", "modifiedDatetime"=>"2009-10-08T17:55:30+00:00", "subscriptions"=>{"subscription"=>[{"ccExpirationDate"=>"2010-01-31T00:00:00+00:00", "plans"=>{"plan"=>{"name"=>"Plus", "billingFrequencyQuantity"=>"1", "code"=>"PLUS", "recurringChargeAmount"=>"49.00", "createdDatetime"=>"2009-10-06T14:54:24+00:00", "id"=>"51a912d0-03d8-102d-a92d-40402145ee8b", "isActive"=>"1", "billingFrequency"=>"monthly", "description"=>nil, "trialDays"=>"0", "setupChargeCode"=>"PLUS_SETUP", "recurringChargeCode"=>"PLUS_RECURRING", "billingFrequencyUnit"=>"months", "setupChargeAmount"=>"49.00", "billingFrequencyPer"=>"month"}}, "gatewayToken"=>nil, "createdDatetime"=>"2009-10-08T17:55:31+00:00", "ccType"=>"visa", "id"=>"f426d5ae-0583-102d-a92d-40402145ee8b", "ccLastFour"=>"2222", "canceledDatetime"=>nil, "invoices"=>{"invoice"=>{"number"=>"12", "createdDatetime"=>"2009-10-08T17:55:30+00:00", "type"=>"subscription", "billingDatetime"=>"2009-11-08T17:55:30+00:00", "id"=>"f3142928-0583-102d-a92d-40402145ee8b"}}}, {"ccExpirationDate"=>"2010-01-31T00:00:00+00:00", "plans"=>{"plan"=>{"name"=>"Basic", "billingFrequencyQuantity"=>"1", "code"=>"BASIC", "recurringChargeAmount"=>"24.00", "createdDatetime"=>"2009-10-06T14:53:49+00:00", "id"=>"3cd2e840-03d8-102d-a92d-40402145ee8b", "isActive"=>"1", "billingFrequency"=>"monthly", "description"=>nil, "trialDays"=>"0", "setupChargeCode"=>"BASIC_SETUP", "recurringChargeCode"=>"BASIC_RECURRING", "billingFrequencyUnit"=>"months", "setupChargeAmount"=>"24.00", "billingFrequencyPer"=>"month"}}, "gatewayToken"=>nil, "createdDatetime"=>"2009-10-08T17:55:30+00:00", "ccType"=>"visa", "id"=>"f30e0e94-0583-102d-a92d-40402145ee8b", "ccLastFour"=>"2222", "canceledDatetime"=>nil, "invoices"=>{"invoice"=>{"number"=>"11", "createdDatetime"=>"2009-10-08T17:55:30+00:00", "transactions"=>{"transaction"=>{"response"=>"approved", "code"=>"", "createdDatetime"=>"2009-10-08T17:55:30+00:00", "memo"=>"This is a simulated transaction", "id"=>"f327b178-0583-102d-a92d-40402145ee8b", "parentId"=>nil, "amount"=>"24.00", "transactedDatetime"=>"2009-10-08T17:55:30+00:00", "gatewayAccount"=>{"id"=>""}, "charges"=>{"charge"=>{"code"=>"BASIC_SETUP", "createdDatetime"=>"2009-10-08T17:55:30+00:00", "type"=>"setup", "quantity"=>"1", "id"=>"f325406e-0583-102d-a92d-40402145ee8b", "description"=>nil, "eachAmount"=>"24.00"}}}}, "type"=>"setup", "billingDatetime"=>"2009-10-08T17:55:30+00:00", "id"=>"f3125468-0583-102d-a92d-40402145ee8b"}}}]}, "id"=>"f30cd614-0583-102d-a92d-40402145ee8b", "firstName"=>"FirsterName1", "email"=>"example1@example.com"}
+MULTIPLE_SUBSCRIPTIONS =[{"ccExpirationDate"=>"2010-01-31T00:00:00+00:00", "plans"=>{"plan"=>{"name"=>"Plus", "billingFrequencyQuantity"=>"1", "code"=>"PLUS", "recurringChargeAmount"=>"49.00", "createdDatetime"=>"2009-10-06T14:54:24+00:00", "id"=>"51a912d0-03d8-102d-a92d-40402145ee8b", "isActive"=>"1", "billingFrequency"=>"monthly", "description"=>nil, "trialDays"=>"0", "setupChargeCode"=>"PLUS_SETUP", "recurringChargeCode"=>"PLUS_RECURRING", "billingFrequencyUnit"=>"months", "setupChargeAmount"=>"49.00", "billingFrequencyPer"=>"month"}}, "gatewayToken"=>nil, "createdDatetime"=>"2009-10-08T17:55:31+00:00", "ccType"=>"visa", "id"=>"f426d5ae-0583-102d-a92d-40402145ee8b", "ccLastFour"=>"2222", "canceledDatetime"=>nil, "invoices"=>{"invoice"=>{"number"=>"12", "createdDatetime"=>"2009-10-08T17:55:30+00:00", "type"=>"subscription", "billingDatetime"=>"2009-11-08T17:55:30+00:00", "id"=>"f3142928-0583-102d-a92d-40402145ee8b"}}}, {"ccExpirationDate"=>"2010-01-31T00:00:00+00:00", "plans"=>{"plan"=>{"name"=>"Basic", "billingFrequencyQuantity"=>"1", "code"=>"BASIC", "recurringChargeAmount"=>"24.00", "createdDatetime"=>"2009-10-06T14:53:49+00:00", "id"=>"3cd2e840-03d8-102d-a92d-40402145ee8b", "isActive"=>"1", "billingFrequency"=>"monthly", "description"=>nil, "trialDays"=>"0", "setupChargeCode"=>"BASIC_SETUP", "recurringChargeCode"=>"BASIC_RECURRING", "billingFrequencyUnit"=>"months", "setupChargeAmount"=>"24.00", "billingFrequencyPer"=>"month"}}, "gatewayToken"=>nil, "createdDatetime"=>"2009-10-08T17:55:30+00:00", "ccType"=>"visa", "id"=>"f30e0e94-0583-102d-a92d-40402145ee8b", "ccLastFour"=>"2222", "canceledDatetime"=>nil, "invoices"=>{"invoice"=>{"number"=>"11", "createdDatetime"=>"2009-10-08T17:55:30+00:00", "transactions"=>{"transaction"=>{"response"=>"approved", "code"=>"", "createdDatetime"=>"2009-10-08T17:55:30+00:00", "memo"=>"This is a simulated transaction", "id"=>"f327b178-0583-102d-a92d-40402145ee8b", "parentId"=>nil, "amount"=>"24.00", "transactedDatetime"=>"2009-10-08T17:55:30+00:00", "gatewayAccount"=>{"id"=>""}, "charges"=>{"charge"=>{"code"=>"BASIC_SETUP", "createdDatetime"=>"2009-10-08T17:55:30+00:00", "type"=>"setup", "quantity"=>"1", "id"=>"f325406e-0583-102d-a92d-40402145ee8b", "description"=>nil, "eachAmount"=>"24.00"}}}}, "type"=>"setup", "billingDatetime"=>"2009-10-08T17:55:30+00:00", "id"=>"f3125468-0583-102d-a92d-40402145ee8b"}}}]
+
+
+describe Mousetrap::Subscription do
+  # subscription:
+  #   ccExpirationDate: "2010-01-31T00:00:00+00:00"
+  #   gatewayToken:
+  #   createdDatetime: "2009-08-27T15:55:51+00:00"
+  #   ccType: visa
+  #   id: 46ad3f1c-e472-102c-a92d-40402145ee8b
+  #   ccLastFour: "1111"
+  #   canceledDatetime:
+
+
+  describe "plan" do
+    it 'has the correct planCode populated' do
+      Mousetrap::Subscription.new_from_api(MULTIPLE_SUBSCRIPTIONS.first).plan.code.should == "PLUS"
+    end
+
+    it 'exists' do
+      Mousetrap::Subscription.new_from_api(MULTIPLE_SUBSCRIPTIONS.first).plan.should_not be_nil
+    end
+  end
+  describe '#destroy' do
+    it "raises a NotImplementedError" do
+      expect do
+        Mousetrap::Subscription.new.destroy
+      end.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe '::attributes_for_api' do
+    it 'coerces the month to 2 digits' do
+      Mousetrap::Subscription.attributes_for_api(
+        :credit_card_expiration_month => 2
+      )[:ccExpMonth].should == '02'
+    end
+  end
+end

data/spec/mousetrap_spec.rb

@@ -0,0 +1,17 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Mousetrap do
+  subject { Mousetrap }
+
+  it "stores product code" do
+    subject.product_code = 'my_product_code'
+    subject.product_code.should == 'my_product_code'
+  end
+  
+  describe "#authenticate" do
+    it "sets basic auth based on the supplied user and password" do
+      Mousetrap::Resource.should_receive(:basic_auth).with('lark@example.com', 'abc123')
+      subject.authenticate 'lark@example.com', 'abc123'
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--format nested

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'mousetrap'
+require 'spec'
+require 'spec/autorun'
+require 'factory_girl'
+require 'active_support'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+module Mousetrap
+  class Resource
+    def self.get(*args)
+      raise 'You must stub this, or should_receive at a higher level.'
+    end
+
+    def self.post(*args)
+      raise 'You must stub this, or should_receive at a higher level.'
+    end
+  end
+end

data/spec/support/random_data.rb

@@ -0,0 +1,21 @@
+def random_email_address
+  "#{random_string}@example.com"
+end
+
+def random_string
+  random_alpha_string_of_length(10)
+end
+
+def random_alpha_string_of_length(length)
+  letters = *'a'..'z'
+  random_string_for_uniqueness = ''
+  length.times { random_string_for_uniqueness += letters[rand(letters.size - 1)]}
+  random_string_for_uniqueness
+end
+
+def random_number_string_of_length(length)
+  numbers = *'0'..'9'
+  random_string_for_uniqueness = ''
+  length.times { random_string_for_uniqueness += numbers[rand(numbers.size - 1)]}
+  random_string_for_uniqueness
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification 
+name: mousetrap
+version: !ruby/object:Gem::Version 
+  version: 0.3.3
+platform: ruby
+authors: 
+- Jon Larkowski
+- Sandro Turriate
+- Wolfram Arnold
+- Corey Grusden
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-12 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.8
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-factory_girl
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.2
+    version: 
+description: CheddarGetter API Client in Ruby
+email: jonlarkowski@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+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
+has_rdoc: true
+homepage: http://github.com/hashrocket/mousetrap
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: CheddarGetter API Client in Ruby
+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