companies-house-gateway 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 35fc32ab120eec1eda0045fb17825c8002d74a0e
+  data.tar.gz: 75bccea34dd2828c0a8b043653f3af63ea0578cd
+SHA512:
+  metadata.gz: 4c2e6547c39056632631be167c1073a4453cc706e66290ea3646b1c60cda828a57b510e5bb678f467f22c28daee37ab10ae7ccd42e5adbefaea3ce407396a5e2
+  data.tar.gz: 796529dcddcc0e3decc0e7820e272b8657bd4a89ca87a0f363d3b5ec065865d52fd9d3619475fb328f51859fbb23a321018d1fdc658cca5d53549657fe920da6

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+.bundle
+*.gem

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+## 0.2.0 - February 23, 2014
+
+- Add filing_history and document_info and document classes. Gem now covers
+  all possible request types
+
+## 0.1.2 - February 23, 2014
+
+- Add officer_details and officer_search classes
+
+## 0.1.1 - February 22, 2014
+
+- Add company_appointments class
+
+## 0.1.0 - February 22, 2014
+
+- Add name_search and number_search classes
+
+## 0.0.1 - February 19, 2014
+
+- Initial commit

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Grey Baker
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Companies House XML Gateway Ruby Client Library
+
+Simple Ruby Gem for interacting with the Companies House XML Gateway API. Wraps
+the XML submissions and responses required so you can deal with Ruby hashes
+instead.
+
+## Usage
+
+### Installation
+
+You don't need this source code unless you want to modify the gem. If you just
+want to use it, you should run:
+
+```ruby
+gem install companies_house_gateway
+````
+
+### Initialising the gem
+Requires your Companies House XML Gateway credentials. If you don't have any,
+you'll need to get in touch with
+[Companies House](http://xmlgw.companieshouse.gov.uk/).
+
+```ruby
+CompaniesHouseGateway.configure do |config|
+  config[:sender_id]        = YOUR_SENDER_ID
+  config[:password]         = YOUR_PASSWORD
+end
+```

data/companies_house_gateway.gemspec

@@ -0,0 +1,22 @@
+require File.expand_path('../lib/companies_house_gateway/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.add_runtime_dependency 'faraday',             '~> 0.8.0'
+  gem.add_runtime_dependency 'faraday_middleware',  '>= 0.8.2'
+  gem.add_runtime_dependency 'multi_xml',           '~> 0.5.1'
+  gem.add_runtime_dependency 'nokogiri',            '~> 1.4'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'webmock'
+
+  gem.authors = ['Grey Baker']
+  gem.description = %q{Ruby wrapper for the Companies House XML Gateway}
+  gem.email = ['grey@gocardless.com']
+  gem.files = `git ls-files`.split("\n")
+  gem.homepage = 'https://github.com/gocardless/companies-house-gateway-ruby'
+  gem.name = 'companies-house-gateway'
+  gem.require_paths = ['lib']
+  gem.summary = %q{Ruby wrapper for the Companies House XML Gateway}
+  gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.version = CompaniesHouseGateway::VERSION.dup
+end

data/lib/companies_house_gateway.rb

@@ -0,0 +1,60 @@
+require 'faraday_middleware'
+require 'nokogiri'
+
+require 'companies_house_gateway/version'
+require 'companies_house_gateway/constants'
+require 'companies_house_gateway/util'
+require 'companies_house_gateway/config'
+require 'companies_house_gateway/request'
+require 'companies_house_gateway/client'
+
+require 'companies_house_gateway/errors/companies_house_gateway_error'
+
+require 'companies_house_gateway/checks/check'
+require 'companies_house_gateway/checks/name_search'
+require 'companies_house_gateway/checks/number_search'
+require 'companies_house_gateway/checks/company_appointments'
+require 'companies_house_gateway/checks/company_details'
+require 'companies_house_gateway/checks/officer_search'
+require 'companies_house_gateway/checks/officer_details'
+require 'companies_house_gateway/checks/mortgages'
+require 'companies_house_gateway/checks/filing_history'
+require 'companies_house_gateway/checks/document_info'
+require 'companies_house_gateway/checks/document'
+
+module CompaniesHouseGateway
+  def self.configure(&block)
+    @config = Config.new(&block)
+  end
+
+  def self.perform_check(*args)
+    client.perform_check(*args)
+  end
+
+  Constants::SUPPORTED_REQUESTS.each do |name|
+    class_eval <<-EOM
+      def self.#{Util.underscore(name)}(*args)
+        client.send(:#{Util.underscore(name)}, *args)
+      end
+    EOM
+  end
+
+  # Require configuration before use
+  def self.config
+    if @config
+      @config
+    else
+      msg = "No config found. Use CompaniesHouseGateway.configure to set "
+            "username and password. See " +
+            "https://github.com/gocardless/companies-house-gateway " +
+            "for details."
+      raise CompaniesHouseGatewayError.new(msg)
+    end
+  end
+
+  def self.client
+    @client ||= Client.new(config)
+  end
+  private_class_method :client
+end
+

data/lib/companies_house_gateway/checks/check.rb

@@ -0,0 +1,66 @@
+module CompaniesHouseGateway
+  module Checks
+    module Check
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      def initialize(client)
+        @client = client
+      end
+
+      def perform(data = {})
+        data = self.class.default_inputs.merge(data)
+        check_params(data)
+        check_type = Util.underscore(Util.demodulize(self.class))
+        @client.perform_check(check_type, data)
+      end
+
+      private
+
+      def check_params(data)
+        self.class.required_inputs.each do |param|
+          if data[param].nil?
+            msg = "#{Util.demodulize(self.class)} requires a #{param}"
+            raise CompaniesHouseGatewayError.new(msg)
+          end
+        end
+
+        data.keys.each do |param|
+          unless self.class.allowed_inputs.include?(param)
+            msg = "#{Util.demodulize(self.class)} does not accept " +
+                  "#{param}. Only the following inputs are permitted: " +
+                  "#{self.class.allowed_inputs.to_a}"
+            raise CompaniesHouseGatewayError.new(msg)
+          end
+        end
+      end
+
+      module ClassMethods
+        # Add one or more required arguments
+        def required_input(*inputs)
+          @required_inputs = self.required_inputs.union(inputs)
+        end
+
+        # Accessor for the check's required arguments
+        def required_inputs
+          @required_inputs ||= Set.new
+        end
+
+        # Add one or more default arguments
+        def default_input(input)
+          @default_inputs = input.merge(self.default_inputs)
+        end
+
+        # Accessor for the check's default arguments
+        def default_inputs
+          @default_inputs ||= {}
+        end
+
+        def allowed_inputs
+          self.required_inputs.union(self.default_inputs.keys)
+        end
+      end
+    end
+  end
+end

data/lib/companies_house_gateway/checks/company_appointments.rb

@@ -0,0 +1,14 @@
+module CompaniesHouseGateway
+  module Checks
+    class CompanyAppointments
+      include Check
+
+      required_input :company_name,
+                     :company_number,
+                     :user_reference
+
+      default_input continuation_key: nil,
+                    include_resigned_ind: false
+    end
+  end
+end

data/lib/companies_house_gateway/checks/company_details.rb

@@ -0,0 +1,11 @@
+module CompaniesHouseGateway
+  module Checks
+    class CompanyDetails
+      include Check
+
+      required_input :company_number
+
+      default_input give_mort_totals: false
+    end
+  end
+end

data/lib/companies_house_gateway/checks/document.rb

@@ -0,0 +1,10 @@
+module CompaniesHouseGateway
+  module Checks
+    class Document
+      include Check
+
+      required_input :doc_request_key,
+                     :user_reference
+    end
+  end
+end

data/lib/companies_house_gateway/checks/document_info.rb

@@ -0,0 +1,11 @@
+module CompaniesHouseGateway
+  module Checks
+    class DocumentInfo
+      include Check
+
+      required_input :company_name,
+                     :company_number,
+                     :image_key
+    end
+  end
+end

data/lib/companies_house_gateway/checks/filing_history.rb

@@ -0,0 +1,12 @@
+module CompaniesHouseGateway
+  module Checks
+    class FilingHistory
+      include Check
+
+      required_input :company_number
+
+      default_input capital_doc_ind: false,
+                    continuation_key: nil
+    end
+  end
+end

data/lib/companies_house_gateway/checks/mortgages.rb

@@ -0,0 +1,16 @@
+module CompaniesHouseGateway
+  module Checks
+    class Mortgages
+      include Check
+
+      required_input :company_name,
+                     :company_number,
+                     :user_reference
+
+      default_input satisfied_charges_ind: false,
+                    start_date: nil,
+                    end_date: nil,
+                    continuation_key: nil
+    end
+  end
+end

data/lib/companies_house_gateway/checks/name_search.rb

@@ -0,0 +1,17 @@
+module CompaniesHouseGateway
+  module Checks
+    class NameSearch
+      include Check
+
+      required_input :company_name,
+                     :data_set
+
+      default_input  data_set: "LIVE",
+                     same_as: false,
+                     search_rows: 20,
+                     continuation_key: nil,
+                     regression_key: nil
+
+    end
+  end
+end

data/lib/companies_house_gateway/checks/number_search.rb

@@ -0,0 +1,13 @@
+module CompaniesHouseGateway
+  module Checks
+    class NumberSearch
+      include Check
+
+      required_input :partial_company_number,
+                     :data_set
+
+      default_input data_set: "LIVE",
+                    search_rows: 20
+    end
+  end
+end

data/lib/companies_house_gateway/checks/officer_details.rb

@@ -0,0 +1,12 @@
+module CompaniesHouseGateway
+  module Checks
+    class OfficerDetails
+      include Check
+
+      required_input :person_id,
+                     :user_reference
+
+      default_input continuation_key: nil
+    end
+  end
+end

data/lib/companies_house_gateway/checks/officer_search.rb

@@ -0,0 +1,16 @@
+module CompaniesHouseGateway
+  module Checks
+    class OfficerSearch
+      include Check
+
+      required_input :surname,
+                     :officer_type
+
+      default_input forename: nil,
+                    post_town: nil,
+                    country_of_residence: nil,
+                    continuation_key: nil,
+                    include_resigned_ind: false
+    end
+  end
+end

data/lib/companies_house_gateway/client.rb

@@ -0,0 +1,45 @@
+module CompaniesHouseGateway
+  class Client
+    def initialize(config=nil)
+      @config = (config || CompaniesHouseGateway.config).clone
+    end
+
+    def perform_check(*args)
+      request = Request.new(connection, @config)
+      request.perform(*args)
+    end
+
+    def config
+      @config
+    end
+
+    Constants::SUPPORTED_REQUESTS.each do |name|
+      class_eval <<-EOM
+        def #{Util.underscore(name)}(*args)
+          check = CompaniesHouseGateway::Checks.const_get(:#{name}).new(self)
+          check.perform(*args)
+        end
+      EOM
+    end
+
+    private
+
+    def connection
+      options = {
+        ssl: { verify: false },
+        url: @config[:api_endpoint],
+        headers: {
+          'Accept' => "application/xml",
+          'User-Agent' => @config[:user_agent]
+        }
+      }
+
+      Faraday.new(options) do |conn|
+        conn.response :xml  unless @config[:raw]            # Parse response
+        conn.response :follow_redirects, limit: 3           # Follow redirect
+        conn.response :raise_error                          # Raise errors
+        conn.adapter @config[:adapter]
+      end
+    end
+  end
+end