gocardless-pro 0.1.0

data/spec/services/user_service_spec.rb

@@ -0,0 +1,433 @@
+require 'spec_helper'
+
+describe GoCardless::Services::UserService do
+  let(:client) do
+    GoCardless::Client.new(
+      api_key: "AK123",
+      api_secret: "ABC"
+    )
+  end
+
+  
+  
+    
+
+    
+    describe "#create" do
+    subject(:post_create_response) { client.users.create(new_resource) }
+      context "with a valid request" do
+        let(:new_resource) do
+          {
+          
+          "created_at" => "created_at-input",
+          "email" => "email-input",
+          "enabled" => "enabled-input",
+          "family_name" => "family_name-input",
+          "given_name" => "given_name-input",
+          "id" => "id-input",
+          "links" => "links-input",
+          }
+        end
+
+        before do
+          stub_request(:post, /.*api.gocardless.com\/users/).
+          with(
+            body: {
+              users: {
+                
+                "created_at" => "created_at-input",
+                "email" => "email-input",
+                "enabled" => "enabled-input",
+                "family_name" => "family_name-input",
+                "given_name" => "given_name-input",
+                "id" => "id-input",
+                "links" => "links-input",
+                }
+            }
+          ).
+          to_return(
+            body: {
+              users: {
+                
+                "created_at" => "created_at-input",
+                "email" => "email-input",
+                "enabled" => "enabled-input",
+                "family_name" => "family_name-input",
+                "given_name" => "given_name-input",
+                "id" => "id-input",
+                "links" => "links-input",
+                }
+            }.to_json,
+            :headers => {'Content-Type' => 'application/json'}
+          )
+        end
+
+        it "creates and returns the resource" do
+          expect(post_create_response).to be_a(GoCardless::Resources::User)
+        end
+      end
+
+      context "with a request that returns a validation error" do
+        let(:new_resource) { {} }
+
+        before do
+          stub_request(:post, /.*api.gocardless.com\/users/).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(GoCardless::ValidationError)
+        end
+      end
+    end
+    
+  
+    
+
+    
+    describe "#list" do
+      describe "with no filters" do
+        subject(:get_list_response) { client.users.list }
+
+        before do
+          stub_request(:get, /.*api.gocardless.com\/users/).to_return(
+            body: {
+              users: [{
+                
+                "created_at" => "created_at-input",
+                "email" => "email-input",
+                "enabled" => "enabled-input",
+                "family_name" => "family_name-input",
+                "given_name" => "given_name-input",
+                "id" => "id-input",
+                "links" => "links-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.map { |x| x.class }.uniq.first).to eq(GoCardless::Resources::User)
+
+          
+          
+          expect(get_list_response.first.created_at).to eq("created_at-input")
+          
+          
+          
+          expect(get_list_response.first.email).to eq("email-input")
+          
+          
+          
+          expect(get_list_response.first.enabled).to eq("enabled-input")
+          
+          
+          
+          expect(get_list_response.first.family_name).to eq("family_name-input")
+          
+          
+          
+          expect(get_list_response.first.given_name).to eq("given_name-input")
+          
+          
+          
+          expect(get_list_response.first.id).to eq("id-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\/users$/).to_return(
+          body: {
+            users: [{
+              
+              "created_at" => "created_at-input",
+              "email" => "email-input",
+              "enabled" => "enabled-input",
+              "family_name" => "family_name-input",
+              "given_name" => "given_name-input",
+              "id" => "id-input",
+              "links" => "links-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\/users\?after=AB345/).to_return(
+          body: {
+            users: [{
+              
+              "created_at" => "created_at-input",
+              "email" => "email-input",
+              "enabled" => "enabled-input",
+              "family_name" => "family_name-input",
+              "given_name" => "given_name-input",
+              "id" => "id-input",
+              "links" => "links-input",
+            }],
+            meta: {
+              limit: 2,
+              cursors: {}
+            }
+          }.to_json,
+          :headers => {'Content-Type' => 'application/json'}
+        )
+      end
+
+      it "automatically makes the extra requests" do
+        expect(client.users.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.users.get(id) }
+
+      context "when there is a user to return" do
+        before do
+          stub_request(:get, /.*api.gocardless.com\/users\/ID123/).to_return(
+            body: {
+              users: {
+                
+                "created_at" => "created_at-input",
+                "email" => "email-input",
+                "enabled" => "enabled-input",
+                "family_name" => "family_name-input",
+                "given_name" => "given_name-input",
+                "id" => "id-input",
+                "links" => "links-input",
+              }
+            }.to_json,
+            :headers => {'Content-Type' => 'application/json'}
+          )
+        end
+
+        it "wraps the response in a resource" do
+          expect(get_response).to be_a(GoCardless::Resources::User)
+        end
+      end
+    end
+
+    
+  
+    
+
+    
+    describe "#update" do
+      subject(:put_update_response) { client.users.update(id, 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\/users\/ABC123/).to_return(
+            body: {
+              users: {
+                
+                "created_at" => "created_at-input",
+                "email" => "email-input",
+                "enabled" => "enabled-input",
+                "family_name" => "family_name-input",
+                "given_name" => "given_name-input",
+                "id" => "id-input",
+                "links" => "links-input",
+              }
+            }.to_json,
+            :headers => {'Content-Type' => 'application/json'}
+          )
+        end
+
+        it "updates and returns the resource" do
+          expect(put_update_response).to be_a(GoCardless::Resources::User)
+          expect(stub).to have_been_requested
+        end
+      end
+    end
+    
+  
+    
+
+    
+    describe "#enable" do
+      
+      
+        subject(:post_response) { client.users.enable(resource_id) }
+      
+      let(:resource_id) { "ABC123" }
+
+      let!(:stub) do
+        # /users/%v/actions/enable
+        stub_url = "/users/:identity/actions/enable".gsub(':identity', resource_id)
+        stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+          body: {
+            users: {
+              
+              "created_at" => "created_at-input",
+              "email" => "email-input",
+              "enabled" => "enabled-input",
+              "family_name" => "family_name-input",
+              "given_name" => "given_name-input",
+              "id" => "id-input",
+              "links" => "links-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(GoCardless::Resources::User)
+
+        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.users.enable(resource_id, body, headers) }
+        
+        let(:resource_id) { "ABC123" }
+
+        let!(:stub) do
+          # /users/%v/actions/enable
+          stub_url = "/users/:identity/actions/enable".gsub(':identity', resource_id)
+          stub_request(:post, /.*api.gocardless.com#{stub_url}/).
+          with(
+            body: { foo: 'bar' },
+            headers: { 'Foo' => 'Bar' }
+          ).to_return(
+            body: {
+              users: {
+                
+                "created_at" => "created_at-input",
+                "email" => "email-input",
+                "enabled" => "enabled-input",
+                "family_name" => "family_name-input",
+                "given_name" => "given_name-input",
+                "id" => "id-input",
+                "links" => "links-input",
+              }
+            }.to_json,
+            headers: {'Content-Type' => 'application/json'},
+          )
+        end
+      end
+    end
+    
+  
+    
+
+    
+    describe "#disable" do
+      
+      
+        subject(:post_response) { client.users.disable(resource_id) }
+      
+      let(:resource_id) { "ABC123" }
+
+      let!(:stub) do
+        # /users/%v/actions/disable
+        stub_url = "/users/:identity/actions/disable".gsub(':identity', resource_id)
+        stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+          body: {
+            users: {
+              
+              "created_at" => "created_at-input",
+              "email" => "email-input",
+              "enabled" => "enabled-input",
+              "family_name" => "family_name-input",
+              "given_name" => "given_name-input",
+              "id" => "id-input",
+              "links" => "links-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(GoCardless::Resources::User)
+
+        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.users.disable(resource_id, body, headers) }
+        
+        let(:resource_id) { "ABC123" }
+
+        let!(:stub) do
+          # /users/%v/actions/disable
+          stub_url = "/users/:identity/actions/disable".gsub(':identity', resource_id)
+          stub_request(:post, /.*api.gocardless.com#{stub_url}/).
+          with(
+            body: { foo: 'bar' },
+            headers: { 'Foo' => 'Bar' }
+          ).to_return(
+            body: {
+              users: {
+                
+                "created_at" => "created_at-input",
+                "email" => "email-input",
+                "enabled" => "enabled-input",
+                "family_name" => "family_name-input",
+                "given_name" => "given_name-input",
+                "id" => "id-input",
+                "links" => "links-input",
+              }
+            }.to_json,
+            headers: {'Content-Type' => 'application/json'},
+          )
+        end
+      end
+    end
+    
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+require 'webmock/rspec'
+require_relative '../lib/gocardless-pro'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end