agraph 0.1.0.beta1 → 0.1.0.beta2

data/README.rdoc

@@ -14,6 +14,12 @@ The features that are exposed by this client are...
 * performing SparQL and Prolog queries
 * mapping of data type
 
+== Installation
+
+There are no special dependencies. Just type
+
+  gem install agraph
+
 == Repository management
 
 A repository can be created by simply typing the following.
@@ -62,7 +68,7 @@ The result will be an array that holds arrays of all matching statements.
 Before coordinates can be added, a fitting type has to be requested from the database. Coordinates can have the
 cartesian (x and y) or spherical (latitude and longitude) type. When creating the type, also a range has to be defined.
 
-  cartesian_type = repository.geo.cartesian_type 1, 0, 0, 100, 100
+  cartesian_type = repository.geometric.cartesian_type 1, 0, 0, 100, 100
 
 The first argument specifies the strip width and the last four the top-left and bottom-right corner of the rectangle
 that represent the boundaries for any coordinate.
@@ -75,14 +81,19 @@ Afterwards, the return type can be used add geometric nodes (subjects or objects
 
 To find statements by thier assigned coordinates, the following methods are provided.
 
-  repository.geo.inside_box
-  repository.geo.inside_circle
-  repository.geo.inside_haversine
-  repository.geo.inside_polygon
+  repository.statements.find_inside_box
+  repository.statements.find_inside_circle
+  repository.statements.find_inside_haversine
+  repository.statements.find_inside_polygon
 
 The previously create statement will be returned by
 
-  repository.geo.inside_box cartesian_type, "<a_predicate>", 10, 10, 30, 30
+  repository.geometric.find_inside_box :type      => cartesian_type,
+                                       :predicate => "<a_predicate>",
+                                       :x_min     => 10,
+                                       :y_min     => 10,
+                                       :x_max     => 30,
+                                       :y_max     => 30
 
 == Transactions
 

data/Rakefile

@@ -9,12 +9,13 @@ task :default => :spec
 
 specification = Gem::Specification.new do |specification|
   specification.name              = "agraph"
-  specification.version           = "0.1.0.beta1"
-  specification.date              = "2010-03-29"
+  specification.version           = "0.1.0.beta2"
+  specification.date              = "2010-03-30"
   specification.email             = "b.phifty@gmail.com"
   specification.homepage          = "http://github.com/phifty/agraph"
   specification.summary           = "Client for the AllegroGraph 4.x graph database."
   specification.description       = "The gem provides a client for the AllegroGraph 4.x RDF graph database. Features like searching geo-spatial data, type mapping and transactions are supported."
+  specification.rubyforge_project = "agraph"
   specification.has_rdoc          = true
   specification.authors           = [ "Philipp Bruell" ]
   specification.files             = [ "README.rdoc", "Rakefile" ] + Dir["{lib,spec}/**/*"]

data/lib/agraph.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "allegro_graph")

data/lib/allegro_graph.rb

@@ -1,5 +1,5 @@
-require File.expand_path(File.join(File.dirname(__FILE__), "allegro_graph", "server"))
-require File.expand_path(File.join(File.dirname(__FILE__), "allegro_graph", "catalog"))
-require File.expand_path(File.join(File.dirname(__FILE__), "allegro_graph", "repository"))
-require File.expand_path(File.join(File.dirname(__FILE__), "allegro_graph", "session"))
-require File.expand_path(File.join(File.dirname(__FILE__), "allegro_graph", "federation"))
+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")

data/lib/allegro_graph/catalog.rb

@@ -2,6 +2,8 @@ require File.join(File.dirname(__FILE__), "repository")
 
 module AllegroGraph
 
+  # The Catalog class wrap the corresponding resource on the AllegroGraph server. A catalog can hold
+  # many repositories.
   class Catalog
 
     attr_reader   :server

data/lib/allegro_graph/federation.rb

@@ -1,11 +1,13 @@
 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", "geo")
+require File.join(File.dirname(__FILE__), "proxy", "geometric")
 require File.join(File.dirname(__FILE__), "proxy", "mapping")
 
 module AllegroGraph
 
+  # The Federation class wrap the corresponding resource on the AllegroGraph server. A federation is a collection
+  # of many repositories that acts like a single one. Only read access is allowed.
   class Federation
 
     attr_reader   :server
@@ -15,7 +17,7 @@ module AllegroGraph
 
     attr_reader :statements
     attr_reader :query
-    attr_reader :geo
+    attr_reader :geometric
     attr_reader :mapping
 
     def initialize(server, name, options = { })
@@ -26,7 +28,7 @@ module AllegroGraph
 
       @statements = Proxy::Statements.new self
       @query      = Proxy::Query.new self
-      @geo        = Proxy::Geo.new self
+      @geometric  = Proxy::Geometric.new self
       @mapping    = Proxy::Mapping.new self
     end
 

data/lib/allegro_graph/proxy/geometric.rb

@@ -0,0 +1,51 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "utility", "parameter_mapper"))
+
+module AllegroGraph
+
+  module Proxy
+
+    # The Geometric class acts as proxy to the geo-functions of the AllegroGraph server.
+    class Geometric
+
+      attr_reader :resource
+
+      def initialize(resource)
+        @resource = resource
+      end
+
+      def path
+        "#{@resource.path}/geo"
+      end
+
+      def cartesian_type(parameters = { })
+        parameters = Utility::ParameterMapper.map parameters, :cartesian_type
+        type = @resource.request :post, self.path + "/types/cartesian", :parameters => parameters, :expected_status_code => 200
+        type.sub! /^.*</, "<"
+        type.sub! />.*$/, ">"
+        type
+      end
+
+      def spherical_type(parameters = { })
+        parameters = Utility::ParameterMapper.map parameters, :spherical_type
+        type = @resource.request :post, self.path + "/types/spherical", :parameters => parameters, :expected_status_code => 200
+        type.sub! /^.*</, "<"
+        type.sub! />.*$/, ">"
+        type
+      end
+
+      def create_polygon(points, parameters = { })
+        type = parameters.delete :type
+        parameters = Utility::ParameterMapper.map parameters, :create_polygon
+
+        raise ArgumentError, "at least three points has to defined" unless points.is_a?(Array) && points.size >= 3
+        parameters[:point] = points.map{ |point| "\"%+g%+g\"^^%s" % [ point[0], point[1], type ] }
+
+        @resource.request :put, self.path + "/polygon", :parameters => parameters, :expected_status_code => 204
+        true
+      end
+
+    end
+
+  end
+
+end

data/lib/allegro_graph/proxy/mapping.rb

@@ -3,6 +3,7 @@ module AllegroGraph
 
   module Proxy
 
+    # The Mapping class acts as proxy to the data type mapping functions of the AllegroGraph server.
     class Mapping
 
       attr_reader :resource

data/lib/allegro_graph/proxy/query.rb

@@ -3,6 +3,7 @@ module AllegroGraph
 
   module Proxy
 
+    # The Query class acts as proxy that bypasses SparQL and Prolog queries to the AllegroGraph server.
     class Query
 
       LANGUAGES = [ :sparql, :prolog ].freeze unless defined?(LANGUAGES)
@@ -21,8 +22,9 @@ module AllegroGraph
       end
 
       def language=(value)
-        raise NotImplementedError, "query langauge [#{value}] is not implemented" unless LANGUAGES.include?(value.to_sym)
-        @language = value.to_sym
+        value = value.to_sym
+        raise NotImplementedError, "query langauge [#{value}] is not implemented" unless LANGUAGES.include?(value)
+        @language = value
       end
 
       def perform(query)

data/lib/allegro_graph/proxy/statements.rb

@@ -1,8 +1,11 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "utility", "parameter_mapper"))
 
 module AllegroGraph
 
   module Proxy
 
+    # The Statement class acts as proxy to functions that add, remove or find statements
+    # in the AllegroGraph data store.
     class Statements
 
       attr_reader :resource
@@ -12,16 +15,27 @@ module AllegroGraph
       end
 
       def path
-        "#{@resource.path}/statements"
+        @resource.path
       end
 
       def create(subject, predicate, object, context = nil)
         statement = [ subject, predicate, object ]
         statement << context if context
-        @resource.request :post, self.path, :body => [ statement ], :expected_status_code => 204
+        @resource.request :post, self.path + "/statements", :body => [ statement ], :expected_status_code => 204
         true
       end
 
+      def delete(options = { })
+        parameters = { }
+
+        { :subject => :subj, :predicate => :pred, :object => :obj, :context => :context }.each do |option_key, parameter_key|
+          value = options[option_key]
+          parameters.merge! parameter_key => value if value
+        end
+
+        @resource.request :delete, self.path + "/statements", :parameters => parameters, :expected_status_code => 200
+      end
+
       def find(options = { })
         parameters = { }
 
@@ -38,18 +52,27 @@ module AllegroGraph
 
         parameters = nil if parameters.empty?
 
-        @resource.request :get, self.path, :parameters => parameters, :expected_status_code => 200
+        @resource.request :get, self.path + "/statements", :parameters => parameters, :expected_status_code => 200
       end
 
-      def delete(options = { })
-        parameters = { }
+      def find_inside_box(parameters = { })
+        parameters = Utility::ParameterMapper.map parameters, :find_inside_box
+        @resource.request :get, self.path + "/geo/box", :parameters => parameters, :expected_status_code => 200
+      end
 
-        { :subject => :subj, :predicate => :pred, :object => :obj, :context => :context }.each do |option_key, parameter_key|
-          value = options[option_key]
-          parameters.merge! parameter_key => value if value
-        end
+      def find_inside_circle(parameters = { })
+        parameters = Utility::ParameterMapper.map parameters, :find_inside_circle
+        @resource.request :get, self.path + "/geo/circle", :parameters => parameters, :expected_status_code => 200
+      end
+
+      def find_inside_haversine(parameters = { })
+        parameters = Utility::ParameterMapper.map parameters, :find_inside_haversine
+        @resource.request :get, self.path + "/geo/haversine", :parameters => parameters, :expected_status_code => 200
+      end
 
-        @resource.request :delete, self.path, :parameters => parameters, :expected_status_code => 200
+      def find_inside_polygon(parameters = { })
+        parameters = Utility::ParameterMapper.map parameters, :find_inside_polygon
+        @resource.request :get, self.path + "/geo/polygon", :parameters => parameters, :expected_status_code => 200
       end
 
     end

data/lib/allegro_graph/repository.rb

@@ -2,11 +2,13 @@ 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", "geo")
+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
 
     attr_reader   :server
@@ -15,7 +17,7 @@ module AllegroGraph
 
     attr_reader   :statements
     attr_reader   :query
-    attr_reader   :geo
+    attr_reader   :geometric
     attr_reader   :mapping
 
     def initialize(server_or_catalog, name, options = { })
@@ -24,7 +26,7 @@ module AllegroGraph
       @name       = name
       @statements = Proxy::Statements.new self
       @query      = Proxy::Query.new self
-      @geo        = Proxy::Geo.new self
+      @geometric  = Proxy::Geometric.new self
       @mapping    = Proxy::Mapping.new self
     end
 
@@ -74,14 +76,18 @@ module AllegroGraph
     end
 
     def transaction(&block)
-      session = Session.create self
+      self.class.transaction self, &block
+    end
+
+    def self.transaction(repository, &block)
+      session = Session.create repository
       begin
         session.instance_eval &block
       rescue Object => error
         session.rollback
         raise error
       end
-      session.commit
+      session.commit      
     end
 
   end

data/lib/allegro_graph/session.rb

@@ -1,11 +1,12 @@
 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", "geo")
+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
 
     attr_reader :url
@@ -14,7 +15,7 @@ module AllegroGraph
 
     attr_reader :statements
     attr_reader :query
-    attr_reader :geo
+    attr_reader :geometric
     attr_reader :mapping
 
     def initialize(options = { })
@@ -24,7 +25,7 @@ module AllegroGraph
 
       @statements = Proxy::Statements.new self
       @query      = Proxy::Query.new self
-      @geo        = Proxy::Geo.new self
+      @geometric  = Proxy::Geometric.new self
       @mapping    = Proxy::Mapping.new self
     end
 
@@ -50,7 +51,8 @@ module AllegroGraph
       url = repository.request :post, repository.path + "/session", :expected_status_code => 200
       url.sub! /^"/, ""
       url.sub! /"$/, ""
-      new :url => url, :username => repository.server.username, :password => repository.server.password
+      server = repository.server
+      new :url => url, :username => server.username, :password => server.password
     end
 
     private

data/lib/allegro_graph/transport.rb

@@ -36,7 +36,7 @@ module AllegroGraph
     private
 
     def initialize_request_class
-      request_class_name = @http_method.capitalize
+      request_class_name = @http_method.to_s.capitalize
       raise NotImplementedError, "the request method #{http_method} is not implemented" unless Net::HTTP.const_defined?(request_class_name)
       @request_class = Net::HTTP.const_get request_class_name
     end
@@ -62,11 +62,8 @@ module AllegroGraph
     def quote_parameters
       @quoted_parameters = { }
       @parameters.each do |key, value|
-        if value.is_a?(Array)
-          @quoted_parameters[ CGI.escape("#{key}") ] = value.map{ |element| CGI.escape element }
-        else
-          @quoted_parameters[ CGI.escape("#{key}") ] = CGI.escape value
-        end
+        quoted_key = CGI.escape(key.to_s)
+        @quoted_parameters[quoted_key] = value.is_a?(Array) ? value.map{ |element| CGI.escape element } : CGI.escape(value)
       end
     end
     
@@ -93,6 +90,7 @@ 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
@@ -159,9 +157,10 @@ module AllegroGraph
     end
 
     def parse_response
-      @response = @response.body.nil? ? nil : JSON.parse(@response.body)
+      body = @response.body
+      @response = body.nil? ? nil : JSON.parse(body)
     rescue JSON::ParserError
-      @response = @response.body.to_s
+      @response = body.to_s
     end
 
   end

data/lib/allegro_graph/utility/parameter_mapper.rb

@@ -0,0 +1,77 @@
+
+module AllegroGraph
+
+  module Utility
+
+    module ParameterMapper
+
+      MAP = {
+        :strip_width    => { :to => :stripWidth,  :for => [ :cartesian_type, :spherical_type ], :default => 1 },
+        :x_min          => { :to => :xmin,        :for => [ :cartesian_type, :find_inside_box ] },
+        :y_min          => { :to => :ymin,        :for => [ :cartesian_type, :find_inside_box ] },
+        :x_max          => { :to => :xmax,        :for => [ :cartesian_type, :find_inside_box ] },
+        :y_max          => { :to => :ymax,        :for => [ :cartesian_type, :find_inside_box ] },
+        :unit           => { :to => :unit,        :for => [ :spherical_type, :find_inside_haversine ], :default => :degree },
+        :latitude_min   => { :to => :latmin,      :for => [ :spherical_type ] },
+        :longitude_min  => { :to => :longmin,     :for => [ :spherical_type ] },
+        :latitude_max   => { :to => :latmax,      :for => [ :spherical_type ] },
+        :longitude_max  => { :to => :longmax,     :for => [ :spherical_type ] },
+        :name           => { :to => :resource,    :for => [ :create_polygon ], :modifier => [ :quote ] },
+        :type           => { :to => :type,        :for => [ :find_inside_box, :find_inside_circle, :find_inside_haversine, :find_inside_polygon ] },
+        :predicate      => { :to => :predicate,   :for => [ :find_inside_box, :find_inside_circle, :find_inside_haversine, :find_inside_polygon ] },
+        :x              => { :to => :x,           :for => [ :find_inside_circle ] },
+        :y              => { :to => :y,           :for => [ :find_inside_circle ] },
+        :radius         => { :to => :radius,      :for => [ :find_inside_circle, :find_inside_haversine ] },
+        :latitude       => { :to => :lat,         :for => [ :find_inside_haversine ], :modifier => :latitude_to_iso },
+        :longitude      => { :to => :long,        :for => [ :find_inside_haversine ], :modifier => :longitude_to_iso },
+        :polygon_name   => { :to => :polygon,     :for => [ :find_inside_polygon ], :modifier => [ :quote ] }
+      }.freeze unless defined?(MAP)
+
+      def self.map(parameters, method_name)
+        result = { }
+        MAP.each do |key, mapping|
+          value = parameters[key] || mapping[:default]
+          required = [ mapping[:for] ].flatten.include? method_name.to_sym
+          if required
+            if value
+              [ mapping[:modifier] ].flatten.compact.each do |modifier|
+                value = send modifier, value
+              end
+              result[ mapping[:to] ] = value.to_s
+            else
+              raise ArgumentError, "missing parameter :#{key}!"
+            end
+          end
+        end
+        result
+      end
+
+      def self.quote(value)
+        "\"#{value}\""
+      end
+
+      def self.latitude_to_iso(value)
+        float_to_iso value, 2
+      end
+
+      def self.longitude_to_iso(value)
+        float_to_iso value, 3
+      end
+
+      private
+
+      def self.float_to_iso(value, digits)
+        sign = "+"
+        if value < 0
+          sign = "-"
+          value = -value
+        end
+        floor = value.to_i
+        sign + (("%%0%dd" % digits) % floor) + (".%07d" % ((value - floor) * 10000000))
+      end
+
+    end
+
+  end
+
+end

data/spec/integration/basic_spec.rb

@@ -166,22 +166,31 @@ describe "integration" do
 
   end
 
-  describe "geo" do
+  describe "geo-spatial data" do
 
     before :each do
       @repository.create_if_missing!
-      @geo = @repository.geo
+      @geometric  = @repository.geometric
+      @statements = @repository.statements
     end
 
     describe "types" do
 
       it "should provide a cartesian type" do
-        result = @geo.cartesian_type 1.0, 2.0, 2.0, 20.0, 20.0
+        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 = @geo.spherical_type 1.0, :degree, 2.0, 2.0, 20.0, 20.0
+        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
       
@@ -190,12 +199,16 @@ describe "integration" do
     describe "creating polygon" do
 
       before :each do
-        @type = @geo.cartesian_type 1.0, 2.0, 2.0, 20.0, 20.0
+        @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 = @geo.create_polygon "test_polygon", @type, @polygon
+        result = @geometric.create_polygon @polygon, :name => "test_polygon", :type => @type
         result.should be_true
       end
       
@@ -204,19 +217,32 @@ describe "integration" do
     context "in a cartesian system" do
 
       before :each do
-        @type = @geo.cartesian_type 1.0, 2.0, 2.0, 20.0, 20.0
-        @repository.statements.create "\"test_subject\"", "\"at\"", "\"+10+10\"^^#{@type}"
-        @repository.statements.create "\"another_subject\"", "\"at\"", "\"+15+15\"^^#{@type}"
+        @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 = @geo.inside_box @type, "\"at\"", 8.0, 8.0, 11.0, 11.0
+        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 = @geo.inside_circle @type, "\"at\"", 9.0, 9.0, 2.0
+        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
@@ -224,14 +250,22 @@ describe "integration" do
       context "with a defined polygon" do
 
         before :each do
-          @type = @geo.cartesian_type 1, -100, -100, 100, 100
-          @repository.statements.create "\"test_subject\"", "\"at\"", "\"+1+1\"^^#{@type}"
-          @geo.create_polygon "test_polygon", @type, [ [ 0, -100 ], [ 0, 100 ], [ 100, 100 ], [ 100, -100 ] ]
+          @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
           pending
-          result = @geo.inside_polygon @type, "\"at\"", "test_polygon"
+          result = @statements.find_inside_polygon :type         => @type,
+                                                   :predicate    => "\"at\"",
+                                                   :polygon_name => "test_polygon"
           result.should include([ "\"test_subject\"", "\"at\"", "\"+1+1\"^^<http://franz.com/ns/allegrograph/3.0/geospatial/cartesian/2.0/20.0/2.0/20.0/1.0>"])
         end
 
@@ -242,12 +276,21 @@ describe "integration" do
     context "in a spherical system" do
 
       before :each do
-        @type = @geo.spherical_type 1.0, :degree, 2.0, 2.0, 20.0, 20.0
-        @repository.statements.create "\"test_subject\"", "\"at\"", "\"+10.00+010.00\"^^#{@type}"
+        @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 = @geo.inside_haversine @type, "\"at\"", 9.0, 9.0, 200.0, :km
+        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
 

data/spec/lib/allegro_graph/proxy/geometric_spec.rb

@@ -0,0 +1,65 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "spec_helper"))
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "..", "lib", "allegro_graph", "proxy", "geometric"))
+
+describe AllegroGraph::Proxy::Geometric do
+
+  before :each do
+    @server = AllegroGraph::Server.new :username => "test", :password => "test"
+    @catalog = AllegroGraph::Catalog.new @server, "test_catalog"
+    @repository = AllegroGraph::Repository.new @catalog, "test_repository"
+    @geometric = AllegroGraph::Proxy::Geometric.new @repository
+    @type = @geometric.cartesian_type :strip_width  => 1.0,
+                                      :x_min        => 2.0,
+                                      :y_min        => 2.0,
+                                      :x_max        => 20.0,
+                                      :y_max        => 20.0
+  end
+
+  describe "path" do
+
+    it "should return the correct path" do
+      @geometric.path.should == "#{@repository.path}/geo"
+    end
+
+  end
+
+  describe "cartesian_type" 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
+
+  end
+
+  describe "spherical_type" do
+
+    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 "create_polygon" do
+
+    before :each do
+      @polygon = [ [ 2.0, 2.0 ], [ 10.0, 2.0 ], [ 10.0, 10.0 ], [ 2.0, 10.0 ] ]
+    end
+
+    it "should create a polygon" do
+      result = @geometric.create_polygon @polygon, :name => "test_polygon", :type => @type
+      result.should be_true
+    end
+
+  end
+
+end

data/spec/lib/allegro_graph/proxy/mapping_spec.rb

@@ -1,7 +1,7 @@
 require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "spec_helper"))
 require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "..", "lib", "allegro_graph", "proxy", "mapping"))
 
-describe AllegroGraph::Proxy::Geo do
+describe AllegroGraph::Proxy::Geometric do
 
   before :each do
     @server = AllegroGraph::Server.new :username => "test", :password => "test"

data/spec/lib/allegro_graph/proxy/statements_spec.rb

@@ -8,12 +8,17 @@ describe AllegroGraph::Proxy::Statements do
     @catalog = AllegroGraph::Catalog.new @server, "test_catalog"
     @repository = AllegroGraph::Repository.new @catalog, "test_repository"
     @statements = AllegroGraph::Proxy::Statements.new @repository
+    @type = @repository.geometric.cartesian_type :strip_width  => 1.0,
+                                                 :x_min        => 2.0,
+                                                 :y_min        => 2.0,
+                                                 :x_max        => 20.0,
+                                                 :y_max        => 20.0
   end
 
   describe "path" do
 
     it "should return the correct path" do
-      @statements.path.should == "#{@repository.path}/statements"
+      @statements.path.should == @repository.path
     end
     
   end
@@ -27,6 +32,15 @@ describe AllegroGraph::Proxy::Statements do
 
   end
 
+  describe "delete" do
+
+    it "should delete all statements" do
+      result = @statements.delete :subject => "test_subject"
+      result.should be_true
+    end
+
+  end
+
   describe "find" do
 
     it "should find all statements" do
@@ -46,11 +60,54 @@ describe AllegroGraph::Proxy::Statements do
 
   end
 
-  describe "delete" do
+  describe "find_inside_box" do
 
-    it "should delete all statements" do
-      result = @statements.delete :subject => "test_subject"
-      result.should be_true
+    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\"^^<http://franz.com/ns/allegrograph/3.0/geospatial/cartesian/2.0/20.0/2.0/20.0/1.0>" ])
+    end
+
+  end
+
+  describe "find_inside_circle" do
+
+    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\"^^<http://franz.com/ns/allegrograph/3.0/geospatial/cartesian/2.0/20.0/2.0/20.0/1.0>" ])
+    end
+
+  end
+
+  describe "find_inside_haversine" do
+
+    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
+
+  describe "find_inside_polygon" do
+
+    it "should find objects inside a polygon" do
+      result = @statements.find_inside_polygon :type          => @type,
+                                               :predicate     => "\"at\"",
+                                               :polygon_name  => "test_polygon"
+      result.should include([ "\"test_subject\"", "\"at\"", "\"+10.000000000931323+10.000000000931323\"^^<http://franz.com/ns/allegrograph/3.0/geospatial/cartesian/2.0/20.0/2.0/20.0/1.0>"])
     end
 
   end

data/spec/lib/allegro_graph/utility/parameter_mapper_spec.rb

@@ -0,0 +1,56 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "spec_helper"))
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "..", "lib", "allegro_graph", "utility", "parameter_mapper"))
+
+describe AllegroGraph::Utility::ParameterMapper do
+
+  before :each do
+    @parameters = {
+      :strip_width    => 10,
+      :latitude_min   => 2.0,
+      :longitude_min  => 2.0,
+      :latitude_max   => 20.0,
+      :longitude_max  => 20.0,
+      :x_min          => 2,
+      :y_min          => 2,
+      :x_max          => 20,
+      :y_max          => 20,
+      :name           => "test"
+    }
+  end
+
+  describe "map" do
+
+    def do_map(method_name = :spherical_type)
+      AllegroGraph::Utility::ParameterMapper.map @parameters, method_name
+    end
+
+    it "should return the mapped parameters" do
+      do_map.should == {
+        :stripWidth => "10",
+        :unit       => "degree",
+        :latmin     => "2.0",
+        :longmin    => "2.0",
+        :latmax     => "20.0",
+        :longmax    => "20.0"
+      }
+    end
+
+    it "should map only the right parameters" do
+      do_map(:cartesian_type).should == {
+        :stripWidth => "10",
+        :xmin       => "2",
+        :ymin       => "2",
+        :xmax       => "20",
+        :ymax       => "20"
+      }
+    end
+
+    it "should modify the parameter values" do
+      do_map(:create_polygon).should == {
+        :resource => "\"test\""
+      }
+    end
+
+  end
+
+end

metadata

@@ -6,8 +6,8 @@ version: !ruby/object:Gem::Version
   - 0
   - 1
   - 0
-  - beta1
-  version: 0.1.0.beta1
+  - beta2
+  version: 0.1.0.beta2
 platform: ruby
 authors: 
 - Philipp Bruell
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-29 00:00:00 +02:00
+date: 2010-03-30 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -32,7 +32,7 @@ files:
 - Rakefile
 - lib/allegro_graph/federation.rb
 - lib/allegro_graph/catalog.rb
-- lib/allegro_graph/proxy/geo.rb
+- lib/allegro_graph/proxy/geometric.rb
 - lib/allegro_graph/proxy/mapping.rb
 - lib/allegro_graph/proxy/query.rb
 - lib/allegro_graph/proxy/statements.rb
@@ -40,19 +40,22 @@ files:
 - lib/allegro_graph/server.rb
 - lib/allegro_graph/repository.rb
 - lib/allegro_graph/transport.rb
+- lib/allegro_graph/utility/parameter_mapper.rb
 - lib/allegro_graph.rb
+- lib/agraph.rb
 - lib/code_smells.reek
 - spec/spec_helper.rb
 - spec/lib/allegro_graph/server_spec.rb
 - spec/lib/allegro_graph/transport_spec.rb
 - spec/lib/allegro_graph/proxy/query_spec.rb
+- spec/lib/allegro_graph/proxy/geometric_spec.rb
 - spec/lib/allegro_graph/proxy/statements_spec.rb
 - spec/lib/allegro_graph/proxy/mapping_spec.rb
-- spec/lib/allegro_graph/proxy/geo_spec.rb
 - spec/lib/allegro_graph/catalog_spec.rb
 - spec/lib/allegro_graph/session_spec.rb
 - spec/lib/allegro_graph/repository_spec.rb
 - spec/lib/allegro_graph/federation_spec.rb
+- spec/lib/allegro_graph/utility/parameter_mapper_spec.rb
 - spec/fake_transport_helper.rb
 - spec/integration/basic_spec.rb
 - spec/fake_transport.yml
@@ -83,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: agraph
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3

data/lib/allegro_graph/proxy/geo.rb

@@ -1,117 +0,0 @@
-
-module AllegroGraph
-
-  module Proxy
-
-    class Geo
-
-      attr_reader :resource
-
-      def initialize(resource)
-        @resource = resource
-      end
-
-      def path
-        "#{@resource.path}/geo"
-      end
-
-      def cartesian_type(strip_width, x_min, y_min, x_max, y_max)
-        parameters = {
-          :stripWidth => strip_width.to_s,
-          :xmin       => x_min.to_s,
-          :ymin       => y_min.to_s,
-          :xmax       => x_max.to_s,
-          :ymax       => y_max.to_s
-        }
-        type = @resource.request :post, self.path + "/types/cartesian", :parameters => parameters, :expected_status_code => 200
-        type.sub! /^.*</, "<"
-        type.sub! />.*$/, ">"
-        type
-      end
-
-      def spherical_type(strip_width, unit, latitude_min, longitude_min, latitude_max, longitude_max)
-        parameters = {
-          :stripWidth => strip_width.to_s,
-          :unit       => unit.to_s,
-          :latmin     => latitude_min.to_s,
-          :longmin    => longitude_min.to_s,
-          :latmax     => latitude_max.to_s,
-          :longmax    => longitude_max.to_s
-        }
-        type = @resource.request :post, self.path + "/types/spherical", :parameters => parameters, :expected_status_code => 200
-        type.sub! /^.*</, "<"
-        type.sub! />.*$/, ">"
-        type
-      end
-
-      def create_polygon(name, type, points)
-        raise ArgumentError, "at least three points has to defined" unless points.is_a?(Array) && points.size >= 3
-        parameters = {
-          :resource => "\"#{name}\"",
-          :point    => points.map{ |point| "\"%+g%+g\"^^%s" % [ point[0], point[1], type ] }
-        }
-        @resource.request :put, self.path + "/polygon", :parameters => parameters, :expected_status_code => 204
-        true
-      end
-
-      def inside_box(type, predicate, x_min, y_min, x_max, y_max)
-        parameters = {
-          :type       => type,
-          :predicate  => predicate,
-          :xmin       => x_min.to_s,
-          :ymin       => y_min.to_s,
-          :xmax       => x_max.to_s,
-          :ymax       => y_max.to_s
-        }
-        @resource.request :get, self.path + "/box", :parameters => parameters, :expected_status_code => 200
-      end
-
-      def inside_circle(type, predicate, x, y, radius)
-        parameters = {
-          :type       => type,
-          :predicate  => predicate,
-          :x          => x.to_s,
-          :y          => y.to_s,
-          :radius     => radius.to_s
-        }
-        @resource.request :get, self.path + "/circle", :parameters => parameters, :expected_status_code => 200
-      end
-
-      def inside_haversine(type, predicate, latitude, longitude, radius, unit = :km)
-        parameters = {
-          :type       => type,
-          :predicate  => predicate,
-          :lat        => float_to_iso_6709(latitude, 2),
-          :long       => float_to_iso_6709(longitude, 3),
-          :radius     => radius.to_s,
-          :unit       => unit.to_s
-        }
-        @resource.request :get, self.path + "/haversine", :parameters => parameters, :expected_status_code => 200
-      end
-
-      def inside_polygon(type, predicate, name)
-        parameters = {
-          :type       => type,
-          :predicate  => predicate,
-          :polygon    => "\"#{name}\""
-        }
-        @resource.request :get, self.path + "/polygon", :parameters => parameters, :expected_status_code => 200
-      end
-
-      private
-
-      def float_to_iso_6709(value, digits)
-        sign = "+"
-        if value < 0
-          sign = "-"
-          value = -value
-        end
-        floor = value.to_i
-        sign + (("%%0%dd" % digits) % floor) + (".%07d" % ((value - floor) * 10000000))
-      end
-
-    end
-
-  end
-
-end

data/spec/lib/allegro_graph/proxy/geo_spec.rb

@@ -1,89 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "spec_helper"))
-require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "..", "lib", "allegro_graph", "proxy", "geo"))
-
-describe AllegroGraph::Proxy::Geo do
-
-  before :each do
-    @server = AllegroGraph::Server.new :username => "test", :password => "test"
-    @catalog = AllegroGraph::Catalog.new @server, "test_catalog"
-    @repository = AllegroGraph::Repository.new @catalog, "test_repository"
-    @geo = AllegroGraph::Proxy::Geo.new @repository
-    @type = @geo.cartesian_type 1.0, 2.0, 2.0, 20.0, 20.0
-  end
-
-  describe "path" do
-
-    it "should return the correct path" do
-      @geo.path.should == "#{@repository.path}/geo"
-    end
-
-  end
-
-  describe "cartesian_type" do
-
-    it "should provide a cartesian type" do
-      result = @geo.cartesian_type 1.0, 2.0, 2.0, 20.0, 20.0
-      result.should == "<http://franz.com/ns/allegrograph/3.0/geospatial/cartesian/2.0/20.0/2.0/20.0/1.0>"
-    end
-
-  end
-
-  describe "spherical_type" do
-
-    it "should provide a spherical type" do
-      result = @geo.spherical_type 1.0, :degree, 2.0, 2.0, 20.0, 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 "create_polygon" do
-
-    before :each do
-      @polygon = [ [ 2.0, 2.0 ], [ 10.0, 2.0 ], [ 10.0, 10.0 ], [ 2.0, 10.0 ] ]
-    end
-
-    it "should create a polygon" do
-      result = @geo.create_polygon "test_polygon", @type, @polygon
-      result.should be_true
-    end
-
-  end
-
-  describe "inside_box" do
-
-    it "should find objects inside a box" do
-      result = @geo.inside_box @type, "\"at\"", 8.0, 8.0, 11.0, 11.0
-      result.should include([ "\"test_subject\"", "\"at\"", "\"+10.000000000931323+10.000000000931323\"^^<http://franz.com/ns/allegrograph/3.0/geospatial/cartesian/2.0/20.0/2.0/20.0/1.0>"])
-    end
-
-  end
-
-  describe "inside_circle" do
-
-    it "should find objects inside a circle" do
-      result = @geo.inside_circle @type, "\"at\"", 9.0, 9.0, 2.0
-      result.should include([ "\"test_subject\"", "\"at\"", "\"+10.000000000931323+10.000000000931323\"^^<http://franz.com/ns/allegrograph/3.0/geospatial/cartesian/2.0/20.0/2.0/20.0/1.0>"])
-    end
-
-  end
-
-  describe "inside_haversine" do
-
-    it "should find objects inside a haversine" do
-      result = @geo.inside_haversine @type, "\"at\"", 9.0, 9.0, 200.0, :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
-
-  describe "inside_polygon" do
-
-    it "should find objects inside a polygon" do
-      result = @geo.inside_polygon @type, "\"at\"", "test_polygon"
-      result.should include([ "\"test_subject\"", "\"at\"", "\"+10.000000000931323+10.000000000931323\"^^<http://franz.com/ns/allegrograph/3.0/geospatial/cartesian/2.0/20.0/2.0/20.0/1.0>"])
-    end
-
-  end
-
-end