bp_obfuscate 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 45925480db83fe4794d1a0bf09d39481f1e848f1
-  data.tar.gz: 2a41754ffb1977bee6c9a0161b9cdbe2fb8015e5
+SHA256:
+  metadata.gz: 106e82e30599e71026b2683baaae7413aa2104b2471039fc380c2a4eb4a822a3
+  data.tar.gz: 33abf0c80f641ddb8b5fbcc4b015ddc1b281fdfc45f424a54be7162716f6fe06
 SHA512:
-  metadata.gz: 8f19f52f9b228a7a328dc36e521ef3f246d3d534612ca91875558393b9779610597687deb66c2ce6c8d927ecebbf2fc98d985f0de5ca73a51e82dbed5588879c
-  data.tar.gz: ff5b77d8eca1026c826e85ce0c0d69b98b58846e1d74fd5f976c2f9d7a53e99aa92190460bf625521bb09469de8d91232285f951cd82bdfd526f3079b870d4f7
+  metadata.gz: f012caab3baf15ad5045b81b034aaaab26926b423875df71579f712d7bba6fcad24c15b34ebb8a3b60e3a53aba00245f390bdcb1fae5a2d65eee9a4138333ea1
+  data.tar.gz: 97d332424a47a08cb4e6e60e9447250ac183d74cee7f3d594f84b5b7903862fe64998ac7b79979e150275e4362b0d8377d09c9ed2b1e836fcc0e4071cfb3d728

data/CHANGELOG.md

@@ -0,0 +1,55 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.0] - 2026-09-08
+
+### Added
+
+- Rails 8 support.
+- `base64` as an explicit runtime dependency; it stopped being a default gem in
+  Ruby 3.4, so `require "base64"` raised `LoadError` under Bundler there.
+- GitHub Actions CI covering Ruby 2.7 through 3.4 plus ruby-head.
+- A real README, and this changelog.
+
+### Fixed
+
+- `cipher_key` called `Rails.application.secrets`, which was removed in Rails
+  7.1, raising `NoMethodError` on every encrypt/decrypt under Rails 7.1 and 8.
+  The key now comes from `Rails.application.secret_key_base`, falling back to
+  the old `secrets` lookup for Rails versions that predate it.
+- `defined?(Rails)` was true whenever any Rails constant was loaded, so the key
+  lookup could run with a `nil` `Rails.application` and raise.
+- `raise NoCipherKey` raised `NameError`, because the constant lives in
+  `BpObfuscate` rather than `Obfuscate`. `BpObfuscate::NoCipherKey` is now
+  raised as documented.
+- `rescue OpenSSL::Cipher::CipherError && ArgumentError` evaluated to just
+  `ArgumentError`, so `decrypt` raised `CipherError` on undecryptable input
+  instead of returning `nil`.
+- Added the missing `require "digest"`, which had been working only via
+  whatever else happened to load it.
+- `rake` failed with "Don't know how to build task 'spec'"; the `:spec` task is
+  now defined.
+
+### Changed
+
+- `required_ruby_version` is now `>= 2.7`.
+- Relaxed the `bundler ~> 1.13` and `rake ~> 10.0` development pins, which
+  could not resolve on a Ruby new enough to run Rails 8.
+- Development and CI files are no longer packaged into the built gem.
+
+## [0.1.1] - 2017-04-30
+
+### Fixed
+
+- Deprecation warning from `OpenSSL::Cipher::Cipher`.
+
+## [0.1.0] - 2017-01-31
+
+- Initial release.
+
+[0.2.0]: https://github.com/burningpony/bp_obfuscate/compare/v0.1.1...v0.2.0
+[0.1.1]: https://github.com/burningpony/bp_obfuscate/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/burningpony/bp_obfuscate/releases/tag/v0.1.0

data/README.md

@@ -1,8 +1,12 @@
 # BpObfuscate
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bp_obfuscate`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![CI](https://github.com/burningpony/bp_obfuscate/actions/workflows/ci.yml/badge.svg)](https://github.com/burningpony/bp_obfuscate/actions/workflows/ci.yml)
 
-TODO: Delete this and the text above, and describe your gem
+A simple wrapper around OpenSSL to easily encrypt/obfuscate data.
+
+Inside a Rails application the key comes from the app's `secret_key_base`;
+outside of Rails it comes from `ENV["SECRET_KEY_BASE"]`. Works on Rails 4.1
+through Rails 8.
 
 ## Installation
 
@@ -12,30 +16,37 @@ Add this line to your application's Gemfile:
 gem 'bp_obfuscate'
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
+And then run `bundle`. Or install it yourself as:
 
     $ gem install bp_obfuscate
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+token = Obfuscate.encrypt("user-42")   # => "rIMK7MWO-u-gLdi7qVKU8A=="
+Obfuscate.decrypt(token)               # => "user-42"
+Obfuscate.decrypt("garbage")           # => nil
+```
+
+`decrypt` returns `nil` instead of raising when it can't decrypt a value, so
+it's safe to call on untrusted input such as a URL parameter.
+
+If no key is available, `BpObfuscate::NoCipherKey` is raised.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Run `bin/setup` to install dependencies, `bundle exec rspec` for the tests, and
+`bin/console` for an interactive prompt.
 
-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).
+To release a new version, update the version number in `version.rb` and run
+`bundle exec rake release`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bp_obfuscate. 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.
-
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/rposborne/bp_obfuscate.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
+Available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/bp_obfuscate.gemspec

@@ -9,18 +9,37 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Russell Osborne"]
   spec.email         = ["russell@burningpony.com"]
 
-  spec.summary       = "A simple wrapper to Open ssl to easily encrypt/obfuscate data."
-  spec.homepage      = "https://burningpony.com"
+  spec.summary       = "A simple wrapper around OpenSSL to easily encrypt/obfuscate data."
+  spec.description   = "A small wrapper around OpenSSL for encrypting and obfuscating " \
+                       "short values such as ids in URLs. Derives its key from a Rails " \
+                       "application's secret_key_base, or from ENV[\"SECRET_KEY_BASE\"] " \
+                       "outside of Rails."
+  spec.homepage      = "https://github.com/burningpony/bp_obfuscate"
   spec.license       = "MIT"
 
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+    "changelog_uri" => "#{spec.homepage}/blob/master/CHANGELOG.md",
+    "bug_tracker_uri" => "#{spec.homepage}/issues",
+    "rubygems_mfa_required" => "true"
+  }
+
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{^(test|spec|features)/}) ||
+      f.match(%r{^(\.github/|\.gitignore|\.rspec|Gemfile|Rakefile|bin/|CODE_OF_CONDUCT\.md)})
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.required_ruby_version = ">= 2.7"
+
+  # base64 stopped being a default gem in Ruby 3.4, so it has to be declared.
+  # Deliberately open-ended: it is a stdlib shim, so any future version will do.
+  spec.add_dependency "base64", ">= 0.1"
+
+  spec.add_development_dependency "bundler", ">= 1.13", "< 5"
+  spec.add_development_dependency "rake", ">= 12.0", "< 14"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/bp_obfuscate/obfuscate.rb

@@ -1,29 +1,25 @@
 # frozen_string_literal: true
 require "openssl"
 require "base64"
+require "digest"
 
 module Obfuscate
   class << self
     def cipher
-      OpenSSL::Cipher::Cipher.new("aes-256-cbc")
+      OpenSSL::Cipher.new('AES-256-CBC')
     end
 
     def cipher_key
-      if defined?(Rails)
-        Rails.application.secrets.secret_key_base
-      elsif ENV["SECRET_KEY_BASE"]
-        ENV["SECRET_KEY_BASE"]
-      else
-        raise NoCipherKey, "you must have a an SECRET_KEY_BASE or be in a rails enviroment"
-      end
+      rails_cipher_key || ENV["SECRET_KEY_BASE"] ||
+        raise(BpObfuscate::NoCipherKey, "you must have a an SECRET_KEY_BASE or be in a rails enviroment")
     end
 
     def decrypt(value)
       c = cipher.decrypt
       c.key = Digest::SHA256.digest(cipher_key)
       c.update(Base64.urlsafe_decode64(value.to_s)) + c.final
-    rescue OpenSSL::Cipher::CipherError && ArgumentError
-      return nil
+    rescue OpenSSL::Cipher::CipherError, ArgumentError
+      nil
     end
 
     def encrypt(value)
@@ -31,5 +27,20 @@ module Obfuscate
       c.key = Digest::SHA256.digest(cipher_key)
       Base64.urlsafe_encode64(c.update(value.to_s) + c.final)
     end
+
+    private
+
+    # Rails.application.secrets was removed in Rails 7.1, so read the key from
+    # the application itself, which resolves credentials/ENV on every version
+    # since Rails 4.1.
+    def rails_cipher_key
+      return nil unless defined?(Rails) && Rails.respond_to?(:application) && Rails.application
+
+      if Rails.application.respond_to?(:secret_key_base)
+        Rails.application.secret_key_base
+      elsif Rails.application.respond_to?(:secrets)
+        Rails.application.secrets.secret_key_base
+      end
+    end
   end
 end

data/lib/bp_obfuscate/version.rb

@@ -1,3 +1,3 @@
 module BpObfuscate
-  VERSION = "0.1.0".freeze
+  VERSION = "0.2.0".freeze
 end

metadata

@@ -1,43 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: bp_obfuscate
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Russell Osborne
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-01-31 00:00:00.000000000 Z
+date: 2026-09-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.13'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.13'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,31 +78,32 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description: A small wrapper around OpenSSL for encrypting and obfuscating short values
+  such as ids in URLs. Derives its key from a Rails application's secret_key_base,
+  or from ENV["SECRET_KEY_BASE"] outside of Rails.
 email:
 - russell@burningpony.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- CODE_OF_CONDUCT.md
-- Gemfile
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - bp_obfuscate.gemspec
 - lib/bp_obfuscate.rb
 - lib/bp_obfuscate/obfuscate.rb
 - lib/bp_obfuscate/version.rb
-homepage: https://burningpony.com
+homepage: https://github.com/burningpony/bp_obfuscate
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/burningpony/bp_obfuscate
+  source_code_uri: https://github.com/burningpony/bp_obfuscate
+  changelog_uri: https://github.com/burningpony/bp_obfuscate/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/burningpony/bp_obfuscate/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -84,16 +111,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
-summary: A simple wrapper to Open ssl to easily encrypt/obfuscate data.
+summary: A simple wrapper around OpenSSL to easily encrypt/obfuscate data.
 test_files: []

data/.gitignore

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

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# 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 russell@burningpony.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

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

data/Rakefile

@@ -1,2 +0,0 @@
-require "bundler/gem_tasks"
-task default: :spec

data/bin/console

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

@@ -1,8 +0,0 @@
-#!/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