gocardless_pro 0.3.0

data/spec/services/payments_service_spec.rb

@@ -0,0 +1,546 @@
+require 'spec_helper'
+
+describe GoCardlessPro::Services::PaymentsService do
+  let(:client) do
+    GoCardlessPro::Client.new(
+      access_token: "SECRET_TOKEN"
+    )
+  end
+
+  
+  
+    
+
+    
+    describe "#create" do
+    subject(:post_create_response) { client.payments.create(params: new_resource) }
+      context "with a valid request" do
+        let(:new_resource) do
+          {
+          
+          "amount" => "amount-input",
+          "amount_refunded" => "amount_refunded-input",
+          "charge_date" => "charge_date-input",
+          "created_at" => "created_at-input",
+          "currency" => "currency-input",
+          "description" => "description-input",
+          "id" => "id-input",
+          "links" => "links-input",
+          "metadata" => "metadata-input",
+          "reference" => "reference-input",
+          "status" => "status-input",
+          }
+        end
+
+        before do
+          stub_request(:post, /.*api.gocardless.com\/payments/).
+          with(
+            body: {
+              payments: {
+                
+                "amount" => "amount-input",
+                "amount_refunded" => "amount_refunded-input",
+                "charge_date" => "charge_date-input",
+                "created_at" => "created_at-input",
+                "currency" => "currency-input",
+                "description" => "description-input",
+                "id" => "id-input",
+                "links" => "links-input",
+                "metadata" => "metadata-input",
+                "reference" => "reference-input",
+                "status" => "status-input",
+                }
+            }
+          ).
+          to_return(
+            body: {
+              payments: {
+                
+                "amount" => "amount-input",
+                "amount_refunded" => "amount_refunded-input",
+                "charge_date" => "charge_date-input",
+                "created_at" => "created_at-input",
+                "currency" => "currency-input",
+                "description" => "description-input",
+                "id" => "id-input",
+                "links" => "links-input",
+                "metadata" => "metadata-input",
+                "reference" => "reference-input",
+                "status" => "status-input",
+                }
+            }.to_json,
+            :headers => {'Content-Type' => 'application/json'}
+          )
+        end
+
+        it "creates and returns the resource" do
+          expect(post_create_response).to be_a(GoCardlessPro::Resources::Payment)
+        end
+      end
+
+      context "with a request that returns a validation error" do
+        let(:new_resource) { {} }
+
+        before do
+          stub_request(:post, /.*api.gocardless.com\/payments/).to_return(
+            body: {
+              error: {
+                type: 'validation_failed',
+                code: 422,
+                errors: [
+                  { message: 'test error message', field: 'test_field' }
+                ]
+              }
+            }.to_json,
+            headers: {'Content-Type' => 'application/json'},
+            status: 422
+          )
+        end
+
+        it "throws the correct error" do
+          expect { post_create_response }.to raise_error(GoCardlessPro::ValidationError)
+        end
+      end
+    end
+    
+  
+    
+
+    
+    describe "#list" do
+      describe "with no filters" do
+        subject(:get_list_response) { client.payments.list }
+
+        before do
+          stub_request(:get, /.*api.gocardless.com\/payments/).to_return(
+            body: {
+              payments: [{
+                
+                "amount" => "amount-input",
+                "amount_refunded" => "amount_refunded-input",
+                "charge_date" => "charge_date-input",
+                "created_at" => "created_at-input",
+                "currency" => "currency-input",
+                "description" => "description-input",
+                "id" => "id-input",
+                "links" => "links-input",
+                "metadata" => "metadata-input",
+                "reference" => "reference-input",
+                "status" => "status-input",
+                }],
+                meta: {
+                  cursors: {
+                    before: nil,
+                    after: "ABC123"
+                  }
+                }
+            }.to_json,
+            :headers => {'Content-Type' => 'application/json'}
+          )
+        end
+
+        it "wraps each item in the resource class" do
+          expect(get_list_response.records.map { |x| x.class }.uniq.first).to eq(GoCardlessPro::Resources::Payment)
+
+          
+          
+          expect(get_list_response.records.first.amount).to eq("amount-input")
+          
+          
+          
+          expect(get_list_response.records.first.amount_refunded).to eq("amount_refunded-input")
+          
+          
+          
+          expect(get_list_response.records.first.charge_date).to eq("charge_date-input")
+          
+          
+          
+          expect(get_list_response.records.first.created_at).to eq("created_at-input")
+          
+          
+          
+          expect(get_list_response.records.first.currency).to eq("currency-input")
+          
+          
+          
+          expect(get_list_response.records.first.description).to eq("description-input")
+          
+          
+          
+          expect(get_list_response.records.first.id).to eq("id-input")
+          
+          
+          
+          
+          
+          expect(get_list_response.records.first.metadata).to eq("metadata-input")
+          
+          
+          
+          expect(get_list_response.records.first.reference).to eq("reference-input")
+          
+          
+          
+          expect(get_list_response.records.first.status).to eq("status-input")
+          
+          
+        end
+
+        it "exposes the cursors for before and after" do
+          expect(get_list_response.before).to eq(nil)
+          expect(get_list_response.after).to eq("ABC123")
+        end
+      end
+    end
+
+    describe "#all" do
+      let!(:first_response_stub) do
+        stub_request(:get, /.*api.gocardless.com\/payments$/).to_return(
+          body: {
+            payments: [{
+              
+              "amount" => "amount-input",
+              "amount_refunded" => "amount_refunded-input",
+              "charge_date" => "charge_date-input",
+              "created_at" => "created_at-input",
+              "currency" => "currency-input",
+              "description" => "description-input",
+              "id" => "id-input",
+              "links" => "links-input",
+              "metadata" => "metadata-input",
+              "reference" => "reference-input",
+              "status" => "status-input",
+            }],
+            meta: {
+              cursors: { after: 'AB345' },
+              limit: 1
+            }
+          }.to_json,
+          :headers => {'Content-Type' => 'application/json'}
+        )
+      end
+
+      let!(:second_response_stub) do
+        stub_request(:get, /.*api.gocardless.com\/payments\?after=AB345/).to_return(
+          body: {
+            payments: [{
+              
+              "amount" => "amount-input",
+              "amount_refunded" => "amount_refunded-input",
+              "charge_date" => "charge_date-input",
+              "created_at" => "created_at-input",
+              "currency" => "currency-input",
+              "description" => "description-input",
+              "id" => "id-input",
+              "links" => "links-input",
+              "metadata" => "metadata-input",
+              "reference" => "reference-input",
+              "status" => "status-input",
+            }],
+            meta: {
+              limit: 2,
+              cursors: {}
+            }
+          }.to_json,
+          :headers => {'Content-Type' => 'application/json'}
+        )
+      end
+
+      it "automatically makes the extra requests" do
+        expect(client.payments.all.to_a.length).to eq(2)
+        expect(first_response_stub).to have_been_requested
+        expect(second_response_stub).to have_been_requested
+      end
+    end
+
+    
+  
+    
+
+    
+    describe "#get" do
+      let(:id) { "ID123" }
+
+      subject(:get_response) { client.payments.get(id) }
+
+      context "passing in a custom header" do
+        let!(:stub) do
+          stub_request(:get, /.*api.gocardless.com\/payments\/ID123/)
+          .with(headers: { 'Foo' => 'Bar' })
+          .to_return(
+            body: {
+              payments: {
+                
+                "amount" => "amount-input",
+                "amount_refunded" => "amount_refunded-input",
+                "charge_date" => "charge_date-input",
+                "created_at" => "created_at-input",
+                "currency" => "currency-input",
+                "description" => "description-input",
+                "id" => "id-input",
+                "links" => "links-input",
+                "metadata" => "metadata-input",
+                "reference" => "reference-input",
+                "status" => "status-input",
+              }
+            }.to_json,
+            :headers => {'Content-Type' => 'application/json'}
+          )
+        end
+
+        subject(:get_response) do
+          client.payments.get(id, headers: {
+            'Foo' => 'Bar'
+          })
+        end
+
+        it "includes the header" do
+          get_response
+          expect(stub).to have_been_requested
+        end
+      end
+
+      context "when there is a payment to return" do
+        before do
+          stub_request(:get, /.*api.gocardless.com\/payments\/ID123/).to_return(
+            body: {
+              payments: {
+                
+                "amount" => "amount-input",
+                "amount_refunded" => "amount_refunded-input",
+                "charge_date" => "charge_date-input",
+                "created_at" => "created_at-input",
+                "currency" => "currency-input",
+                "description" => "description-input",
+                "id" => "id-input",
+                "links" => "links-input",
+                "metadata" => "metadata-input",
+                "reference" => "reference-input",
+                "status" => "status-input",
+              }
+            }.to_json,
+            :headers => {'Content-Type' => 'application/json'}
+          )
+        end
+
+        it "wraps the response in a resource" do
+          expect(get_response).to be_a(GoCardlessPro::Resources::Payment)
+        end
+      end
+
+      context "when nothing is returned" do
+        before do
+          stub_request(:get, /.*api.gocardless.com\/payments\/ID123/).to_return(
+            body: "",
+            headers: { 'Content-Type' => 'application/json' }
+          )
+        end
+
+        it "returns nil" do
+          expect(get_response).to be_nil
+        end
+      end
+    end
+
+    
+  
+    
+
+    
+    describe "#update" do
+      subject(:put_update_response) { client.payments.update(id, params: update_params) }
+      let(:id) { "ABC123" }
+
+      context "with a valid request" do
+        let(:update_params) { { "hello" => "world" } }
+
+        let!(:stub) do
+          stub_request(:put, /.*api.gocardless.com\/payments\/ABC123/).to_return(
+            body: {
+              payments: {
+                
+                "amount" => "amount-input",
+                "amount_refunded" => "amount_refunded-input",
+                "charge_date" => "charge_date-input",
+                "created_at" => "created_at-input",
+                "currency" => "currency-input",
+                "description" => "description-input",
+                "id" => "id-input",
+                "links" => "links-input",
+                "metadata" => "metadata-input",
+                "reference" => "reference-input",
+                "status" => "status-input",
+              }
+            }.to_json,
+            :headers => {'Content-Type' => 'application/json'}
+          )
+        end
+
+        it "updates and returns the resource" do
+          expect(put_update_response).to be_a(GoCardlessPro::Resources::Payment)
+          expect(stub).to have_been_requested
+        end
+      end
+    end
+    
+  
+    
+
+    
+    describe "#cancel" do
+      
+      
+        subject(:post_response) { client.payments.cancel(resource_id) }
+      
+      let(:resource_id) { "ABC123" }
+
+      let!(:stub) do
+        # /payments/%v/actions/cancel
+        stub_url = "/payments/:identity/actions/cancel".gsub(':identity', resource_id)
+        stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+          body: {
+            payments: {
+              
+              "amount" => "amount-input",
+              "amount_refunded" => "amount_refunded-input",
+              "charge_date" => "charge_date-input",
+              "created_at" => "created_at-input",
+              "currency" => "currency-input",
+              "description" => "description-input",
+              "id" => "id-input",
+              "links" => "links-input",
+              "metadata" => "metadata-input",
+              "reference" => "reference-input",
+              "status" => "status-input",
+            }
+          }.to_json,
+          headers: {'Content-Type' => 'application/json'},
+        )
+      end
+
+      it "wraps the response and calls the right endpoint" do
+        expect(post_response).to be_a(GoCardlessPro::Resources::Payment)
+
+        expect(stub).to have_been_requested
+      end
+
+      context "when the request needs a body and custom header" do
+        
+          let(:body) { { foo: 'bar' } }
+          let(:headers) { { 'Foo' => 'Bar' } }
+          subject(:post_response) { client.payments.cancel(resource_id, body, headers) }
+        
+        let(:resource_id) { "ABC123" }
+
+        let!(:stub) do
+          # /payments/%v/actions/cancel
+          stub_url = "/payments/:identity/actions/cancel".gsub(':identity', resource_id)
+          stub_request(:post, /.*api.gocardless.com#{stub_url}/).
+          with(
+            body: { foo: 'bar' },
+            headers: { 'Foo' => 'Bar' }
+          ).to_return(
+            body: {
+              payments: {
+                
+                "amount" => "amount-input",
+                "amount_refunded" => "amount_refunded-input",
+                "charge_date" => "charge_date-input",
+                "created_at" => "created_at-input",
+                "currency" => "currency-input",
+                "description" => "description-input",
+                "id" => "id-input",
+                "links" => "links-input",
+                "metadata" => "metadata-input",
+                "reference" => "reference-input",
+                "status" => "status-input",
+              }
+            }.to_json,
+            headers: {'Content-Type' => 'application/json'},
+          )
+        end
+      end
+    end
+    
+  
+    
+
+    
+    describe "#retry" do
+      
+      
+        subject(:post_response) { client.payments.retry(resource_id) }
+      
+      let(:resource_id) { "ABC123" }
+
+      let!(:stub) do
+        # /payments/%v/actions/retry
+        stub_url = "/payments/:identity/actions/retry".gsub(':identity', resource_id)
+        stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+          body: {
+            payments: {
+              
+              "amount" => "amount-input",
+              "amount_refunded" => "amount_refunded-input",
+              "charge_date" => "charge_date-input",
+              "created_at" => "created_at-input",
+              "currency" => "currency-input",
+              "description" => "description-input",
+              "id" => "id-input",
+              "links" => "links-input",
+              "metadata" => "metadata-input",
+              "reference" => "reference-input",
+              "status" => "status-input",
+            }
+          }.to_json,
+          headers: {'Content-Type' => 'application/json'},
+        )
+      end
+
+      it "wraps the response and calls the right endpoint" do
+        expect(post_response).to be_a(GoCardlessPro::Resources::Payment)
+
+        expect(stub).to have_been_requested
+      end
+
+      context "when the request needs a body and custom header" do
+        
+          let(:body) { { foo: 'bar' } }
+          let(:headers) { { 'Foo' => 'Bar' } }
+          subject(:post_response) { client.payments.retry(resource_id, body, headers) }
+        
+        let(:resource_id) { "ABC123" }
+
+        let!(:stub) do
+          # /payments/%v/actions/retry
+          stub_url = "/payments/:identity/actions/retry".gsub(':identity', resource_id)
+          stub_request(:post, /.*api.gocardless.com#{stub_url}/).
+          with(
+            body: { foo: 'bar' },
+            headers: { 'Foo' => 'Bar' }
+          ).to_return(
+            body: {
+              payments: {
+                
+                "amount" => "amount-input",
+                "amount_refunded" => "amount_refunded-input",
+                "charge_date" => "charge_date-input",
+                "created_at" => "created_at-input",
+                "currency" => "currency-input",
+                "description" => "description-input",
+                "id" => "id-input",
+                "links" => "links-input",
+                "metadata" => "metadata-input",
+                "reference" => "reference-input",
+                "status" => "status-input",
+              }
+            }.to_json,
+            headers: {'Content-Type' => 'application/json'},
+          )
+        end
+      end
+    end
+    
+  
+end