nexaas-async-collector 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee2109580d4539bc01aa2015e35fdb66a03a5e47
-  data.tar.gz: b36924123c2122b0fec86735195899cb0fa70b2c
+  metadata.gz: 22260bccd9579781a6b6ca2dadc82198a30cbb01
+  data.tar.gz: ddfe6e2396e4229904ff1f4084a498913813cd7c
 SHA512:
-  metadata.gz: 965dd0712b7f5d4e6cc82be1a1ccbf256a74a95253ab155759f8934e84d92fbcefea0fc673d23e98847330867b3ecf52f4a55a6ca3204c61beb449b783c76169
-  data.tar.gz: abbae053baa51b8313e474544a56bcfcdd448f98539244fb330ef7fb11de8121e9fa3d98ddd0ce809c6f5531dbacfeb3ae42d78de39a1d8a56e9c0e28c3343c3
+  metadata.gz: 9029f15e453e1c4ef0a53cbe2cfcd9a320376acb8761b7b4bedf9470abb529212b4403ba751fe5417bd7b90258a8bfbf96cdb06c6acdbb4fd11c19b03a205b4e
+  data.tar.gz: 1b03833b73d63e95f5988681cad00ec5035a3d5dac53ab7d2f8d60579502bae2667983d48856dfaf7211d15ef8a3cd57c37f6769d49831dcf5f163069b6f87c1

data/README.md

@@ -78,6 +78,28 @@ end
 }) %>
 ```
 
+### Download file
+
+Instead of rendering text or HTML, you can use `nexaas-async-collect` to generate files, so the user can download it.
+
+If you want to export something to `xls` file, for example:
+
+```ruby
+<%= nexaas_async_collect({
+  scope_id: scope.id, # (required)
+  class_name: ModelService, # (required)
+  class_method: :model_method, # (required)
+  args: [arg1, arg2], # (optional)
+  file: {
+    content_type: 'application/vnd.ms-excel', # (required) content type of the file
+    name: 'reports', # (required) name of the file
+    extension: 'xls' # (require) extension of the file
+  }
+}) %>
+```
+
+This will generate the spinner and it will redirect the user to download the file when it is ready.
+
 ## 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/controllers/nexaas/async/collector/async_resource_controller.rb

@@ -4,20 +4,29 @@ module Nexaas
   module Async
     module Collector
       class AsyncResourceController < ApplicationController
+
         def show
           @result = Result.new(collector_scope.id, params[:id])
           @unique_id = params[:unique_id]
-          respond_to { |f| f.js }
+          respond_to do |format|
+            render_for_request(format)
+          end
         end
 
         private
 
-        def nexaas_async_collector_scope
-          Nexaas::Async::Collector.scope
+        def render_for_request(format)
+          format.js { render :show }
+          format.all do
+            send_data(@result.content, {
+              filename: "#{@result.filename}.#{@result.extension}", type: @result.content_type,
+              disposition: 'attachment'
+            })
+          end
         end
 
         def collector_scope
-          send(nexaas_async_collector_scope)
+          send(Nexaas::Async::Collector.scope)
         end
       end
     end

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

@@ -2,21 +2,32 @@ module Nexaas
   module Async
     module Collector
       module ApplicationHelper
+
         #
         # Helper to enqueue AsyncResourceJob and include the JavaScript code to request the result
         # - scope_id: an ID that is unique (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
+        # - instrumentation_context: Custom context for instrumentatio with ActiveSupport::Notifications
+        # - file: Argument to pass file informations. This will be used to generated file for the user
+        #   - conten_type: Content type of the file
+        #   - name: Basename of the file to be generated
         #
         # Example:
-        # <%= nexaas_async_collect(current_user.id, ReportGenerator, :generate, []) %>
+        # <%= nexaas_async_collect({
+        #   scope_id: current_user.id, class_name: ReportGenerator,
+        #   class_method: :generate, args: [],
+        #   file: { content_type: 'application/json', name: 'data' }
+        # }) %>
         #
         def nexaas_async_collect(opts={})
-          validate_options(opts)
-          opts.merge!({ collect_id: collect_id })
-          AsyncResourceJob.perform_async(opts)
-          render(partial: 'nexaas/async/collector/async_resource/show', locals: { unique_id: SecureRandom.hex })
+          async_resource = Nexaas::Async::Collector::AsyncResource.new(opts)
+          async_resource.save!
+          render(partial: 'nexaas/async/collector/async_resource/show', locals: {
+            unique_id: SecureRandom.hex,
+            collect_id: async_resource.collect_id
+          })
         end
 
         # Rails 4.x does not add this helper automatically as Rails 5.X and 3.X does. So we had to created it to keep
@@ -25,23 +36,6 @@ module Nexaas
           @@nexaas_async_collector ||= Nexaas::Async::Collector::Engine.routes.url_helpers
         end
 
-        private
-
-        def validate_options(opts={})
-          missing_keys = required_collect_opts - opts.keys.map(&:to_s)
-          if missing_keys.any?
-            raise "Nexaas::Async::Collector: Required parameter missing: #{missing_keys.join(', ')}"
-          end
-        end
-
-        def collect_id
-          @collect_id ||= SecureRandom.hex(15)
-        end
-
-        def required_collect_opts
-          ['scope_id', 'class_name', 'class_method']
-        end
-
       end
     end
   end

data/app/models/nexaas/async/collector/async_resource.rb

@@ -0,0 +1,43 @@
+require 'active_model'
+
+module Nexaas
+  module Async
+    module Collector
+      class AsyncResource
+
+        attr_accessor :scope_id, :class_name, :class_method, :args, 
+                      :file, :collect_id, :instrumentation_context
+
+        include ActiveModel::Validations
+
+        validates_presence_of :scope_id, :class_name, :class_method
+
+        def initialize(opts={})
+          opts.each do |key, value|
+            self.send("#{key}=", value)
+          end
+        end
+
+        def save!
+          initialize_collect_id
+          raise "Nexaas::Async::Collector: invalid fields #{errors.messages.keys.join(', ')}" unless valid?
+          AsyncResourceJob.perform_async(sliced_attributes) 
+        end
+
+        def sliced_attributes
+          {
+            scope_id: scope_id, class_name: class_name, class_method: class_method,
+            args: args, file: file, collect_id: collect_id,
+            instrumentation_context: instrumentation_context
+          }.reject { |_,v| v.nil? }
+        end
+
+        private
+
+        def initialize_collect_id
+          @collect_id ||= SecureRandom.hex(15)
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 <script type="text/javascript" id="js-nexaas-async-collector-<%= unique_id %>">
   var requestContent = function() {
     $.ajax({
-      url: '<%= nexaas_async_collector.async_resource_path(@collect_id) %>',
+      url: '<%= nexaas_async_collector.async_resource_path(collect_id) %>',
       dataType: 'script',
       data: { unique_id: '<%= unique_id %>' }
     })

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

@@ -1,7 +1,13 @@
 <% if @result.content_is_ready? %>
   clearInterval(window.nexaas_async_interval);
-  $('#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 %>').remove()
-  $('#js-nexaas-async-collector-style-<%= @unique_id %>').remove()
+
+  <% if @result.is_file? %>
+    $('#js-nexaas-async-collector-loading-<%= @unique_id %>').remove();
+    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 %>').remove()
+    $('#js-nexaas-async-collector-style-<%= @unique_id %>').remove()
+  <% end %>
 <% end %>

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

@@ -10,12 +10,18 @@ module Nexaas
           initialize_options(opts)
           start_time = Time.current.to_i
           instrument_start(start_time)
-          Persist.save(@scope_id, @collect_id, generate_content)
+          Persist.save(sliced_options(opts))
           instrument_finish(start_time)
         end
 
         private
 
+        def sliced_options(opts={})
+          opts.with_indifferent_access
+            .slice('collect_id', 'scope_id', 'file')
+            .merge('content' => generate_content)
+        end
+
         def initialize_options(opts)
           opts.each do |k, v|
             instance_variable_set("@#{k}", v)

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

@@ -3,19 +3,22 @@ module Nexaas
     module Collector
       class Persist
         class << self
-          def save(scope_id, key, value)
-            storage.set(key, content(scope_id, value))
+          def save(opts={})
+            opts = opts.with_indifferent_access
+            content = content_in_json(opts)
+            storage.set(opts[:collect_id], content)
           end
 
-          def content(scope_id, value)
+          private
+
+          def content_in_json(opts)
             {
-              'scope_id' => scope_id,
-              'content' => value
+              'scope_id' => opts[:scope_id],
+              'content' => opts[:content],
+              'file' => opts[:file]
             }.to_json
           end
 
-          private
-
           def storage
             InMemoryStorage.new
           end

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

@@ -11,7 +11,7 @@ module Nexaas
     module Collector
       class Result
 
-        attr_reader :scope_id, :id, :content
+        attr_reader :scope_id, :id, :object
 
         def initialize(scope_id, id)
           @scope_id = scope_id
@@ -19,11 +19,27 @@ module Nexaas
         end
 
         def content
-          _content['content'] if content_is_ready?
+          object['content'] if content_is_ready?
         end
 
         def content_is_ready?
-          _content && _content['scope_id'] == scope_id && _content['content']
+          object && object['scope_id'] == scope_id && object['content']
+        end
+
+        def is_file?
+          object && !object['file'].nil?
+        end
+
+        def filename
+          object && object.dig('file', 'name')
+        end
+
+        def content_type
+          object && object.dig('file', 'content_type')
+        end
+
+        def extension
+          object && object.dig('file', 'extension')
         end
 
         private
@@ -32,9 +48,10 @@ module Nexaas
           @storage ||= InMemoryStorage.new
         end
 
-        def _content
-          @_content ||= storage.get(id)
-          @content ||= JSON.parse(@_content) if @_content
+        def object
+          return @object if @object
+          @_object = storage.get(id)
+          @object = JSON.parse(@_object) if @_object
         end
 
         def url

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

@@ -1,7 +1,7 @@
 module Nexaas
   module Async
     module Collector
-      VERSION = '3.0.1'
+      VERSION = '3.1.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexaas-async-collector
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Eduardo Hertz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-20 00:00:00.000000000 Z
+date: 2017-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -141,6 +141,7 @@ files:
 - 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/models/nexaas/async/collector/async_resource.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