nexaas-async-collector 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6f7dddb4c3f1de985620fc046e55ad5abe09d4d
-  data.tar.gz: 4acb3b3d95a33a71139362f9b9b325e1c068e0be
+  metadata.gz: a17f015b0f574c0e61e461f95cbaac500bdd44a9
+  data.tar.gz: a8792061a11ac481b44b8ee714a078e017825a5d
 SHA512:
-  metadata.gz: 706fe8b5a088ad6d737dbc1016c718ab4ae6368a772c5a7f728a4b19bba84f4f70960d457dfbd579bef90a0b0247cacfba88cb6c9bc73b1fc29c63296eb68cd7
-  data.tar.gz: fed0df22ab89639ee90ca666bffa506f2395be4c5cf7dc7b99d4d00a44ab05953465d2749e3ab1ed07b9dc7fa6257873f8c31a1e2d83270464cb6f3a2cdea31c
+  metadata.gz: d738e244744e6dad3df385e4d65ac7afa22a0385a3e371f9a4b8ebd274d032d8d3cec8c8c757c9abb31df5e12a0f40beba72fa4df5a5d373b1916107c0c58b69
+  data.tar.gz: d489fe21546f871855abc3335f9517cc91babfbec766380633cce782798322c17fbf8dc01e08ee737038b766bca404de51df1da9d5472127bb0370d38126a7db

data/README.md

@@ -53,6 +53,9 @@ $ gem install nexaas-async-collector
 
     # The parent class of all nexaas-async-collector controller
     config.parent_controller = "::ActionController::Base"
+
+    # The expiration of the data in seconds
+    config.expiration = 600
   end
 ```
 
@@ -74,7 +77,8 @@ end
   class_name: ModelService, # (required) name of the class
   class_method: :model_method, # (required) name of the class method responsible to generate data
   args: [arg1, arg2], # (optional) arguments to be passed to class method
-  instrumentation_context: 'my.custom.instrumentation' # (optional) context of the instrumentation name. It will generate two instrumentation: 'my.custom.instrumentation.start' and 'my.custom.instrumentation.finish'
+  instrumentation_context: 'my.custom.instrumentation', # (optional) context of the instrumentation name. It will generate two instrumentation: 'my.custom.instrumentation.start' and 'my.custom.instrumentation.finish'
+  expiration: 180 # (optional) this local expiration will overwrite global expiration for this particular data generation
 }) %>
 ```
 
@@ -100,6 +104,10 @@ If you want to export something to `xls` file, for example:
 
 This will generate the spinner and it will redirect the user to download the file when it is ready.
 
+## Redis configuration
+
+If you are sharing your Redis server between important information (e.g., Sidekiq data) and temporary information (e.g., `nexaas-async-collector` data), we suggest you to set the [`maxmemory-policy` eviction policy in Redis](https://redis.io/topics/lru-cache) to `volatile-lru` or `volatile-ttl`.
+
 ## 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.
 

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

@@ -6,7 +6,7 @@
     window.location.href = '<%= async_resource_path(params[:id], format: @result.extension) %>';
   <% else %>
     $('#js-nexaas-async-collector-loading-<%= @unique_id %>').remove();
-    $('#js-nexaas-async-collector-<%= @unique_id %>').parent().append("<%= escape_javascript(@result.content.html_safe) %>");
+    $('#js-nexaas-async-collector-<%= @unique_id %>').parent().append("<%= escape_javascript(@result.content.force_encoding('UTF-8').html_safe) %>");
     $('#js-nexaas-async-collector-<%= @unique_id %>').remove()
     $('#js-nexaas-async-collector-style-<%= @unique_id %>').remove()
   <% end %>

data/lib/nexaas/async/collector.rb

@@ -1,6 +1,6 @@
 require 'sidekiq'
 require "nexaas/async/collector/engine"
-require "nexaas/async/collector/in_memory_storage"
+require "nexaas/async/collector/storage"
 require "nexaas/async/collector/result"
 require "nexaas/async/collector/persist"
 
@@ -32,6 +32,10 @@ module Nexaas
       mattr_accessor :parent_controller
       @@parent_controller = '::ActionController::Base'
 
+      # Sets expiration (in seconds) for content in database
+      mattr_accessor :expiration
+      @@expiration = 600 # 10 minutes
+
       def self.configure
         yield self
       end

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

@@ -2,27 +2,35 @@ module Nexaas
   module Async
     module Collector
       class Persist
-        class << self
-          def save(opts={})
-            opts = opts.with_indifferent_access
-            content = content_in_json(opts)
-            storage.set(opts[:collect_id], content)
-          end
 
-          private
+        attr_reader :opts, :storage
 
-          def content_in_json(opts)
-            {
-              'scope_id' => opts[:scope_id],
-              'content' => (opts[:content] ? Base64.encode64(opts[:content].to_s) : nil),
-              'file' => opts[:file]
-            }.to_json
-          end
+        def initialize(opts={})
+          @opts = opts.with_indifferent_access
+          @storage = Storage.new
+        end
+
+        def self.save(opts={})
+          new(opts).save
+        end
 
+        def save
+          content = content_in_json(opts)
+          storage.set(opts[:collect_id], content, expiration)
+        end
+
+        private
+
+        def content_in_json(opts)
+          {
+            'scope_id' => opts[:scope_id],
+            'content' => (opts[:content] ? Base64.encode64(opts[:content].to_s) : nil),
+            'file' => opts[:file]
+          }.to_json
+        end
 
-          def storage
-            InMemoryStorage.new
-          end
+        def expiration
+          opts[:expiration] || Nexaas::Async::Collector.expiration
         end
       end
     end

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

@@ -11,11 +11,12 @@ module Nexaas
     module Collector
       class Result
 
-        attr_reader :scope_id, :id, :object
+        attr_reader :scope_id, :id, :object, :storage
 
         def initialize(scope_id, id)
           @scope_id = scope_id
           @id = id
+          @storage = Storage.new
         end
 
         def content
@@ -44,10 +45,6 @@ module Nexaas
 
         private
 
-        def storage
-          @storage ||= InMemoryStorage.new
-        end
-
         def object
           return @object if @object
           @_object = storage.get(id)

data/lib/nexaas/async/collector/{in_memory_storage.rb → storage.rb}

@@ -1,7 +1,7 @@
 module Nexaas
   module Async
     module Collector
-      class InMemoryStorage
+      class Storage
 
         def get(key)
           Sidekiq.redis_pool.with do |connection|
@@ -9,11 +9,13 @@ module Nexaas
           end
         end
 
-        def set(key, value, expiration=nil)
+        def set(key, value, expiration)
           Sidekiq.redis_pool.with do |connection|
             key = namespaced_key(key)
-            connection.set(key, value)
-            connection.expire(key, expiration) if expiration
+            connection.multi do
+              connection.set(key, value)
+              connection.expire(key, expiration)
+            end
           end
         end
 

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

@@ -1,7 +1,7 @@
 module Nexaas
   module Async
     module Collector
-      VERSION = '3.2.0'
+      VERSION = '3.3.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexaas-async-collector
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Eduardo Hertz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-27 00:00:00.000000000 Z
+date: 2017-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -151,9 +151,9 @@ files:
 - config/routes.rb
 - lib/nexaas/async/collector.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/storage.rb
 - lib/nexaas/async/collector/version.rb
 homepage: https://github.com/myfreecomm/nexaas-async-collector
 licenses: