freebase-api 0.1

data/spec/freebase_api_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe FreebaseAPI do
+
+  it "should have a default logger" do
+    FreebaseAPI.logger.should be_kind_of(Logger)
+  end
+
+  it "should have a default session" do
+    FreebaseAPI.session.should be_kind_of(FreebaseAPI::Session)
+  end
+
+end

data/spec/image_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+require 'tempfile'
+
+describe FreebaseAPI::Image do
+
+  let(:options) { { :maxheight => 20, :maxwidth => 20 } }
+  let(:image) { FreebaseAPI::Image.get('/en/bob_dylan', options) }
+
+  let(:data) {
+    load_data 'img.jpg'
+  }
+
+  before {
+    stubbed_session = mock('session')
+    FreebaseAPI.stub(:session).and_return(stubbed_session)
+    stubbed_session.stub(:image).and_return(data)
+  }
+
+  describe ".get" do
+    let(:stubbed_session) { mock('session').as_null_object }
+
+    before {
+      FreebaseAPI.stub(:session).and_return(stubbed_session)
+    }
+
+    it "should make a Image API call" do
+      stubbed_session.should_receive(:image).with('/en/bob_dylan', :maxheight => 20, :maxwidth => 20).and_return(data)
+      image
+    end
+
+    it "should return an image" do
+      image.should be_kind_of FreebaseAPI::Image
+    end
+  end
+
+  describe "#id" do
+    it "should return the topic related ID" do
+      image.id.should == '/en/bob_dylan'
+    end
+  end
+
+  describe "#size" do
+    it "should return the topic related ID" do
+      image.size.should == data.size
+    end
+  end
+
+  describe "#store" do
+    it "should store the image" do
+      Dir::Tmpname.create 'freebase-api' do |file|
+        image.store(file)
+        File.size(file).should == data.size
+        File.unlink(file)
+      end
+    end
+  end
+end

data/spec/session_spec.rb

@@ -0,0 +1,165 @@
+require 'spec_helper'
+
+describe FreebaseAPI::Session do
+
+  let(:session) { FreebaseAPI::Session.new }
+  let(:dummy_session) { FreebaseAPI::Session.new(:key => "GOOGLE_API_KEY", :env => :sandbox, :query_options => { :lang => :fr, :limit => 1 }) }
+
+  it "should include HTTParty" do
+    FreebaseAPI::Session.should include(HTTParty)
+  end
+
+  describe "#key" do
+    context "when key has been set manually" do
+      it "should return the API key" do
+        dummy_session.key.should == 'GOOGLE_API_KEY'
+      end
+    end
+
+    context "with the env variables defined" do
+      before { ENV['GOOGLE_API_KEY'] = 'ENV_GOOGLE_API_KEY' }
+      it "should return the API key" do
+        session.key.should == 'ENV_GOOGLE_API_KEY'
+      end
+      after { ENV['GOOGLE_API_KEY'] = nil }
+    end
+  end
+
+  describe "#env" do
+    it "should return the environnment" do
+      dummy_session.env.should == :sandbox
+    end
+  end
+
+  describe "#query_options" do
+    it "should return the environnment" do
+      dummy_session.query_options.should == { :lang => :fr, :limit => 1 }
+    end
+  end
+
+  describe "#surl" do
+    context "in a sandbox environnment" do
+      it "should return the sandbox service URL" do
+        dummy_session.send(:surl, 'service').should == 'https://www.googleapis.com/freebase/v1sandbox/service'
+      end
+    end
+
+    context "in a stable environnment" do
+      it "should return the sandbox service URL" do
+        session.send(:surl, 'service').should == 'https://www.googleapis.com/freebase/v1/service'
+      end
+    end
+  end
+
+  describe "#mqlread" do
+    let(:query) {
+      {
+        :type => '/internet/website',
+        :id => '/en/github',
+        :'/common/topic/official_website' => nil
+      }
+    }
+
+    let(:request) {
+      session.mqlread(query)
+    }
+
+    context "when the query is successful" do
+      it "should run a MQL query and return the result" do
+        request.should == {
+          "/common/topic/official_website" => "http://github.com/",
+          "id" => "/en/github",
+          "type" => "/internet/website"
+        }
+      end
+    end
+
+    context "when the query has failed" do
+      let(:session) { FreebaseAPI::Session.new :key => 'nil' }
+
+      it "should raise en error" do
+        expect {
+          request
+        }.to raise_error(FreebaseAPI::Error)
+      end
+    end
+  end
+
+  describe "#image" do
+    let(:request) {
+      session.image('/en/bob_dylan')
+    }
+
+    context "when the query is successful" do
+      it "should not raise any error" do
+        expect {
+          request
+        }.to_not raise_error(FreebaseAPI::Error)
+      end
+
+      it "should return some data" do
+        request.size.should > 1000
+      end
+    end
+
+    context "when the query has failed" do
+      let(:session) { FreebaseAPI::Session.new :key => 'nil' }
+
+      it "should raise en error" do
+        expect {
+          request
+        }.to raise_error(FreebaseAPI::Error)
+      end
+    end
+  end
+
+  describe "#search" do
+    let(:request) {
+      session.search('bob dylan')
+    }
+
+    context "when the query is successful" do
+      it "should not raise any error" do
+        expect {
+          request
+        }.to_not raise_error(FreebaseAPI::Error)
+      end
+
+      it "should return some topics" do
+        request.should_not be_empty
+      end
+    end
+
+    context "when the query has failed" do
+      let(:session) { FreebaseAPI::Session.new :key => 'nil' }
+
+      it "should raise en error" do
+        expect {
+          request
+        }.to raise_error(FreebaseAPI::Error)
+      end
+    end
+  end
+
+  describe "#topic" do
+    let(:request) {
+      session.topic('/en/github', :filter => '/common/topic/official_website')
+    }
+
+    context "when the query is successful" do
+      it "should run a topic query and return the result" do
+        request['property'].should have(1).elements
+      end
+    end
+
+    context "when the query has failed" do
+      let(:session) { FreebaseAPI::Session.new :key => 'nil' }
+
+      it "should raise en error" do
+        expect {
+          request
+        }.to raise_error(FreebaseAPI::Error)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+
+require 'rspec'
+require 'freebase-api'
+require 'support/helpers'
+
+RSpec.configure do |config|
+  config.include FreebaseAPI::Helpers
+end
+
+FreebaseAPI.logger.level = Logger::FATAL

data/spec/support/helpers.rb

@@ -0,0 +1,12 @@
+module FreebaseAPI
+  # Helpers for Rspec
+  module Helpers
+    def load_fixture(fixture)
+      JSON.parse(IO.read(File.join(File.dirname(__FILE__), "..", "fixtures", "#{fixture}.json")))
+    end
+
+    def load_data(file)
+      IO.read(File.join(File.dirname(__FILE__), "..", "fixtures", file))
+    end
+  end
+end

data/spec/topic_spec.rb

@@ -0,0 +1,166 @@
+require 'spec_helper'
+
+describe FreebaseAPI::Topic do
+
+  let(:options) { { :lang => :en } }
+  let(:topic) { FreebaseAPI::Topic.get('/en/github', options) }
+  let(:new_topic) { FreebaseAPI::Topic.new('/en/github') }
+
+  let(:data) { load_fixture 'topic' }
+
+  before {
+    stubbed_session = mock('session')
+    FreebaseAPI.stub(:session).and_return(stubbed_session)
+    stubbed_session.stub(:topic).and_return(data)
+    stubbed_session.stub(:image).and_return(nil)
+  }
+
+  describe ".get" do
+    let(:stubbed_session) { mock('session').as_null_object }
+
+    before {
+      FreebaseAPI::Topic.any_instance.stub(:build)
+      FreebaseAPI.stub(:session).and_return(stubbed_session)
+    }
+
+    it "should make a Topic API call" do
+      stubbed_session.should_receive(:topic).with('/en/github', :lang => :en, :filter => 'commons').and_return(data)
+      topic
+    end
+
+    it "should return a topic" do
+      topic.should be_kind_of FreebaseAPI::Topic
+    end
+  end
+
+   describe ".search" do
+    let(:stubbed_session) { mock('session') }
+    let(:topic_search) { FreebaseAPI::Topic.search('dylan') }
+    let(:data) { load_fixture 'search' }
+    let(:item) { topic_search.values.first }
+
+    before {
+      FreebaseAPI.stub(:session).and_return(stubbed_session)
+      stubbed_session.stub(:search).and_return(data)
+    }
+
+    it "should make a Search API call" do
+      stubbed_session.should_receive(:search).with('dylan', {}).and_return(data)
+      topic_search
+    end
+
+    it "should return an hash" do
+      topic_search.should be_kind_of Hash
+    end
+
+    it "should return ordered scores" do
+      topic_search.keys.first.should == 72.587578
+      topic_search.keys.last.should == 20.738529
+    end
+
+    it "should return topics" do
+      item.should be_kind_of(FreebaseAPI::Topic)
+    end
+
+    it "should store the id" do
+      item.id.should == '/m/01vrncs'
+    end
+
+    it "should store some properties" do
+      item.properties.keys.should == ["/type/object/name", "/common/topic/notable_for"]
+    end
+  end
+
+  describe "#id" do
+    context "when the topic has been sync yet" do
+      it "should return the topic ID" do
+        new_topic.id.should == '/en/github'
+      end
+    end
+
+    context "when the topic has been sync" do
+      it "should return the topic ID" do
+        topic.id.should == '/m/04g0kcw'
+      end
+    end
+  end
+
+  describe "#text" do
+    it "should return the topic text" do
+      topic.text.should == "GitHub"
+    end
+  end
+
+  describe "#lang" do
+    it "should return the topic language" do
+      topic.lang.should == 'en'
+    end
+  end
+
+  describe "#name" do
+    it "should return the topic name" do
+      topic.name.should == 'GitHub'
+    end
+  end
+
+  describe "#types" do
+    it "should return all the topic types" do
+      topic.types.should == ["/common/topic", "/internet/website", "/base/technologyofdoing/proposal_agent"]
+    end
+  end
+
+  describe "#description" do
+    it "should return the topic description" do
+      topic.description.should start_with "GitHub is a web-based hosting service for software development projects that use the Git revision control system."
+    end
+  end
+
+  describe "#properties" do
+    it "should return the properties values which are topics" do
+      link = topic.properties['/internet/website/category'].first
+      link.should be_kind_of(FreebaseAPI::Topic)
+      link.name.should == 'Revision control'
+    end
+
+    it "should return the properties values which are data" do
+      link = topic.properties['/common/topic/official_website'].first
+      link.should be_kind_of(FreebaseAPI::Attribute)
+      link.value.should == 'http://github.com/'
+    end
+
+    context "with a property exclusion constraint" do
+      let(:topic) { FreebaseAPI::Topic.get('/en/github', :exclude => '/internet') }
+
+      it "should not return these properties" do
+        topic.properties.should_not have_key('/internet/website/category')
+      end
+
+      it "should return the properties that do not match this exclusion" do
+        topic.properties.should have_key('/common/topic/official_website')
+      end
+    end
+  end
+
+  describe "#property" do
+    it "should return the asked property" do
+      property = topic.property('/type/object/type')
+      property.should have(3).elements
+    end
+  end
+
+  describe "#properties domains" do
+    it "should return an hash containing the properties domains" do
+      topic.properties_domains.should == { 'common' => 16, 'internet' => 1,'type' => 30 }
+    end
+  end
+
+  describe "#image" do
+    it "should return an Image" do
+      topic.image.should be_kind_of(FreebaseAPI::Image)
+    end
+
+    it "should be the topic image" do
+      topic.image.id.should == topic.id
+    end
+  end
+end

data/travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - rbx-19mode
+  - jruby-19mode
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+  - jruby-head

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: freebase-api
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Aymeric Brisse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &1 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: *1
+description: A library to use the Freebase API
+email:
+- aymeric.brisse@mperfect-memory.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- freebase-api.gemspec
+- lib/freebase-api.rb
+- lib/freebase_api/attribute.rb
+- lib/freebase_api/exceptions.rb
+- lib/freebase_api/ext/hash.rb
+- lib/freebase_api/image.rb
+- lib/freebase_api/session.rb
+- lib/freebase_api/topic.rb
+- lib/freebase_api/version.rb
+- spec/attribute_spec.rb
+- spec/fixtures/img.jpg
+- spec/fixtures/search.json
+- spec/fixtures/topic.json
+- spec/freebase_api_spec.rb
+- spec/image_spec.rb
+- spec/session_spec.rb
+- spec/spec_helper.rb
+- spec/support/helpers.rb
+- spec/topic_spec.rb
+- travis.yml
+homepage: https://github.com/PerfectMemory/freebase-api
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Provides access to both a raw-access and an abstract-layer to the Freebase
+  API
+test_files:
+- spec/attribute_spec.rb
+- spec/fixtures/img.jpg
+- spec/fixtures/search.json
+- spec/fixtures/topic.json
+- spec/freebase_api_spec.rb
+- spec/image_spec.rb
+- spec/session_spec.rb
+- spec/spec_helper.rb
+- spec/support/helpers.rb
+- spec/topic_spec.rb
+has_rdoc: