rocketjob 5.0.0.beta3 → 5.0.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a9461707111b2196affa91073e002da7664503f5a31aa1718745502e8b677ed
-  data.tar.gz: b1aff5d9bd88c754de93454f699821f5d598767e30830d3456ff289ae0ed7525
+  metadata.gz: '048d247981e5131c03505a00a99945bc9efb9a1d862d629a5da1db9bbd2aa083'
+  data.tar.gz: 361373a9b8a8709276fc9198be95bd7f197b54c7dc067e59d91d2f648f13653f
 SHA512:
-  metadata.gz: c61f05e4bd981ce85d199758bc6211256f9fa1408196c9f0168821d79ba8eb4d9e403db2fa91ed5de4a00b20545aadca051bdbd3fd586b9340c6e06430c91f28
-  data.tar.gz: 4ba190a069d7fa2ed7f0a684e1f32e6d7ff6f6a6838df8d082016cecc62d83207522393e6bca0c7a25370a8bfb0986a3f4db51a055a8629df4fa10f8fcac57f6
+  metadata.gz: e955117f6a72063a9de9bbea3d7ced0e1e4afa1943ff72af5f443f9fc1b2c59babeb687fc0d3924892635a328605b9421b11ee3ea18de2681f159be95595ebcf
+  data.tar.gz: e22f2bea9056da23229a29cc6fd6005dc09d8ae0a73b8bac30704636ace2cd7d347c1cfa8fcffed89680fe6b591eb77dfbeb925185594330772f11c8f8b53b29

data/lib/rocket_job/batch/state_machine.rb

@@ -57,7 +57,7 @@ module RocketJob
       #
       # I.e. Not during before_batch and after_batch.
       def pausable?
-        queued? || paused? || running? && (sub_state == :processing)
+        queued? || paused? || (running? && (sub_state == :processing))
       end
 
       private

data/lib/rocket_job/jobs/copy_file_job.rb

@@ -0,0 +1,104 @@
+# Copy the source_url file/url/path to the target file/url/path.
+#
+# Example: Upload a file to an SFTP Server:
+#
+# RocketJob::Jobs::CopyFileJob.create!(
+#   source_url:  "/exports/uploads/important.csv.pgp",
+#   target_url:  "sftp://sftp.example.org/uploads/important.csv.pgp",
+#   target_args: {
+#     username: "Jack",
+#     password: "OpenSesame",
+#     ssh_options: {
+#       IdentityFile: "~/.ssh/secondary"
+#     }
+#   }
+# )
+#
+# Notes:
+# - The password is only encrypted when the Symmetric Encryption gem has been installed.
+# - If `decrypt: true` then the file will be decrypted with Symmetric Encryption,
+#   prior to uploading to the sftp server.
+module RocketJob
+  module Jobs
+    class CopyFileJob < RocketJob::Job
+      include RocketJob::Plugins::Retry
+
+      self.destroy_on_complete = false
+      # Number of times to automatically retry the copy. Set to `0` for no retry attempts.
+      self.retry_limit = 5
+
+      # File names in IOStreams URL format.
+      field :source_url, type: String, user_editable: true
+      field :target_url, type: String, user_editable: true
+
+      # Any optional arguments to pass through to the IOStreams source and/or target.
+      field :source_args, type: Hash, default: -> { {} }
+      field :target_args, type: Hash, default: -> { {} }
+
+      # Any optional IOStreams streams to apply to the source and/or target.
+      field :source_streams, type: Hash, default: -> { {none: nil} }
+      field :target_streams, type: Hash, default: -> { {none: nil} }
+
+      # Data to upload, instead of supplying `:input_file_name` above.
+      # Note: Data must be less than 15MB after compression.
+      if defined?(SymmetricEncryption)
+        field :encrypted_source_data, type: String, encrypted: {random_iv: true, compress: true}
+      else
+        field :source_data, type: String
+      end
+
+      validates_presence_of :source_url, unless: :source_data
+      validates_presence_of :target_url
+      validates_presence_of :source_data, unless: :source_url
+
+      before_save :set_description
+
+      def perform
+        if source_data
+          target_path.write(source_data)
+        elsif target_url
+          target_path.copy_from(source_path)
+        end
+
+        self.percent_complete = 100
+      end
+
+      private
+
+      def set_description
+        self.description = "Copying to #{target_url}"
+      end
+
+      def source_path
+        source = IOStreams.path(source_url, **decrypt_args(source_args))
+        apply_streams(source, source_streams)
+        source
+      end
+
+      def target_path
+        target = IOStreams.path(target_url, **decrypt_args(target_args))
+        apply_streams(target, target_streams)
+        target
+      end
+
+      def apply_streams(path, streams)
+        streams.each_pair { |stream, args| path.stream(stream.to_sym, args.nil? ? {} : decrypt_args(args)) }
+      end
+
+      def decrypt_args(args)
+        return args.symbolize_keys unless defined?(SymmetricEncryption)
+
+        decrypted_args = {}
+        args.each_pair do |key, value|
+          if key.to_s.start_with?("encrypted_")
+            unencrypted_key                        = key.to_s.sub("encrypted_", "")
+            decrypted_args[unencrypted_key.to_sym] = SymmetricEncryption.decrypt(value)
+          else
+            decrypted_args[key.to_sym] = value
+          end
+        end
+        decrypted_args
+      end
+    end
+  end
+end

data/lib/rocket_job/jobs/upload_file_job.rb

@@ -1,12 +1,6 @@
 require 'fileutils'
 require 'uri'
 
-begin
-  require 'iostreams'
-rescue LoadError
-  # Optional dependency
-end
-
 module RocketJob
   module Jobs
     # Job to upload a file into another job.
@@ -93,12 +87,12 @@ module RocketJob
       end
 
       def file_exists
-        return if upload_file_name.nil? 
+        return if upload_file_name.nil?
         uri = URI.parse(upload_file_name)
         return unless uri.scheme.nil? || uri.scheme == 'file'
-        return if File.exist?(upload_file_name) 
+        return if File.exist?(upload_file_name)
         errors.add(:upload_file_name, "Upload file: #{upload_file_name} does not exist.")
       end
-   end
+    end
   end
 end

data/lib/rocket_job/plugins/job/state_machine.rb

@@ -111,6 +111,11 @@ module RocketJob
           end
         end
 
+        # All regular jobs can be paused or resumed whilst queued.
+        def self.pausable?
+          queued? || paused? || pausable
+        end
+
         private
 
         # Sets the exception child object for this job based on the

data/lib/rocket_job/version.rb

@@ -1,3 +1,3 @@
 module RocketJob
-  VERSION = '5.0.0.beta3'.freeze
+  VERSION = '5.0.0.beta4'.freeze
 end

data/lib/rocketjob.rb

@@ -64,6 +64,7 @@ module RocketJob
 
   module Jobs
     autoload :ActiveJob,        'rocket_job/jobs/active_job'
+    autoload :CopyFileJob,      'rocket_job/jobs/copy_file_job'
     autoload :DirmonJob,        'rocket_job/jobs/dirmon_job'
     autoload :OnDemandBatchJob, 'rocket_job/jobs/on_demand_batch_job'
     autoload :OnDemandJob,      'rocket_job/jobs/on_demand_job'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rocketjob
 version: !ruby/object:Gem::Version
-  version: 5.0.0.beta3
+  version: 5.0.0.beta4
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-04 00:00:00.000000000 Z
+date: 2019-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aasm
@@ -128,6 +128,7 @@ files:
 - lib/rocket_job/job.rb
 - lib/rocket_job/job_exception.rb
 - lib/rocket_job/jobs/active_job.rb
+- lib/rocket_job/jobs/copy_file_job.rb
 - lib/rocket_job/jobs/dirmon_job.rb
 - lib/rocket_job/jobs/housekeeping_job.rb
 - lib/rocket_job/jobs/on_demand_batch_job.rb