sparql-client 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 996cb716d6311ccd569174d200c39d05a035e3b7
-  data.tar.gz: 23d718dd6a3e23cec61d02df0689d46dd87cf481
+SHA256:
+  metadata.gz: b3a059f24774ca03ca4acab2ad37de9edcfbfcc8844ea0da0d7fe3d4b2a90849
+  data.tar.gz: 8aa709b83cab4ee290d3513ebb6fd90370d40587b58e8b06351b3df0f32973bb
 SHA512:
-  metadata.gz: 2ae85660825933ff2779a03acc8837f3cc82442edd6b5e725e44e2fd4558c346cce7d1bfd8a03d63fbc0ef5bbd4e7a6bfccb626575106d1b256f5a6e36eb8a71
-  data.tar.gz: a89eaac82c304cc3fc28d6b63c0c3e317728d20d2773262871fd111a2bf4dd8fe3597a87dbcfddf2284975bd12af7183856f9dcc603b2be1178a46e5f189e6db
+  metadata.gz: a7abad9a9c21cf0b8d88f9e1bf7ee98cc97ba8fa9a40c9eb06d29293202d16cb10aef0dc9edabe626709230e13511cae7a28af7bc0d48c5ece65ed7030c86022
+  data.tar.gz: fe927a99648a455a10494b839d994edae99b755512c69862e1a77418af0aad62d59132e663915ebea6f3f34c0fa6b057f7eab281fbb401bef8be30afecc63c2a

data/README.md

@@ -25,70 +25,92 @@ This is a [Ruby][] implementation of a [SPARQL][] client for [RDF.rb][].
 ## Examples
 
 ### Querying a remote SPARQL endpoint
-    require 'sparql/client'
 
-    sparql = SPARQL::Client.new("http://dbpedia.org/sparql")
+```ruby
+require 'sparql/client'
+sparql = SPARQL::Client.new("http://dbpedia.org/sparql")
+```
+### Querying a remote SPARQL endpoint with a specified default graph
 
-### Querying a `RDF::Repository` instance
+```ruby
+require 'sparql/client'
+sparql = SPARQL::Client.new("http://dbpedia.org/sparql", { :graph => "http://dbpedia.org" })
+```
 
-    require 'rdf/trig'
-    repository = RDF::Repository.load("http://example/dataset.trig")
 
-    sparql = SPARQL::Client.new(repository)
+### Querying a `RDF::Repository` instance
 
-### Executing a boolean query and outputting the result
+```ruby
+require 'rdf/trig'
+repository = RDF::Repository.load("http://example/dataset.trig")
+sparql = SPARQL::Client.new(repository)
+```
 
-    # ASK WHERE { ?s ?p ?o }
-    result = sparql.ask.whether([:s, :p, :o]).true?
+### Executing a boolean query and outputting the result
 
-    puts result.inspect   #=> true or false
+```ruby
+# ASK WHERE { ?s ?p ?o }
+result = sparql.ask.whether([:s, :p, :o]).true?
+puts result.inspect   #=> true or false
+```
 
 ### Executing a tuple query and iterating over the returned solutions
 
-    # SELECT * WHERE { ?s ?p ?o } OFFSET 100 LIMIT 10
-    query = sparql.select.where([:s, :p, :o]).offset(100).limit(10)
+```ruby
+# SELECT * WHERE { ?s ?p ?o } OFFSET 100 LIMIT 10
+query = sparql.select.where([:s, :p, :o]).offset(100).limit(10)
 
-    query.each_solution do |solution|
-      puts solution.inspect
-    end
+query.each_solution do |solution|
+  puts solution.inspect
+end
+```
 
 ### Executing a graph query and iterating over the returned statements
 
-    # CONSTRUCT { ?s ?p ?o } WHERE { ?s ?p ?o } LIMIT 10
-    query = sparql.construct([:s, :p, :o]).where([:s, :p, :o]).limit(10)
 
-    query.each_statement do |statement|
-      puts statement.inspect
-    end
+```ruby
+# CONSTRUCT { ?s ?p ?o } WHERE { ?s ?p ?o } LIMIT 10
+query = sparql.construct([:s, :p, :o]).where([:s, :p, :o]).limit(10)
+
+query.each_statement do |statement|
+  puts statement.inspect
+end
+```
 
 ### Executing an arbitrary textual SPARQL query string
 
-    result = sparql.query("ASK WHERE { ?s ?p ?o }")
+```ruby
+result = sparql.query("ASK WHERE { ?s ?p ?o }")
 
-    puts result.inspect   #=> true or false
+puts result.inspect   #=> true or false
+```
 
 ### Inserting data into a graph
 
-    # INSERT DATA { <http://example.org/jhacker> <http://xmlns.com/foaf/0.1/name> "J. Random Hacker" .}
-    data = RDF::Graph.new do |graph|
-      graph << [RDF::URI('http://example.org/jhacker'), RDF::Vocab::FOAF.name, "J. Random Hacker"]
-    end
-    sparql.insert_data(data)
+```ruby
+# INSERT DATA { <http://example.org/jhacker> <http://xmlns.com/foaf/0.1/name> "J. Random Hacker" .}
+data = RDF::Graph.new do |graph|
+  graph << [RDF::URI('http://example.org/jhacker'), RDF::Vocab::FOAF.name, "J. Random Hacker"]
+end
+sparql.insert_data(data)
+```
 
 ### Deleting data from a graph
 
-    # DELETE DATA { <http://example.org/jhacker> <http://xmlns.com/foaf/0.1/name> "J. Random Hacker" .}
-    data = RDF::Graph.new do |graph|
-      graph << [RDF::URI('http://example.org/jhacker'), RDF::Vocab::FOAF.name, "J. Random Hacker"]
-    end
-    sparql.delete_data(data)
+```ruby
+# DELETE DATA { <http://example.org/jhacker> <http://xmlns.com/foaf/0.1/name> "J. Random Hacker" .}
+data = RDF::Graph.new do |graph|
+  graph << [RDF::URI('http://example.org/jhacker'), RDF::Vocab::FOAF.name, "J. Random Hacker"]
+end
+sparql.delete_data(data)
+```
 
 ## Documentation
 
-* {SPARQL::Client}
-  * {SPARQL::Client::Query}
-  * {SPARQL::Client::Repository}
-  * {SPARQL::Client::Update}
+* [SPARQL::Client](https://www.rubydoc.info/github/ruby-rdf/sparql-client/SPARQL/Client)
+  * [SPARQL::Client::Query](https://www.rubydoc.info/github/ruby-rdf/sparql-client/SPARQL/Client/Query)
+  * [SPARQL::Client::Repository](https://www.rubydoc.info/github/ruby-rdf/sparql-client/SPARQL/Client/Repository)
+  * [SPARQL::Client::Update](https://www.rubydoc.info/github/ruby-rdf/sparql-client/SPARQL/Client/Update)
 
 ## Dependencies
 

data/VERSION

@@ -1 +1 @@
-3.0.0
+3.0.1

data/lib/sparql/client.rb

@@ -40,7 +40,7 @@ module SPARQL
       '*/*;q=0.1'
     ].join(', ').freeze
     GRAPH_ALL  = (
-      RDF::Format.content_types.keys + 
+      RDF::Format.content_types.keys +
       ['*/*;q=0.1']
     ).join(', ').freeze
 
@@ -543,7 +543,7 @@ module SPARQL
       if reader = RDF::Reader.for(options)
         reader.new(response.body)
       else
-        raise RDF::ReaderError, "no suitable rdf reader was found."
+        raise RDF::ReaderError, "no RDF reader was found for #{options}."
       end
     end
 
@@ -701,8 +701,8 @@ module SPARQL
         if response.kind_of? Net::HTTPRedirection
           response = @http.request(::URI.parse(response['location']), request)
         else
-          return block_given? ? block.call(response) : response 
-        end          
+          return block_given? ? block.call(response) : response
+        end
       end
       raise ServerError, "Infinite redirect at #{url}. Redirected more than 10 times."
     end
@@ -726,6 +726,7 @@ module SPARQL
     def make_get_request(query, headers = {})
       url = self.url.dup
       url.query_values = (url.query_values || {}).merge(:query => query.to_s)
+      set_url_default_graph url unless @options[:graph].nil?
       request = Net::HTTP::Get.new(url.request_uri, self.headers.merge(headers))
       request
     end
@@ -740,23 +741,56 @@ module SPARQL
     # @see    http://www.w3.org/TR/sparql11-protocol/#query-via-post-urlencoded
     def make_post_request(query, headers = {})
       if @alt_endpoint.nil?
-        endpoint = url.request_uri 
+        url = self.url.dup
+        set_url_default_graph url unless @options[:graph].nil?
+        endpoint = url.request_uri
       else
         endpoint = @alt_endpoint
       end
+
       request = Net::HTTP::Post.new(endpoint, 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((@op || :query) => query.to_s)
+          form_data = {(@op || :query) => query.to_s}
+          form_data.merge!(
+            {:'default-graph-uri' => @options[:graph]}
+          ) if !@options[:graph].nil? && (@op.eql? :query)
+          form_data.merge!(
+            {:'using-graph-uri' => @options[:graph]}
+          ) if !@options[:graph].nil? && (@op.eql? :update)
+          request.set_form_data(form_data)
         else
           raise ArgumentError, "unknown SPARQL protocol version: #{self.options[:protocol].inspect}"
       end
       request
     end
 
+    ##
+    # Setup url query parameter to use a specified default graph
+    #
+    # @see    https://www.w3.org/TR/sparql11-protocol/#query-operation
+    # @see    https://www.w3.org/TR/sparql11-protocol/#update-operation
+    def set_url_default_graph url
+      if @options[:graph].is_a? Array
+        graphs = @options[:graph].map {|graph|
+          CGI::escape(graph)
+        }
+      else
+        graphs = CGI::escape(@options[:graph])
+      end
+      case @op
+      when :query
+        url.query_values = (url.query_values || {})
+          .merge(:'default-graph-uri' => graphs)
+      when :update
+        url.query_values = (url.query_values || {})
+          .merge(:'using-graph-uri' => graphs)
+      end
+    end
+
     # A query element can be used as a component of a query. It may be initialized with a string, which is wrapped in an appropriate container depending on the type of QueryElement. Implements {#to_s} to property serialize when generating a SPARQL query.
     class QueryElement
       attr_reader :elements

data/lib/sparql/client/query.rb

@@ -1,4 +1,4 @@
-module SPARQL; class Client
+class SPARQL::Client
   ##
   # A SPARQL query builder.
   #
@@ -366,16 +366,38 @@ module SPARQL; class Client
     end
 
     ##
-    # @example PREFIX dc: <http://purl.org/dc/elements/1.1/> PREFIX foaf: <http://xmlns.com/foaf/0.1/> SELECT * WHERE \{ ?s ?p ?o . \}
-    #   query.select.
-    #     prefix(dc: RDF::URI("http://purl.org/dc/elements/1.1/")).
-    #     prefix(foaf: RDF::URI("http://xmlns.com/foaf/0.1/")).
-    #     where([:s, :p, :o])
+    # @overload prefix(prefix: uri)
+    #   @example PREFIX dc: <http://purl.org/dc/elements/1.1/> PREFIX foaf: <http://xmlns.com/foaf/0.1/> SELECT * WHERE \{ ?s ?p ?o . \}
+    #     query.select.
+    #       prefix(dc: RDF::URI("http://purl.org/dc/elements/1.1/")).
+    #       prefix(foaf: RDF::URI("http://xmlns.com/foaf/0.1/")).
+    #       where([:s, :p, :o])
     #
-    # @return [Query]
+    #   @param [RDF::URI] uri
+    #   @param [Symbol, String] prefix
+    #   @return [Query]
+    #
+    # @overload prefix(string)
+    #   @example PREFIX dc: <http://purl.org/dc/elements/1.1/> PREFIX foaf: <http://xmlns.com/foaf/0.1/> SELECT * WHERE \{ ?s ?p ?o . \}
+    #     query.select.
+    #       prefix("dc: <http://purl.org/dc/elements/1.1/>").
+    #       prefix("foaf: <http://xmlns.com/foaf/0.1/>").
+    #       where([:s, :p, :o])
+    #
+    #   @param [string] string
+    #   @return [Query]
     # @see    http://www.w3.org/TR/sparql11-query/#prefNames
-    def prefix(string)
-      (options[:prefixes] ||= []) << string
+    def prefix(val)
+      options[:prefixes] ||= []
+      if val.kind_of? String
+        options[:prefixes] << val
+      elsif val.kind_of? Hash
+        val.each do |k, v|
+          options[:prefixes] << "#{k}: <#{v}>"
+        end
+      else
+        raise ArgumentError, "prefix must be a kind of String or a Hash"
+      end
       self
     end
 
@@ -823,4 +845,4 @@ module SPARQL; class Client
       end
     end
   end
-end; end
+end

data/lib/sparql/client/repository.rb

@@ -1,4 +1,4 @@
-module SPARQL; class Client
+class SPARQL::Client
   ##
   # A read-only repository view of a SPARQL endpoint.
   #
@@ -345,4 +345,4 @@ module SPARQL; class Client
     end
 
   end
-end; end
+end

data/lib/sparql/client/version.rb

@@ -1,4 +1,4 @@
-module SPARQL; class Client
+class SPARQL::Client
   module VERSION
     FILE = File.expand_path('../../../../VERSION', __FILE__)
     MAJOR, MINOR, TINY, EXTRA = File.read(FILE).chomp.split('.')
@@ -16,4 +16,4 @@ module SPARQL; class Client
     # @return [Array(Integer, Integer, Integer)]
     def self.to_a() [MAJOR, MINOR, TINY] end
   end
-end; end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sparql-client
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Arto Bendiken
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-31 00:00:00.000000000 Z
+date: 2018-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdf
@@ -170,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: SPARQL client for RDF.rb.