artemis-bot 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb1208c38d363ca50f1c465b2c0d4832754a9a2a
+  data.tar.gz: ce481daf17385fb47ce30ec6727cbcba52370957
+SHA512:
+  metadata.gz: 84f14e00bf96b6b54053ac15daa7eff29a5781096676db257a36cf988f00e17fecabd3e4a19b7cf0bdbf64d6c4097e474d3a80a3ca97437e308467bfb93dd8d0
+  data.tar.gz: 2a6addd28a1f5e46b19725fa71ced025f63d220e5607b37ca7704071a0ea8d564768d394c9f0353a8d0e8854f2ee865128bc867e2eb4fd930888fa5f0dd6d05e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at wal.reyes.11@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in artemis-bot.gemspec
+gemspec
+gem 'pry'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Walter Reyes
+
+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,67 @@
+<a href="https://codeclimate.com/repos/582ddb758ec2e6008000009a/feed"><img src="https://codeclimate.com/repos/582ddb758ec2e6008000009a/badges/5b338f461679b2e41308/gpa.svg" /></a>
+
+# Artemis
+
+Artemis is a wrapper for the [Watson Conversation Service](http://www.ibm.com/watson/developercloud/doc/conversation/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'artemis-bot'
+```
+
+And run `bundle install` from your shell
+
+To install the gem manually from your shell, run:
+
+    $ gem install artemis-bot
+
+## Configuration
+
+First you need to configure Artemis with your Conversation credentials
+
+```
+  Artemis::Bot.configure do |config|
+    config.username = "your-username-here"
+    config.password = "your-password-here"
+  end
+```
+
+## Usage
+
+To send a message:
+
+```
+workspace_id =  "your-workspace_id-here"
+
+message_request = Artemis::Bot::MessageRequest.new
+message_request.input.text = "Hello there"
+message_request.alternate_intents = true
+
+response = Artemis::Bot::Conversator.message(workspace_id, message_request)
+```
+
+To follow up a conversation:
+
+```
+# assign the context from the previous response
+message_request.context = response.context
+message_request.input.text = "How you doing?"
+
+# send the message through the Conversator
+response = Artemis::Bot::Conversator.message(workspace_id, message_request)
+```
+
+`Artemis::Bot::MessageRequest` is a wrapper of the [MessageRequest hash](http://www.ibm.com/watson/developercloud/conversation/api/v1/?curl#send_message) that the endpoint is expecting
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/icalialabs/artemis. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/artemis-bot.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'artemis/bot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "artemis-bot"
+  spec.version       = Artemis::Bot::VERSION
+  spec.authors       = ["Walter Reyes"]
+  spec.email         = ["wal@icalialabs.com"]
+
+  spec.summary       = %q{ Watson Conversation in Ruby}
+  spec.description   = %q{ A Ruby wrapper for the Watson Conversation Service}
+  spec.homepage      = "https://github.com/IcaliaLabs/artemis"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", "~> 0.14.0"
+  spec.add_dependency "httmultiparty", "~> 0.3.16"
+  spec.add_dependency "activesupport", "~> 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'artemis/bot'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/artemis/bot.rb

@@ -0,0 +1,14 @@
+require 'artemis/bot/version'
+require 'artemis/bot/message_request'
+require 'artemis/bot/input'
+require "olimpo"
+require 'active_support/dependencies'
+require 'httmultiparty'
+require "pry"
+
+module Artemis
+  module Bot
+    extend Olimpo
+    autoload(:Conversator, 'artemis/bot/conversator')
+  end
+end

data/lib/artemis/bot/connection.rb

@@ -0,0 +1,15 @@
+module Artemis
+  module Bot
+    module Connection
+      def self.included(klass)
+        klass.class_eval do
+          include HTTMultiParty
+          base_uri 'https://gateway.watsonplatform.net/conversation/api'
+          headers 'Content-Type' => 'application/json'
+          basic_auth Artemis::Bot.username, Artemis::Bot.password
+          debug_output $stdout
+        end
+      end
+    end
+  end
+end

data/lib/artemis/bot/context.rb

@@ -0,0 +1,15 @@
+require 'artemis/bot/context/system'
+
+module Artemis
+  module Bot
+    class Context
+      attr_reader :conversation_id, :system, :default_counter
+
+      def initialize(attrs = {})
+        @conversation_id = attrs['conversation_id']
+        @system = Artemis::Bot::Context::System.new(attrs['system'])
+        @default_counter = attrs['defaultCounter']
+      end
+    end
+  end
+end

data/lib/artemis/bot/context/system.rb

@@ -0,0 +1,15 @@
+module Artemis
+  module Bot
+    class Context
+      class System
+        attr_reader :dialog_stack, :dialog_turn_counter, :dialog_request_counter
+
+        def initialize(attrs = {})
+          @dialog_stack = attrs['dialog_stack']
+          @dialog_turn_counter = attrs['dialog_turn_counter']
+          @dialog_request_counter = attrs['dialog_request_counter']
+        end
+      end
+    end
+  end
+end

data/lib/artemis/bot/conversator.rb

@@ -0,0 +1,33 @@
+require 'artemis/bot/response'
+require 'artemis/bot/message_request'
+require 'artemis/bot/connection'
+require 'artemis/bot/errors'
+require 'artemis/services/object_to_hash'
+
+module Artemis
+  module Bot
+    class Conversator < Olimpo::Base
+      include Artemis::Bot::Connection
+
+      def self.message(workspace_id, message_request = Artemis::Bot::MessageRequest.new)
+        message_request_hash = Artemis::Services::ObjectToHash.convert(message_request, include_nils: false)
+
+        response = post("/v1/workspaces/#{workspace_id}/message?version=2016-09-20",
+                        body: message_request_hash.to_json)
+
+        parsed_response = JSON.parse(response.body)
+
+        return Artemis::Bot::Response.new(parsed_response) if response.success?
+
+        raise_exception(response.code, response.body)
+      end
+
+      private
+
+      def self.raise_exception(code, body)
+        raise Artemis::Bot::ServerError.new(code, body) if code >= 500
+        raise Artemis::Bot::ClientError.new(code, body) if code < 500
+      end
+    end
+  end
+end

data/lib/artemis/bot/entity.rb

@@ -0,0 +1,13 @@
+module Artemis
+  module Bot
+    class Entity
+      attr_reader :entity, :location, :value
+
+      def initialize(attrs = {})
+        @entity = attrs['entity']
+        @location = attrs['location']
+        @value = attrs['value']
+      end
+    end
+  end
+end

data/lib/artemis/bot/errors.rb

@@ -0,0 +1,18 @@
+module Artemis
+  module Bot
+    class Error < StandardError
+      attr_accessor :http_status, :response_body
+
+      def initialize(http_status, response_body)
+        message = " [HTTP #{http_status}] #{response_body}"
+        super(message)
+      end
+    end
+
+    # Any error with a 5xx HTTP status code
+    class ServerError < Error; end
+
+    # Any error with a 4xx HTTP status code
+    class ClientError < Error; end
+  end
+end

data/lib/artemis/bot/input.rb

@@ -0,0 +1,11 @@
+module Artemis
+  module Bot
+    class Input
+      attr_accessor :text
+
+      def initialize(attrs = {})
+        @text = attrs['text']
+      end
+    end
+  end
+end

data/lib/artemis/bot/intent.rb

@@ -0,0 +1,12 @@
+module Artemis
+  module Bot
+    class Intent
+      attr_reader :intent, :confidence
+
+      def initialize(attrs = {})
+        @intent = attrs['intent']
+        @confidence = attrs['confidence']
+      end
+    end
+  end
+end

data/lib/artemis/bot/message_request.rb

@@ -0,0 +1,18 @@
+require 'artemis/bot/input'
+
+module Artemis
+  module Bot
+    class MessageRequest
+      attr_accessor :input, :alternate_intents, :context, :entities, :intents, :output
+
+      def initialize(attrs = {})
+        @input = attrs['input'] || Artemis::Bot::Input.new
+        @alternate_intents = attrs['alternate_intents']
+        @context = attrs['context']
+        @entities = attrs['entities']
+        @intents = attrs['intents']
+        @output = attrs['output']
+      end
+    end
+  end
+end

data/lib/artemis/bot/output.rb

@@ -0,0 +1,12 @@
+module Artemis
+  module Bot
+    class Output
+      attr_reader :text, :nodes_visited
+
+      def initialize(attrs = {})
+        @text = attrs['text']
+        @nodes_visited = attrs['nodes_visited']
+      end
+    end
+  end
+end

data/lib/artemis/bot/response.rb

@@ -0,0 +1,21 @@
+require 'artemis/bot/input'
+require 'artemis/bot/entity'
+require 'artemis/bot/context'
+require 'artemis/bot/intent'
+require 'artemis/bot/output'
+
+module Artemis
+  module Bot
+    class Response
+      attr_reader :input, :context, :entities, :intents, :output
+
+      def initialize(attrs = {})
+        @input = Artemis::Bot::Input.new(attrs['input'])
+        @context = Artemis::Bot::Context.new(attrs['context'])
+        @entities = attrs['entities'].map { |entity| Artemis::Bot::Entity.new(entity) }
+        @intents = attrs['intents'].map { |intent| Artemis::Bot::Intent.new(intent) }
+        @output = Artemis::Bot::Output.new(attrs['output'])
+      end
+    end
+  end
+end

data/lib/artemis/bot/version.rb

@@ -0,0 +1,5 @@
+module Artemis
+  module Bot
+    VERSION = '0.1.1'.freeze
+  end
+end

data/lib/artemis/services/object_to_hash.rb

@@ -0,0 +1,27 @@
+module Artemis
+  module Services
+    module ObjectToHash
+      def self.convert(object, opts = { include_nils: true })
+        hash = {}
+        object.instance_variables.each do |var|
+          var_value = object.instance_variable_get(var)
+
+          next if !opts['include_nils'] && var_value.nil?
+
+          hash[var.to_s.delete('@')] = if descendant?(var_value, Artemis::Bot)
+                                         convert(var_value)
+                                       else
+                                         hash[var.to_s.delete('@')] = var_value
+                                       end
+        end
+
+        hash
+      end
+
+      def self.descendant?(value, parent)
+        parent = parent.class unless parent.is_a?(Class) || parent.is_a?(Module)
+        value.class.to_s.index("#{parent}::").present?
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: artemis-bot
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Walter Reyes
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: httmultiparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.16
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.16
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: " A Ruby wrapper for the Watson Conversation Service"
+email:
+- wal@icalialabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- artemis-bot.gemspec
+- bin/console
+- bin/setup
+- lib/.DS_Store
+- lib/artemis/bot.rb
+- lib/artemis/bot/connection.rb
+- lib/artemis/bot/context.rb
+- lib/artemis/bot/context/system.rb
+- lib/artemis/bot/conversator.rb
+- lib/artemis/bot/entity.rb
+- lib/artemis/bot/errors.rb
+- lib/artemis/bot/input.rb
+- lib/artemis/bot/intent.rb
+- lib/artemis/bot/message_request.rb
+- lib/artemis/bot/output.rb
+- lib/artemis/bot/response.rb
+- lib/artemis/bot/version.rb
+- lib/artemis/services/object_to_hash.rb
+homepage: https://github.com/IcaliaLabs/artemis
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: Watson Conversation in Ruby
+test_files: []