companies-house 0.0.2 → 0.0.3

data/CHANGELOG

@@ -1,3 +1,5 @@
+v0.0.3. can now set same_as, continuation_key, regression_key on name search request
+
 v0.0.2. better responses when errors occur
 
 v0.0.1. initial release

data/Rakefile

@@ -10,7 +10,7 @@ begin
     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.dependencies = ["hpricot >=0.6", "haml >=2.0.9", "activesupport >=2.0.2", "morph >=0.2.6", "unicode >=0.4.0"]
     # m.executable_pattern = 'bin/companies_house'
   end
 

data/companies-house.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{companies-house}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rob McKinnon"]
-  s.date = %q{2010-09-01}
+  s.date = %q{2010-10-20}
   s.description = %q{Ruby API to UK Companies House XML Gateway.
 }
   s.email = ["rob ~@nospam@~ rubyforge.org"]
@@ -28,16 +28,19 @@ Gem::Specification.new do |s|
       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.6"])
+      s.add_runtime_dependency(%q<unicode>, [">= 0.4.0"])
     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.6"])
+      s.add_dependency(%q<unicode>, [">= 0.4.0"])
     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.6"])
+    s.add_dependency(%q<unicode>, [">= 0.4.0"])
   end
 end

data/lib/companies_house.rb

@@ -11,8 +11,10 @@ require 'haml'
 require File.dirname(__FILE__) + '/companies_house/request'
 require File.dirname(__FILE__) + '/companies_house/exception'
 
+$KCODE = 'UTF8' unless RUBY_VERSION >= "1.9"
+
 module CompaniesHouse
-  VERSION = "0.0.2" unless defined? CompaniesHouse::VERSION
+  VERSION = "0.0.3" unless defined? CompaniesHouse::VERSION
 
   class << self
 
@@ -62,6 +64,7 @@ module CompaniesHouse
     end
 
     def create_transaction_id_and_digest
+      # transaction_id = (Time.now + 2.minutes - 17.seconds).to_i
       transaction_id = Time.now.to_i
       digest = Digest::MD5.hexdigest("#{sender_id}#{password}#{transaction_id}")
       return transaction_id, digest
@@ -107,6 +110,8 @@ module CompaniesHouse
           raise CompaniesHouse::Exception.new(e.class.name + ' ' + e.to_s)
         rescue SocketError => e
           raise CompaniesHouse::Exception.new(e.class.name + ' ' + e.to_s)
+        rescue Timeout::Error => e
+          raise CompaniesHouse::Exception.new(e.class.name + ' ' + e.to_s)
         end
       end
 

data/lib/companies_house/name_search.haml

@@ -2,4 +2,10 @@
   %NameSearchRequest{ :request_ns=>'' }
     %CompanyName= company_name
     %DataSet= data_set
+    - if same_as && same_as[/true/i]
+      %SameAs< true
     %SearchRows= search_rows
+    - if continuation_key
+      %ContinuationKey= continuation_key
+    - if regression_key
+      %RegressionKey= regression_key

data/lib/companies_house/request.rb

@@ -19,6 +19,9 @@ module CompaniesHouse
       def default options
         options[:search_rows] = 20 unless options.has_key?(:search_rows)
         options[:data_set] = 'LIVE' unless options.has_key?(:data_set)
+        options[:same_as] = nil unless options.has_key?(:same_as)
+        options[:continuation_key] = nil unless options.has_key?(:continuation_key)
+        options[:regression_key] = nil unless options.has_key?(:regression_key)
         options
       end
 
@@ -29,7 +32,7 @@ module CompaniesHouse
           :digest_method => CompaniesHouse.digest_method,
           :sender_id => CompaniesHouse.sender_id,
           :password => CompaniesHouse.password,
-          :email => CompaniesHouse.email,
+          :email => '',
           :transaction_id => transaction_id }.merge(options)
 
         render_request options[:request_type], template, params

data/spec/lib/companies_house/request_spec.rb

@@ -2,11 +2,68 @@ require File.dirname(__FILE__) + '/../../spec_helper.rb'
 
 describe CompaniesHouse::Request do
 
+  before do
+    @transaction_id = 123
+    @digest = '????'
+    @sender_id = 'XMLGatewayTestUserID'
+    @email = 'x@y'
+    CompaniesHouse.sender_id = @sender_id
+    CompaniesHouse.email = @email
+    CompaniesHouse.stub!(:create_transaction_id_and_digest).and_return [@transaction_id, @digest]
+
+    @name_search_type = 'NameSearch'
+    @company_name = 'millennium stadium plc'
+    @name_search_xml = expected_xml @name_search_type, %Q|<NameSearchRequest xmlns="http://xmlgw.companieshouse.gov.uk/v1-0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlgw.companieshouse.gov.uk/v1-0/schema/NameSearch.xsd">
+      <CompanyName>millennium stadium plc</CompanyName>
+      <DataSet>LIVE</DataSet>
+      <SearchRows>20</SearchRows>
+    </NameSearchRequest>|
+
+    @number_search_type = 'NumberSearch'
+    @company_number = '03176906'
+    @number_search_xml = expected_xml @number_search_type, %Q|<NumberSearchRequest xmlns="http://xmlgw.companieshouse.gov.uk/v1-0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlgw.companieshouse.gov.uk/v1-0/schema/NumberSearch.xsd">
+      <PartialCompanyNumber>#{@company_number}</PartialCompanyNumber>
+      <DataSet>LIVE</DataSet>
+      <SearchRows>20</SearchRows>
+    </NumberSearchRequest>|
+
+    @company_details_type = 'CompanyDetails'
+    @company_details_xml = expected_xml @company_details_type, %Q|<CompanyDetailsRequest xmlns="http://xmlgw.companieshouse.gov.uk/v1-0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlgw.companieshouse.gov.uk/v1-0/schema/CompanyDetails.xsd">
+      <CompanyNumber>#{@company_number}</CompanyNumber>
+      <GiveMortTotals>1</GiveMortTotals>
+    </CompanyDetailsRequest>|
+  end
+
   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.strip.should == @name_search_xml.strip
     end
+
+    describe "and same_as flag is set to true" do
+      it 'should create xml correctly' do
+        request_xml = CompaniesHouse::Request.name_search_xml :company_name => @company_name, :same_as => 'true'
+        request_xml.strip.should == @name_search_xml.gsub('      <DataSet>LIVE</DataSet>',"      <DataSet>LIVE</DataSet>\n      <SameAs>true</SameAs>").strip
+      end
+    end
+    describe "and same_as flag is set to false" do
+      it 'should create xml correctly' do
+        request_xml = CompaniesHouse::Request.name_search_xml :company_name => @company_name, :same_as => 'false'
+      request_xml.strip.should == @name_search_xml.strip
+      end
+    end
+    describe "and continuation_key is set" do
+      it 'should create xml correctly' do
+        request_xml = CompaniesHouse::Request.name_search_xml :company_name => @company_name, :continuation_key => '1234'
+        request_xml.strip.should == @name_search_xml.gsub('      <SearchRows>20</SearchRows>',"      <SearchRows>20</SearchRows>\n      <ContinuationKey>1234</ContinuationKey>").strip
+      end
+    end
+    describe "and regression_key is set" do
+      it 'should create xml correctly' do
+        request_xml = CompaniesHouse::Request.name_search_xml :company_name => @company_name, :regression_key => '4321'
+        request_xml.strip.should == @name_search_xml.gsub('      <SearchRows>20</SearchRows>',"      <SearchRows>20</SearchRows>\n      <RegressionKey>4321</RegressionKey>").strip
+      end
+    end
   end
 
   describe "when asked for number search request xml" do
@@ -18,6 +75,8 @@ describe CompaniesHouse::Request do
 
   describe "when asked for company details request xml" do
     it 'should create xml correctly' do
+      CompaniesHouse.email = ''
+      CompaniesHouse.email.should == ''
       request_xml = CompaniesHouse::Request.company_details_xml :company_number => @company_number
       request_xml.strip.should == @company_details_xml.strip
     end
@@ -41,7 +100,7 @@ describe CompaniesHouse::Request do
           <Value>#{@digest}</Value>
         </Authentication>
       </IDAuthentication>
-      <EmailAddress>#{@email}</EmailAddress>
+      <EmailAddress>#{}</EmailAddress>
     </SenderDetails>
   </Header>
   <GovTalkDetails>
@@ -53,36 +112,4 @@ describe CompaniesHouse::Request do
 </GovTalkMessage>|
   end
 
-  before do
-    @transaction_id = 123
-    @digest = '????'
-    @sender_id = 'XMLGatewayTestUserID'
-    @email = 'x@y'
-    CompaniesHouse.sender_id = @sender_id
-    CompaniesHouse.email = @email
-    CompaniesHouse.stub!(:create_transaction_id_and_digest).and_return [@transaction_id, @digest]
-
-    @name_search_type = 'NameSearch'
-    @company_name = 'millennium stadium plc'
-    @name_search_xml = expected_xml @name_search_type, %Q|<NameSearchRequest xmlns="http://xmlgw.companieshouse.gov.uk/v1-0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlgw.companieshouse.gov.uk/v1-0/schema/NameSearch.xsd">
-      <CompanyName>millennium stadium plc</CompanyName>
-      <DataSet>LIVE</DataSet>
-      <SearchRows>20</SearchRows>
-    </NameSearchRequest>|
-
-    @number_search_type = 'NumberSearch'
-    @company_number = '03176906'
-    @number_search_xml = expected_xml @number_search_type, %Q|<NumberSearchRequest xmlns="http://xmlgw.companieshouse.gov.uk/v1-0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlgw.companieshouse.gov.uk/v1-0/schema/NumberSearch.xsd">
-      <PartialCompanyNumber>#{@company_number}</PartialCompanyNumber>
-      <DataSet>LIVE</DataSet>
-      <SearchRows>20</SearchRows>
-    </NumberSearchRequest>|
-
-    @company_details_type = 'CompanyDetails'
-    @company_details_xml = expected_xml @company_details_type, %Q|<CompanyDetailsRequest xmlns="http://xmlgw.companieshouse.gov.uk/v1-0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlgw.companieshouse.gov.uk/v1-0/schema/CompanyDetails.xsd">
-      <CompanyNumber>#{@company_number}</CompanyNumber>
-      <GiveMortTotals>1</GiveMortTotals>
-    </CompanyDetailsRequest>|
-  end
-
 end

data/spec/lib/companies_house_spec.rb

@@ -2,67 +2,79 @@ require File.dirname(__FILE__) + '/../spec_helper.rb'
 
 describe CompaniesHouse do
 
-  before do
-    @sender_id = 'user'
-    @password = '???'
-    @email = 'email'
+  describe 'when objectifying xml' do
+    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
+  end
 
-    CompaniesHouse.sender_id = @sender_id
-    CompaniesHouse.password = @password
-    CompaniesHouse.email = @email
+  describe 'when calling public methods' do
+    before do
+      @sender_id = 'user'
+      @password = '???'
+      @email = 'email'
 
-    @company_name = 'millennium stadium plc'
-    @company_number = '03176906'
-    @request_xml = '<request/>'
-    @response_xml = '<response/>'
+      CompaniesHouse.sender_id = @sender_id
+      CompaniesHouse.password = @password
+      CompaniesHouse.email = @email
 
-    @transaction_id = 123
-    Time.stub!(:now).and_return(mock('time', :to_i => @transaction_id))
-    @digest = 'digest'
-  end
+      @company_name = 'millennium stadium plc'
+      @company_number = '03176906'
+      @request_xml = '<request/>'
+      @response_xml = '<response/>'
 
-  describe "when asked for credientials" do
-    it 'should return sender_id correctly' do
-      CompaniesHouse.sender_id.should == @sender_id
+      @transaction_id = 123
+      Time.stub!(:now).and_return(mock('time', :to_i => @transaction_id))
+      @digest = 'digest'
     end
-    it 'should return password correctly' do
-      CompaniesHouse.password.should == @password
-    end
-    it 'should return email correctly' do
-      CompaniesHouse.email.should == @email
+
+    describe "when asked for credientials" do
+      it 'should return sender_id correctly' do
+        CompaniesHouse.sender_id.should == @sender_id
+      end
+      it 'should return password correctly' do
+        CompaniesHouse.password.should == @password
+      end
+      it 'should return email correctly' do
+        CompaniesHouse.email.should == @email
+      end
     end
-  end
 
-  describe 'when asked for a transaction id and digest' do
-    it 'should create transaction id and digest correctly' do
-      Digest::MD5.should_receive(:hexdigest).with("#{@sender_id}#{@password}#{@transaction_id}").and_return @digest
-      transaction_id, digest = CompaniesHouse.create_transaction_id_and_digest
-      transaction_id.should == @transaction_id
-      digest.should == @digest
+    describe 'when asked for a transaction id and digest' do
+      it 'should create transaction id and digest correctly' do
+        Digest::MD5.should_receive(:hexdigest).with("#{@sender_id}#{@password}#{@transaction_id}").and_return @digest
+        transaction_id, digest = CompaniesHouse.create_transaction_id_and_digest
+        transaction_id.should == @transaction_id
+        digest.should == @digest
+      end
     end
-  end
 
-  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(:get_response).with(@request_xml).and_return @response_xml
-      CompaniesHouse.name_search(@company_name).should == @response_xml
+    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(:get_response).with(@request_xml).and_return @response_xml
+        CompaniesHouse.name_search(@company_name).should == @response_xml
+      end
     end
-  end
 
-  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(:get_response).with(@request_xml).and_return @response_xml
-      CompaniesHouse.number_search(@company_number).should == @response_xml
+    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(:get_response).with(@request_xml).and_return @response_xml
+        CompaniesHouse.number_search(@company_number).should == @response_xml
+      end
     end
-  end
 
-  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(:get_response).with(@request_xml).and_return @response_xml
-      CompaniesHouse.company_details(@company_number).should == @response_xml
+    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(:get_response).with(@request_xml).and_return @response_xml
+        CompaniesHouse.company_details(@company_number).should == @response_xml
+      end
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: companies-house
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Rob McKinnon
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-01 00:00:00 +01:00
+date: 2010-10-20 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -81,6 +81,22 @@ dependencies:
         version: 0.2.6
   type: :runtime
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: unicode
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :runtime
+  version_requirements: *id005
 description: |
   Ruby API to UK Companies House XML Gateway.