companies-house 0.0.5 → 0.0.6

data/CHANGELOG

@@ -1,3 +1,5 @@
+v0.0.6. now raise CompaniesHouse::Exception if response XML contains error
+
 v0.0.5. now sic_codes.sic_texts always returns array
 
 v0.0.4. cleaned up gem dependencies

data/Manifest

@@ -15,5 +15,3 @@ README
 README.rdoc
 spec/lib/companies_house/request_spec.rb
 spec/lib/companies_house_spec.rb
-spec/spec.opts
-spec/spec_helper.rb

data/companies-house.gemspec

@@ -2,16 +2,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{companies-house}
-  s.version = "0.0.5"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rob McKinnon"]
-  s.date = %q{2010-10-20}
+  s.date = %q{2010-10-22}
   s.description = %q{Ruby API to UK Companies House XML Gateway.
 }
   s.email = ["rob ~@nospam@~ rubyforge.org"]
   s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README"]
-  s.files = ["CHANGELOG", "companies-house.yml.example", "init.rb", "lib/companies_house/company_details.haml", "lib/companies_house/exception.rb", "lib/companies_house/name_search.haml", "lib/companies_house/number_search.haml", "lib/companies_house/request.haml", "lib/companies_house/request.rb", "lib/companies_house.rb", "LICENSE", "Manifest", "Rakefile", "README", "README.rdoc", "spec/lib/companies_house/request_spec.rb", "spec/lib/companies_house_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "companies-house.gemspec"]
+  s.files = ["CHANGELOG", "companies-house.yml.example", "init.rb", "lib/companies_house/company_details.haml", "lib/companies_house/exception.rb", "lib/companies_house/name_search.haml", "lib/companies_house/number_search.haml", "lib/companies_house/request.haml", "lib/companies_house/request.rb", "lib/companies_house.rb", "LICENSE", "Manifest", "Rakefile", "README", "README.rdoc", "spec/lib/companies_house/request_spec.rb", "spec/lib/companies_house_spec.rb", "companies-house.gemspec"]
   s.homepage = %q{}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Companies-house", "--main", "README", "--inline-source"]
   s.require_paths = ["lib"]

data/lib/companies_house.rb

@@ -14,7 +14,7 @@ require File.dirname(__FILE__) + '/companies_house/exception'
 $KCODE = 'UTF8' unless RUBY_VERSION >= "1.9"
 
 module CompaniesHouse
-  VERSION = "0.0.5" unless defined? CompaniesHouse::VERSION
+  VERSION = "0.0.6" unless defined? CompaniesHouse::VERSION
 
   class << self
 
@@ -83,9 +83,40 @@ module CompaniesHouse
 
     def objectify response_xml
       doc = Hpricot.XML(response_xml)
-      xml = doc.at('Body')
-      if xml && xml.children.select(&:elem?).size > 0
-        xml = xml.children.select(&:elem?).first.to_s
+      qualifier = doc.at('Qualifier')
+      if qualifier && qualifier.inner_text.to_s[/error/]
+        raise_error doc
+      else
+        body = doc.at('Body')
+        if body && body.children.select(&:elem?).size > 0
+          objectify_body body
+        else
+          nil
+        end
+      end
+    end
+
+    private
+
+      def add_to_message attribute, error, message, suffix=''
+        if value = error.at(attribute)
+          message << "#{value.inner_text}#{suffix}"
+        end
+      end
+
+      def raise_error doc
+        message = []
+        if error = doc.at('Error')
+          add_to_message 'RaisedBy', error, message
+          add_to_message 'Type', error, message
+          add_to_message 'Number', error, message, ':'
+          add_to_message 'Text', error, message
+        end
+        raise CompaniesHouse::Exception.new(message.join(' '))
+      end
+
+      def objectify_body body
+        xml = body.children.select(&:elem?).first.to_s
         hash = Hash.from_xml(xml)
         object = Morph.from_hash(hash, CompaniesHouse)
         if object && object.class.name == 'CompaniesHouse::CompanyDetails'
@@ -101,12 +132,7 @@ module CompaniesHouse
           end
         end
         object
-      else
-        nil
       end
-    end
-
-    private
 
       def get_response(data, root_element='NameSearch')
         begin

data/spec/lib/companies_house_spec.rb

@@ -3,37 +3,89 @@ require File.dirname(__FILE__) + '/../spec_helper.rb'
 describe CompaniesHouse do
 
   describe 'when objectifying xml' do
-    it 'should return an instance of CompaniesHouse::CompanyDetails' do
-      xml = '<Body><company_details><company_name>£IBRA FINANCIAL SERVICES LIMITED</company_name></company_details></Body>'
-      object = CompaniesHouse.objectify xml
-      object.class.name.should == 'CompaniesHouse::CompanyDetails'
-    end
-    describe 'and xml contains expanded unicode' do
-      it 'should convert to utf8' do
+    describe 'and xml contains response in Body' do
+      it 'should return an instance of CompaniesHouse::CompanyDetails' do
         xml = '<Body><company_details><company_name>£IBRA FINANCIAL SERVICES LIMITED</company_name></company_details></Body>'
         object = CompaniesHouse.objectify xml
-        object.company_name.should == "£IBRA FINANCIAL SERVICES LIMITED"
+        object.class.name.should == 'CompaniesHouse::CompanyDetails'
       end
-    end
-    describe 'and xml contains single sic_text' do
-      it 'should convert to sic_code sic_texts' do
-        xml = '<Body><company_details><sic_codes><sic_text>9261 - Operate sports arenas &amp; stadiums</sic_text></sic_codes></company_details></Body>'
+      describe 'and xml contains expanded unicode' do
+        it 'should convert to utf8' do
+          xml = '<Body><company_details><company_name>£IBRA FINANCIAL SERVICES LIMITED</company_name></company_details></Body>'
+          object = CompaniesHouse.objectify xml
+          object.company_name.should == "£IBRA FINANCIAL SERVICES LIMITED"
+        end
+      end
+      describe 'and xml contains single sic_text' do
+        it 'should convert to sic_code sic_texts' do
+          xml = '<Body><company_details><sic_codes><sic_text>9261 - Operate sports arenas &amp; stadiums</sic_text></sic_codes></company_details></Body>'
 
-        object = CompaniesHouse.objectify xml
-        object.sic_codes.sic_text.should == '9261 - Operate sports arenas & stadiums'
-        object.sic_codes.sic_texts.should == ['9261 - Operate sports arenas & stadiums']
+          object = CompaniesHouse.objectify xml
+          object.sic_codes.sic_text.should == '9261 - Operate sports arenas & stadiums'
+          object.sic_codes.sic_texts.should == ['9261 - Operate sports arenas & stadiums']
+        end
+      end
+      describe 'and xml contains no sic_text' do
+        it 'should return empty sic_code sic_texts' do
+          xml = '<Body><company_details><sic_codes></sic_codes></company_details></Body>'
+          object = CompaniesHouse.objectify xml
+          object.sic_codes.sic_texts.should == []
+        end
+        it 'should return empty sic_code sic_texts again' do
+          xml = '<Body><company_details><sic_codes><sic_text></sic_text></sic_codes></company_details></Body>'
+          object = CompaniesHouse.objectify xml
+          object.sic_codes.sic_texts.should == []
+        end
       end
     end
-    describe 'and xml contains no sic_text' do
-      it 'should return empty sic_code sic_texts' do
-        xml = '<Body><company_details><sic_codes></sic_codes></company_details></Body>'
-        object = CompaniesHouse.objectify xml
-        object.sic_codes.sic_texts.should == []
+
+    describe 'and xml contains Error' do
+      it 'should raise CompaniesHouse::Exception' do
+        xml = xml_error
+        lambda { CompaniesHouse.objectify xml }.should raise_error(CompaniesHouse::Exception)
       end
-      it 'should return empty sic_code sic_texts again' do
-        xml = '<Body><company_details><sic_codes><sic_text></sic_text></sic_codes></company_details></Body>'
-        object = CompaniesHouse.objectify xml
-        object.sic_codes.sic_texts.should == []
+
+      it 'should include error message in exception' do
+        xml = xml_error
+        lambda { CompaniesHouse.objectify xml }.should raise_error(CompaniesHouse::Exception, 'NameSearch fatal 503: Repeat/non-incremental Transaction ID sent with request - Rejecting')
+      end
+
+      def xml_error
+        %Q|<?xml version="1.0" encoding="UTF-8" ?>
+<GovTalkMessage xsi:schemaLocation="http://www.govtalk.gov.uk/schemas/govtalk/govtalkheader http://xmlgw.companieshouse.gov.uk/v1-0/schema/Egov_ch.xsd" xmlns="http://www.govtalk.gov.uk/schemas/govtalk/govtalkheader" xmlns:dsig="http://www.w3.org/2000/09/xmldsig#" xmlns:gt="http://www.govtalk.gov.uk/schemas/govtalk/core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
+  <EnvelopeVersion>1.0</EnvelopeVersion>
+  <Header>
+    <MessageDetails>
+      <Class>NameSearch</Class>
+      <Qualifier>error</Qualifier>
+      <TransactionID>1287070383</TransactionID>
+      <GatewayTimestamp>2010-10-14T16:33:04-00:00</GatewayTimestamp>
+    </MessageDetails>
+    <SenderDetails>
+      <IDAuthentication>
+        <SenderID>63884537357901904930357805221487</SenderID>
+        <Authentication>
+          <Method>CHMD5</Method>
+          <Value>3985a067aa3f4613adcf3589b420f4e2</Value>
+        </Authentication>
+      </IDAuthentication>
+    </SenderDetails>
+  </Header>
+  <GovTalkDetails>
+    <Keys/>
+	<GovTalkErrors>
+	  <Error>
+	    <RaisedBy>NameSearch</RaisedBy>
+	    <Number>503</Number>
+	    <Type>fatal</Type>
+	    <Text>Repeat/non-incremental Transaction ID sent with request - Rejecting</Text>
+	    <Location></Location>
+	  </Error>
+	</GovTalkErrors>
+  </GovTalkDetails>
+  <Body>
+  </Body>
+</GovTalkMessage>|
       end
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: companies-house
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Rob McKinnon
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-20 00:00:00 +01:00
+date: 2010-10-22 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -96,8 +96,6 @@ files:
 - README.rdoc
 - spec/lib/companies_house/request_spec.rb
 - spec/lib/companies_house_spec.rb
-- spec/spec.opts
-- spec/spec_helper.rb
 - companies-house.gemspec
 has_rdoc: true
 homepage: ""

data/spec/spec.opts

@@ -1,7 +0,0 @@
---color
---format
-progress
---loadby
-mtime
---reverse
---diff

data/spec/spec_helper.rb

@@ -1,9 +0,0 @@
-require 'rubygems'
-gem 'rspec'
-require 'spec'
-
-require File.dirname(__FILE__) + '/../lib/companies_house'
-
-def fixture(filename)
-  open("#{File.dirname(__FILE__)}/fixtures/#{filename}").read
-end