cheddargetter_client_rails 0.1.14 → 0.1.15

data/README.rdoc

@@ -7,32 +7,48 @@ Much of the heavy lifting with the api itself is done through the cheddargetter_
 
 === In the model
 
-	class User < ActiveRecord::Base
-		cheddargetter_billable_on :customer_code, :shared_columns => {
-		  :email        => :email,
-		  :firstName    => :first_name,
-		  :lastName     => :last_name,
-		  :planCode     => :plan_code
-		}
- end
-
-The first argument is the unique identifier column that CheddarGetter uses for the customers' customerCode.
-It can be any column as long as it is unique.
+It can be very simple if you go with the default columns, ie:
 
-The shared columns hash are other attributes that appear both in your records for the user and CheddarGetter's records.  When the save is called on the subscription object it grabs these attributes from your ActiveRecord 
-record.  This is to prevent duplicate form inputs asking the user more than once for the same information.
+	:customerCode => :id
+  :email        => :email,
+  :firstName    => :first_name,
+  :lastName     => :last_name,
+  :planCode     => :plan_code
 
-The planCode shared attribute may also be set as string, as sometimes you want everyone on the same plan.
+Then the declaration in the model is simply:
 
 	class User < ActiveRecord::Base
-		cheddargetter_billable_on :customer_code, :shared_columns => {
-		  :email        => :email,
-		  :firstName    => :first_name,
-		  :lastName     => :last_name,
-		  :planCode     => 'PAID_PLAN'
-		}
+	  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
 
+Note that the plan code can also take a string.
+
+The has_subscription will also takes additional key/values of items that appear both in your records for the user and CheddarGetter's records. For instance zip code is a common one. Here are others:
+
+	:ccFirstName,
+	:ccLastName,
+	:ccExpiration,
+	:ccNumber,
+	:ccCountry,
+	:ccAddress,
+	:ccCity,
+	:ccState,
+	: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. 
+
 === In the controller
 
 Make sure the subscription is always set on the user as some data may only exist there.
@@ -121,6 +137,7 @@ Do something like this, if it is a user form use fields_for @user.subscription i
 				<dd>
 					<%= subscription.text_field :ccCountry, :autocomplete => 'off' %>
 				</dd>
+			</dt
 		</fieldset>
 	<% end %>
 	

data/VERSION

@@ -1 +1 @@
-0.1.14
+0.1.15

data/cheddargetter_client_rails.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cheddargetter_client_rails}
-  s.version = "0.1.14"
+  s.version = "0.1.15"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brent Wooden"]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cheddargetter_client_rails
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: false
   segments: 
   - 0
   - 1
-  - 14
-  version: 0.1.14
+  - 15
+  version: 0.1.15
 platform: ruby
 authors: 
 - Brent Wooden