watson-api-client 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e3210faf43b3240684b0871e6a09bc77c0aa5ad
-  data.tar.gz: 2b40d2d3d87820368555f4577de2f23e538c8765
+  metadata.gz: bf43a7c4e5b1a840e5e59c752434155f9a1704e4
+  data.tar.gz: ac7cf313d8948c803dba69ac10121a6618027a48
 SHA512:
-  metadata.gz: bfcccc4f138b4ef62b69af897584580f86a6fdc2b71cd221e5688fe6021552f7edfe2ee5c5fb754addc07dd59d5bb991091eab8bc2d2b20ff975813dc17f3bc5
-  data.tar.gz: 56d9179cf6db6a307f1ca6e59e99ee3ebec842e80d36ebb901cfe6692314655b31e2abb5ff7573466c57518b17c33bb54256b43d2911f40ea3e74cf7115f00ba
+  metadata.gz: edbe184d558657b75a05a7852f64b99554dbfaeab16176c9d25621ed275dd92c4988c358c83db440ed3bd63188483894711ce76db40e1d7eed3764b54d7a548f
+  data.tar.gz: d084db495948621d638cda6289c31e5200aaefdb1a2cc3660b4c7ad9c0763848a16c8afcb5be8f13ea5c668a4c8fc4cecff7a6e4003fa0f1e92c4d61929a53eb

data/LICENSE

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2015 Takashi SUGA <suchowan@box.email.ne.jp>.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2015 Takashi SUGA <suchowan@box.email.ne.jp>.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -55,7 +55,7 @@ Let's use the 'Relationship Extraction' service.
                              'txt' => 'John Smith lives in New York, and he has been living there since 2001.')
     p JSON.parse(result.body)
 
-####The generation of the RelationshipExtraction service object
+####Generation of the RelationshipExtraction service object
 First of all, the instance of the RelationshipExtraction class has to be generated. 
 The constructor argument is passed to the constructor of [RestClient::Resource](http://www.rubydoc.info/gems/rest-client/RestClient/Resource) class.
 Please refer to the document of the rest-client for the details of this hash argument.
@@ -70,7 +70,7 @@ Therefore, it is necessary to start up a server application even if it is a dumm
 If the server application is a Ruby on Rails application that require 'watson-api-client', and if it is deployed on the Cloud Foundry, the watson-api-client can read environment variable VCAP_SERVICES directly.
 In this case, the specification of :user and :password is omissible.
 
-####The extraction of relationship in an example sentence using RelationshipExtraction#extract
+####Extraction of relationship in an example sentence using RelationshipExtraction#extract
 Next, by the 'extract' method of the RelationshipExtraction class, we try to extract relationship in an example sentence.
 How to set the argument can be seen by clicking on the 'Expand Operations' link of the Watson API Reference 'Relationship Extraction'.
 The method name called 'extract' is the nickname corresponding to 'POST /v1/sire/0'.
@@ -95,17 +95,30 @@ Next, let's use 'Personality Insights'.
       'Accept'           => "application/json",
       'Accept-Language'  => "en",
       'Content-Language' => "en",
-      'body'             => open('https://raw.githubusercontent.com/suchowan/when_exe/master/LICENSE.txt',
+      'body'             => open('https://raw.githubusercontent.com/suchowan/watson-api-client/master/LICENSE',
                                  :ssl_verify_mode=>OpenSSL::SSL::VERIFY_NONE))
     p JSON.parse(result.body)
 
 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
+
+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)
+
+It seems that the image file must be on the local file system.
 
 More
 -------
-At present this gem is a α version and only the normal behavior of RelationshipExtraction and PersonalityInsights are confirmed.
+At present this gem is an α version and only the normal behavior of RelationshipExtraction, PersonalityInsights and VisualRecognition are confirmed.
 It is welcome when you can cooperate with the confirmation of other various functions.
 
 

data/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require "bundler/gem_tasks"

data/lib/watson-api-client.rb

@@ -1,132 +1,121 @@
-require 'json'
-require 'openssl'
-require 'open-uri'
-require 'rest-client'
-require 'pp' if __FILE__ == $PROGRAM_NAME
-
-class WatsonAPIClient
-
-  VERSION = '0.0.1'
-
-  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'][1..-1].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={})
-    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
-
-  alias :_method_missing :method_missing
-
-  def method_missing(method, *args, &block)
-    definition = self.class::API['methods'][method.to_s]
-    if definition
-      self.class.module_eval %Q{
-        def #{method}(options={})
-          rest_access_#{definition['body'] ? 'with' : 'without'}_body("#{method}", options)
-        end
-      }
-      send(method, *args, &block)
-    else
-      _method_missing(method, *args, &block)
-    end
-  end
-end
+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

data/watson-api-client.gemspec

@@ -1,24 +1,24 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path('../lib', __FILE__)
-require 'watson-api-client'
-
-Gem::Specification.new do |s|
-  s.name        = 'watson-api-client'
-  s.version     = WatsonAPIClient::VERSION
-  s.authors     = ['Takashi SUGA']
-  s.email       = ['suchowan@box.email.ne.jp']
-  s.homepage    = 'https://github.com/suchowan/watson-api-client'
-  s.license     = 'MIT'
-  s.summary     = %q{An IBM Watson™ API client}
-  s.description = %q{The watson-api-client is a gem to use REST API on the IBM Watson™ Developer Cloud. It wraps the rest-client REST API using Swagger documents retrievable from the Watson API Reference.}
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ['lib']
-  s.required_ruby_version = '>= 1.9.3'
-
-  # specify any dependencies here; for example:
-  # s.add_development_dependency 'rspec'
-  s.add_runtime_dependency 'rest-client'
-end
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'watson-api-client'
+
+Gem::Specification.new do |s|
+  s.name        = 'watson-api-client'
+  s.version     = WatsonAPIClient::VERSION
+  s.authors     = ['Takashi SUGA']
+  s.email       = ['suchowan@box.email.ne.jp']
+  s.homepage    = 'https://github.com/suchowan/watson-api-client'
+  s.license     = 'MIT'
+  s.summary     = %q{An IBM Watson™ API client}
+  s.description = %q{The watson-api-client is a gem to use REST API on the IBM Watson™ Developer Cloud. It wraps the rest-client REST API using Swagger documents retrievable from the Watson API Reference.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+  s.required_ruby_version = '>= 1.9.3'
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency 'rspec'
+  s.add_runtime_dependency 'rest-client'
+end

metadata

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