stealth-aws-comprehend 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ebf9ff316ff38bd0e93b7d902199389529ea3aee2aae2b074c486a4eddd66a1d
+  data.tar.gz: 06b6cee909c613ff518d39044b80e1dcfc7de7edcf6b531ac620e88773f513f5
+SHA512:
+  metadata.gz: 7f58207d4b2d8b5f4bafba530586094288c0509cc2fe501581268454975b6af3c53ee2d56d19ba46951230d17c83126333a97d64e68a9ae8e326285161d22dd4
+  data.tar.gz: fddb2d17bff2020db94bd442f0758bf9b4932c5591398184024f513139c0d080675b08cffd414f21c5c6d72810e5e152df8cc0918b60a31579570874fccb779b

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+gemspec
+
+source 'https://rubygems.org'
+ruby '2.5.1'

data/Gemfile.lock

@@ -0,0 +1,86 @@
+PATH
+  remote: .
+  specs:
+    stealth-aws-comprehend (0.9.0)
+      aws-sdk-comprehend (~> 1.0)
+      stealth (< 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    aws-partitions (1.82.0)
+    aws-sdk-comprehend (1.0.0)
+      aws-sdk-core (~> 3)
+      aws-sigv4 (~> 1.0)
+    aws-sdk-core (3.20.2)
+      aws-partitions (~> 1.0)
+      aws-sigv4 (~> 1.0)
+      jmespath (~> 1.0)
+    aws-sigv4 (1.0.2)
+    concurrent-ruby (1.0.5)
+    connection_pool (2.2.1)
+    diff-lcs (1.3)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    jmespath (1.4.0)
+    minitest (5.11.3)
+    multi_json (1.13.1)
+    mustermann (1.0.2)
+    puma (3.11.4)
+    rack (2.0.5)
+    rack-protection (2.0.1)
+      rack
+    redis (4.0.1)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    sidekiq (5.1.3)
+      concurrent-ruby (~> 1.0)
+      connection_pool (~> 2.2, >= 2.2.0)
+      rack-protection (>= 1.5.0)
+      redis (>= 3.3.5, < 5)
+    sinatra (2.0.1)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.1)
+      tilt (~> 2.0)
+    stealth (0.10.6)
+      activesupport (~> 5.2.0.rc1)
+      multi_json (~> 1.12)
+      puma (~> 3.10)
+      sidekiq (~> 5.0)
+      sinatra (~> 2.0)
+      thor (~> 0.20)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tilt (2.0.8)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec (= 3.6.0)
+  stealth-aws-comprehend!
+
+RUBY VERSION
+   ruby 2.5.1p57
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,76 @@
+# stealth-aws-comprehend
+
+This gem provides NLP via the [AWS Comprehend](https://aws.amazon.com/comprehend/) service. It integrates with the Stealth Controller to provide NLP against `current_message`.
+
+## Setup
+
+To use AWS Comprehend, set the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables to your AWS account credentials. You may also want to optionally set your preferred AWS region by setting the environment variable `AWS_REGION`. That's the only setup required!
+
+## Using NLP
+
+This gem adds the following methods to `current_message`:
+
+1. `language` identifies text written in over 100 languages and returns the dominant language in `current_message` with a confidence score
+2. `entities` returns the named entities ("People," "Places," "Locations," etc.) present in `current_message`
+3. `key_phrases` returns the key phrases or talking points and a confidence score to support for the `current_message`
+4. `sentiment` returns the overall sentiment (Positive, Negative, Neutral, or Mixed) for the `current_message`
+5. `sentiment_score` returns the scoring for each sentiment (Positive, Negative, Neutral, or Mixed) for the `current_message`
+
+If `current_message.message` is not available, each of these will return `nil`.
+
+The following examples are run on `current_message.message` when it is equal to `"I bought a brand new Craftsman Drill at Home Depot."`.
+
+### language
+
+`current_message.language` will return an Array of dominate languages:
+
+```ruby
+languages = [#<struct Aws::Comprehend::Types::DominantLanguage language_code="en", score=0.9921924471855164>]
+languages.first.language_code # "en"
+languages.first.score # 0.9921924471855164
+```
+
+### entities
+
+`current_message.entites` will return an Array of entities:
+
+```ruby
+entities = [#<struct Aws::Comprehend::Types::Entity score=0.5775995850563049, type="ORGANIZATION", text="Craftsman", begin_offset=21, end_offset=30>, #<struct Aws::Comprehend::Types::Entity score=0.9224900007247925, type="ORGANIZATION", text="Home Depot", begin_offset=40, end_offset=50>]
+entities.first.text # "Craftsman"
+entities.first.score # 5775995850563049
+entities.first.type # ORGANIZATION
+```
+
+### key_phrases
+
+`current_message.key_phrases` will return an Array of key phrases:
+
+```ruby
+key_phrases = [#<struct Aws::Comprehend::Types::KeyPhrase score=0.965133786201477, text="a brand new Craftsman Drill", begin_offset=9, end_offset=36>, #<struct Aws::Comprehend::Types::KeyPhrase score=0.9943040609359741, text="Home Depot", begin_offset=40, end_offset=50>]
+key_phrases.first.text # "a brand new Craftsman Drill"
+key_phrases.first.score # 0.965133786201477
+```
+
+### sentiment
+
+`current_message.sentiment` will return the dominate sentiment of the message:
+
+```ruby
+current_message.sentiment # "NEUTRAL"
+```
+
+### sentiment_score
+
+`current_message.sentiment_score` will return the scoring for each sentiment of the message:
+
+```ruby
+sentiment_scores = #<struct Aws::Comprehend::Types::SentimentScore positive=0.0249068271368742, negative=0.012575631029903889, neutral=0.9605817794799805, mixed=0.0019358232384547591>
+sentiment_scores.positive # 0.0249068271368742
+sentiment_scores.negative # 0.012575631029903889
+sentiment_scores.neutral # 0.9605817794799805
+sentiment_scores.mixed # 0.0019358232384547591
+```
+
+## AWS Usage
+
+Loading this gem into your bot doesn't automatically issue API requests to your AWS account. API requests are lazily made each time you call one of the above methods. One exception is `sentiment` and `sentiment_score` which share an API call and so that only a single API call is made between the two.

data/lib/stealth-aws-comprehend/client.rb

@@ -0,0 +1,56 @@
+module Stealth
+  class AwsComprehend
+
+    def self.client
+      @client ||= Aws::Comprehend::Client.new
+    end
+
+    def self.detect_dominate_language(message:)
+      begin
+        client.detect_dominant_language({
+          text: message
+        }).languages
+      rescue Aws::Comprehend::Errors::ServiceError
+        Stealth::Logger.l(topic: "AWS::Comprehend", message: e.message)
+        return []
+      end
+    end
+
+    def self.detect_entities(message:, language: 'en')
+      begin
+        client.detect_entities({
+          text: message,
+          language_code: language
+        }).entities
+      rescue Aws::Comprehend::Errors::ServiceError => e
+        Stealth::Logger.l(topic: "AWS::Comprehend", message: e.message)
+        return []
+      end
+    end
+
+    def self.detect_key_phrases(message:, language: 'en')
+      begin
+        client.detect_key_phrases({
+          text: message,
+          language_code: language
+        }).key_phrases
+      rescue Aws::Comprehend::Errors::ServiceError
+        Stealth::Logger.l(topic: "AWS::Comprehend", message: e.message)
+        return []
+      end
+    end
+
+    def self.detect_sentiment(message:, language: 'en')
+      begin
+        client.detect_sentiment({
+          text: message,
+          language_code: language
+        })
+      rescue Aws::Comprehend::Errors::ServiceError
+        Stealth::Logger.l(topic: "AWS::Comprehend", message: e.message)
+        return []
+      end
+    end
+
+  end
+end

data/lib/stealth-aws-comprehend/nlp.rb

@@ -0,0 +1,55 @@
+module Stealth
+  class ServiceMessage
+
+    def language
+      @language ||= begin
+        if message.present?
+          Stealth::AwsComprehend.detect_dominate_language(
+            message: message
+          )
+        end
+      end
+    end
+
+    def entities
+      @entities ||= begin
+        if message.present?
+          Stealth::AwsComprehend.detect_entities(
+            message: message
+          )
+        end
+      end
+    end
+
+    def key_phrases
+      @key_phrases ||= begin
+        if message.present?
+          Stealth::AwsComprehend.detect_key_phrases(
+            message: message
+          )
+        end
+      end
+    end
+
+    def sentiment_score
+      get_sentiment.sentiment_score
+    end
+
+    def sentiment
+      get_sentiment.sentiment
+    end
+
+    private
+
+      def get_sentiment
+        @sentiment ||= begin
+          if message.present?
+            Stealth::AwsComprehend.detect_sentiment(
+              message: message
+            )
+          end
+        end
+      end
+
+  end
+end

data/lib/stealth-aws-comprehend.rb

@@ -0,0 +1,3 @@
+require 'aws-sdk-comprehend'
+require 'stealth-aws-comprehend/client'
+require 'stealth-aws-comprehend/nlp'

data/spec/spec_helper.rb

@@ -0,0 +1,84 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'stealth-aws-comprehend'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/stealth-aws-comprehend.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name        = 'stealth-aws-comprehend'
+  s.version     = '0.9.0'
+  s.date        = '2018-04-26'
+  s.summary     = "Stealth AWS Comprehend"
+  s.description = "Built-in NLP for Stealth bots via AWS Comprehend."
+  s.authors     = ["Mauricio Gomes"]
+  s.email       = 'mauricio@edge14.com'
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    = 'http://github.com/hellostealth/stealth-aws-comprehend'
+  s.license     = 'MIT'
+
+  s.add_dependency 'stealth', '< 2.0'
+  s.add_dependency 'aws-sdk-comprehend', '~> 1.0'
+
+  s.add_development_dependency "rspec", "3.6.0"
+
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: stealth-aws-comprehend
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Mauricio Gomes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: stealth
+  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: aws-sdk-comprehend
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+description: Built-in NLP for Stealth bots via AWS Comprehend.
+email: mauricio@edge14.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/stealth-aws-comprehend.rb
+- lib/stealth-aws-comprehend/client.rb
+- lib/stealth-aws-comprehend/nlp.rb
+- spec/spec_helper.rb
+- stealth-aws-comprehend.gemspec
+homepage: http://github.com/hellostealth/stealth-aws-comprehend
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Stealth AWS Comprehend
+test_files: []