gocardless 0.1.3 → 0.2.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.2.0 - April 3, 2012
+
+- Add `cancel!` method to `Subscription`
+- Include the API version in the user agent header
+
+
 ## 0.1.3 - February 22, 2012
 
 - Fix parameter encoding in `Client#new_merchant_url` (related to Faraday issue

data/README.md

@@ -13,5 +13,5 @@ you want to support multiple merchant accounts, see the
 The full API reference is available at on
 [rubydoc.info](http://rubydoc.info/github/gocardless/gocardless-ruby/master/frames).
 
-[![Build Status](https://secure.travis-ci.org/gocardless/gocardless-ruby.png)](http://travis-ci.org/gocardless/gocardless-ruby)
+[![Build Status](https://secure.travis-ci.org/gocardless/gocardless-ruby.png?branch=master)](http://travis-ci.org/gocardless/gocardless-ruby)
 

data/gocardless.gemspec

@@ -1,15 +1,15 @@
 require File.expand_path('../lib/gocardless/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.add_runtime_dependency "oauth2", "~> 0.5.0.rc1"
-  gem.add_runtime_dependency "json", ">= 1.5.3"
+  gem.add_runtime_dependency 'oauth2', '~> 0.5.0.rc1'
+  gem.add_runtime_dependency 'multi_json', '~> 1.2'
 
   gem.add_development_dependency 'rspec', '~> 2.6'
   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 'yard', '~> 0.7.3'
+  gem.add_development_dependency 'activesupport', '~> 3.1'
 
-  gem.authors = ["Harry Marr", "Tom Blomfield"]
+  gem.authors = ['Harry Marr', 'Tom Blomfield']
   gem.description = %q{A Ruby wrapper for the GoCardless API}
   gem.email = ['developers@gocardless.com']
   gem.files = `git ls-files`.split("\n")

data/lib/gocardless.rb

@@ -1,4 +1,5 @@
 module GoCardless
+  require 'gocardless/version'
   require 'gocardless/errors'
   require 'gocardless/utils'
   require 'gocardless/resource'

data/lib/gocardless/client.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
-require 'json'
+require 'multi_json'
 require 'oauth2'
 require 'openssl'
 require 'uri'
@@ -270,7 +270,8 @@ module GoCardless
       opts[:headers] = {} if opts[:headers].nil?
       opts[:headers]['Accept'] = 'application/json'
       opts[:headers]['Content-Type'] = 'application/json' unless method == :get
-      opts[:body] = JSON.generate(opts[:data]) if !opts[:data].nil?
+      opts[:headers]['User-Agent'] = "gocardless-ruby-v#{GoCardless::VERSION}"
+      opts[:body] = MultiJson.encode(opts[:data]) if !opts[:data].nil?
 
       # Reset the URL in case the environment / base URL has been changed.
       @oauth_client.site = self.class.base_url

data/lib/gocardless/errors.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
-require 'json'
+require 'multi_json'
 
 module GoCardless
   class Error < StandardError
@@ -11,7 +11,7 @@ module GoCardless
     def initialize(response)
       @response = response
       @code = response.status
-      body = JSON.parse(response.body) rescue nil
+      body = MultiJson.decode(response.body) rescue nil
       if body.is_a? Hash
         @description = body["error"] || response.body.strip || "Unknown error"
       end

data/lib/gocardless/resource.rb

@@ -150,7 +150,7 @@ module GoCardless
     end
 
     def to_json
-      to_hash.to_json
+      MultiJson.encode(Utils.stringify_times(to_hash))
     end
 
     def inspect

data/lib/gocardless/subscription.rb

@@ -10,6 +10,12 @@ module GoCardless
 
     date_accessor :expires_at, :created_at
 
+
+    def cancel!
+      path = self.class.endpoint.gsub(':id', id.to_s) + '/cancel'
+      client.api_put(path)
+    end
+
   end
 end
 

data/lib/gocardless/utils.rb

@@ -39,14 +39,6 @@ module GoCardless
       URI.encode(str, /[^a-zA-Z0-9\-\.\_\~]/)
     end
 
-    # Format a Time object according to ISO 8601, and convert to UTC.
-    #
-    # @param [Time] time the time object to format
-    # @return [String] the ISO-formatted time
-    def iso_format_time(time)
-      time.is_a?(Time) ? time.getutc.strftime('%Y-%m-%dT%H:%M:%SZ') : time
-    end
-
     # Flatten a hash containing nested hashes and arrays to a non-nested array
     # of key-value pairs.
     #
@@ -101,6 +93,32 @@ module GoCardless
       digest = OpenSSL::Digest::Digest.new('sha256')
       OpenSSL::HMAC.hexdigest(digest, key, msg)
     end
+
+    # Format a Time object according to ISO 8601, and convert to UTC.
+    #
+    # @param [Time] time the time object to format
+    # @return [String] the ISO-formatted time
+    def iso_format_time(time)
+      return time unless time.is_a? Time or time.is_a? Date
+      time = time.getutc if time.is_a? Time
+      time = time.new_offset(0) if time.is_a? DateTime
+      time.strftime('%Y-%m-%dT%H:%M:%SZ')
+    end
+
+    # Recursively ISO format all time and date values.
+    #
+    # @param [Hash] obj the object containing date or time objects
+    # @return [Hash] the object with ISO-formatted time stings
+    def stringify_times(obj)
+      case obj
+      when Hash
+        Hash[obj.map { |k,v| [k, stringify_times(v)] }]
+      when Array
+        obj.map { |v| stringify_times(v) }
+      else
+        iso_format_time(obj)
+      end
+    end
   end
 end
 

data/lib/gocardless/version.rb

@@ -1,3 +1,3 @@
 module GoCardless
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/spec/resource_spec.rb

@@ -293,15 +293,16 @@ describe GoCardless::Resource do
       reference_accessor :person_id
     end
 
+    time_str = '2012-01-01T00:00:00Z'
     bill = test_resource.new({
       :amount => '10',
-      :when => DateTime.now,
+      :when => Time.parse(time_str),
       :person_id => 15
     })
 
-    result = JSON.parse(bill.to_json)
+    result = MultiJson.decode(bill.to_json)
     result['amount'].should == bill.amount
-    result['when'].should == bill.when.to_s
+    result['when'].should == time_str
     result['person_id'].should == 15
   end
 

data/spec/spec_helper.rb

@@ -1,5 +1,4 @@
 require 'mocha'
-require 'json'
 require 'active_support/hash_with_indifferent_access'
 require 'gocardless'
 

data/spec/subscription_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe GoCardless::Subscription do
+  before :each do
+    @app_id = 'abc'
+    @app_secret = 'xyz'
+    GoCardless.account_details = {:app_id => @app_id, :app_secret => @app_secret,
+                                  :token  => 'xxx manage_merchant:1'}
+    @client = GoCardless.client
+  end
+
+  it "should be cancellable" do
+    s = GoCardless::Subscription.new_with_client(@client, :id => '009988')
+    @client.expects(:api_put).with('/subscriptions/009988/cancel')
+    s.cancel!
+  end
+
+end

data/spec/utils_spec.rb

@@ -105,18 +105,6 @@ describe GoCardless::Utils do
       end
     end
 
-    describe ".iso_format_time" do
-      it "should work with a Time object" do
-        d = GoCardless::Utils.iso_format_time(Time.parse("1st January 2012"))
-        d.should == "2012-01-01T00:00:00Z"
-      end
-
-      it "should leave a string untouched" do
-        date = "1st January 2012"
-        GoCardless::Utils.iso_format_time(date).should == date
-      end
-    end
-
     describe ".flatten_params" do
       subject { GoCardless::Utils.method(:flatten_params) }
 
@@ -206,4 +194,45 @@ describe GoCardless::Utils do
     end
   end
 
+  describe "date and time helpers" do
+    describe ".iso_format_time" do
+      it "should work with a Time object" do
+        d = GoCardless::Utils.iso_format_time(Time.parse("1st January 2012"))
+        d.should == "2012-01-01T00:00:00Z"
+      end
+
+      it "should work with a DateTime object" do
+        d = GoCardless::Utils.iso_format_time(DateTime.parse("1st January 2012"))
+        d.should == "2012-01-01T00:00:00Z"
+      end
+
+      it "should work with a Date object" do
+        d = GoCardless::Utils.iso_format_time(Date.parse("1st January 2012"))
+        d.should == "2012-01-01T00:00:00Z"
+      end
+
+      it "should leave a string untouched" do
+        date = "1st January 2012"
+        GoCardless::Utils.iso_format_time(date).should == date
+      end
+    end
+
+    describe ".stringify_times" do
+      it "stringifies time objects" do
+        d = GoCardless::Utils.stringify_times(Time.parse("1st Jan 2012"))
+        d.should == "2012-01-01T00:00:00Z"
+      end
+
+      it "stringifies time values in hashes" do
+        d = GoCardless::Utils.stringify_times(:t => Time.parse("1st Jan 2012"))
+        d.should == { :t => "2012-01-01T00:00:00Z" }
+      end
+
+      it "stringifies time values in arrays" do
+        d = GoCardless::Utils.stringify_times([Time.parse("1st Jan 2012")])
+        d.should == ["2012-01-01T00:00:00Z"]
+      end
+    end
+  end
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gocardless
 version: !ruby/object:Gem::Version 
-  hash: 800522045387967993
+  hash: 2380615109590600174
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 3
-  version: 0.1.3
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Harry Marr
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-22 00:00:00 Z
+date: 2012-04-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: oauth2
@@ -37,19 +37,18 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: json
+  name: multi_json
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3211771947681907367
+        hash: 3191556116430806706
         segments: 
         - 1
-        - 5
-        - 3
-        version: 1.5.3
+        - 2
+        version: "1.2"
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -152,6 +151,7 @@ files:
 - spec/merchant_spec.rb
 - spec/resource_spec.rb
 - spec/spec_helper.rb
+- spec/subscription_spec.rb
 - spec/utils_spec.rb
 homepage: https://github.com/gocardless/gocardless-ruby
 licenses: []
@@ -193,5 +193,6 @@ test_files:
 - spec/merchant_spec.rb
 - spec/resource_spec.rb
 - spec/spec_helper.rb
+- spec/subscription_spec.rb
 - spec/utils_spec.rb
 has_rdoc: