voltron-encrypt 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3080525362d98c64d07af3cee1eddf4b5dc3478
+  data.tar.gz: c38f951cced89162994f62076a9d12461995ae0d
+SHA512:
+  metadata.gz: 79910d13b164695fa0ed7c3c701020fddb1a0b71af1b652fa231c44c6785736e655ca440c21701ff9b6ee20784af185c98dd00a51beb9000466a22061d719b1c
+  data.tar.gz: ceb20d3e6771aae6b9a478a034416fc8a17c9589a535a36e871ebb258048bdb1d5a9dd767912fb258d6587b7ced4d68b06c3d7cc7f42dd445749912a11e44c6e

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+tmp/
+log/
+voltron-*.gem
+*.bak

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at eric.hainer@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+source 'http://gem.minow.io'
+
+# Specify your gem's dependencies in voltron-encrypt.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Eric Hainer
+
+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,65 @@
+[![Build Status](https://travis-ci.org/ehainer/voltron-encrypt.svg?branch=master)](https://travis-ci.org/ehainer/voltron-encrypt)
+
+# Voltron::Encrypt
+
+An attempt at giving rails models more obfuscated, base64 encoded id's, and therefore less lame looking urls.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'voltron-encrypt'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install voltron-encrypt
+
+Then run the following to create the voltron.rb initializer (if not exists already) and add the encrypt config:
+
+    $ rails g voltron:encrypt:install
+
+## Usage
+
+Once installed, enable "encrypted" id's on rails models by placing `encrypted_id` at the top of your model.
+
+```ruby
+class User < ActiveRecord::Base
+
+  encrypted_id
+
+end
+```
+
+That's it. All url helper generated urls to the resource in question will receive a base 64 encoded id, i.e. - /users/bvE3j/edit
+
+## Understanding the Options
+
+#### Voltron.config.encrypt.seed
+
+Determines how the base64 characters are randomized to help further obfuscate base64 encoded ids. Running `rake secret` will yield a string of characters that is plenty good. The most important thing is that this value be set once at the beginning of a project and never changed once id's have started to be generated. Changing it will change the randomization of the characters and will therefore change encoded/decoded ids, which equals very, very bad things happening.
+
+#### Voltron.config.encrypt.offset
+
+Since id's start at low numbers, their base 64 encoded values can look like "R" or "3" or "2x" Providing an offset value will case Voltron Encrypt to base 64 encode (id # + offset) and decode (decoded id - offset) That basically means another layer of obfuscation, and id's that don't look lame and more like actual id's.
+
+#### Voltron.config.encrypt.blacklist
+
+The blacklist file is a list of words that encoded id's are not permitted to "look like." Voltron Encrypt includes a fairly comprehensive list automatically, but you can always add/remove words as you please. When id's are created they are regex matched against all possible blacklisted words and, if matched, a new potential id is chosen.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ehainer/voltron-encrypt. 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/models/voltron/id.rb

@@ -0,0 +1,9 @@
+module Voltron
+  class Id < ActiveRecord::Base
+
+    self.primary_key = "id"
+
+    belongs_to :resource, polymorphic: true
+
+  end
+end

data/bin/console

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