watsbot 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b41f8b57d87729bb11ef95cab49fd8017441754d
+  data.tar.gz: 741021ef543d67646490bc89ebf6defcb1c85cda
+SHA512:
+  metadata.gz: b4949ae9e6ea73319cf501cb16e140b0cf5091d86d58fd759006edeb1997507c5713ed357edef595f0e949504400cb8c00037a44b21461c9a2d3f23b1c357a50
+  data.tar.gz: 9a192c6a5be0cc2c755aa738f8cf9047d94ade2971ca8ad85c7b1a6170463cd7664ea38f47b8fda34f60750764bab94a2712014aab072c639c631e82ca1a5423

data/.byebug_history

@@ -0,0 +1,71 @@
+c
+n
+ex
+n
+ex
+n
+uid
+c
+response.context["system"]
+response.context["system"]["branch_exited_reason"]
+response.context["system"]["branch_exited_reason"
+n
+response
+n
+c
+response
+n
+c
+response
+n
+c
+State.instancec
+State.instance
+response
+response = message.call(uid, "Hi", {})
+  Watsbot.configuration.version
+c
+response
+n
+c
+State.instance
+State.instance.redis.keys
+State.instance.keys
+State.instance.fetch(uid)
+c
+data.to_json
+data
+d2 = state.fetch(uid)
+c
+e
+n
+c
+e
+n
+c
+options
+n
+c
+e
+n
+Watsbot.configuration.version
+options
+body
+n
+c
+e.backtrace.first
+e
+n
+context
+state
+n
+uid
+s
+n
+ENV["WATSON_WORKSPACE_VERSION"]
+c
+Dotenv.load
+ENV["WATSON_WORKSPACE_VERSION"]
+ENV["WATSON_WORKSPACE"]
+ENV["WATSON_PASSWORD"]
+ENV["WATSON_USERNAME"]

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/log/
+# rspec failure tracking
+.rspec_status
+coverage
+.env

data/.rspec

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

data/.simplecov

@@ -0,0 +1,4 @@
+SimpleCov.start do
+  add_group "lib", "lib"
+  add_filter "/spec/"
+end

data/.travis.yml

@@ -0,0 +1,14 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.15.0
+script: 'bundle exec rake'
+
+notifications:
+  email:
+    recipients:
+      - payam@roundtableapps.com
+    on_failure: change
+    on_success: never

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at payam@roundtableapps.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in watsbot.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,26 @@
+guard 'rspec', cmd: "rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # watch /lib/ files
+  watch(%r{^lib\/watsbot\/(.+)\.rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  # watch /spec/ files
+  watch(%r{^spec\/(.+)\.rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Payam Mousavi
+
+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,63 @@
+# Watsbot
+
+Talk to [IBM Watson Conversation service](https://www.ibm.com/watson/developercloud/doc/conversation/getting-started.html)!
+
+This gem provides a simple client to communicate with IBM Watson Conversation service using REST API. It utilizes [Redis](https://redis.io/) to store state of the conversation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'watsbot'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install watsbot
+
+## Requirements
+
+* Redis server ([https://redis.io/topics/quickstart](https://redis.io/topics/quickstart))
+
+## Examples
+
+
+```ruby
+require 'watsbot/watsbot'
+
+# config/initializers/watsbot.rb
+Watsbot::Configuration.new(
+  username:  ENV["WATSON_USERNAME"],
+  password:  ENV["WATSON_PASSWORD"],
+  workspace: ENV["WATSON_WORKSPACE"],
+  version:   ENV["WATSON_WORKSPACE_VERSION"],
+  redis_url: ENV["REDIS_URL"] # redis://127.0.0.1:6379/2
+  )
+
+watsbot = Watsbot::Message.new
+
+# To start a conversation/send a message without context
+watsbot.send("A UNIQUE IDENTIFIER, e.g. uuid", "Hi")
+
+# To send a message with context
+watsbot.send("A UNIQUE IDENTIFIER, e.g. uuid", "Hi", { conversation_id: "...", ... })
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pamit/watsbot.
+
+## 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,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "dotenv"
+
+Dotenv.load
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'documentation']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "watsbot"
+
+# 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
+
+require "irb"
+IRB.start(__FILE__)

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/watsbot.rb

@@ -0,0 +1,33 @@
+require "watsbot/base_resource"
+require "watsbot/configuration"
+require "watsbot/logger"
+require "watsbot/message"
+require "watsbot/state"
+require "watsbot/version"
+require "watsbot/response/error"
+require "watsbot/response/success"
+require "watsbot/response/parser"
+
+module Watsbot
+  BASE_URI = "https://gateway.watsonplatform.net/conversation/api/v1"
+
+  def self.root
+    File.dirname __dir__
+  end
+  
+  class << self
+    attr_writer :configuration
+
+    def configure(&block)
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def reset
+      @configuration = Configuration.new
+    end
+  end
+end

data/lib/watsbot/base_resource.rb

@@ -0,0 +1,19 @@
+module Watsbot
+  class BaseResource
+    attr_accessor :config, :logger
+
+    def initialize(config = Watsbot.configuration)
+      @config = config
+      self.class.base_uri @config.base_uri
+      @logger = Logger.instance
+    end
+
+    def headers
+      { 'Content-Type' => 'application/json' }
+    end
+
+    def basic_auth
+      { username: @config.username, password: @config.password }
+    end
+  end
+end

data/lib/watsbot/configuration.rb

@@ -0,0 +1,16 @@
+module Watsbot
+  class Configuration
+    attr_accessor :username, :password, :workspace, :version, :base_uri, :redis_url
+
+    def initialize(*args, &block)
+      arg        = args.pop        || {}
+      @username  = arg[:username]  || ENV["WATSON_USERNAME"]
+      @password  = arg[:password]  || ENV["WATSON_PASSWORD"]
+      @workspace = arg[:workspace] || ENV["WATSON_WORKSPACE"]
+      @version   = arg[:version]   || ENV["WATSON_WORKSPACE_VERSION"]
+      @base_uri  = BASE_URI
+      @redis_url = arg[:redis_url] || ENV["REDIS_URL"]
+      yield self if block_given?
+    end
+  end
+end

data/lib/watsbot/logger.rb

@@ -0,0 +1,50 @@
+require "logger"
+require "singleton"
+
+module Watsbot
+  class Logger
+    include Singleton
+
+    def debug(path, message)
+      ::Logger.new(make_log_file(path), "daily").debug(message)
+    end
+
+    def error(path, message)
+      ::Logger.new(make_log_file(path), "daily").error(message)
+    end
+
+    def info(path, message)
+      ::Logger.new(make_log_file(path), "daily").info(message)
+    end
+
+    def warn(path, message)
+      ::Logger.new(make_log_file(path), "daily").warn(message)
+    end
+
+    def raw_log(path, message)
+      full_path = make_log_file(path)
+      File.open(full_path, "a+") { |f| f.puts("R, [#{DateTime.now.as_json}]  RAW -- : " + message) }
+    end
+
+    private
+
+      def make_log_file(path)
+        log_address = "#{Watsbot.root}#{path}"
+        make_dir(File.dirname(log_address))
+        make_file(log_address)
+        log_address
+      end
+
+      def make_dir(path)
+        if (!File.directory? path)
+          FileUtils.mkpath path
+        end
+      end
+
+      def make_file(path_to_file)
+        if (!File.exists? path_to_file)
+          FileUtils.touch path_to_file
+        end
+      end
+  end
+end