aws_detect_sentiment 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e60d0e3760cbb1b5f9363fdd7d0f7a6ff778a1d99104b0bb7271ac5d022cb8fe
+  data.tar.gz: 6b3e97e635bcd601a0a5f3113b10ac873cbcd4e25ee8b0c14fc60ac82bf4b1db
+SHA512:
+  metadata.gz: 0716a10136a64a6ef45e01eedcdb50a6797547b0d06e865cde84e4968dfa1ee787494f55452426d44ff75fa6f9d907ead9dcb053078d5d14f748ed9467c10f68
+  data.tar.gz: 10bcdfb2af32ebbd4dd831c9118dd47e3197984bbf3cb047991a0a7c8514addc6906ff7ab3cc74e0fd037045c14dc64b7163522882ea755c0acb0799d627b714

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Aleksey Strizhak
+
+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/lib/aws_detect_sentiment.rb

@@ -0,0 +1,8 @@
+require_relative "aws_detect_sentiment/version"
+require_relative "aws_detect_sentiment/configuration"
+require_relative "aws_detect_sentiment/aws_comprehend_client"
+require_relative "aws_detect_sentiment/assign"
+
+module AwsDetectSentiment
+  class Error < StandardError; end
+end

data/lib/aws_detect_sentiment/assign.rb

@@ -0,0 +1,34 @@
+module AwsDetectSentiment
+  class Assign
+    # @param scope [Array<::Object>]
+    # @param text_field [Symbol]
+    # @param api_client [Object]
+    def initialize(scope:, text_field:, api_client: AwsDetectSentiment::AwsComprehendClient.new)
+      self.scope = scope
+      self.text_field = text_field
+      self.api_client = api_client
+    end
+
+    def perform
+      records.each_with_index do |record, index|
+        yield(record, sentiments[index])
+      end
+    end
+
+    private
+
+    def records
+      scope.reject { |record| record.public_send(text_field).to_s.empty? }
+    end
+
+    attr_accessor :scope, :text_field, :api_client
+
+    def sentiments
+      @sentiments ||= api_client.detect_sentiments(texts)
+    end
+
+    def texts
+      scope.map { |record| record.public_send(text_field) }
+    end
+  end
+end

data/lib/aws_detect_sentiment/aws_comprehend_client.rb

@@ -0,0 +1,47 @@
+require "aws-sdk-comprehend"
+
+module AwsDetectSentiment
+  class AwsComprehendClient
+    BATCH_LIMIT = 25
+
+    def initialize
+      self.s3_client =
+        Aws::Comprehend::Client.new(
+          stub_responses: stub_enabled?,
+          region: AwsDetectSentiment.configuration.aws_region,
+          access_key_id: AwsDetectSentiment.configuration.aws_access_key_id,
+          secret_access_key: AwsDetectSentiment.configuration.aws_secret_access_key
+        )
+    end
+
+    def detect_sentiment(text, options: inner_options, stub_response: {})
+      s3_client.stub_responses(:detect_sentiment, stub_response) if stub_enabled?
+      sentiment(s3_client.detect_sentiment(text: text, **options))
+    end
+
+    def detect_sentiments(texts, batch_limit: BATCH_LIMIT, options: inner_options, stub_responses: [{}])
+      texts.each_slice(batch_limit).map.with_index do |texts_slice, index|
+        s3_client.stub_responses(:batch_detect_sentiment, stub_responses[index]) if stub_enabled?
+        s3_client.batch_detect_sentiment(text_list: texts_slice, **options).result_list
+      end.flatten.map(&method(:sentiment))
+    end
+
+    private
+
+    attr_accessor :s3_client
+
+    def sentiment(result)
+      result.sentiment.downcase
+    end
+
+    def inner_options
+      {
+        language_code: "en"
+      }
+    end
+
+    def stub_enabled?
+      AwsDetectSentiment.configuration.stub_client_requests
+    end
+  end
+end

data/lib/aws_detect_sentiment/configuration.rb

@@ -0,0 +1,13 @@
+require "ostruct"
+
+module AwsDetectSentiment
+  class << self
+    def configuration
+      @configuration ||= OpenStruct.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/lib/aws_detect_sentiment/version.rb

@@ -0,0 +1,3 @@
+module AwsDetectSentiment
+  VERSION = "0.1.0".freeze
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: aws_detect_sentiment
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aleksey Strizhak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-comprehend
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.48.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.48.0
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description: Provided Client-object to detect the sentiment of provided word/words
+  by Aws::Comprehend API
+email:
+- alexei.mifrill.strizhak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/aws_detect_sentiment.rb
+- lib/aws_detect_sentiment/assign.rb
+- lib/aws_detect_sentiment/aws_comprehend_client.rb
+- lib/aws_detect_sentiment/configuration.rb
+- lib/aws_detect_sentiment/version.rb
+homepage: https://github.com/Mifrill/aws_detect_sentiment.git
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Mifrill/aws_detect_sentiment.git
+  changelog_uri: https://github.com/Mifrill/aws_detect_sentiment/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key: 
+specification_version: 4
+summary: Detect sentiment by Aws::Comprehend::Client
+test_files: []