cheddargetter_client_rails 0.1.8

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+  gem "activesupport", ">= 2.3.5"
+  gem "cheddargetter_client_ruby", ">= 0"
+
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.0"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,37 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.7)
+    cheddargetter_client_ruby (0.3.1)
+      httparty (>= 0.4.3)
+      httparty (>= 0.4.3)
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    httparty (0.7.7)
+      crack (= 0.1.8)
+    jeweler (1.6.0)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (>= 2.3.5)
+  bundler (~> 1.0.0)
+  cheddargetter_client_ruby
+  jeweler (~> 1.6.0)
+  rcov
+  rspec (~> 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Brent Wooden
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,142 @@
+= cheddargetter_client_rails
+
+The CheddarGetter rails client aims to tie the CheddarGetter API closely into ActiveRecord models.  
+Much of the heavy lifting with the api itself is done through the cheddargetter_client_ruby gem.
+
+== Usage
+
+=== 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.
+
+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.
+
+The planCode shared attribute may also be set as string, as sometimes you want everyone on the same plan.
+
+	class User < ActiveRecord::Base
+		cheddargetter_billable_on :customer_code, :shared_columns => {
+		  :email        => :email,
+		  :firstName    => :first_name,
+		  :lastName     => :last_name,
+		  :planCode     => 'PAID_PLAN'
+		}
+  end
+
+=== In the controller
+
+Make sure the subscription is always set on the user as some data may only exist there.
+
+	class CreditCardsController < ApplicationController
+	  def edit
+	    @user = current_user
+	  end
+
+	  def update
+	    @user = current_user
+
+	    if @user.save_subscription(params[:cheddargetter_client_rails_subscription])
+	      redirect_to edit_credit_card_path, :flash => {:success => 'Billing information updated'}
+	    else     
+	      render 'edit'
+	    end
+	  end
+	end
+
+Or in a user controller
+
+	class UsersController < ApplicationController
+	  def new
+	    @user = User.new
+	  end
+
+	  def create
+	    @user = User.new
+			@user.build_subscription(params[:cheddargetter_client_rails_subscription])
+
+	    if @user.save
+	      redirect_to after_creation_path, :flash => {:success => 'User successfully created'}
+	    else     
+	      render 'new'
+	    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' %>
+		
+			<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>
+		</fieldset>
+	<% end %>
+	
+
+== Contributing to cheddargetter_client_rails
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Brent Wooden. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "cheddargetter_client_rails"
+  gem.homepage = "http://github.com/BrentW/cheddargetter_client_rails"
+  gem.license = "MIT"
+  gem.summary = %Q{Integrates CheddarGetter api with Active Record}
+  gem.description = %Q{Integrates CheddarGetter api with Active Record. Uses cheddargetter_client_ruby.}
+  gem.email = "brent.wooden@gmail.com"
+  gem.authors = ["Brent Wooden"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cheddargetter_client_rails #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.8

data/cheddargetter_client_rails.gemspec

@@ -0,0 +1,73 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cheddargetter_client_rails}
+  s.version = "0.1.8"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brent Wooden"]
+  s.date = %q{2011-05-11}
+  s.description = %q{Integrates CheddarGetter api with Active Record. Uses cheddargetter_client_ruby.}
+  s.email = %q{brent.wooden@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "cheddargetter_client_rails.gemspec",
+    "features/cheddargetter_client_rails.feature",
+    "features/step_definitions/cheddargetter_client_rails_steps.rb",
+    "features/support/env.rb",
+    "lib/cheddargetter_client_rails.rb",
+    "lib/cheddargetter_client_rails/subscription.rb",
+    "spec/cheddargetter_client_rails/subscription_spec.rb",
+    "spec/cheddargetter_client_rails_spec.rb",
+    "spec/fixtures/users.yml",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/BrentW/cheddargetter_client_rails}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Integrates CheddarGetter api with Active Record}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.5"])
+      s.add_runtime_dependency(%q<cheddargetter_client_ruby>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 2.3.5"])
+      s.add_dependency(%q<cheddargetter_client_ruby>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 2.3.5"])
+    s.add_dependency(%q<cheddargetter_client_ruby>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/features/cheddargetter_client_rails.feature

@@ -0,0 +1,9 @@
+Feature: something something
+  In order to something something
+  A user something something
+  something something something
+
+  Scenario: something something
+    Given inspiration
+    When I create a sweet new gem
+    Then everyone should see how awesome I am

data/features/support/env.rb

@@ -0,0 +1,13 @@
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'cheddargetter_client_rails'
+
+require 'rspec/expectations'

data/lib/cheddargetter_client_rails.rb

@@ -0,0 +1,120 @@
+require 'active_support'
+require 'cheddargetter_client_ruby'
+
+module CheddargetterClientRails
+  autoload :Subscription, 'cheddargetter_client_rails/subscription'
+  
+  def self.included(base)
+    base.extend ClassMethods
+    
+    def subscription
+      @subscription ||= Subscription.new
+    end
+    
+    def subscription=(value)
+      @subscription = value
+    end
+    
+    def validate_subscription
+       supplement_subscription_fields
+       
+       if !skip_cheddargetter && new_record? && !subscription.valid?
+         errors.add(:subscription, 'problem')
+       end
+    end
+    
+    def supplement_subscription_fields
+      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)
+        else
+          subscription.send(subscription_column.to_s + '=', send(user_attribute))
+        end
+      end
+    end
+    
+    def create_subscription
+      raise ArgumentError, 'Customer code is not set on record.' if !customer_code_column_value && !subscription.customerCode
+      subscription.customerCode = customer_code_column_value if !subscription.customerCode
+      subscription.create unless skip_cheddargetter
+    end
+        
+    def current_subscription
+      @current_subscription ||= CheddargetterClientRails::Subscription.get(customer_code_column_value) if customer_code_column_value
+    end
+    
+    def destroy_subscription
+      current_subscription.try(:destroy)
+    end
+
+    def customer_code_column_value
+      send(self.class.send(:customer_code_column)) if self.class.send(:customer_code_column)
+    end
+    
+    def build_subscription(attributes_hash)
+      # set attributes from current cheddargetter subscription, then
+      # replaces any values with supplied data
+      new_subscription = CheddargetterClientRails::Subscription.new
+      if old_subscription = current_subscription
+        old_subscription.instance_variables_hash.each do |key, value|
+          new_subscription.send(key.to_s + '=', value)
+        end
+      end
+      
+      attributes_hash.each do |key, value|
+        new_subscription.send(key.to_s + '=', value)
+      end
+      
+      self.subscription = new_subscription
+      new_subscription
+    end
+    
+    def save_subscription(attributes_hash)
+      build_subscription(attributes_hash)
+      subscription.save
+    end
+  end
+  
+  module ClassMethods
+    def cheddargetter_billable_on(*args)
+      raise ArgumentError.new('Must supply customer code column.') if args.length < 1
+      self.customer_code_column = args.shift
+      raise ArgumentError.new("Record does not respond to #{customer_code_column.to_s}.") if !responds_to_customer_code_column?        
+      
+      if args.length > 0
+        self.shared_columns = args.shift[:shared_columns]
+      end
+      
+      attr_accessor :skip_cheddargetter
+      
+      validate        :validate_subscription
+      after_create    :create_subscription
+      before_destroy  :destroy_subscription           
+    end
+
+    def responds_to_customer_code_column?
+      self.instance_methods.include?(customer_code_column.to_s) || 
+      self.column_names.include?(customer_code_column.to_s)      
+    end
+
+    def customer_code_column
+      @customer_code_column
+    end
+  
+    def customer_code_column=(column)
+      @customer_code_column = column
+    end
+    
+    def shared_columns
+      @shared_columns
+    end
+    
+    def shared_columns=(columns)
+      @shared_columns = columns
+    end    
+  end
+end
+
+class ActiveRecord::Base
+  include CheddargetterClientRails
+end