sidekiq-encrypted_args 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ca6bc1fc5d72297d12bd0f232a87d4ecaa25979c92eba55ea127822fad621c2
-  data.tar.gz: 869bb08e744fa7366e3115a9c1ad7fc8d2d3887a88bee0af7465b0d6b62f5490
+  metadata.gz: 0fdd24a7aeee28447ee34b8bddaa462a967a4d01ded3b9e0fc1c3561310c9a0a
+  data.tar.gz: 42e1f30f93d6c1c9c71e25b9ef46ea1334d89a09746f4cb75f6facf38c0943be
 SHA512:
-  metadata.gz: 4fc68145cdcfdc34ee2a07cbfd18357a73de96ac5b14a03a4ff09de3376bbba0e501bff181cbda9c964fa79c8e492637e9c7b40c3c4a5cbb82d348bc72be2654
-  data.tar.gz: 75418905177a4bea81d7995967d24dbcdb500b4ca6dcf6d528110676569e87dd857b33c04b3fd4aa821cc3200d956b9cd8de037730f08efeebca1cdc60e18378
+  metadata.gz: c6c1409dac2ed256f73c5f18d303adaba6e28fec7114b97ea943d16e1aaa34cb3107233c0cce4ab372b085430c7c4b4b2efbc555b123f13aef72bd2691d44170
+  data.tar.gz: 765dea1c7d85313a4ef7451f1ce5293ee7a8cfab53304037ff1f4f4d056831fb7250e3478e87bce8e92023c03cca4788f1276e923830d6343e7edc9e1574ab52

data/CHANGE_LOG.md

@@ -1,24 +1,43 @@
-# Change Log
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 1.1.1
+
+### Fixed
+- Client middleware will no longer encrypt already encrypted arguments when a job is retried.
 
 ## 1.1.0
 
-* Use `to_json` if it is defined when serializing encrypted args to JSON.
-* Add client middleware to the server default configuration. This ensures that arguments will be encrypted if a worker enqueues a job with encrypted arguments.
-* Client middleware now reads sidekiq options from the job hash instead of from the worker class so that the list of encrypted arguments is always in sync on the job payload.
-* Don't blow up if class name that is not defined is passed to client middleware.
-* Added additional option to specify encrypted args with array of argument indexes.
-* Deprecated setting encrypted args as hash or array of booleans.
-* Client middleware is prepended while server middleware is appended.
+### Added
+- Use `to_json` if it is defined when serializing encrypted args to JSON.
+- Add client middleware to the server default configuration. This ensures that arguments will be encrypted if a worker enqueues a job with encrypted arguments.
+- Client middleware now reads sidekiq options from the job hash instead of from the worker class so that the list of encrypted arguments is always in sync on the job payload.
+- Added additional option to specify encrypted args with array of argument indexes.
+
+### Changed
+- Client middleware is now prepended while server middleware is appended.
+
+### Fixed
+- Don't raise error if undefined class name is passed to client middleware as a string.
+
+### Deprecated
+- Deprecated setting encrypted args as hash or array of booleans.
 
 ## 1.0.2
 
-* Remove overly noisy log warning when running without the secret set
+### Changed
+- Remove overly noisy log warning when running without the secret set
 
 ## 1.0.1
 
-* Now works with scheduled jobs
-  * Scheduled jobs dispatch by class name instead of `Class`, requiring a constant lookup
+### Added
+
+### Fixed
+- Added support for scheduled jobs
 
 ## 1.0.0
 
-* Initial release
+- Initial release

data/README.md

@@ -1,7 +1,6 @@
 # Sidekiq Encrypted Args
 
 [![Continuous Integration](https://github.com/bdurand/sidekiq-encrypted_args/workflows/Continuous%20Integration/badge.svg?branch=master)](https://github.com/bdurand/sidekiq-encrypted_args/actions?query=workflow%3A%22Continuous+Integration%22)
-[![Maintainability](https://api.codeclimate.com/v1/badges/70ab3782e4d5285eb173/maintainability)](https://codeclimate.com/github/bdurand/sidekiq-encrypted_args/maintainability)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 
 Support for encrypting arguments for [Sidekiq](https://github.com/mperham/sidekiq).
@@ -106,3 +105,31 @@ You can also safely add encryption to an existing worker. Any jobs that are alre
 ## Encryption
 
 Encrypted arguments are stored using AES-256-GCM with a key derived from your secret using PBKDF2. For more info on the underlying encryption, refer to the [SecretKeys](https://github.com/bdurand/secret_keys) gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "sidekiq-encrypted_args"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install sidekiq-encrypted_args
+```
+
+## Contributing
+
+Open a pull request on GitHub.
+
+Please use the [standardrb](https://github.com/testdouble/standard) syntax and lint your code with `standardrb --fix` before submitting.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.1.1

data/lib/sidekiq/encrypted_args/client_middleware.rb

@@ -28,7 +28,7 @@ module Sidekiq
         if encrypted_args
           job_args = job["args"]
           job_args.each_with_index do |value, position|
-            if encrypted_args.include?(position)
+            if encrypted_args.include?(position) && !EncryptedArgs.encrypted?(value)
               job_args[position] = EncryptedArgs.encrypt(value)
             end
           end

data/lib/sidekiq/encrypted_args.rb

@@ -31,7 +31,7 @@ module Sidekiq
         @encryptors = make_encryptors(value)
       end
 
-      # Add the client and server middleware to the Sidekiq
+      # Add the client and server middleware to the default Sidekiq
       # middleware chains. If you need to ensure the order of where the middleware is
       # added, you can forgo this method and add it yourself.
       #
@@ -64,6 +64,7 @@ module Sidekiq
       # @return [String]
       def encrypt(data)
         return nil if data.nil?
+
         json = (data.respond_to?(:to_json) ? data.to_json : JSON.generate(data))
         encrypted = encrypt_string(json)
         if encrypted == json
@@ -85,6 +86,13 @@ module Sidekiq
         JSON.parse(json)
       end
 
+      # Check if a value is encrypted.
+      #
+      # @return [Boolean]
+      def encrypted?(value)
+        SecretKeys::Encryptor.encrypted?(value)
+      end
+
       # Private helper method to get the encrypted args option from an options hash. The value of this option
       # can be `true` or an array indicating if each positional argument should be encrypted, or a hash
       # with keys for the argument position and true as the value.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-encrypted_args
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Brian Durand
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-15 00:00:00.000000000 Z
+date: 2023-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -91,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Support for encrypting arguments that contain sensitive information in sidekiq