active_triple 0.1.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Rob Nichols
+
+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,119 @@
+ActiveTriple: a tool to search a triple store
+=============================================
+
+Configuration
+-------------
+Before you can use ActiveTriple, you must set up a connector and
+associate it with ActiveTriple.
+
+    ActiveTriple.set_connector(MyConnector)
+
+Two connector templates are provided:
+
+ActiveTriple::Connectors::TripleStoreConnector
+---------------------------------------------
+
+A very basic connector, that shows the minimum requirement for a connector.
+
+ActiveTriple::Connectors::PostToUrlConnector
+----------------------------------------------
+This connector provides a connection to a server via HTTP post. If you have
+a server that will return json data to a posted request, you can inherit
+from this class to make a simple connector. For example:
+
+    class MyConnector < ActiveTriple::Connectors::PostToUrlConnector
+      def path
+        @path = 'http://path/to/the/server'
+      end
+    end
+
+    ActiveTriple.set_connector MyConnector
+
+
+Usage
+-----
+
+To search for items: 
+
+near a given location:
+
+    ActiveTriple.location('London')
+
+within 30km of a location
+
+    ActiveTriple.location('London', '30km')
+
+about a resource
+
+    ActiveTriple.about('London')
+
+mentions a resource
+
+    ActiveTriple.mentions('London')
+
+with a title of "This article"
+
+    ActiveTriple.title('This article')
+
+Using where
+-----------
+
+The title query can also be made using a where clause, with the key matching
+the predicate, and the value matching the object. The where method accepts
+both colon delimited style triples and bracketed url style triples 
+
+    ActiveTriple.where('dc:terms:title' => 'text:en:"This article"')
+
+or
+
+    ActiveTriple.where('<http://purl.org/dc/terms/title>' => '"This article"@en')
+
+Combining queries
+-----------------
+
+    ActiveTriple.location('Evesham', '200km').mentions('London')
+
+Limiting queries
+----------------
+
+By default, queries are limited to return ten items. This can be overwritten.
+
+    ActiveTriple.location('London').limit(2)
+    ActiveTriple.limit(20).location('London')
+
+Accessing the data
+------------------
+
+Each of the above searches will return an ActiveTriple instance. To access
+the data returned by the query, either use 'all' or use an Array method.
+
+Get all the items:
+
+    ActiveTriple.location('London').all
+
+Get the title of each of the items:
+
+    ActiveTriple.location('London').collect{|a| a.title}
+
+Items returned as objects
+-------------------------
+
+Notice in the last example, that the item is an object with a method title.
+Hashie is used to convert the data from it's native hash to an object. The
+native hash is nested and this is reflected in the structure of the object.
+
+To return the body text of the first item:
+
+    ActiveTriple.location('London').first.full_data.body
+
+To return the original hash:
+
+    ActiveTriple.location('London').first.to_hash
+
+No items found
+--------------
+If the query returns no items, an empty array will be returned when an attempt
+is made to access the data.
+
+    ActiveTriple.mentions('XXXXYYYY').all  ---> []
+

data/lib/active_triple.rb

@@ -0,0 +1,83 @@
+require_relative 'active_triple/search'
+require_relative 'active_triple/connectors/connectors.rb'
+require 'json'
+require 'triple_parser'
+
+class ActiveTriple
+  def initialize
+    
+  end
+  
+  @@connector = Connectors::PostToUrlConnector 
+  
+  def method_missing(m, *args, &block)
+    if Search.respond_to?(m)
+      statements = Search.send(m, *args)
+      add_triple(statements) 
+    elsif Array.new.respond_to?(m)
+      get_data.send(m, *args, &block)
+    else  
+      super
+    end
+  end
+  
+  def self.method_missing(m, *args)
+    if Search.respond_to?(m) || m.to_sym == :limit
+      active_triple = new
+      active_triple.send(m, *args)
+    else
+      super
+    end
+  end
+  
+  def self.set_connector(connector)
+    @@connector = connector
+  end
+  
+  def self.connector
+    @@connector
+  end
+  
+ 
+  def add_triple(statement)
+    @triples ||= Array.new
+    @triples << statement
+    @triples.flatten!
+    return self
+  end
+
+  def triples
+    TripleParser.to_rdf(@triples).join("\n")
+  end
+  
+  def self.binding_id
+    "output"
+  end
+  
+  def self.binding_variable
+    "?#{binding_id}"
+  end
+  
+  def limit(number_of_items)
+    @number_of_items = number_of_items
+    return self
+  end
+  
+  def number_of_items
+    @number_of_items || '10'
+  end
+  
+  def all
+    get_data
+  end
+  
+  def get_data
+    connection = self.class.connector.send_data(
+      :binding => self.class.binding_id,
+      :limit => number_of_items,
+      :triples => triples           
+    )  
+    connection.response
+  end
+   
+end

data/lib/active_triple/connectors/connectors.rb

@@ -0,0 +1,3 @@
+module Connectors
+  Dir[File.dirname(__FILE__) + '/*.rb'].each {|file| require file }  
+end

data/lib/active_triple/connectors/post_to_url_connector.rb

@@ -0,0 +1,64 @@
+require_relative 'triple_store_connector'
+require 'typhoeus'
+require 'hashie'
+
+class ActiveTriple
+  module Connectors
+    class PostToUrlConnector < TripleStoreConnector
+      attr_reader :url_variables, :triples
+      
+    
+      def self.send_data(args)
+        connector = new
+        connector.send_by_post(args)
+        return connector
+      end
+      
+      def response
+        resp = by_post
+        begin
+          json = JSON.parse(resp.body)
+          results = json.first[1]
+          results.collect!{|a| Hashie::Mash.new(a)}
+          return results
+        rescue JSON::ParserError => e
+          if /No stories found for query/ =~ e.message
+            return Array.new
+          else
+            raise e
+          end
+        end        
+      end
+      
+      def send_by_post(args)
+        @triples = args.delete(:triples)
+        set_url_variables(args)
+      end
+      
+      def path
+        raise 'Need to define path to server'  
+      end      
+      
+      def set_url_variables(variables = {})
+        @url_variables = build_varible_string(variables)
+      end
+
+      def url
+        [path, url_variables].join
+      end
+      
+      private
+      def by_post
+        Typhoeus::Request.post(url, {
+          :headers => { 'Content-Type' => 'text/plain' },
+          :body    => triples
+        })
+      end      
+      
+      def build_varible_string(variables)
+        parts = variables.to_a.collect{|v| v.join("=")}
+        "?#{parts.join('&')}"
+      end
+    end
+  end
+end

data/lib/active_triple/connectors/triple_store_connector.rb

@@ -0,0 +1,31 @@
+class ActiveTriple
+  module Connectors
+
+    class TripleStoreConnector
+
+      def initialize
+
+      end
+     
+      # Method used to initial a connection and send data.
+      def self.send_data(args = {})
+        required_arguments.each{|arg| raise "args must include :#{arg}" unless args.keys.include?(arg.to_sym)}
+        raise "Need to define how connector sends data to server"
+      end
+
+      # Response should be an array of objects holding the data returned by the server
+      # or an empty array
+      def response
+        raise "Need to define how connector handles response"
+      end
+      
+      private
+      def self.required_arguments
+        %w{triples binding limit}
+      end
+
+      
+    end
+
+  end
+end

data/lib/active_triple/search.rb

@@ -0,0 +1,41 @@
+class ActiveTriple
+  module Search
+    
+    # At the moment, I think this is the only search method that is working.
+    def self.location(place_name, radius = '8km')
+      [
+        %Q{resource:#{place_name} geo-pos:lat ?Latitude .},
+        %Q{resource:#{place_name} geo-pos:long ?Longitude .},
+        %Q{?location omgeo:nearby(?Latitude ?Longitude "#{radius}") .},
+        %Q{#{ActiveTriple.binding_variable} ontology:about ?location .}
+      ]
+    end
+    
+    def self.about(text)
+      %Q{#{ActiveTriple.binding_variable} ontology:about resource:#{underscore_spaces(text)} .}
+    end
+    
+    def self.mentions(text)
+      %Q{#{ActiveTriple.binding_variable} ontology:mentions resource:#{underscore_spaces(text)} .}
+    end
+    
+    def self.subject(text)
+      %Q{#{ActiveTriple.binding_variable} dc:terms:subject resource:#{text} .}
+    end
+    
+    # ActiveTriple.where('dc:terms:subject' => 'resource:London') is equivalent to ActiveTriple.subject('London')
+    def self.where(hash)
+      statements = Array.new
+      hash.each{|predicate, object| statements << %Q{#{ActiveTriple.binding_variable} #{predicate} #{object} .}}
+      return statements
+    end
+    
+    def self.title(text)
+      %Q{#{ActiveTriple.binding_variable} dc:terms:title text:en:"#{text}" .}
+    end  
+    
+    def self.underscore_spaces(text)
+      text.gsub(/\s+/, "_")
+    end
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: active_triple
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Rob Nichols
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-07 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &10204240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *10204240
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &10203780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *10203780
+- !ruby/object:Gem::Dependency
+  name: triple_parser
+  requirement: &10203200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *10203200
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: &10202660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *10202660
+description: Active Triple - Tool to query triple stores
+email: rob@undervale.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- lib/active_triple/connectors/post_to_url_connector.rb
+- lib/active_triple/connectors/connectors.rb
+- lib/active_triple/connectors/triple_store_connector.rb
+- lib/active_triple/search.rb
+- lib/active_triple.rb
+homepage: https://github.com/reggieb/active_triple
+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: Active Triple - Tool to query triple stores
+test_files: []