sparql-client 0.3.3 → 1.0.0

data/README

@@ -64,9 +64,9 @@ This is a [Ruby][] implementation of a [SPARQL][] client for [RDF.rb][].
 ##Dependencies
 
 * [Ruby](http://ruby-lang.org/) (>= 1.8.7) or (>= 1.8.1 with [Backports][])
-* [RDF.rb](http://rubygems.org/gems/rdf) (>= 0.3.5)
-* [Net::HTTP::Persistent](http://rubygems.org/gems/net-http-persistent) (>= 1.4.1)
-* [JSON](http://rubygems.org/gems/json_pure) (>= 1.4.6)
+* [RDF.rb](http://rubygems.org/gems/rdf) (>= 1.0)
+* [Net::HTTP::Persistent](http://rubygems.org/gems/net-http-persistent) (>= 1.4)
+* [JSON](http://rubygems.org/gems/json_pure) (>= 1.4)
 
 ##Installation
 

data/VERSION

@@ -1 +1 @@
-0.3.3
+1.0.0

data/lib/sparql/client.rb

@@ -4,13 +4,15 @@ require 'rdf/ntriples'        # @see http://rubygems.org/gems/rdf
 
 module SPARQL
   ##
-  # A SPARQL client for RDF.rb.
+  # A SPARQL 1.0/1.1 client for RDF.rb.
   #
   # @see http://www.w3.org/TR/sparql11-query/
+  # @see http://www.w3.org/TR/sparql11-protocol/
   # @see http://www.w3.org/TR/sparql11-results-json/
   class Client
     autoload :Query,      'sparql/client/query'
     autoload :Repository, 'sparql/client/repository'
+    autoload :Update,     'sparql/client/update'
     autoload :VERSION,    'sparql/client/version'
 
     class ClientError < StandardError; end
@@ -25,19 +27,32 @@ module SPARQL
     ACCEPT_XML  = {'Accept' => RESULT_XML}.freeze
     ACCEPT_BRTR = {'Accept' => RESULT_BRTR}.freeze
 
+    DEFAULT_PROTOCOL = 1.0
+    DEFAULT_METHOD   = :post
+
+    ##
+    # The SPARQL endpoint URL.
+    #
     # @return [RDF::URI]
     attr_reader :url
 
+    ##
+    # The HTTP headers that will be sent in requests to the endpoint.
+    #
     # @return [Hash{String => String}]
     attr_reader :headers
 
+    ##
+    # Any miscellaneous configuration.
+    #
     # @return [Hash{Symbol => Object}]
     attr_reader :options
 
     ##
     # @param  [String, #to_s]          url
     # @param  [Hash{Symbol => Object}] options
-    # @option options [Symbol] :method (:post)
+    # @option options [Symbol] :method (DEFAULT_METHOD)
+    # @option options [Number] :protocol (DEFAULT_PROTOCOL)
     # @option options [Hash] :headers
     def initialize(url, options = {}, &block)
       @url, @options = RDF::URI.new(url.to_s), options.dup
@@ -117,15 +132,7 @@ module SPARQL
     # @return [void] `self`
     # @see    http://www.w3.org/TR/sparql11-update/#insertData
     def insert_data(data, options = {})
-      raise ArgumentError, "no data given" if data.empty?
-      query_text = 'INSERT DATA {'
-      query_text += ' GRAPH ' + self.class.serialize_uri(options[:graph]) + ' {' if options[:graph]
-      query_text += "\n"
-      query_text += RDF::NTriples::Writer.buffer { |writer| writer << data }
-      query_text += '}' if options[:graph]
-      query_text += "}\n"
-      query(query_text)
-      self
+      self.update(Update::InsertData.new(data, options))
     end
 
     ##
@@ -146,15 +153,7 @@ module SPARQL
     # @return [void] `self`
     # @see    http://www.w3.org/TR/sparql11-update/#deleteData
     def delete_data(data, options = {})
-      raise ArgumentError, "no data given" if data.empty?
-      query_text = 'DELETE DATA {'
-      query_text += ' GRAPH ' + self.class.serialize_uri(options[:graph]) + ' {' if options[:graph]
-      query_text += "\n"
-      query_text += RDF::NTriples::Writer.buffer { |writer| writer << data }
-      query_text += '}' if options[:graph]
-      query_text += "}\n"
-      query(query_text)
-      self
+      self.update(Update::DeleteData.new(data, options))
     end
 
     ##
@@ -197,18 +196,7 @@ module SPARQL
     # @return [void] `self`
     # @see    http://www.w3.org/TR/sparql11-update/#clear
     def clear(what, *arguments)
-      options = arguments.last.is_a?(Hash) ? arguments.pop : {}
-      query_text = 'CLEAR '
-      query_text += 'SILENT ' if options[:silent]
-      case what.to_sym
-        when :graph   then query_text += 'GRAPH ' + self.class.serialize_uri(arguments.pop)
-        when :default then query_text += 'DEFAULT'
-        when :named   then query_text += 'NAMED'
-        when :all     then query_text += 'ALL'
-        else raise ArgumentError, "invalid CLEAR operation: #{what.inspect}"
-      end
-      query(query_text)
-      self
+      self.update(Update::Clear.new(what, *arguments))
     end
 
     ##
@@ -231,17 +219,34 @@ module SPARQL
     end
 
     ##
-    # Executes a SPARQL query and returns parsed results.
+    # Executes a SPARQL query and returns the parsed results.
     #
     # @param  [String, #to_s]          query
     # @param  [Hash{Symbol => Object}] options
     # @option options [String] :content_type
     # @option options [Hash] :headers
     # @return [Array<RDF::Query::Solution>]
+    # @see    http://www.w3.org/TR/sparql11-protocol/#query-operation
     def query(query, options = {})
+      @op = :query
       parse_response(response(query, options), options)
     end
 
+    ##
+    # Executes a SPARQL update operation.
+    #
+    # @param  [String, #to_s]          query
+    # @param  [Hash{Symbol => Object}] options
+    # @option options [String] :content_type
+    # @option options [Hash] :headers
+    # @return [void] `self`
+    # @see    http://www.w3.org/TR/sparql11-protocol/#update-operation
+    def update(query, options = {})
+      @op = :update
+      parse_response(response(query, options), options)
+      self
+    end
+
     ##
     # Executes a SPARQL query and returns the Net::HTTP::Response of the
     # result.
@@ -458,7 +463,7 @@ module SPARQL
     # @return [Net::HTTPResponse]
     # @see    http://www.w3.org/TR/sparql11-protocol/#query-operation
     def request(query, headers = {}, &block)
-      method = (self.options[:method] || :post).to_sym
+      method = (self.options[:method] || DEFAULT_METHOD).to_sym
       request = send("make_#{method}_request", query, headers)
 
       request.basic_auth(url.user, url.password) if url.user && !url.user.empty?
@@ -491,11 +496,19 @@ module SPARQL
     # @param  [String, #to_s]          query
     # @param  [Hash{String => String}] headers
     # @return [Net::HTTPRequest]
+    # @see    http://www.w3.org/TR/sparql11-protocol/#query-via-post-direct
     # @see    http://www.w3.org/TR/sparql11-protocol/#query-via-post-urlencoded
     def make_post_request(query, headers = {})
-      url = self.url
-      request = Net::HTTP::Post.new(url.request_uri, self.headers.merge(headers))
-      request.set_form_data(:query => query.to_s)
+      request = Net::HTTP::Post.new(self.url.request_uri, self.headers.merge(headers))
+      case (self.options[:protocol] || DEFAULT_PROTOCOL).to_s
+        when '1.1'
+          request['Content-Type'] = 'application/sparql-' + (@op || :query).to_s
+          request.body = query.to_s
+        when '1.0'
+          request.set_form_data(:query => query.to_s)
+        else
+          raise ArgumentError, "unknown SPARQL protocol version: #{self.options[:protocol].inspect}"
+      end
       request
     end
   end # Client

data/lib/sparql/client/update.rb

@@ -0,0 +1,228 @@
+class SPARQL::Client
+  ##
+  # SPARQL 1.1 Update operation builders.
+  module Update
+    def self.insert_data(*arguments)
+      InsertData.new(*arguments)
+    end
+
+    def self.delete_data(*arguments)
+      DeleteData.new(*arguments)
+    end
+
+    def self.load(*arguments)
+      Load.new(*arguments)
+    end
+
+    def self.clear(*arguments)
+      Clear.new(*arguments)
+    end
+
+    def self.create(*arguments)
+      Create.new(*arguments)
+    end
+
+    def self.drop(*arguments)
+      Drop.new(*arguments)
+    end
+
+    class Operation
+      attr_reader :options
+
+      def initialize(*arguments)
+        @options = arguments.last.is_a?(Hash) ? arguments.pop.dup : {}
+        unless arguments.empty?
+          send(arguments.shift, *arguments)
+        end
+      end
+
+      def silent
+        self.options[:silent] = true
+        self
+      end
+    end
+
+    ##
+    # @see http://www.w3.org/TR/sparql11-update/#insertData
+    class InsertData < Operation
+      attr_reader :data
+
+      def initialize(data, options = {})
+        @data = data
+        super(options)
+      end
+
+      def graph(uri)
+        self.options[:graph] = uri
+        self
+      end
+
+      def to_s
+        query_text = 'INSERT DATA {'
+        query_text += ' GRAPH ' + SPARQL::Client.serialize_uri(self.options[:graph]) + ' {' if self.options[:graph]
+        query_text += "\n"
+        query_text += RDF::NTriples::Writer.buffer { |writer| writer << @data }
+        query_text += '}' if self.options[:graph]
+        query_text += "}\n"
+      end
+    end
+
+    ##
+    # @see http://www.w3.org/TR/sparql11-update/#deleteData
+    class DeleteData < Operation
+      attr_reader :data
+
+      def initialize(data, options = {})
+        @data = data
+        super(options)
+      end
+
+      def graph(uri)
+        self.options[:graph] = uri
+        self
+      end
+
+      def to_s
+        query_text = 'DELETE DATA {'
+        query_text += ' GRAPH ' + SPARQL::Client.serialize_uri(self.options[:graph]) + ' {' if self.options[:graph]
+        query_text += "\n"
+        query_text += RDF::NTriples::Writer.buffer { |writer| writer << @data }
+        query_text += '}' if self.options[:graph]
+        query_text += "}\n"
+      end
+    end
+
+    ##
+    # @see http://www.w3.org/TR/sparql11-update/#deleteInsert
+    class DeleteInsert < Operation
+      def to_s
+        # TODO
+      end
+    end
+
+    ##
+    # @see http://www.w3.org/TR/sparql11-update/#load
+    class Load < Operation
+      attr_reader :from
+      attr_reader :into
+
+      def initialize(from, options = {})
+        options = options.dup
+        @from = RDF::URI(from)
+        @into = RDF::URI(options.delete(:into)) if options[:into]
+        super(options)
+      end
+
+      def into(url)
+        @into = RDF::URI(url)
+        self
+      end
+
+      def to_s
+        query_text = 'LOAD '
+        query_text += 'SILENT ' if self.options[:silent]
+        query_text += SPARQL::Client.serialize_uri(@from)
+        query_text += ' INTO GRAPH ' + SPARQL::Client.serialize_uri(@into) if @into
+        query_text
+      end
+    end
+
+    ##
+    # @see http://www.w3.org/TR/sparql11-update/#clear
+    class Clear < Operation
+      attr_reader :uri
+
+      def graph(uri)
+        @what, @uri = :graph, uri
+        self
+      end
+
+      def default
+        @what = :default
+        self
+      end
+
+      def named
+        @what = :named
+        self
+      end
+
+      def all
+        @what = :all
+        self
+      end
+
+      def to_s
+        query_text = 'CLEAR '
+        query_text += 'SILENT ' if self.options[:silent]
+        case @what.to_sym
+          when :graph   then query_text += 'GRAPH ' + SPARQL::Client.serialize_uri(@uri)
+          when :default then query_text += 'DEFAULT'
+          when :named   then query_text += 'NAMED'
+          when :all     then query_text += 'ALL'
+          else raise ArgumentError, "invalid CLEAR operation: #{@what.inspect}"
+        end
+        query_text
+      end
+    end
+
+    ##
+    # @see http://www.w3.org/TR/sparql11-update/#create
+    class Create < Operation
+      attr_reader :uri
+
+      def initialize(uri, options = {})
+        @uri = RDF::URI(uri)
+        super(options)
+      end
+
+      def to_s
+        query_text = 'CREATE '
+        query_text += 'SILENT ' if self.options[:silent]
+        query_text += 'GRAPH ' + SPARQL::Client.serialize_uri(@uri)
+        query_text
+      end
+    end
+
+    ##
+    # @see http://www.w3.org/TR/sparql11-update/#drop
+    class Drop < Clear
+      def to_s
+        query_text = 'DROP '
+        query_text += 'SILENT ' if self.options[:silent]
+        case @what.to_sym
+          when :graph   then query_text += 'GRAPH ' + SPARQL::Client.serialize_uri(@uri)
+          when :default then query_text += 'DEFAULT'
+          when :named   then query_text += 'NAMED'
+          when :all     then query_text += 'ALL'
+          else raise ArgumentError, "invalid DROP operation: #{@what.inspect}"
+        end
+        query_text
+      end
+    end
+
+    ##
+    # @see http://www.w3.org/TR/sparql11-update/#copy
+    class Copy < Operation
+      def to_s
+        # TODO
+      end
+    end
+
+    ##
+    # @see http://www.w3.org/TR/sparql11-update/#move
+    class Move < Operation
+      def to_s
+        # TODO
+      end
+    end
+
+    ##
+    # @see http://www.w3.org/TR/sparql11-update/#add
+    class Add < Operation
+      def to_s
+        # TODO
+      end
+    end
+  end # Update
+end # SPARQL::Client

data/lib/sparql/client/version.rb

@@ -1,8 +1,8 @@
 module SPARQL; class Client
   module VERSION
-    VERSION_FILE = File.expand_path('../../../../VERSION', __FILE__)
-    MAJOR, MINOR, TINY, EXTRA = File.read(VERSION_FILE).chop.split('.')
-    STRING = [MAJOR, MINOR, TINY, EXTRA].compact.join('.')
+    FILE = File.expand_path('../../../../VERSION', __FILE__)
+    MAJOR, MINOR, TINY, EXTRA = File.read(FILE).chomp.split('.')
+    STRING = [MAJOR, MINOR, TINY, EXTRA].compact.join('.').freeze
 
     ##
     # @return [String]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sparql-client
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-11 00:00:00.000000000 Z
+date: 2013-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdf
@@ -20,7 +20,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.3.5
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -28,7 +28,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.3.5
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: net-http-persistent
   requirement: !ruby/object:Gem::Requirement
@@ -36,7 +36,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -44,7 +44,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: json_pure
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +52,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.4.6
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -60,7 +60,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.4.6
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rdf-spec
   requirement: !ruby/object:Gem::Requirement
@@ -68,7 +68,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.3.5
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -76,7 +76,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.3.5
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -84,7 +84,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.10.0
+        version: '2.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -92,7 +92,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.10.0
+        version: '2.12'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -100,7 +100,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -108,7 +108,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: '0.8'
 description: SPARQL client for RDF.rb.
 email: public-rdf-ruby@w3.org
 executables: []
@@ -122,9 +122,10 @@ files:
 - VERSION
 - lib/sparql/client/query.rb
 - lib/sparql/client/repository.rb
+- lib/sparql/client/update.rb
 - lib/sparql/client/version.rb
 - lib/sparql/client.rb
-homepage: http://github.com/ruby-rdf/sparql-client
+homepage: http://ruby-rdf.github.com/sparql-client/
 licenses:
 - Public Domain
 post_install_message: