gocardless-pro 0.1.0

data/lib/gocardless-pro/version.rb

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

data/spec/api_service_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe GoCardless::ApiService do
+  subject(:service) { described_class.new("https://api.example.com", "ak123", "abc123") }
+
+  it "uses basic auth" do
+    stub = stub_request(:get, 'https://ak123:abc123@api.example.com/customers')
+    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", { 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", {
+        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", {
+        given_name: "Jack",
+        family_name: "Franklin"
+      }, {
+        '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",
+        given_name: "Jack",
+        family_name: "Franklin"
+      )
+      expect(stub).to have_been_requested
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe GoCardless::Client do
+  subject { -> { described_class.new(options) } }
+
+  let(:options) do
+    {
+      environment: environment,
+      api_key: api_key,
+      api_secret: api_secret
+    }
+  end
+
+  context "when initialised without an API key" do
+    let(:environment) { :live }
+    let(:api_secret) { "MYSECRETTOKEN" }
+    let(:api_key) { 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") }
+  end
+end

data/spec/error_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe GoCardless::Error do
+  subject(:error) { described_class.new(api_error) }
+
+  let(:api_error) do
+    {
+      "documentation_url" => "https://developer.gocardless.com/pro#validation_failed",
+      "message" => "Validation failed",
+      "type" => "validation_failed",
+      "code" => 422,
+      "request_id" => "dd50eaaf-8213-48fe-90d6-5466872efbc4",
+      "errors" => [
+        {
+          "message" => "must be a number",
+          "field" => "branch_code"
+        }, {
+          "message" => "is the wrong length (should be 8 characters)",
+          "field" => "branch_code"
+        }
+      ]
+    }
+  end
+
+  specify do
+    expect(error.documentation_url).to eq("https://developer.gocardless.com/pro#validation_failed")
+  end
+
+  specify { expect(error.message).to eq("Validation failed") }
+  specify { expect(error.type).to eq("validation_failed") }
+  specify { expect(error.code).to eq(422) }
+  specify { expect(error.request_id).to eq("dd50eaaf-8213-48fe-90d6-5466872efbc4") }
+  specify do
+    expect(error.errors).to eq([
+      {
+        "message" => "must be a number",
+        "field" => "branch_code"
+      }, {
+        "message" => "is the wrong length (should be 8 characters)",
+        "field" => "branch_code"
+      }
+    ])
+  end
+end

data/spec/resources/api_key_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe GoCardless::Resources::ApiKey do
+  describe "initialising" do
+    let(:data) do
+      {
+      
+        
+          "created_at" => "created_at-input",
+        
+      
+        
+          "enabled" => "enabled-input",
+        
+      
+        
+          "id" => "id-input",
+        
+      
+        
+          "key" => "key-input",
+        
+      
+        
+        "links" => {
+          
+            "role" => "role-input",
+          
+        },
+        
+      
+        
+          "name" => "name-input",
+        
+      
+        
+          "webhook_url" => "webhook_url-input",
+        
+      
+      }
+    end
+
+    it "can be initialized from an uneveloped response" do
+      resource = described_class.new(data)
+      
+       
+       expect(resource.created_at).to eq("created_at-input")
+       
+       
+       
+       expect(resource.enabled).to eq("enabled-input")
+       
+       
+       
+       expect(resource.id).to eq("id-input")
+       
+       
+       
+       expect(resource.key).to eq("key-input")
+       
+       
+       
+         
+           expect(resource.links.role).to eq("role-input")
+         
+       
+       
+       
+       expect(resource.name).to eq("name-input")
+       
+       
+       
+       expect(resource.webhook_url).to eq("webhook_url-input")
+       
+       
+    end
+
+    describe "#to_h" do
+      it "returns a hash representing the resource" do
+        expect(described_class.new(data).to_h).to eq(data)
+      end
+    end
+  end
+end
+

data/spec/resources/creditor_bank_account_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe GoCardless::Resources::CreditorBankAccount do
+  describe "initialising" do
+    let(:data) do
+      {
+      
+        
+          "account_holder_name" => "account_holder_name-input",
+        
+      
+        
+          "account_number_ending" => "account_number_ending-input",
+        
+      
+        
+          "bank_name" => "bank_name-input",
+        
+      
+        
+          "country_code" => "country_code-input",
+        
+      
+        
+          "created_at" => "created_at-input",
+        
+      
+        
+          "currency" => "currency-input",
+        
+      
+        
+          "enabled" => "enabled-input",
+        
+      
+        
+          "id" => "id-input",
+        
+      
+        
+        "links" => {
+          
+            "creditor" => "creditor-input",
+          
+        },
+        
+      
+        
+          "metadata" => "metadata-input",
+        
+      
+      }
+    end
+
+    it "can be initialized from an uneveloped response" do
+      resource = described_class.new(data)
+      
+       
+       expect(resource.account_holder_name).to eq("account_holder_name-input")
+       
+       
+       
+       expect(resource.account_number_ending).to eq("account_number_ending-input")
+       
+       
+       
+       expect(resource.bank_name).to eq("bank_name-input")
+       
+       
+       
+       expect(resource.country_code).to eq("country_code-input")
+       
+       
+       
+       expect(resource.created_at).to eq("created_at-input")
+       
+       
+       
+       expect(resource.currency).to eq("currency-input")
+       
+       
+       
+       expect(resource.enabled).to eq("enabled-input")
+       
+       
+       
+       expect(resource.id).to eq("id-input")
+       
+       
+       
+         
+           expect(resource.links.creditor).to eq("creditor-input")
+         
+       
+       
+       
+       expect(resource.metadata).to eq("metadata-input")
+       
+       
+    end
+
+    describe "#to_h" do
+      it "returns a hash representing the resource" do
+        expect(described_class.new(data).to_h).to eq(data)
+      end
+    end
+  end
+end
+

data/spec/resources/creditor_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+
+describe GoCardless::Resources::Creditor do
+  describe "initialising" do
+    let(:data) do
+      {
+      
+        
+          "address_line1" => "address_line1-input",
+        
+      
+        
+          "address_line2" => "address_line2-input",
+        
+      
+        
+          "address_line3" => "address_line3-input",
+        
+      
+        
+          "city" => "city-input",
+        
+      
+        
+          "country_code" => "country_code-input",
+        
+      
+        
+          "created_at" => "created_at-input",
+        
+      
+        
+          "id" => "id-input",
+        
+      
+        
+        "links" => {
+          
+            "default_eur_payout_account" => "default_eur_payout_account-input",
+          
+            "default_gbp_payout_account" => "default_gbp_payout_account-input",
+          
+            "logo" => "logo-input",
+          
+        },
+        
+      
+        
+          "name" => "name-input",
+        
+      
+        
+          "postal_code" => "postal_code-input",
+        
+      
+        
+          "region" => "region-input",
+        
+      
+      }
+    end
+
+    it "can be initialized from an uneveloped response" do
+      resource = described_class.new(data)
+      
+       
+       expect(resource.address_line1).to eq("address_line1-input")
+       
+       
+       
+       expect(resource.address_line2).to eq("address_line2-input")
+       
+       
+       
+       expect(resource.address_line3).to eq("address_line3-input")
+       
+       
+       
+       expect(resource.city).to eq("city-input")
+       
+       
+       
+       expect(resource.country_code).to eq("country_code-input")
+       
+       
+       
+       expect(resource.created_at).to eq("created_at-input")
+       
+       
+       
+       expect(resource.id).to eq("id-input")
+       
+       
+       
+         
+           expect(resource.links.default_eur_payout_account).to eq("default_eur_payout_account-input")
+         
+           expect(resource.links.default_gbp_payout_account).to eq("default_gbp_payout_account-input")
+         
+           expect(resource.links.logo).to eq("logo-input")
+         
+       
+       
+       
+       expect(resource.name).to eq("name-input")
+       
+       
+       
+       expect(resource.postal_code).to eq("postal_code-input")
+       
+       
+       
+       expect(resource.region).to eq("region-input")
+       
+       
+    end
+
+    describe "#to_h" do
+      it "returns a hash representing the resource" do
+        expect(described_class.new(data).to_h).to eq(data)
+      end
+    end
+  end
+end
+