activejob-argument_mask 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca56bc550e795611d5b406ed4fe06500a9685f76
+  data.tar.gz: c13e4ccdcc7d81894a97063dcd7fe9d89688122e
+SHA512:
+  metadata.gz: 890e083d007feb6165454a39831a38a0f259dd9f0881aa7deb6d04edf1beb5cbae4df43c6e9440a3b732240d781e53b6dc3532101f3dd0877d65b12efa5bae78
+  data.tar.gz: 50342f5d6674352bee7093466e4286740ce0624157a6e043ed2c619401f8997d2954131c2d377555af693a95465d13c83aaf6c17cda13cc4092ac083e19f0841

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+
+sudo: false
+
+before_install: gem install bundler
+
+rvm:
+  - 2.3.6
+  - 2.4.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hrysd22@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activejob-argument_mask.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Hiroshi Yoshida
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+# ActiveJob::ArgumentMask
+
+[![Build Status](https://travis-ci.org/hrysd/activejob-argument_mask.svg?branch=master)](https://travis-ci.org/hrysd/activejob-argument_mask)
+
+This is [ActiveJob](https://github.com/rails/rails/tree/master/activejob) extension wich mask arguments of specified Job from ActiveJob's log file.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activejob-argument_mask'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activejob-argument_mask
+
+## Usage
+
+You can specify job class which mask arguments in configuration.
+
+- config/application.rb
+
+```ruby
+module App
+  class Application < Rails::Application
+    config.active_job_argument_mask.job_classes = %w(SensitiveJob)
+  end
+end
+```
+
+Output example:
+
+```
+[ActiveJob] [SensitiveJob] [3c6f7384-deae-4a7d-9387-7204a09b24e9] Performing SensitiveJob (Job ID: 3c6f7384-deae-4a7d-9387-7204a09b24e9) from Async(default) with masked arguments
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hrysd/activejob-argument_mask. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/activejob-argument_mask.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activejob/argument_mask/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activejob-argument_mask"
+  spec.version       = ActiveJob::ArgumentMask::VERSION
+  spec.authors       = ["Hiroshi Yoshida"]
+  spec.email         = ["hrysd22@gmail.com"]
+
+  spec.summary       = %q{Mask arguments of specified Job from ActiveJob's log file}
+  spec.description   = %q{This is ActiveJob extension wich mask arguments of specified Job from ActiveJob's log.}
+  spec.homepage      = "https://github.com/hrysd/activejob-argument_mask"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'activejob'
+  spec.add_runtime_dependency 'activesupport'
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activejob/argument_mask"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/activejob-argument_mask.rb

@@ -0,0 +1 @@
+require 'activejob/argument_mask'

data/lib/activejob/argument_mask.rb

@@ -0,0 +1,27 @@
+require 'activejob/argument_mask/args_info'
+require 'activejob/argument_mask/version'
+
+require 'active_job/logging'
+
+require 'active_support/configurable'
+require 'active_support/log_subscriber'
+
+module ActiveJob
+  module ArgumentMask
+    include ActiveSupport::Configurable
+
+    config_accessor :job_classes, instance_accessor: false do
+      []
+    end
+
+    config_accessor :message, instance_accessor: false do
+      " with masked arguments"
+    end
+  end
+end
+
+require 'activejob/argument_mask/railtie' if defined?(Rails)
+
+ActiveSupport.on_load(:active_job) do
+  ::ActiveJob::Logging::LogSubscriber.prepend ActiveJob::ArgumentMask::ArgsInfo
+end

data/lib/activejob/argument_mask/args_info.rb

@@ -0,0 +1,25 @@
+module ActiveJob
+  module ArgumentMask
+    module ArgsInfo
+      private
+
+      def args_info(job)
+        return '' if job.arguments.empty?
+
+        if argument_filter_job_classes.include?(job.class.name)
+          argument_filter_message
+        else
+          super(job)
+        end
+      end
+
+      def argument_filter_job_classes
+        ::ActiveJob::ArgumentMask.job_classes
+      end
+
+      def argument_filter_message
+        ::ActiveJob::ArgumentMask.message
+      end
+    end
+  end
+end

data/lib/activejob/argument_mask/railtie.rb

@@ -0,0 +1,18 @@
+require 'active_support/ordered_options'
+
+module ActiveJob
+  module ArgumentMask
+    class Railtie < ::Rails::Railtie
+      config.active_job_argument_mask = ActiveSupport::OrderedOptions.new
+
+      initializer 'active_job_argument_mask', before: 'active_job.set_configs' do |app|
+        option = app.config.active_job_argument_mask
+
+        ActiveJob::ArgumentMask.configure do |a|
+          a.job_classes = option.job_classes if option.job_classes.present?
+          a.message     = option.message     if option.message.present?
+        end
+      end
+    end
+  end
+end

data/lib/activejob/argument_mask/version.rb

@@ -0,0 +1,5 @@
+module ActiveJob
+  module ArgumentMask
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: activejob-argument_mask
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hiroshi Yoshida
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: This is ActiveJob extension wich mask arguments of specified Job from
+  ActiveJob's log.
+email:
+- hrysd22@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activejob-argument_mask.gemspec
+- bin/console
+- bin/setup
+- lib/activejob-argument_mask.rb
+- lib/activejob/argument_mask.rb
+- lib/activejob/argument_mask/args_info.rb
+- lib/activejob/argument_mask/railtie.rb
+- lib/activejob/argument_mask/version.rb
+homepage: https://github.com/hrysd/activejob-argument_mask
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Mask arguments of specified Job from ActiveJob's log file
+test_files: []