semantic-crawler 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Alex Oberhauser
+
+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,70 @@
+[ATTENTION]  This library is under heavy development and currently not working properly. Please be patient 
+             for a usable version.
+
+= SemanticCrawler
+
+This project encapsulates data gathering from different sources.
+It simplifies the extension of internal data with public available
+knowledge. The major strength is the use of semantic technology
+to bypass complex NLP (natural language processing).
+
+
+== Supported Sources
+
+* CIA Factbook RDF Dump, see http://www4.wiwiss.fu-berlin.de/factbook/directory/countries
+
+=== TODO
+
+* LinkedGeoData - LGD(see http://linkedgeodata.org)
+* Freebase
+* Geonames
+* DBPedia
+* Different Government Sources
+
+== Installation
+
+    $ git clone git://github.com/obale/semantic_crawler.git
+    $ cd semantic_crawler
+    $ bundle install
+    $ rake build
+    $ rake install pkg/semantic-crawler-*.gem
+
+If the library is stable enough it will be published at rubygems.org. That simplifies the installation.
+
+You can add this library also as dependency in your Gemfile:
+
+    gem "semantic-crawler", :git => "git://github.com/obale/semantic_crawler.git"                   # for the master branch or
+    gem "semantic-crawler", :git => "git://github.com/obale/semantic_crawler.git", :tags => "xyz"   # for the xyz tag
+
+
+== Examples
+
+Fetch Factbook information about Austria:
+
+    >> require "semantic_crawler"
+    >> austria = SemanticCrawler::Factbook::Country.new("austria")
+    >> puts austria.background
+    >> puts austria.climate
+
+== Changelog
+
+see CHANGELOG.rdoc
+
+
+== Tested with
+
+* Ruby 1.8.7-p358 and Rails 3.2.2
+* Ruby 1.9.3-p125 and Rails 3.2.2
+
+
+== License
+
+(c) 2012 by Alex Oberhauser for {Sigimera}[http://www.sigimera.org],
+published under MIT license.
+
+== Warranty
+
+This software is provided "as is" and without any express or implied
+warranties, including, without limitation, the implied warranties of 
+merchantibility and fitness for a particular purpose.
+

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SemanticCrawler'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/semantic_crawler.rb

@@ -0,0 +1,13 @@
+require "httparty"
+
+module SemanticCrawler
+end
+
+# Freebase.com
+require "semantic_crawler/freebase/crawler"
+require "semantic_crawler/freebase/entity"
+require "semantic_crawler/freebase/country"
+
+# CIA Factbook RDF Dump
+require "semantic_crawler/factbook/country"
+

data/lib/semantic_crawler/factbook/country.rb

@@ -0,0 +1,124 @@
+require 'nokogiri'
+require 'open-uri'
+
+module SemanticCrawler
+    module Factbook
+        class Country
+            @@URI_PREFIX = "http://www4.wiwiss.fu-berlin.de/factbook/data/"
+
+            @@NAMESPACES = {
+                "factbook" => "http://www4.wiwiss.fu-berlin.de/factbook/ns#",
+                "rdfs" => "http://www.w3.org/2000/01/rdf-schema#",
+                "rdf" => "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+            }
+
+            attr_reader :country_name
+            attr_reader :url
+
+            # Get Country Information from the CIA Factbook. see
+            # http://www4.wiwiss.fu-berlin.de/factbook/
+            #
+            # Example:
+            #   >> austria = SemanticCrawler::Factbook::Country.new("austria")
+            #   >> puts austria.background
+            #
+            # Argumenst:
+            #   name: (String)
+            def initialize(new_country_name)
+                new_country_name.gsub!(" ", "_")
+                @country_name = new_country_name.downcase
+                @url = @@URI_PREFIX + @country_name
+                begin
+                    fetch_rdf
+                rescue => e
+                    puts "Not able to get country information, through exception: " + e
+                end
+            end
+
+            # Returns the country name (rdfs:label)
+            def name
+                get_rdfs_property("label", "/rdf:RDF/rdf:Description/factbook:landboundary/factbook:Country")
+            end
+
+            # Returns background information about the country
+            def background
+                get_factbook_property("background")
+            end
+
+            # Returns background information about the country
+            def population_total
+                get_factbook_property("population_total")
+            end
+
+            # Returns geographiccoordinates latitude 
+            def latitude
+                get_factbook_property("geographiccoordinates_latitude")
+            end
+
+            # Returns geographiccoordinates longitude
+            def longitude
+                get_factbook_property("geographiccoordinates_longitude")
+            end
+
+            # Returns landboundary
+            def landboundary
+                if !@doc.nil?
+                    @doc.xpath("//factbook:landboundary/rdf:Description/@rdf:about", @@NAMESPACES)
+                else
+                    @doc = Nokogiri::XML::Document.new
+                end
+            end
+
+            # Returns terrain description (human readable)
+            def terrain
+                get_factbook_property("terrain")
+            end
+
+            # Returns the total number of airports in the country
+            def airports_total
+                get_factbook_property("airports_total")
+            end
+
+            # Returns the number of helicopter airports
+            def heliports
+                get_factbook_property("heliports")
+            end
+
+            # Returns climate description (human readable)
+            def climate
+                get_factbook_property("climate")
+            end
+
+            # Returns location description (human readable)
+            def location
+                get_factbook_property("location")
+            end
+
+
+            # Abstract method that allows to fetch factbook properties via
+            # xpath
+            def get_factbook_property(property_name, prefix = "/" )
+                if !@doc.nil?
+                    @doc.xpath(prefix + "/factbook:" + property_name + "/text()", @@NAMESPACES)
+                else
+                    @doc = Nokogiri::XML::Document.new
+                end
+            end
+
+            # Abstract method that allows to fetch rdfs properties via
+            # xpath
+            def get_rdfs_property(property_name, prefix = "/")
+                if !@doc.nil?
+                    @doc.xpath(prefix + "/rdfs:" + property_name + "/text()", @@NAMESPACES)
+                else
+                    @doc = Nokogiri::XML::Document.new
+                end
+            end
+
+            private
+            def fetch_rdf
+                @doc = Nokogiri::XML(open(@url))
+            end
+        end
+    end
+end

data/lib/semantic_crawler/freebase/country.rb

@@ -0,0 +1,33 @@
+class SemanticCrawler::Freebase::Country < SemanticCrawler::Freebase::Entity
+    attr_accessor :input_name
+    attr_accessor :json_link
+
+    @@uri_prefix = "http://www.freebase.com/experimental/topic/standard/en/"
+
+    def initialize
+        @input_name = nil
+        @html_link = nil
+        @json_link = nil
+    end
+
+    # Get Country Information from freebase.com
+    #
+    # Example:
+    #   >> freebaseCrawler = SemanticCrawler::Freebase::Crawler.new
+    #   >> austria = freebaseCrawler.getCountry("Austria")
+    #   >> austria.get
+    #
+    # Argumenst:
+    #   options: (Hash)
+    #
+    #
+    def get(options={})
+        if !@input_name.nil?
+            @json_link = @@uri_prefix + @input_name
+            JSON(self.class.get(@json_link, options).body)["result"]
+        else
+            nil
+        end
+    end
+
+end

data/lib/semantic_crawler/freebase/crawler.rb

@@ -0,0 +1,21 @@
+module SemanticCrawler
+    module Freebase
+        class Crawler
+            # Returns a country object that contains all relevant
+            # information that could be extracted from freebase.com
+            #
+            # Example:
+            #   >> freebaseCrawler = SemanticCrawler::Freebase::Crawler.new
+            #   >> austria = freebaseCrawler.getCountry("Austria")
+            #
+            # Arguments:
+            #   countryName: (String)
+            #
+            def getCountry(countryName)
+                country = SemanticCrawler::Freebase::Country.new
+                country.input_name = countryName.downcase!
+                country
+            end
+        end
+    end
+end

data/lib/semantic_crawler/freebase/entity.rb

@@ -0,0 +1,3 @@
+class SemanticCrawler::Freebase::Entity
+    include HTTParty
+end

data/lib/semantic_crawler/version.rb

@@ -0,0 +1,3 @@
+module SemanticCrawler
+  VERSION = "0.0.2"
+end

data/lib/tasks/semantic_crawler_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :semantic_crawler do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.