gocardless 1.6.3 → 1.7.0

data/.travis.yml

@@ -1,5 +1,6 @@
 script: "rake spec"
 rvm:
+  - 2.0.0
   - 1.9.3
   - 1.9.2
   - 1.8.7

data/CHANGELOG.md

@@ -1,8 +1,16 @@
+## 1.7.0 - April 19, 2013
+
+- Adds `retry!` method to Bill, allowing you to re-attempt collection where a
+  bill has a status of `failed`
+- Publicise Client#merchant_id
+- Deprecate old syntax for setting merchant id / scope
+- Add User#name method, for getting a user's full name
+- Add `?` methods for checking resource statuses (e.g. `Subscription#active?`)
+
 ## 1.6.3 - February 11, 2013
 
 - Handle empty arrays in Utils#flatten_params
 
-
 ## 1.6.2 - January 25, 2013
 
 - Add fee accessors to Bill

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec
 

data/README.md

@@ -1,4 +1,4 @@
-![GoCardless Ruby Client Library](https://s3-eu-west-1.amazonaws.com/gocardless/images/client-lib-headers/ruby-lib-header.png)
+[![GoCardless Ruby Client Library](https://s3-eu-west-1.amazonaws.com/gocardless/images/client-lib-headers/ruby-lib-header.png)](https://gocardless.com/docs?language=ruby)
 
 The GoCardless Ruby client provides a simple Ruby interface to the GoCardless
 API.

data/gocardless.gemspec

@@ -8,6 +8,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'mocha', '~> 0.9.12'
   gem.add_development_dependency 'yard', '~> 0.7.3'
   gem.add_development_dependency 'activesupport', '~> 3.1'
+  gem.add_development_dependency 'rake', '~> 10.0'
 
   gem.authors = ['Harry Marr', 'Tom Blomfield']
   gem.description = %q{A Ruby wrapper for the GoCardless API}

data/lib/gocardless/bill.rb

@@ -35,6 +35,11 @@ module GoCardless
       @source_type = Utils.underscore(klass)
     end
 
+    def retry!
+      path = self.class.endpoint.gsub(':id', id.to_s) + '/retry'
+      client.api_post(path)
+    end
+
     def save
       save_data({
         :bill => {
@@ -46,5 +51,25 @@ module GoCardless
       })
       self
     end
+
+    def pending?
+      status == 'pending'
+    end
+
+    def paid?
+      status == 'paid'
+    end
+
+    def failed?
+      status == 'failed'
+    end
+
+    def withdrawn?
+      status == 'withdrawn'
+    end
+
+    def refunded?
+      status == 'refunded'
+    end
   end
 end

data/lib/gocardless/client.rb

@@ -83,11 +83,18 @@ module GoCardless
 
     # Set the client's access token
     #
-    # @param [String] token a string with format <code>"#{token} #{scope}"</code>
+    # @param [String] token a string with format <code>"#{token}"</code>
     #   (as returned by {#access_token})
     def access_token=(token)
       token, scope = token.sub(/^bearer\s+/i, '').split(' ', 2)
-      scope ||= ''
+      if scope
+        warn "[DEPRECATION] (gocardless-ruby) merchant_id is now a separate " +
+             "attribute, the manage_merchant scope should no longer be " +
+             "included in the 'token' attribute. See http://git.io/G9y37Q " +
+             "for more info."
+      else
+        scope = ''
+      end
 
       @access_token = OAuth2::AccessToken.new(@oauth_client, token)
       @access_token.params['scope'] = scope
@@ -95,6 +102,14 @@ module GoCardless
       set_merchant_id_from_scope(scope) unless @merchant_id
     end
 
+    # Return the merchant id, throwing a proper error if it's missing.
+    def merchant_id
+      raise ClientError, 'No merchant id set' unless @merchant_id
+      @merchant_id
+    end
+
+    attr_writer :merchant_id
+
     # Issue an GET request to the API server
     #
     # @note this method is for internal use
@@ -285,12 +300,6 @@ module GoCardless
 
   private
 
-    # Return the merchant id, throwing a proper error if it's missing.
-    def merchant_id
-      raise ClientError, 'No merchant id set' unless @merchant_id
-      @merchant_id
-    end
-
     # Pull the merchant id out of the access scope
     def set_merchant_id_from_scope(scope)
       perm = scope.split.select {|p| p.start_with?('manage_merchant:') }.first

data/lib/gocardless/pre_authorization.rb

@@ -31,6 +31,22 @@ module GoCardless
       client.api_put(path)
     end
 
+    def inactive?
+      status == 'inactive'
+    end
+
+    def active?
+      status == 'active'
+    end
+
+    def cancelled?
+      status == 'cancelled'
+    end
+
+    def expired?
+      status == 'expired'
+    end
+
   end
 end
 

data/lib/gocardless/subscription.rb

@@ -25,6 +25,22 @@ module GoCardless
       client.api_put(path)
     end
 
+    def inactive?
+      status == 'inactive'
+    end
+
+    def active?
+      status == 'active'
+    end
+
+    def cancelled?
+      status == 'cancelled'
+    end
+
+    def expired?
+      status == 'expired'
+    end
+
   end
 end
 

data/lib/gocardless/user.rb

@@ -4,5 +4,9 @@ module GoCardless
 
     attr_accessor :name, :first_name, :last_name, :email
     date_accessor :created_at
+
+    def name
+      "#{first_name} #{last_name}".strip
+    end
   end
 end

data/lib/gocardless/version.rb

@@ -1,3 +1,3 @@
 module GoCardless
-  VERSION = '1.6.3'.freeze
+  VERSION = '1.7.0'.freeze
 end

data/spec/bill_spec.rb

@@ -5,13 +5,14 @@ describe GoCardless::Bill do
     @app_id = 'abc'
     @app_secret = 'xyz'
     GoCardless.account_details = {:app_id => @app_id, :app_secret => @app_secret,
-                                  :token  => 'xxx manage_merchant:1'}
+                                  :token  => 'xxx', :merchant_id => '1'}
     @client = GoCardless.client
   end
 
   it "source getter works" do
     b = GoCardless::Bill.new(:source_type => :subscription, :source_id => 123)
-    @client.access_token = 'TOKEN manage_merchant:123'
+    @client.access_token = 'TOKEN'
+    @client.merchant_id = '123'
     stub_get(@client, :id => 123)
     source = b.source
     source.should be_a GoCardless::Subscription
@@ -24,4 +25,60 @@ describe GoCardless::Bill do
     b.source_id.should == 123
     b.source_type.should.to_s == 'subscription'
   end
+
+  it "should be able to be retried" do
+    b = GoCardless::Bill.new(:id => 123)
+    @client.expects(:api_post).with('/bills/123/retry')
+    b.retry!
+  end
+
+  describe "pending query method" do
+    it "returns true when the subscription status is pending" do
+      GoCardless::Bill.new(:status => 'pending').pending?.should be_true
+    end
+
+    it "returns false otherwise" do
+      GoCardless::Bill.new.pending?.should be_false
+    end
+  end
+
+  describe "paid query method" do
+    it "returns true when the subscription status is paid" do
+      GoCardless::Bill.new(:status => 'paid').paid?.should be_true
+    end
+
+    it "returns false otherwise" do
+      GoCardless::Bill.new.paid?.should be_false
+    end
+  end
+
+  describe "failed query method" do
+    it "returns true when the subscription status is failed" do
+      GoCardless::Bill.new(:status => 'failed').failed?.should be_true
+    end
+
+    it "returns false otherwise" do
+      GoCardless::Bill.new.failed?.should be_false
+    end
+  end
+
+  describe "withdrawn query method" do
+    it "returns true when the subscription status is withdrawn" do
+      GoCardless::Bill.new(:status => 'withdrawn').withdrawn?.should be_true
+    end
+
+    it "returns false otherwise" do
+      GoCardless::Bill.new.withdrawn?.should be_false
+    end
+  end
+
+  describe "refunded query method" do
+    it "returns true when the subscription status is refunded" do
+      GoCardless::Bill.new(:status => 'refunded').refunded?.should be_true
+    end
+
+    it "returns false otherwise" do
+      GoCardless::Bill.new.refunded?.should be_false
+    end
+  end
 end

data/spec/client_spec.rb

@@ -146,6 +146,8 @@ describe GoCardless::Client do
   end
 
   describe "#access_token=" do
+    before { @client.stubs(:warn) }
+
     it "deserializes access token correctly" do
       @client.access_token = 'TOKEN123 a:1 b:2'
       token = @client.instance_variable_get(:@access_token)
@@ -158,6 +160,16 @@ describe GoCardless::Client do
       @client.send('merchant_id').should == 'xyz'
     end
 
+    it "issues a deprecation warning when the scope is present" do
+      @client.expects(:warn)
+      @client.access_token = 'TOKEN123 manage_merchant:xyz'
+    end
+
+    it "doesn't issue a deprecation warning when the scope is missing" do
+      @client.expects(:warn).never
+      @client.access_token = 'TOKEN123'
+    end
+
     it "ignores 'bearer' if it is present at the start of the string" do
       @client.access_token = 'Bearer TOKEN manage_merchant:123'
       token = @client.instance_variable_get(:@access_token)
@@ -168,7 +180,7 @@ describe GoCardless::Client do
 
   describe "#api_get" do
     it "uses the correct path prefix" do
-      @client.access_token = 'TOKEN123 a:1 b:2'
+      @client.access_token = 'TOKEN123'
       token = @client.instance_variable_get(:@access_token)
       r = mock
       r.stubs(:parsed)
@@ -183,7 +195,7 @@ describe GoCardless::Client do
 
   describe "#api_post" do
     it "encodes data to json" do
-      @client.access_token = 'TOKEN123 a:1 b:2'
+      @client.access_token = 'TOKEN123'
       token = @client.instance_variable_get(:@access_token)
       r = mock
       r.stubs(:parsed)
@@ -198,7 +210,8 @@ describe GoCardless::Client do
 
   describe "#merchant" do
     it "looks up the correct merchant" do
-      @client.access_token = 'TOKEN a manage_merchant:123 b'
+      @client.access_token = 'TOKEN'
+      @client.merchant_id = '123'
       response = mock
       response.expects(:parsed)
 
@@ -212,7 +225,8 @@ describe GoCardless::Client do
     end
 
     it "creates a Merchant object" do
-      @client.access_token = 'TOKEN manage_merchant:123'
+      @client.access_token = 'TOKEN'
+      @client.merchant_id = '123'
       response = mock
       response.expects(:parsed).returns({:name => 'test', :id => 123})
 
@@ -229,7 +243,8 @@ describe GoCardless::Client do
   %w{subscription pre_authorization user bill payment}.each do |resource|
     describe "##{resource}" do
       it "returns the correct #{GoCardless::Utils.camelize(resource)} object" do
-        @client.access_token = 'TOKEN manage_merchant:123'
+        @client.access_token = 'TOKEN'
+        @client.merchant_id = '123'
         stub_get(@client, {:id => 123})
         obj = @client.send(resource, 123)
         obj.should be_a GoCardless.const_get(GoCardless::Utils.camelize(resource))
@@ -373,7 +388,8 @@ describe GoCardless::Client do
   describe "#new_limit_url" do
     before(:each) do
       @merchant_id = '123'
-      @client.access_token = "TOKEN manage_merchant:#{@merchant_id}"
+      @client.access_token = "TOKEN"
+      @client.merchant_id  = @merchant_id
     end
 
     def get_params(url)
@@ -446,7 +462,7 @@ describe GoCardless::Client do
 
   describe "#merchant_id" do
     it "returns the merchant id when an access token is set" do
-      @client.access_token = 'TOKEN manage_merchant:123'
+      @client.merchant_id = '123'
       @client.send(:merchant_id).should == '123'
     end
 

data/spec/gocardless_spec.rb

@@ -4,7 +4,8 @@ describe GoCardless do
   before do
     unset_ivar GoCardless, :client
     unset_ivar GoCardless, :account_details
-    @details = {:app_id => 'X', :app_secret => 'X', :token => 'X manage_merchant:1'}
+    @details = { :app_id => 'X', :app_secret => 'X',
+                 :token => 'X', :merchant_id => '1' }
   end
 
   describe ".account_details=" do

data/spec/pre_authorization_spec.rb

@@ -5,7 +5,7 @@ describe GoCardless::PreAuthorization do
     @app_id = 'abc'
     @app_secret = 'xyz'
     GoCardless.account_details = {:app_id => @app_id, :app_secret => @app_secret,
-                                  :token  => 'xxx manage_merchant:1'}
+                                  :token  => 'xxx', :merchant_id => '1'}
     @client = GoCardless.client
   end
 
@@ -15,4 +15,43 @@ describe GoCardless::PreAuthorization do
     s.cancel!
   end
 
+  describe "inactive query method" do
+    it "returns true when the subscription status is inactive" do
+      GoCardless::PreAuthorization.new(:status => 'inactive').inactive?.should be_true
+    end
+
+    it "returns false otherwise" do
+      GoCardless::PreAuthorization.new.inactive?.should be_false
+    end
+  end
+
+  describe "active query method" do
+    it "returns true when the subscription status is active" do
+      GoCardless::PreAuthorization.new(:status => 'active').active?.should be_true
+    end
+
+    it "returns false otherwise" do
+      GoCardless::PreAuthorization.new.active?.should be_false
+    end
+  end
+
+  describe "cancelled query method" do
+    it "returns true when the subscription status is cancelled" do
+      GoCardless::PreAuthorization.new(:status => 'cancelled').cancelled?.should be_true
+    end
+
+    it "returns false otherwise" do
+      GoCardless::PreAuthorization.new.cancelled?.should be_false
+    end
+  end
+
+  describe "expired query method" do
+    it "returns true when the subscription status is expired" do
+      GoCardless::PreAuthorization.new(:status => 'expired').expired?.should be_true
+    end
+
+    it "returns false otherwise" do
+      GoCardless::PreAuthorization.new.expired?.should be_false
+    end
+  end
 end

data/spec/resource_spec.rb

@@ -156,7 +156,8 @@ describe GoCardless::Resource do
 
       resource = test_resource.new_with_client(@client)
       resource.instance_variable_set(:@user_id, 123)
-      @client.access_token = 'TOKEN manage_merchant:123'
+      @client.access_token = 'TOKEN'
+      @client.merchant_id = '123'
       stub_get(@client, {:id => 123})
       user = resource.user
       user.should be_a GoCardless::User

data/spec/subscription_spec.rb

@@ -5,7 +5,7 @@ describe GoCardless::Subscription do
     @app_id = 'abc'
     @app_secret = 'xyz'
     GoCardless.account_details = {:app_id => @app_id, :app_secret => @app_secret,
-                                  :token  => 'xxx manage_merchant:1'}
+                                  :token  => 'xxx', :merchant_id => '1'}
     @client = GoCardless.client
   end
 
@@ -15,4 +15,43 @@ describe GoCardless::Subscription do
     s.cancel!
   end
 
+  describe "inactive query method" do
+    it "returns true when the subscription status is inactive" do
+      GoCardless::Subscription.new(:status => 'inactive').inactive?.should be_true
+    end
+
+    it "returns false otherwise" do
+      GoCardless::Subscription.new.inactive?.should be_false
+    end
+  end
+
+  describe "active query method" do
+    it "returns true when the subscription status is active" do
+      GoCardless::Subscription.new(:status => 'active').active?.should be_true
+    end
+
+    it "returns false otherwise" do
+      GoCardless::Subscription.new.active?.should be_false
+    end
+  end
+
+  describe "cancelled query method" do
+    it "returns true when the subscription status is cancelled" do
+      GoCardless::Subscription.new(:status => 'cancelled').cancelled?.should be_true
+    end
+
+    it "returns false otherwise" do
+      GoCardless::Subscription.new.cancelled?.should be_false
+    end
+  end
+
+  describe "expired query method" do
+    it "returns true when the subscription status is expired" do
+      GoCardless::Subscription.new(:status => 'expired').expired?.should be_true
+    end
+
+    it "returns false otherwise" do
+      GoCardless::Subscription.new.expired?.should be_false
+    end
+  end
 end

data/spec/user_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe GoCardless::User do
+  let(:user) { GoCardless::User.new(:id => 123, :first_name => first, :last_name => last) }
+
+  describe "#name" do
+    subject { user.name }
+
+    context "with first and last name" do
+      let(:first) { "First" }
+      let(:last) { "Last" }
+      it { should == "First Last" }
+    end
+
+    context "with first name only" do
+      let(:first) { "First" }
+      let(:last) { nil }
+      it { should == "First" }
+    end
+
+    context "with last name only" do
+      let(:first) { nil }
+      let(:last) { "Last" }
+      it { should == "Last" }
+    end
+
+    context "with no first or last name" do
+      let(:first) { nil }
+      let(:last) { nil }
+      it { should == "" }
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: gocardless
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 1.6.3
+  version: 1.7.0
 platform: ruby
 authors:
 - Harry Marr
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-11 00:00:00.000000000 Z
+date: 2013-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
@@ -108,6 +108,22 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.1'
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    none: false
+  name: rake
+  type: :development
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    none: false
 description: A Ruby wrapper for the GoCardless API
 email:
 - developers@gocardless.com
@@ -144,6 +160,7 @@ files:
 - spec/resource_spec.rb
 - spec/spec_helper.rb
 - spec/subscription_spec.rb
+- spec/user_spec.rb
 - spec/utils_spec.rb
 homepage: https://github.com/gocardless/gocardless-ruby
 licenses: []
@@ -177,5 +194,6 @@ test_files:
 - spec/resource_spec.rb
 - spec/spec_helper.rb
 - spec/subscription_spec.rb
+- spec/user_spec.rb
 - spec/utils_spec.rb
 has_rdoc: