agraph 0.1.0 → 0.1.1

data/Rakefile

@@ -9,8 +9,8 @@ task :default => :spec
 
 specification = Gem::Specification.new do |specification|
   specification.name              = "agraph"
-  specification.version           = "0.1.0"
-  specification.date              = "2010-04-05"
+  specification.version           = "0.1.1"
+  specification.date              = "2010-07-05"
   specification.email             = "b.phifty@gmail.com"
   specification.homepage          = "http://github.com/phifty/agraph"
   specification.summary           = "Client for the AllegroGraph 4.x graph database."
@@ -46,4 +46,4 @@ namespace :spec do
     task.spec_files = FileList["spec/integration/**/*_spec.rb"]
   end
 
-end
+end

data/lib/allegro_graph.rb

@@ -1,5 +1,14 @@
-require File.join(File.dirname(__FILE__), "allegro_graph", "server")
-require File.join(File.dirname(__FILE__), "allegro_graph", "catalog")
-require File.join(File.dirname(__FILE__), "allegro_graph", "repository")
-require File.join(File.dirname(__FILE__), "allegro_graph", "session")
-require File.join(File.dirname(__FILE__), "allegro_graph", "federation")
+
+module AllegroGraph
+
+  autoload :Transport,          File.join(File.dirname(__FILE__), "allegro_graph", "transport")
+  autoload :ExtendedTransport,  File.join(File.dirname(__FILE__), "allegro_graph", "extended_transport")
+  autoload :Server,             File.join(File.dirname(__FILE__), "allegro_graph", "server")
+  autoload :Catalog,            File.join(File.dirname(__FILE__), "allegro_graph", "catalog")
+  autoload :Resource,           File.join(File.dirname(__FILE__), "allegro_graph", "resource")
+  autoload :Repository,         File.join(File.dirname(__FILE__), "allegro_graph", "repository")
+  autoload :Session,            File.join(File.dirname(__FILE__), "allegro_graph", "session")
+  autoload :Proxy,              File.join(File.dirname(__FILE__), "allegro_graph", "proxy")
+  autoload :Utility,            File.join(File.dirname(__FILE__), "allegro_graph", "utility")
+
+end

data/lib/allegro_graph/catalog.rb

@@ -1,4 +1,3 @@
-require File.join(File.dirname(__FILE__), "repository")
 
 module AllegroGraph
 

data/lib/allegro_graph/extended_transport.rb

@@ -0,0 +1,84 @@
+require 'json'
+
+module AllegroGraph
+  
+  # Extended transport layer for http transfers. Basic authorization and JSON transfers are supported.
+  class ExtendedTransport < Transport
+
+    # The UnexpectedStatusCodeError is raised if the :expected_status_code option is given to
+    # the :request method and the responded status code is different from the expected one.
+    class UnexpectedStatusCodeError < StandardError
+
+      attr_reader :status_code
+      attr_reader :message
+
+      def initialize(status_code, message)
+        @status_code, @message = status_code, message
+      end
+
+      def to_s
+        "#{super} received status code #{self.status_code}" + (@message ? " [#{@message}]" : "")
+      end
+
+    end
+
+    attr_reader :expected_status_code
+    attr_reader :auth_type
+    attr_reader :username
+    attr_reader :password
+
+    def initialize(http_method, url, options = { })
+      super http_method, url, options
+      @expected_status_code = options[:expected_status_code]
+      @auth_type            = options[:auth_type]
+      @username             = options[:username]
+      @password             = options[:password]
+    end
+
+    def perform
+      initialize_headers
+      super
+      check_status_code
+      parse_response
+    end
+
+    private
+
+    def initialize_headers
+      @headers["Accept"] = "application/json"
+    end
+
+    def initialize_request
+      super
+      if @auth_type == :basic
+        @request.basic_auth @username, @password
+      elsif !@auth_type.nil?
+        raise NotImplementedError, "the given auth_type [#{@auth_type}] is not implemented"
+      end
+    end
+
+    def initialize_request_body
+      super
+      if @body
+        @request.body = @body.to_json
+        @request["Content-Type"] = "application/json"
+      end
+    end
+
+    def check_status_code
+      return unless @expected_status_code
+      response_code = @response.code
+      response_body = @response.body
+      raise UnexpectedStatusCodeError.new(response_code.to_i, response_body) if @expected_status_code.to_s != response_code
+    end
+
+    def parse_response
+      body = @response.body
+      @response = body.nil? ? nil : JSON.parse(body)
+    rescue JSON::ParserError
+      @response = body.to_s
+    end
+
+  end
+
+end

data/lib/allegro_graph/proxy.rb

@@ -0,0 +1,13 @@
+
+module AllegroGraph
+
+  module Proxy
+
+    autoload :Statements, File.join(File.dirname(__FILE__), "proxy", "statements")
+    autoload :Query,      File.join(File.dirname(__FILE__), "proxy", "query")
+    autoload :Geometric,  File.join(File.dirname(__FILE__), "proxy", "geometric")
+    autoload :Mapping,    File.join(File.dirname(__FILE__), "proxy", "mapping")
+
+  end
+
+end

data/lib/allegro_graph/proxy/statements.rb

@@ -1,4 +1,3 @@
-require File.expand_path(File.join(File.dirname(__FILE__), "..", "utility", "parameter_mapper"))
 
 module AllegroGraph
 

data/lib/allegro_graph/repository.rb

@@ -1,33 +1,19 @@
-require File.join(File.dirname(__FILE__), "server")
-require File.join(File.dirname(__FILE__), "session")
-require File.join(File.dirname(__FILE__), "proxy", "statements")
-require File.join(File.dirname(__FILE__), "proxy", "query")
-require File.join(File.dirname(__FILE__), "proxy", "geometric")
-require File.join(File.dirname(__FILE__), "proxy", "mapping")
 
 module AllegroGraph
 
   # The Repository class wrap the corresponding resource on the AllegroGraph server. A repository acts as a scope for
   # statements. Simple management methods are provided.
-  class Repository
+  class Repository < Resource
 
     attr_reader   :server
     attr_reader   :catalog
     attr_accessor :name
 
-    attr_reader   :statements
-    attr_reader   :query
-    attr_reader   :geometric
-    attr_reader   :mapping
-
-    def initialize(server_or_catalog, name, options = { })
-      @catalog    = server_or_catalog.is_a?(AllegroGraph::Server) ? server_or_catalog.root_catalog : server_or_catalog
-      @server     = @catalog.server
-      @name       = name
-      @statements = Proxy::Statements.new self
-      @query      = Proxy::Query.new self
-      @geometric  = Proxy::Geometric.new self
-      @mapping    = Proxy::Mapping.new self
+    def initialize(server_or_catalog, name)
+      super
+      @catalog  = server_or_catalog.is_a?(AllegroGraph::Server) ? server_or_catalog.root_catalog : server_or_catalog
+      @server   = @catalog.server
+      @name     = name
     end
 
     def ==(other)

data/lib/allegro_graph/resource.rb

@@ -0,0 +1,22 @@
+
+module AllegroGraph
+
+  # The Resource class acts as a base for statement resources. It provide proxy classes that provide methods
+  # to manipulate that statements.
+  class Resource
+
+    attr_reader :statements
+    attr_reader :query
+    attr_reader :geometric
+    attr_reader :mapping
+
+    def initialize(*arguments)
+      @statements = Proxy::Statements.new self
+      @query      = Proxy::Query.new self
+      @geometric  = Proxy::Geometric.new self
+      @mapping    = Proxy::Mapping.new self
+    end
+
+  end
+
+end

data/lib/allegro_graph/server.rb

@@ -1,6 +1,3 @@
-require File.join(File.dirname(__FILE__), "transport")
-require File.join(File.dirname(__FILE__), "catalog")
-require File.join(File.dirname(__FILE__), "federation")
 
 module AllegroGraph
 
@@ -48,11 +45,6 @@ module AllegroGraph
       result
     end
 
-    def federations
-      federations = self.request :get, "/federated", :expected_status_code => 200
-      federations.map { |federation| Federation.new self, federation["id"] }
-    end
-
     def url
       "http://#{@host}:#{@port}"
     end

data/lib/allegro_graph/session.rb

@@ -1,32 +1,18 @@
-require File.join(File.dirname(__FILE__), "transport")
-require File.join(File.dirname(__FILE__), "proxy", "statements")
-require File.join(File.dirname(__FILE__), "proxy", "query")
-require File.join(File.dirname(__FILE__), "proxy", "geometric")
-require File.join(File.dirname(__FILE__), "proxy", "mapping")
 
 module AllegroGraph
 
   # The Session class wrap the corresponding resource on the AllegroGraph server.
-  class Session
+  class Session < Resource
 
     attr_reader :url
     attr_reader :username
     attr_reader :password
 
-    attr_reader :statements
-    attr_reader :query
-    attr_reader :geometric
-    attr_reader :mapping
-
     def initialize(options = { })
+      super
       @url      = options[:url]
       @username = options[:username]
       @password = options[:password]
-
-      @statements = Proxy::Statements.new self
-      @query      = Proxy::Query.new self
-      @geometric  = Proxy::Geometric.new self
-      @mapping    = Proxy::Mapping.new self
     end
 
     def path

data/lib/allegro_graph/transport.rb

@@ -1,7 +1,6 @@
 require 'uri'
 require 'cgi'
 require 'net/http'
-require 'json'
 
 module AllegroGraph
 
@@ -98,83 +97,4 @@ module AllegroGraph
 
   end
 
-  # Extended transport layer for http transfers. Basic authorization and JSON transfers are supported.
-  class ExtendedTransport < Transport
-
-    # The UnexpectedStatusCodeError is raised if the :expected_status_code option is given to
-    # the :request method and the responded status code is different from the expected one.
-    class UnexpectedStatusCodeError < StandardError
-
-      attr_reader :status_code
-      attr_reader :message
-
-      def initialize(status_code, message)
-        @status_code, @message = status_code, message
-      end
-
-      def to_s
-        "#{super} received status code #{self.status_code}" + (@message ? " [#{@message}]" : "")
-      end
-
-    end
-
-    attr_reader :expected_status_code
-    attr_reader :auth_type
-    attr_reader :username
-    attr_reader :password
-    
-    def initialize(http_method, url, options = { })
-      super http_method, url, options
-      @expected_status_code = options[:expected_status_code]
-      @auth_type            = options[:auth_type]
-      @username             = options[:username]
-      @password             = options[:password]
-    end
-
-    def perform
-      initialize_headers
-      super
-      check_status_code
-      parse_response
-    end
-
-    private
-
-    def initialize_headers
-      @headers["Accept"] = "application/json"
-    end
-
-    def initialize_request
-      super
-      if @auth_type == :basic
-        @request.basic_auth @username, @password
-      elsif !@auth_type.nil?
-        raise NotImplementedError, "the given auth_type [#{@auth_type}] is not implemented"
-      end
-    end
-
-    def initialize_request_body
-      super
-      if @body
-        @request.body = @body.to_json
-        @request["Content-Type"] = "application/json"
-      end
-    end
-
-    def check_status_code
-      return unless @expected_status_code
-      response_code = @response.code
-      response_body = @response.body
-      raise UnexpectedStatusCodeError.new(response_code.to_i, response_body) if @expected_status_code.to_s != response_code
-    end
-
-    def parse_response
-      body = @response.body
-      @response = body.nil? ? nil : JSON.parse(body)
-    rescue JSON::ParserError
-      @response = body.to_s
-    end
-
-  end
-
 end

data/lib/allegro_graph/utility.rb

@@ -0,0 +1,10 @@
+
+module AllegroGraph
+
+  module Utility
+
+    autoload :ParameterMapper, File.join(File.dirname(__FILE__), "utility", "parameter_mapper")
+
+  end
+
+end

data/spec/fake_transport.yml

@@ -52,33 +52,6 @@
   :response:
     :code:      "201"
     :body:      ""
--
-  :http_method: "get"
-  :url:         "http://localhost:10035/federated"
-  :response:
-    :code:      "200"
-    :body:
-      -
-        "uri":      "http://localhost:10035/federated/test_federation"
-        "id":       "test_federation"
-        "title":    "test_federation"
-        "readable": true
-        "writable": false
--
-  :http_method: "put"
-  :url:         "http://localhost:10035/federated/test_federation"
-  :parameters:
-    :repo:      [ "test_repository" ]
-    :url:       [ "http://username:password@server:10035/repositories/another" ]
-  :response:
-    :code:      "204"
-    :body:      ""
--
-  :http_method: "delete"
-  :url:         "http://localhost:10035/federated/test_federation"
-  :response:
-    :code:      "204"
-    :body:      ""
 -
   :http_method: "get"
   :url:         "http://localhost:10035/catalogs/test_catalog/repositories"

data/spec/integration/geo_spatial_spec.rb

@@ -0,0 +1,137 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "lib", "allegro_graph"))
+
+describe "geo-spatial data" do
+
+  use_real_transport!
+
+  before :each do
+    @server = AllegroGraph::Server.new :username => "test", :password => "test"
+    @repository = AllegroGraph::Repository.new @server, "test_repository"
+    @repository.create_if_missing!
+    @geometric  = @repository.geometric
+    @statements = @repository.statements
+  end
+
+  describe "types" do
+
+    it "should provide a cartesian type" do
+      result = @geometric.cartesian_type :strip_width => 1.0,
+                                         :x_min       => 2.0,
+                                         :y_min       => 2.0,
+                                         :x_max       => 20.0,
+                                         :y_max       => 20.0
+      result.should == "<http://franz.com/ns/allegrograph/3.0/geospatial/cartesian/2.0/20.0/2.0/20.0/1.0>"
+    end
+
+    it "should provide a spherical type" do
+      result = @geometric.spherical_type :strip_width   => 1.0,
+                                         :latitude_min  => 2.0,
+                                         :longitude_min => 2.0,
+                                         :latitude_max  => 20.0,
+                                         :longitude_max => 20.0
+      result.should == "<http://franz.com/ns/allegrograph/3.0/geospatial/spherical/degrees/2.0/20.0/2.0/20.0/1.0>"
+    end
+
+  end
+
+  describe "creating polygon" do
+
+    before :each do
+      @type = @geometric.cartesian_type :strip_width => 1.0,
+                                        :x_min       => 2.0,
+                                        :y_min       => 2.0,
+                                        :x_max       => 20.0,
+                                        :y_max       => 20.0
+      @polygon = [ [ 2.0, 2.0 ], [ 11.0, 2.0 ], [ 11.0, 11.0 ], [ 2.0, 11.0 ] ]
+    end
+
+    it "should return true" do
+      result = @geometric.create_polygon @polygon, :name => "test_polygon", :type => @type
+      result.should be_true
+    end
+
+  end
+
+  context "in a cartesian system" do
+
+    before :each do
+      @type = @geometric.cartesian_type :strip_width => 1.0,
+                                        :x_min       => 2.0,
+                                        :y_min       => 2.0,
+                                        :x_max       => 20.0,
+                                        :y_max       => 20.0
+      @statements.create "\"test_subject\"", "\"at\"", "\"+10+10\"^^#{@type}"
+      @statements.create "\"another_subject\"", "\"at\"", "\"+15+15\"^^#{@type}"
+    end
+
+    it "should find objects inside a box" do
+      result = @statements.find_inside_box :type       => @type,
+                                           :predicate  => "\"at\"",
+                                           :x_min      => 8.0,
+                                           :y_min      => 8.0,
+                                           :x_max      => 11.0,
+                                           :y_max      => 11.0
+      result.should include([ "\"test_subject\"", "\"at\"", "\"+10.000000000931323+10.000000000931323\"^^#{@type}"])
+      result.should_not include([ "\"another_subject\"", "\"at\"", "\"+15.000000000465661+15.000000000465661\"^^#{@type}"])
+    end
+
+    it "should find objects inside a circle" do
+      result = @statements.find_inside_circle :type      => @type,
+                                              :predicate => "\"at\"",
+                                              :x         => 9.0,
+                                              :y         => 9.0,
+                                              :radius    => 2.0
+      result.should include([ "\"test_subject\"", "\"at\"", "\"+10.000000000931323+10.000000000931323\"^^#{@type}"])
+      result.should_not include([ "\"another_subject\"", "\"at\"", "\"+15.000000000465661+15.000000000465661\"^^#{@type}"])
+    end
+
+    context "with a defined polygon" do
+
+      before :each do
+        @type = @geometric.cartesian_type :strip_width => 1,
+                                          :x_min       => -100,
+                                          :y_min       => -100,
+                                          :x_max       => 100,
+                                          :y_max       => 100
+        @statements.create "\"test_subject\"", "\"at\"", "\"+1+1\"^^#{@type}"
+        @geometric.create_polygon [ [ 0, -100 ], [ 0, 100 ], [ 100, 100 ], [ 100, -100 ] ],
+                                  :name => "test_polygon",
+                                  :type => @type
+      end
+
+      it "should find objects inside that polygon" do
+        result = @statements.find_inside_polygon :type         => @type,
+                                                 :predicate    => "\"at\"",
+                                                 :polygon_name => "test_polygon"
+        result.should include([ "\"test_subject\"", "\"at\"", "\"+0.9999999776482582+0.9999999776482582\"^^<http://franz.com/ns/allegrograph/3.0/geospatial/cartesian/-100.0/100.0/-100.0/100.0/1.0>"])
+      end
+
+    end
+
+  end
+
+  context "in a spherical system" do
+
+    before :each do
+      @type = @geometric.spherical_type :strip_width   => 1.0,
+                                        :latitude_min  => 2.0,
+                                        :longitude_min => 2.0,
+                                        :latitude_max  => 20.0,
+                                        :longitude_max => 20.0
+      @statements.create "\"test_subject\"", "\"at\"", "\"+10.00+010.00\"^^#{@type}"
+    end
+
+    it "should find objects inside a haversine" do
+      result = @statements.find_inside_haversine :type       => @type,
+                                                 :predicate  => "\"at\"",
+                                                 :latitude   => 9.0,
+                                                 :longitude  => 9.0,
+                                                 :radius     => 200.0,
+                                                 :unit       => :km
+      result.should include([ "\"test_subject\"", "\"at\"", "\"+100000+0100000\"^^<http://franz.com/ns/allegrograph/3.0/geospatial/spherical/degrees/2.0/20.0/2.0/20.0/1.0>"])
+    end
+
+  end
+
+end