nexaas-async-collector 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 171dcf42099cb98d18b2492a2a3cb499e95d99cc
+  data.tar.gz: f361911c8d5751a9df609c457c9c4c44758c16e6
+SHA512:
+  metadata.gz: 4a12a3ddd8ce4ea14d1669990a09976bae771eb45fd0106adf6308eccb80836bde722be0c3feea978d81c63d7e0680d9ef6565f802b1488c96e4dbf1dbfb305a
+  data.tar.gz: dfea2bb81b8ada2ef1c290b85b46261aecc955a4d1dfab2ce8f18876274831a0d7f2dbed1f156d36d0be937c788bf5aa299ae0d6e917cc158b1bdb1ab8ff1bf3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Eduardo Hertz
+
+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,72 @@
+# Nexaas::Async::Collector
+Agnostic collector and generator of async content for Rails apps. Used in production in a few [Nexaas](www.nexaas.com) systems.
+
+This gems is compatible with Ruby 2.1+ and Rails 3.2+.
+
+## Prerequisites
+The prerequisites of this project are:
+  - Sidekiq 4+
+  - Redis
+  - JQuery 1.0+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nexaas-async-collector'
+```
+
+And then run:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install nexaas-async-collector
+```
+
+## Usage
+1) Create the file `config/initializers/nexaas-async-collector.rb` with the following content (edit as you need):
+
+```ruby
+  Nexaas::Async::Collector.configure do |config|
+    # Your redis URL. The default value will be the value of yout REDIS_URL env var
+    config.redis_url = "redis://test.local"
+
+    # The namespace where you want to store you data within Redis
+    config.redis_namespace = 'nexaas_async'
+
+    # The method that returns the use robject (or anyother object you want. It must respond to id method)
+    config.scope = :current_user
+
+    # The parent class of all nexaas-async-collector controller
+    config.parent_controller = "::ActionController::Base"
+  end
+```
+
+2) Use the view helper to do all the process:
+
+```ruby
+<%= nexaas_async_collector(user.id, ModelService, :model_method, [arg1, arg2]) %>
+```
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at [https://github.com/myfreecomm/nexaas-async-collector](https://github.com/myfreecomm/nexaas-async-collector). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
+
+After downloading the project and install all gems (through `bundler`) don't forget to install appraisal gems dependencies:
+
+```
+$ appraisal install
+```
+
+This is necessary to test the code in different versions of Ruby and Rails. To run the full suite of tests:
+
+```
+$ bundle exec rake spec
+```
+
+## 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,25 @@
+require "rubygems"
+require "bundler/setup"
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+namespace :spec do
+  task :all do
+    system('appraisal rake spec')
+  end
+end
+

data/app/controllers/nexaas/async/collector/application_controller.rb

@@ -0,0 +1,9 @@
+module Nexaas
+  module Async
+    module Collector
+      class ApplicationController < Nexaas::Async::Collector.configuration.parent_controller.constantize
+        protect_from_forgery with: :exception
+      end
+    end
+  end
+end

data/app/controllers/nexaas/async/collector/async_resource_controller.rb

@@ -0,0 +1,22 @@
+module Nexaas
+  module Async
+    module Collector
+      class AsyncResourceController < ApplicationController
+        def show
+          @result = Result.new(collector_scope.id, params[:id])
+          respond_to { |f| f.js }
+        end
+
+        private
+
+        def nexaas_async_collector_scope
+          Nexaas::Async::Collector.configuration.scope
+        end
+
+        def collector_scope
+          send(nexaas_async_collector_scope)
+        end
+      end
+    end
+  end
+end

data/app/helpers/nexaas/async/collector/application_helper.rb

@@ -0,0 +1,29 @@
+module Nexaas
+  module Async
+    module Collector
+      module ApplicationHelper
+        #
+        # Helper to enqueue AsyncResourceJob and include the JavaScript code to request the result
+        # - user_id: an ID that is unique for each logged user (maybe user.id, account.id, organization.id, etc)
+        # - klass_name: The name of the class responsible for generate the content to be stored in the memory
+        # - klass_method: The name of the class method to be called
+        # - args: The arguments to be passed in the call of the class method
+        #
+        # Example:
+        # <%= nexaas_async_collect(current_user.id, ReportGenerator, :generate, []) %>
+        #
+        def nexaas_async_collect(user_id, klass_name, klass_method, args=[])
+          AsyncResourceJob.perform_async(collector_user_id, user_id, klass_name, klass_method, args)
+          render(partial: 'nexaas/async/collector/async_resource/show')
+        end
+
+        private
+
+        def collector_user_id
+          @collector_user_id ||= SecureRandom.hex(15)
+        end
+
+      end
+    end
+  end
+end

data/app/views/nexaas/async/collector/async_resource/_loading.html.erb

@@ -0,0 +1,13 @@
+<style type="text/css">
+  .nexaas-async-collector-loading img {
+    vertical-align: middle;
+  }
+
+  .nexaas-async-collector-loading {
+    text-align: center;
+  }
+</style>
+
+<div class="nexaas-async-collector-loading">
+  <%= image_tag 'nexaas/async/collector/spin.svg' %> <%= I18n.t('nexaas.async.collector.loading') %>
+</div>

data/app/views/nexaas/async/collector/async_resource/_show.html.erb

@@ -0,0 +1,12 @@
+<script type="text/javascript" id="js-nexaas-async-collector">
+  var requestContent = function() {
+    $.ajax({
+      url: '<%= Rails.application.routes.url_helpers.nexaas_async_collect_path(@collector_user_id) %>',
+      dataType: 'script'
+    })
+  }
+
+  window.nexaas_async_interval = setInterval(requestContent, 3000);
+</script>
+
+<%= render partial: "nexaas/async/collector/async_resource/loading" %>

data/app/views/nexaas/async/collector/async_resource/show.js.erb

@@ -0,0 +1,5 @@
+<% if @result.content_is_ready? %>
+  $('#js-nexaas-async-collector').parent().append("<%= escape_javascript(@result.content.html_safe) %>");
+  $('.nexaas-async-collector-loading').remove();
+  clearInterval(window.nexaas_async_interval);
+<% end %>

data/app/workers/nexaas/async/collector/async_resource_job.rb

@@ -0,0 +1,26 @@
+module Nexaas
+  module Async
+    module Collector
+      class AsyncResourceJob
+
+        include Sidekiq::Worker
+        sidekiq_options queue: :high_fast
+
+        def perform(collector_id, user_id, klass_name, klass_method, args=[])
+          content = call_for_method(klass_name, klass_method, args)
+          Persist.save(user_id, collector_id, content)
+        end
+
+        private
+
+        def call_for_method(klass_name, klass_method, args=[])
+          if args.any?
+            klass_name.to_s.constantize.send(klass_method, *args)
+          else
+            klass_name.to_s.constantize.send(klass_method)
+          end
+        end
+      end
+    end
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  nexaas:
+    async:
+      collector:
+        loading: 'Loading...'

data/config/locales/pt.yml

@@ -0,0 +1,5 @@
+pt:
+  nexaas:
+    async:
+      collector:
+        loading: 'Carregando...'

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  get 'nexaas/async/collect/:id' => 'nexaas/async/collector/async_resource#show', as: :nexaas_async_collect
+end

data/lib/nexaas/async/collector.rb

@@ -0,0 +1,23 @@
+require 'redis-namespace'
+require 'sidekiq'
+require "nexaas/async/collector/engine"
+require "nexaas/async/collector/configuration"
+require "nexaas/async/collector/in_memory_storage"
+require "nexaas/async/collector/result"
+require "nexaas/async/collector/persist"
+
+module Nexaas
+  module Async
+    module Collector
+      class << self
+        def configure
+          yield(configuration)
+        end
+
+        def configuration
+          @configuration ||= Configuration.new
+        end
+      end
+    end
+  end
+end

data/lib/nexaas/async/collector/configuration.rb

@@ -0,0 +1,16 @@
+module Nexaas
+  module Async
+    module Collector
+      class Configuration
+        attr_accessor :redis_url, :redis_namespace, :scope, :parent_controller
+
+        def initialize
+          @redis_url = ENV.fetch('REDIS_URL') { nil }
+          @redis_namespace = 'nexaas_async'
+          @scope = :current_user
+          @parent_controller = '::ActionController::Base'
+        end
+      end
+    end
+  end
+end

data/lib/nexaas/async/collector/engine.rb

@@ -0,0 +1,17 @@
+module Nexaas
+  module Async
+    module Collector
+      class Engine < ::Rails::Engine
+        initializer 'Nexaas::Async::Collector precompile hook', group: :all do |app|
+          app.config.assets.precompile += %w(
+            nexaas/async/collector/spin.svg
+          )
+        end
+
+        config.generators do |g|
+          g.test_framework :rspec
+        end
+      end
+    end
+  end
+end

data/lib/nexaas/async/collector/in_memory_storage.rb

@@ -0,0 +1,39 @@
+module Nexaas
+  module Async
+    module Collector
+      class InMemoryStorage
+
+        attr_reader :connection, :namespace
+
+        def initialize
+          @connection ||= Redis.new(url: redis_url)
+          @namespace ||= Redis::Namespace.new(redis_namespace, redis: connection) if redis_namespace
+        end
+
+        def get(key)
+          storage.get(key)
+        end
+
+        def set(key, value, expiration=nil)
+          storage.set(key, value)
+          storage.expire(key, expiration) if expiration
+        end
+
+        private
+
+        def storage
+          @namespace || @connection
+        end
+
+        def redis_url
+          Nexaas::Async::Collector.configuration.redis_url
+        end
+
+        def redis_namespace
+          Nexaas::Async::Collector.configuration.redis_namespace
+        end
+
+      end
+    end
+  end
+end

data/lib/nexaas/async/collector/persist.rb

@@ -0,0 +1,26 @@
+module Nexaas
+  module Async
+    module Collector
+      class Persist
+        class << self
+          def save(user_id, key, value)
+            storage.set(key, content(user_id, value))
+          end
+
+          def content(user_id, value)
+            {
+              'user_id' => user_id,
+              'content' => value
+            }.to_json
+          end
+
+          private
+
+          def storage
+            InMemoryStorage.new
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nexaas/async/collector/result.rb

@@ -0,0 +1,52 @@
+# Content is stored in the database as the following JSON:
+# {
+#   'user_id' => 'user_id',
+#   'content' => 'generated content'
+# }
+# The content is scoped by user, so any other user who discover the key (id) of the content, will not be able
+# to access only. Only the user who created it.
+# Maybe leave this more generic?
+
+module Nexaas
+  module Async
+    module Collector
+      class Result
+
+        attr_reader :user_id, :id, :content
+
+        def initialize(user_id, id)
+          @user_id = user_id
+          @id = id
+        end
+
+        def content
+          _content['content'] if content_is_ready?
+        end
+
+        def content_is_ready?
+          _content && _content['user_id'] == user_id && _content['content']
+        end
+
+        private
+
+        def storage
+          @storage ||= InMemoryStorage.new
+        end
+
+        def _content
+          @_content ||= storage.get(id)
+          @content ||= JSON.parse(@_content) if @_content
+        end
+
+        def url
+          Nexaas::Async::Collector.configuration.redis_url
+        end
+
+        def namespace
+          Nexaas::Async::Collector.configuration.redis_namespace
+        end
+
+      end
+    end
+  end
+end

data/lib/nexaas/async/collector/version.rb

@@ -0,0 +1,7 @@
+module Nexaas
+  module Async
+    module Collector
+      VERSION = '1.0.0'
+    end
+  end
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: nexaas-async-collector
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Eduardo Hertz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !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
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: fakeredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 9.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 9.0.6
+description: Agnostic collector and generator of async content for Rails apps.
+email:
+- eduardohertz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/nexaas/async/collector/application_controller.rb
+- app/controllers/nexaas/async/collector/async_resource_controller.rb
+- app/helpers/nexaas/async/collector/application_helper.rb
+- app/views/nexaas/async/collector/async_resource/_loading.html.erb
+- app/views/nexaas/async/collector/async_resource/_show.html.erb
+- app/views/nexaas/async/collector/async_resource/show.js.erb
+- app/workers/nexaas/async/collector/async_resource_job.rb
+- config/locales/en.yml
+- config/locales/pt.yml
+- config/routes.rb
+- lib/nexaas/async/collector.rb
+- lib/nexaas/async/collector/configuration.rb
+- lib/nexaas/async/collector/engine.rb
+- lib/nexaas/async/collector/in_memory_storage.rb
+- lib/nexaas/async/collector/persist.rb
+- lib/nexaas/async/collector/result.rb
+- lib/nexaas/async/collector/version.rb
+homepage: https://github.com/myfreecomm/nexaas-async-collector
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Collect and generate async content.
+test_files: []