michael-ken 0.1.1 → 0.1.2

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/ken.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ken}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["michael"]
-  s.date = %q{2009-07-24}
+  s.date = %q{2009-08-23}
   s.email = %q{ma[at]zive[dot]at}
   s.extra_rdoc_files = [
     "LICENSE",

data/lib/ken.rb

@@ -2,7 +2,6 @@ require 'pathname'
 require 'rubygems'
 require 'net/http'
 require 'json'
-require 'extlib'
 require 'extlib/assertions'
 require 'addressable/uri'
 
@@ -41,6 +40,7 @@ module Ken
   
   FETCH_DATA_QUERY = {
     # :id => id, # needs to be merge!d in instance method
+    :guid => nil,
     :name => nil,
     :"ken:type" => [{
       :id => nil,
@@ -59,7 +59,8 @@ module Ken
         :id => nil,
         :link => nil,
         :name => nil,
-        :optional => true
+        :optional => true,
+        :limit => 999999
       }
     ],
     :"/type/reflect/any_reverse" => [
@@ -67,14 +68,16 @@ module Ken
         :id => nil,
         :link => nil,
         :name => nil,
-        :optional => true
+        :optional => true,
+        :limit => 999999
       }
     ],
     :"/type/reflect/any_value" => [
       {
         :link => nil,
         :value => nil,
-        :optional => true
+        :optional => true,
+        :limit => 999999
         # TODO: support multiple language
         # :lang => "/lang/en",
         # :type => "/type/text"
@@ -82,7 +85,6 @@ module Ken
     ]
   }
   
-  
   # Executes an Mql Query against the Freebase API and returns the result as
   # a <tt>Collection</tt> of <tt>Resources</tt>.
   #

data/lib/ken/resource.rb

@@ -2,48 +2,7 @@ module Ken
   class Resource
     include Extlib::Assertions
     
-    FETCH_DATA_QUERY = {
-      # :id => id, # needs to be merge!d in instance method
-      :name => nil,
-      :"ken:type" => [{
-        :id => nil,
-        :name => nil,
-        :properties => [{
-          :id => nil,
-          :name => nil,
-          :expected_type => nil,
-          :unique => nil,
-          :reverse_property => nil,
-          :master_property => nil,
-        }]
-      }],
-      :"/type/reflect/any_master" => [
-        {
-          :id => nil,
-          :link => nil,
-          :name => nil,
-          :optional => true
-        }
-      ],
-      :"/type/reflect/any_reverse" => [
-        {
-          :id => nil,
-          :link => nil,
-          :name => nil,
-          :optional => true
-        }
-      ],
-      :"/type/reflect/any_value" => [
-        {
-          :link => nil,
-          :value => nil,
-          :optional => true
-          # TODO: support multiple language
-          # :lang => "/lang/en",
-          # :type => "/type/text"
-        }
-      ]
-    }
+    attr_reader :data
     
     # initializes a resource using a json result
     def initialize(data)
@@ -58,6 +17,12 @@ module Ken
       @data["id"] || ""
     end
     
+    # resource guid
+    # @api public
+    def guid
+      @data['guid'] || ""
+    end
+    
     # resource name
     # @api public
     def name
@@ -87,6 +52,20 @@ module Ken
       @views ||= Ken::Collection.new(types.map { |type| Ken::View.new(self, type) })
     end
     
+    # returns individual view based on the requested type id
+    # @api public
+    def view(type)
+      views.each { |v| return v if v.type.id =~ /^#{Regexp.escape(type)}$/}
+      nil
+    end
+    
+    # returns individual type based on the requested type id
+    # @api public
+    def type(type)
+      types.each { |t| return t if t.id =~ /^#{Regexp.escape(type)}$/}
+      nil
+    end
+
     # returns all the properties from all assigned types
     # @api public
     def properties
@@ -104,6 +83,13 @@ module Ken
       @attributes.values
     end
     
+    # search for an attribute by name and return it
+    # @api public
+    def attribute(name)
+      attributes.each { |a| return a if a.property.id == name }
+      nil
+    end
+    
     # returns true if type information is already loaded
     # @api public
     def schema_loaded?

data/lib/ken/session.rb

@@ -1,5 +1,5 @@
 module Ken
-  class << self #:nodoc:
+  class << self
     attr_accessor :session
   end
   
@@ -16,14 +16,14 @@ module Ken
     end
   end
   
-  class AttributeNotFound < StandardError; end
-  class PropertyNotFound < StandardError; end
-  class ResourceNotFound < StandardError; end
+  class AttributeNotFound < StandardError ; end
+  class PropertyNotFound < StandardError ; end
+  class ResourceNotFound < StandardError ; end
+  class ViewNotFound < StandardError ; end
   
   # partially taken from chris eppstein's freebase api
   # http://github.com/chriseppstein/freebase/tree
   class Session
-    
     public
     # Initialize a new Ken Session
     #   Ken::Session.new(host{String, IO}, username{String}, password{String})
@@ -69,11 +69,10 @@ module Ken
       end
     end # handle_read_error
 
-
-    # perform a mqlread and return the results
+    # Perform a mqlread and return the results
+    # Specify :cursor => true to batch the results of a query, sending multiple requests if necessary.
     # TODO: should support multiple queries
     #       you should be able to pass an array of queries
-    # Specify :cursor => true to batch the results of a query, sending multiple requests if necessary.
     def mqlread(query, options = {})
       Ken.logger.info ">>> Sending Query: #{query.to_json}"
       cursor = options[:cursor]
@@ -126,6 +125,5 @@ module Ken
       end
       Ken.logger.info("Wrote response to #{fname}")
     end
-    
   end # class Session
 end # module Ken

data/lib/ken/util.rb

@@ -16,12 +16,3 @@ module Ken
   end
 end
 
-class Object
-  # nice for debugging
-  # usage: print_call_stack(:method_name, 2, 10)
-  def print_call_stack(from = 2, to = nil, html = false)
-    (from..(to ? to : caller.length)).each do |idx| 
-      p "[#{idx}]: #{caller[idx]}#{html ? '<br />' : ''}"
-    end
-  end
-end

data/lib/ken/view.rb

@@ -34,23 +34,23 @@ module Ken
       @resource.attributes.select { |a| a.property.type == @type}
     end
     
+    # search for an attribute by name and return it
+    # @api public
+    def attribute(name)
+      attributes.each { |a| return a if a.property.id =~ /\/#{name}$/ }
+      nil
+    end
+    
     # returns properties which are member of the view's type    
     # @api public
     def properties
       @resource.properties.select { |p| p.type == @type}
     end
     
-    # delegate to attribute_get
+    # delegate to attribute
     def method_missing sym
-      attribute_get(sym.to_s)
+      attribute(sym.to_s)
     end
     
-    private
-    # search for an attribute by name and return it
-    # @api private
-    def attribute_get(name)
-      attributes.each { |a| return a if a.property.id =~ /\/#{name}$/ }
-      raise AttributeNotFound
-    end
   end
 end

data/test/integration/ken_test.rb

@@ -5,7 +5,7 @@ class KenTest < Test::Unit::TestCase
     setup do
       Ken::Session.new('http://www.freebase.com', 'ma', 'xxxxx')
     end
-  
+    
     should 'return a Ken::Resource' do
       the_police = Ken.get("/en/the_police")
       the_police.should be_kind_of(Ken::Resource)
@@ -48,7 +48,7 @@ class KenTest < Test::Unit::TestCase
         ],
         :type => "/film/film"
       }
-
+  
       resources = Ken.all(query)
       resources.length.should == 3
       resources.first.name.should == "Star Wars Episode IV: A New Hope"

data/test/test_helper.rb

@@ -48,4 +48,14 @@ class Test::Unit::TestCase
     matcher.negative_failure_message = "Expected #{receiver} not to be false but it was"
     receiver.eql?(false)
   end
+end
+
+class Object
+  # nice for debugging
+  # usage: print_call_stack(:method_name, 2, 10)
+  def print_call_stack(from = 2, to = nil, html = false)
+    (from..(to ? to : caller.length)).each do |idx| 
+      p "[#{idx}]: #{caller[idx]}#{html ? '<br />' : ''}"
+    end
+  end
 end

data/test/unit/resource_test.rb

@@ -18,6 +18,16 @@ class ResourceTest < Test::Unit::TestCase
       @the_police.views.first.type.should be_kind_of(Ken::Type)
     end
     
+    should "return individual view based requested type id" do
+      @the_police.view('/music/artist').should be_kind_of(Ken::View)
+      @the_police.view('/location/location').should be_nil # not existent view
+    end
+    
+    should "return individual type based requested type id" do
+      @the_police.type('/music/artist').should be_kind_of(Ken::Type)
+      @the_police.type('/location/location').should be_nil # not existent type
+    end
+    
     should 'have a full set of attributes' do
       @the_police.attributes.should_not be_nil
     end

data/test/unit/session_test.rb

@@ -9,7 +9,7 @@ class SessionTest < Test::Unit::TestCase
 
     should 'return the correct set of types' do
       result = Ken.session.mqlread({:id => "/en/the_police", :type => []})
-      result['type'].length.should == 6
+      result['type'].length.should >= 1
     end
 
     should 'raise a Ken::MqlReadError if node does not exist' do

data/test/unit/view_test.rb

@@ -26,7 +26,7 @@ class ViewTest < Test::Unit::TestCase
     
     context "when accessing a direct attribute" do
       setup do
-        @genre = @view.genre
+        @genre = @view.attribute('genre')
         @album = @view.album
       end
       
@@ -41,7 +41,7 @@ class ViewTest < Test::Unit::TestCase
       end
       
       should "raise AttributeNotFound when invalid propertyname is supplied" do
-        lambda { @view.not_existing_attribute }.should raise_error(Ken::AttributeNotFound)
+        @view.not_existing_attribute.should be_nil
       end
     end # context
   end # context

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: michael-ken
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - michael
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-24 00:00:00 -07:00
+date: 2009-08-23 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -89,6 +89,7 @@ files:
 - test/unit/view_test.rb
 has_rdoc: false
 homepage: http://github.com/michael/ken
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -109,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Ruby API for Accessing the Freebase