ibm-watson-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 987b93d5b8b4632720831f78dc5ecbe016633648
+  data.tar.gz: f499c7861a98ab27974a30b53888b5dc7dcd7998
+SHA512:
+  metadata.gz: 7fcac6af6ef7871ba2845434a06111c0b6c8e6456558786cf583bdbfbb71ad9bdf431ab83d1757654b79c56992ddf4869a506f95359a33f4597159e7ffaf030b
+  data.tar.gz: 759a838669ecec44667e05258f6c50a1547cb4b42ae02313a8ebece7ba8fa7c6a6f9a800b8641f9d86882e8d4e5cdaa6d7f920c5db4d0b7fb29763e938d17a53

data/.gitignore

@@ -0,0 +1,96 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Rails template
+*.rbc
+capybara-*.html
+.rspec
+/log
+/tmp
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+/coverage/
+/spec/tmp
+**.orig
+rerun.txt
+pickle-email-*.html
+
+# TODO Comment out these rules if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+config/secrets.yml
+
+# dotenv
+# TODO Comment out this rule if environment variables can be committed
+.env
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalize the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv
+
+# Ignore Byebug command history file.
+.byebug_history
+### Ruby template
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'http'
+gem 'active_attr'

data/Gemfile.lock

@@ -0,0 +1,75 @@
+PATH
+  remote: .
+  specs:
+    ibm-watson-ruby (0.0.1)
+      active_attr (~> 0.10)
+      http (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    active_attr (0.10.0)
+      activemodel (>= 3.0.2, < 5.1)
+      activesupport (>= 3.0.2, < 5.1)
+    activemodel (4.2.8)
+      activesupport (= 4.2.8)
+      builder (~> 3.1)
+    activesupport (4.2.8)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
+    builder (3.2.3)
+    diff-lcs (1.3)
+    domain_name (0.5.20170223)
+      unf (>= 0.0.5, < 1.0.0)
+    http (2.2.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 1.0.1)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (1.0.1)
+    http_parser.rb (0.6.0)
+    i18n (0.8.1)
+    minitest (5.10.1)
+    public_suffix (2.0.5)
+    rake (0.9.6)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubygems-tasks (0.2.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_attr
+  bundler (~> 1.0)
+  http
+  ibm-watson-ruby!
+  rake (~> 0.8)
+  rspec (~> 3.3)
+  rubygems-tasks (~> 0.2)
+
+BUNDLED WITH
+   1.14.4

data/README.md

@@ -0,0 +1,2 @@
+# ibm-watson-ruby
+IBM Watson Services in Ruby

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'bundler'
+require 'rake'
+require 'rubygems/tasks'
+
+Bundler.setup(:development)
+
+task :build do
+  Gem::Tasks.new(release: true)
+end

data/ibm-watson-ruby.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/ibm_watson/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "ibm-watson-ruby"
+  gem.version       = IBMWatson::VERSION
+  gem.summary       = "IBM Watson services in ruby"
+  gem.description   = "."
+  gem.license       = "MIT"
+  gem.authors       = ["Bram Whillock"]
+  gem.email         = "bramski@gmail.com"
+  gem.homepage      = "https://github.com/imrealtor/watson-ruby"
+  gem.required_ruby_version = '~> 2.3'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency "http", "~> 2.0"
+  gem.add_dependency "active_attr", '~> 0.10'
+
+  gem.add_development_dependency 'bundler', '~> 1.0'
+  gem.add_development_dependency 'rake', '~> 0.8'
+  gem.add_development_dependency 'rspec', '~> 3.3'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+end

data/lib/ibm_watson.rb

@@ -0,0 +1,7 @@
+require 'active_attr'
+
+require 'ibm_watson/version'
+require 'ibm_watson/base_model'
+require 'ibm_watson/errors'
+require 'ibm_watson/conversation'
+require 'ibm_watson/base_service'

data/lib/ibm_watson/base_model.rb

@@ -0,0 +1,6 @@
+module IBMWatson
+  class BaseModel
+    include ActiveAttr::Model
+    include ActiveAttr::AttributeDefaults
+  end
+end

data/lib/ibm_watson/base_service.rb

@@ -0,0 +1,70 @@
+module IBMWatson
+  class BaseService
+    class << self
+      def url(url)
+        define_method :service_url do
+          url
+        end
+      end
+
+      def version(version)
+        define_method :service_version do
+          version
+        end
+      end
+    end
+
+    def initialize(username:, password:)
+      @username = username
+      @password = password
+    end
+
+    private
+
+    attr_reader :username, :password
+
+    def parse_array(json_string, model_class, root_key)
+      array = JSON.parse(json_string).fetch(root_key)
+      array.map do |attributes|
+        model_class.new attributes
+      end
+    end
+
+    def build_url(*paths, query: {})
+      url = [service_url, service_version, paths.join('/')].join("/")
+      if query.any?
+        url += "?" + query.to_query
+      end
+      url
+    end
+
+    def collection_url(cluster_id, collection_name, resource)
+      build_url('solr_clusters', cluster_id, 'solr', collection_name, resource)
+    end
+
+    def accept_json(http_chain)
+      http_chain.headers(accept: "application/json")
+    end
+
+    def verify_http_result(result, verify_json: true)
+      if result.status.between?(200, 299)
+        if verify_json
+          verify_no_json_failure(result)
+        end
+      elsif result.status.between?(400, 499)
+        raise IBMWatson::Errors::WatsonRequestError, "Server returned #{result.status} : #{result.reason}"
+      end
+    end
+
+    def verify_no_json_failure(result)
+      json_data = JSON.parse(result.body)
+      if json_data['failure']
+        raise IBMWatson::Errors::WatsonError, json_data['failure'].values.first
+      end
+    end
+
+    def basic_auth
+      HTTP.basic_auth(user: username, pass: password)
+    end
+  end
+end

data/lib/ibm_watson/conversation.rb

@@ -0,0 +1,13 @@
+module IBMWatson
+  module Conversation
+  end
+end
+
+require 'conversation/service'
+require 'conversation/context'
+require 'conversation/intent_result'
+require 'conversation/output_result'
+require 'conversation/result'
+require 'conversation/workspace'
+require 'conversation/intent'
+require 'conversation/dialog_node'

data/lib/ibm_watson/conversation/context.rb

@@ -0,0 +1,35 @@
+module IBMWatson
+  module Conversation
+    class Context < IBMWatson::BaseModel
+      attribute :conversation_id
+      attribute :dialog_stack, default: [{ dialog_node: "root" }]
+      attribute :dialog_turn_counter, default: 1
+      attribute :dialog_request_counter, default: 1
+      attribute :context, default: {}
+      attribute :_node_output_map
+
+      def as_json(*)
+        {
+          conversation_id: conversation_id,
+          system: {
+            dialog_stack: dialog_stack,
+            dialog_turn_counter: dialog_turn_counter,
+            dialog_request_counter: dialog_request_counter,
+          }
+        }
+      end
+
+      def from_json(json)
+        values = json.deep_symbolize_keys
+        self.attributes= {
+          conversation_id: values[:conversation_id],
+          dialog_stack: values[:system][:dialog_stack],
+          dialog_turn_counter: values[:system][:dialog_turn_counter],
+          dialog_request_counter: values[:system][:dialog_request_counter],
+          _node_output_map: values[:system][:_node_output_map],
+          context: values[:context]
+        }
+      end
+    end
+  end
+end

data/lib/ibm_watson/conversation/dialog_node.rb

@@ -0,0 +1,17 @@
+module IBMWatson
+  module Conversation
+    class DialogNode < IBMWatson::BaseModel
+      attribute :goto, type: String
+      attribute :output, type: Hash
+      attribute :parent, type: String
+      attribute :context, type: Hash
+      attribute :created, type: String
+      attribute :updated, type: String
+      attribute :metadata
+      attribute :conditions, type: String
+      attribute :description, type: String
+      attribute :dialog_node, type: String
+      attribute :previous_sibling, type: String
+    end
+  end
+end

data/lib/ibm_watson/conversation/intent.rb

@@ -0,0 +1,11 @@
+module IBMWatson
+  module Conversation
+    class Intent < IBMWatson::BaseModel
+      attribute :intent, type: String
+      attribute :created, type: String
+      attribute :updated, type: String
+      attribute :examples, type: Array
+      attribute :description
+    end
+  end
+end

data/lib/ibm_watson/conversation/intent_result.rb

@@ -0,0 +1,8 @@
+module IBMWatson
+  module Conversation
+    class IntentResult < IBMWatson::BaseModel
+      attribute :intent, type: String
+      attribute :confidence, type: Float
+    end
+  end
+end

data/lib/ibm_watson/conversation/output_result.rb

@@ -0,0 +1,14 @@
+module IBMWatson
+  module Conversation
+    class OutputResult < IBMWatson::BaseModel
+      attribute :log_messages, type: Array
+      attribute :text, type: Array
+      attribute :nodes_visited, type: Array
+      attribute :action, type: String
+      attribute :template, type: String
+      attribute :choices, type: Hash
+      attribute :boolean, type: Hash
+      attribute :repeat_input, type: String
+    end
+  end
+end

data/lib/ibm_watson/conversation/result.rb

@@ -0,0 +1,18 @@
+module IBMWatson
+  module Conversation
+    class Result < IBMWatson::BaseModel
+      attribute :intents,
+                type: ::IBMWatson::Conversation::IntentResult,
+                typecaster: lambda { |values|
+                  values.map do |value|
+                    ::IBMWatson::Conversation::IntentResult.new(value)
+                  end
+                }
+      attribute :entities
+      attribute :input
+      attribute :output, type: Hash
+      attribute :context, type: Hash
+      attribute :alternate_intents
+    end
+  end
+end

data/lib/ibm_watson/conversation/service.rb

@@ -0,0 +1,32 @@
+module IBMWatson
+  module Conversation
+    class Service < IBMWatson::BaseService
+      version "v1"
+      url "https://gateway.watsonplatform.net/conversation/api"
+      QUERY_VERSION = "2017-02-03"
+
+      def workspace(workspace_id:, export: false)
+        url = build_url('workspaces', workspace_id, query: { version: QUERY_VERSION, export: export})
+        result = accept_json(basic_auth).get(url)
+        verify_http_result(result)
+        IBMWatson::Conversation::Workspace.new.tap do |result_object|
+          result_object.from_json(result)
+        end
+      end
+
+      def message(workspace_id:, input:, context:, alternate_intents: false)
+        url = build_url('workspaces',workspace_id, 'message', query: { version: QUERY_VERSION})
+        params = {
+          input: {text: input},
+          context: context.as_json,
+          alternate_intents: alternate_intents
+        }
+        result = accept_json(basic_auth).post(url, json: params)
+        verify_http_result(result)
+        IBMWatson::Conversation::Result.new.tap do |result_object|
+          result_object.from_json(result)
+        end
+      end
+    end
+  end
+end

data/lib/ibm_watson/conversation/workspace.rb

@@ -0,0 +1,20 @@
+module IBMWatson
+  module Conversation
+    class Workspace < IBMWatson::BaseModel
+      attribute :name, type: String
+      attribute :description, type: String
+      attribute :language, type: String
+      attribute :metadata, type: Hash
+      attribute :created, type: String
+      attribute :updated, type: String
+      attribute :workspace_id, type: String
+      attribute :status, type: String
+      attribute :intents, type: ::IBMWatson::Conversation::Intent,
+                typecaster: lambda { |values| values.map { |value| ::IBMWatson::Conversation::Intent.new(value) }}
+      attribute :entities, type: Array
+      attribute :counterexamples, type: Array
+      attribute :dialog_nodes, type: ::IBMWatson::Conversation::DialogNode,
+                typecaster: lambda { |values| values.map { |value|  ::IBMWatson::Conversation::DialogNode.new(value)}}
+    end
+  end
+end

data/lib/ibm_watson/errors.rb

@@ -0,0 +1,6 @@
+module IBMWatson
+  module Errors
+    class WatsonError < StandardError; end
+    class WatsonRequestError < WatsonError; end
+  end
+end

data/lib/ibm_watson/version.rb

@@ -0,0 +1,3 @@
+module IBMWatson
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: ibm-watson-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bram Whillock
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: active_attr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: "."
+email: bramski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- ibm-watson-ruby.gemspec
+- lib/ibm_watson.rb
+- lib/ibm_watson/base_model.rb
+- lib/ibm_watson/base_service.rb
+- lib/ibm_watson/conversation.rb
+- lib/ibm_watson/conversation/context.rb
+- lib/ibm_watson/conversation/dialog_node.rb
+- lib/ibm_watson/conversation/intent.rb
+- lib/ibm_watson/conversation/intent_result.rb
+- lib/ibm_watson/conversation/output_result.rb
+- lib/ibm_watson/conversation/result.rb
+- lib/ibm_watson/conversation/service.rb
+- lib/ibm_watson/conversation/workspace.rb
+- lib/ibm_watson/errors.rb
+- lib/ibm_watson/version.rb
+homepage: https://github.com/imrealtor/watson-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: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: IBM Watson services in ruby
+test_files: []