gocardless-pro 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4743079901f623f99893a58f597217374d0b149b
-  data.tar.gz: 921dcc074feefd8c1a34169a7dea5510d81144b6
+  metadata.gz: cc97cc92944bdc8032081deee54e766bb9aa95bc
+  data.tar.gz: f5c6b37dd5d70425c9c6b0e127013c013fe9fd7f
 SHA512:
-  metadata.gz: eb1c2e0828a1910b4b94009a69d8d051cbaa4bbb8bd99394811afa03587e1e0f6ea9ae6008780c458a9eadd5cc97fc9d2b1720e3ca6025b2b55b64140af85506
-  data.tar.gz: 538fd99d6696cd8b21b9fe66de2121071b847c92ef60346923bd620cede1afc3fa9685d4cebcce0c9ab7cb50190978755cb71dadc0f4a13438da85967b39f848
+  metadata.gz: 867c8018cab90326aaa0e258b631240753e1b4820b8a4a4dd3339519d093dd6ce1360cdf87d5330f6e081f319c66172ef5fa3755990a6988bfb08af679b1887f
+  data.tar.gz: 17ca6a9c7464c075216cec90f373bcb4b38a4a94fa9e76e59eee44b9c44e91234426d0a4bf976af14e1bf68961229908d726fbe2d486f683a98eeec17617f8b6

data/README.md

@@ -26,14 +26,12 @@ require 'gocardless-pro'
 
 ### Initialising the client
 
-The client is initialised with the API Key ID and the API Key `key` property.
-
+The client is initialised with an Access Token.
 You can also pass in `environment` as `:sandbox` to make requests to the sandbox environment rather than the live one.
 
 ```rb
 @client = GoCardless::Client.new(
-  api_key: ENV["GOCARDLESS_API_ID"],
-  api_secret: ENV["GOCARDLESS_API_KEY"]
+  token: ENV["GOCARDLESS_TOKEN"]
 )
 ```
 

data/lib/gocardless-pro.rb

@@ -34,9 +34,6 @@ require_relative 'gocardless-pro/paginator'
 require_relative 'gocardless-pro/request'
 require_relative 'gocardless-pro/response'
 
-require_relative 'gocardless-pro/resources/api_key'
-require_relative 'gocardless-pro/services/api_key_service'
-
 require_relative 'gocardless-pro/resources/creditor'
 require_relative 'gocardless-pro/services/creditor_service'
 
@@ -64,178 +61,13 @@ require_relative 'gocardless-pro/services/payment_service'
 require_relative 'gocardless-pro/resources/payout'
 require_relative 'gocardless-pro/services/payout_service'
 
-require_relative 'gocardless-pro/resources/publishable_api_key'
-require_relative 'gocardless-pro/services/publishable_api_key_service'
-
 require_relative 'gocardless-pro/resources/redirect_flow'
 require_relative 'gocardless-pro/services/redirect_flow_service'
 
 require_relative 'gocardless-pro/resources/refund'
 require_relative 'gocardless-pro/services/refund_service'
 
-require_relative 'gocardless-pro/resources/role'
-require_relative 'gocardless-pro/services/role_service'
-
 require_relative 'gocardless-pro/resources/subscription'
 require_relative 'gocardless-pro/services/subscription_service'
 
-require_relative 'gocardless-pro/resources/user'
-require_relative 'gocardless-pro/services/user_service'
-
-module GoCardless
-  # A class for working with and talking to the GoCardless API
-  class Client
-    extend Forwardable
-
-    # Access to the service for api_key to make API calls
-    def api_keys
-      @api_keys ||= Services::ApiKeyService.new(@api_service)
-    end
-
-    # Access to the service for creditor to make API calls
-    def creditors
-      @creditors ||= Services::CreditorService.new(@api_service)
-    end
-
-    # Access to the service for creditor_bank_account to make API calls
-    def creditor_bank_accounts
-      @creditor_bank_accounts ||= Services::CreditorBankAccountService.new(@api_service)
-    end
-
-    # Access to the service for customer to make API calls
-    def customers
-      @customers ||= Services::CustomerService.new(@api_service)
-    end
-
-    # Access to the service for customer_bank_account to make API calls
-    def customer_bank_accounts
-      @customer_bank_accounts ||= Services::CustomerBankAccountService.new(@api_service)
-    end
-
-    # Access to the service for event to make API calls
-    def events
-      @events ||= Services::EventService.new(@api_service)
-    end
-
-    # Access to the service for helper to make API calls
-    def helpers
-      @helpers ||= Services::HelperService.new(@api_service)
-    end
-
-    # Access to the service for mandate to make API calls
-    def mandates
-      @mandates ||= Services::MandateService.new(@api_service)
-    end
-
-    # Access to the service for payment to make API calls
-    def payments
-      @payments ||= Services::PaymentService.new(@api_service)
-    end
-
-    # Access to the service for payout to make API calls
-    def payouts
-      @payouts ||= Services::PayoutService.new(@api_service)
-    end
-
-    # Access to the service for publishable_api_key to make API calls
-    def publishable_api_keys
-      @publishable_api_keys ||= Services::PublishableApiKeyService.new(@api_service)
-    end
-
-    # Access to the service for redirect_flow to make API calls
-    def redirect_flows
-      @redirect_flows ||= Services::RedirectFlowService.new(@api_service)
-    end
-
-    # Access to the service for refund to make API calls
-    def refunds
-      @refunds ||= Services::RefundService.new(@api_service)
-    end
-
-    # Access to the service for role to make API calls
-    def roles
-      @roles ||= Services::RoleService.new(@api_service)
-    end
-
-    # Access to the service for subscription to make API calls
-    def subscriptions
-      @subscriptions ||= Services::SubscriptionService.new(@api_service)
-    end
-
-    # Access to the service for user to make API calls
-    def users
-      @users ||= Services::UserService.new(@api_service)
-    end
-
-    # Get a Client configured to use HTTP Basic authentication with the GC Api
-    #
-    # @param options [Hash<Symbol,String>] configuration for creating the client
-    # @option options [Symbol] :environment the environment to connect to - one of `:live` or `:sandbox`.
-    # @option options [Symbol] :api_key the ID of the API Key
-    # @option options [Symbol] :api_secret the key of the API Key
-    # @option options [Symbol] :url the full URL used to make requests to. If you specify this, it will be used over the `environment` option.
-    # @return [Client] A client configured to use the API with HTTP Basic
-    #   authentication.
-    #
-    def initialize(options)
-      api_key = options.delete(:api_key) || fail('No API key ID given to GoCardless Client')
-      api_secret = options.delete(:api_secret) || fail('No API secret given to GoCardless Client')
-      environment = options.delete(:environment) || :live
-      url = options.delete(:url) || url_for_environment(environment)
-      options = custom_options(options)
-      @api_service = ApiService.new(url, api_key, api_secret, options)
-    end
-
-    private
-
-    def url_for_environment(environment)
-      if environment === :live
-        'https://api.gocardless.com'
-      elsif environment === :sandbox
-        'https://api-sandbox.gocardless.com'
-      else
-        fail "Unknown environment key: #{environment}"
-      end
-    end
-
-    # Get customized options.
-    def custom_options(options)
-      return default_options if options.nil?
-
-      return default_options.merge(options) unless options[:default_headers]
-
-      opts = default_options.merge(options)
-      opts[:default_headers] = default_options[:default_headers].merge(options[:default_headers])
-
-      opts
-    end
-
-    # Get the default options.
-    def default_options
-      {
-        default_headers: {
-          'GoCardless-Version' => '2014-11-03',
-          'User-Agent' => "#{user_agent}",
-          'Content-Type' => 'application/json'
-        }
-      }
-    end
-
-    def user_agent
-      @user_agent ||=
-        begin
-          gem_name = 'gocardless-pro'
-          gem_info = "#{gem_name}"
-          gem_info += "/v#{ GoCardless::VERSION}" if defined?(GoCardless::VERSION)
-          ruby_engine = defined?(RUBY_ENGINE) ? RUBY_ENGINE : 'ruby'
-          ruby_version = RUBY_VERSION
-          ruby_version += " p#{RUBY_PATCHLEVEL}" if defined?(RUBY_PATCHLEVEL)
-          comment = ["#{ruby_engine} #{ruby_version}"]
-          comment << "gocardless-pro v#{ GoCardless::VERSION}"
-          comment << "faraday v#{Faraday::VERSION}"
-          comment << RUBY_PLATFORM if defined?(RUBY_PLATFORM)
-          "#{gem_info} (#{comment.join('; ')})"
-        end
-    end
-  end
-end
+require_relative 'gocardless-pro/client.rb'

data/lib/gocardless-pro/api_service.rb

@@ -16,7 +16,7 @@ module GoCardless
     # @param key [String] the API Key ID to use
     # @param secret [String] the API key secret to use
     # @param options [Hash] additional options to use when creating the service
-    def initialize(url, key, secret, options = {})
+    def initialize(url, token, options = {})
       @url = url
       root_url, @path_prefix = unpack_url(url)
       http_adapter = options[:http_adapter] || [:net_http]
@@ -25,7 +25,7 @@ module GoCardless
       end
 
       @headers = options[:default_headers] || {}
-      @headers['Authorization'] = 'Basic ' + Base64.strict_encode64("#{key}:#{secret}")
+      @headers['Authorization'] = "Bearer #{token}"
     end
 
     # Make a request to the API

data/lib/gocardless-pro/client.rb

@@ -0,0 +1,135 @@
+module GoCardless
+  # A class for working with and talking to the GoCardless API
+  class Client
+    extend Forwardable
+
+    # Access to the service for creditor to make API calls
+    def creditors
+      @creditors ||= Services::CreditorService.new(@api_service)
+    end
+
+    # Access to the service for creditor_bank_account to make API calls
+    def creditor_bank_accounts
+      @creditor_bank_accounts ||= Services::CreditorBankAccountService.new(@api_service)
+    end
+
+    # Access to the service for customer to make API calls
+    def customers
+      @customers ||= Services::CustomerService.new(@api_service)
+    end
+
+    # Access to the service for customer_bank_account to make API calls
+    def customer_bank_accounts
+      @customer_bank_accounts ||= Services::CustomerBankAccountService.new(@api_service)
+    end
+
+    # Access to the service for event to make API calls
+    def events
+      @events ||= Services::EventService.new(@api_service)
+    end
+
+    # Access to the service for helper to make API calls
+    def helpers
+      @helpers ||= Services::HelperService.new(@api_service)
+    end
+
+    # Access to the service for mandate to make API calls
+    def mandates
+      @mandates ||= Services::MandateService.new(@api_service)
+    end
+
+    # Access to the service for payment to make API calls
+    def payments
+      @payments ||= Services::PaymentService.new(@api_service)
+    end
+
+    # Access to the service for payout to make API calls
+    def payouts
+      @payouts ||= Services::PayoutService.new(@api_service)
+    end
+
+    # Access to the service for redirect_flow to make API calls
+    def redirect_flows
+      @redirect_flows ||= Services::RedirectFlowService.new(@api_service)
+    end
+
+    # Access to the service for refund to make API calls
+    def refunds
+      @refunds ||= Services::RefundService.new(@api_service)
+    end
+
+    # Access to the service for subscription to make API calls
+    def subscriptions
+      @subscriptions ||= Services::SubscriptionService.new(@api_service)
+    end
+
+    # Get a Client configured to use HTTP Basic authentication with the GC Api
+    #
+    # @param options [Hash<Symbol,String>] configuration for creating the client
+    # @option options [Symbol] :environment the environment to connect to - one of `:live` or `:sandbox`.
+    # @option options [Symbol] :token the API token
+    # @option options [Symbol] :url the full URL used to make requests to. If you specify this, it will be used over the `environment` option.
+    # @return [Client] A client configured to use the API with HTTP Basic
+    #   authentication.
+    #
+    def initialize(options)
+      access_token = options.delete(:token) || fail('No Access Token given to GoCardless Client')
+      environment = options.delete(:environment) || :live
+      url = options.delete(:url) || url_for_environment(environment)
+      options = custom_options(options)
+      @api_service = ApiService.new(url, access_token, options)
+    end
+
+    private
+
+    def url_for_environment(environment)
+      if environment === :live
+        'https://api.gocardless.com'
+      elsif environment === :sandbox
+        'https://api-sandbox.gocardless.com'
+      else
+        fail "Unknown environment key: #{environment}"
+      end
+    end
+
+    # Get customized options.
+    def custom_options(options)
+      return default_options if options.nil?
+
+      return default_options.merge(options) unless options[:default_headers]
+
+      opts = default_options.merge(options)
+      opts[:default_headers] = default_options[:default_headers].merge(options[:default_headers])
+
+      opts
+    end
+
+    # Get the default options.
+    def default_options
+      {
+        default_headers: {
+          'GoCardless-Version' => '2015-04-07',
+          'User-Agent' => "#{user_agent}",
+          'Content-Type' => 'application/json'
+        }
+      }
+    end
+
+    def user_agent
+      @user_agent ||=
+        begin
+          gem_name = 'gocardless-pro'
+          gem_info = "#{gem_name}"
+          gem_info += "/v#{ GoCardless::VERSION}" if defined?(GoCardless::VERSION)
+          ruby_engine = defined?(RUBY_ENGINE) ? RUBY_ENGINE : 'ruby'
+          ruby_version = RUBY_VERSION
+          ruby_version += " p#{RUBY_PATCHLEVEL}" if defined?(RUBY_PATCHLEVEL)
+          comment = ["#{ruby_engine} #{ruby_version}"]
+          comment << "gocardless-pro v#{ GoCardless::VERSION}"
+          comment << "faraday v#{Faraday::VERSION}"
+          comment << RUBY_PLATFORM if defined?(RUBY_PLATFORM)
+          "#{gem_info} (#{comment.join('; ')})"
+        end
+    end
+  end
+end

data/lib/gocardless-pro/version.rb

@@ -4,5 +4,5 @@ end
 
 module GoCardless
   # Current version of the GC gem
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/spec/api_service_spec.rb

@@ -1,10 +1,11 @@
 require 'spec_helper'
 
 describe GoCardless::ApiService do
-  subject(:service) { described_class.new("https://api.example.com", "ak123", "abc123") }
+  subject(:service) { described_class.new("https://api.example.com", "secret_token") }
 
   it "uses basic auth" do
-    stub = stub_request(:get, 'https://ak123:abc123@api.example.com/customers')
+    stub = stub_request(:get, 'https://api.example.com/customers').
+      with(headers: { "Authorization" => "Bearer secret_token" })
     service.make_request(:get, "/customers")
     expect(stub).to have_been_requested
   end

data/spec/client_spec.rb

@@ -6,24 +6,14 @@ describe GoCardless::Client do
   let(:options) do
     {
       environment: environment,
-      api_key: api_key,
-      api_secret: api_secret
+      token: token
     }
   end
 
-  context "when initialised without an API key" do
+  context "when initialised without an Access Token" do
     let(:environment) { :live }
-    let(:api_secret) { "MYSECRETTOKEN" }
-    let(:api_key) { nil }
+    let(:token) { nil }
 
-    it { is_expected.to raise_error("No API key ID given to GoCardless Client") }
-  end
-
-  context "when initialised without an API secret" do
-    let(:api_secret) { nil }
-    let(:environment) { :live }
-    let(:api_key) { "AK123" }
-
-    it { is_expected.to raise_error("No API secret given to GoCardless Client") }
+    it { is_expected.to raise_error("No Access Token given to GoCardless Client") }
   end
 end

data/spec/services/creditor_bank_account_service_spec.rb

@@ -3,8 +3,7 @@ require 'spec_helper'
 describe GoCardless::Services::CreditorBankAccountService do
   let(:client) do
     GoCardless::Client.new(
-      api_key: "AK123",
-      api_secret: "ABC"
+      token: "SECRET_TOKEN"
     )
   end
 

data/spec/services/creditor_service_spec.rb

@@ -3,8 +3,7 @@ require 'spec_helper'
 describe GoCardless::Services::CreditorService do
   let(:client) do
     GoCardless::Client.new(
-      api_key: "AK123",
-      api_secret: "ABC"
+      token: "SECRET_TOKEN"
     )
   end
 

data/spec/services/customer_bank_account_service_spec.rb

@@ -3,8 +3,7 @@ require 'spec_helper'
 describe GoCardless::Services::CustomerBankAccountService do
   let(:client) do
     GoCardless::Client.new(
-      api_key: "AK123",
-      api_secret: "ABC"
+      token: "SECRET_TOKEN"
     )
   end