watson-api-client 0.0.1

checksums.yaml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+ruby '>= 1.9.3'
+
+gem 'rest-client'

data/LICENSE

@@ -0,0 +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.

data/README.md

@@ -0,0 +1,121 @@
+watson-api-client - An IBM Watson™ API client
+================================================================
+
+[![Gem Version](https://badge.fury.io/rb/watson-api-client.svg)](http://badge.fury.io/rb/watson-api-client)
+
+The [watson-api-client](http://rubygems.org/gems/watson-api-client) is a gem to use REST API on the IBM Watson™ Developer Cloud.
+
+It wraps the [rest-client](https://rubygems.org/gems/rest-client) REST API using [Swagger](http://swagger.io/) documents retrievable from the [Watson API Reference](https://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/apis/).
+
+
+Installation
+------------
+
+The watson-api-client gem can be installed by running:
+
+    gem install watson-api-client
+
+Since watson-api-client is dependent on the rest-client, when the rest-client is not installed, the rest-client is also installed automatically.
+
+
+Documentation
+-------------
+
+The simple API documentation for the watson-api-client is available on [RubyDoc.info](http://rubydoc.info/gems/watson-api-client).
+
+However, most of the classes and methods of this gem are not described in the above document because they are dynamically defined.
+Instead, you can output to the standard output the actual those list of classes and methods when you run the lib/watson-api-client.rb directly.
+
+
+Source Code
+-----------
+
+The source code for the watson-api-client is available on [GitHub](https://github.com/suchowan/watson-api-client).
+
+
+Example Usage
+-------------
+
+###Preparation
+
+The watson-api-client is a gem to use REST API on the IBM Watson™ Developer Cloud.
+To enable these API, you have to do the user registration to the IBM Bluemix™ beforehand, make the services effective, and be relating them to your application.
+For more information, refer to 'Getting Started' in '[Table of Contents for Services Documentation](http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/)'.
+
+###Relationship Extraction example
+
+Let's use the 'Relationship Extraction' service.
+
+    require 'watson-api-client'
+    service = WatsonAPIClient::RelationshipExtraction.new(:user=>"xxxxxx",
+                                                          :password=>"yyyyy",
+                                                          :verify_ssl=>OpenSSL::SSL::VERIFY_NONE)
+    result = service.extract('rt'  => 'json',
+                             'sid' => 'ie-en-news',
+                             '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
+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.
+
+Class name called RelationshipExtraction is the camel case-ized service name of [Watson API Reference](http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/apis/).
+:user and :password are the 'username' and the 'password' picked out from environment variable VCAP_SERVICES.
+Please refer to '[Viewing Bluemix environment variables](http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/getting_started/gs-bluemix.shtml#vcapViewing)' for the details of VCAP_SERVICES.
+
+However, when no server application associated with the service exists, 'Show Credentials' link does not appear on the console window.
+Therefore, it is necessary to start up a server application even if it is a dummy.
+
+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
+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'.
+This can be seen by opening the JSON code of Swagger by clicking on the '[Raw](http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/apis/listings/relationship-extraction)' link of the 'Relationship Extraction' of API Reference window.
+
+The list of the method of the RelationshipExtraction class can be seen even by using the following script.
+
+    p WatsonAPIClient::RelationshipExtraction::API['digest']
+
+Since 'json' is specified as Return type ('rt') in this example, the JSON string is stored in the body of the 'extract' method response.
+When converting this JSON string to a hash object using JSON.parse method, the result of Relationship Extraction can be used variously by your client programs.
+
+###Personality Insights example
+
+Next, let's use 'Personality Insights'.
+
+    service = WatsonAPIClient::PersonalityInsights.new(:user=>"xxxxxx",
+                                                       :password=>"yyyyy",
+                                                       :verify_ssl=>OpenSSL::SSL::VERIFY_NONE)
+    result = service.profile(
+      'Content-Type'     => "text/plain",
+      'Accept'           => "application/json",
+      'Accept-Language'  => "en",
+      'Content-Language' => "en",
+      'body'             => open('https://raw.githubusercontent.com/suchowan/when_exe/master/LICENSE.txt',
+                                 :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.
+
+
+More
+-------
+At present this gem is a α 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)
+
+
+Legal
+-------
+The watson-api-client is released under the MIT license, see [LICENSE](https://github.com/suchowan/watson-api-client/blob/master/LICENSE) for details.
+
+IBM Watson™ and IBM Bluemix™ are trade marks of the IBM corporation.

data/Rakefile

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

data/lib/watson-api-client.rb

@@ -0,0 +1,132 @@
+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

data/watson-api-client.gemspec

@@ -0,0 +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

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: watson-api-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Takashi SUGA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 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.
+email:
+- suchowan@box.email.ne.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/watson-api-client.rb
+- watson-api-client.gemspec
+homepage: https://github.com/suchowan/watson-api-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: An IBM Watson™ API client
+test_files: []
+has_rdoc: