watson-api-client 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf43a7c4e5b1a840e5e59c752434155f9a1704e4
-  data.tar.gz: ac7cf313d8948c803dba69ac10121a6618027a48
+  metadata.gz: 5fec45c50b850da9cd802179d152e89d98891076
+  data.tar.gz: 773b646ed640000c56789f6d07083274b1e40ded
 SHA512:
-  metadata.gz: edbe184d558657b75a05a7852f64b99554dbfaeab16176c9d25621ed275dd92c4988c358c83db440ed3bd63188483894711ce76db40e1d7eed3764b54d7a548f
-  data.tar.gz: d084db495948621d638cda6289c31e5200aaefdb1a2cc3660b4c7ad9c0763848a16c8afcb5be8f13ea5c668a4c8fc4cecff7a6e4003fa0f1e92c4d61929a53eb
+  metadata.gz: 28a9d5c4e20a7eb5bf088a1a075883165958dd4df037e5d3d1268fcc0eafbef9efa10b23e916ce50164262b0efe47272368b66112818a3936da788e1ba6b056d
+  data.tar.gz: 8a17361402286dffe07a2c34724ba537c68fe37b1aeb528b0111b2164293d7a4c109b478039af3f072aebfe425a1546b2eb7bcc40890035eeb49550c55e57695

data/README.md

@@ -102,29 +102,31 @@ Next, let's use 'Personality Insights'.
 The class name, the method name, and the argument setting rules are the same as that of the case of 'Relationship Extraction' almost.
 The rest-client and the watson-api-client judge which of path, query, header, body each argument is used for automatically.
 
-###Visual Recognition example
+More
+-------
+The documents which 'watson-api-client' referred to have changed in [February 2016](https://github.com/suchowan/watson-api-client/issues/1).
 
-Last, let's use 'Visual Recognition'.
 
-    service = WatsonAPIClient::VisualRecognition.new(:user=>"xxxxxx",
-                                                     :password=>"yyyyy",
-                                                     :verify_ssl=>OpenSSL::SSL::VERIFY_NONE)
-    result = service.recognizeLabelsService(
-      'img_File' => open('image.jpg','rb')
-    )
-    p JSON.parse(result.body)
+(1) The JSON file which held the list of APIs emptied.
 
-It seems that the image file must be on the local file system.
+(2) The version of Swagger which describes API specifications went up from 1.2 to 2.0.
 
-More
--------
-At present this gem is an α version and only the normal behavior of RelationshipExtraction, PersonalityInsights and VisualRecognition are confirmed.
+
+They may be linked to the release of the IBM Watson for Japanese language.
+
+The new version 0.0.3 corresponding to them was released provisionally.
+Concerning about (1) in the version 0.0.3, the locations of JSON files which describe API specification are acquired from contents of web pages for human using regular expressions.
+
+Essentially, as well as former versions, the location of the API documents should be readable with JSON file.
+I will request to the IBM to revive the JSON file which held the list of APIs.
+
+At present this gem is an alpha version and only the normal behavior of RelationshipExtraction and PersonalityInsights are confirmed.
 It is welcome when you can cooperate with the confirmation of other various functions.
 
 
 Credits
 -------
-Copyright (c) 2015 [Takashi SUGA](http://hosi.org/TakashiSuga.ttl)
+Copyright (c) 2015-2016 [Takashi SUGA](http://hosi.org/TakashiSuga.ttl)
 
 
 Legal

data/lib/watson-api-client.rb

@@ -1,121 +1,161 @@
-require 'json'
-require 'openssl'
-require 'open-uri'
-require 'rest-client'
-require 'pp' if __FILE__ == $PROGRAM_NAME
-
-class WatsonAPIClient
-
-  VERSION = '0.0.2'
-
-  class << self
-    def listings(apis)
-      methods = {}
-      digest  = {}
-      apis['apis'].each do |api|
-        api['operations'].each do |operation|
-          body = nil
-          (operation['parameters']||[]).each do |parameter|
-            next unless parameter['paramType'] == 'body'
-            body = parameter['name']
-            break
-          end
-          nickname = operation['nickname'].sub(/(.)/) {$1.downcase}
-          methods[nickname] = {'path'=>api['path'], 'operation'=>operation, 'body'=>body}
-          digest[nickname]  = {'method'=>operation['method'], 'path'=>api['path'], 'summary'=>operation['summary']}
-        end
-      end
-      {'apis'=>apis, 'methods'=>methods, 'digest'=>digest}
-    end
-    private :listings
-  end
-
-  api_docs = {
-    :base => 'https://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/apis/',
-    :path => 'listings/api-docs.json',
-    :ssl_verify_mode => OpenSSL::SSL::VERIFY_NONE
-  }
-  JSON.parse(ENV['WATSON_API_DOCS'] || '{}').each_pair do |key, value|
-    api_docs[key.to_sym] = value
-  end
-
-  Services = JSON.parse(ENV['VCAP_SERVICES'] || '{}')
-  Base     = api_docs.delete(:base)
-  path     = api_docs.delete(:path)
-  Options  = api_docs
-  listings = JSON.parse(open(Base + path, Options).read)
-
-  listings['apis'].each do |list|
-    module_eval %Q{
-      class #{('-'+list['path']).gsub(/[-_\/]+(.)/) {$1.upcase}} < self
-        Service = superclass::Services['#{list['path'].sub(/^[-_\/]+/,'').gsub(/-/, '_')}']
-        RawDoc  = "#{Base + listings['basePath'] + list['path']}"
-
-        class << self
-          alias :_const_missing :const_missing
-
-          def const_missing(constant)
-            if constant == :API
-              const_set(:API, listings(JSON.parse(open(RawDoc, superclass::Options).read)))
-            else
-              _const_missing(constant)
-            end
-          end
-        end
-        pp [self, 'See ' + RawDoc, API['digest']] if '#{__FILE__}' == '#{$PROGRAM_NAME}'
-      end
-    }
-  end
-
-  # All subclass constructors use following hash parameter - 
-  #
-  # @param [Hash] options See following..
-  # @option options [String] :url          API URL (default: the url described in listings or VCAP_SERVICES)
-  # @option options [String] :user         USER ID (default: the username described in VCAP_SERVICES)
-  # @option options [String] :password     USER Password (default: the password described in VCAP_SERVICES)
-  # @option options [Object] other_options Other options are passed to RestClient::Resource.new[http://www.rubydoc.info/gems/rest-client/RestClient/Resource] as it is. 
-  #
-  # @note VCAP_SERVICES[http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/getting_started/gs-bluemix.shtml#vcapViewing] is IBM Bluemix™ environment variable.
-  #
-  def initialize(options={})
-    self.class::API['methods'].each_pair do |method, definition|
-      self.class.module_eval %Q{define_method("#{method}",
-        Proc.new {|options={}| rest_access_#{definition['body'] ? 'with' : 'without'}_body("#{method}", options)}
-      )} unless respond_to?(method)
-    end
-    credential = self.class::Service ? self.class::Service.first['credentials'] : {}
-    if options[:url]
-      @url   = options.delete(:url)
-    elsif credential['url']
-      @url   = credential['url']
-    else
-      @url   = self.class::API['apis']['basePath']
-      @url  += self.class::API['apis']['resourcePath'] unless @url.index(self.class::API['apis']['resourcePath'])
-    end
-    @options = {:user=>credential['username'], :password=>credential['password']}.merge(options)
-    @service = RestClient::Resource.new(@url, @options)
-  end
-
-  private
-
-  def rest_access_without_body(method, options={})
-    path, access = swagger_info(method, options)
-    @service[path].send(access, options)
-  end
-
-  def rest_access_with_body(method, options={})
-    path, access = swagger_info(method, options)
-    body = options.delete(self.class::API['methods'][method.to_s]['body'])
-    @service[path].send(access, body, options)
-  end
-
-  def swagger_info(method, options)
-    spec   = self.class::API['methods'][method.to_s]
-    lacked = []
-    spec['operation']['parameters'].each do |parameter|
-      lacked << parameter['name'] if parameter['required'] && !options[parameter['name']]
-    end
-    raise ArgumentError, "Parameter(s) '#{lacked.join(', ')}' required, see #{self.class::RawDoc}." unless lacked.empty?
-    [spec['path'].gsub(/\{(.+?)\}/) {options.delete($1)}, spec['operation']['method'].downcase]
-  end
-end
+require 'json'
+require 'openssl'
+require 'open-uri'
+require 'rest-client'
+require 'pp' if __FILE__ == $PROGRAM_NAME
+
+class WatsonAPIClient
+
+  VERSION = '0.0.3'
+
+  class << self
+
+    private
+
+    def retrieve_doc(doc_urls)
+      apis  = {}
+
+      # Watson API Explorer
+      host1 = doc_urls[:doc_base1][/^https?:\/\/[^\/]+/]
+      open(doc_urls[:doc_base1], Options, &:read).scan(/<p>\s*<a href="\/(.+?)".*?>\s*(.+?)\s*<\/a><\/p>/i) do
+        api = {'path'=>doc_urls[:doc_base1] + $1, 'title'=>$2.sub(/\s*\(.+?\)$/,'')}
+        open(api['path'], Options, &:read).scan(/url:\s*'(.+?)'/) do
+          api['path'] = host1 + $1
+        end
+        apis[api['title']] = api
+      end
+
+      # Watson Developercloud
+      host2 = doc_urls[:doc_base2][/^https?:\/\/[^\/]+/]
+      open(doc_urls[:doc_base2], Options, &:read).scan(/<li>\s*<img src=.+?>\s*<h2><a href="(.+?)".*?>\s*(.+?)\s*<\/a><\/h2>\s*<p>(.+?)<\/p>\s*<\/li>/im) do
+        api = {'path'=>$1, 'title'=>$2, 'description'=>$3}
+        next if api['path'] =~ /\.\./
+        if apis.key?(api['title'])
+          apis[api['title']]['description'] = api['description']
+        else
+          # Only for Relationship Extraction
+          open(doc_urls[:doc_base2] + api['path'], Options, &:read).scan(/<li><a href="(.+?)".*?>API\s+explorer<\/a><\/li>/i) do
+            ref = host2 + $1
+            open(ref, Options, &:read).scan(/getAbsoluteUrl\("(.+?)"\)/) do
+              api['path'] = ref.split('/')[0..-2].join('/') + '/' + $1
+            end
+          end
+          apis[api['title']] = api
+        end
+      end
+
+      apis
+    end
+
+    # for Swagger 2.0
+    def listings(apis)
+      methods = {}
+      digest  = {}
+      apis['paths'].each_pair do |path, operations|
+        operations.each_pair do |method, operation|
+          body = nil
+          (operation['parameters']||[]).each do |parameter|
+            next unless parameter['in'] == 'body'
+            body = parameter['name']
+            break
+          end
+          nickname = operation['operationId'].sub(/(.)/) {$1.downcase}
+          methods[nickname] = {'method'=>method, 'path'=>path, 'operation'=>operation, 'body'=>body}
+          digest[nickname]  = {'method'=>method, 'path'=>path, 'summary'=>operation['summary']}
+        end
+      end
+      {'apis'=>apis, 'methods'=>methods, 'digest'=>digest}
+    end
+  end
+
+  api_docs = {
+    :gateway   => 'https://gateway.watsonplatform.net',
+    :doc_base1 => 'https://watson-api-explorer.mybluemix.net/',
+    :doc_base2 => 'https://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/',
+    :ssl_verify_mode => OpenSSL::SSL::VERIFY_NONE
+  }
+  JSON.parse(ENV['WATSON_API_DOCS'] || '{}').each_pair do |key, value|
+    api_docs[key.to_sym] = value
+  end
+  doc_urls = {
+    :doc_base1 => api_docs.delete(:doc_base1),
+    :doc_base2 => api_docs.delete(:doc_base2)
+  }
+
+  Gateway  = api_docs.delete(:gateway)
+  Options  = api_docs
+  Services = JSON.parse(ENV['VCAP_SERVICES'] || '{}')
+
+  retrieve_doc(doc_urls).each_value do |list|
+    module_eval %Q{
+      class #{list['title'].gsub(/\s+(.)/) {$1.upcase}} < self
+        Service = superclass::Services['#{list['title'].sub(/\s+/,'_').downcase}']
+        RawDoc  = "#{list['path']}"
+
+        class << self
+          alias :_const_missing :const_missing
+
+          def const_missing(constant)
+            if constant == :API
+              const_set(:API, listings(JSON.parse(open(RawDoc, superclass::Options, &:read))))
+            else
+              _const_missing(constant)
+            end
+          end
+        end
+        pp [self, 'See ' + RawDoc, API['digest']] if '#{__FILE__}' == '#{$PROGRAM_NAME}'
+      end
+    }
+  end
+
+  # All subclass constructors use following hash parameter - 
+  #
+  # @param [Hash] options See following..
+  # @option options [String] :url          API URL (default: the url described in listings or VCAP_SERVICES)
+  # @option options [String] :user         USER ID (default: the username described in VCAP_SERVICES)
+  # @option options [String] :password     USER Password (default: the password described in VCAP_SERVICES)
+  # @option options [Object] other_options Other options are passed to RestClient::Resource.new[http://www.rubydoc.info/gems/rest-client/RestClient/Resource] as it is. 
+  #
+  # @note VCAP_SERVICES[http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/getting_started/gs-bluemix.shtml#vcapViewing] is IBM Bluemix™ environment variable.
+  #
+  def initialize(options={})
+    self.class::API['methods'].each_pair do |method, definition|
+      self.class.module_eval %Q{define_method("#{method}",
+        Proc.new {|options={}| rest_access_#{definition['body'] ? 'with' : 'without'}_body("#{method}", options)}
+      )} unless respond_to?(method)
+    end
+    credential = self.class::Service ? self.class::Service.first['credentials'] : {}
+    if options[:url]
+      @url   = options.delete(:url)
+    elsif credential['url']
+      @url   = credential['url']
+    else
+      @url   = Gateway + self.class::API['apis']['basePath']
+    end
+    @options = {:user=>credential['username'], :password=>credential['password']}.merge(options)
+    @service = RestClient::Resource.new(@url, @options)
+  end
+
+  private
+
+  def rest_access_without_body(method, options={})
+    path, access = swagger_info(method, options)
+    @service[path].send(access, options)
+  end
+
+  def rest_access_with_body(method, options={})
+    path, access = swagger_info(method, options)
+    body = options.delete(self.class::API['methods'][method.to_s]['body'])
+    @service[path].send(access, body, options)
+  end
+
+  def swagger_info(method, options)
+    spec   = self.class::API['methods'][method.to_s]
+    lacked = []
+    spec['operation']['parameters'].each do |parameter|
+      lacked << parameter['name'] if parameter['required'] && !options[parameter['name']]
+    end
+    raise ArgumentError, "Parameter(s) '#{lacked.join(', ')}' required, see #{self.class::RawDoc}." unless lacked.empty?
+    [spec['path'].gsub(/\{(.+?)\}/) {options.delete($1)}, spec['method']]
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: watson-api-client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Takashi SUGA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-14 00:00:00.000000000 Z
+date: 2016-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client