companies-house-rest 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e65c6b0dc6a852028c762b9321fda74d1b1ad97
-  data.tar.gz: e07022f3a98a5e906975d0f300158345a3163570
+  metadata.gz: 67fd9432223ef1ff69e1f6bbe6c67a4687725948
+  data.tar.gz: ce5123c5283a4c6c0bdb54e72a6dd2ac8526c1a2
 SHA512:
-  metadata.gz: 8f3901911201a184ded7db0e560135a281e3befe4cca48f4bccbc08d8842eec0200bade212524c98eb6f876e8eb82a02db18038d94a94a096537c6503d23e4cf
-  data.tar.gz: ed781a6ac56a719dc667ea3e3c22c686cb2ef2019c5259e714cc1aa5a482d46c7f5ac580b940b1ab8acbfd90b7913074aedb2a3a9ae9c78c30eb3be85e93d803
+  metadata.gz: 5581a2599700c5c798d64097f1d5331149e78507165dfaeab0f0c1c07721cc01c99a772cac7a9749d8b8a661e7216a8f4d81927bfc5f0753ead28e5a90ea3d24
+  data.tar.gz: 85659d09bd029eb39850ecd748cfc6028be4dde8589d6873dd4182c4911747dde3ef91d73aff88663ce97676ef644ce790d1c7b39da4d821305fecd3d3f59580

data/companies-house-rest.gemspec

@@ -18,11 +18,15 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = '~> 2.0'
+  spec.required_ruby_version = '~> 2.2.2'
+
+  spec.add_runtime_dependency "activesupport", ">= 4.2"
+  spec.add_runtime_dependency "virtus", '~> 1.0', '>= 1.0.5'
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.5.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
   spec.add_development_dependency "rubocop", "~> 0.41.2"
-  spec.add_development_dependency "webmock", "~> 2.1.0"
+  spec.add_development_dependency "webmock", "~> 2.1"
+  spec.add_development_dependency 'timecop', '~> 0.8'
 end

data/lib/companies_house/client.rb

@@ -1,14 +1,11 @@
 # frozen_string_literal: true
-require 'companies_house/api_error'
-require 'companies_house/not_found_error'
-require 'companies_house/authentication_error'
-require 'companies_house/rate_limit_error'
+require 'companies_house/request'
 require 'net/http'
-require 'json'
 
 module CompaniesHouse
-  # This class connects to the Companies House API
+  # This class provides an interface to the Companies House API
   # at https://api.companieshouse.gov.uk
+  # Specifically, it manages the connections and arranges requests.
   class Client
     ENDPOINT = 'https://api.companieshouse.gov.uk'
 
@@ -26,7 +23,7 @@ module CompaniesHouse
     end
 
     def company(id)
-      request(id)
+      request(:company, id)
     end
 
     # The API endpoint for company officers is paginated, and not all of the officers may
@@ -35,9 +32,10 @@ module CompaniesHouse
     def officers(id)
       items = []
       offset = 0
+      xid = make_transaction_id
 
       loop do
-        page = request(id, '/officers', start_index: offset)
+        page = request(:officers, id, '/officers', { start_index: offset }, xid)
         new_items = page['items']
         total = page['total_results'] || new_items.count
 
@@ -58,30 +56,27 @@ module CompaniesHouse
 
     private
 
-    def request(company_id, extra_path = '', params = {})
-      uri = URI.join(endpoint, 'company/', "#{company_id}#{extra_path}")
-      uri.query = URI.encode_www_form(params)
-
-      req = Net::HTTP::Get.new(uri)
-      req.basic_auth api_key, ''
-
-      response = connection.request req
-      parse(response, company_id)
+    def make_transaction_id
+      SecureRandom.hex(10)
     end
 
-    def parse(response, company_id)
-      case response.code
-      when '200'
-        return JSON[response.body]
-      when '401'
-        raise CompaniesHouse::AuthenticationError, response
-      when '404'
-        raise CompaniesHouse::NotFoundError.new(company_id, response)
-      when '429'
-        raise CompaniesHouse::RateLimitError, response
-      else
-        raise CompaniesHouse::APIError.new("Unknown API response", response)
-      end
+    def request(resource,
+                company_id,
+                extra_path = '',
+                params = {},
+                transaction_id = make_transaction_id)
+      Request.new(
+        connection: connection,
+        api_key: @api_key,
+        endpoint: @endpoint,
+
+        path: "company/#{company_id}#{extra_path}",
+        query: params,
+
+        resource_type: resource,
+        company_id: company_id,
+        transaction_id: transaction_id
+      ).execute
     end
   end
 end

data/lib/companies_house/request.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+require 'companies_house/api_error'
+require 'companies_house/not_found_error'
+require 'companies_house/authentication_error'
+require 'companies_house/rate_limit_error'
+
+require 'virtus'
+require 'uri'
+require 'json'
+
+require 'active_support/notifications'
+
+module CompaniesHouse
+  # This class manages individual requests.
+  # Users of the CompaniesHouse gem should not instantiate this class
+  # and should instead use CompaniesHouse::Client.
+  class Request
+    include Virtus.model
+    # API-level attributes
+    attribute :connection, Net::HTTP, required: true
+    attribute :api_key, String, required: true
+    attribute :endpoint, URI, required: true
+
+    # Physical request attributes
+    attribute :path, String, required: true
+    attribute :query, Hash, required: true
+
+    # Logical request attributes
+    attribute :resource_type, Symbol, required: true
+    attribute :company_id, String, required: true
+
+    attribute :transaction_id, String, required: true
+
+    def initialize(args)
+      super(args)
+
+      @uri = URI.join(endpoint, path)
+      @uri.query = URI.encode_www_form(query)
+
+      @notification_payload = {
+        method: :get,
+        path: path,
+        query: query
+      }
+    end
+
+    def execute
+      @started = Time.now.utc
+
+      req = Net::HTTP::Get.new(@uri)
+      req.basic_auth @api_key, ''
+
+      response = connection.request req
+      @notification_payload[:status] = response.code
+
+      begin
+        response_body = @notification_payload[:response] = parse(response, company_id)
+      rescue => e
+        @notification_payload[:error] = e
+        raise e
+      ensure
+        publish_notification
+      end
+
+      response_body
+    end
+
+    private
+
+    def publish_notification
+      ActiveSupport::Notifications.publish(
+        "companies_house.#{resource_type}",
+        @started, Time.now.utc,
+        transaction_id,
+        @notification_payload
+      )
+    end
+
+    def parse(response, company_id)
+      case response.code
+      when '200'
+        return JSON[response.body]
+      when '401'
+        raise CompaniesHouse::AuthenticationError, response
+      when '404'
+        raise CompaniesHouse::NotFoundError.new(company_id, response)
+      when '429'
+        raise CompaniesHouse::RateLimitError, response
+      else
+        raise CompaniesHouse::APIError.new("Unknown API response", response)
+      end
+    end
+  end
+end

data/lib/companies_house/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CompaniesHouse
-  VERSION = '0.1.3'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,85 +1,133 @@
 --- !ruby/object:Gem::Specification
 name: companies-house-rest
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - GoCardless Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-03 00:00:00.000000000 Z
+date: 2016-08-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.41.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.41.2
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '0.8'
 description: Client for the Companies House REST API. Provides company profiles and
   officer lists.
 email:
@@ -97,6 +145,7 @@ files:
 - lib/companies_house/client.rb
 - lib/companies_house/not_found_error.rb
 - lib/companies_house/rate_limit_error.rb
+- lib/companies_house/request.rb
 - lib/companies_house/version.rb
 homepage: https://github.com/gocardless/companies-house-rest
 licenses:
@@ -108,17 +157,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ~>
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Look up UK company registration information