hashrocket-mousetrap 0.2.1 → 0.3.0

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/lib/mousetrap.rb

@@ -5,6 +5,7 @@ require 'httparty'
 
 module Mousetrap
   NO_BUSINESS_NEED = "No business need at this time."
+  API_UNSUPPORTED = "CheddarGetter API doesn't support this."
 
   autoload :Customer,     'mousetrap/customer'
   autoload :Plan,         'mousetrap/plan'

data/lib/mousetrap/customer.rb

@@ -32,14 +32,28 @@ module Mousetrap
       a
     end
 
-    def destroy
-      self.class.delete_resource('customers', code) unless new_record?
+    def cancel
+      member_action 'cancel' unless new_record?
     end
 
     def save
       new? ? create : update
     end
 
+    def self.all
+      response = get_resources plural_resource_name
+
+      if response['error']
+        if response['error'] == "Bad request: No customers found."
+          return []
+        else
+          raise response['error']
+        end
+      end
+
+      build_resources_from response
+    end
+
     def self.create(attributes)
       object = new(attributes)
       response = object.save
@@ -88,7 +102,13 @@ module Mousetrap
     end
 
     def create
-      self.class.post_resource 'customers', 'new', attributes_for_api
+      response = self.class.post_resource 'customers', 'new', attributes_for_api
+
+      raise response['error'] if response['error']
+
+      returned_customer = self.class.build_resource_from response
+      self.id = returned_customer.id
+      response
     end
 
     def update

data/lib/mousetrap/plan.rb

@@ -5,6 +5,11 @@ module Mousetrap
       :code,
       :name
 
+    def self.all
+      response = get_resources plural_resource_name
+      return [] unless response['plans']
+      build_resources_from response
+    end
 
     protected
 

data/lib/mousetrap/resource.rb

@@ -15,11 +15,6 @@ module Mousetrap
       build_resource_from response
     end
 
-    def self.all
-      response = get_resources plural_resource_name
-      build_resources_from response
-    end
-
     def self.create(attributes = {})
       raise NotImplementedError, NO_BUSINESS_NEED
     end
@@ -28,12 +23,16 @@ module Mousetrap
       raise NotImplementedError, NO_BUSINESS_NEED
     end
 
+    def self.destroy_all
+      all.each { |object| object.destroy }
+    end
+
     def self.exists?(code)
       raise NotImplementedError, NO_BUSINESS_NEED
     end
 
     def destroy
-      raise NotImplementedError, NO_BUSINESS_NEED
+      member_action 'delete' unless new_record?
     end
 
     def exists?(code)
@@ -57,28 +56,44 @@ module Mousetrap
 
     protected
 
+    def member_action(action)
+      self.class.member_action(self.class.plural_resource_name, action, code)
+    end
+
+    def self.resource_path(resource, action, code = nil)
+      path = "/xml/#{resource}/#{action}/productCode/#{Mousetrap.product_code}"
+      path += "/code/#{code}" if code
+      path
+    end
+
+    def self.member_action(resource, action, code, attributes = nil)
+      path = resource_path(resource, action, code)
+
+      if attributes
+        post path, :body => attributes
+      else
+        post path
+      end
+    end
+
     def self.delete_resource(resource, code)
-      path = "/xml/#{resource}/delete/productCode/#{Mousetrap.product_code}/code/#{code}"
-      post path
+      member_action(resource, 'delete', code)
+    end
+
+    def self.put_resource(resource, action, code, attributes)
+      member_action(resource, action, code, attributes)
     end
 
     def self.get_resource(resource, code)
-      path = "/xml/#{resource}/get/productCode/#{Mousetrap.product_code}/code/#{code}"
-      get path
+      get resource_path(resource, 'get', code)
     end
 
     def self.get_resources(resource)
-      path = "/xml/#{resource}/get/productCode/#{Mousetrap.product_code}"
-      get path
+      get resource_path(resource, 'get')
     end
 
     def self.post_resource(resource, action, attributes)
-      path = "/xml/#{resource}/#{action}/productCode/#{Mousetrap.product_code}"
-      post path, :body => attributes
-    end
-
-    def self.put_resource(resource, action, resource_code, attributes)
-      path = "/xml/#{resource}/#{action}/productCode/#{Mousetrap.product_code}/code/#{resource_code}"
+      path = resource_path(resource, action)
       post path, :body => attributes
     end
 

data/lib/mousetrap/subscription.rb

@@ -10,9 +10,10 @@ module Mousetrap
       :credit_card_expiration_year,
       :billing_zip_code,
 
-      :customer_code, # belongs to customer
+      :customer_code # belongs to customer
 
-      # Attributes that come _from_ the API.
+    # Attributes that come _from_ the API.
+    attr_reader \
       :id,
       :canceled_at,
       :created_at,
@@ -39,6 +40,10 @@ module Mousetrap
       self.class.attributes_for_api(attributes)
     end
 
+    def destroy
+      raise NotImplementedError, API_UNSUPPORTED
+    end
+
     def save
       mutated_attributes = attributes_for_api(attributes)
       self.class.put_resource('customers', 'edit-subscription', customer_code, mutated_attributes)
@@ -47,6 +52,14 @@ module Mousetrap
 
     protected
 
+    attr_writer \
+      :id,
+      :canceled_at,
+      :created_at,
+      :credit_card_expiration_date,
+      :credit_card_last_four_digits,
+      :credit_card_type
+
     def self.plural_resource_name
       'subscriptions'
     end

data/mousetrap.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mousetrap}
-  s.version = "0.2.1"
+  s.version = "0.3.0"
 
   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-09-01}
+  s.date = %q{2009-09-27}
   s.description = %q{CheddarGetter API Client in Ruby}
   s.email = %q{jonlarkowski@gmail.com}
   s.extra_rdoc_files = [

data/spec/integration/smoke_test.rb

@@ -1,7 +1,10 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-require File.dirname(__FILE__) + '/../../lib/mousetrap'
+require File.expand_path('../../../lib/mousetrap', __FILE__)
+
+require 'spec'
+require 'spec/autorun'
+require 'factory_girl'
+require 'active_support'
 require 'yaml'
-require 'activesupport'
 
 Dir["#{File.dirname(__FILE__)}/../support/**/*.rb"].each {|f| require f}
 
@@ -9,8 +12,138 @@ 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
-  it "works" do
-    true.should be_true
+  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

@@ -21,21 +21,33 @@ def plans
   puts test_plan.to_yaml
 end
 
-def customers
+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
-
-  #all_customers = Mousetrap::Customer.all
-  #puts all_customers.to_yaml
 end
 
 def destroy_all_customers
-  all_customers = Mousetrap::Customer.all
-  all_customers.each { |c| c.destroy }
+  Mousetrap::Customer.destroy_all
 end
 
-#destroy_all_customers
-#customers
+# 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

@@ -1,6 +1,51 @@
 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,
@@ -19,6 +64,35 @@ describe Mousetrap::Customer do
     }
   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' => "Bad request: 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
@@ -80,20 +154,20 @@ describe Mousetrap::Customer do
     end
   end
 
-  describe '#destroy' do
+  describe '#cancel' do
     context "for existing records" do
-      it 'destroys' do
+      it 'cancels' do
         customer = Factory :existing_customer
-        Mousetrap::Customer.should_receive(:delete_resource).with('customers', customer.code)
-        customer.destroy
+        customer.should_receive(:member_action).with('cancel')
+        customer.cancel
       end
     end
 
     context "for new records" do
       it "does nothing" do
-        customer = Factory :new_customer
-        Mousetrap::Customer.should_not_receive(:delete_resource)
-        customer.destroy
+        customer = Factory.build :new_customer
+        customer.should_not_receive(:member_action).with('cancel')
+        customer.cancel
       end
     end
   end

data/spec/mousetrap/plan_spec.rb

@@ -16,4 +16,26 @@ describe Mousetrap::Plan do
   # 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

@@ -64,18 +64,32 @@ describe Mousetrap::Resource do
     end
   end
 
-  describe '.all' do
-    it 'gets widgets resources' do
-      Mousetrap::Widget.stub(:build_resources_from)
-      Mousetrap::Widget.should_receive(:get_resources).with('widgets')
-      Mousetrap::Widget.all
+  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
 
-    it 'builds widget resources' do
-      response = stub
-      Mousetrap::Widget.stub(:get_resources => response)
-      Mousetrap::Widget.should_receive(:build_resources_from).with(response)
-      Mousetrap::Widget.all
+    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
 
@@ -108,7 +122,7 @@ describe Mousetrap::Resource do
   end
 
   describe ".put_resource" do
-    it "put to /xml/<resource>/<action>/productCode/<product_code>/code/<resource_code>" 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')

data/spec/mousetrap/subscription_spec.rb

@@ -9,4 +9,12 @@ describe Mousetrap::Subscription do
   #   id: 46ad3f1c-e472-102c-a92d-40402145ee8b
   #   ccLastFour: "1111"
   #   canceledDatetime: 
+
+  describe '#destroy' do
+    it "raises a NotImplementedError" do
+      expect do
+        Mousetrap::Subscription.new.destroy
+      end.to raise_error(NotImplementedError)
+    end
+  end
 end

data/spec/spec.opts

@@ -1,4 +1,2 @@
 --colour
---format specdoc
---loadby mtime
---reverse
+--format nested

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hashrocket-mousetrap
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - Jon Larkowski
@@ -12,7 +12,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-01 00:00:00 -07:00
+date: 2009-09-27 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency