eco-helpers 1.5.7 → 1.5.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7620c9cd737d1ba284868030b84b2589b0cd55c71708fee487c79dbce3fa3313
-  data.tar.gz: 444174de9c8634744060d411dcbad7229ef6c2acf24065f001ff29ecd41c6d4c
+  metadata.gz: 2b5a4fcfab321e9a7071a18fb52c38c21a67314a44a2edda63f4783de6ea9f38
+  data.tar.gz: 20b067294c6e2d47c6efa09c62052d2081ce3a56252216fb11c9e465ed0fc5af
 SHA512:
-  metadata.gz: ae26e27d3b51f2b11cc50f6a6c6acc6229172b6a0416ca6feb633727b7fb45c9f19307d8d355ea14f77a67a041cf6886b54299f555b45990ff2c16ff6857f130
-  data.tar.gz: a11ca5b39ca0067c912b2ae59b5bfff1f59caa8ee23565b91f3dc8d694c966cc593a9efb5b7ca1c9c53cae4855f6fa4e59c3a792c6068c5179637641f22a5300
+  metadata.gz: 92bc7a1814a8654bc9831ca8e763802ad40f0679c7ee31bc26b2146f7006744b576fa7586c16b2bd50deb1b74738c41d08d14e47b41fd3d34fd299d753213bb1
+  data.tar.gz: 1dbdacf348a3ec57718dbf15dc825adf97839ea070ae0463b4df1a8a020c3c8bee8edc5b3903029d57f112a8517f20ac0870a5b73a206257be21d27e425c66f2

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [1.5.8] - 2020-12-xx
+
+### Added
+### Changed
+### Fixed
+  - `Eco::API::Session::Batch::Jobs#job` shouldn't be calling the post-launch callback function on creation.
+  - `Eco::API::Session#new_job` should include a `&block` parameter.
+  - `Eco::API::UseCases::DefaultCases::RefreshCase`: fixed typo
+  
 ## [1.5.7] - 2020-12-17
 
 ### Added

data/lib/eco/api/session.rb

@@ -217,6 +217,7 @@ module Eco
         @job_groups ||= Batch::JobsGroups.new(enviro)
       end
 
+      # It retrives the group of `Batch::Jobs` named `name`. It creates it if it doesn't exist.
       # @return [Eco::API::Session::Batch::Jobs]
       def job_group(name, order: :last)
         case
@@ -228,9 +229,10 @@ module Eco
       end
 
       # Shortcut to create a job of certain type within a group
+      # @param [see @Eco::API::Session::Batch::Jobs#new]
       # @return [Eco::API::Session::Batch::Job]
-      def new_job(group, name, type, usecase, sets = [:core, :details, :account])
-        job_group(group).new(name, usecase: usecase, type: type, sets: sets)
+      def new_job(group, name, type, usecase, sets = [:core, :details, :account], &block)
+        job_group(group).new(name, usecase: usecase, type: type, sets: sets, &block)
       end
 
       # @see Eco::API::Session::Batch::JobsGroups#launch

data/lib/eco/api/session/batch/job.rb

@@ -96,7 +96,7 @@ module Eco
           # @param entry [Ecoportal::API::V1::Person, Enumberable<Person>] the person(s) we want to update, carrying the changes to be done.
           # @param unique [Boolean] specifies if repeated entries should be avoided in the queue.
           # @yield [person] callback before launching the batch job request against the server.
-          # @yieldparam param [Person] current person object that that should be treated by the callback before launching the batch.
+          # @yieldparam person [Person] current person object that that should be treated by the callback before launching the batch.
           # @return [Eco::API::Session::Batch::Job] this `Batch::Job`.
           def add(entry, unique: true, &block)
             case entry

data/lib/eco/api/session/batch/jobs.rb

@@ -42,13 +42,23 @@ module Eco
             @jobs.key?(name)
           end
 
+          # It retrieves an existing job named `name` or creates it if it doesn't exist.
+          # @note
+          #   - the block should only be passed when creating the job
+          # @param [see @Eco::API::Session::Batch::Jobs#new]
+          # @return [Eco::API::Session::Batch::Job]
           def job(name, type: nil, sets: nil, usecase: nil, &block)
+            fatal "Can't give a job post-launch callback &block to an already existing job" if exists?(name)
             new(name, type: type, sets: sets, usecase: usecase, &block) unless exists?(name)
-            self[name].tap do |job|
-              block.call(job) if block
-            end
+            self[name]
           end
 
+          # Creates a new `Batch::Job` included as part of this `Batch::Jobs`.
+          # @param [see Eco::API::Session::Job#new]
+          # @yield [job, status] callback after launching the batch job request against the server.
+          # @yieldparam job [Eco::API::Session::Batch::Job] the job we have launched against the server.
+          # @yieldparam status [Eco::API::Session::Batch::Status] the status of the batch job launch.
+          # @return [Eco::API::Session::Batch::Job]
           def new(name, type:, sets:, usecase: nil, &block)
             fatal "Can't create job named '#{name}' because it already exists." if exists?(name)
 
@@ -57,6 +67,11 @@ module Eco
             end
           end
 
+          # @param job [Eco::API::Session::Batch::Job] the `Batch::Job` to add.
+          # @yield [job, status] callback after launching the batch job request against the server.
+          # @yieldparam job [Eco::API::Session::Batch::Job] the job we have launched against the server.
+          # @yieldparam status [Eco::API::Session::Batch::Status] the status of the batch job launch.
+          # @return [Eco::API::Session::Batch::Job]
           def add(job)
             fatal "Expected Eco::API::Session::Batch::Job object. Given #{job.class}" unless job.is_a?(Eco::API::Session::Batch::Job)
             @jobs[job.name] = job
@@ -67,6 +82,10 @@ module Eco
             any? {|job| job.pending?}
           end
 
+          # Launches every `Batch::Job` in the group.
+          # @note
+          #   - if there was post-launch callback for a `Batch::Job`, it calls it.
+          # @return [Hash<Eco::API::Session::Batch::Job, Eco::API::Session::Batch::Status>]
           def launch(simulate: false)
             each do |job|
               if job.pending?

data/lib/eco/api/session/batch/jobs_groups.rb

@@ -58,6 +58,11 @@ module Eco
             @groups.key?(name)
           end
 
+          # Creates a new group of `Batch::Jobs` named `name`.
+          # @yield [group, group_status] callback after launching the batch job request against the server.
+          # @yieldparam group [Eco::API::Session::Batch::Jobs] the group of jobs we have launched against the server.
+          # @yieldparam group_status [Hash<Eco::API::Session::Batch::Job, Eco::API::Session::Batch::Status>] the status of the launched batch jobs.
+          # @return [Eco::API::Session::Batch::Jobs] the group of jobs.
           def new(name, order: :last)
             fatal "Can't create job group named '#{name}' because it already exists." if exists?(name)
 
@@ -78,6 +83,10 @@ module Eco
             any? {|group| group.pending?}
           end
 
+          # Launches every `Batch::Jobs` group in the current `Batch::JobGroups`
+          # @note
+          #   - if there was post-launch callback for a `Batch::Jobs` groups, it calls it.
+          # @return [Hash<Eco::API::Session::Batch::Jobs,Hash<Eco::API::Session::Batch::Job, Eco::API::Session::Batch::Status>>]
           def launch(simulate: false)
             @order.each_with_index do |group, idx|
               if group.pending?

data/lib/eco/api/usecases/default_cases/refresh_case.rb

@@ -4,7 +4,7 @@ class Eco::API::UseCases::DefaultCases::RefreshCase < Eco::API::Common::Loaders:
 
   def main(people, session, options, usecase)
     update   = session.new_job("main", "update", :update, usecase)
-    people.each {|person| job.add(person)}
+    people.each {|person| update.add(person)}
   end
 
 end

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "1.5.7"
+  VERSION = "1.5.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 1.5.7
+  version: 1.5.8
 platform: ruby
 authors:
 - Oscar Segura