nexaas-async-collector 1.2.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d6262f078636b043ae567b9f2e0e9318b86b80c
-  data.tar.gz: 85abf3a76680a3194b366fc6de0459cd86d65142
+  metadata.gz: '095b630a7a47dcb39b779d55d8a9adec7cec81c3'
+  data.tar.gz: 3aeadb92991d1884a3bda6b36ac4a49a3a67071d
 SHA512:
-  metadata.gz: 4579d88011523cb251fa330a11cd07db1d357430148daed76cd61c49b3c9d2131844e463191cf28e6c044974d74b1e6dcdc255e6804f61dca6e17bfc04106efb
-  data.tar.gz: 907207719835d0f6589ecdbafbe248d98e24e9f03b1c6dc6629c885cd3a0b6db32a30d0ebb4432e6ce1c0b52f864b37f3a678a09d8e6a5d9d5fbb88c7c245af3
+  metadata.gz: 003da333f56ca3122b2221fd4ca14e54cdd6dcefee8ffc1c5b15189d56104df61b572cff3d9624afd5ece531c9cb9719fdfea804aecdb134b4c64c84c7b0562e
+  data.tar.gz: 7831048e2329a696533c56b731c2e95730b8c1a17f590c063265492c27bc2319f0cff83e803d0afa998af4aaf8a8fbc94ab29a71a3ebcf7e951e8219edc2899e

data/README.md

@@ -69,7 +69,13 @@ end
 3) Use the view helper to do all the process:
 
 ```ruby
-<%= nexaas_async_collect(user.id, ModelService, :model_method, [arg1, arg2]) %>
+<%= nexaas_async_collect({
+  scoped_id: scope.id, # (required) the ID of the scope. It ensures only the scope who requested the data will be able to fetch it
+  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'
+}) %>
 ```
 
 ## Contributing

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

@@ -4,7 +4,7 @@ module Nexaas
       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)
+        # - scoped_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
@@ -12,8 +12,10 @@ module Nexaas
         # 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)
+        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')
         end
 
@@ -25,8 +27,19 @@ module Nexaas
 
         private
 
-        def collector_user_id
-          @collector_user_id ||= SecureRandom.hex(15)
+        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

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

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

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

@@ -6,20 +6,51 @@ module Nexaas
         include Sidekiq::Worker
         sidekiq_options queue: Nexaas::Async::Collector.queue_name
 
-        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)
+        def perform(opts={})
+          initialize_options(opts)
+          start_time = Time.current.to_i
+          instrument_start(start_time)
+          Persist.save(@scoped_id, @collect_id, generate_content)
+          instrument_finish(start_time)
         end
 
         private
 
-        def call_for_method(klass_name, klass_method, args=[])
-          if args.any?
-            klass_name.to_s.constantize.send(klass_method, *args)
+        def initialize_options(opts)
+          opts.each do |k, v|
+            instance_variable_set("@#{k}", v)
+          end
+        end
+
+        def generate_content
+          if @args && @args.any?
+            @class_name.to_s.constantize.send(@class_method, *@args)
           else
-            klass_name.to_s.constantize.send(klass_method)
+            @class_name.to_s.constantize.send(@class_method)
           end
         end
+
+        def instrument_start(start_time)
+          ActiveSupport::Notifications.instrument("#{instrumentation_context}.start", {
+            collect_id: @collect_id, scoped_id: @scoped_id,
+            class_name: @class_name, class_method: @class_method,
+            start: start_time
+          })
+        end
+
+        def instrument_finish(start_time)
+          finish = Time.current.to_i
+          duration = (finish - start_time)
+          ActiveSupport::Notifications.instrument("#{instrumentation_context}.finish", {
+            collect_id: @collect_id, scoped_id: @scoped_id,
+            class_name: @class_name, class_method: @class_method,
+            finish: finish, duration: duration
+          })
+        end
+
+        def instrumentation_context
+          @instrumentation_context || 'nexaas-async-collector'
+        end
       end
     end
   end

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

@@ -3,13 +3,13 @@ module Nexaas
     module Collector
       class Persist
         class << self
-          def save(user_id, key, value)
-            storage.set(key, content(user_id, value))
+          def save(scope_id, key, value)
+            storage.set(key, content(scope_id, value))
           end
 
-          def content(user_id, value)
+          def content(scope_id, value)
             {
-              'user_id' => user_id,
+              'scope_id' => scope_id,
               'content' => value
             }.to_json
           end

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

@@ -1,21 +1,20 @@
 # Content is stored in the database as the following JSON:
 # {
-#   'user_id' => 'user_id',
+#   'scope_id' => 'scope_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?
+# The content is scoped by scope, so any other scope who discover the key (id) of the content, will not be able
+# to access only. Only the scope who created it.
 
 module Nexaas
   module Async
     module Collector
       class Result
 
-        attr_reader :user_id, :id, :content
+        attr_reader :scope_id, :id, :content
 
-        def initialize(user_id, id)
-          @user_id = user_id
+        def initialize(scope_id, id)
+          @scope_id = scope_id
           @id = id
         end
 
@@ -24,7 +23,7 @@ module Nexaas
         end
 
         def content_is_ready?
-          _content && _content['user_id'] == user_id && _content['content']
+          _content && _content['scope_id'] == scope_id && _content['content']
         end
 
         private

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

@@ -1,7 +1,7 @@
 module Nexaas
   module Async
     module Collector
-      VERSION = '1.2.2'
+      VERSION = '2.0.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexaas-async-collector
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Eduardo Hertz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-13 00:00:00.000000000 Z
+date: 2017-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -108,6 +108,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 9.0.6
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: Agnostic collector and generator of async content for Rails apps.
 email:
 - eduardohertz@gmail.com