kdonovan-duns-lookup 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kali Donovan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,18 @@
+= duns-lookup
+
+This provides a small wrapper around the Dun & Bradstreet website to retrieve business information from DUNS numbers.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Kali Donovan. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "duns-lookup"
+    gem.summary = "DSL for looking up Dun & Bradstreet numbers (DUNS)"
+    gem.description = %Q{Provides a small wrapper around the Dun & Bradstreet website to retrieve business information from DUNS numbers.}
+    gem.email = "kali.donovan@gmail.com"
+    gem.homepage = "http://github.com/kdonovan/duns-lookup"
+    gem.authors = ["Kali Donovan"]
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "mechanize"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "duns-lookup #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/duns-lookup.rb

@@ -0,0 +1,99 @@
+class DunsError < Exception
+end
+
+class Duns
+# = Synopsis
+# The Duns library provides a small wrapper around the Dun & Bradstreet
+# website's advanced search functionality.  Currently it only implements
+# searching for company by DUNS number.
+#
+# == Example
+#  require 'rubygems'
+#  require 'kdonovan-duns-lookup'
+#
+#  Duns.lookup_duns('123456789')
+#     # => nil
+#  Duns.lookup_duns( *some_valid_number* )
+#     # => {:name => *a_name*, :address => *an_address*}
+
+  require 'rubygems'
+  require 'open-uri'
+  require 'mechanize'
+  
+  # D&B homepage URL
+  @@dnb_homepage = 'http://smallbusiness.dnb.com/'
+  
+  # The URI for D&B advanced search
+  @@dnb_advanced_search = 'https://smallbusiness.dnb.com/ePlatform/servlet/AdvancedCompanySearch?storeId=10001&catalogId=70001?storeId=10001&catalogId=70001'
+
+  # Our Mechanize agent
+  @@agent = WWW::Mechanize.new
+  @@agent.user_agent_alias = 'Windows IE 7'
+
+  ####
+  # Look up a given DUNS number in the D&B database.
+  # If the number is found, returns a hash with :name and :address keys.
+  # Otherwise, returns nil.
+  #  
+  def self.lookup_duns(number)
+    form = @@agent.get( @@dnb_advanced_search ).form('DunsSearchForm')
+    form.dunsNumber = enforce_duns_formatting(number)
+    page = @@agent.submit(form)
+    
+    extract_search_results(page)
+  end
+
+
+  ####
+  # Updates the internal URL used as the base for advanced searches.
+  # 
+  # The D&B website uses lots of extraneous (to us) URL params, and I have no idea what they all mean.
+  # If the base URL stops working, this method will try to set a new one by visiting the main page and
+  # finding & clicking an Advanced Search link.
+  # 
+  # This is mostly a precaution, but if searches stop working a good first bet would be to try running this
+  # method.  If search is still broken, something actually changed in the D&B HTML and we'll need to retool
+  # the gem.
+  #
+  def self.update_advanced_search_url
+    page = @@agent.get( @@dnb_homepage )
+    advanced_link = page.links.find{|l| l.text.match(/search/i) && l.uri.to_s.match(/AdvancedCompanySearch/)}
+    raise(DunsError, "Unable to find an advanced search link at: #{@@dnb_homepage}") if advanced_link.nil?
+    @@dnb_advanced_search = advanced_link.uri.to_s
+  end
+  
+  
+  protected
+  
+  # Given a search page, extract the results
+  def self.extract_search_results(page)
+    return nil if page.search('div.text-red').size > 0
+    
+    # Given a DUNS number search, we only expect one result.  For other search types (when/if implemented), loop over all TRs returned in this table
+    company_name    = extract_name( page.search("//table[@id='SearchResultsTable']//tr[1]/td[2]") )
+    company_address = extract_address( page.search("//table[@id='SearchResultsTable']//tr[1]/td[3]") )
+
+    {:name => company_name, :address => company_address}
+  end
+  
+  # Retrieve an address from the proper D&B HTML for the td element
+  def self.extract_address(td)
+    td.text.gsub(/\s{2,}/, ' ')
+  end
+  
+  # Retrieve a name from the proper D&B HTML for the td element
+  def self.extract_name(td)
+    raw_text = td.text.gsub(/\s{2,}/, ' ')
+    with_js = raw_text.match(/var companyName=escape(.+?)var companyAddr/)[1] # First get the surrounding js, to ensure we don't get confused by e.g. a ) in the company name
+
+    # Now we have e.g. >> ('NORTH TEXAS CIRCUIT BOARD CO., INC.'); << and we need to strip off the extraneous stuff
+    with_js[2..-5]
+  end
+  
+  # Strip out non-numeric characters, and raise error if remaining number is still invalid
+  def self.enforce_duns_formatting(orig_number)
+    number = orig_number.gsub(/\D/, '')
+    raise(DunsError, "Received invalid DUNS number (must be 9 digits): #{orig_number}") unless number.length == 9
+    return number
+  end
+end

data/spec/duns-lookup_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "DunsLookup" do
+  context "Searching by DUNS number" do
+    it "should raise an exception when invalid DUNS numbers are supplied" do
+      lambda { Duns.lookup_duns('123') }.should raise_error(DunsError)
+      lambda { Duns.lookup_duns('abcdefghi') }.should raise_error(DunsError)
+      lambda { Duns.lookup_duns('123abc---') }.should raise_error(DunsError)
+      lambda { Duns.lookup_duns('') }.should raise_error(DunsError)
+    end
+
+    it "should not raise an exception when a valid DUNS number is supplied" do
+      lambda { Duns.lookup_duns('123456789') }.should_not raise_error(DunsError)
+      lambda { Duns.lookup_duns('123 456 789') }.should_not raise_error(DunsError)
+      lambda { Duns.lookup_duns('123-456-789') }.should_not raise_error(DunsError)
+    end
+    
+    it "Returns no results where there shouldn't be any" do
+      Duns.lookup_duns('123456789').should be_nil
+    end
+  
+    it "Should properly extract company name and address when a valid result is found" do
+      results = Duns.lookup_duns('095444246')
+      results.should_not be_nil
+      results.should be_a_kind_of Hash
+      
+      results[:name].should == "NORTH TEXAS CIRCUIT BOARD CO., INC."
+      results[:address].should == "1501 W SHADY GROVE RD, GRAND PRAIRIE, TX"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'duns-lookup'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: kdonovan-duns-lookup
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Kali Donovan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-12 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Provides a small wrapper around nokogiri processing of the Dun & Bradstreet website to retrieve business information from DUN numbers.
+email: kali.donovan@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/duns-lookup.rb
+- spec/duns-lookup_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kdonovan/duns-lookup
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: DSL for looking up Dun & Bradstreet numbers (DUNs)
+test_files: 
+- spec/duns-lookup_spec.rb
+- spec/spec_helper.rb