dm-freebase-adapter 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Yves Senn
+
+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,13 @@
+= dm-freebase-adapter
+
+This adapter allows you to map any freebase resource to DataMapper models.
+
+== Installation
+
+To install the freebase adapter execute:
+
+`gem install dm-freebase-adapter`
+
+== Usage
+
+Copyright (c) 2009 Yves Senn. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "dm-freebase-adapter"
+    gem.summary = %Q{DataMapper adapter to access data stored in Freebase}
+    gem.description = %Q{This Adapter allows you to access any Freebase data with your DataMapper models}
+    gem.email = "yves.senn@gmail.com"
+    gem.homepage = "http://github.com/senny/dm-freebase-adapter"
+    gem.authors = ["Yves Senn"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem.add_development_dependency "cucumber", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+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
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+
+  task :features => :check_dependencies
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dm-freebase-adapter #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/features/dm-freebase-adapter.feature

@@ -0,0 +1,9 @@
+Feature: something something
+  In order to something something
+  A user something something
+  something something something
+
+  Scenario: something something
+    Given inspiration
+    When I create a sweet new gem
+    Then everyone should see how awesome I am

data/features/support/env.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'dm-freebase-adapter'
+
+require 'spec/expectations'

data/lib/freebase_adapter.rb

@@ -0,0 +1,115 @@
+require 'json'
+require 'net/http'
+
+module DataMapper
+  module Adapters
+    class FreebaseAdapter < AbstractAdapter
+
+      FREEBASE_HOST = "www.freebase.com"
+      FREEBASE_PATH = "/api/service/mqlread"
+
+      def query_url
+        host = (options[:host] && !options[:host].empty?) ? options[:host] : FREEBASE_HOST
+        path = (options[:path] && !options[:path].empty?) ? options[:path] : FREEBASE_PATH
+        "http://#{ host }#{ path }"
+      end
+
+      def read(query)
+        metaweb_query = {}
+        fields = query.fields
+        query.conditions.each do |condition|
+          metaweb_query[build_metaweb_condition_key(condition)] = build_metaweb_condition(condition)
+          looking_for = fields.reject {|field| metaweb_query.include?(field.name)}
+          looking_for.each do |field|
+            metaweb_query[field.name] = [{}]
+          end
+        end
+        metaweb_query["type"] = query.model.storage_name
+        result = metaweb_read(metaweb_query)["result"]
+        convert_metaweb_result(result)
+      end
+
+      private
+
+      def build_metaweb_condition_key(condition)
+        case condition
+        when DataMapper::Query::Conditions::LikeComparison
+          "#{condition.subject.name}~="
+        when DataMapper::Query::Conditions::InclusionComparison
+          "#{condition.subject.name}|="
+        when DataMapper::Query::Conditions::LessThanComparison
+          "#{condition.subject.name}<"
+        when DataMapper::Query::Conditions::GreaterThanComparison
+          "#{condition.subject.name}>"
+        when DataMapper::Query::Conditions::LessThanOrEqualToComparison
+          "#{condition.subject.name}<="
+        when DataMapper::Query::Conditions::GreaterThanOrEqualToComparison
+          "#{condition.subject.name}>="
+        when DataMapper::Query::Conditions::NotOperation
+          "#{condition.subject.name}!="
+        else
+          condition.subject.name
+        end
+      end
+
+      def build_metaweb_condition(condition)
+        case condition.subject
+        when DataMapper::Associations::ManyToOne::Relationship
+          {:id => condition.value.id}
+        else
+          condition.value
+        end
+      end
+
+      def convert_metaweb_result(results)
+        results.each do |element|
+          element.each do |key, value|
+            element[key] = extract_value(value)
+          end
+        end
+      end
+
+      def extract_value(property)
+        case property
+        when Array
+          values = property.collect {|element| extract_value(element)}
+          values.size == 1 ? values.first : values
+        when Hash
+          if property.has_key?("type")
+            extract_typed_value(property)
+          else
+            property
+          end
+        else
+          property
+        end
+      end
+
+      def extract_typed_value(property)
+        case property["type"]
+        when "/type/text", "/type/id"
+          property["value"]
+        else
+          property["name"]
+        end
+      end
+
+      def metaweb_read(query)
+        metaweb_query = "?query={\"query\": [#{JSON.dump(query)}]}"
+        url = "#{query_url}#{URI.escape(metaweb_query)}"
+        response = Net::HTTP.get_response(URI.parse(url))
+        data = response.body
+
+        result = JSON.parse(data)
+
+        if result['code'] == '/api/status/error'
+          raise "web service error #{url}"
+        end
+        return result
+      end
+
+
+    end # class FreebaseAdapter
+  end # module Adapters
+end # module DataMapper
+

data/spec/freebase_adapter_spec.rb

@@ -0,0 +1,59 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class Artist
+  include DataMapper::Resource
+
+  storage_names[:default] = '/music/artist'
+
+  property :id, String, :key => true
+  property :guid, String
+  property :name, String
+  property :genre, String
+
+  has n, :albums, :child_key => [:artist]
+end
+
+class Album
+  include DataMapper::Resource
+
+  storage_names[:default] = '/music/album'
+
+  property :id, String, :key => true
+  property :name, String
+  property :track, String
+
+  belongs_to :artist, :child_key => [:artist]
+end
+
+describe "FreebaseAdapter" do
+
+  it "should fetch the given properties" do
+    artist = Artist.get('/en/paul_kalkbrenner')
+    artist.name.should == "Paul Kalkbrenner"
+    artist.genre.should_not be_empty
+  end
+
+  it "should fetch associations on demand" do
+    artist = Artist.get('/en/apparat')
+    artist.albums.size.should > 0
+    titles = artist.albums.collect(&:name)
+    ["Silizium EP", "Walls"].each do |title|
+      titles.should include(title)
+    end
+  end
+
+  it "should work with inclusion (in) queries" do
+    results = Album.all(:name => ["Berlin Calling", "Balance 005: James Holden"])
+    results.size.should == 2
+    results[0].name.should == "Balance 005: James Holden"
+    results[1].name.should == "Berlin Calling"
+  end
+
+  it "should work with like (regexp match) queries" do
+    results = Album.all(:name.like => "Balance 00*")
+    results.size.should > 0
+    titles = results.collect(&:name)
+    titles.each {|title| title.should =~ /^Balance 00.*$/}
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require "rubygems"
+require "dm-core"
+require 'freebase_adapter'
+require 'spec'
+require 'spec/autorun'
+
+DataMapper.setup(:default, :adapter => 'freebase')
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: dm-freebase-adapter
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Yves Senn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-07 00:00:00 +01: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: 1.2.9
+    version: 
+description: This Adapter allows you to access any Freebase data with your DataMapper models
+email: yves.senn@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- features/dm-freebase-adapter.feature
+- features/step_definitions/dm-freebase-adapter_steps.rb
+- features/support/env.rb
+- lib/freebase_adapter.rb
+- spec/freebase_adapter_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/senny/dm-freebase-adapter
+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: 3
+summary: DataMapper adapter to access data stored in Freebase
+test_files: 
+- spec/freebase_adapter_spec.rb
+- spec/spec_helper.rb