watson-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 75eb37d001cf07bb49a4719cd6ef33760dd51ef7
+  data.tar.gz: f23f072ec1f00124c73618f1eabd1a775b53997e
+SHA512:
+  metadata.gz: bf10d1598cf074e77b59cb8ee78eaf9f9f42f50917d428ae5be724b336fce03bf6763c37d569c8fdee7203301b04038a1591e29e518c043139bde440e9b974d2
+  data.tar.gz: 9402bdc34541986e5070c79b6881a5634582a46f08e1da434fcc9fbcd5cb4a75a743933e88ca4d82dd780282f88c92435b9b4771011990efeb70f708363d9209

data/README.md

@@ -0,0 +1,61 @@
+# w-ruby
+API client for watson IPBM services
+
+# w-ruby
+API client for watson IPBM services
+
+### Conversation API
+Initialize your own credentials for Conversation API
+```ruby
+Watson::Conversation.configure(
+  password: 'YOUR_CONVERSATION_PASSWORD',
+  username: 'YOUR_CONVERSATION_USERNAME',
+  url:      'https://gateway.watsonplatform.net/conversation/api',
+  workspace_id: 'YOUR_CONVERSATION_WORKSPACE_ID'
+)
+```
+
+**Example:**
+A simple response from your dialog model
+```ruby
+require 'watson-client'
+
+client = Watson::Conversation.new
+client.send_message('message one')
+  >> "Watson response one"
+client.send_message('message two')
+  >> "Watson response two"
+```
+
+Try something different
+```ruby
+require 'watson-client'
+
+puts 'Say Hi!'
+user_input = nil
+until user_input == 'q' || user_input == 'exit'
+  print '> '
+  user_input = gets.chomp
+  return if user_input == 'q' || user_input == 'exit'
+  client.send_message(user_input)
+  sleep 0.5
+end
+```
+
+### Retrieve and Rank API
+Initialize your own credentials for Conversation API
+```ruby
+Watson::RetrieveAndRank.configure(
+  url:      'https://watson-api-explorer.mybluemix.net/retrieve-and-rank/api',
+  password: 'YOUR_RETRIEVE_AND_RANK_PASSWORD',
+  username: 'YOUR_RETRIEVE_AND_RANK_USERNAME',
+  cluster_id: 'YOUR_RETRIEVE_AND_RANK_CLUSTER_ID',
+  collection_name: 'YOUR_RETRIEVE_AND_RANK_COLLECTION_NAME'
+)
+```
+Get the suggested answers
+```ruby
+responses = Watson::RetrieveAndRank.send_message('message')
+```
+
+The response is returned as a JSON array.

data/lib/watson/cluster.rb

@@ -0,0 +1,13 @@
+module Watson
+  class Cluster
+    attr_reader :solr_cluster_id, :cluster_name, :cluster_size,
+                :solr_cluster_status
+
+    def initialize(options = {})
+      @solr_cluster_id     = options['solr_cluster_id']
+      @cluster_name        = options['cluster_name']
+      @cluster_size        = options['cluster_size']
+      @solr_cluster_status = options['solr_cluster_status']
+    end
+  end
+end

data/lib/watson/conversation.rb

@@ -0,0 +1,36 @@
+module Watson
+  class Conversation
+    def self.configure(options = {})
+      @@username     = options[:username]
+      @@password     = options[:password]
+      @@url          = options[:url]
+      @@workspace_id = options[:workspace_id]
+    end
+
+    def conversation
+      @context['conversation_id']
+    end
+
+    def send_message(message = '')
+      params = { input: { text: message }, alternate_intents: true }
+      params.merge!(@context) unless @context.nil?
+
+      response = Excon.post(url,
+                            body:     params.to_json,
+                            headers:  {
+                              'Content-Type' => 'application/json',
+                              'Accept' => 'application/json'
+                            },
+                            user:      @@username,
+                            password:  @@password)
+      result = JSON.parse(response.body)
+
+      @context = { context: result['context'] }
+      puts result['output']['text']
+    end
+
+    def url
+      @@url + '/v1/workspaces/' + @@workspace_id + '/message?version=2016-09-20'
+    end
+  end
+end

data/lib/watson/retrieve_and_rank.rb

@@ -0,0 +1,33 @@
+module Watson
+  class RetrieveAndRank
+    def self.configure(options = {})
+      @username         = options[:username]
+      @password         = options[:password]
+      @url              = options[:url]
+      @cluster          = options[:cluster_id]
+      @collection_name  = options[:collection_name]
+    end
+
+    def self.send_message(message = '')
+      query = URI.encode(message)
+      response = Excon.post(url(query),
+                            headers: {
+                              'Content-Type' => 'application/json',
+                              'Accept' => 'application/json'
+                            },
+                            user:      @username,
+                            password:  @password)
+      result = JSON.parse(response.body)
+      answers(result['response']['docs'])
+    end
+
+    def self.answers(data)
+      data.each { |d| puts d['body'] }
+    end
+
+    def self.url(query)
+      @url + '/v1/solr_clusters/' + @cluster + '/solr/' + @collection_name +
+        '/select?q=' + query + '&wt=json'
+    end
+  end
+end

data/lib/watson.rb

@@ -0,0 +1,5 @@
+require 'excon'
+require 'json'
+require 'uri'
+require_relative '../lib/watson/conversation'
+require_relative '../lib/watson/retrieve_and_rank'

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: watson-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Carlos Andres Torres Cruz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Send and receive messages to Conversation or Retrieve and Rank services
+email: carlosandrestorres28@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/watson.rb
+- lib/watson/cluster.rb
+- lib/watson/conversation.rb
+- lib/watson/retrieve_and_rank.rb
+homepage: https://github.com/katorres02/w-ruby
+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.6
+signing_key: 
+specification_version: 4
+summary: REST API client for IBM Watson™ services
+test_files: []