freebase-api 0.1

data/.gitignore

@@ -0,0 +1,4 @@
+/coverage/
+/.env
+/pkg/
+/doc/

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gem 'rake', '~> 10.0'
+
+group :test do
+  gem 'coveralls', :require => false
+  gem 'rspec', '~> 2.12'
+  gem 'yard', '~> 0.8'
+  gem 'rspec', '~> 2.12'
+  gem 'simplecov', '~> 0.7', :require => false
+  gem 'redcarpet', '~> 2.2'
+end
+
+# Specify your gem's dependencies in freebase-api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    freebase-api (0.1)
+      httparty (~> 0.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colorize (0.5.8)
+    coveralls (0.6.2)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
+    diff-lcs (1.2.1)
+    httparty (0.10.0)
+      multi_json (~> 1.0)
+      multi_xml
+    mime-types (1.21)
+    multi_json (1.6.1)
+    multi_xml (0.5.2)
+    rake (10.0.3)
+    redcarpet (2.2.2)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.0)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    thor (0.17.0)
+    yard (0.8.5.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls
+  freebase-api!
+  rake (~> 10.0)
+  redcarpet (~> 2.2)
+  rspec (~> 2.12)
+  simplecov (~> 0.7)
+  yard (~> 0.8)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Perfect Memory
+
+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.markdown

@@ -0,0 +1,204 @@
+# freebase-api [![Build Status](https://travis-ci.org/PerfectMemory/freebase-api.png?branch=master)](http://travis-ci.org/mongoid/mongoid) [![Coverage Status](https://coveralls.io/repos/PerfectMemory/freebase-api/badge.png?branch=master)](https://coveralls.io/r/PerfectMemory/freebase-api) [![Code Climate](https://codeclimate.com/github/PerfectMemory/freebase-api.png)](https://codeclimate.com/github/PerfectMemory/freebase-api) [![Dependency Status](https://gemnasium.com/PerfectMemory/freebase-api.png)](https://gemnasium.com/PerfectMemory/freebase-api)
+
+freebase-api provides access to both a raw-access and an abstract-layer to the [Freebase API](http://wiki.freebase.com/wiki/Freebase_API).
+
+Currently supported APIs are :
+
+- Search ([doc](https://developers.google.com/freebase/v1/search))
+- MQL Read ([doc](https://developers.google.com/freebase/v1/mqlread))
+- Topic ([doc](https://developers.google.com/freebase/v1/topic))
+- Image support
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'freebase-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself with:
+
+    $ gem install freebase-api
+
+## Session
+
+If you have a [Google API key](https://code.google.com/apis/console), you can set the environment variable `GOOGLE_API_KEY`, the default session will load it automatically.
+
+You can override the default session by providing some options, like the language or the environment.
+
+```ruby
+FreebaseAPI.session = FreebaseAPI::Session.new(key: 'GOOGLE_API_KEY', env: => :stable)
+```
+
+Options are :
+
+* `:key` : your Google API key
+* `:env` : the environment (sandbox or stable) (default is :stable)
+* `:query_options` : some options that will be used in each query
+ * `:limit` : the number of items returned (default is 10)
+ * `:lang` : the language you would like the content in (default is 'en')
+
+## Fetch resources
+
+The DSL of `freebase-api` is based on 3 main models :
+
+* **Topic** (used to store topics, types, CVTs)
+* **Attribute** (used to store value typed properties such as string, number, date)
+* **Image** (used to store image data)
+
+To access a specific resource on Freebase, you can use the `Topic` model which provides some useful methods. The `get` method is based on the `Topic API`.
+
+```ruby
+resource = FreebaseAPI::Topic.get('/en/github') # => #<FreebaseAPI::Topic:0x000000021a10d8>
+```
+
+Once the resource is fetched, you can access its properties :
+
+```ruby
+# id
+resource.id # => "/m/04g0kcw"
+
+# Name
+resource.name # => "GitHub"
+
+# Description
+resource.description # => "GitHub is a web-based hosting service for software dev..."
+
+# Types
+resource.types # => ["/common/topic", "/internet/website", "/base/technologyofdoing/proposal_agent"]
+
+# Properties
+resource.properties.size # => 18
+
+# Access a specific Property
+attribute = resource.property('/common/topic/official_website').first # => #<FreebaseAPI::Attribute:0x00000002008500>
+attribute.value # => "http://github.com/"
+
+types = resource.property('/type/object/type') # => #<FreebaseAPI::Topic:0x00000002009888>
+types.map(&:id) # => equivalent to resource.types
+
+types[1].name # => "Website"
+types[1].sync # fetch all the properties of this topic
+types[1].description # => "Website or (Web site) is a collection of web pages, typically common..."
+
+# Image
+image = property.image(maxwidth: 150, maxheight: 150) # => #<FreebaseAPI::Image:0x00000001fcd4c8>
+image.store('/path/to/filename') # record the image
+```
+
+## Search resources
+
+To search topics using a query, you can use `FreebaseAPI::Topic.search` that returns a Hash ordered by scores (keys). This method supports
+all the parameters of the official API.
+
+```
+results = FreebaseAPI::Topic.search('jackson') # => [100.55349=>#<FreebaseAPI::Topic:0x000000021e91d0>, 73.209366=>#<FreebaseAPI::Topic:0x000000021f01d8> ...]
+best_match = results.values.first # => #<FreebaseAPI::Topic:0x000000021e91d0>
+best_match.name # => "Michael Jackson"
+best_match.sync
+best_match.description # => "Michael Joseph Jackson (August 29, 1958 – June 25, 2009) was an American recording artist..."
+```
+
+```ruby
+FreebaseAPI::Topic.search('Cee Lo Green', filter: '(all type:/music/artist created:"The Lady Killer")')
+# => {868.82666=>#<FreebaseAPI::Topic:0x000000029ca250}
+```
+
+## Freebase API Raw access
+
+To get a raw access to the API, use `FreebaseAPI.session`. You can use any option or parameter documented in the Freebase API with the following methods.
+
+### Search
+
+The `search` method provides access to Freebase data given a free text query. Please consult the [Search Overview](https://developers.google.com/freebase/v1/search-overview) and the [Search Cookbook](https://developers.google.com/freebase/v1/search-cookbook) for more information on how to construct detailed search queries. All the parameters are supported.
+
+```ruby
+FreebaseAPI.session.search('Cee Lo Green', filter: '(all type:/music/artist created:"The Lady Killer")')
+```
+
+The method returns an Array containing all the results.
+
+```json
+[{"mid"=>"/m/01w5jwb",
+  "id"=>"/en/cee_lo_1974",
+  "name"=>"Cee Lo Green",
+  "notable"=>{"name"=>"Singer-songwriter", "id"=>"/m/016z4k"},
+  "lang"=>"en",
+  "score"=>868.82666}]
+```
+
+### Topic
+
+The `topic` method calls a web service that will return all known facts for a given topic including images and text blurbs. You can apply filters to the Topic API so that it only returns the property values that you're interested in. This is ideal for building topic pages and short summaries of an entity. You can consult the API reference [here](https://developers.google.com/freebase/v1/topic).
+
+```ruby
+FreebaseAPI.session.topic('/en/cee_lo_1974', filter: '/people/person/profession')
+```
+
+The method returns a Hash containing all the properties.
+
+```json
+{ "id"=>"/m/01w5jwb",
+  "property"=>{
+    "/people/person/profession"=>{"valuetype"=>"object", "values"=>[
+      {"text"=>"Record producer", "lang"=>"en", "id"=>"/m/0dz3r", "creator"=>"/user/mw_template_bot", "timestamp"=>"2008-10-09T08:34:08.000Z"},
+      {"text"=>"Singer-songwriter", "lang"=>"en", "id"=>"/m/016z4k", "creator"=>"/user/mw_template_bot", "timestamp"=>"2008-10-09T08:34:08.000Z"},
+      {"text"=>"Actor", "lang"=>"en", "id"=>"/m/02hrh1q", "creator"=>"/user/netflixbot", "timestamp"=>"2011-04-09T04:01:36.001Z"},
+      {"text"=>"Rapper", "lang"=>"en", "id"=>"/m/0hpcdn2", "creator"=>"/user/lycel", "timestamp"=>"2011-12-28T07:40:42.002Z"}
+    ], "count"=>4.0}
+  }
+}
+```
+
+### MQL Read
+
+The `mqlread` method provides access to the Freebase database using the [Metaweb query language (MQL)](https://developers.google.com/freebase/v1/mql-overview). You can consult the API reference [here](https://developers.google.com/freebase/v1/mqlread).
+
+```ruby
+FreebaseAPI.session.mqlread({
+  :type => '/internet/website',
+  :id => '/en/github',
+  :'/common/topic/official_website' => nil}
+)
+```
+
+The method returns a Hash containing the MQL response.
+
+```json
+{"/common/topic/official_website"=>"http://github.com/",
+ "id"=>"/en/github",
+ "type"=>"/internet/website"}
+```
+
+### Image
+
+The `image` method retrieves image data for a given Topic.
+
+```ruby
+FreebaseAPI.session.image('/en/github', maxwidth: 150, maxheight: 150)
+```
+
+The method returns data bytes.
+
+```
+\x89PNG\r\n\x1A\n\x00\x00\x00\rIHDR\x00\x0...
+```
+
+## Contributing to freebase-api
+
+* Check the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't unintentionally break it in a future version.
+* Please try not to mess with the Rakefile, version, or history. If you want, or really need, to have your own version, that is fine, but please isolate it in its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2013 Perfect Memory. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+
+YARD::Rake::YardocTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/freebase-api.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/freebase_api/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Aymeric Brisse"]
+  gem.email         = ["aymeric.brisse@mperfect-memory.com"]
+  gem.description   = %q{A library to use the Freebase API}
+  gem.summary       = %q{Provides access to both a raw-access and an abstract-layer to the Freebase API}
+  gem.homepage      = "https://github.com/PerfectMemory/freebase-api"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "freebase-api"
+  gem.require_paths = ["lib"]
+  gem.version       = FreebaseAPI::VERSION
+
+  gem.add_dependency('httparty', '~> 0.10')
+end

data/lib/freebase-api.rb

@@ -0,0 +1,32 @@
+require 'logger'
+
+require 'freebase_api/session'
+require 'freebase_api/image'
+require 'freebase_api/version'
+require 'freebase_api/topic'
+require 'freebase_api/attribute'
+require 'freebase_api/exceptions'
+require 'freebase_api/ext/hash'
+
+# FreebaseAPI is a library to use the Freebase API
+#
+# It provides :
+# - a Data mapper
+# - a low level class to use directly the Freebase API (Topic, Search, MQLRead)
+#
+# @see http://wiki.freebase.com/wiki/Freebase_API
+module FreebaseAPI
+  class << self
+    attr_accessor :logger, :session
+
+    def init_logger
+      logger = Logger.new(STDERR)
+      logger.level = Logger::WARN
+      logger.progname = "FreebaseAPI"
+      self.logger = logger
+    end
+  end
+end
+
+FreebaseAPI.init_logger
+FreebaseAPI.session = FreebaseAPI::Session.new

data/lib/freebase_api/attribute.rb

@@ -0,0 +1,29 @@
+module FreebaseAPI
+  # Attribute can be any Freebase data type
+  class Attribute
+
+    attr_accessor :type
+
+    def initialize(data, options={})
+      @data = data
+      @type = options[:type]
+    end
+
+    def value
+      @data['value']
+    end
+
+    def text
+      @data['text']
+    end
+
+    def lang
+      @data['lang']
+    end
+
+    def type
+      @type
+    end
+
+  end
+end

data/lib/freebase_api/exceptions.rb

@@ -0,0 +1,25 @@
+module FreebaseAPI
+  # A class for returning errors from the Freebase API
+  class Error < StandardError
+    attr_accessor :code, :message, :errors
+
+    def initialize(params)
+      FreebaseAPI.logger.error("#{params['message']} (#{params['code']})")
+      self.code = params['code']
+      self.message = params['message']
+    end
+
+    def to_s
+      "#{self.message} (#{self.code})"
+    end
+  end
+
+  class ServiceError < Error
+    def initialize(params)
+      super
+      self.errors = params['errors']
+    end
+  end
+
+  class NetError < Error ;; end
+end

data/lib/freebase_api/ext/hash.rb

@@ -0,0 +1,15 @@
+class Hash
+
+  def deep_merge(other_hash)
+    dup.deep_merge!(other_hash)
+  end
+
+  def deep_merge!(other_hash)
+    other_hash.each_pair do |k,v|
+      tv = self[k]
+      self[k] = tv.is_a?(Hash) && v.is_a?(Hash) ? tv.deep_merge(v) : v
+    end
+    self
+  end
+
+end

data/lib/freebase_api/image.rb

@@ -0,0 +1,44 @@
+module FreebaseAPI
+  class Image
+
+    attr_reader :id
+
+    class << self
+      def get(id, options={})
+        image = Image.new(id, options)
+        image.retrieve
+        image
+      end
+    end
+
+    def initialize(id, options={})
+      @data = nil
+      @options = options
+      @id = id
+    end
+
+    def retrieve
+      @data = FreebaseAPI.session.image(self.id, @options)
+    end
+
+    def store(filename)
+      File.open(filename, 'wb') do |f|
+        f.write data
+      end
+    end
+
+    def size
+      data.size
+    end
+
+    def inspect
+      self.to_s
+    end
+
+    private
+
+    def data
+      @data || retrieve
+    end
+  end
+end