free-scrape 0.1.0

data/History.txt

@@ -0,0 +1,12 @@
+=== 0.1.0 / 2008-09-29
+
+* Renamed freebase to free-scrape, in order to not conflict with the other
+  freebase gem from the freebaseapi project.
+
+=== 0.0.9 / 2008-09-28
+
+* Initial release.
+* Can request items from freebase.com using either a URL, an Item GUID or an
+  Item name.
+* Preserves tags and other freebase links.
+

data/Manifest.txt

@@ -0,0 +1,14 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/free_scrape.rb
+lib/free_scrape/item_link.rb
+lib/free_scrape/category.rb
+lib/free_scrape/item.rb
+lib/free_scrape/free_scrape.rb
+lib/free_scrape/version.rb
+tasks/spec.rb
+spec/item_spec.rb
+spec/free_scrape_spec.rb
+spec/spec_helper.rb

data/README.txt

@@ -0,0 +1,35 @@
+= FreeBase
+
+* http://freebase.rubyforge.org/
+* Postmodern (postmodern.mod3@gmail.com)
+
+== DESCRIPTION:
+
+A web-scraping interface to freebase.com, the open and shared database of the
+world's knowledge.
+
+== FEATURES/PROBLEMS:
+
+* Can request items from freebase.com using either a URL, an Item GUID or an
+  Item name.
+* Preserves tags and other freebase links.
+
+== EXAMPLES:
+
+  require 'free_scrape'
+
+  FreeScrape.item('Aphex Twin')
+  # => #<FreeScrape::Item:0xb73fdba0 ...>
+
+  FreeScrape.item('http://www.freebase.com/view/guid/9202a8c04000641f8000000003ac957f')
+  # => #<FreeScrape::Item:0xb73fe3dc ...>
+
+== REQUIREMENTS:
+
+* Hpricot
+* WWW::Mechanize
+
+== INSTALL:
+
+  $ sudo gem install free-scrape
+

data/Rakefile

@@ -0,0 +1,15 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './tasks/spec.rb'
+require './lib/free_scrape/version.rb'
+
+Hoe.new('free-scrape', FreeScrape::VERSION) do |p|
+  p.rubyforge_name = 'freebase'
+  p.remote_rdoc_dir = ''
+  p.developer('Postmodern Modulus III', 'postmodern.mod3@gmail.com')
+  p.extra_deps = ['hpricot', 'mechanize']
+end
+
+# vim: syntax=Ruby

data/lib/free_scrape.rb

@@ -0,0 +1,3 @@
+require 'free_scrape/item'
+require 'free_scrape/free_scrape'
+require 'free_scrape/version'

data/lib/free_scrape/category.rb

@@ -0,0 +1,33 @@
+module FreeScrape
+  class Category
+
+    # Name of the category
+    attr_reader :name
+
+    # Metadata associated with the category
+    attr_reader :metadata
+
+    #
+    # Creates a new Category object with the specified _name_.
+    #
+    def initialize(name)
+      @name = name
+      @metadata = {}
+    end
+
+    #
+    # Returns the metadata with the specified _name_.
+    #
+    def [](name)
+      @metadata[name]
+    end
+
+    #
+    # Returns the name of the category in +String+ form.
+    #
+    def to_s
+      @name.to_s
+    end
+
+  end
+end

data/lib/free_scrape/free_scrape.rb

@@ -0,0 +1,185 @@
+require 'free_scrape/item'
+require 'free_scrape/item_link'
+
+require 'www/mechanize'
+require 'hpricot'
+require 'open-uri'
+
+module FreeScrape
+  # Common proxy port
+  COMMON_PROXY_PORT = 8080
+
+  # Default language
+  DEFAULT_LANGUAGE = :en
+
+  #
+  # Returns the +Hash+ of proxy information.
+  #
+  def FreeScrape.proxy
+    @@free_scrape_proxy ||= {
+      :host => nil,
+      :port => COMMON_PROXY_PORT,
+      :user => nil,
+      :password => nil
+    }
+  end
+
+  #
+  # Creates a HTTP URI based from the given _proxy_info_ hash. The
+  # _proxy_info_ hash defaults to Web.proxy, if not given.
+  #
+  # _proxy_info_ may contain the following keys:
+  # <tt>:host</tt>:: The proxy host.
+  # <tt>:port</tt>:: The proxy port. Defaults to COMMON_PROXY_PORT,
+  #                  if not specified.
+  # <tt>:user</tt>:: The user-name to login as.
+  # <tt>:password</tt>:: The password to login with.
+  #
+  def FreeScrape.proxy_uri(proxy_info=FreeScrape.proxy)
+    if FreeScrape.proxy[:host]
+      return URI::HTTP.build(:host => FreeScrape.proxy[:host],
+                             :port => FreeScrape.proxy[:port],
+                             :userinfo => "#{FreeScrape.proxy[:user]}:#{FreeScrape.proxy[:password]}",
+                             :path => '/')
+    end
+  end
+  
+  #
+  # Returns the supported FreeScrape User-Agent Aliases.
+  #
+  def FreeScrape.user_agent_aliases
+    WWW::Mechanize::AGENT_ALIASES
+  end
+
+  #
+  # Returns the FreeScrape User-Agent
+  #
+  def FreeScrape.user_agent
+    @@free_scrape_user_agent ||= FreeScrape.user_agent_aliases['Windows IE 6']
+  end
+
+  #
+  # Sets the FreeScrape User-Agent to the specified _agent_.
+  #
+  def FreeScrape.user_agent=(agent)
+    @@free_scrape_user_agent = agent
+  end
+
+  #
+  # Sets the FreeScrape User-Agent using the specified user-agent alias
+  # _name_.
+  # 
+  def FreeScrape.user_agent_alias=(name)
+    @@free_scrape_user_agent = FreeScrape.user_agent_aliases[name.to_s]
+  end
+
+  #
+  # Opens the _uri_ with the given _options_. The contents of the _uri_
+  # will be returned.
+  #
+  # _options_ may contain the following keys:
+  # <tt>:user_agent_alias</tt>:: The User-Agent Alias to use.
+  # <tt>:user_agent</tt>:: The User-Agent String to use.
+  # <tt>:proxy</tt>:: A +Hash+ of proxy information which may
+  #                   contain the following keys:
+  #                   <tt>:host</tt>:: The proxy host.
+  #                   <tt>:port</tt>:: The proxy port.
+  #                   <tt>:user</tt>:: The user-name to login as.
+  #                   <tt>:password</tt>:: The password to login with.
+  #
+  #   FreeScrape.open_uri('http://www.hackety.org/')
+  #
+  #   FreeScrape.open_uri('http://tenderlovemaking.com/',
+  #     :user_agent_alias => 'Linux Mozilla')
+  #   FreeScrape.open_uri('http://www.wired.com/',
+  #     :user_agent => 'the future')
+  #
+  def FreeScrape.open_uri(uri,options={})
+    headers = {}
+
+    if options[:user_agent_alias]
+      headers['User-Agent'] = WWW::Mechanize::AGENT_ALIASES[options[:user_agent_alias]]
+    elsif options[:user_agent]
+      headers['User-Agent'] = options[:user_agent]
+    elsif FreeScrape.user_agent
+      headers['User-Agent'] = FreeScrape.user_agent
+    end
+
+    proxy = (options[:proxy] || FreeScrape.proxy)
+    if proxy[:host]
+      headers[:proxy] = FreeScrape.proxy_uri(proxy)
+    end
+
+    return Kernel.open(uri,headers)
+  end
+
+  #
+  # Similar to FreeScrape.open_uri but returns an Hpricot document.
+  #
+  def FreeScrape.open_page(uri,options={})
+    Hpricot(FreeScrape.open_uri(uri,options))
+  end
+
+  #
+  # Creates a new WWW::Mechanize agent with the given _options_.
+  #
+  # _options_ may contain the following keys:
+  # <tt>:user_agent_alias</tt>:: The User-Agent Alias to use.
+  # <tt>:user_agent</tt>:: The User-Agent string to use.
+  # <tt>:proxy</tt>:: A +Hash+ of proxy information which may
+  #                   contain the following keys:
+  #                   <tt>:host</tt>:: The proxy host.
+  #                   <tt>:port</tt>:: The proxy port.
+  #                   <tt>:user</tt>:: The user-name to login as.
+  #                   <tt>:password</tt>:: The password to login with.
+  #
+  #   FreeScrape.web_agent
+  #
+  #   FreeScrape.web_agent(:user_agent_alias => 'Linux Mozilla')
+  #   FreeScrape.web_agent(:user_agent => 'Google Bot')
+  #
+  def FreeScrape.web_agent(options={},&block)
+    agent = WWW::Mechanize.new
+
+    if options[:user_agent_alias]
+      agent.user_agent_alias = options[:user_agent_alias]
+    elsif options[:user_agent]
+      agent.user_agent = options[:user_agent]
+    elsif FreeScrape.user_agent
+      agent.user_agent = FreeScrape.user_agent
+    end
+
+    proxy = (options[:proxy] || FreeScrape.proxy)
+    if proxy[:host]
+      agent.set_proxy(proxy[:host],proxy[:port],proxy[:user],proxy[:password])
+    end
+
+    block.call(agent) if block
+    return agent
+  end
+
+  #
+  # Returns the language to access FreeScrape with.
+  #
+  def FreeScrape.language
+    @@free_scrape_language ||= DEFAULT_LANGUAGE
+  end
+
+  #
+  # Sets the language to access FreeScrape with to the _new_language_.
+  #
+  def FreeScrape.language=(new_language)
+    @@free_scrape_language = new_language.to_sym
+  end
+
+  #
+  # Returns the Item with the specified _descriptor_, which can be either
+  # a URI to freebase.com, an Item GUID or an Item name.
+  #
+  #   FreeScrape.item('Aphex Twin')
+  #   # => #<FreeScrape::Item:0xb73fdba0 ...>
+  #
+  def FreeScrape.item(descriptor)
+    Item.from(descriptor)
+  end
+end

data/lib/free_scrape/item.rb

@@ -0,0 +1,171 @@
+require 'free_scrape/item_link'
+require 'free_scrape/category'
+
+require 'uri'
+
+module FreeScrape
+  class Item
+
+    # URL of the item
+    attr_reader :url
+
+    # Name of the item
+    attr_accessor :name
+
+    # Description of the item
+    attr_accessor :summary
+
+    # Categories the item is in
+    attr_reader :categories
+
+    #
+    # Creates a new Item object with the specified _name_ and the given
+    # _options_.
+    #
+    def initialize(url,options={})
+      @url = url
+      @name = options[:name]
+      @summary = options[:summary]
+
+      @categories = {}
+    end
+
+    #
+    # Returns the Item object with the specified _descriptor_, which can
+    # be either a URI to freebase.com, an Item GUID or an Item name.
+    #
+    def Item.from(descriptor)
+      descriptor = descriptor.to_s
+
+      if descriptor =~ /^[0-9a-f]+$/
+        return Item.guid(descriptor)
+      elsif descriptor =~ /^http(s)?:\/\/(www\.)?freebase.com\/view/
+        return Item.from_url(descriptor)
+      else
+        return Item.named(descriptor)
+      end
+    end
+
+    #
+    # Returns the Item object with the specified _name_.
+    #
+    def Item.named(name)
+      name = name.split(' ').map { |word|
+        word.downcase
+      }.join('_')
+
+      return Item.from_url("http://www.freebase.com/view/#{FreeScrape.language}/#{name}")
+    end
+
+    #
+    # Returns the Item object with the specified _guid_.
+    #
+    def Item.guid(guid)
+      Item.from_url("http://www.freebase.com/view/guid/#{guid}")
+    end
+
+    #
+    # Creates the Item at the specified _url_.
+    #
+    #   Item.from_url('http://www.freebase.com/view/guid/9202a8c04000641f800000000301146f')
+    #   # => #<FreeScrape::Item:0xb73fdba0 ...>
+    #
+    def Item.from_url(url)
+      url = URI(url.to_s)
+      page = FreeScrape.open_page(url)
+      new_item = Item.new(url)
+
+      content = page.at('#content_main')
+
+      new_item.name = content.at('#title//h1').inner_text.strip
+      new_item.summary = content.at('#title/div.article-container/div.article').inner_html.strip
+
+      extract_value = lambda { |elem|
+        if (item_link = elem.at('a.pv'))
+          link_url = new_item.url.merge(item_link['href'])
+
+          ItemLink.new(item_link.inner_text.strip, link_url)
+        elsif elem.at('a.detail-view').nil?
+          text = elem.inner_text.strip
+
+          if text.empty?
+            nil
+          else
+            text
+          end
+        end
+      }
+
+      content.search('div.domainsboxes//div.domainbox//div.typebox-container') do |domainbox|
+        category_name = domainbox.at('//div.typebox-column-title/a').inner_text
+        new_category = Category.new(category_name)
+
+        domainbox.search('//div.prop-typebox') do |field|
+          field_name = field.at('//span.prop-title').inner_text
+          field_content = field.at('//div.prop-content')
+
+          field_value = nil
+
+          if (table = field_content.at('table.prop-table'))
+            field_value = []
+
+            column_names = table.search('tr/th/div.prop-table-cell').map do |div|
+              div.inner_text.strip
+            end
+
+            table.search('tr[td]') do |row|
+              field_row = {}
+              index = 0
+
+              row.search('td') do |cell|
+                if (value = extract_value.call(cell))
+                  field_row[column_names[index]] = value
+                end
+
+                index += 1
+              end
+
+              field_value << field_row unless field_row.empty?
+            end
+          elsif (list = field_content.at('ul.prop-list'))
+            field_value = []
+
+            list.search('li.prop-list-item') do |list_item|
+              if (value = extract_value.call(list_item))
+                field_value << value
+              end
+            end
+          end
+
+          new_category.metadata[field_name] = field_value
+        end
+
+        new_item.categories[new_category.name] = new_category
+      end
+
+      return new_item
+    end
+
+    #
+    # Returns the category names of the item.
+    #
+    def category_names
+      @categories.keys
+    end
+
+    #
+    # Returns the Category with the specified _name_ of the item.
+    #
+    def [](name)
+      @categories[name]
+    end
+
+    #
+    # Returns the name of the item.
+    #
+    def to_s
+      @name.to_s
+    end
+
+  end
+end

data/lib/free_scrape/item_link.rb

@@ -0,0 +1,26 @@
+module FreeScrape
+  class ItemLink
+
+    # Title of the item
+    attr_reader :title
+
+    # URL of the item
+    attr_reader :url
+
+    #
+    # Creates a new ItemLink with the specified _title_ and _url_.
+    #
+    def initialize(title,url)
+      @title = title
+      @url = url
+    end
+
+    #
+    # Returns the title of the item-link in +String+ form.
+    #
+    def to_s
+      @title.to_s
+    end
+
+  end
+end

data/lib/free_scrape/version.rb

@@ -0,0 +1,3 @@
+module FreeScrape
+  VERSION = '0.1.0'
+end

data/spec/free_scrape_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe FreeScrape do
+  it "should have a version" do
+    FreeScrape.const_get('VERSION').should_not be_nil
+  end
+
+  it "should have a default language" do
+    FreeScrape.language.should_not be_nil
+  end
+
+  it "should have a default User-Agent string" do
+    FreeScrape.user_agent.should_not be_nil
+  end
+
+  it "should return an item from a given URL" do
+    @item = FreeScrape.item('http://www.freebase.com/view/en/squarepusher/')
+    @item.should_not be_nil
+    @item.name.should == 'Squarepusher'
+  end
+
+  it "should return an item from a given GUID" do
+    @item = FreeScrape.item('9202a8c04000641f8000000000184c7a')
+    @item.should_not be_nil
+    @item.name.should == 'Conflict'
+  end
+
+  it "should return an item for a given title" do
+    @item = FreeScrape.item('Aphex Twin')
+    @item.should_not be_nil
+    @item.name.should == 'Aphex Twin'
+  end
+end

data/spec/item_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Item do
+  before(:all) do
+    @item = Item.from_url('http://www.freebase.com/view/en/aphex_twin')
+  end
+
+  it "should have a URL" do
+    @item.url.should_not be_nil
+  end
+
+  it "should have a name" do
+    @item.name.should_not be_nil
+    @item.name.should_not be_empty
+  end
+
+  it "should have categories" do
+    @item.categories.should_not be_empty
+  end
+
+  it "should have category names" do
+    @item.category_names.should_not be_empty
+  end
+
+  it "should have metadata for each category" do
+    @item.categories.each_value do |category|
+      category.metadata.should_not be_empty
+
+      category.metadata.each_value do |data|
+        data.should_not be_nil
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+gem 'rspec', '>=1.1.3'
+require 'spec'
+
+require 'free_scrape'
+
+include FreeScrape

data/tasks/spec.rb

@@ -0,0 +1,7 @@
+require 'spec/rake/spectask'
+
+desc "Run all specifications"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs += ['lib', 'spec']
+  t.spec_opts = ['--colour', '--format', 'specdoc']
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: free-scrape
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Postmodern Modulus III
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-29 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mechanize
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
+description: A web-scraping interface to freebase.com, the open and shared database of the world's knowledge.
+email: 
+- postmodern.mod3@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/free_scrape.rb
+- lib/free_scrape/item_link.rb
+- lib/free_scrape/category.rb
+- lib/free_scrape/item.rb
+- lib/free_scrape/free_scrape.rb
+- lib/free_scrape/version.rb
+- tasks/spec.rb
+- spec/item_spec.rb
+- spec/free_scrape_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://freebase.rubyforge.org/
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: freebase
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A web-scraping interface to freebase.com, the open and shared database of the world's knowledge.
+test_files: []
+