companies-house-gateway 0.2.0

data/spec/request_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe CompaniesHouseGateway::Request do
+  let(:request) { CompaniesHouseGateway::Request.new(connection, config) }
+  let(:config) { CompaniesHouseGateway::Config.new }
+  let(:connection) do
+    CompaniesHouseGateway::Client.new(config).send(:connection)
+  end
+
+  let(:response_hash) { { status: status, body: body } }
+  let(:status) { 200 }
+  let(:body) { "<Results><Errors/></Results>" }
+  before { stub_request(:post, config[:api_endpoint]).to_return(response_hash) }
+
+  let(:request_type) { :name_search }
+  let(:request_data) { {} }
+
+  describe '#build_request_xml' do
+    subject(:request_xml) do
+      request.build_request_xml(request_type, request_data)
+    end
+    let(:xml_schema) { load_fixture('request.xsd') }
+    let(:xsd) { Nokogiri::XML::Schema(xml_schema) }
+
+    it "generates a valid XML request" do
+      xsd.validate(request_xml).should == []
+    end
+
+    context "with an email address" do
+      before { config[:email] = "grey@gocardless.com" }
+
+      it "generates a valid XML request" do
+        xsd.validate(request_xml).should == []
+      end
+    end
+  end
+
+  describe "#perform" do
+    subject(:perform_check) { request.perform(request_type, request_data) }
+
+    it "makes a get request" do
+      perform_check
+      a_request(:post, config[:api_endpoint]).should have_been_made
+    end
+
+    context "when the config[:raw] is true" do
+      before { config[:raw] = true }
+      it { should be_a Faraday::Response }
+      its(:body) { should be_a String }
+    end
+
+    context "when the config[:raw] is false" do
+      it { should be_a Hash }
+      it { should include "Results" }
+
+      context "errors" do
+        context "500" do
+          let(:status) { 500 }
+
+          it "wraps the error" do
+            expect { perform_check }.
+              to raise_error CompaniesHouseGateway::CompaniesHouseGatewayError
+          end
+        end
+
+        context "400" do
+          let(:status) { 400 }
+
+          it "wraps the error" do
+            expect { perform_check }.
+              to raise_error CompaniesHouseGateway::CompaniesHouseGatewayError
+          end
+        end
+      end
+    end
+  end
+end

data/spec/shared_examples.rb

@@ -0,0 +1,40 @@
+shared_examples 'it validates presence' do |property|
+  let(:client) { CompaniesHouseGateway::Client.new(config) }
+  let(:config) { CompaniesHouseGateway::Config.new }
+  subject(:perform_check) { described_class.new(client).perform(check_data) }
+
+  context "with a missing #{property}" do
+    before { check_data.delete(property) }
+
+    it "raises and error" do
+      expect { perform_check }.
+        to raise_error CompaniesHouseGateway::CompaniesHouseGatewayError
+    end
+  end
+end
+
+shared_examples 'it generates_valid_xml' do
+  let(:request) { CompaniesHouseGateway::Request.new(connection, config) }
+  let(:client) { CompaniesHouseGateway::Client.new(config) }
+  let(:config) { CompaniesHouseGateway::Config.new }
+  let(:connection) { client.send(:connection) }
+  let(:klass) { described_class.name.split("::").last }
+
+  let(:request_xml) do
+    builder = Nokogiri::XML::Builder.new do |xml|
+      request.send(:request_body, xml, klass, check_data)
+    end
+    builder.doc
+  end
+
+  let(:xsd_path) do
+    fixture_path('checks',
+                 "#{CompaniesHouseGateway::Util.underscore(klass)}.xsd")
+  end
+  let(:xsd_doc) { Nokogiri::XML(File.read(xsd_path), xsd_path) }
+  let(:xsd) { Nokogiri::XML::Schema.from_document(xsd_doc) }
+
+  it "generates a valid XML request" do
+    xsd.validate(request_xml).should == []
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'companies_house_gateway'
+require 'webmock/rspec'
+require 'shared_examples'
+RSpec.configure { |config| config.include WebMock::API }
+
+def configure_companies_house_gateway
+  CompaniesHouseGateway.configure { |config| config[:sender_id] = "Grey" }
+end
+
+def load_fixture(*filename)
+  File.open(fixture_path(filename)).read
+end
+
+def fixture_path(*filename)
+  File.join('spec', 'fixtures', *filename)
+end
+

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: companies-house-gateway
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Grey Baker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for the Companies House XML Gateway
+email:
+- grey@gocardless.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- companies_house_gateway.gemspec
+- lib/companies_house_gateway.rb
+- lib/companies_house_gateway/checks/check.rb
+- lib/companies_house_gateway/checks/company_appointments.rb
+- lib/companies_house_gateway/checks/company_details.rb
+- lib/companies_house_gateway/checks/document.rb
+- lib/companies_house_gateway/checks/document_info.rb
+- lib/companies_house_gateway/checks/filing_history.rb
+- lib/companies_house_gateway/checks/mortgages.rb
+- lib/companies_house_gateway/checks/name_search.rb
+- lib/companies_house_gateway/checks/number_search.rb
+- lib/companies_house_gateway/checks/officer_details.rb
+- lib/companies_house_gateway/checks/officer_search.rb
+- lib/companies_house_gateway/client.rb
+- lib/companies_house_gateway/config.rb
+- lib/companies_house_gateway/constants.rb
+- lib/companies_house_gateway/errors/companies_house_gateway_error.rb
+- lib/companies_house_gateway/request.rb
+- lib/companies_house_gateway/util.rb
+- lib/companies_house_gateway/version.rb
+- spec/checks/company_appointments_spec.rb
+- spec/checks/company_details_spec.rb
+- spec/checks/document_info_spec.rb
+- spec/checks/document_spec.rb
+- spec/checks/filing_history_spec.rb
+- spec/checks/mortgages_spec.rb
+- spec/checks/name_search_spec.rb
+- spec/checks/number_search_spec.rb
+- spec/checks/officer_details_spec.rb
+- spec/checks/officer_search_spec.rb
+- spec/client_spec.rb
+- spec/companies_house_gateway_spec.rb
+- spec/fixtures/checks/chbase.xsd
+- spec/fixtures/checks/company_appointments.xsd
+- spec/fixtures/checks/company_details.xsd
+- spec/fixtures/checks/document.xsd
+- spec/fixtures/checks/document_info.xsd
+- spec/fixtures/checks/filing_history.xsd
+- spec/fixtures/checks/mortgages.xsd
+- spec/fixtures/checks/name_search.xsd
+- spec/fixtures/checks/number_search.xsd
+- spec/fixtures/checks/officer_details.xsd
+- spec/fixtures/checks/officer_search.xsd
+- spec/fixtures/request.xsd
+- spec/request_spec.rb
+- spec/shared_examples.rb
+- spec/spec_helper.rb
+homepage: https://github.com/gocardless/companies-house-gateway-ruby
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the Companies House XML Gateway
+test_files:
+- spec/checks/company_appointments_spec.rb
+- spec/checks/company_details_spec.rb
+- spec/checks/document_info_spec.rb
+- spec/checks/document_spec.rb
+- spec/checks/filing_history_spec.rb
+- spec/checks/mortgages_spec.rb
+- spec/checks/name_search_spec.rb
+- spec/checks/number_search_spec.rb
+- spec/checks/officer_details_spec.rb
+- spec/checks/officer_search_spec.rb
+- spec/client_spec.rb
+- spec/companies_house_gateway_spec.rb
+- spec/fixtures/checks/chbase.xsd
+- spec/fixtures/checks/company_appointments.xsd
+- spec/fixtures/checks/company_details.xsd
+- spec/fixtures/checks/document.xsd
+- spec/fixtures/checks/document_info.xsd
+- spec/fixtures/checks/filing_history.xsd
+- spec/fixtures/checks/mortgages.xsd
+- spec/fixtures/checks/name_search.xsd
+- spec/fixtures/checks/number_search.xsd
+- spec/fixtures/checks/officer_details.xsd
+- spec/fixtures/checks/officer_search.xsd
+- spec/fixtures/request.xsd
+- spec/request_spec.rb
+- spec/shared_examples.rb
+- spec/spec_helper.rb