passfort 0.2.3 → 0.3.0

data/spec/passfort/endpoint/profiles_spec.rb

@@ -1,79 +1,79 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-RSpec.describe Passfort::Endpoint::Profiles do
-  let(:profiles) { described_class.new(client) }
-
-  let(:client) { instance_double(Passfort::Http) }
-
-  let(:profile_fixture) { JSON.parse(load_fixture("profile.json")) }
-  let(:collected_data_fixture) { JSON.parse(load_fixture("collected_data.json")) }
-
-  describe "#create" do
-    subject { profiles.create(role: role, collected_data: collected_data) }
-
-    let(:role) { Passfort::Role::COMPANY_CUSTOMER }
-    let(:collected_data) { {} }
-
-    before do
-      allow(client).
-        to receive(:post).
-        with("/profiles", body: { role: role, collected_data: collected_data }).
-        and_return(profile_fixture)
-    end
-
-    it { is_expected.to have_attributes(id: profile_fixture["id"]) }
-  end
-
-  describe "#find" do
-    subject { profiles.find(id) }
-
-    let(:id) { profile_fixture["id"] }
-
-    before do
-      allow(client).to receive(:get).with("/profiles/#{id}").and_return(profile_fixture)
-    end
-
-    it { is_expected.to have_attributes(id: id) }
-  end
-
-  describe "#collected_data" do
-    subject { profiles.collected_data(id) }
-
-    let(:id) { profile_fixture["id"] }
-
-    before do
-      allow(client).
-        to receive(:get).
-        with("/profiles/#{id}/collected_data").
-        and_return(collected_data_fixture)
-    end
-
-    it { is_expected.to have_attributes(entity_type: Passfort::EntityType::COMPANY) }
-    it { is_expected.to be_a(Passfort::Resource::CompanyData) }
-  end
-
-  describe "#update_collected_data" do
-    subject { profiles.update_collected_data(id, data) }
-
-    let(:id) { profile_fixture["id"] }
-    let(:data) do
-      collected_data_fixture.merge(metadata: { country_of_incorporation: "FR" })
-    end
-
-    before do
-      allow(client).
-        to receive(:post).
-        with("/profiles/#{id}/collected_data", body: data).
-        and_return(data)
-    end
-
-    it do
-      is_expected.to have_attributes(
-        entity_type: Passfort::EntityType::COMPANY,
-        metadata: { country_of_incorporation: "FR" },
-      )
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Passfort::Endpoint::Profiles do
+  let(:profiles) { described_class.new(client) }
+
+  let(:client) { instance_double(Passfort::Http) }
+
+  let(:profile_fixture) { JSON.parse(load_fixture("profile.json")) }
+  let(:collected_data_fixture) { JSON.parse(load_fixture("collected_data.json")) }
+
+  describe "#create" do
+    subject { profiles.create(role: role, collected_data: collected_data) }
+
+    let(:role) { Passfort::Role::COMPANY_CUSTOMER }
+    let(:collected_data) { {} }
+
+    before do
+      allow(client).
+        to receive(:post).
+        with("/profiles", body: { role: role, collected_data: collected_data }).
+        and_return(profile_fixture)
+    end
+
+    it { is_expected.to have_attributes(id: profile_fixture["id"]) }
+  end
+
+  describe "#find" do
+    subject { profiles.find(id) }
+
+    let(:id) { profile_fixture["id"] }
+
+    before do
+      allow(client).to receive(:get).with("/profiles/#{id}").and_return(profile_fixture)
+    end
+
+    it { is_expected.to have_attributes(id: id) }
+  end
+
+  describe "#collected_data" do
+    subject { profiles.collected_data(id) }
+
+    let(:id) { profile_fixture["id"] }
+
+    before do
+      allow(client).
+        to receive(:get).
+        with("/profiles/#{id}/collected_data").
+        and_return(collected_data_fixture)
+    end
+
+    it { is_expected.to have_attributes(entity_type: Passfort::EntityType::COMPANY) }
+    it { is_expected.to be_a(Passfort::Resource::CompanyData) }
+  end
+
+  describe "#update_collected_data" do
+    subject { profiles.update_collected_data(id, data) }
+
+    let(:id) { profile_fixture["id"] }
+    let(:data) do
+      collected_data_fixture.merge(metadata: { country_of_incorporation: "FR" })
+    end
+
+    before do
+      allow(client).
+        to receive(:post).
+        with("/profiles/#{id}/collected_data", body: data).
+        and_return(data)
+    end
+
+    it do
+      is_expected.to have_attributes(
+        entity_type: Passfort::EntityType::COMPANY,
+        metadata: { country_of_incorporation: "FR" },
+      )
+    end
+  end
+end

data/spec/passfort/endpoint/tasks_spec.rb

@@ -1,21 +1,21 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-RSpec.describe Passfort::Endpoint::Tasks do
-  let(:endpoint) { described_class.new(Passfort::Http.new("api_key")) }
-
-  describe "#find" do
-    subject { endpoint.find(profile_id: profile_id, task_id: task_id) }
-
-    let(:profile_id) { "a_profile_id" }
-    let(:task_id) { "a_task_id" }
-
-    before do
-      stub_request(:get, %r{/profiles/#{profile_id}/tasks/#{task_id}\z}).
-        to_return(status: 200, body: load_fixture("task.json"))
-    end
-
-    it { is_expected.to have_attributes(id: "33cdc540-61e0-11e7-b07b-acbc32b67d7b") }
-  end
-end
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Passfort::Endpoint::Tasks do
+  let(:endpoint) { described_class.new(Passfort::Http.new("api_key")) }
+
+  describe "#find" do
+    subject { endpoint.find(profile_id: profile_id, task_id: task_id) }
+
+    let(:profile_id) { "a_profile_id" }
+    let(:task_id) { "a_task_id" }
+
+    before do
+      stub_request(:get, %r{/profiles/#{profile_id}/tasks/#{task_id}\z}).
+        to_return(status: 200, body: load_fixture("task.json"))
+    end
+
+    it { is_expected.to have_attributes(id: "33cdc540-61e0-11e7-b07b-acbc32b67d7b") }
+  end
+end

data/spec/passfort/http_spec.rb

@@ -1,95 +1,130 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-RSpec.describe Passfort::Http do
-  let(:http) { described_class.new("api_key") }
-  let(:path) { "a/path" }
-
-  shared_examples "an API call that handles all errors" do
-    let(:api_path) { Passfort::Http::DOMAIN + Passfort::Http::ROOT_PATH + path }
-    let(:status) { 200 }
-    let(:error_code) { 0 }
-    let(:body) { { errors: { code: error_code } }.to_json }
-
-    before { stub_request(method, api_path).to_return(status: status, body: body) }
-
-    context "when returning a request error" do
-      let(:status) { 404 }
-      let(:error_class) { Passfort::Errors::RequestError }
-
-      it { is_expected.to raise_error(error_class) }
-    end
-
-    context "when returning an invalid API Key error" do
-      let(:error_code) { 204 }
-      let(:error_class) { Passfort::Errors::InvalidAPIKeyError }
-
-      it { is_expected.to raise_error(error_class) }
-    end
-
-    context "when returning an invalid input data error" do
-      let(:error_code) { 201 }
-      let(:error_class) { Passfort::Errors::InvalidInputDataError }
-
-      it { is_expected.to raise_error(error_class) }
-    end
-
-    context "when returning a chargeable limit reached error" do
-      let(:error_code) { 104 }
-      let(:error_class) { Passfort::Errors::ChargeableLimitReachedError }
-
-      it { is_expected.to raise_error(error_class) }
-    end
-
-    context "when returning an unknown API error" do
-      let(:error_code) { 203 }
-      let(:error_class) { Passfort::Errors::UnknownApiError }
-
-      it { is_expected.to raise_error(error_class) }
-    end
-
-    context "when returning a response that can't be parsed as JSON" do
-      let(:body) { "<html><body><h1>something that isn't json</h1></body></html>" }
-      let(:error_class) { Passfort::Errors::UnparseableResponseError }
-
-      it { is_expected.to raise_error(error_class) }
-    end
-
-    context "when returning a successful result" do
-      let(:result) { subject.call }
-
-      before do
-        stub_request(method, api_path).
-          to_return(status: status, body: load_fixture("check.json"))
-      end
-
-      it "includes the id response" do
-        expect(result).to include("id" => "6c1d594a-496e-11e7-911e-acbc32b67d7b")
-      end
-    end
-
-    context "when the request times out" do
-      before { stub_request(method, api_path).to_raise(Excon::Errors::Timeout) }
-      let(:error_class) { Passfort::Errors::TimeoutError }
-
-      it { is_expected.to raise_error(error_class) }
-    end
-  end
-
-  describe "#get" do
-    subject { -> { http.get(path) } }
-
-    let(:method) { :get }
-
-    it_behaves_like "an API call that handles all errors"
-  end
-
-  describe "#post" do
-    subject { -> { http.post(path, body: {}) } }
-
-    let(:method) { :post }
-
-    it_behaves_like "an API call that handles all errors"
-  end
-end
+# frozen_string_literal: true
+
+require "spec_helper"
+require "timecop"
+
+RSpec.describe Passfort::Http do
+  let(:http) { described_class.new("api_key") }
+  let(:path) { "a/path" }
+
+  shared_examples "an API call that handles all errors" do
+    let(:api_path) { Passfort::Http::DOMAIN + Passfort::Http::ROOT_PATH + path }
+    let(:status) { 200 }
+    let(:error_code) { 0 }
+    let(:body) { { errors: { code: error_code } }.to_json }
+
+    before { stub_request(method, api_path).to_return(status: status, body: body) }
+
+    context "when returning a request error" do
+      let(:status) { 404 }
+      let(:error_class) { Passfort::Errors::RequestError }
+
+      it { is_expected.to raise_error(error_class) }
+    end
+
+    context "when returning an invalid API Key error" do
+      let(:error_code) { 204 }
+      let(:error_class) { Passfort::Errors::InvalidAPIKeyError }
+
+      it { is_expected.to raise_error(error_class) }
+    end
+
+    context "when returning an invalid input data error" do
+      let(:error_code) { 201 }
+      let(:error_class) { Passfort::Errors::InvalidInputDataError }
+
+      it { is_expected.to raise_error(error_class) }
+    end
+
+    context "when returning a chargeable limit reached error" do
+      let(:error_code) { 104 }
+      let(:error_class) { Passfort::Errors::ChargeableLimitReachedError }
+
+      it { is_expected.to raise_error(error_class) }
+    end
+
+    context "when returning an unknown API error" do
+      let(:error_code) { 203 }
+      let(:error_class) { Passfort::Errors::UnknownApiError }
+
+      it { is_expected.to raise_error(error_class) }
+    end
+
+    context "when returning a response that can't be parsed as JSON" do
+      let(:body) { "<html><body><h1>something that isn't json</h1></body></html>" }
+      let(:error_class) { Passfort::Errors::UnparseableResponseError }
+
+      it { is_expected.to raise_error(error_class) }
+    end
+
+    context "when returning a successful result" do
+      let(:result) { subject.call }
+
+      before do
+        stub_request(method, api_path).
+          to_return(status: status, body: load_fixture("check.json"))
+      end
+
+      it "includes the id response" do
+        expect(result).to include("id" => "6c1d594a-496e-11e7-911e-acbc32b67d7b")
+      end
+    end
+
+    context "when the request times out" do
+      before { stub_request(method, api_path).to_raise(Excon::Errors::Timeout) }
+      let(:error_class) { Passfort::Errors::TimeoutError }
+
+      it { is_expected.to raise_error(error_class) }
+    end
+  end
+
+  shared_examples_for "an API call that sends notifications" do
+    let(:api_path) { Passfort::Http::DOMAIN + Passfort::Http::ROOT_PATH + path }
+    let(:notifications) { [] }
+    let(:time) { Time.local(1990) }
+    let(:payload) { { path: path, response: be_truthy } }
+    let(:expected_notification) do
+      have_attributes(
+        name: "passfort.#{method}",
+        transaction_id: match(/\A.{20}\Z/),
+        time: time,
+        end: time,
+        payload: payload,
+      )
+    end
+    let(:result) { subject.call }
+
+    before do
+      ActiveSupport::Notifications.subscribe do |*args|
+        notifications << ActiveSupport::Notifications::Event.new(*args)
+      end
+      stub_request(method, api_path).to_return(body: {}.to_json)
+      payload[:body] = be_truthy if method == :post
+    end
+
+    it "records a notification" do
+      Timecop.freeze(time) do
+        result
+      end
+      expect(notifications).to match([expected_notification])
+    end
+  end
+
+  describe "#get" do
+    subject { -> { http.get(path) } }
+
+    let(:method) { :get }
+
+    it_behaves_like "an API call that handles all errors"
+    it_behaves_like "an API call that sends notifications"
+  end
+
+  describe "#post" do
+    subject { -> { http.post(path, body: {}) } }
+
+    let(:method) { :post }
+
+    it_behaves_like "an API call that handles all errors"
+    it_behaves_like "an API call that sends notifications"
+  end
+end

data/spec/spec_helper.rb

@@ -1,9 +1,9 @@
-# frozen_string_literal: true
-
-require "passfort"
-require "pry"
-require "webmock/rspec"
-
-def load_fixture(path)
-  File.read(File.join(__dir__, "fixtures", path))
-end
+# frozen_string_literal: true
+
+require "passfort"
+require "pry"
+require "webmock/rspec"
+
+def load_fixture(path)
+  File.read(File.join(__dir__, "fixtures", path))
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: passfort
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - GoCardless
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-29 00:00:00.000000000 Z
+date: 2018-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement