passfort 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6895fae5e18a47206f33b537029a9b9ada673f0dc2c707bcc3eb041e2b054746
-  data.tar.gz: 60682b4845fd07a3cf4b9f009a9362f0cff7f1d6825ee94f6e4de31ddb99ecca
+  metadata.gz: 3fae0cf597ac783a06b37fa4edbebbbd60b55ec711ba585c216010bc3e77d5ff
+  data.tar.gz: 96c0f4f15f58aacebfc044a5711f7f0f28b7dad7a3398f1c7377c107a0e31065
 SHA512:
-  metadata.gz: e2484850489eb6035f75e64e1baa608c2c1a6d75677ffbcbf2a2998c0face9cffacdd6631c3079da8aa4f76d68047ad79799b7a5844bcf4fd7066dda85094d83
-  data.tar.gz: a6b4fe95090fda50ec1fe4022383e5ac6c62bcba55d4e5ecfe03de381658c4fb98febc30adb0d42d7b2a5ce03a519748b11e57bc549b363e865721125ea771d0
+  metadata.gz: e05785677a8e26c10673944b56078dfca578f9b76151a07a557793393bbd811bb5b51a3ebd0d86fe460eae00092787a3ff89bff59ba08d57ab5747ed3fda78f7
+  data.tar.gz: 6aa7ef2c1dca9560de069a8930d2442c920bcb853a438821bc4064f79bb0eef515b72972cf37cb6bcd9075da1c66f98155e3f879f63b42fcc6e6c083e17de322

data/CHANGELOG.md

@@ -6,6 +6,11 @@ Unreleased
 
 No changes.
 
+0.4.0
+-----
+
+- Add `company_search` functionality
+
 0.3.1
 -----
 

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    passfort (0.3.1)
+    passfort (0.4.0)
       activesupport (~> 5.0)
       excon (~> 0.60)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.1.6)
+    activesupport (5.2.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)

data/lib/passfort/client.rb

@@ -19,5 +19,17 @@ module Passfort
     def tasks
       Endpoint::Tasks.new(@http)
     end
+
+    def company_search(country, query, state = nil, provider = nil)
+      search_query = "/search/companies?country=#{CGI.escape(country)}"
+      search_query += "&query=#{CGI.escape(query)}"
+      search_query += "&state=#{CGI.escape(state)}" unless state.nil?
+      search_query += "&provider=#{CGI.escape(provider)}" unless provider.nil?
+
+      response = @http.get(search_query)
+      response["companies"].map do |company|
+        Passfort::Resource::CompanySummary.new(company)
+      end
+    end
   end
 end

data/lib/passfort/resource.rb

@@ -3,6 +3,7 @@
 require "passfort/resource/base"
 require "passfort/resource/profile"
 require "passfort/resource/company_data"
+require "passfort/resource/company_summary"
 require "passfort/resource/task"
 require "passfort/resource/check"
 

data/lib/passfort/resource/company_summary.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Passfort
+  module Resource
+    class CompanySummary < Base
+      attributes :name, :number, :country, :state
+    end
+  end
+end

data/lib/passfort/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Passfort
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/spec/fixtures/companies.json

@@ -0,0 +1,19 @@
+{
+    "companies": [
+        {
+            "country": "GBR",
+            "name": "GOCARDLESS LTD",
+            "number": "07495895"
+        },
+        {
+            "country": "GBR",
+            "name": "GO CARD LIMITED",
+            "number": "07269277"
+        },
+        {
+            "country": "GBR",
+            "name": "GO CAR DIRECT LTD",
+            "number": "10333984"
+        }
+    ]
+}

data/spec/passfort/client_spec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Passfort::Client do
+  let(:client) { described_class.new(api_key: "api_key") }
+
+  describe "#company_search" do
+    let(:result) { client.company_search(country, query, state, provider) }
+
+    let(:country) { "GBR" }
+    let(:query) { "GoCard" }
+    let(:state) { nil }
+    let(:provider) { "duedil" }
+
+    before do
+      stub_request(
+        :get,
+        %r{/search/companies\?country=#{country}&provider=#{provider}&query=#{query}\z},
+      ).to_return(status: 200, body: load_fixture("companies.json"))
+    end
+
+    it "returns an array of companies" do
+      expect(result).to be_a(Array)
+    end
+
+    it "returns expected number of companies" do
+      expect(result.count).to eq(3)
+    end
+
+    it "returns right type of company summary resource" do
+      expect(result[0]).to be_a(Passfort::Resource::CompanySummary)
+    end
+
+    it "returns maps company summary data" do
+      expect(result[0]).to have_attributes(
+        country: "GBR",
+        name: "GOCARDLESS LTD",
+        number: "07495895",
+      )
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: passfort
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - GoCardless
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-09 00:00:00.000000000 Z
+date: 2018-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -157,6 +157,7 @@ files:
 - lib/passfort/resource/base.rb
 - lib/passfort/resource/check.rb
 - lib/passfort/resource/company_data.rb
+- lib/passfort/resource/company_summary.rb
 - lib/passfort/resource/individual_data.rb
 - lib/passfort/resource/profile.rb
 - lib/passfort/resource/task.rb
@@ -164,6 +165,7 @@ files:
 - passfort.gemspec
 - spec/fixtures/check.json
 - spec/fixtures/collected_data.json
+- spec/fixtures/companies.json
 - spec/fixtures/company_ownership_check/check.json
 - spec/fixtures/company_ownership_check/collected_data.json
 - spec/fixtures/company_ownership_check/collected_data_update_request.json
@@ -171,6 +173,7 @@ files:
 - spec/fixtures/profile.json
 - spec/fixtures/task.json
 - spec/integration/company_ownership_check_spec.rb
+- spec/passfort/client_spec.rb
 - spec/passfort/endpoint/checks_spec.rb
 - spec/passfort/endpoint/profiles_spec.rb
 - spec/passfort/endpoint/tasks_spec.rb
@@ -203,6 +206,7 @@ summary: Client for the PassFort API
 test_files:
 - spec/fixtures/check.json
 - spec/fixtures/collected_data.json
+- spec/fixtures/companies.json
 - spec/fixtures/company_ownership_check/check.json
 - spec/fixtures/company_ownership_check/collected_data.json
 - spec/fixtures/company_ownership_check/collected_data_update_request.json
@@ -210,6 +214,7 @@ test_files:
 - spec/fixtures/profile.json
 - spec/fixtures/task.json
 - spec/integration/company_ownership_check_spec.rb
+- spec/passfort/client_spec.rb
 - spec/passfort/endpoint/checks_spec.rb
 - spec/passfort/endpoint/profiles_spec.rb
 - spec/passfort/endpoint/tasks_spec.rb