sentiment_tracker 0.1.0alpha → 1.0.0beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3490ea1586eecfb700a24a3b446f9fc81916c832404923a0a452f787d47d9523
-  data.tar.gz: 840249ab2615a4fcb7051e285a03a9e991e6dc9dd27cabedf473be7e345f3c07
+  metadata.gz: d48182658fe6b71819eab46c09e16424a1868a218d1146eebc076d9ae8901210
+  data.tar.gz: 104635c21bbec583f7d6adde43731ffd56c5b29841b4ea9cd4a6825a216851f9
 SHA512:
-  metadata.gz: c8823315e1f0b0bbf572a37e0acfdc18a1cf92bdf2fc98d76b407b857a9dced7cbd3f8bf7713b49565caf19f0b77325d5d22010cfffe96d2d59d8aeda06ac6aa
-  data.tar.gz: 82dd8fe7881a5c39ca9df343cef23e4596e4929390a19afcc14d97bb8ec936cf53035c1e044e4c4fd2fa29912504088aa036eceda3f8c31a5043d597922bd443
+  metadata.gz: 2fbe16c776a2291e1fa2ceebd4233ac223c56f1fc56a44658f55b99f87d82ab311bba1319277872f5d60984b04a5f70511dfedf5e1791644607b3f45c7caebda
+  data.tar.gz: 653a0e074574140c5235914eb93027bf7029b63e2e30e2e51398d709a7853a2ec3b33fb83cb4b9f0d5a13aad1a14042d67cfa628dd0e3987d1bf783e42c90bc4

data/README.md

@@ -4,10 +4,6 @@ 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:
@@ -40,6 +36,33 @@ Then:
 $ rails db:migrate
 ```
 
+## Usage
+
+SentimentTracker is a plugin Rails for keep track of sentiment analysis process. It contains a control that process the data given throught SentimentTracker::Service. Ones the data is processed the service will create a tracks about all the responces.
+
+The service use [sentiment-al](https://github.com/armando1339/sentiment-al) gem to execute the Sentiment Analysis .
+
+A control is available to track the process about the texts. To access the routes call the #sentiment_tracker method into the route file.
+
+```ruby
+# call method #sentiment_tracker:
+# config/routes.rb
+
+Rails.application.routes.draw do
+
+  sentiment_tracker
+end
+
+```
+
+Check routes.
+
+```bach
+rails routes
+```
+
+More information about the routes and request structure visit [Postman](https://documenter.getpostman.com/view/2691667/TVRn3Sen) documentation.
+
 ## Contributing
 
 Bug report or pull request are welcome.

data/lib/sentiment_tracker.rb

@@ -1,11 +1,15 @@
 require "sentiment_tracker/railtie"
+require "jbuilder"
 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_relative 'sentiment_tracker/controllers/sentiment_base_controller'
+require_relative 'sentiment_tracker/controllers/texts_controller'
 
 require 'sentiment_tracker/strategies/prepare_params'
 require 'sentiment_tracker/strategies/process_sentiment'
 require 'sentiment_tracker/service'
+require 'sentiment_tracker/routing'

data/lib/sentiment_tracker/controllers/sentiment_base_controller.rb

@@ -0,0 +1,49 @@
+class SentimentBaseController < ActionController::Base
+  protect_from_forgery with: :null_session
+  before_action :set_jbuilder
+
+  def build_index_json(instances)
+    json_builder.texts do
+      json_builder.array! instances do |text|
+        build_partial_json(text)
+      end
+    end
+  end
+
+  def build_show_json(instance)
+    json_builder.text do
+      build_partial_json(instance)
+    end
+  end
+
+  def build_partial_json(instance)
+    json_builder.call(
+      instance,
+      :id,
+      :description,
+      :created_at,
+      :updated_at,
+      :sentiment
+    )
+
+    json_builder.sentences do
+      json_builder.array! instance.sentences do |sentence|
+        json_builder.call(
+          sentence,
+          :id,
+          :description,
+          :created_at,
+          :updated_at,
+          :sentiment
+        )
+      end
+    end
+  end
+
+  private
+
+  def set_jbuilder
+    self.class.send(:attr_accessor, :json_builder)
+    instance_variable_set(:@json_builder, Jbuilder.new)
+  end
+end

data/lib/sentiment_tracker/controllers/texts_controller.rb

@@ -0,0 +1,38 @@
+class TextsController < SentimentBaseController
+  before_action :set_text, only: %i(show update destroy)
+
+  def index
+    render json: build_index_json(Text.includes(:sentences, :sentiment).all), status: :ok
+  end
+
+  def show
+    render json: build_show_json(@text), status: :ok
+  end
+
+  def create
+    service = SentimentTracker::Service.call params: params
+    
+    if service.success?
+      render(
+        json: build_index_json(service.processed_texts),
+        status: :ok
+      )
+    end
+  end
+
+  def destroy
+    @text.destroy
+  end
+
+  private
+
+  def set_text
+    @text = Text.includes(:sentences, :sentiment).find params.fetch(:id)
+  rescue ActiveRecord::RecordNotFound
+    head :not_found
+  end
+
+  def text_params
+    params.permit data_processable: [:description]
+  end
+end

data/lib/sentiment_tracker/models/text.rb

@@ -3,7 +3,7 @@ class Text < ActiveRecord::Base
   # => Associations
   belongs_to :entity, polymorphic: true, optional: true
   has_one :sentiment, as: :entity, dependent: :destroy
-  has_many :sentences, dependent: :destroy
+  has_many :sentences, -> { includes(:sentiment) }, dependent: :destroy
 
   # => Callbacks
   after_create :exec_sentiment_analysis

data/lib/sentiment_tracker/routing.rb

@@ -0,0 +1,20 @@
+module ActionDispatch::Routing
+  class Mapper
+
+    # => Inserting routes
+    #
+    # Example: 
+    #
+    # sentiment_tracker do
+    #   resources :texts
+    # end
+    #
+    def sentiment_tracker
+      scope :rails, defaults: { format: :json } do
+        scope :sentiment_tracker do
+          scope(:operations){ resources :texts }
+        end
+      end
+    end
+  end
+end

data/lib/sentiment_tracker/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sentiment_tracker
 version: !ruby/object:Gem::Version
-  version: 0.1.0alpha
+  version: 1.0.0beta
 platform: ruby
 authors:
 - Armando Alejandre
@@ -30,6 +30,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.3.4
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.10.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.10.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -141,10 +161,13 @@ files:
 - lib/generators/sentiment_tracker_generator.rb
 - lib/generators/templates/migration.rb
 - lib/sentiment_tracker.rb
+- lib/sentiment_tracker/controllers/sentiment_base_controller.rb
+- lib/sentiment_tracker/controllers/texts_controller.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/routing.rb
 - lib/sentiment_tracker/service.rb
 - lib/sentiment_tracker/strategies/prepare_params.rb
 - lib/sentiment_tracker/strategies/process_sentiment.rb