chargify_api_ares 0.6.0 → 0.6.1

data/.gitignore

@@ -5,3 +5,4 @@ pkg
 .ruby-version
 .bundle/
 bin/
+.rbenv-version

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    chargify_api_ares (0.6.0)
+    chargify_api_ares (0.6.1)
       activeresource (>= 3.0.0)
 
 GEM
@@ -67,6 +67,7 @@ DEPENDENCIES
   fakeweb (~> 1.3.0)
   growl (~> 1.0.3)
   guard-rspec (~> 2.4.0)
+  pry (~> 0.9.12)
   rake (~> 10.0.3)
   rb-fsevent (~> 0.9.2)
   rspec (~> 2.12.0)

data/README.md

@@ -6,6 +6,42 @@ Chargify API wrapper for Ruby (using ActiveResource)
 
 This is a Ruby wrapper for the [Chargify](http://chargify.com) API that leverages ActiveResource.
 
+To configure api key, site, domain, and protocol you can do the
+following. Please note that this step is required.
+
+Most common usage
+----------------
+
+``` ruby
+  Chargify.configure do |c|
+    c.api_key   = "your_key_goes_here"
+    c.subdomain = "test-site"
+  end
+```
+
+Overriding the endpoint
+--------------
+
+``` ruby
+  Chargify.configure do |c|
+    c.api_key   = "your_key_goes_here"
+    c.site      = "https://test-site.some-domain.com"
+  end
+```
+
+Available configuration options
+-------------------------------
+
+| Name              | Description                                                                                      | Default      | Required                   |
+| ----------------- | -----------------------------------------------------------------------------------              | ---------    | -------------------------- |
+| api_key           | The api_key credentials that are used to access your chargify account.                           | N/A          | Yes                        |
+| subdomain         | The subdomain (site name) of the chargify endpoint you are trying to interact with               | test         | Yes (unless site was used) |
+| domain            | The domain of the endpoint, in which you want to interact with.                                  | chargify.com | No                         |
+| protocol          | The endpoint protocol that you wish to use (http / https)                                        | https        | No                         |
+| site              | This is meant to override all three of the previous settings eg: http://foo.bar.com              | N/A          | No                         |
+| format            | The format of the request and response type that you want to deal with                           | xml          | No                         |
+| timeout           | The time in seconds for a request to be valid. Will raise a timeout error if exceeds time limit. | N/A          | No                         |
+
 It allows you to interface with the Chargify API using simple ActiveRecord-like syntax, i.e.:
 
 ``` ruby

data/chargify_api_ares.gemspec

@@ -4,11 +4,11 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.7'
   
   s.name    = 'chargify_api_ares'
-  s.version = '0.6.0'
-  s.date    = '2013-02-16'
+  s.version = '0.6.1'
+  s.date    = '2013-02-26'
   s.summary = 'A Chargify API wrapper for Ruby using ActiveResource'
   s.description = ''
-  s.authors = ["Michael Klett", "Nathan Verni", "Graham McIntire", "Rodrigo Franco", "Shay Frendt"]
+  s.authors = ["Michael Klett", "Nathan Verni", "Graham McIntire", "Jeremy W. Rowe", "Rodrigo Franco", "Shay Frendt"]
   s.email = 'support@chargify.com'
   s.homepage = 'http://github.com/chargify/chargify_api_ares'
   
@@ -28,4 +28,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency('guard-rspec', '~> 2.4.0')
   s.add_development_dependency('growl', '~> 1.0.3')
   s.add_development_dependency('rb-fsevent', '~> 0.9.2')
+  s.add_development_dependency('pry', '~> 0.9.12')
 end

data/lib/chargify_api_ares/config.rb

@@ -1,18 +1,18 @@
 module Chargify
   class << self
-    attr_accessor :subdomain, :api_key, :site, :format, :timeout
+    attr_accessor :subdomain, :api_key, :site, :format, :timeout, :domain, :protocol
 
     def configure
       yield self
-
+      self.protocol  = protocol  || "https"
+      self.domain    = domain    || "chargify.com"
+      self.format    = format    || :xml
+      self.subdomain = subdomain || "test"
       Base.user      = api_key
       Base.password  = 'X'
       Base.timeout   = timeout unless (timeout.blank?)
-      
-      self.site ||= "https://#{subdomain}.chargify.com"
-      Base.site = site
-      self.format ||= :xml
-      Base.format = format
+      Base.site      = site || "#{protocol}://#{subdomain}.#{domain}"
+      Base.format    = format
     end
   end
 end

data/spec/remote/remote.example.yml

@@ -2,5 +2,8 @@
 #
 # Note: Remote tests will only work when configured to run on a test site that uses the Bogus gateway.
 # Warning: All data in the site specified will be cleared and replaced with test data.
-api_key: your_api_key
-site: your_site
+api_key: your_api_key # your api key for your login (Required)
+subdomain: your_site  # the subdomain for the site you wish to test (Required)
+#domain: ".foo.dev"   # this is optional to point to a local version of chargify
+#protocol: "http"     # this is an optional value to use https or http
+#site: "http://doo.foo-com" # this is optional to override the entire url

data/spec/remote/remote_helper.rb

@@ -10,8 +10,11 @@ end
 RSpec.configure do |config|
   config.before(:all) do
     Chargify.configure do |c|
-      c.api_key = remote_configuration['api_key']
-      c.site = remote_configuration['site']
+      c.api_key    = remote_configuration['api_key']
+      c.protocol   = remote_configuration['protocol']  if remote_configuration['protocol']
+      c.domain     = remote_configuration['domain']    if remote_configuration['domain']
+      c.subdomain  = remote_configuration['subdomain'] if remote_configuration['subdomain']
+      c.site       = remote_configuration['site']      if remote_configuration['site']
     end
   end
 end

data/spec/remote/remote_spec.rb

@@ -34,9 +34,9 @@ describe "Remote" do
       :email => "john.doe@example.com",
       :reference => "johndoe")
   end
-  
+
   let(:johnadoes_credit_card) { Chargify::PaymentProfile.create(good_payment_profile_attributes.merge(:customer_id => johnadoe.id)) }
-  
+
   before(:all) do
     # Make sure the test site data is set up correctly
     clear_site_data; acme_projects; basic_plan; pro_plan; johnadoe; johnadoes_credit_card
@@ -46,16 +46,16 @@ describe "Remote" do
     context "when providing valid attributes for the customer and the payment profile" do
       before(:all) do
         @subscription = Chargify::Subscription.create(
-          :product_handle => basic_plan.handle, 
+          :product_handle => basic_plan.handle,
           :customer_attributes => {
             :first_name => "Rick",
             :last_name => "James",
             :email => "rick@example.com",
             :reference => "rickjames"
-          }, 
-          :payment_profile_attributes => good_payment_profile_attributes) 
+          },
+          :payment_profile_attributes => good_payment_profile_attributes)
       end
-      
+
       it "sets the current_period_started_at attribute to now" do
         @subscription.current_period_started_at.utc.should be_within(60).of(now.utc)
       end
@@ -128,7 +128,7 @@ describe "Remote" do
             :last_name => "Marley",
             :email => "ziggy@example.com",
             :reference => "ziggy"
-          }, 
+          },
           :payment_profile_attributes => unstorable_payment_profile_attributes)
       end
 
@@ -155,7 +155,7 @@ describe "Remote" do
             :last_name => "Denver",
             :email => "john.denver@example.com",
             :reference => "johndenver"
-          }, 
+          },
           :payment_profile_attributes => pretokenized_card_attributes,
           :next_billing_at => ten_days_from_now.utc)
         @subscription.should be_a(Chargify::Subscription)
@@ -185,10 +185,14 @@ describe "Remote" do
             :last_name => "Sinatra",
             :email => "frank.sinatra@example.com",
             :reference => "franksinatra"
-          }, 
+          },
           :payment_profile_attributes => declined_payment_profile_attributes)
       end
 
+      it "returns the correct error message" do
+        @subscription.errors[:base].should include "Bogus Gateway: Forced failure"
+      end
+
       it "does not create the subscription" do
         @subscription.should_not be_valid
       end
@@ -281,7 +285,7 @@ describe "Remote" do
     context "via Chargify::Subscription#refund" do
       it "creates a refund" do
         lambda{
-          @subscription.refund :payment_id => @payment.id, :amount => 7, 
+          @subscription.refund :payment_id => @payment.id, :amount => 7,
             :memo => 'Refunding One Time Charge'
         }.should change{@subscription.reload.transactions.size}.by(1)
 
@@ -313,7 +317,7 @@ describe "Remote" do
         tx.transaction_type.should == 'refund'
       end
     end
-    
+
     describe 'Webhooks' do
       before(:all) do
         @subscription = Chargify::Subscription.create(

data/spec/spec_helper.rb

@@ -4,6 +4,7 @@ require 'bundler'
 Bundler.require(:default, :development)
 
 require 'support/fake_resource'
+require 'pry'
 
 FactoryGirl.find_definitions
 ActiveResource::Base.send :include, ActiveResource::FakeResource
@@ -13,7 +14,7 @@ Chargify.configure do |c|
   c.subdomain = 'test'
   c.api_key   = 'test'
 end
- 
+
 RSpec.configure do |config|
   config.filter_run :focused => true
   config.run_all_when_everything_filtered = true

metadata

@@ -1,19 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: chargify_api_ares
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
   prerelease: 
 platform: ruby
 authors:
 - Michael Klett
 - Nathan Verni
 - Graham McIntire
+- Jeremy W. Rowe
 - Rodrigo Franco
 - Shay Frendt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-16 00:00:00.000000000 Z
+date: 2013-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -159,6 +160,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12
 description: ''
 email: support@chargify.com
 executables: []
@@ -225,6 +242,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 4368782760728078099
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: