chemspider 0.0.2 → 0.0.3

data/AUTHORS

@@ -0,0 +1 @@
+* Mark Borkum <m.i.borkum@soton.ac.uk>

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/chem_spider.rb

@@ -4,6 +4,10 @@ require 'date'
 require 'net/http'
 require 'uri'
 
+##
+# ChemSpider.rb: ChemSpider wrapped up with a Ruby bow.
+#
+# @see http://www.chemspider.com/AboutServices.aspx
 module ChemSpider
   class << self
     ##
@@ -38,9 +42,10 @@ module ChemSpider
     #   })
     #   #=> 2157
     #
-    # @param [#to_s] service_name
-    # @param [#to_s] operation_name
-    # @param [Hash] params (Hash.new)
+    # @param [#to_sym] service_name
+    # @param [#to_sym] operation_name
+    # @param [Hash{Symbol => Object}] params (Hash.new)
+    # @param [Hash{Symbol => Object}] options (Hash.new)
     # @option uri_options [#to_s] :scheme ('http')
     # @option uri_options [#to_s] :host ('www.chemspider.com')
     # @option uri_options [#to_s] :port (80)
@@ -49,14 +54,10 @@ module ChemSpider
     # @option uri_options [#to_s] :query (nil)
     # @option uri_options [#to_s] :fragment (nil)
     # @option options [#to_s] :selector (nil)
-    # @option options [Hash, Class, #__attributes__, #new] :datatype (Hash.new)
+    # @option options [Hash{Symbol => Object}, Class, #__attributes__] :datatype (Hash.new)
     # @option options [Boolean] :first_child (false)
-    #
     # @return [Object]
-    #
-    # @see ChemSpider#css
-    # @see ChemSpider#uri_for
-    #
+    # @since 0.0.1
     def get!(service_name, operation_name, params = {}, uri_options = {}, options = {})
       # construct the URI...
       uri = uri_for(service_name, operation_name, params, uri_options)
@@ -103,9 +104,10 @@ module ChemSpider
     #   })
     #   #=> 2157
     #
-    # @param [#to_s] service_name
-    # @param [#to_s] operation_name
-    # @param [Hash] params (Hash.new)
+    # @param [#to_sym] service_name
+    # @param [#to_sym] operation_name
+    # @param [Hash{Symbol => Object}] params (Hash.new)
+    # @param [Hash{Symbol => Object}] options (Hash.new)
     # @option uri_options [#to_s] :scheme ('http')
     # @option uri_options [#to_s] :host ('www.chemspider.com')
     # @option uri_options [#to_s] :port (80)
@@ -114,14 +116,10 @@ module ChemSpider
     # @option uri_options [#to_s] :query (nil)
     # @option uri_options [#to_s] :fragment (nil)
     # @option options [#to_s] :selector (nil)
-    # @option options [Hash, Class, #__attributes__, #new] :datatype (Hash.new)
+    # @option options [Hash{Symbol => Object}, Class, #__attributes__] :datatype (Hash.new)
     # @option options [Boolean] :first_child (false)
-    #
     # @return [Object]
-    #
-    # @see ChemSpider#css
-    # @see ChemSpider#uri_for
-    #
+    # @since 0.0.1
     def post!(service_name, operation_name, params = {}, uri_options = {}, options = {})
       # construct the URI...
       uri = uri_for(service_name, operation_name, nil, uri_options)
@@ -156,18 +154,15 @@ module ChemSpider
     #   m.post!(:inchi_key => 'BSYNRYMUTXBXSQ-UHFFFAOYSA-N')
     #   #=> 2157
     #
-    # @param [#to_s] service_name
-    # @param [#to_s] operation_name
-    # @param [Array<String>] param_names
+    # @param [#to_sym] service_name
+    # @param [#to_sym] operation_name
+    # @param [Array<String>] param_names (Array.new)
+    # @param [Hash{Symbol => Object}] options (Hash.new)
     # @option options [#to_s] :selector (nil)
-    # @option options [Hash, Class, #__attributes__, #new] :datatype (Hash.new)
+    # @option options [Hash{Symbol => Object}, Class, #__attributes__] :datatype (Hash.new)
     # @option options [Boolean] :first_child (false)
-    #
     # @return [Module]
-    #
-    # @see ChemSpider#get!
-    # @see ChemSpider#post!
-    #
+    # @since 0.0.1
     def REST(service_name, operation_name, param_names = [], options = {})
       # find/create the specified module...
       # #=> "ChemSpider::#{service_name}::#{operation_name}"
@@ -182,8 +177,10 @@ module ChemSpider
       # [re]define the methods...
       %w{get! post!}.each do |method_name|
         ##
+        # @return [Object]
         # @see ChemSpider#get!
         # @see ChemSpider#post!
+        # @since 0.0.1
         mod.send(:define_method, method_name.to_sym) do |*args|
           # the default `uri_options` argument is an empty Hash
           uri_options = {}
@@ -235,25 +232,29 @@ module ChemSpider
       end
       
       ##
-      # @return [String]
+      # @return [Symbol]
+      # @since 0.0.2
       mod.send(:define_method, :chem_spider_service_name) do ||
-        service_name.to_s
+        service_name.to_sym
       end
       
       ##
-      # @return [String]
+      # @return [Symbol]
+      # @since 0.0.2
       mod.send(:define_method, :chem_spider_operation_name) do ||
-        operation_name.to_s
+        operation_name.to_sym
       end
       
       ##
       # @return [Array<String>]
+      # @since 0.0.2
       mod.send(:define_method, :chem_spider_param_names) do ||
         param_names.collect(&:to_s)
       end
       
       ##
-      # @return [Hash]
+      # @return [Hash{Symbol => Object}]
+      # @since 0.0.2
       mod.send(:define_method, :chem_spider_options) do ||
         options.dup
       end
@@ -268,9 +269,8 @@ module ChemSpider
     # Returns a unary callable that casts the argument to the specified `Class`. 
     #
     # @param [Class] klass
-    #
     # @return [#call]
-    #
+    # @since 0.0.1
     def cast_for(klass)
       # lazily construct the set of callables...
       @casts ||= {
@@ -293,14 +293,12 @@ module ChemSpider
     # Extracts nodes specified by a CSS selector, and casts the result. 
     # 
     # @param [Nokogiri::XML::Node] doc
+    # @param [Hash{Symbol => Object}] options (Hash.new)
     # @option options [#to_s] :selector (nil)
-    # @option options [Class, Hash, #__attributes__, #new] :datatype (Hash.new)
+    # @option options [Hash{Symbol => Object}, Class, #__attributes__] :datatype (Hash.new)
     # @option options [Boolean] :first_child (false)
-    #
     # @return [Object]
-    # 
-    # @see ChemSpider#cast_for
-    #
+    # @since 0.0.1
     def css(doc, options = {})
       # evaluate the CSS selector...
       nodes = doc.css(options[:selector].to_s)
@@ -359,10 +357,9 @@ module ChemSpider
     # @example Construct a query string with multivalued parameters.
     #   ChemSpider.query_for(:letters => %w{a b c}) #=> 'letters=a&letters=b&letters=c'
     #
-    # @param [Array, Hash] pairs
-    #
+    # @param [Array<#to_s>, Hash{Symbol => Object}] pairs
     # @return [#to_s]
-    #
+    # @since 0.0.1
     def query_for(pairs)
       return nil if pairs.nil? || pairs.empty?
       
@@ -392,11 +389,12 @@ module ChemSpider
     #     :port => 443,
     #     :path_format => '/chemspider/%s/%s',
     #   })
-    #   #=> #<URI::HTTP:0x101990e88 URL:http://www.example.com:443/chemspider/InChI/InChIKeyToCSID?inchi_key=BSYNRYMUTXBXSQ-UHFFFAOYSA-N>
+    #   #=> #<URI::HTTPS:0x101990e88 URL:https://www.example.com:443/chemspider/InChI/InChIKeyToCSID?inchi_key=BSYNRYMUTXBXSQ-UHFFFAOYSA-N>
     #
-    # @param [#to_s] service_name
-    # @param [#to_s] operation_name
-    # @param [Hash] params (Hash.new)
+    # @param [#to_sym] service_name
+    # @param [#to_sym] operation_name
+    # @param [Hash{Symbol => Object}] params (Hash.new)
+    # @param [Hash{Symbol => Object}] options (Hash.new)
     # @option options [#to_s] :scheme ('http')
     # @option options [#to_s] :host ('www.chemspider.com')
     # @option options [#to_s] :port (80)
@@ -404,11 +402,9 @@ module ChemSpider
     # @option options [#to_s] :path_format ('/%s.asmx/%s')
     # @option options [#to_s] :query (nil)
     # @option options [#to_s] :fragment (nil)
-    #
     # @return [URI]
-    #
     # @see ChemSpider#query_for
-    #
+    # @since 0.0.1
     def uri_for(service_name, operation_name, params = {}, options = {})
       # initialize the format string for the base URI "scheme://host:port"...
       format = '%s://%s:%s'

data/lib/chem_spider/version.rb

@@ -2,7 +2,7 @@ module ChemSpider
   module VERSION
     MAJOR = 0
     MINOR = 0
-    TINY = 2
+    TINY = 3
     EXTRA = nil
 
     STRING = [MAJOR, MINOR, TINY, EXTRA].compact.join('.')

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: chemspider
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Mark Borkum
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-15 00:00:00 Z
+date: 2012-10-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
@@ -33,7 +33,23 @@ dependencies:
         version: 1.5.0
   type: :runtime
   version_requirements: *id001
-description: The ChemSpider API wrapped up with a Ruby bow.
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 7
+        - 2
+        version: 0.7.2
+  type: :development
+  version_requirements: *id002
+description: "ChemSpider.rb: ChemSpider wrapped up with a Ruby bow."
 email: m.i.borkum@soton.ac.uk
 executables: []
 
@@ -42,6 +58,7 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- AUTHORS
 - README
 - UNLICENSE
 - VERSION
@@ -66,10 +83,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 57
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: