sparql-client 0.0.4 → 0.0.5

data/CREDITS

@@ -0,0 +1,4 @@
+* Gabriel Horner <gabriel.horner@gmail.com>
+* Nicholas Humfrey <njh@aelius.com>
+* David Nielsen <david@graveyard.dk>
+* Thamaraiselvan Poomalai <p.thamarai@gmail.com>

data/README

@@ -1,7 +1,7 @@
 SPARQL Client for RDF.rb
 ========================
 
-This is a pure-Ruby implementation of a [SPARQL][] client for [RDF.rb][].
+This is a [Ruby][] implementation of a [SPARQL][] client for [RDF.rb][].
 
 * <http://github.com/bendiken/sparql-client>
 
@@ -68,7 +68,8 @@ Documentation
 Dependencies
 ------------
 
-* [RDF.rb](http://rubygems.org/gems/rdf) (>= 0.1.10)
+* [Ruby](http://ruby-lang.org/) (>= 1.8.7) or (>= 1.8.1 with [Backports][])
+* [RDF.rb](http://rubygems.org/gems/rdf) (>= 0.2.0)
 * [JSON](http://rubygems.org/gems/json_pure) (>= 1.4.0)
 
 Installation
@@ -91,6 +92,35 @@ as follows:
 
     % wget http://github.com/bendiken/sparql-client/tarball/master
 
+Authors
+-------
+
+* [Arto Bendiken](mailto:arto.bendiken@gmail.com) - <http://ar.to/>
+* [Ben Lavender](mailto:blavender@gmail.com) - <http://bhuga.net/>
+
+Contributors
+------------
+
+* [Gabriel Horner](http://github.com/cldwalker) - <http://tagaholic.me/>
+* [Nicholas Humfrey](http://github.com/njh) - <http://www.aelius.com/njh/>
+* [David Nielsen](http://github.com/drankard) - <http://github.com/drankard>
+* [Thamaraiselvan Poomalai](http://github.com/selvan) - <http://softonaut.blogspot.com/>
+
+Contributing
+------------
+
+* Do your best to adhere to the existing coding conventions and idioms.
+* Don't use hard tabs, and don't leave trailing whitespace on any line.
+* Do document every method you add using [YARD][] annotations. Read the
+  [tutorial][YARD-GS] or just look at the existing code for examples.
+* Don't touch the `.gemspec`, `VERSION` or `AUTHORS` files. If you need to
+  change them, do so on your private branch only.
+* Do feel free to add yourself to the `CREDITS` file and the corresponding
+  list in the the `README`. Alphabetical order applies.
+* Do note that in order for us to merge any non-trivial changes (as a rule
+  of thumb, additions larger than about 15 lines of code), we need an
+  explicit [public domain dedication][PDD] on record from you.
+
 Resources
 ---------
 
@@ -101,22 +131,13 @@ Resources
 * <http://raa.ruby-lang.org/project/sparql-client/>
 * <http://www.ohloh.net/p/rdf>
 
-Authors
--------
-
-* [Arto Bendiken](mailto:arto.bendiken@gmail.com) - <http://ar.to/>
-* [Ben Lavender](mailto:blavender@gmail.com) - <http://bhuga.net/>
-
-Contributors
-------------
-* [Nicholas Humfrey](mailto:njh@aelius.com) - <http://www.aelius.com/njh/>
-
 License
 -------
 
-`SPARQL::Client` is free and unencumbered public domain software. For more
-information, see <http://unlicense.org/> or the accompanying UNLICENSE file.
+This is free and unencumbered public domain software. For more information,
+see <http://unlicense.org/> or the accompanying {file:UNLICENSE} file.
 
+[Ruby]:            http://ruby-lang.org/
 [RDF]:             http://www.w3.org/RDF/
 [SPARQL]:          http://en.wikipedia.org/wiki/SPARQL
 [SPARQL JSON]:     http://www.w3.org/TR/rdf-sparql-json-res/
@@ -125,3 +146,7 @@ information, see <http://unlicense.org/> or the accompanying UNLICENSE file.
 [RDF::Repository]: http://rdf.rubyforge.org/RDF/Repository.html
 [DSL]:             http://en.wikipedia.org/wiki/Domain-specific_language
                    "domain-specific language"
+[YARD]:            http://yardoc.org/
+[YARD-GS]:         http://rubydoc.info/docs/yard/file/docs/GettingStarted.md
+[PDD]:             http://unlicense.org/#unlicensing-contributions
+[Backports]:       http://rubygems.org/gems/backports

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/lib/sparql.rb

@@ -1,3 +1,6 @@
 module SPARQL
-  autoload :Client, 'sparql/client'
+  # @see http://rubygems.org/gems/sparql-client
+  autoload :Client,  'sparql/client'
+  # @see http://rubygems.org/gems/sparql-grammar
+  autoload :Grammar, 'sparql/grammar'
 end

data/lib/sparql/client.rb

@@ -43,12 +43,7 @@ module SPARQL
     #
     # @return [Query]
     def ask(*args)
-      client = self
-      result = Query.ask(*args)
-      (class << result; self; end).send(:define_method, :execute) do
-        client.query(self)
-      end
-      result
+      call_query_method(:ask, *args)
     end
 
     ##
@@ -57,12 +52,16 @@ module SPARQL
     # @param  [Array<Symbol>] variables
     # @return [Query]
     def select(*args)
-      client = self
-      result = Query.select(*args)
-      (class << result; self; end).send(:define_method, :execute) do
-        client.query(self)
-      end
-      result
+      call_query_method(:select, *args)
+    end
+
+    ##
+    # Executes a `DESCRIBE` query.
+    #
+    # @param  [Array<Symbol, RDF::URI>] variables
+    # @return [Query]
+    def describe(*args)
+      call_query_method(:describe, *args)
     end
 
     ##
@@ -71,8 +70,14 @@ module SPARQL
     # @param  [Array<Symbol>] pattern
     # @return [Query]
     def construct(*args)
+      call_query_method(:construct, *args)
+    end
+
+    ##
+    # @private
+    def call_query_method(meth, *args)
       client = self
-      result = Query.construct(*args)
+      result = Query.send(meth, *args)
       (class << result; self; end).send(:define_method, :execute) do
         client.query(self)
       end
@@ -84,6 +89,7 @@ module SPARQL
     #
     # @param  [String, #to_s]          url
     # @param  [Hash{Symbol => Object}] options
+    # @option options [String] :content_type
     # @return [Array<RDF::Query::Solution>]
     def query(query, options = {})
       get(query) do |response|
@@ -95,16 +101,17 @@ module SPARQL
           when Net::HTTPServerError # 5xx
             raise ServerError.new(response.body)
           when Net::HTTPSuccess     # 2xx
-            parse_response(response)
+            parse_response(response, options)
         end
       end
     end
 
     ##
     # @param  [Net::HTTPSuccess] response
+    # @param  [Hash{Symbol => Object}] options
     # @return [Object]
-    def parse_response(response)
-      case content_type = response.content_type
+    def parse_response(response, options = {})
+      case content_type = options[:content_type] || response.content_type
         when RESULT_BOOL # Sesame-specific
           response.body == 'true'
         when RESULT_JSON
@@ -112,7 +119,7 @@ module SPARQL
         when RESULT_XML
           parse_xml_bindings(response.body)
         else
-          parse_rdf_serialization(response)
+          parse_rdf_serialization(response, options)
       end
     end
 
@@ -202,9 +209,11 @@ module SPARQL
 
     ##
     # @param  [Net::HTTPSuccess] response
+    # @param  [Hash{Symbol => Object}] options
     # @return [RDF::Enumerable]
-    def parse_rdf_serialization(response)
-      if reader = RDF::Reader.for(:content_type => response.content_type)
+    def parse_rdf_serialization(response, options = {})
+      options = {:content_type => response.content_type} if options.empty?
+      if reader = RDF::Reader.for(options)
         reader.new(response.body)
       end
     end
@@ -227,6 +236,24 @@ module SPARQL
 
     protected
 
+    ##
+    # Returns an HTTP class or HTTP proxy class based on environment http_proxy & https_proxy settings
+    # @return [Net::HTTP::Proxy]
+    def http_klass(scheme)
+      proxy_uri = nil
+      case scheme
+        when "http"
+          proxy_uri = URI.parse(ENV['http_proxy']) unless ENV['http_proxy'].nil?
+        when "https"
+          proxy_uri = URI.parse(ENV['https_proxy']) unless ENV['https_proxy'].nil?
+      end
+      return Net::HTTP if proxy_uri.nil? 
+
+      proxy_host, proxy_port = proxy_uri.host, proxy_uri.port
+      proxy_user, proxy_pass = proxy_uri.userinfo.split(/:/) if proxy_uri.userinfo
+      Net::HTTP::Proxy(proxy_host, proxy_port, proxy_user, proxy_pass)
+    end
+
     ##
     # Performs an HTTP GET request against the SPARQL endpoint.
     #
@@ -239,7 +266,7 @@ module SPARQL
       url = self.url.dup
       url.query_values = {:query => query.to_s}
 
-      Net::HTTP.start(url.host, url.port) do |http|
+      http_klass(url.scheme).start(url.host, url.port) do |http|
         response = http.get(url.path + "?#{url.query}", @headers.merge(headers))
         if block_given?
           block.call(response)

data/lib/sparql/client/query.rb

@@ -16,6 +16,10 @@ module SPARQL; class Client
     # @return [Hash{Symbol => Object}]
     attr_reader :options
 
+    ##
+    # @return [Array<[key, RDF::Value]>]
+    attr_reader :values
+
     ##
     # Creates a boolean `ASK` query.
     #
@@ -35,7 +39,19 @@ module SPARQL; class Client
     # @see    http://www.w3.org/TR/rdf-sparql-query/#select
     def self.select(*variables)
       options = variables.last.is_a?(Hash) ? variables.pop : {}
-      self.new(:select, options).select(*variables) # FIXME
+      self.new(:select, options).select(*variables)
+    end
+
+    ##
+    # Creates a `DESCRIBE` query.
+    #
+    # @param  [Array<Symbol, RDF::URI>] variables
+    # @param  [Hash{Symbol => Object}]  options
+    # @return [Query]
+    # @see    http://www.w3.org/TR/rdf-sparql-query/#describe
+    def self.describe(*variables)
+      options = variables.last.is_a?(Hash) ? variables.pop : {}
+      self.new(:describe, options).describe(*variables)
     end
 
     ##
@@ -70,15 +86,21 @@ module SPARQL; class Client
 
     ##
     # @param  [Array<Symbol>] variables
-    # @param  [Hash{Symbol => Object}] options
     # @return [Query]
     # @see    http://www.w3.org/TR/rdf-sparql-query/#select
     def select(*variables)
-      @form = :select
-      options = variables.last.is_a?(Hash) ? variables.pop : {}
-      @variables = variables.inject({}) do |vars, var|
-        vars.merge(var.to_sym => RDF::Query::Variable.new(var))
-      end
+      @values = variables.map { |var| [var, RDF::Query::Variable.new(var)] }
+      self
+    end
+
+    ##
+    # @param  [Array<Symbol>] variables
+    # @return [Query]
+    # @see    http://www.w3.org/TR/rdf-sparql-query/#describe
+    def describe(*variables)
+      @values = variables.map { |var|
+        [var, var.is_a?(RDF::URI) ? var : RDF::Query::Variable.new(var)]
+      }
       self
     end
 
@@ -86,12 +108,15 @@ module SPARQL; class Client
     # @param  [Array<RDF::Query::Pattern, Array>] patterns
     # @return [Query]
     def construct(*patterns)
-      options[:template] = patterns.map do |pattern|
-        case pattern
-          when RDF::Query::Pattern then pattern
-          else RDF::Query::Pattern.new(*pattern.to_a)
-        end
-      end
+      options[:template] = build_patterns(patterns)
+      self
+    end
+
+    # @param RDF::URI uri
+    # @return [Query]
+    # @see http://www.w3.org/TR/rdf-sparql-query/#specDataset
+    def from(uri)
+      options[:from] = uri
       self
     end
 
@@ -100,19 +125,14 @@ module SPARQL; class Client
     # @return [Query]
     # @see    http://www.w3.org/TR/rdf-sparql-query/#GraphPattern
     def where(*patterns)
-      @patterns += patterns.map do |pattern|
-        case pattern
-          when RDF::Query::Pattern then pattern
-          else RDF::Query::Pattern.new(*pattern.to_a)
-        end
-      end
+      @patterns += build_patterns(patterns)
       self
     end
 
     alias_method :whether, :where
 
     ##
-    # @param  [Array<Symbol>] variables
+    # @param  [Array<Symbol, String>] variables
     # @return [Query]
     # @see    http://www.w3.org/TR/rdf-sparql-query/#modOrderBy
     def order(*variables)
@@ -164,6 +184,33 @@ module SPARQL; class Client
       self
     end
 
+    ##
+    # @return [Query]
+    # @see    http://www.w3.org/TR/rdf-sparql-query/#prefNames
+    def prefix(string)
+      (options[:prefixes] ||= []) << string
+      self
+    end
+
+    ##
+    # @return [Query]
+    # @see    http://www.w3.org/TR/rdf-sparql-query/#optionals
+    def optional(*patterns)
+      (options[:optionals] ||= []) << build_patterns(patterns)
+      self
+    end
+
+    ##
+    # @private
+    def build_patterns(patterns)
+      patterns.map do |pattern|
+        case pattern
+          when RDF::Query::Pattern then pattern
+          else RDF::Query::Pattern.new(*pattern.to_a)
+        end
+      end
+    end
+
     ##
     # @private
     def filter(string)
@@ -220,38 +267,54 @@ module SPARQL; class Client
     def to_s
       buffer = [form.to_s.upcase]
       case form
-        when :select
+        when :select, :describe
           buffer << 'DISTINCT' if options[:distinct]
           buffer << 'REDUCED'  if options[:reduced]
-          buffer << (variables.empty? ? '*' : variables.values.map { |v| serialize_value(v) }.join(' '))
+          buffer << (values.empty? ? '*' : values.map { |v| serialize_value(v[1]) }.join(' '))
         when :construct
           buffer << '{'
-          buffer += options[:template].map do |p|
-            p.to_triple.map { |v| serialize_value(v) }.join(' ') + " . "
-          end
+          buffer += serialize_patterns(options[:template])
           buffer << '}'
       end
 
-      buffer << 'WHERE {'
-      buffer += patterns.map do |p|
-        p.to_triple.map { |v| serialize_value(v) }.join(' ') + " . "
-      end
-      if options[:filters]
-        buffer += options[:filters].map { |filter| "FILTER(#{filter})" }
+      buffer << "FROM #{serialize_value(options[:from])}" if options[:from]
+
+      unless patterns.empty? && form == :describe
+        buffer << 'WHERE {'
+        buffer += serialize_patterns(patterns)
+        if options[:optionals]
+          options[:optionals].each do |patterns|
+            buffer << 'OPTIONAL {'
+            buffer += serialize_patterns(patterns)
+            buffer << '}'
+          end
+        end
+        if options[:filters]
+          buffer += options[:filters].map { |filter| "FILTER(#{filter})" }
+        end
+        buffer << '}'
       end
-      buffer << '}'
 
       if options[:order_by]
         buffer << 'ORDER BY'
-        buffer += options[:order_by].map { |var| "?#{var}" }
+        buffer += options[:order_by].map { |var| var.is_a?(String) ? var : "?#{var}" }
       end
 
       buffer << "OFFSET #{options[:offset]}" if options[:offset]
       buffer << "LIMIT #{options[:limit]}"   if options[:limit]
+      options[:prefixes].reverse.each {|e| buffer.unshift("PREFIX #{e}") } if options[:prefixes]
 
       buffer.join(' ')
     end
 
+    ##
+    # @private
+    def serialize_patterns(patterns)
+      patterns.map do |p|
+        p.to_triple.map { |v| serialize_value(v) }.join(' ') + " ."
+      end
+    end
+
     ##
     # Outputs a developer-friendly representation of this query to `stderr`.
     #
@@ -279,7 +342,7 @@ module SPARQL; class Client
       # 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.variable? then "?#{value.name}"
+        when value.variable? then value.to_s
         else RDF::NTriples.serialize(value)
       end
     end

data/lib/sparql/client/version.rb

@@ -2,11 +2,10 @@ module SPARQL; class Client
   module VERSION
     MAJOR = 0
     MINOR = 0
-    TINY  = 4
+    TINY  = 5
     EXTRA = nil
 
-    STRING = [MAJOR, MINOR, TINY].join('.')
-    STRING << ".#{EXTRA}" if EXTRA
+    STRING = [MAJOR, MINOR, TINY, EXTRA].compact.join('.')
 
     ##
     # @return [String]

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Arto Bendiken
@@ -15,36 +15,36 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-21 00:00:00 +02:00
+date: 2010-09-06 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rdf-spec
+  name: json_pure
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         segments: 
-        - 0
         - 1
-        - 10
-        version: 0.1.10
-  type: :development
+        - 4
+        - 0
+        version: 1.4.0
+  type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: rdf
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
-        - 1
-        - 3
         - 0
-        version: 1.3.0
-  type: :development
+        - 2
+        - 0
+        version: 0.2.0
+  type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: yard
@@ -55,41 +55,41 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        - 5
-        - 4
-        version: 0.5.4
+        - 6
+        - 0
+        version: 0.6.0
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rdf
+  name: rspec
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 0
         - 1
-        - 10
-        version: 0.1.10
-  type: :runtime
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: json_pure
+  name: rdf-spec
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         segments: 
-        - 1
-        - 4
         - 0
-        version: 1.4.0
-  type: :runtime
+        - 2
+        - 0
+        version: 0.2.0
+  type: :development
   version_requirements: *id005
 description: SPARQL client for RDF.rb.
-email: arto.bendiken@gmail.com
+email: public-rdf-ruby@w3.org
 executables: []
 
 extensions: []
@@ -98,7 +98,7 @@ extra_rdoc_files: []
 
 files: 
 - AUTHORS
-- CONTRIBUTORS
+- CREDITS
 - README
 - UNLICENSE
 - VERSION
@@ -108,7 +108,7 @@ files:
 - lib/sparql/client.rb
 - lib/sparql.rb
 has_rdoc: false
-homepage: http://sparql.rubyforge.org/
+homepage: http://sparql.rubyforge.org/client/
 licenses: 
 - Public Domain
 post_install_message: 
@@ -123,8 +123,8 @@ required_ruby_version: !ruby/object:Gem::Requirement
       segments: 
       - 1
       - 8
-      - 2
-      version: 1.8.2
+      - 1
+      version: 1.8.1
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="

data/CONTRIBUTORS

@@ -1 +0,0 @@
-* Nicholas Humfrey <njh@aelius.com>