freebase-importers 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+.env

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1,2 @@
+#!/bin/bash
+rvm gemset use ${PWD##*/}

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in freebase-importers.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sam Schenkman-Moore
+
+MIT License
+
+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.md

@@ -0,0 +1,48 @@
+# Freebase::Importers
+
+Some help for getting Freebase data into a more flat form.
+
+## Installation
+
+    gem 'freebase-importers'
+    require 'freebase_importers'
+
+## Usage
+
+Figure out your query via https://www.freebase.com/query
+
+Then define a model to make that query and load accessors with results.
+
+    class Book < FreebaseImporters::Base
+      map :name
+      map :characters, []
+
+      add_to_mql :"type", "/book/book"
+
+      add_to_mql :"/book/written_work/author", []
+      add_method :authors, CommonAccessors.single(:"/book/written_work/author")
+
+      add_to_mql :genre, []
+      add_method :genres,  -> { data['genre'] }
+      add_method :genre,   -> { genres.first   }
+
+      add_to_mql :"/book/written_work/date_of_first_publication"
+      add_method :date_of_first_publication, -> {
+        pub = data["/book/written_work/date_of_first_publication"]
+        pub ? Date.parse(pub) : nil rescue pub
+      }
+    end
+
+*map* is good when you want to modify mql to get a value from Freebase and also create an accessor with the same name.
+
+*add_to_mq* just modifies mql.
+
+*add_method* just adds a method.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+require 'dotenv/tasks'

data/freebase-importers.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'freebase_importers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "freebase-importers"
+  spec.version       = FreebaseImporters::VERSION
+  spec.authors       = ["Sam Schenkman-Moore"]
+  spec.email         = ["samsm@samsm.com"]
+  spec.description   = %q{Some easy importers for Freebase data.}
+  spec.summary       = %q{Import Freebase data.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency "rest-client"
+  spec.add_dependency "addressable"
+  spec.add_dependency "json"
+  spec.add_dependency "dotenv"
+end

data/lib/freebase_importers/base.rb

@@ -0,0 +1,66 @@
+module FreebaseImporters
+  class Base
+    attr_reader :data
+    def initialize(data)
+      @data = data
+    end
+
+    def self.map(target, value = nil)
+      add_to_mql(target, value)
+      target_ending = target.to_s.split('/').last
+      add_method(target_ending, CommonAccessors.single(target))
+    end
+
+    def self.add_to_mql(key, value = nil)
+      mql[key.to_s] = value
+    end
+
+    def self.add_method(name, proc)
+      define_method(name, proc)
+    end
+
+    private
+
+    def self.query
+      Query.new(mql)
+    end
+
+    def self.all
+      query.each do |result|
+        yield new(result)
+      end
+    end
+
+    def self.first
+      all {|m| break(m) }
+    end
+
+    def self.images!
+      key = "/common/topic/image"
+      add_to_mql key, [ { "id" => nil } ]
+      add_method :image_ids, CommonAccessors.deep(key, :id)
+      add_method :image_urls,     -> { image_ids.collect {|id| freebase_image_url(id) } }
+      add_method :thumbnail_urls, -> { image_ids.collect {|id| freebase_thumb_url(id) } }
+
+      add_method :image_url,     -> { image_urls.first }
+      add_method :thumbnail_url, -> { thumbnail_urls.first }
+
+    end
+
+    class << self
+      private
+
+      def mql
+        @mql ||= {}
+      end
+    end
+
+    def freebase_thumb_url(path)
+      "https://usercontent.googleapis.com/freebase/v1/image#{path}"
+    end
+
+    def freebase_image_url(path)
+      "https://api.freebase.com/api/trans/raw#{path}"
+    end
+  end
+end

data/lib/freebase_importers/book.rb

@@ -0,0 +1,21 @@
+module FreebaseImporters
+  class Book < Base
+    map :name
+    map :characters, []
+
+    add_to_mql :"type", "/book/book"
+
+    add_to_mql :"/book/written_work/author", []
+    add_method :authors, CommonAccessors.single(:"/book/written_work/author")
+
+    add_to_mql :genre, []
+    add_method :genres,  -> { data['genre'] }
+    add_method :genre,   -> { genres.first   }
+
+    add_to_mql :"/book/written_work/date_of_first_publication"
+    add_method :date_of_first_publication, -> {
+      pub = data["/book/written_work/date_of_first_publication"]
+      pub ? Date.parse(pub) : nil rescue pub
+    }
+  end
+end

data/lib/freebase_importers/car.rb

@@ -0,0 +1,16 @@
+module FreebaseImporters
+  class Car < Base
+    map :name
+
+    add_to_mql :type, "/automotive/model"
+
+    add_to_mql :make, [{"name" => nil }]
+    add_method :make, CommonAccessors.deep_singular(:make, :name)
+
+    add_to_mql :model_years,  [ { "name" => nil } ]
+    add_method :model_years, CommonAccessors.deep(:model_years, :name)
+
+    images!
+
+  end
+end

data/lib/freebase_importers/common_accessors.rb

@@ -0,0 +1,17 @@
+module FreebaseImporters
+  module CommonAccessors
+    class << self
+      def single(key)
+        -> { data[key.to_s] }
+      end
+
+      def deep(key, internal_key)
+        -> { data[key.to_s].collect {|d| d[internal_key.to_s] } }
+      end
+
+      def deep_singular(key, internal_key)
+        -> { data[key.to_s].collect {|d| d[internal_key.to_s] }.first }
+      end
+    end
+  end
+end

data/lib/freebase_importers/person.rb

@@ -0,0 +1,8 @@
+module FreebaseImporters
+  class Person < Base
+    map :name
+    map :place_of_birth
+    add_to_mql(:type, "/people/person")
+    images!
+  end
+end

data/lib/freebase_importers/query.rb

@@ -0,0 +1,54 @@
+require "addressable/uri"
+require "rest_client"
+require "json"
+
+module FreebaseImporters
+  class Query
+    include Enumerable
+
+    def initialize(mql, cursor = nil)
+      @mql, @cursor = mql, cursor
+    end
+
+    def response
+      @response ||= json_query
+    end
+
+    def result
+      json_query['result']
+    end
+
+    # https://developers.google.com/freebase/v1/mql-overview#querying-with-cursor-paging-results
+    def next
+      if (cursor = result["cursor"])
+        self.class.new(mql, cursor)
+      end
+    end
+
+    def each(*args, &block)
+      return enum_for(__callee__) unless block_given?
+      result.each(*args, &block)
+    end
+
+    private
+    attr_reader :mql, :cursor
+
+    def base_url
+      Addressable::URI.parse('https://www.googleapis.com/freebase/v1/mqlread')
+    end
+
+    def query
+      # puts "About to mql: #{mql.inspect}"
+      url = base_url
+      url.query_values = {
+        'query' => [mql].to_json,
+        'cursor' => cursor
+      }
+      RestClient.get url.normalize.to_s, format: :json
+    end
+
+    def json_query
+      JSON.parse(query)
+    end
+  end
+end

data/lib/freebase_importers/query_builder.rb

@@ -0,0 +1,15 @@
+module FreebaseImporters
+  class QueryBuilder
+    def initialize
+      @filters, @maps = [], []
+    end
+
+    # add a filter or whatever
+    # "type" => "/book/book",
+    def map(target, value = nil, comparison = nil, &block)
+      if !value || value.empty? || block_given?
+        # create accesor
+      end
+    end
+  end
+end

data/lib/freebase_importers/version.rb

@@ -0,0 +1,3 @@
+module FreebaseImporters
+  VERSION = "0.0.1"
+end

data/lib/freebase_importers.rb

@@ -0,0 +1,28 @@
+require 'dotenv'
+Dotenv.load
+
+require "#{File.dirname(__FILE__)}/freebase_importers/version"
+
+# https://developers.google.com/freebase/v1/mql-overview
+module FreebaseImporters
+
+  Dir.glob("#{File.dirname(__FILE__)}/freebase_importers/*").each do |filename|
+    class_name = File.basename(filename, '.*').split('_').collect(&:capitalize).join.to_sym
+    autoload class_name, filename
+  end
+
+  def self.api_key
+    ENV['GOOGLE_SIMPLE_API_ACCESS'] || missing_api_key_error!
+  end
+
+  def self.missing_api_key_error!
+    puts
+    puts "Create a GOOGLE_SIMPLE_API_ACCESS environment vairable (maybe use gem dotenv)."
+    puts "Follow these instructions to get a Freebase api key: http://wiki.freebase.com/wiki/How_to_obtain_an_API_key"
+    puts
+    raise "No api key."
+  end
+
+end
+
+# puts FreebaseImporters::Cars.mql_search

data/spec/integration_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+puts "This makes unstubbed API requests right now. Woo"
+
+describe FreebaseImporters do
+  it "should be a module" do
+    expect(FreebaseImporters).to be_a_kind_of Module
+  end
+
+  describe FreebaseImporters::Book do
+    let(:book) { FreebaseImporters::Book.first }
+    it "should have a name" do
+      expect(book.name).to match /\w+/
+    end
+  end
+
+  describe FreebaseImporters::Car do
+    let(:car) { FreebaseImporters::Car.first }
+    it "should have images and thumbnails" do
+      expect(car.thumbnail_urls).not_to be_empty
+      expect(car.image_urls).not_to be_empty
+    end
+  end
+
+  describe FreebaseImporters::Person do
+    let(:person) { FreebaseImporters::Person.first }
+    it "should have name" do
+      expect(person.name).to match /\w+/
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require "#{File.dirname(__FILE__)}/../lib/freebase_importers"
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  # config.filter_run :focus
+
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: freebase-importers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sam Schenkman-Moore
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Some easy importers for Freebase data.
+email:
+- samsm@samsm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- freebase-importers.gemspec
+- lib/freebase_importers.rb
+- lib/freebase_importers/base.rb
+- lib/freebase_importers/book.rb
+- lib/freebase_importers/car.rb
+- lib/freebase_importers/common_accessors.rb
+- lib/freebase_importers/person.rb
+- lib/freebase_importers/query.rb
+- lib/freebase_importers/query_builder.rb
+- lib/freebase_importers/version.rb
+- spec/integration_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2781904459238432472
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2781904459238432472
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Import Freebase data.
+test_files:
+- spec/integration_spec.rb
+- spec/spec_helper.rb