Add support for the new confirmation_url attribute in the Redirect Flow API (v2.3.0) (#31)

* Add support for the new `confirmation_url` attribute in the Redirect Flow API

* Bump the library version to v2.3.0

Author: Tim Rogers

lib/gocardless_pro/client.rb

@@ -118,7 +118,7 @@ def default_options
           'User-Agent' => user_agent.to_s,
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '2.2.0',
+          'GoCardless-Client-Version' => '2.3.0',
         },
       }
     end

lib/gocardless_pro/resources/redirect_flow.rb

@@ -39,14 +39,18 @@ module Resources
     # You may wish to create a [subscription](#core-endpoints-subscriptions) or
     # [payment](#core-endpoints-payments) at this point.
     #
-    # It is
-    # recommended that you link the redirect flow to your user object as soon as
-    # it is created, and attach the created resources to that user in the
-    # complete step.
+    # Once you
+    # have [completed](#redirect-flows-complete-a-redirect-flow) the redirect
+    # flow via the API, you should display a confirmation page to your customer,
+    # confirming that their Direct Debit has been set up. You can build your own
+    # page, or redirect to the one we provide in the `confirmation_url`
+    # attribute of the redirect flow.
     #
-    # Redirect flows expire 30 minutes after they
-    # are first created. You cannot complete an expired redirect flow.
+    # Redirect flows expire 30
+    # minutes after they are first created. You cannot complete an expired
+    # redirect flow.
     class RedirectFlow
+      attr_reader :confirmation_url
       attr_reader :created_at
       attr_reader :description
       attr_reader :id
@@ -60,6 +64,7 @@ class RedirectFlow
       def initialize(object, response = nil)
         @object = object
 
+        @confirmation_url = object['confirmation_url']
         @created_at = object['created_at']
         @description = object['description']
         @id = object['id']

lib/gocardless_pro/version.rb

@@ -4,5 +4,5 @@ module GoCardlessPro
 
 module GoCardlessPro
   # Current version of the GC gem
-  VERSION = '2.2.0'.freeze
+  VERSION = '2.3.0'.freeze
 end

spec/resources/redirect_flow_spec.rb

@@ -15,6 +15,7 @@
       let(:new_resource) do
         {
 
+          'confirmation_url' => 'confirmation_url-input',
           'created_at' => 'created_at-input',
           'description' => 'description-input',
           'id' => 'id-input',
@@ -32,6 +33,7 @@
             body: {
               'redirect_flows' => {
 
+                'confirmation_url' => 'confirmation_url-input',
                 'created_at' => 'created_at-input',
                 'description' => 'description-input',
                 'id' => 'id-input',
@@ -49,6 +51,7 @@
 
                 {
 
+                  'confirmation_url' => 'confirmation_url-input',
                   'created_at' => 'created_at-input',
                   'description' => 'description-input',
                   'id' => 'id-input',
@@ -99,6 +102,7 @@
       let(:new_resource) do
         {
 
+          'confirmation_url' => 'confirmation_url-input',
           'created_at' => 'created_at-input',
           'description' => 'description-input',
           'id' => 'id-input',
@@ -139,6 +143,7 @@
             body: {
               'redirect_flows' => {
 
+                'confirmation_url' => 'confirmation_url-input',
                 'created_at' => 'created_at-input',
                 'description' => 'description-input',
                 'id' => 'id-input',
@@ -175,6 +180,7 @@
             body: {
               'redirect_flows' => {
 
+                'confirmation_url' => 'confirmation_url-input',
                 'created_at' => 'created_at-input',
                 'description' => 'description-input',
                 'id' => 'id-input',
@@ -208,6 +214,7 @@
           body: {
             'redirect_flows' => {
 
+              'confirmation_url' => 'confirmation_url-input',
               'created_at' => 'created_at-input',
               'description' => 'description-input',
               'id' => 'id-input',
@@ -262,6 +269,7 @@
         body: {
           'redirect_flows' => {
 
+            'confirmation_url' => 'confirmation_url-input',
             'created_at' => 'created_at-input',
             'description' => 'description-input',
             'id' => 'id-input',
@@ -300,6 +308,7 @@
             body: {
               'redirect_flows' => {
 
+                'confirmation_url' => 'confirmation_url-input',
                 'created_at' => 'created_at-input',
                 'description' => 'description-input',
                 'id' => 'id-input',

spec/services/redirect_flows_service_spec.rb

@@ -15,6 +15,7 @@
       let(:new_resource) do
         {
 
+          'confirmation_url' => 'confirmation_url-input',
           'created_at' => 'created_at-input',
           'description' => 'description-input',
           'id' => 'id-input',
@@ -32,6 +33,7 @@
             body: {
               'redirect_flows' => {
 
+                'confirmation_url' => 'confirmation_url-input',
                 'created_at' => 'created_at-input',
                 'description' => 'description-input',
                 'id' => 'id-input',
@@ -49,6 +51,7 @@
 
                 {
 
+                  'confirmation_url' => 'confirmation_url-input',
                   'created_at' => 'created_at-input',
                   'description' => 'description-input',
                   'id' => 'id-input',
@@ -122,6 +125,7 @@
       let(:new_resource) do
         {
 
+          'confirmation_url' => 'confirmation_url-input',
           'created_at' => 'created_at-input',
           'description' => 'description-input',
           'id' => 'id-input',
@@ -162,6 +166,7 @@
             body: {
               'redirect_flows' => {
 
+                'confirmation_url' => 'confirmation_url-input',
                 'created_at' => 'created_at-input',
                 'description' => 'description-input',
                 'id' => 'id-input',
@@ -198,6 +203,7 @@
             body: {
               'redirect_flows' => {
 
+                'confirmation_url' => 'confirmation_url-input',
                 'created_at' => 'created_at-input',
                 'description' => 'description-input',
                 'id' => 'id-input',
@@ -231,6 +237,7 @@
           body: {
             'redirect_flows' => {
 
+              'confirmation_url' => 'confirmation_url-input',
               'created_at' => 'created_at-input',
               'description' => 'description-input',
               'id' => 'id-input',
@@ -312,6 +319,7 @@
         body: {
           'redirect_flows' => {
 
+            'confirmation_url' => 'confirmation_url-input',
             'created_at' => 'created_at-input',
             'description' => 'description-input',
             'id' => 'id-input',
@@ -361,6 +369,7 @@
             body: {
               'redirect_flows' => {
 
+                'confirmation_url' => 'confirmation_url-input',
                 'created_at' => 'created_at-input',
                 'description' => 'description-input',
                 'id' => 'id-input',