gocardless_pro 0.3.0

data/lib/gocardless_pro/services/redirect_flows_service.rb

@@ -0,0 +1,98 @@
+require_relative './base_service'
+
+# encoding: utf-8
+#
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+
+module GoCardlessPro
+  module Services
+    # Service for making requests to the RedirectFlow endpoints
+    class RedirectFlowsService < BaseService
+      # Creates a redirect flow object which can then be used to redirect your
+      # customer to the GoCardless Pro hosted payment pages.
+      # Example URL: /redirect_flows
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create(options = {})
+        path = '/redirect_flows'
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+        response = make_request(:post, path, options)
+
+        return if response.body.nil?
+        Resources::RedirectFlow.new(unenvelope_body(response.body))
+      end
+
+      # Returns all details about a single redirect flow
+      # Example URL: /redirect_flows/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "RE".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def get(identity, options = {})
+        path = sub_url('/redirect_flows/:identity',           'identity' => identity)
+
+        response = make_request(:get, path, options)
+
+        return if response.body.nil?
+        Resources::RedirectFlow.new(unenvelope_body(response.body))
+      end
+
+      # This creates a
+      # [customer](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-customers),
+      # [customer bank
+      # account](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-customer-bank-accounts),
+      # and
+      # [mandate](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-mandates)
+      # using the details supplied by your customer and returns the ID of the created
+      # mandate.
+      #
+      # This will return a `redirect_flow_incomplete` error if your
+      # customer has not yet been redirected back to your site, and a
+      # `redirect_flow_already_completed` error if your integration has already
+      # completed this flow. It will return a `bad_request` error if the
+      # `session_token` differs to the one supplied when the redirect flow was
+      # created.
+      # Example URL: /redirect_flows/:identity/actions/complete
+      #
+      # @param identity       # Unique identifier, beginning with "RE".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def complete(identity, options = {})
+        path = sub_url('/redirect_flows/:identity/actions/complete',           'identity' => identity)
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params]['data'] = params
+        response = make_request(:post, path, options)
+
+        return if response.body.nil?
+        Resources::RedirectFlow.new(unenvelope_body(response.body))
+      end
+
+      # Unenvelope the response of the body using the service's `envelope_key`
+      #
+      # @param body [Hash]
+      def unenvelope_body(body)
+        body[envelope_key] || body['data']
+      end
+
+      private
+
+      # return the key which API responses will envelope data under
+      def envelope_key
+        'redirect_flows'
+      end
+
+      # take a URL with placeholder params and substitute them out for the acutal value
+      # @param url [String] the URL with placeholders in
+      # @param param_map [Hash] a hash of placeholders and their actual values
+      def sub_url(url, param_map)
+        param_map.reduce(url) do |new_url, (param, value)|
+          new_url.gsub(":#{param}", value)
+        end
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/refunds_service.rb

@@ -0,0 +1,132 @@
+require_relative './base_service'
+
+# encoding: utf-8
+#
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+
+module GoCardlessPro
+  module Services
+    # Service for making requests to the Refund endpoints
+    class RefundsService < BaseService
+      # Creates a new refund object.
+      #
+      # This fails with:<a
+      # name="refund_payment_invalid_state"></a><a
+      # name="total_amount_confirmation_invalid"></a><a
+      # name="number_of_refunds_exceeded"></a>
+      #
+      # - `refund_payment_invalid_state`
+      # error if the linked
+      # [payment](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-payments)
+      # isn't either `confirmed` or `paid_out`.
+      #
+      # -
+      # `total_amount_confirmation_invalid` if the confirmation amount doesn't match
+      # the total amount refunded for the payment. This safeguard is there to prevent
+      # two processes from creating refunds without awareness of each other.
+      #
+      # -
+      # `number_of_refunds_exceeded` if five or more refunds have already been created
+      # against the payment.
+      #
+      # Example URL: /refunds
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create(options = {})
+        path = '/refunds'
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+        response = make_request(:post, path, options)
+
+        return if response.body.nil?
+        Resources::Refund.new(unenvelope_body(response.body))
+      end
+
+      # Returns a
+      # [cursor-paginated](https://developer.gocardless.com/pro/2015-04-29/#overview-cursor-pagination)
+      # list of your refunds.
+      # Example URL: /refunds
+      # @param options [Hash] parameters as a hash, under a params key.
+      def list(options = {})
+        path = '/refunds'
+
+        response = make_request(:get, path, options)
+        ListResponse.new(
+          raw_response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::Refund
+        )
+      end
+
+      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      #
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Otherwise they will be the body of the request.
+      def all(options = {})
+        Paginator.new(
+          service: self,
+          path: '/refunds',
+          options: options,
+          resource_class: Resources::Refund
+        ).enumerator
+      end
+
+      # Retrieves all details for a single refund
+      # Example URL: /refunds/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "RF"
+      # @param options [Hash] parameters as a hash, under a params key.
+      def get(identity, options = {})
+        path = sub_url('/refunds/:identity',           'identity' => identity)
+
+        response = make_request(:get, path, options)
+
+        return if response.body.nil?
+        Resources::Refund.new(unenvelope_body(response.body))
+      end
+
+      # Updates a refund object.
+      # Example URL: /refunds/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "RF"
+      # @param options [Hash] parameters as a hash, under a params key.
+      def update(identity, options = {})
+        path = sub_url('/refunds/:identity',           'identity' => identity)
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+        response = make_request(:put, path, options)
+
+        return if response.body.nil?
+        Resources::Refund.new(unenvelope_body(response.body))
+      end
+
+      # Unenvelope the response of the body using the service's `envelope_key`
+      #
+      # @param body [Hash]
+      def unenvelope_body(body)
+        body[envelope_key] || body['data']
+      end
+
+      private
+
+      # return the key which API responses will envelope data under
+      def envelope_key
+        'refunds'
+      end
+
+      # take a URL with placeholder params and substitute them out for the acutal value
+      # @param url [String] the URL with placeholders in
+      # @param param_map [Hash] a hash of placeholders and their actual values
+      def sub_url(url, param_map)
+        param_map.reduce(url) do |new_url, (param, value)|
+          new_url.gsub(":#{param}", value)
+        end
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/subscriptions_service.rb

@@ -0,0 +1,134 @@
+require_relative './base_service'
+
+# encoding: utf-8
+#
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+
+module GoCardlessPro
+  module Services
+    # Service for making requests to the Subscription endpoints
+    class SubscriptionsService < BaseService
+      # Creates a new subscription object
+      # Example URL: /subscriptions
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create(options = {})
+        path = '/subscriptions'
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+        response = make_request(:post, path, options)
+
+        return if response.body.nil?
+        Resources::Subscription.new(unenvelope_body(response.body))
+      end
+
+      # Returns a
+      # [cursor-paginated](https://developer.gocardless.com/pro/2015-04-29/#overview-cursor-pagination)
+      # list of your subscriptions.
+      # Example URL: /subscriptions
+      # @param options [Hash] parameters as a hash, under a params key.
+      def list(options = {})
+        path = '/subscriptions'
+
+        response = make_request(:get, path, options)
+        ListResponse.new(
+          raw_response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::Subscription
+        )
+      end
+
+      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      #
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Otherwise they will be the body of the request.
+      def all(options = {})
+        Paginator.new(
+          service: self,
+          path: '/subscriptions',
+          options: options,
+          resource_class: Resources::Subscription
+        ).enumerator
+      end
+
+      # Retrieves the details of a single subscription.
+      # Example URL: /subscriptions/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "SB"
+      # @param options [Hash] parameters as a hash, under a params key.
+      def get(identity, options = {})
+        path = sub_url('/subscriptions/:identity',           'identity' => identity)
+
+        response = make_request(:get, path, options)
+
+        return if response.body.nil?
+        Resources::Subscription.new(unenvelope_body(response.body))
+      end
+
+      # Updates a subscription object.
+      # Example URL: /subscriptions/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "SB"
+      # @param options [Hash] parameters as a hash, under a params key.
+      def update(identity, options = {})
+        path = sub_url('/subscriptions/:identity',           'identity' => identity)
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+        response = make_request(:put, path, options)
+
+        return if response.body.nil?
+        Resources::Subscription.new(unenvelope_body(response.body))
+      end
+
+      # Immediately cancels a subscription; no more payments will be created under it.
+      # Any metadata supplied to this endpoint will be stored on the payment
+      # cancellation event it causes.
+      #
+      # This will fail with a cancellation_failed
+      # error if the subscription is already cancelled or finished.
+      # Example URL: /subscriptions/:identity/actions/cancel
+      #
+      # @param identity       # Unique identifier, beginning with "SB"
+      # @param options [Hash] parameters as a hash, under a params key.
+      def cancel(identity, options = {})
+        path = sub_url('/subscriptions/:identity/actions/cancel',           'identity' => identity)
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params]['data'] = params
+        response = make_request(:post, path, options)
+
+        return if response.body.nil?
+        Resources::Subscription.new(unenvelope_body(response.body))
+      end
+
+      # Unenvelope the response of the body using the service's `envelope_key`
+      #
+      # @param body [Hash]
+      def unenvelope_body(body)
+        body[envelope_key] || body['data']
+      end
+
+      private
+
+      # return the key which API responses will envelope data under
+      def envelope_key
+        'subscriptions'
+      end
+
+      # take a URL with placeholder params and substitute them out for the acutal value
+      # @param url [String] the URL with placeholders in
+      # @param param_map [Hash] a hash of placeholders and their actual values
+      def sub_url(url, param_map)
+        param_map.reduce(url) do |new_url, (param, value)|
+          new_url.gsub(":#{param}", value)
+        end
+      end
+    end
+  end
+end

data/lib/gocardless_pro/version.rb

@@ -0,0 +1,8 @@
+
+module GoCardlessPro
+end
+
+module GoCardlessPro
+  # Current version of the GC gem
+  VERSION = '0.3.0'
+end

data/spec/api_service_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe GoCardlessPro::ApiService do
+  subject(:service) { described_class.new("https://api.example.com", "secret_token") }
+
+  it "uses basic auth" do
+    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
+
+  describe "making a get request without any parameters" do
+    it "is expected to call the correct stub" do
+      stub = stub_request(:get, /.*api.example.com\/customers/)
+      service.make_request(:get, "/customers")
+      expect(stub).to have_been_requested
+    end
+  end
+
+  describe "making a get request with query parameters" do
+    it "correctly passes the query parameters" do
+      stub = stub_request(:get, /.*api.example.com\/customers\?a=1&b=2/)
+      service.make_request(:get, "/customers", params: { a: 1, b: 2 })
+      expect(stub).to have_been_requested
+    end
+  end
+
+  describe "making a post request with some data" do
+    it "passes the data in as the post body" do
+      stub = stub_request(:post, /.*api.example.com\/customers/).
+        with(body: { given_name: "Jack", family_name: "Franklin" })
+      service.make_request(:post, "/customers", params: {
+        given_name: "Jack",
+        family_name: "Franklin"
+      })
+      expect(stub).to have_been_requested
+    end
+  end
+
+  describe "making a post request with data and custom header" do
+    it "passes the data in as the post body" do
+      stub = stub_request(:post, /.*api.example.com\/customers/).
+        with(
+          body: { given_name: "Jack", family_name: "Franklin" },
+          headers: { 'Foo' => 'Bar' }
+        )
+
+      service.make_request(:post, "/customers", {
+        params: {
+          given_name: "Jack",
+          family_name: "Franklin"
+        },
+        headers: {
+          'Foo' => 'Bar'
+        }
+      })
+      expect(stub).to have_been_requested
+    end
+  end
+
+  describe "making a put request with some data" do
+    it "passes the data in as the request body" do
+      stub = stub_request(:put, /.*api.example.com\/customers\/CU123/).
+        with(body: { given_name: "Jack", family_name: "Franklin" })
+      service.make_request(:put, "/customers/CU123", params: {
+        given_name: "Jack",
+        family_name: "Franklin"
+      })
+      expect(stub).to have_been_requested
+    end
+  end
+end