adamsalter-ken 0.1.1

data/lib/ken/view.rb

@@ -0,0 +1,56 @@
+# provides an interface to view a resource as a specific type
+# provides an interface for working with attributes, properties
+module Ken
+  class View
+    
+    include Extlib::Assertions
+    
+    # initializes a resource by json result
+    def initialize(resource, type)
+      assert_kind_of 'resource', resource, Ken::Resource
+      assert_kind_of 'type', type, Ken::Type
+      @resource, @type = resource, type
+    end
+    
+    # @api public
+    def to_s
+      @type.to_s
+    end
+    
+    # return correspondent type
+    # @api public
+    def type
+      @type
+    end
+    
+    # @api public
+    def inspect
+      result = "#<View type=\"#{type.id || "nil"}\">"
+    end
+    
+    # returns attributes which are member of the view's type
+    # @api public
+    def attributes
+      @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
+    def method_missing sym
+      attribute(sym.to_s)
+    end
+    
+  end
+end

data/lib/ken.rb

@@ -0,0 +1,124 @@
+require 'pathname'
+require 'rubygems'
+require 'net/http'
+require 'json'
+require 'extlib/assertions'
+require 'addressable/uri'
+
+dir = Pathname(__FILE__).dirname.expand_path + 'ken'
+
+require dir + 'util'
+require dir + 'resource'
+require dir + 'type'
+require dir + 'view'
+require dir + 'property'
+require dir + 'attribute'
+require dir + 'collection'
+require dir + 'session'
+require dir + 'logger'
+
+# init logger as soon as the library is required
+Ken::Logger.new(STDOUT, :error)
+
+# init default session
+Ken::Session.new('http://www.freebase.com', 'ma', 'xxxxx')
+
+module Ken
+  extend Extlib::Assertions
+  
+  # store query as a constant here.
+  # if the hash gets updated using
+  # #merge! or #update, this will mean
+  # that it actually stores the last
+  # query used. there are 2 sides to this.
+  # on the one hand, it isn't really a 
+  # constant anymore (ruby doesn't complain)?
+  # on the other hand, there is no need to
+  # create a new object everytime a query is
+  # executed. maybe this is fine, maybe not,
+  # this needs to be discussed.
+  
+  FETCH_DATA_QUERY = {
+    # :id => id, # needs to be merge!d in instance method
+    :guid => nil,
+    :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"
+      }
+    ]
+  }
+  
+  
+  # Executes an Mql Query against the Freebase API and returns the result as
+  # a <tt>Collection</tt> of <tt>Resources</tt>.
+  #
+  # performs a cursored query unless there's a limit specified
+  # == Examples
+  #
+  # Ken.all(:name => "Apple", :type => "/music/album")
+  #
+  # Ken.all(
+  #  :directed_by => "George Lucas",
+  #  :starring => [{
+  #    :actor => "Harrison Ford"
+  #  }],
+  #  :type => "/film/film"
+  # )
+  # @api public
+  def self.all(options = {})
+    assert_kind_of 'options', options, Hash
+    query = { :name => nil }.merge!(options).merge!(:id => nil)
+    result = Ken.session.mqlread([ query ], :cursor => !options[:limit])    
+    Ken::Collection.new(result.map { |r| Ken::Resource.new(r) })
+  end
+  
+  
+  # Executes an Mql Query against the Freebase API and returns the result wrapped
+  # in a <tt>Resource</tt> Object.
+  #
+  # == Examples
+  #
+  #  Ken.get('/en/the_police') => #<Resource id="/en/the_police" name="The Police">
+  # @api public
+  def self.get(id)
+    assert_kind_of 'id', id, String
+    result = Ken.session.mqlread(FETCH_DATA_QUERY.merge!(:id => id))
+    raise ResourceNotFound unless result
+    Ken::Resource.new(result)
+  end
+  
+end # module Ken

data/rails/init.rb

@@ -0,0 +1,2 @@
+# when used as a rails plugin
+require 'ken'

data/tasks/ken.rb

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :ken do
+#   # Task goes here
+# end

data/tasks/spec.rb

@@ -0,0 +1,25 @@
+begin
+  gem 'rspec', '~>1.1.12'
+  require 'spec'
+  require 'spec/rake/spectask'
+
+  task :default => [ :spec ]
+
+  desc 'Run specifications'
+  Spec::Rake::SpecTask.new(:spec) do |t|
+    t.spec_opts << '--options' << 'spec/spec.opts' if File.exists?('spec/spec.opts')
+    t.spec_files = Pathname.glob((ROOT + 'spec/**/*_spec.rb').to_s).map { |f| f.to_s }
+
+    begin
+      gem 'rcov', '~>0.8'
+      t.rcov = JRUBY ? false : (ENV.has_key?('NO_RCOV') ? ENV['NO_RCOV'] != 'true' : true)
+      t.rcov_opts << '--exclude' << 'spec'
+      t.rcov_opts << '--text-summary'
+      t.rcov_opts << '--sort' << 'coverage' << '--sort-reverse'
+    rescue LoadError
+      # rcov not installed
+    end
+  end
+rescue LoadError
+  # rspec not installed
+end

data/test/fixtures/music_artist.json

@@ -0,0 +1,103 @@
+
+{
+  "id" : "/music/artist",
+  "name" : "Musical Artist",
+  "properties" : [
+    {
+      "expected_type" : "/location/location",
+      "id" : "/music/artist/origin",
+      "name" : "Place Musical Career Began",
+      "unique" :true
+    },
+    {
+      "expected_type" : "/type/datetime",
+      "id" : "/music/artist/active_start",
+      "name" : "Active as Musical Artist (start)",
+      "unique" : true
+    },
+    {
+      "expected_type" : "/type/datetime",
+      "id" : "/music/artist/active_end",
+      "name" : "Active as Musical Artist (end)",
+      "unique" : true
+    },
+    {
+      "expected_type" : "/music/genre",
+      "id" : "/music/artist/genre",
+      "name" : "Musical Genres",
+      "unique" : null
+    },
+    {
+      "expected_type" : "/music/record_label",
+      "id" : "/music/artist/label",
+      "name" : "Record Labels",
+      "unique" : null
+    },
+    {
+      "expected_type" : "/music/artist",
+      "id" : "/music/artist/similar_artist",
+      "name" : "Similar Artists",
+      "unique" : null
+    },
+    {
+      "expected_type" : "/common/webpage",
+      "id" : "/music/artist/home_page",
+      "name" : "Musical Artist Home Page",
+      "unique" : null
+    },
+    {
+      "expected_type" : "/common/webpage",
+      "id" : "/music/artist/acquire_webpage",
+      "name" : "Web Page for Music",
+      "unique" : null
+    },
+    {
+      "expected_type" : "/music/album",
+      "id" : "/music/artist/album",
+      "name" : "Albums",
+      "unique" : null
+    },
+    {
+      "expected_type" : "/music/recording_contribution",
+      "id" : "/music/artist/contribution",
+      "name" : "Album Contributions",
+      "unique" : null
+    },
+    {
+      "expected_type" : "/music/track",
+      "id" : "/music/artist/track",
+      "name" : "Tracks Recorded",
+      "unique" : null
+    },
+    {
+      "expected_type" : "/music/artist",
+      "id" : "/music/artist/artist_similar",
+      "name" : "Similar Musical Artists",
+      "unique" : null
+    },
+    {
+      "expected_type" : "/music/track_contribution",
+      "id" : "/music/artist/track_contributions",
+      "name" : "Track Contributions",
+      "unique" : null
+    },
+    {
+      "expected_type" : "/music/instrument",
+      "id" : "/music/artist/instruments_played",
+      "name" : "Instruments Played",
+      "unique" : null
+    },
+    {
+      "expected_type" : "/music/voice",
+      "id" : "/music/artist/vocal_range",
+      "name" : "Vocal Range",
+      "unique" : null
+    },
+    {
+      "expected_type" : "/music/concert_tour",
+      "id" : "/music/artist/concert_tours",
+      "name" : "Concert Tours",
+      "unique" : false
+    }
+  ]
+}