public_primary_key 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9bc0c05d883e1deb908569567c4b4ada213237b4
+  data.tar.gz: c603518009f712bb0252d161f91e1e6b16b42df4
+SHA512:
+  metadata.gz: 297bc1df1e48b173010f2964b7f41bd3a363329a73e7eac296f4bc54b8387993daaffdc4e73f53a92208aed784a51cce5543a2d89e2aefb6982d23c17e820697
+  data.tar.gz: b7fd8f7ab34cd8aef25aabff7f547aa16a0a603bec7479146fa45b2dcae72bc5e2b38009c00231f8402c76c68fa3da880c9fb4735f4df365d51a07b2d6b51454

data/.gitignore

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

data/.travis.yml

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

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 cyrus.stoller@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 public_primary_key.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Cyrus Stoller
+
+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,81 @@
+# PublicPrimaryKey
+
+It's often advantageous to use integer primary keys,
+but it may be disadvantageous to expose the size of your database to open internet.
+This gem makes it easy to continue using an integer primary key internally in your code,
+while displaying a more obscure public primary key that does not give clues to the size of
+your database to your users.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'public_primary_key'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install public_primary_key
+
+## Usage
+
+For now, this gem only supports ActiveRecord.
+
+### Step 1: Choose a model that you want to use `public_primary_key` with
+
+- Add a string column to your model that will store your public_primary_key
+(for this example I'm assume you named the column `hash_id`, but you can name it whatever you like)
+- (Recommended) Add an index in the database
+- (Recommended) Check for uniqueness at the database level
+- Add the following to your model
+
+```ruby
+class Post < ApplicatonRecord
+  public_primary_key :hash_id
+end
+```
+
+- (Optionally) you can set which generator is used by `SecureRandom` (default is `urlsafe_base64`)
+- (Optionally) you can set the length of the primary key string (default is 10)
+- Result: users would go to `/posts/TukHuqisTm4l6A` instead of `/posts/1`.
+- If you're migrating an existing table to use this gem, be sure to backfill the new column.
+
+```ruby
+class Post < ApplicationRecord
+  public_primary_key :hash_id, generator: :hex, length: 12
+end
+```
+
+### Step 2: Update your controllers
+
+Because public_primary_key overwrites the default `to_param` method, you will need to update your controllers.
+For the example above, go to the `posts_controller.rb` and change the `set_post` private method to
+
+```ruby
+def set_post
+  @post = Post.find_by_hash_id(params[:id])
+end
+```
+
+You'll also want to remove `hash_id` from the list of trusted parameters in the `post_params` method.
+
+## 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/[USERNAME]/public_primary_key. 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/bin/console

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

@@ -0,0 +1,3 @@
+require "public_primary_key/version"
+require "public_primary_key/active_record_mixin"
+require "public_primary_key/railtie" if defined?(Rails)

data/lib/public_primary_key/active_record_mixin.rb

@@ -0,0 +1,27 @@
+require "active_record"
+require "securerandom"
+
+module PublicPrimaryKey::ActiveRecordMixin
+  extend ActiveSupport::Concern
+
+  def public_primary_key(column_name, opts = {})
+    before_validation on: :create do
+      length = opts[:length] || 10
+      generator = opts[:generator] || "urlsafe_base64"
+      new_id = SecureRandom.send(generator, length)
+      eval "self.#{column_name} = '#{new_id}'"
+    end
+
+    validates_uniqueness_of column_name
+    validates_presence_of column_name
+    validates_format_of column_name, :with => /\A[\w-]+\z/, :message => "cannot have whitespace"
+
+    class_eval do
+      eval %{
+        def to_param
+          self.#{column_name}
+        end
+      }
+    end
+  end
+end

data/lib/public_primary_key/railtie.rb

@@ -0,0 +1,9 @@
+module PublicPrimaryKey
+  class Railtie < Rails::Railtie
+    initializer "public_primary_key.mixin" do
+      ActiveSupport.on_load(:active_record) do
+        extend PublicPrimaryKey::ActiveRecordMixin
+      end
+    end
+  end
+end

data/lib/public_primary_key/version.rb

@@ -0,0 +1,3 @@
+module PublicPrimaryKey
+  VERSION = "0.1.0"
+end

data/public_primary_key.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'public_primary_key/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "public_primary_key"
+  spec.version       = PublicPrimaryKey::VERSION
+  spec.authors       = ["Cyrus Stoller"]
+  spec.email         = ["cyrus.stoller@gmail.com"]
+
+  spec.summary       = %q{Public primay key makes it easy to obscure how many records you have in your application.}
+  spec.description   = %q{It's often advantageous to use integer primary keys,
+                          but it may be disadvantageous to expose the size of your database to open internet.
+                          This gem makes it easy to continue using an integer primary key internally in your code,
+                          while displaying a more obscure public primary key that does not give clues to the size of
+                          your database to your users.}
+  spec.homepage      = "https://github.com/cyrusstoller/public_primary_key"
+  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_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "sqlite3"
+
+  spec.add_dependency "activerecord", "> 4.0"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: public_primary_key
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cyrus Stoller
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: |-
+  It's often advantageous to use integer primary keys,
+                            but it may be disadvantageous to expose the size of your database to open internet.
+                            This gem makes it easy to continue using an integer primary key internally in your code,
+                            while displaying a more obscure public primary key that does not give clues to the size of
+                            your database to your users.
+email:
+- cyrus.stoller@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/public_primary_key.rb
+- lib/public_primary_key/active_record_mixin.rb
+- lib/public_primary_key/railtie.rb
+- lib/public_primary_key/version.rb
+- public_primary_key.gemspec
+homepage: https://github.com/cyrusstoller/public_primary_key
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Public primay key makes it easy to obscure how many records you have in your
+  application.
+test_files: []