whitepages 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-04-13
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,22 @@
+(LGPL version 3 - http://www.gnu.org/licenses/lgpl-3.0.txt)
+
+Copyright (c) 2008 Jason Goecke
+
+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/Manifest.txt

@@ -0,0 +1,25 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/whitepages.rb
+lib/whitepages/version.rb
+log/debug.log
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_helper.rb
+test/test_whitepages.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/README.txt

@@ -0,0 +1,61 @@
+= whitepages
+
+* http://whitepages.rubyforge.org
+
+== DESCRIPTION:
+
+The Whitepages Gem provides a library for consuming the web services provided by "Whitepages":http://www.whitepages.com. More information on the Developer API may be found "here":http://developer.whitepages.com/. This API may be used to lookup people by name as well as reverse lookups based on phone number or address.
+
+There are a couple of limitations to consider (refer to the Whitepages website for any changes):
+
+* Maximum of 1,500 calls per day per API key
+* Throttle set at 2 searches per second per API key
+
+== FEATURES/PROBLEMS:
+
+* TBD
+
+== SYNOPSIS:
+
+require 'rubygems'
+require 'whitepages'
+
+data = Whitepages.find_person({ "lastname" => "Smith", 
+                                "state" => "CO", 
+                                "api_key" => "your_key" })
+
+== REQUIREMENTS:
+
+* Requires these gems:
+	- rubigen 
+	- xmlsimple 
+	- rest_client
+
+== INSTALL:
+
+* sudo gem install whitepages
+
+== LICENSE:
+
+(LGPL version 3 - http://www.gnu.org/licenses/lgpl-3.0.txt)
+
+Copyright (c) 2008 Jason Goecke
+
+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/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,70 @@
+require 'whitepages/version'
+
+AUTHOR = 'FIXME full name'  # can also be an array of Authors
+EMAIL = "FIXME email"
+DESCRIPTION = "description of gem"
+GEM_NAME = 'whitepages' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'whitepages' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Whitepages::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'whitepages documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen xmlsimple rest_client].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/whitepages/version.rb

@@ -0,0 +1,9 @@
+module Whitepages #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/whitepages.rb

@@ -0,0 +1,85 @@
+# Author::    Jason Goecke  (mailto:dave@x.y)
+# Copyright:: Copyright (c) 2008 Jason Goecke
+# License::   LGPL v3 
+
+require 'rubygems'
+require 'rest_client'
+require 'xmlsimple'
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+#This module holds the methods for consuming the Whitepages API
+module Whitepages
+  
+  #Set our RESTful URLs for each of the methods
+  @base_url = "http://api.whitepages.com/"
+  @find_person_url = @base_url + "find_person/1.0/?"
+  @reverse_phone_url = @base_url + "reverse_phone/1.0/?"
+  @reverse_address_url = @base_url + "reverse_address/1.0/?"
+  
+  #Retrieves contact information about a person, such as a telephone number and address
+  #Accepts a hash:
+  # * firstname - First Name
+  # * lastname - Last Name (*REQUIRED*)
+  # * house - May take a range, in the form [start-end]
+  # * apt - Apartment
+  # * street - Street
+  # * city - City
+  # * state - State
+  # * zip - ZipCode/PostalCode
+  # * areacode - AreaCode
+  # * metro - Whether or not to expand the search to the metro area
+  # * api_key - The API key obtained from the Whitpages Developer website
+  #More details may be found here: http://developer.whitepages.com/docs/Methods/find_person
+  def self.find_person(options)
+    return XmlSimple.xml_in(RestClient.get(build_url(options, "find_person")))
+  end
+
+  #Retrieves contact information about a telephone number
+  #Accepts a hash:
+  # * phone - May be 7 digits if state provided otherwise 10 (*REQUIRED*)
+  # * state - Two digit code for the state
+  # * api_key - The API key obtained from the Whitpages Developer website
+  #More details may be found here: http://developer.whitepages.com/docs/Methods/reverse_phone
+  def self.reverse_phone(options)  
+    return XmlSimple.xml_in(RestClient.get(build_url(options, "reverse_phone")))
+  end
+  
+  #Retrieves contact information about the people at an address
+  # * house - May take a range, in the form [start-end]
+  # * apt - Apartment
+  # * street - Street (*REQUIRED*)
+  # * city - City
+  # * state - State
+  # * zip - ZipCode/PostalCode
+  # * areacode - AreaCode
+  # * api_key - The API key obtained from the Whitpages Developer website
+  #More details may be found here: http://developer.whitepages.com/docs/Methods/reverse_address
+  def self.reverse_address(options)
+    return XmlSimple.xml_in(RestClient.get(build_url(options, "reverse_address")))
+  end
+  
+  private 
+  
+  #Build the appropriate URL
+  def self.build_url(options, type)
+    case type
+    when "reverse_phone"
+      built_url = @reverse_phone_url
+    when "reverse_address"
+      built_url = @reverse_address_url
+    when "find_person"
+      built_url = @find_person_url
+    end
+    
+    options.each do |key,value|
+      if value != nil
+        built_url = built_url + key + "=" + value.gsub(' ', '%20') + ";"
+      end
+    end
+    
+    return built_url
+  end
+    
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/whitepages.rb'}"
+puts "Loading whitepages gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/txt2html

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+begin
+  require 'newgem'
+rescue LoadError
+  puts "\n\nGenerating the website requires the newgem RubyGem"
+  puts "Install: gem install newgem\n\n"
+  exit(1)
+end
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + '/../lib/whitepages/version.rb'
+
+version  = Whitepages::VERSION::STRING
+download = 'http://rubyforge.org/projects/whitepages'
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.html.erb')
+  
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.html.erb] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text = fsrc.read
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)