cheddargetter_client_rails 0.1.16 → 0.1.26

data/README.rdoc

@@ -26,20 +26,19 @@ It can be very simple if you go with the default columns, ie:
 
 Then the declaration in the model is simply:
 
-	class User < ActiveRecord::Base
-	  has_subscription
-  end
+ class User < ActiveRecord::Base
+  has_subscription
+ end
 
 These are the only required columns however you can change their names locally very easily.
 
-  class User < ActiveRecord::Base
-    has_subscription :customerCode => :customer_code,
-										:firstName => :name
-										:lastName  => :l_name
-										:email			=> :business_email
-										:planCode   => "FREE_PLAN"
-										
-  end
+ class User < ActiveRecord::Base
+  has_subscription :customerCode => :customer_code,
+   :firstName => :name,
+   :lastName  => :l_name,
+   :email			=> :business_email,
+   :planCode   => "FREE_PLAN"										
+ end
 
 Note that the plan code can also take a string.
 
@@ -56,13 +55,13 @@ The has_subscription will also takes additional key/values of items that appear
 	:company
 	:zip
 
-When the save is called on the subscription object or create is called on the user it grabs all shared attributes from your ActiveRecord record. 
+When the save is called on the subscription object or the user it grabs all shared attributes from your ActiveRecord record. 
 
 === In the controller
 
 Make sure the subscription is always set on the user as some data may only exist there.
 
-	class CreditCardsController < ApplicationController
+	class SubscriptionController < ApplicationController
 	  def edit
 	    @user = current_user
 	  end
@@ -70,7 +69,7 @@ Make sure the subscription is always set on the user as some data may only exist
 	  def update
 	    @user = current_user
 
-	    if @user.save_subscription(params[:cheddargetter_client_rails_subscription])
+	    if @user.update_attributes(params[:user])
 	      redirect_to edit_credit_card_path, :flash => {:success => 'Billing information updated'}
 	    else     
 	      render 'edit'
@@ -81,75 +80,125 @@ Make sure the subscription is always set on the user as some data may only exist
 Or in a user controller
 
  class UsersController < ApplicationController
-	  def new
-	    @user = User.new
-	  end
+  def new
+   @user = User.new
+  end
 
-	  def create
-	    @user = User.new
-			@user.build_subscription(params[:cheddargetter_client_rails_subscription])
+  def create
+   @user = User.new(params[:user])
 
-	    if @user.save
-	      redirect_to after_creation_path, :flash => {:success => 'User successfully created'}
-	    else     
-	      render 'new'
-	    end
-	  end
-	end
+   if @user.save
+    redirect_to after_creation_path, :flash => {:success => 'User successfully created'}
+   else     
+    render 'new'
+   end
+  end
+
+  def update
+   @user = User.find(params[:id])
+
+   if @user.update_attributes(params[:user])
+    redirect_to @user, :flash => {:success => 'User successfully updated'}
+   else
+    render 'edit'
+   end
+  end
+
+ end
 
 The user save will take care of saving the subscription to CheddarGetter.
 
 === In the view
 
-Do something like this, if it is a user form use fields_for @user.subscription inside the user form.
-
-	<%= form_for(@user.subscription, :url => credit_cards_path) do |subscription| %>
-		<fieldset>
-			<%= subscription.hidden_field :planCode, :value => 'FREE_PLAN', :class => 'jq_planCodeValue' %>
-		
+In order to save through the user param it is important to nest the subscription params
+in the user params with fields for.  This is an example of how to set up the form properly.
+
+	<%= form_for(@user) do |f| %>
+	  <%= @user.errors.full_messages.each do |message|%>
+			<%= message %>
+		<% end %>
+	  <% if @user.errors.any? %>
+	    <div id="error_explanation">
+	      <h2><%= pluralize(@user.errors.count, "error") %> prohibited this user from being saved:</h2>
+
+	      <ul>
+	      <% @user.errors.full_messages.each do |msg| %>
+	        <li><%= msg %></li>
+	      <% end %>
+	      </ul>
+	    </div>
+	  <% end %>
+
+	  <div class="field">
+	    <%= f.label :email %><br />
+	    <%= f.text_field :email %>
+	  </div>
+	  <div class="field">
+	    <%= f.label :first_name %><br />
+	    <%= f.text_field :first_name %>
+	  </div>
+	  <div class="field">
+	    <%= f.label :last_name %><br />
+	    <%= f.text_field :last_name %>
+	  </div>
+	  <div class="field">
+	    <%= f.label :plan_code, "User Plan" %><br />
+	    <%= f.select :plan_code, User::Plans #This is a collection of my plans, ie, [['Free Plan', 'FREE_PLAN'], ['Paid Plan'], ['PAID_PLAN']].  You will need to use your own plans here.
+	     %> 
+	  </div>
+
+		The following fields are only required if selecting a paid plan.
+		<%= fields_for(:'user[subscription]') do |s| %> #THIS IS THE TRICKY WAY TO NEST THE SUBSCRIPTION PROPERLY.
 			<dl>
-				<dt>First Name:</dt> 
-				<dd>
-					<%= subscription.text_field :ccFirstName,:autocomplete => "off" %>
-				</dd>
-
-				<dt>Last Name:</dt> 
-				<dd>
-					<%= subscription.text_field :ccLastName, :autocomplete => "off" %>
-				</dd>
-			
-				<dt>Card Number:</dt>
-				<dd>
-					<%= subscription.text_field :ccNumber,:autocomplete => "off" %>
-				</dd>
-				<dt>Expiration Date:</dt>
-				<dd>
-					<%= subscription.text_field :ccExpiration, :autocomplete => 'off' %>
-				</dd>
-				<dt>Address:</dt>
-				<dd>
-					<%= subscription.text_field :ccAddress, :autocomplete => 'off' %>
-				</dd>
-				<dt>City:</dt>
-				<dd>
-					<%= subscription.text_field :ccCity, :autocomplete => 'off' %>
-				</dd>
-				<dt>State:</dt>
-				<dd>
-					<%= subscription.text_field :ccState, :autocomplete => 'off' %>
-				</dd>
-				<dt>Zip Code:</dt>
-				<dd>
-					<%= subscription.text_field :zip, :autocomplete => 'off' %>
-				</dd>
-				<dt>Country:</dt>
-				<dd>
-					<%= subscription.text_field :ccCountry, :autocomplete => 'off' %>
-				</dd>
-			</dt
-		</fieldset>
+	      <dt>First Name:</dt>
+	      <dd>
+	              <%= s.text_field :ccFirstName,:autocomplete => "off" %>
+	      </dd>
+
+	      <dt>Last Name:</dt>
+	      <dd>
+	              <%= s.text_field :ccLastName, :autocomplete => "off" %>
+	      </dd>
+
+	      <dt>Card Number:</dt>
+	      <dd>
+	              <%= s.text_field :ccNumber,:autocomplete => "off" %>
+	      </dd>
+	      <dt>Expiration Date:</dt>
+	      <dd>
+	              <%= s.text_field :ccExpiration, :autocomplete => 'off' %>
+	      </dd>
+	      <dt>Address:</dt>
+	      <dd>
+	              <%= s.text_field :ccAddress, :autocomplete => 'off' %>
+	      </dd>
+	      <dt>City:</dt>
+	      <dd>
+	              <%= s.text_field :ccCity, :autocomplete => 'off' %>
+	      </dd>
+	      <dt>State:</dt>
+	      <dd>
+	              <%= s.text_field :ccState, :autocomplete => 'off' %>
+	      </dd>
+	      <dt>Zip Code:</dt>
+	      <dd>
+	              <%= s.text_field :zip, :autocomplete => 'off' %>
+	      </dd>
+	      <dt>Country:</dt>
+	      <dd>
+	              <%= s.text_field :ccCountry, :autocomplete => 'off' %>
+	      </dd>
+			</dl>
+		<% end %>
+	
+		<div class="actions">
+	    <%= f.submit %>
+	  </div>
 	<% end %>
 	
+You'll want to user the current_subscription method to get a subscription object with current data.
+CheddarGetter only stores the last 4 of the credit card. This data is gotten by calling ccLastFour
+on the subscription object gotten through the current_subscription call. 
 
 == Contributing to cheddargetter_client_rails
  

data/VERSION

@@ -1 +1 @@
-0.1.16
+0.1.26

data/cheddargetter_client_rails.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cheddargetter_client_rails}
-  s.version = "0.1.16"
+  s.version = "0.1.26"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brent Wooden"]
-  s.date = %q{2011-05-15}
+  s.date = %q{2011-05-16}
   s.description = %q{Integrates CheddarGetter api with Active Record. Uses cheddargetter_client_ruby.}
   s.email = %q{brent.wooden@gmail.com}
   s.extra_rdoc_files = [
@@ -35,11 +35,13 @@ Gem::Specification.new do |s|
     "lib/generators/cheddargetter/cheddargetter_generator.rb",
     "lib/generators/cheddargetter/templates/cheddargetter.yml",
     "lib/generators/cheddargetter/templates/cheddargetter_client.rb",
+    "lib/rails/naming.rb",
     "lib/rails/record_identifier.rb",
     "spec/cheddargetter_client_rails/subscription_spec.rb",
     "spec/cheddargetter_client_rails_spec.rb",
     "spec/fixtures/users.yml",
     "spec/generator_spec.rb",
+    "spec/naming_spec.rb",
     "spec/record_identifier_spec.rb",
     "spec/spec_helper.rb"
   ]

data/lib/cheddargetter_client_rails.rb

@@ -2,6 +2,7 @@ require 'active_support'
 require 'action_controller/record_identifier'
 require 'cheddargetter_client_ruby'
 require 'rails/record_identifier'
+require 'rails/naming'
 
 module CheddargetterClientRails
   autoload :Subscription, 'cheddargetter_client_rails/subscription'
@@ -26,6 +27,10 @@ module CheddargetterClientRails
     end
     
     def supplement_subscription_fields
+      if subscription.is_a?(ActiveSupport::HashWithIndifferentAccess)
+        self.subscription = CheddargetterClientRails::Subscription.new(subscription)
+      end
+
       self.class.shared_columns.each do |subscription_column, user_attribute|
         if(subscription_column == :planCode && user_attribute.is_a?(String)) #user can specify planCode as a string
           subscription.send(subscription_column.to_s + '=', user_attribute)
@@ -78,6 +83,21 @@ module CheddargetterClientRails
       build_subscription(attributes_hash)
       subscription.save
     end
+    
+    def update_subscription
+      if !new_record?
+        subscription.customerCode = customer_code_column_value if subscription.customerCode.blank? and customer_code_column_value.present?
+        if shared_attributes_have_changed? || subscription.fields_present?
+          subscription.update
+        end
+      end
+    end
+    
+    def shared_attributes_have_changed?
+      self.class.shared_columns.collect do |cgkey, column|
+        self.send(column.to_s + '_changed?')
+      end.include?(true)      
+    end
   end
   
   module ClassMethods
@@ -101,7 +121,8 @@ module CheddargetterClientRails
       
       validate        :validate_subscription
       after_create    :create_subscription
-      before_destroy  :destroy_subscription           
+      before_destroy  :destroy_subscription
+      after_save      :update_subscription            
     end
 
     def responds_to_customer_code_column?

data/lib/cheddargetter_client_rails/subscription.rb

@@ -4,6 +4,25 @@ module CheddargetterClientRails
 
     Months = ("01".."12").freeze
     Years  = (Date.current.year..Date.current.year+10).collect{|y| y.to_s }.freeze
+    CGKeys =  [   
+      :planCode,
+      :company,
+      :firstName,
+      :lastName,
+      :ccFirstName,
+      :ccLastName,
+      :ccExpiration,
+      :ccNumber,
+      :ccLastFour,
+      :ccCountry,
+      :ccAddress,
+      :ccCity,
+      :ccState,
+      :customerCode,
+      :email,
+      :zip    
+    ]
+  
   
     attr_accessor :planCode,
                   :company,
@@ -182,5 +201,16 @@ module CheddargetterClientRails
         :email => email
       }     
     end
+    
+    def to_key
+      nil
+    end
+    
+    def fields_present?
+      CGKeys.collect do |key|
+        val = send(key)
+        val if val.present?
+      end.compact.present?
+    end
   end
 end

data/lib/rails/naming.rb

@@ -0,0 +1,9 @@
+module ActiveModel::Naming
+  def self.singular(record_or_class)
+    model_name_from_record_or_class(record_or_class).singular.gsub('cheddargetter_client_rails_', '')
+  end
+  
+  def self.plural(record_or_class)
+    model_name_from_record_or_class(record_or_class).plural.gsub('cheddargetter_client_rails_', '')
+  end
+end

data/spec/cheddargetter_client_rails/subscription_spec.rb

@@ -1,7 +1,27 @@
 require 'spec_helper'
 
 describe CheddargetterClientRails::Subscription do
-  let(:user)          { double("TestUser") }
+  before {
+    class TestUser < ActiveRecord::Base
+      attr_accessor :customer_code, :first_name, :last_name, :plan_code, :email
+
+      def self.column_names
+        []
+      end
+            
+      has_subscription :customerCode => :customer_code,
+                                :firstName    => :first_name, 
+                                :lastName     => :last_name, 
+                                :ccFirstName  => :first_name, 
+                                :ccLastName   => :last_name, 
+                                :planCode     => :plan_code
+                                              
+    end
+  }
+  
+  before { ActiveRecord::Base.stub(:connection).and_return mock(:columns => []) }
+  
+  let(:user)          { TestUser.new }
   let(:subscription)  { CheddargetterClientRails::Subscription.new }
   let(:customer_code) { 'JOHN_DOE' }
 
@@ -196,4 +216,27 @@ describe CheddargetterClientRails::Subscription do
       })
     }
   end
+  
+  describe 'to_key' do
+    subject { subscription.to_key }
+    it { should eq(nil) }
+  end
+  
+  describe 'subscription_fields_present?' do
+    subject { user.subscription.fields_present? }
+    
+    context 'when they are not present' do
+      it { should be_false }
+    end
+    
+    context 'when one is and it is nil' do
+      before { user.subscription.firstName = nil }
+      it { should be_false }
+    end
+    
+    context 'when is and it is not nil' do
+      before { user.subscription.firstName = 'Joe' }
+      it { should be_true }
+    end
+  end
 end

data/spec/cheddargetter_client_rails_spec.rb

@@ -338,6 +338,38 @@ describe "CheddargetterClientRails" do
         user.subscription.planCode.should == "EVERYBODYS_PLAN"
       }
     end
+    
+    context 'when subscription is a ActiveSupport::HashWithIndifferentAccess' do
+      let!(:user) {
+        TestUser.new  
+      }
+      
+      before { user.subscription = ActiveSupport::HashWithIndifferentAccess.new }
+
+      before { user.class.stub(:shared_columns).and_return({
+                                                  :firstName    => :first_name, 
+                                                  :lastName     => :last_name, 
+                                                  :ccFirstName  => :first_name, 
+                                                  :ccLastName   => :last_name, 
+                                                  :planCode     => :plan_code
+                                                })
+      }
+
+      before {
+        user.customer_code  = "FIRST_NAME" 
+        user.first_name     = "First"
+        user.last_name      = "Last"
+        user.plan_code      = "TEST_PLAN"
+      }
+
+      subject { user.supplement_subscription_fields }
+      specify { 
+        subject
+        user.subscription.firstName.should == "First"
+        user.subscription.lastName.should == "Last"
+        user.subscription.planCode.should == "TEST_PLAN"
+      }
+    end
   end
 
   describe 'create_subscription' do
@@ -494,4 +526,60 @@ describe "CheddargetterClientRails" do
     before { user.subscription.should_receive(:save) }
     it do subject end
   end
+  
+  describe 'update_subscription' do
+    subject { user.update_subscription }
+    
+    context 'when user is a new record' do
+      before { user.stub(:new_record?).and_return(true) }
+      before { user.subscription.should_not_receive(:save) }
+      it do subject end      
+    end
+    
+    context 'when user is not a new record' do
+      before { user.stub(:new_record?).and_return(false) }
+      before { user.customer_code = 'coooode' }
+      
+      context 'and shared_attributes have not changed' do
+        before { user.stub(:shared_attributes_have_changed?).and_return false }
+        before { user.subscription.stub(:fields_present?).and_return false }
+        before { user.subscription.should_not_receive(:save) }        
+        it do subject end        
+      end
+    
+      context 'and shared_attributes have changed' do        
+        before { user.stub(:shared_attributes_have_changed?).and_return true }
+        
+        context 'but subscription fields are not present' do
+          before { user.subscription.stub(:fields_present?).and_return false }
+          before { user.subscription.should_receive(:update) }        
+          it do subject end          
+        end
+    
+        context 'and attributes have changed and subscription fields are present' do
+          before { user.subscription.stub(:fields_present?).and_return true }
+          before { user.subscription.should_receive(:update) }        
+          it do subject end
+        end
+      end
+    end
+  end
+  
+  describe 'shared_attributes_have_changed?' do
+    subject { user.shared_attributes_have_changed? }
+    before { 
+      user.class.shared_columns.each do |cgkey, attribute|
+        user.stub((attribute.to_s + '_changed?').to_sym).and_return false
+      end 
+    }
+    
+    context 'when attributes have not changed' do
+      it { should be_false }
+    end
+    
+    context 'when an attribute has changed' do
+      before { user.stub((user.class.shared_columns.first[1]).to_s + '_changed?').and_return true }
+      it { should be_true }
+    end
+  end
 end

data/spec/naming_spec.rb

@@ -0,0 +1,78 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "RecordIdentifier" do
+  before {
+    class TestUser < ActiveRecord::Base
+      attr_accessor :customer_code, :first_name, :last_name, :plan_code, :email
+
+      def self.column_names
+        []
+      end
+            
+      has_subscription :customerCode => :customer_code,
+                                :firstName    => :first_name, 
+                                :lastName     => :last_name, 
+                                :ccFirstName  => :first_name, 
+                                :ccLastName   => :last_name, 
+                                :planCode     => :plan_code
+                                              
+    end    
+  }
+  
+  before { ActiveRecord::Base.stub(:connection).and_return mock(:columns => []) }
+  
+  describe 'singular' do
+    subject { ActiveModel::Naming.singular(record_or_class) }
+    
+    context 'called with class' do
+      let(:record_or_class) { CheddargetterClientRails::Subscription }
+      it { should eq('subscription') }
+    end
+    
+    context 'called with class' do
+      let(:record_or_class) { CheddargetterClientRails::Subscription.new }
+      it { should eq('subscription') }      
+    end
+    
+    context 'with user model' do
+      context 'called with class' do
+        let(:record_or_class) { TestUser }
+        it { should eq('test_user') }
+      end
+
+      context 'called with class' do
+        let(:record_or_class) { TestUser.new }
+        it { should eq('test_user') }      
+      end
+    end
+  end
+  
+  describe 'plural' do
+    subject { ActiveModel::Naming.plural(record_or_class) }
+    
+    context 'called with class' do
+      let(:record_or_class) { CheddargetterClientRails::Subscription }
+      it { should eq('subscriptions') }
+    end
+    
+    context 'called with class' do
+      let(:record_or_class) { CheddargetterClientRails::Subscription.new }
+      it { should eq('subscriptions') }      
+    end
+    
+    context 'with user model' do
+      context 'called with class' do
+        let(:record_or_class) { TestUser }
+        it { should eq('test_users') }
+      end
+
+      context 'called with class' do
+        let(:record_or_class) { TestUser.new }
+        it { should eq('test_users') }      
+      end
+    end
+  end
+  
+  
+  
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cheddargetter_client_rails
 version: !ruby/object:Gem::Version 
-  hash: 59
+  hash: 47
   prerelease: false
   segments: 
   - 0
   - 1
-  - 16
-  version: 0.1.16
+  - 26
+  version: 0.1.26
 platform: ruby
 authors: 
 - Brent Wooden
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-15 00:00:00 -04:00
+date: 2011-05-16 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -138,11 +138,13 @@ files:
 - lib/generators/cheddargetter/cheddargetter_generator.rb
 - lib/generators/cheddargetter/templates/cheddargetter.yml
 - lib/generators/cheddargetter/templates/cheddargetter_client.rb
+- lib/rails/naming.rb
 - lib/rails/record_identifier.rb
 - spec/cheddargetter_client_rails/subscription_spec.rb
 - spec/cheddargetter_client_rails_spec.rb
 - spec/fixtures/users.yml
 - spec/generator_spec.rb
+- spec/naming_spec.rb
 - spec/record_identifier_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true