companies-house-gateway 0.2.0

data/lib/companies_house_gateway/config.rb

@@ -0,0 +1,31 @@
+module CompaniesHouseGateway
+  class Config
+    DEFAULT_OPTIONS = {
+      adapter:          Faraday.default_adapter,
+      sender_id:        nil,
+      password:         nil,
+      email:            nil,
+      raw:              false,
+      api_endpoint:     "http://xmlgw.companieshouse.gov.uk/v1-0/xmlgw/Gateway",
+      user_agent:       "CompaniesHouseGateway Ruby Gem #{CompaniesHouseGateway::VERSION}".freeze
+    }.freeze
+
+    def initialize
+      @config = {}
+      yield self if block_given?
+    end
+
+    def [](name)
+      @config.fetch(name, DEFAULT_OPTIONS[name])
+    end
+
+    def []=(name, val)
+      @config[name] = val
+    end
+
+    def clone
+      Config.new { |config| @config.each { |k,v| config[k] = v } }
+    end
+  end
+end
+

data/lib/companies_house_gateway/constants.rb

@@ -0,0 +1,8 @@
+module CompaniesHouseGateway
+  module Constants
+    # Check types suported by the Companies House XML Gateway
+    SUPPORTED_REQUESTS = %w(NameSearch NumberSearch CompanyAppointments
+                            CompanyDetails OfficerSearch OfficerDetails
+                            Mortgages FilingHistory DocumentInfo Document)
+  end
+end

data/lib/companies_house_gateway/errors/companies_house_gateway_error.rb

@@ -0,0 +1,18 @@
+module CompaniesHouseGateway
+  class CompaniesHouseGatewayError < StandardError
+    attr_reader :message
+    attr_reader :status
+    attr_reader :response_body
+
+    def initialize(message=nil, status=nil, response=nil)
+      @message = message
+      @status = status
+      @response_body = response_body
+    end
+
+    def to_s
+      status_string = @status.nil? ? "" : "(Status #{@status}) "
+      "#{status_string}#{@message}"
+    end
+  end
+end

data/lib/companies_house_gateway/request.rb

@@ -0,0 +1,105 @@
+module CompaniesHouseGateway
+  class Request
+    def initialize(connection, config)
+      @connection = connection
+      @config = config
+    end
+
+    # Perform a check
+    def perform(request_type, request_data = {})
+      request_type = Util.camelize(request_type)
+      unless Constants::SUPPORTED_REQUESTS.include?(request_type)
+        msg = "Unsupported request type #{request_type}"
+        raise CompaniesHouseGatewayError.new(msg)
+      end
+
+      response = @connection.post do |request|
+        request.path = @config[:api_endpoint]
+        request.body = build_request_xml(request_type, request_data).to_s
+      end
+      @config[:raw] ? response : response.body
+    rescue Faraday::Error::ClientError => e
+      raise CompaniesHouseGatewayError.new(e.response[:body],
+                                           e.response[:status],
+                                           e.response)
+    end
+
+    # Compile the complete XML request to send to Companies House
+    def build_request_xml(request_type, request_data={})
+      transaction_id = (Time.now.to_f * 100).to_i
+
+      builder = Nokogiri::XML::Builder.new do |xml|
+        xml.GovTalkMessage(header_namespace) do
+          xml.EnvelopeVersion "2.0"
+          xml.Header do
+            message_details(xml, request_type, transaction_id)
+            authentication(xml, transaction_id)
+          end
+          xml.GovTalkDetails
+          xml.Body do
+            request_body(xml, request_type, request_data)
+          end
+        end
+      end
+      builder.doc
+    end
+
+    private
+
+    def header_namespace
+      {
+        'xmlns'              => "http://www.govtalk.gov.uk/CM/envelope",
+        'xmlns:dsig'         => "http://www.w3.org/2000/09/xmldsig#",
+        'xmlns:gt'           => "http://www.govtalk.gov.uk/CM/core",
+        'xmlns:xsi'          => "http://www.w3.org/2001/XMLSchema-instance",
+        'xsi:schemaLocation' => "http://www.govtalk.gov.uk/CM/envelope " +
+                                "http://xmlgw.companieshouse.gov.uk/v1-1/schema/Egov_ch-v2-0.xsd"
+      }
+    end
+
+    def message_details(xml, request_type, transaction_id)
+      xml.MessageDetails do
+        xml.Class request_type
+        xml.Qualifier "request"
+        xml.TransactionID transaction_id
+      end
+    end
+
+    def authentication(xml, transaction_id)
+      xml.SenderDetails do
+        xml.IDAuthentication do
+          xml.SenderID @config[:sender_id]
+          xml.Authentication do
+            xml.Method "CHMD5"
+            xml.Value create_digest(transaction_id)
+          end
+        end
+        xml.EmailAddress @config[:email] if @config[:email]
+      end
+    end
+
+    def request_body(xml, request_type, search_data)
+      xml.send("#{request_type}Request", request_namespace(request_type)) do
+        search_data.each do |key, value|
+          if value
+            element_name = Util.camelize(key).sub(/Id\z/, "ID")
+            xml.send(element_name, value)
+          end
+        end
+      end
+    end
+
+    def request_namespace(request_type)
+      {
+        'xmlns:xsi'          => "http://www.w3.org/2001/XMLSchema-instance",
+        'xsi:schemaLocation' => "http://xmlgw.companieshouse.gov.uk/v1-0/schema " +
+                                "http://xmlgw.companieshouse.gov.uk/v1-0/schema/#{request_type}.xsd"
+      }
+    end
+
+    def create_digest(transaction_id)
+      creds = "#{@config[:sender_id]}#{@config[:password]}#{transaction_id}"
+      Digest::MD5.hexdigest(creds)
+    end
+  end
+end

data/lib/companies_house_gateway/util.rb

@@ -0,0 +1,20 @@
+module CompaniesHouseGateway
+  module Util
+    extend self
+    # String helper
+    def camelize(str)
+      str.to_s.split('_').map(&:capitalize).join
+    end
+
+    def underscore(str)
+      str.to_s.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+    end
+
+    def demodulize(str)
+      str.to_s.split('::').last
+    end
+  end
+end

data/lib/companies_house_gateway/version.rb

@@ -0,0 +1,3 @@
+module CompaniesHouseGateway
+  VERSION = '0.2.0'.freeze
+end

data/spec/checks/company_appointments_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe CompaniesHouseGateway::Checks::CompanyAppointments do
+  describe "#perform" do
+    let(:check_data) do
+      { company_name: "GoCardless",
+        company_number: "07495895",
+        user_reference: 1 }
+    end
+
+    it_behaves_like "it generates_valid_xml"
+    it_behaves_like "it validates presence", :company_number
+    it_behaves_like "it validates presence", :company_name
+    it_behaves_like "it validates presence", :user_reference
+  end
+end

data/spec/checks/company_details_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe CompaniesHouseGateway::Checks::CompanyDetails do
+  describe "#perform" do
+    let(:check_data) { { company_number: "07495895" } }
+
+    it_behaves_like "it generates_valid_xml"
+    it_behaves_like "it validates presence", :company_number
+  end
+end

data/spec/checks/document_info_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe CompaniesHouseGateway::Checks::DocumentInfo do
+  describe "#perform" do
+    let(:check_data) do
+      { company_number: "07495895",
+        company_name: "GoCardless",
+        image_key: "asd121a" }
+    end
+
+    it_behaves_like "it generates_valid_xml"
+    it_behaves_like "it validates presence", :company_name
+    it_behaves_like "it validates presence", :company_number
+    it_behaves_like "it validates presence", :image_key
+  end
+end

data/spec/checks/document_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe CompaniesHouseGateway::Checks::Document do
+  describe "#perform" do
+    let(:check_data) { { doc_request_key: "als123lkj123", user_reference: 1 } }
+
+    it_behaves_like "it generates_valid_xml"
+    it_behaves_like "it validates presence", :doc_request_key
+    it_behaves_like "it validates presence", :user_reference
+  end
+end

data/spec/checks/filing_history_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe CompaniesHouseGateway::Checks::FilingHistory do
+  describe "#perform" do
+    let(:check_data) { { company_number: "07495895" } }
+
+    it_behaves_like "it generates_valid_xml"
+    it_behaves_like "it validates presence", :company_number
+  end
+end

data/spec/checks/mortgages_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe CompaniesHouseGateway::Checks::Mortgages do
+  describe "#perform" do
+    let(:check_data) do
+      { company_name: "GoCardless",
+        company_number: "07495895",
+        user_reference: "asd121a" }
+    end
+
+    it_behaves_like "it generates_valid_xml"
+    it_behaves_like "it validates presence", :company_name
+    it_behaves_like "it validates presence", :company_number
+    it_behaves_like "it validates presence", :user_reference
+  end
+end

data/spec/checks/name_search_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe CompaniesHouseGateway::Checks::NameSearch do
+  describe "#perform" do
+    let(:check_data) { { company_name: "GoCardless", data_set: "LIVE" } }
+
+    it_behaves_like "it generates_valid_xml"
+    it_behaves_like "it validates presence", :company_name
+  end
+end

data/spec/checks/number_search_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe CompaniesHouseGateway::Checks::NumberSearch do
+  describe "#perform" do
+    let(:check_data) { { partial_company_number: "123", data_set: "LIVE" } }
+
+    it_behaves_like "it generates_valid_xml"
+    it_behaves_like "it validates presence", :partial_company_number
+  end
+end

data/spec/checks/officer_details_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe CompaniesHouseGateway::Checks::OfficerDetails do
+  describe "#perform" do
+    let(:check_data) { { person_id: "alsdkj123", user_reference: 1 } }
+
+    it_behaves_like "it generates_valid_xml"
+    it_behaves_like "it validates presence", :person_id
+    it_behaves_like "it validates presence", :user_reference
+  end
+end

data/spec/checks/officer_search_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe CompaniesHouseGateway::Checks::OfficerSearch do
+  describe "#perform" do
+    let(:check_data) { { surname: "Baker", officer_type: "DIS" } }
+
+    it_behaves_like "it generates_valid_xml"
+    it_behaves_like "it validates presence", :surname
+    it_behaves_like "it validates presence", :officer_type
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+shared_examples "it delegates to the check" do |method_name|
+  it "delegates #{method_name} to " +
+     "#{CompaniesHouseGateway::Util.camelize(method_name)}" do
+    expect_any_instance_of(CompaniesHouseGateway::Checks.
+      const_get(CompaniesHouseGateway::Util.camelize(method_name))).
+      to receive(:perform).once
+    client.send(method_name, {})
+  end
+end
+
+describe CompaniesHouseGateway::Client do
+  let(:client) { CompaniesHouseGateway::Client.new(config) }
+  let(:config) { CompaniesHouseGateway::Config.new }
+
+  describe "#new" do
+    context "without a config" do
+      before { configure_companies_house_gateway }
+      subject(:new_client) { CompaniesHouseGateway::Client.new }
+
+      its(:config) { should_not == CompaniesHouseGateway.config }
+      it "has the attributes of the global config" do
+        new_client.config[:sender_id] ==
+          CompaniesHouseGateway.config[:sender_id]
+      end
+    end
+
+    context "with a config" do
+      before { config[:first_name] = "test" }
+      subject(:new_client) { CompaniesHouseGateway::Client.new(config) }
+
+      its(:config) { should_not == config }
+      it "has the attributes of the passed in config" do
+        new_client.config[:sender_id] == config[:sender_id]
+      end
+    end
+  end
+
+  describe "#perform_check" do
+    it "delegates to an instance of Request" do
+      expect_any_instance_of(CompaniesHouseGateway::Request).
+        to receive(:perform).once
+      client.perform_check({})
+    end
+  end
+
+  it_behaves_like "it delegates to the check", :name_search
+  it_behaves_like "it delegates to the check", :number_search
+  it_behaves_like "it delegates to the check", :company_appointments
+  it_behaves_like "it delegates to the check", :company_details
+  it_behaves_like "it delegates to the check", :officer_search
+  it_behaves_like "it delegates to the check", :officer_details
+  it_behaves_like "it delegates to the check", :mortgages
+  it_behaves_like "it delegates to the check", :filing_history
+  it_behaves_like "it delegates to the check", :document_info
+  it_behaves_like "it delegates to the check", :document
+end

data/spec/companies_house_gateway_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+shared_examples "it delegates to the client" do |method_name|
+  before { configure_companies_house_gateway }
+  let(:data) { "data" }
+
+  it "delegates #{method_name} to the client" do
+    CompaniesHouseGateway::Client.any_instance.
+      should_receive(method_name).with(data)
+    CompaniesHouseGateway.send(method_name, data)
+  end
+end
+
+describe CompaniesHouseGateway do
+  before { CompaniesHouseGateway.instance_variable_set(:@config, nil) }
+
+  describe '#configure' do
+    subject { CompaniesHouseGateway.config }
+    CompaniesHouseGateway::Config::DEFAULT_OPTIONS.keys.each do |key|
+      context "setting #{key}" do
+        before do
+          CompaniesHouseGateway.configure { |config| config[key] = key }
+        end
+        its([key]) { should == key }
+      end
+    end
+  end
+
+  describe "#config" do
+    subject(:config) { CompaniesHouseGateway.config }
+
+    it "raises an error if CompaniesHouseGateway hasn't been configured" do
+      expect { config }.
+        to raise_error CompaniesHouseGateway::CompaniesHouseGatewayError
+    end
+  end
+
+  it_behaves_like "it delegates to the client", :perform_check
+  it_behaves_like "it delegates to the client", :name_search
+  it_behaves_like "it delegates to the client", :number_search
+  it_behaves_like "it delegates to the client", :company_appointments
+  it_behaves_like "it delegates to the client", :company_details
+  it_behaves_like "it delegates to the client", :officer_search
+  it_behaves_like "it delegates to the client", :officer_details
+  it_behaves_like "it delegates to the client", :mortgages
+  it_behaves_like "it delegates to the client", :filing_history
+  it_behaves_like "it delegates to the client", :document_info
+  it_behaves_like "it delegates to the client", :document
+end