Class: SPARQL::Client
- Inherits:
-
Object
- Object
- SPARQL::Client
- Defined in:
- lib/sparql/client.rb,
lib/sparql/client/query.rb,
lib/sparql/client/update.rb,
lib/sparql/client/version.rb,
lib/sparql/client/repository.rb
Overview
A SPARQL 1.0/1.1 client for RDF.rb.
Defined Under Namespace
Modules: Update, VERSION Classes: ClientError, MalformedQuery, Query, QueryElement, Repository, ServerError
Constant Summary collapse
- RESULT_JSON =
'application/sparql-results+json'.freeze
- RESULT_XML =
'application/sparql-results+xml'.freeze
- RESULT_CSV =
'text/csv'.freeze
- RESULT_TSV =
'text/tab-separated-values'.freeze
- RESULT_BOOL =
Sesame-specific
'text/boolean'.freeze
- RESULT_BRTR =
Sesame-specific
'application/x-binary-rdf-results-table'.freeze
- RESULT_ALL =
[ RESULT_JSON, RESULT_XML, RESULT_BOOL, "#{RESULT_TSV};q=0.8", "#{RESULT_CSV};q=0.2", '*/*;q=0.1' ].join(', ').freeze
- GRAPH_ALL =
( RDF::Format.content_types.keys + ['*/*;q=0.1'] ).join(', ').freeze
- ACCEPT_JSON =
{'Accept' => RESULT_JSON}.freeze
- ACCEPT_XML =
{'Accept' => RESULT_XML}.freeze
- ACCEPT_CSV =
{'Accept' => RESULT_CSV}.freeze
- ACCEPT_TSV =
{'Accept' => RESULT_TSV}.freeze
- ACCEPT_BRTR =
{'Accept' => RESULT_BRTR}.freeze
- ACCEPT_RESULTS =
{'Accept' => RESULT_ALL}.freeze
- ACCEPT_GRAPH =
{'Accept' => GRAPH_ALL}.freeze
- DEFAULT_PROTOCOL =
1.0
- DEFAULT_METHOD =
:post
- XMLNS =
{'sparql' => 'http://www.w3.org/2005/sparql-results#'}.freeze
Instance Attribute Summary collapse
-
#headers ⇒ Hash{String => String}
readonly
The HTTP headers that will be sent in requests to the endpoint.
-
#options ⇒ Hash{Symbol => Object}
readonly
Any miscellaneous configuration.
-
#url ⇒ RDF::URI, RDF::Queryable
readonly
The SPARQL endpoint URL, or an RDF::Queryable instance, to use the native SPARQL engine.
Class Method Summary collapse
- .parse_csv_bindings(csv, nodes = {}) ⇒ <RDF::Query::Solutions>
- .parse_json_bindings(json, nodes = {}) ⇒ <RDF::Query::Solutions>
- .parse_json_value(value, nodes = {}) ⇒ RDF::Value
- .parse_tsv_bindings(tsv, nodes = {}) ⇒ <RDF::Query::Solutions>
- .parse_xml_bindings(xml, nodes = {}) ⇒ <RDF::Query::Solutions>
- .parse_xml_value(value, nodes = {}) ⇒ RDF::Value
-
.serialize_patterns(patterns, use_vars = false) ⇒ String
Serializes a SPARQL graph.
-
.serialize_predicate(value, rdepth = 0) ⇒ String
Serializes a SPARQL predicate.
-
.serialize_uri(uri) ⇒ String
Serializes a URI or URI string into SPARQL syntax.
-
.serialize_value(value, use_vars = false) ⇒ String
Serializes an ‘RDF::Value` into SPARQL syntax.
Instance Method Summary collapse
-
#ask(*args, **options) ⇒ Query
Executes a boolean ‘ASK` query.
- #call_query_method(meth, *args, **options) ⇒ Object
-
#clear(what, *arguments) ⇒ Object
Executes a ‘CLEAR` operation.
-
#clear_graph(graph_uri, **options) ⇒ void
Executes a ‘CLEAR GRAPH` operation.
-
#close ⇒ void
Closes a client instance by finishing the connection.
-
#construct(*args, **options) ⇒ Query
Executes a graph ‘CONSTRUCT` query.
-
#delete_data(data, **options) ⇒ void
Executes a ‘DELETE DATA` operation.
-
#delete_insert(delete_graph, insert_graph = nil, where_graph = nil, **options) ⇒ void
Executes a ‘DELETE/INSERT` operation.
-
#describe(*args, **options) ⇒ Query
Executes a ‘DESCRIBE` query.
-
#initialize(url, **options, &block) ⇒ Client
constructor
Initialize a new sparql client, either using the URL of a SPARQL endpoint or an ‘RDF::Queryable` instance to use the native SPARQL gem.
-
#insert_data(data, **options) ⇒ void
Executes an ‘INSERT DATA` operation.
-
#inspect ⇒ String
Returns a developer-friendly representation of this object.
-
#inspect! ⇒ void
Outputs a developer-friendly representation of this object to ‘stderr`.
-
#nodes ⇒ Object
Returns a mapping of blank node results for this client.
- #parse_rdf_serialization(response, **options) ⇒ RDF::Enumerable
- #parse_response(response, **options) ⇒ Object
-
#query(query, **options) ⇒ Array<RDF::Query::Solution>
Executes a SPARQL query and returns the parsed results.
-
#response(query, **options) ⇒ String
Executes a SPARQL query and returns the Net::HTTP::Response of the result.
-
#select(*args, **options) ⇒ Query
Executes a tuple ‘SELECT` query.
-
#update(query, **options) ⇒ void
Executes a SPARQL update operation.
Constructor Details
#initialize(url, **options, &block) ⇒ Client
Initialize a new sparql client, either using the URL of a SPARQL endpoint or an ‘RDF::Queryable` instance to use the native SPARQL gem.
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 |
# File 'lib/sparql/client.rb', line 95 def initialize(url, **, &block) case url when RDF::Queryable @url, @options = url, .dup else @url, @options = RDF::URI.new(url.to_s), .dup @headers = @options.delete(:headers) || {} @http = http_klass(@url.scheme) # Close the http connection when object is deallocated ObjectSpace.define_finalizer(self, proc {@http.shutdown if @http.respond_to?(:shutdown)}) end if block_given? case block.arity when 1 then block.call(self) else instance_eval(&block) end end end |
Instance Attribute Details
#headers ⇒ Hash{String => String} (readonly)
The HTTP headers that will be sent in requests to the endpoint.
70 71 72 |
# File 'lib/sparql/client.rb', line 70 def headers @headers end |
#options ⇒ Hash{Symbol => Object} (readonly)
Any miscellaneous configuration.
76 77 78 |
# File 'lib/sparql/client.rb', line 76 def @options end |
#url ⇒ RDF::URI, RDF::Queryable (readonly)
The SPARQL endpoint URL, or an RDF::Queryable instance, to use the native SPARQL engine.
64 65 66 |
# File 'lib/sparql/client.rb', line 64 def url @url end |
Class Method Details
.parse_csv_bindings(csv, nodes = {}) ⇒ <RDF::Query::Solutions>
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 |
# File 'lib/sparql/client.rb', line 446 def self.parse_csv_bindings(csv, nodes = {}) require 'csv' unless defined?(::CSV) csv = CSV.parse(csv.to_s) unless csv.is_a?(Array) vars = csv.shift solutions = RDF::Query::Solutions.new csv.each do |row| solution = RDF::Query::Solution.new row.each_with_index do |v, i| term = case v when /^_:(.*)$/ then nodes[$1] ||= RDF::Node($1) when /^\w+:.*$/ then RDF::URI(v) else RDF::Literal(v) end solution[vars[i].to_sym] = term end solutions << solution end solutions end |
.parse_json_bindings(json, nodes = {}) ⇒ <RDF::Query::Solutions>
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 |
# File 'lib/sparql/client.rb', line 406 def self.parse_json_bindings(json, nodes = {}) require 'json' unless defined?(::JSON) json = JSON.parse(json.to_s) unless json.is_a?(Hash) case when json.has_key?('boolean') json['boolean'] when json.has_key?('results') solutions = json['results']['bindings'].map do |row| row = row.inject({}) do |cols, (name, value)| cols.merge(name.to_sym => parse_json_value(value, nodes)) end RDF::Query::Solution.new(row) end RDF::Query::Solutions.new(solutions) end end |
.parse_json_value(value, nodes = {}) ⇒ RDF::Value
428 429 430 431 432 433 434 435 436 437 438 439 440 |
# File 'lib/sparql/client.rb', line 428 def self.parse_json_value(value, nodes = {}) case value['type'].to_sym when :bnode nodes[id = value['value']] ||= RDF::Node.new(id) when :uri RDF::URI.new(value['value']) when :literal RDF::Literal.new(value['value'], datatype: value['datatype'], language: value['xml:lang']) when :'typed-literal' RDF::Literal.new(value['value'], datatype: value['datatype']) else nil end end |
.parse_tsv_bindings(tsv, nodes = {}) ⇒ <RDF::Query::Solutions>
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 |
# File 'lib/sparql/client.rb', line 470 def self.parse_tsv_bindings(tsv, nodes = {}) tsv = tsv.lines.map {|l| l.chomp.split("\t")} unless tsv.is_a?(Array) vars = tsv.shift.map {|h| h.sub(/^\?/, '')} solutions = RDF::Query::Solutions.new tsv.each do |row| solution = RDF::Query::Solution.new row.each_with_index do |v, i| if !v.empty? term = RDF::NTriples.unserialize(v) || case v when /^\d+\.\d*[eE][+-]?[0-9]+$/ then RDF::Literal::Double.new(v) when /^\d*\.\d+[eE][+-]?[0-9]+$/ then RDF::Literal::Double.new(v) when /^\d*\.\d+$/ then RDF::Literal::Decimal.new(v) when /^\d+$/ then RDF::Literal::Integer.new(v) else RDF::Literal(v) end nodes[term.id] = term if term.is_a? RDF::Node solution[vars[i].to_sym] = term end end solutions << solution end solutions end |
.parse_xml_bindings(xml, nodes = {}) ⇒ <RDF::Query::Solutions>
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 |
# File 'lib/sparql/client.rb', line 499 def self.parse_xml_bindings(xml, nodes = {}) xml.force_encoding(::Encoding::UTF_8) if xml.respond_to?(:force_encoding) if defined?(::Nokogiri) xml = Nokogiri::XML(xml).root unless xml.is_a?(Nokogiri::XML::Document) case when boolean = xml.xpath("//sparql:boolean", XMLNS)[0] boolean.text == 'true' when results = xml.xpath("//sparql:results", XMLNS)[0] solutions = results.elements.map do |result| row = {} result.elements.each do |binding| name = binding.attr('name').to_sym value = binding.elements.first row[name] = parse_xml_value(value, nodes) end RDF::Query::Solution.new(row) end RDF::Query::Solutions.new(solutions) end else # REXML xml = REXML::Document.new(xml).root unless xml.is_a?(REXML::Element) case when boolean = xml.elements['boolean'] boolean.text == 'true' when results = xml.elements['results'] solutions = results.elements.map do |result| row = {} result.elements.each do |binding| name = binding.attributes['name'].to_sym value = binding.select { |node| node.kind_of?(::REXML::Element) }.first row[name] = parse_xml_value(value, nodes) end RDF::Query::Solution.new(row) end RDF::Query::Solutions.new(solutions) end end end |
.parse_xml_value(value, nodes = {}) ⇒ RDF::Value
544 545 546 547 548 549 550 551 552 553 554 555 556 |
# File 'lib/sparql/client.rb', line 544 def self.parse_xml_value(value, nodes = {}) case value.name.to_sym when :bnode nodes[id = value.text] ||= RDF::Node.new(id) when :uri RDF::URI.new(value.text) when :literal lang = value.respond_to?(:attr) ? value.attr('xml:lang') : value.attributes['xml:lang'] datatype = value.respond_to?(:attr) ? value.attr('datatype') : value.attributes['datatype'] RDF::Literal.new(value.text, language: lang, datatype: datatype) else nil end end |
.serialize_patterns(patterns, use_vars = false) ⇒ String
Serializes a SPARQL graph
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 |
# File 'lib/sparql/client.rb', line 631 def self.serialize_patterns(patterns, use_vars = false) patterns.map do |pattern| serialized_pattern = case pattern when SPARQL::Client::QueryElement then [pattern.to_s] else RDF::Statement.from(pattern).to_triple.each_with_index.map do |v, i| if i == 1 SPARQL::Client.serialize_predicate(v) else SPARQL::Client.serialize_value(v, use_vars) end end end serialized_pattern.join(' ') + ' .' end end |
.serialize_predicate(value, rdepth = 0) ⇒ String
Serializes a SPARQL predicate
610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/sparql/client.rb', line 610 def self.serialize_predicate(value,rdepth=0) case value when nil RDF::Query::Variable.new.to_s when String then value when Array s = value.map{|v|serialize_predicate(v,rdepth+1)}.join rdepth > 0 ? "(#{s})" : s when RDF::Value # abbreviate RDF.type in the predicate position per SPARQL grammar value.equal?(RDF.type) ? 'a' : serialize_value(value) end end |
.serialize_uri(uri) ⇒ String
Serializes a URI or URI string into SPARQL syntax.
577 578 579 580 581 582 583 |
# File 'lib/sparql/client.rb', line 577 def self.serialize_uri(uri) case uri when String then RDF::NTriples.serialize(RDF::URI(uri)) when RDF::URI then RDF::NTriples.serialize(uri) else raise ArgumentError, "expected the graph URI to be a String or RDF::URI, but got #{uri.inspect}" end end |
.serialize_value(value, use_vars = false) ⇒ String
Serializes an ‘RDF::Value` into SPARQL syntax.
592 593 594 595 596 597 598 599 600 601 |
# File 'lib/sparql/client.rb', line 592 def self.serialize_value(value, use_vars = false) # SPARQL queries are UTF-8, but support ASCII-style Unicode escapes, so # the N-Triples serializer is fine unless it's a variable: case when value.nil? then RDF::Query::Variable.new.to_s when value.variable? then value.to_s when value.node? then (use_vars ? RDF::Query::Variable.new(value.id) : value) else RDF::NTriples.serialize(value) end end |
Instance Method Details
#ask(*args, **options) ⇒ Query
Executes a boolean ‘ASK` query.
131 132 133 |
# File 'lib/sparql/client.rb', line 131 def ask(*args, **) call_query_method(:ask, *args, **) end |
#call_query_method(meth, *args, **options) ⇒ Object
284 285 286 287 288 289 290 291 |
# File 'lib/sparql/client.rb', line 284 def call_query_method(meth, *args, **) client = self result = Query.send(meth, *args, **) (class << result; self; end).send(:define_method, :execute) do client.query(self) end result end |
#clear(what, *arguments) ⇒ void #clear(what, *arguments, **options) ⇒ void
Executes a ‘CLEAR` operation.
This requires that the endpoint support SPARQL 1.1 Update.
278 279 280 |
# File 'lib/sparql/client.rb', line 278 def clear(what, *arguments) self.update(Update::Clear.new(what, *arguments)) end |
#clear_graph(graph_uri, **options) ⇒ void
This method returns an undefined value.
Executes a ‘CLEAR GRAPH` operation.
This is a convenience wrapper for the #clear method.
243 244 245 |
# File 'lib/sparql/client.rb', line 243 def clear_graph(graph_uri, **) self.clear(:graph, graph_uri, **) end |
#close ⇒ void
This method returns an undefined value.
Closes a client instance by finishing the connection. The client is unavailable for any further data operations; an IOError is raised if such an attempt is made. I/O streams are automatically closed when they are claimed by the garbage collector.
120 121 122 123 124 |
# File 'lib/sparql/client.rb', line 120 def close @http.shutdown if @http @http = nil self end |
#construct(*args, **options) ⇒ Query
Executes a graph ‘CONSTRUCT` query.
158 159 160 |
# File 'lib/sparql/client.rb', line 158 def construct(*args, **) call_query_method(:construct, *args, **) end |
#delete_data(data, **options) ⇒ void
This method returns an undefined value.
Executes a ‘DELETE DATA` operation.
This requires that the endpoint support SPARQL 1.1 Update.
210 211 212 |
# File 'lib/sparql/client.rb', line 210 def delete_data(data, **) self.update(Update::DeleteData.new(data, **)) end |
#delete_insert(delete_graph, insert_graph = nil, where_graph = nil, **options) ⇒ void
This method returns an undefined value.
Executes a ‘DELETE/INSERT` operation.
This requires that the endpoint support SPARQL 1.1 Update.
226 227 228 |
# File 'lib/sparql/client.rb', line 226 def delete_insert(delete_graph, insert_graph = nil, where_graph = nil, **) self.update(Update::DeleteInsert.new(delete_graph, insert_graph, where_graph, **)) end |
#describe(*args, **options) ⇒ Query
Executes a ‘DESCRIBE` query.
149 150 151 |
# File 'lib/sparql/client.rb', line 149 def describe(*args, **) call_query_method(:describe, *args, **) end |
#insert_data(data, **options) ⇒ void
This method returns an undefined value.
Executes an ‘INSERT DATA` operation.
This requires that the endpoint support SPARQL 1.1 Update.
Note that for inserting non-trivial amounts of data, you probably ought to consider using the RDF store’s native bulk-loading facilities or APIs, as ‘INSERT DATA` operations entail comparably higher parsing overhead.
189 190 191 |
# File 'lib/sparql/client.rb', line 189 def insert_data(data, **) self.update(Update::InsertData.new(data, **)) end |
#inspect ⇒ String
Returns a developer-friendly representation of this object.
660 661 662 |
# File 'lib/sparql/client.rb', line 660 def inspect sprintf("#<%s:%#0x(%s)>", self.class.name, __id__, url.to_s) end |
#inspect! ⇒ void
This method returns an undefined value.
Outputs a developer-friendly representation of this object to ‘stderr`.
652 653 654 |
# File 'lib/sparql/client.rb', line 652 def inspect! warn(inspect) end |
#nodes ⇒ Object
Returns a mapping of blank node results for this client.
297 298 299 |
# File 'lib/sparql/client.rb', line 297 def nodes @nodes ||= {} end |
#parse_rdf_serialization(response, **options) ⇒ RDF::Enumerable
562 563 564 565 566 567 568 569 |
# File 'lib/sparql/client.rb', line 562 def parse_rdf_serialization(response, **) = {content_type: response.content_type} unless [:content_type] if reader = RDF::Reader.for() reader.new(response.body) else raise RDF::ReaderError, "no RDF reader was found for #{}." end end |
#parse_response(response, **options) ⇒ Object
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 |
# File 'lib/sparql/client.rb', line 383 def parse_response(response, **) case [:content_type] || response.content_type when NilClass response.body when RESULT_BOOL # Sesame-specific response.body == 'true' when RESULT_JSON self.class.parse_json_bindings(response.body, nodes) when RESULT_XML self.class.parse_xml_bindings(response.body, nodes) when RESULT_CSV self.class.parse_csv_bindings(response.body, nodes) when RESULT_TSV self.class.parse_tsv_bindings(response.body, nodes) else parse_rdf_serialization(response, **) end end |
#query(query, **options) ⇒ Array<RDF::Query::Solution>
Executes a SPARQL query and returns the parsed results.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 |
# File 'lib/sparql/client.rb', line 311 def query(query, **) @op = :query @alt_endpoint = [:endpoint] case @url when RDF::Queryable require 'sparql' unless defined?(::SPARQL::Grammar) begin SPARQL.execute(query, @url, optimize: true, **) rescue SPARQL::MalformedQuery $stderr.puts "error running #{query}: #{$!}" raise end else parse_response(response(query, **), **) end end |
#response(query, **options) ⇒ String
Executes a SPARQL query and returns the Net::HTTP::Response of the result.
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 |
# File 'lib/sparql/client.rb', line 362 def response(query, **) headers = [:headers] || @headers headers['Accept'] = [:content_type] if [:content_type] request(query, headers) do |response| case response when Net::HTTPBadRequest # 400 Bad Request raise MalformedQuery.new(response.body + " Processing query #{query}") when Net::HTTPClientError # 4xx raise ClientError.new(response.body + " Processing query #{query}") when Net::HTTPServerError # 5xx raise ServerError.new(response.body + " Processing query #{query}") when Net::HTTPSuccess # 2xx response end end end |
#select(*args, **options) ⇒ Query
Executes a tuple ‘SELECT` query.
140 141 142 |
# File 'lib/sparql/client.rb', line 140 def select(*args, **) call_query_method(:select, *args, **) end |
#update(query, **options) ⇒ void
This method returns an undefined value.
Executes a SPARQL update operation.
339 340 341 342 343 344 345 346 347 348 349 350 |
# File 'lib/sparql/client.rb', line 339 def update(query, **) @op = :update @alt_endpoint = [:endpoint] case @url when RDF::Queryable require 'sparql' unless defined?(::SPARQL::Grammar) SPARQL.execute(query, @url, update: true, optimize: true, **) else response(query, **) end self end |