companies-house 0.0.9 → 0.1.0

data/CHANGELOG

@@ -1,3 +1,5 @@
+v0.1.0. allow overriding of default sender_id and password by passing options
+
 v0.0.9. fixes bug preventing multiple sic codes being returned in query response
 
 v0.0.8. use Nokogiri instead of Hpricot

data/companies-house.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{companies-house}
-  s.version = "0.0.9"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rob McKinnon"]
-  s.date = %q{2011-01-11}
+  s.date = %q{2011-04-11}
   s.description = %q{Ruby API to UK Companies House XML Gateway.
 }
   s.email = ["rob ~@nospam@~ rubyforge.org"]

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.9" unless defined? CompaniesHouse::VERSION
+  VERSION = "0.1.0" unless defined? CompaniesHouse::VERSION
 
   class << self
 
@@ -63,10 +63,9 @@ module CompaniesHouse
       'CHMD5'
     end
 
-    def create_transaction_id_and_digest
-      # transaction_id = (Time.now + 2.minutes - 17.seconds).to_i
+    def create_transaction_id_and_digest(options={})
       transaction_id = (Time.now.to_f * 100).to_i
-      digest = Digest::MD5.hexdigest("#{sender_id}#{password}#{transaction_id}")
+      digest = Digest::MD5.hexdigest("#{options[:sender_id] || sender_id}#{options[:password] || password}#{transaction_id}")
       return transaction_id, digest
     end
 

data/lib/companies_house/request.rb

@@ -27,7 +27,7 @@ module CompaniesHouse
 
       def create options={}
         template = options.delete(:template)
-        transaction_id, digest = CompaniesHouse.create_transaction_id_and_digest
+        transaction_id, digest = CompaniesHouse.create_transaction_id_and_digest(options)
         params = {:digest => digest,
           :digest_method => CompaniesHouse.digest_method,
           :sender_id => CompaniesHouse.sender_id,

data/spec/lib/companies_house/request_spec.rb

@@ -64,6 +64,12 @@ describe CompaniesHouse::Request do
         request_xml.strip.should == @name_search_xml.gsub('      <SearchRows>20</SearchRows>',"      <SearchRows>20</SearchRows>\n      <RegressionKey>4321</RegressionKey>").strip
       end
     end
+    describe "and sender_id and password given in options" do
+      it "should use given sender_id and password when creating transaction_id and digest" do
+        CompaniesHouse.should_receive(:create_transaction_id_and_digest).with(hash_including(:sender_id => 'foo123', :password => 'bar456'))
+        CompaniesHouse::Request.name_search_xml(:company_name => @company_name, :sender_id => 'foo123', :password => 'bar456')
+      end
+    end
   end
 
   describe "when asked for number search request xml" do
@@ -71,6 +77,13 @@ describe CompaniesHouse::Request do
       request_xml = CompaniesHouse::Request.number_search_xml :company_number => @company_number
       request_xml.strip.should == @number_search_xml.strip
     end
+    
+    describe "and sender_id and password given in options" do
+      it "should use given sender_id and password when creating transaction_id and digest" do
+        CompaniesHouse.should_receive(:create_transaction_id_and_digest).with(hash_including(:sender_id => 'foo123', :password => 'bar456'))
+        CompaniesHouse::Request.number_search_xml(:company_number => @company_number, :sender_id => 'foo123', :password => 'bar456')
+      end
+    end
   end
 
   describe "when asked for company details request xml" do
@@ -80,6 +93,13 @@ describe CompaniesHouse::Request do
       request_xml = CompaniesHouse::Request.company_details_xml :company_number => @company_number
       request_xml.strip.should == @company_details_xml.strip
     end
+    
+    describe "and sender_id and password given in options" do
+      it "should use given sender_id and password when creating transaction_id and digest" do
+        CompaniesHouse.should_receive(:create_transaction_id_and_digest).with(hash_including(:sender_id => 'foo123', :password => 'bar456'))
+        CompaniesHouse::Request.company_details_xml(:company_number => @company_number, :sender_id => 'foo123', :password => 'bar456')
+      end
+    end
   end
 
   def expected_xml request_type, body

data/spec/lib/companies_house_spec.rb

@@ -137,8 +137,15 @@ describe CompaniesHouse do
         transaction_id.should == @transaction_id
         digest.should == @digest
       end
+      
+      describe "and password and sender_id passed as options" do
+        it "should use in preference to class ones" do
+          Digest::MD5.should_receive(:hexdigest).with("foo1234bar4567#{@transaction_id}")# @digest
+          CompaniesHouse.create_transaction_id_and_digest(:sender_id => 'foo1234', :password => 'bar4567')
+        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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: companies-house
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 27
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 9
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors: 
 - Rob McKinnon
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-11 00:00:00 +00:00
+date: 2011-04-11 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency