companies-house 0.0.1 → 0.0.2

data/CHANGELOG

@@ -1 +1,3 @@
+v0.0.2. better responses when errors occur
+
 v0.0.1. initial release

data/Manifest

@@ -1,15 +1,19 @@
 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
-companies-house.yml.example
+README.rdoc
 spec/lib/companies_house/request_spec.rb
 spec/lib/companies_house_spec.rb
 spec/spec.opts
 spec/spec_helper.rb
-Manifest

data/README.rdoc

@@ -0,0 +1,32 @@
+Ruby API to UK Companies House XML Gateway.
+
+= Companies House XML Gateway
+
+The Companies House XML Gateway offers electronic access to a core range of
+company information from Companies House Databases. The service is accessible
+online over the internet by authorised XML Gateway customers.
+
+For more details about the Companies House XML Gateway, including how to become
+a registered user see: http://xmlgw.companieshouse.gov.uk/
+
+= Disclaimer
+
+The companies-house rubygem has been developed independently of Companies House.
+It is in no way authorized or supported by Companies House.
+
+= Example usage:
+
+Note usage requires you have a registered account with Companies House:
+http://xmlgw.companieshouse.gov.uk/faq.shtml#hdiafaxga
+
+ require 'rubygems'
+ require 'companies-house'
+
+ CompaniesHouse.sender_id = 'XMLGatewayTestUserID'
+ CompaniesHouse.password = 'password'
+
+ x = CompaniesHouse.name_search 'Canonical'
+
+ x = CompaniesHouse.number_search '05276648'
+
+ x = CompaniesHouse.company_details '05276648'

data/Rakefile

@@ -1,29 +1,29 @@
-require 'rubygems'; require 'spec'; require 'lib/companies_house'
-
-begin
-  require 'echoe'
-
-  Echoe.new("companies-house", CompaniesHouse::VERSION) do |m|
-    m.author = ["Rob McKinnon"]
-    m.email = ["rob ~@nospam@~ rubyforge.org"]
-    m.description = File.readlines("README").first
-    m.rubyforge_name = "companies-house"
-    m.rdoc_options << '--inline-source'
-    m.rdoc_pattern = ["README", "CHANGELOG", "LICENSE"]
-    m.dependencies = ["hpricot >=0.6", "haml >=2.0.9", "activesupport >=2.0.2", "morph >=0.2.4"]
-    # m.executable_pattern = 'bin/companies_house'
-  end
-
-rescue LoadError
-  puts "You need to install the echoe gem to perform meta operations on this gem"
-end
-
-desc "Open an irb session preloaded with this library"
-task :console do
-  sh "irb -rubygems -r ./lib/companies_house.rb"
-end
-
-desc "Run all examples with RCov"
-task :rcov do
-  sh '/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/bin/ruby -Ilib -S rcov --text-report  -o "coverage" -x "Library" spec/lib/**/*'
+require 'rubygems'; require 'spec'; require 'lib/companies_house'
+
+begin
+  require 'echoe'
+
+  Echoe.new("companies-house", CompaniesHouse::VERSION) do |m|
+    m.author = ["Rob McKinnon"]
+    m.email = ["rob ~@nospam@~ rubyforge.org"]
+    m.description = File.readlines("README").first
+    m.rubyforge_name = "companies-house"
+    m.rdoc_options << '--inline-source'
+    m.rdoc_pattern = ["README", "CHANGELOG", "LICENSE"]
+    m.dependencies = ["hpricot >=0.6", "haml >=2.0.9", "activesupport >=2.0.2", "morph >=0.2.6"]
+    # m.executable_pattern = 'bin/companies_house'
+  end
+
+rescue LoadError
+  puts "You need to install the echoe gem to perform meta operations on this gem"
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/companies_house.rb"
+end
+
+desc "Run all examples with RCov"
+task :rcov do
+  sh '/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/bin/ruby -Ilib -S rcov --text-report  -o "coverage" -x "Library" spec/lib/**/*'
 end

data/companies-house.gemspec

@@ -2,42 +2,42 @@
 
 Gem::Specification.new do |s|
   s.name = %q{companies-house}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rob McKinnon"]
-  s.date = %q{2009-03-16}
-  s.description = %q{Ruby API to UK Companies House XML Gateway.}
+  s.date = %q{2010-09-01}
+  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", "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", "Rakefile", "README", "companies-house.yml.example", "spec/lib/companies_house/request_spec.rb", "spec/lib/companies_house_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "Manifest", "companies-house.gemspec"]
-  s.has_rdoc = true
+  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.homepage = %q{}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Companies-house", "--main", "README", "--inline-source"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{companies-house}
-  s.rubygems_version = %q{1.3.1}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Ruby API to UK Companies House XML Gateway.}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
+    s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<hpricot>, [">= 0.6"])
       s.add_runtime_dependency(%q<haml>, [">= 2.0.9"])
       s.add_runtime_dependency(%q<activesupport>, [">= 2.0.2"])
-      s.add_runtime_dependency(%q<morph>, [">= 0.2.4"])
+      s.add_runtime_dependency(%q<morph>, [">= 0.2.6"])
     else
       s.add_dependency(%q<hpricot>, [">= 0.6"])
       s.add_dependency(%q<haml>, [">= 2.0.9"])
       s.add_dependency(%q<activesupport>, [">= 2.0.2"])
-      s.add_dependency(%q<morph>, [">= 0.2.4"])
+      s.add_dependency(%q<morph>, [">= 0.2.6"])
     end
   else
     s.add_dependency(%q<hpricot>, [">= 0.6"])
     s.add_dependency(%q<haml>, [">= 2.0.9"])
     s.add_dependency(%q<activesupport>, [">= 2.0.2"])
-    s.add_dependency(%q<morph>, [">= 0.2.4"])
+    s.add_dependency(%q<morph>, [">= 0.2.6"])
   end
 end

data/init.rb

@@ -0,0 +1,5 @@
+begin
+  require File.join(File.dirname(__FILE__), 'lib', 'companies_house') # From here
+rescue LoadError
+  require 'companies-house' # From gem
+end

data/lib/companies_house.rb

@@ -9,66 +9,50 @@ require 'hpricot'
 require 'haml'
 
 require File.dirname(__FILE__) + '/companies_house/request'
+require File.dirname(__FILE__) + '/companies_house/exception'
 
 module CompaniesHouse
-  VERSION = "0.0.1" unless defined? CompaniesHouse::VERSION
+  VERSION = "0.0.2" unless defined? CompaniesHouse::VERSION
 
   class << self
-    def name_search name
-      xml = CompaniesHouse::Request.name_search_xml :company_name=>name
-      post(xml)
-    end
 
-    def number_search number
-      xml = CompaniesHouse::Request.number_search_xml :company_number=>number
-      post(xml)
+    def name_search name, options={}
+      xml = CompaniesHouse::Request.name_search_xml options.merge(:company_name => name)
+      get_response(xml)
     end
 
-    def company_details number
-      xml = CompaniesHouse::Request.company_details_xml :company_number=>number
-      post(xml)
+    def number_search number, options={}
+      xml = CompaniesHouse::Request.number_search_xml options.merge(:company_number => number)
+      get_response(xml)
     end
 
-    def post(data)
-      begin
-        u = "http://xmlgw.companieshouse.gov.uk/v1-0/xmlgw/Gateway"
-        puts "Checking url #{u}"
-        url = URI.parse u
-        http = Net::HTTP.new(url.host, url.port)
-        res, body = http.post(url.path, data, {'Content-type'=>'text/xml;charset=utf-8'})
-        case res
-          when Net::HTTPSuccess, Net::HTTPRedirection
-            xml = res.body
-            doc = Hpricot.XML(xml)
-            xml = doc.at('Body')
-            xml = xml.children.select(&:elem?).first.to_s
-            hash = Hash.from_xml(xml)
-            Morph.from_hash(hash, CompaniesHouse)
-          else
-            raise res.inspect
-        end
-      rescue URI::InvalidURIError
-        raise "URI is no good: " + u
-      end
+    def company_details number, options={}
+      xml = CompaniesHouse::Request.company_details_xml options.merge(:company_number => number)
+      get_response(xml)
     end
 
     def sender_id= id
       @sender_id = id
     end
+
     def sender_id
       config_setup('.') if @sender_id.blank?
       @sender_id
     end
+
     def password= pw
       @password = pw
     end
+
     def password
       config_setup('.') if @password.blank?
       @password
     end
+
     def email= e
       @email = e
     end
+
     def email
       @email
     end
@@ -93,5 +77,38 @@ module CompaniesHouse
         self.email= config['email']
       end
     end
+
+    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
+        hash = Hash.from_xml(xml)
+        Morph.from_hash(hash, CompaniesHouse)
+      else
+        nil
+      end
+    end
+
+    private
+
+      def get_response(data, root_element='NameSearch')
+        begin
+          http = Net::HTTP.new("xmlgw.companieshouse.gov.uk", 80)
+          res, body = http.post("/v1-0/xmlgw/Gateway", data, {'Content-type'=>'text/xml;charset=utf-8'})
+          case res
+            when Net::HTTPSuccess, Net::HTTPRedirection
+              xml = res.body
+              objectify xml
+            else
+              raise CompaniesHouse::Exception.new(res.inspect.to_s)
+          end
+        rescue URI::InvalidURIError => e
+          raise CompaniesHouse::Exception.new(e.class.name + ' ' + e.to_s)
+        rescue SocketError => e
+          raise CompaniesHouse::Exception.new(e.class.name + ' ' + e.to_s)
+        end
+      end
+
   end
 end

data/lib/companies_house/company_details.haml

@@ -0,0 +1,4 @@
+%Body
+  %CompanyDetailsRequest{ :request_ns=>'' }
+    %CompanyNumber= company_number
+    %GiveMortTotals 1

data/lib/companies_house/exception.rb

@@ -0,0 +1,3 @@
+class CompaniesHouse::Exception < Exception
+end
+

data/spec/lib/companies_house/request_spec.rb

@@ -4,21 +4,21 @@ describe CompaniesHouse::Request do
 
   describe "when asked for name search request xml" do
     it 'should create xml correctly' do
-      request_xml = CompaniesHouse::Request.name_search_xml :company_name=> @company_name
+      request_xml = CompaniesHouse::Request.name_search_xml :company_name => @company_name
       request_xml.strip.should == @name_search_xml.strip
     end
   end
 
   describe "when asked for number search request xml" do
     it 'should create xml correctly' do
-      request_xml = CompaniesHouse::Request.number_search_xml :company_number=> @company_number
+      request_xml = CompaniesHouse::Request.number_search_xml :company_number => @company_number
       request_xml.strip.should == @number_search_xml.strip
     end
   end
 
   describe "when asked for company details request xml" do
     it 'should create xml correctly' do
-      request_xml = CompaniesHouse::Request.company_details_xml :company_number=> @company_number
+      request_xml = CompaniesHouse::Request.company_details_xml :company_number => @company_number
       request_xml.strip.should == @company_details_xml.strip
     end
   end

data/spec/lib/companies_house_spec.rb

@@ -45,7 +45,7 @@ describe CompaniesHouse do
   describe "when asked for name search request" do
     it 'should perform request correctly' do
       CompaniesHouse::Request.should_receive(:name_search_xml).with(:company_name=> @company_name).and_return @request_xml
-      CompaniesHouse.should_receive(:post).with(@request_xml).and_return @response_xml
+      CompaniesHouse.should_receive(:get_response).with(@request_xml).and_return @response_xml
       CompaniesHouse.name_search(@company_name).should == @response_xml
     end
   end
@@ -53,7 +53,7 @@ describe CompaniesHouse do
   describe "when asked for number search request" do
     it 'should perform request correctly' do
       CompaniesHouse::Request.should_receive(:number_search_xml).with(:company_number=> @company_number).and_return @request_xml
-      CompaniesHouse.should_receive(:post).with(@request_xml).and_return @response_xml
+      CompaniesHouse.should_receive(:get_response).with(@request_xml).and_return @response_xml
       CompaniesHouse.number_search(@company_number).should == @response_xml
     end
   end
@@ -61,7 +61,7 @@ describe CompaniesHouse do
   describe "when asked for company details request" do
     it 'should perform request correctly' do
       CompaniesHouse::Request.should_receive(:company_details_xml).with(:company_number=> @company_number).and_return @request_xml
-      CompaniesHouse.should_receive(:post).with(@request_xml).and_return @response_xml
+      CompaniesHouse.should_receive(:get_response).with(@request_xml).and_return @response_xml
       CompaniesHouse.company_details(@company_number).should == @response_xml
     end
   end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: companies-house
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Rob McKinnon
@@ -9,50 +15,75 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-16 00:00:00 +00:00
+date: 2010-09-01 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hpricot
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
         version: "0.6"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: haml
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 2
+        - 0
+        - 9
         version: 2.0.9
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: activesupport
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 0
+        - 2
         version: 2.0.2
-    version: 
+  type: :runtime
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: morph
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.2.4
-    version: 
-description: Ruby API to UK Companies House XML Gateway.
+        hash: 27
+        segments: 
+        - 0
+        - 2
+        - 6
+        version: 0.2.6
+  type: :runtime
+  version_requirements: *id004
+description: |
+  Ruby API to UK Companies House XML Gateway.
+
 email: 
 - rob ~@nospam@~ rubyforge.org
 executables: []
@@ -65,23 +96,29 @@ extra_rdoc_files:
 - README
 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
-- companies-house.yml.example
+- README.rdoc
 - spec/lib/companies_house/request_spec.rb
 - spec/lib/companies_house_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-- Manifest
 - companies-house.gemspec
 has_rdoc: true
 homepage: ""
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --line-numbers
@@ -94,23 +131,30 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 11
+      segments: 
+      - 1
+      - 2
       version: "1.2"
-  version: 
 requirements: []
 
 rubyforge_project: companies-house
-rubygems_version: 1.3.1
+rubygems_version: 1.3.7
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Ruby API to UK Companies House XML Gateway.
 test_files: []