rails_console_shield 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 677ad7893e0d9732cdcc2783bec2e344d7bb163c1df45baadd8007c3068d3b9a
+  data.tar.gz: b5dd57b7f17b428800237a6ebad793b5dd25e5a37b2d217c923264f162233c37
+SHA512:
+  metadata.gz: 6880f14cf393de510f34b3965f3392d0b26de92d38177f580520a7beb7638629f863eccdbb62bae903af506c7bf4e003a837d8fcff812028a49742dcdd56fa30
+  data.tar.gz: db0fc2dcf021dfc3397f23d368a9eb97b2a1d7542d6478167e6ce38ca1efedf948560229d52b465e069fb6d877186af5909feeb04f8c5cdb27475436449d8c27

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/vendor/bundle
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

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 lala.akira@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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rails_console_shield.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 aki
+
+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,42 @@
+# RailsConsoleShield
+
+Make your production rails console more secure!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_console_shield'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_console_shield
+
+## Usage
+
+Set the production console to sandbox mode by default.\
+To disable it, run it with the --no-sandbox option.
+
+```
+bin/rails console --no-sandbox
+```
+
+![Demo](https://i.gyazo.com/a92364252211e4a9bb6be08da6456f0e.png)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RailsConsoleShield project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/aki77/rails_console_shield/blob/master/CODE_OF_CONDUCT.md).
+
+## Acknowledgements
+
+This is a lite and refactored version of [safer_rails_console](https://github.com/salsify/safer_rails_console)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails_console_shield"
+
+# 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(__FILE__)

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/rails_console_shield.rb

@@ -0,0 +1,24 @@
+require 'rails_console_shield/version'
+require 'rails_console_shield/railtie'
+require 'rails_console_shield/configuration'
+require 'rails_console_shield/colors'
+
+module RailsConsoleShield
+  class << self
+    def configure
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def shield_environment?
+      configuration.shield_environments.include?(::Rails.env)
+    end
+
+    def prompt_color
+      configuration.environment_prompt_colors.fetch(::Rails.env.to_sym) { :none }
+    end
+  end
+end

data/lib/rails_console_shield/colors.rb

@@ -0,0 +1,22 @@
+module RailsConsoleShield
+  module Colors
+    COLORS = {
+      none: 0,
+      black: 30,
+      red: 31,
+      green: 32,
+      yellow: 33,
+      blue: 34,
+      pink: 35,
+      cyan: 36,
+      white: 37,
+    }.freeze
+
+    module_function
+
+    def color_text(text, color)
+      color_code = COLORS.fetch(color.to_sym) { COLORS[:none] }
+      "\e[#{color_code}m#{text}\e[0m"
+    end
+  end
+end

data/lib/rails_console_shield/configuration.rb

@@ -0,0 +1,21 @@
+module RailsConsoleShield
+  class Configuration
+    attr_accessor :environment_prompt_colors, :warn_text, :shield_environments
+
+    def initialize
+      self.environment_prompt_colors = {
+        development: :green,
+        staging: :yellow,
+        production: :red,
+      }
+
+      self.warn_text =<<~TEXT
+        WARNING: YOU ARE USING RAILS CONSOLE IN PRODUCTION!
+        Changing data can cause serious data loss.
+        Make sure you know what you're doing.
+      TEXT
+
+      self.shield_environments = %w[production]
+    end
+  end
+end

data/lib/rails_console_shield/console.rb

@@ -0,0 +1,26 @@
+require 'rails_console_shield/colors'
+
+module RailsConsoleShield
+  module Console
+    class << self
+      include Colors
+
+      def print_warning
+        puts color_text(RailsConsoleShield.configuration.warn_text)
+      end
+
+      def print_sandbox
+        puts color_text(<<~TEXT)
+          Sets the console to sandbox mode by default.
+          To disable it, run it with the --no-sandbox option.
+        TEXT
+      end
+
+      private
+
+      def color_text(text)
+        Colors.color_text(text, RailsConsoleShield.prompt_color)
+      end
+    end
+  end
+end

data/lib/rails_console_shield/console/irbrc.rb

@@ -0,0 +1,18 @@
+include RailsConsoleShield::Colors
+
+app_name = Rails.application.class.module_parent.to_s.underscore.dasherize
+env_name = Rails.env
+sandbox = ::Rails.application.sandbox? ? '(sandbox)' : ''
+color = RailsConsoleShield.prompt_color
+
+prompt = "#{app_name}(#{env_name})#{sandbox}:%03n:%i"
+
+IRB.conf[:PROMPT][:RAILS_ENV] = {
+  PROMPT_I: color_text("#{prompt}> ", color),
+  PROMPT_N: color_text("#{prompt}> ", color),
+  PROMPT_S: color_text("#{prompt}%l ", color),
+  PROMPT_C: color_text("#{prompt}* ", color),
+  RETURN: color_text('=> ', color).concat("%s\n")
+}
+
+IRB.conf[:PROMPT_MODE] = :RAILS_ENV

data/lib/rails_console_shield/console_command_extension.rb

@@ -0,0 +1,12 @@
+module RailsConsoleShield
+  module ConsoleCommandExtension
+    def initialize(args = [], local_options = {}, config = {})
+      super(args, local_options, config)
+
+      env = options[:environment] || Rails.env
+      if RailsConsoleShield.configuration.shield_environments.include?(env) && !local_options.include?('--no-sandbox')
+        self.options = options.merge(sandbox: true)
+      end
+    end
+  end
+end

data/lib/rails_console_shield/railtie.rb

@@ -0,0 +1,26 @@
+require 'rails/railtie'
+require 'rails_console_shield/console'
+require 'rails_console_shield/console_command_extension'
+
+module RailsConsoleShield
+  class Railtie < Rails::Railtie
+    include RailsConsoleShield::Colors
+
+    console do |app|
+      if RailsConsoleShield.shield_environment?
+        Console.print_sandbox if app.sandbox?
+        Console.print_warning
+      end
+
+      unless ARGV.include?('-r')
+        ARGV.push '-r', File.expand_path('./console/irbrc.rb', __dir__)
+      end
+    end
+
+    config.after_initialize do
+      require 'rails/command'
+      require 'rails/commands/console/console_command'
+      Rails::Command::ConsoleCommand.prepend ConsoleCommandExtension
+    end
+  end
+end

data/lib/rails_console_shield/version.rb

@@ -0,0 +1,3 @@
+module RailsConsoleShield
+  VERSION = '0.1.0'
+end

data/rails_console_shield.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rails_console_shield/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_console_shield"
+  spec.version       = RailsConsoleShield::VERSION
+  spec.authors       = ["aki77"]
+  spec.email         = ["aki77@users.noreply.github.com"]
+
+  spec.summary       = %q{Make your production rails console more secure!}
+  spec.description   = %q{Make your production rails console more secure!}
+  spec.homepage      = "https://github.com/aki77/rails_console_shield"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency "rails", ">= 6.0.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: rails_console_shield
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- aki77
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Make your production rails console more secure!
+email:
+- aki77@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rails_console_shield.rb
+- lib/rails_console_shield/colors.rb
+- lib/rails_console_shield/configuration.rb
+- lib/rails_console_shield/console.rb
+- lib/rails_console_shield/console/irbrc.rb
+- lib/rails_console_shield/console_command_extension.rb
+- lib/rails_console_shield/railtie.rb
+- lib/rails_console_shield/version.rb
+- rails_console_shield.gemspec
+homepage: https://github.com/aki77/rails_console_shield
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Make your production rails console more secure!
+test_files: []