spreedly-core-ruby 0.1.3 → 0.1.4

data/README.md

@@ -1,11 +1,12 @@
 SpreedlyCore
 ======
-
-spreedly-core-ruby is a Ruby library for accessing the [Spreedly Core API](https://spreedlycore.com/). Spreedly Core is a Software-as-a-Service billing solution that serves two major functions for companies and developers. 
+spreedly-core-ruby is a Ruby library for accessing the [Spreedly Core API](https://spreedlycore.com/). Spreedly Core is a Software-as-a-Service billing solution that serves two major functions for companies and developers.
 
 * First, it removes your [PCI Compliance](https://www.pcisecuritystandards.org/) requirement by pushing the card data handling and storage outside of your application. This is possible by having your customers POST their credit card info to the Spreedly Core service while embedding a transparent redirect URL back to your application (see "Submit payment form" on [the quick start guide](https://spreedlycore.com/manual/quickstart)). 
 * Second, it removes any possibility of your gateway locking you in by owning your customer billing data (yes, this happens). By allowing you to charge any card against whatever gateways you as a company have signed up for, you retain all of your customer data and can switch between gateways as you please. Also, expanding internationally won't require an additional technical integration with yet another gateway.
 
+Credit where credit is due: our friends over at [403 Labs](http://www.403labs.com/) carried most of the weight in cutting the initial version of this gem, and we can't thank them enough for their work.
+
 Quickstart
 ----------
 Head over to the [Spreedly Core Website](https://www.spreedlycore.com) to sign up for an account. It's free to get started and play with test gateways/transactions using our specified test card data.
@@ -172,22 +173,27 @@ Additional Field Validation
 ----------
 The Spreely Core API provides validation of the credit card number, security code, and
 first and last name. In most cases this is enough; however, sometimes you may want to
-enforce the full billing information as well. This can be accomplished via the following:
+enforce the full billing information as well. The following example illustrates how this can be accomplished.
 
     SpreedlyCore.configure
     SpreedlyCore::PaymentMethod.additional_required_cc_fields :address1, :city, :state, :zip
+    
     master_card_data = SpreedlyCore::TestHelper.cc_data(:master)
     token = SpreedlyCore::PaymentMethod.create_test_token(master_card_data)
+    
     payment_method = SpreedlyCore::PaymentMethod.find(token)
     payment_method.valid? # false
     payment_method.errors # ["Address1 can't be blank", "City can't be blank", "State can't be blank", "Zip can't be blank"]
+    
     master_card_data = SpreedlyCore::TestHelper.cc_data(:master, :credit_card => {:address1 => "742 Evergreen Terrace", :city => "Springfield", :state => "IL", 62701})
+    token = SpreedlyCore::PaymentMethod.create_test_token(master_card_data)
+    
     payment_method = SpreedlyCore::PaymentMethod.find(token)
     payment_method.valid? # returns true
     payment_method.errors # []
 
    
-Configuring SpreedlyCore for use in production (Rails example)
+Configuring SpreedlyCore for Use in Production (Rails example)
 ----------
 When you're ready for primetime, you'll need to complete a couple more steps to start processing real transactions.
 
@@ -196,18 +202,26 @@ When you're ready for primetime, you'll need to complete a couple more steps to
 
 For this example, I will be using an Authorize.net account that only has a login and password credential.
 
-    authorize_credentials = {:login => 'my_authorize_login', :password => 'my_authorize_password'}
     SpreedlyCore.configure
-    gateway = SpreedlyCore::Gateway.create(authorize_credentials)
-    puts "Authorize.net gateway token is #{gateway.token}"
+    
+    gateway = SpreedlyCore::Gateway.create(:login => 'my_authorize_login', :password => 'my_authorize_password', :gateway_type => 'authorize_net')
     gateway.use!
     
-For most users, you will start off using only 1 gateway token, and as such can configure an additional environment variable to hold your gateway token. In addition to the previous environment variables, the SpreedlyCore.configure method will also look for a SPREEDLYCORE_GATEWAY_TOKEN environment value.
+    puts "Authorize.net gateway token is #{gateway.token}"
+    
+For most users, you will start off using only one gateway token, and as such can configure it as an environment variable to hold your gateway token. In addition to the previous environment variables, the SpreedlyCore.configure method will also look for a SPREEDLYCORE_GATEWAY_TOKEN environment value.
 
 	# create an initializer at config/initializers/spreedly_core.rb
     # values already set for ENV['SPREEDLYCORE_API_LOGIN'], ENV['SPREEDLYCORE_API_SECRET'], and ENV['SPREEDLYCORE_GATEWAY_TOKEN']
     SpreedlyCore.configure
     
+If you wish to require additional credit card fields, the initializer is the best place to set this up.
+
+    SpreedlyCore.configure
+    SpreedlyCore::PaymentMethod.additional_required_cc_fields :address1, :city, :state, :zip
+    
+Using Multiple Gateways
+------------
 For those using multiple gateway tokens, there is a class variable that holds the active gateway token. Before running any sort of transaction against a payment method, you'll need to set the gateway token that you wish to charge against.
 
     SpreedlyCore.configure
@@ -218,19 +232,30 @@ For those using multiple gateway tokens, there is a class variable that holds th
     SpreedlyCore.gateway_token(authorize_gateway_token)
     SpreedlyCore::PaymentMethod.find(pm_token).purchase(2885)
     
-If you wish to require additional credit card fields, the initializer is the best place to set this up.
+    SpreedlyCore.gateway_token(braintree_gateway_token)
+    SpreedlyCore::PaymentMethod.find(pm_token).credit(150)
+    
+Creating Payment Types Programatically
+------------
+For those using multiple gateway tokens, there is a class variable that holds the active gateway token. Before running any sort of transaction against a payment method, you'll need to set the gateway token that you wish to charge against.
 
     SpreedlyCore.configure
-    SpreedlyCore::PaymentMethod.additional_required_cc_fields :address1, :city, :state, :zip  
+    
+    SpreedlyCore.gateway_token(paypal_gateway_token)
+    SpreedlyCore::PaymentMethod.find(pm_token).purchase(550)
+    
+    SpreedlyCore.gateway_token(authorize_gateway_token)
+    SpreedlyCore::PaymentMethod.find(pm_token).purchase(2885)
+    
+    SpreedlyCore.gateway_token(braintree_gateway_token)
+    SpreedlyCore::PaymentMethod.find(pm_token).credit(150)
 
 Contributing
 ------------
-
-Once you've made your commits:
-
-1. [Fork](http://help.github.com/forking/) SpreedlyCore
-2. Create a topic branch - `git checkout -b my_branch`
+1. [Fork](http://help.github.com/forking/) spreedly-core-ruby
+2. Create a topic branch - `git checkout -b my_branch
+3. Make your changes on your topic branch.
+4. DO NOT bump the version number, or put it in a separate commit that I can ignore.
 3. Push to your branch - `git push origin my_branch`
 4. Create a [Pull Request](http://help.github.com/pull-requests/) from your branch
-5. Profit! 
 

data/lib/spreedly-core-ruby/version.rb

@@ -1,4 +1,4 @@
 module SpreedlyCore
-  Version = VERSION = "0.1.3"
+  Version = VERSION = "0.1.4"
   ApiVersion = API_VERSION = "v1"
 end

data/lib/spreedly-core-ruby.rb

@@ -6,6 +6,7 @@ require 'active_support/core_ext/hash/conversions'
 require 'spreedly-core-ruby/base'
 require 'spreedly-core-ruby/payment_method'
 require 'spreedly-core-ruby/gateway'
+require 'spreedly-core-ruby/test_extensions'
 require 'spreedly-core-ruby/test_gateway'
 require 'spreedly-core-ruby/transactions'
 require 'active_support/core_ext/hash/conversions'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spreedly-core-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ date: 2012-03-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70198459726880 !ruby/object:Gem::Requirement
+  requirement: &70226775420580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -22,10 +22,10 @@ dependencies:
         version: 0.7.7
   type: :runtime
   prerelease: false
-  version_requirements: *70198459726880
+  version_requirements: *70226775420580
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70198459725600 !ruby/object:Gem::Requirement
+  requirement: &70226775420040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70198459725600
+  version_requirements: *70226775420040
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: &70198459724560 !ruby/object:Gem::Requirement
+  requirement: &70226775419660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70198459724560
+  version_requirements: *70226775419660
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &70198459723100 !ruby/object:Gem::Requirement
+  requirement: &70226775419000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70198459723100
+  version_requirements: *70226775419000
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70198459721160 !ruby/object:Gem::Requirement
+  requirement: &70226775418400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -66,10 +66,10 @@ dependencies:
         version: 0.8.7
   type: :development
   prerelease: false
-  version_requirements: *70198459721160
+  version_requirements: *70226775418400
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70198459719780 !ruby/object:Gem::Requirement
+  requirement: &70226775417800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,7 +77,7 @@ dependencies:
         version: 1.6.2
   type: :development
   prerelease: false
-  version_requirements: *70198459719780
+  version_requirements: *70226775417800
 description: Spreedly Core is a cloud service that allows you to store credit cards
   and run transactions against them, enabling you to accept payments on your website
   while avoiding all liability and PCI compliance requirements.