sentiment_tracker 0.1.0alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3490ea1586eecfb700a24a3b446f9fc81916c832404923a0a452f787d47d9523
+  data.tar.gz: 840249ab2615a4fcb7051e285a03a9e991e6dc9dd27cabedf473be7e345f3c07
+SHA512:
+  metadata.gz: c8823315e1f0b0bbf572a37e0acfdc18a1cf92bdf2fc98d76b407b857a9dced7cbd3f8bf7713b49565caf19f0b77325d5d22010cfffe96d2d59d8aeda06ac6aa
+  data.tar.gz: 82dd8fe7881a5c39ca9df343cef23e4596e4929390a19afcc14d97bb8ec936cf53035c1e044e4c4fd2fa29912504088aa036eceda3f8c31a5043d597922bd443

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 
+
+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,59 @@
+# SentimentTracker
+
+SentimentTracker is a plugin Rails for keep track of sentiment analysis process.
+
+[![Build Status](https://travis-ci.org/armando1339/sentiment_tracker.svg?branch=master)](https://travis-ci.org/armando1339/sentiment_tracker) [![Coverage Status](https://coveralls.io/repos/github/armando1339/sentiment_tracker/badge.svg?branch=master)](https://coveralls.io/github/armando1339/sentiment_tracker?branch=master)
+
+## Usage
+
+How to use my plugin.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sentiment_tracker'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install sentiment_tracker
+```
+
+Ones installed, generate migrations:
+
+```bash
+$ rails generate sentiment_tracker
+```
+
+Then:
+
+```bash
+$ rails db:migrate
+```
+
+## Contributing
+
+Bug report or pull request are welcome.
+
+Make a pull request:
+
+- Clone the repo
+- Create your feature branch
+- Commit your changes
+- Push the branch
+- Create PR
+
+Please write tests if necessary.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,21 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SentimentTracker'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/generators/sentiment_tracker_generator.rb

@@ -0,0 +1,25 @@
+class SentimentTrackerGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('templates', __dir__)
+
+  def migration
+    migration_template(
+      'migration.rb',
+      'db/migrate/create_sentiment_tracker.rb'
+    )
+  end
+
+  def rails5_and_up?
+    Rails::VERSION::MAJOR >= 5
+  end
+
+  def migration_version
+    if rails5_and_up?
+      "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+    end
+  end
+
+  def self.next_migration_number(dir)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,22 @@
+class CreateSentimentTracker < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :texts do |t|
+      t.string :description
+      t.references :entity, polymorphic: true, index: true
+      t.timestamps
+    end
+
+    create_table :sentences do |t|
+      t.string :description
+      t.references :text, foreign_key: true, index: true
+      t.timestamps
+    end
+
+    create_table :sentiments do |t|
+      t.string :polarity
+      t.string :kind
+      t.references :entity, polymorphic: true, index: true
+      t.timestamps
+    end
+  end
+end

data/lib/sentiment_tracker.rb

@@ -0,0 +1,11 @@
+require "sentiment_tracker/railtie"
+require "light-service"
+require "sentiment_al"
+
+require_relative 'sentiment_tracker/models/text'
+require_relative 'sentiment_tracker/models/sentence'
+require_relative 'sentiment_tracker/models/sentiment'
+
+require 'sentiment_tracker/strategies/prepare_params'
+require 'sentiment_tracker/strategies/process_sentiment'
+require 'sentiment_tracker/service'

data/lib/sentiment_tracker/models/sentence.rb

@@ -0,0 +1,12 @@
+class Sentence < ActiveRecord::Base
+
+  # => Associations
+  belongs_to :text, touch: true
+  has_one :sentiment, as: :entity, dependent: :destroy
+
+  # => Validations
+  validates_presence_of :description
+
+  # => Nested
+  accepts_nested_attributes_for :sentiment
+end

data/lib/sentiment_tracker/models/sentiment.rb

@@ -0,0 +1,8 @@
+class Sentiment < ActiveRecord::Base
+
+  # => Associations
+  belongs_to :entity, polymorphic: true
+
+  # => Validations
+  validates_presence_of :polarity, :kind
+end

data/lib/sentiment_tracker/models/text.rb

@@ -0,0 +1,59 @@
+class Text < ActiveRecord::Base
+
+  # => Associations
+  belongs_to :entity, polymorphic: true, optional: true
+  has_one :sentiment, as: :entity, dependent: :destroy
+  has_many :sentences, dependent: :destroy
+
+  # => Callbacks
+  after_create :exec_sentiment_analysis
+
+  # => Validations
+  validates_presence_of :description
+
+  # => Nested
+  accepts_nested_attributes_for :sentences, :sentiment
+
+  # => Execute the request to SENTIM-API
+  # and process the responces creating
+  # some trackeable data
+  #
+  def exec_sentiment_analysis
+    sentiment_al.call text: description
+
+    create_tracking! if sentiment_al.successfully?
+  end
+
+  private
+
+  # => *
+  def create_tracking!
+    update(
+      sentences_attributes: build_track_params,
+      sentiment_attributes: build_result_params
+    )
+  end
+
+  # => *
+  def build_track_params
+    sentiment_al.response_to_hash.fetch('sentences').each do |sentence|
+      sentence.transform_keys!{ |key| keys_map[key] }
+      sentence.fetch('sentiment_attributes').transform_keys!{ |key| keys_map[key] }
+    end
+  end
+
+  # => *
+  def build_result_params
+    sentiment_al.response_to_hash.fetch('result').transform_keys!{ |key| keys_map[key] }
+  end
+
+  # => *
+  def keys_map
+    {
+      'sentence' => 'description',
+      'sentiment' => 'sentiment_attributes',
+      'type' => 'kind',
+      'polarity' => 'polarity'
+    }
+  end
+end

data/lib/sentiment_tracker/railtie.rb

@@ -0,0 +1,4 @@
+module SentimentTracker
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/sentiment_tracker/service.rb

@@ -0,0 +1,14 @@
+module SentimentTracker
+  class Service
+    extend LightService::Organizer
+
+    def self.call(args = {})
+      with(args).reduce(
+        [
+          SentimentTracker::PrepareParams,
+          SentimentTracker::ProcessSentiment
+        ]
+      )
+    end
+  end
+end

data/lib/sentiment_tracker/strategies/prepare_params.rb

@@ -0,0 +1,14 @@
+module SentimentTracker
+  class PrepareParams
+    extend LightService::Action
+    expects :params
+
+    executed do |context|
+      unless context.params.kind_of? ActionController::Parameters
+        context.params = ActionController::Parameters.new context.params
+      end
+
+      context.params = context.params.permit(data_processable: [:description])
+    end
+  end
+end

data/lib/sentiment_tracker/strategies/process_sentiment.rb

@@ -0,0 +1,11 @@
+module SentimentTracker
+  class ProcessSentiment
+    extend LightService::Action
+    expects :params
+    promises :processed_texts
+
+    executed do |context|
+      context.processed_texts = Text.create context.params.fetch('data_processable')
+    end
+  end
+end

data/lib/sentiment_tracker/version.rb

@@ -0,0 +1,3 @@
+module SentimentTracker
+  VERSION = '0.1.0alpha'
+end

data/lib/tasks/sentiment_tracker_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :sentiment_tracker do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: sentiment_tracker
+version: !ruby/object:Gem::Version
+  version: 0.1.0alpha
+platform: ruby
+authors:
+- Armando Alejandre
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: pg
+  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-rails
+  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: shoulda-matchers
+  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: shoulda-callback-matchers
+  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: coveralls
+  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: pry-rails
+  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'
+description: Plugin Rails for keep track of sentiment analysis process
+email:
+- armando1339@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/sentiment_tracker_generator.rb
+- lib/generators/templates/migration.rb
+- lib/sentiment_tracker.rb
+- lib/sentiment_tracker/models/sentence.rb
+- lib/sentiment_tracker/models/sentiment.rb
+- lib/sentiment_tracker/models/text.rb
+- lib/sentiment_tracker/railtie.rb
+- lib/sentiment_tracker/service.rb
+- lib/sentiment_tracker/strategies/prepare_params.rb
+- lib/sentiment_tracker/strategies/process_sentiment.rb
+- lib/sentiment_tracker/version.rb
+- lib/tasks/sentiment_tracker_tasks.rake
+homepage: https://github.com/armando1339
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+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: 1.3.1
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: SentimentTracker is a plugin Rails for keep track of sentiment analysis process.
+test_files: []