obfuscatable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 869c127a994e1b082fb9e6fde29dacf41586cef1
+  data.tar.gz: 76217edbe7ac6c21664c65c72168a41a54e145aa
+SHA512:
+  metadata.gz: aca135fad2c1f76d0f617d0b98a58bd9ea48c4256c4073a2affaec07a83fc8fbee1f95718bead64e91f146944f424cbb0314d79a059bee94f36f42988acc4c96
+  data.tar.gz: bf75aa59b08b58832d806359f3ad74fd28cdd9d9dd83d9462b4d649411f96d9c9d1f21e8f11693eff36ca3cb38d6bb86fa3c732cc00ae5e7936e879fbf397f99

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Nathan Amick
+
+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,58 @@
+# obfuscatable
+
+[![Build Status](https://secure.travis-ci.org/namick/obfuscatable.png)](http://travis-ci.org/namick/obfuscatable) [![Dependency Status](https://gemnasium.com/namick/obfuscatable.png)](https://gemnasium.com/namick/obfuscatable) [![Code Climate](https://codeclimate.com/github/namick/obfuscatable.png)](https://codeclimate.com/github/namick/obfuscatable)
+
+**Make your ActiveRecord ids non-obvious**
+
+This gem is just a fork from [obfuscate_id](https://github.com/namick/obfuscate_id) but I made the obfuscation optional because it affects to some conditions and causes errors.
+
+## Installation
+
+Add the gem to your Gemfile.
+
+```ruby
+gem "obfuscatable"
+```
+
+Run bundler.
+
+```ruby
+bundle install
+```
+
+## Usage
+ 
+In your model, add a single line.  
+
+```ruby
+class Post < ActiveRecord::Base
+  obfuscatable
+end
+```
+
+Then use it with `to_param` or direct object passing in the view.
+
+```ruby
+link_to 'Post', post_path(@post.to_param)
+link_to 'Post', post_path(@post)
+```
+
+And in your controller.
+
+```ruby
+class PostController < ApplicationController
+  def show
+    Post.find(params[:id], obfuscated: true)
+  end
+end
+```
+
+## Customization
+
+If you want your obfuscated ids to be different than some other website using the same plugin, you can throw a random number (spin) at obfuscatable to make it hash out unique ids for your app.
+
+```ruby
+class Post < ActiveRecord::Base
+  obfuscatable :spin => 89238723
+end
+```

data/Rakefile

@@ -0,0 +1,29 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ObfuscateId'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/obfuscatable.rb

@@ -0,0 +1,67 @@
+module Obfuscatable
+
+  def obfuscatable(options = {})
+    require 'scatter_swap'
+
+    extend ClassMethods 
+    include InstanceMethods
+    cattr_accessor :obfuscatable_spin
+    self.obfuscatable_spin = (options[:spin] || obfuscatable_default_spin)
+  end
+
+  def self.hide(id, spin)
+    ScatterSwap.hash(id, spin)
+  end
+
+  def self.show(id, spin)
+    ScatterSwap.reverse_hash(id, spin)
+  end
+
+
+  module ClassMethods
+    def find_obfuscated(*args)
+      scope = args.slice!(0)
+      options = args.slice!(0) || {}
+      if has_obfuscated_id?
+        if scope.is_a?(Array)
+          scope.map! {|a| deobfuscatable(a).to_i}
+        else
+          scope = deobfuscatable(scope)
+        end
+      end
+      find(scope)
+    end
+
+    def has_obfuscated_id?
+      true
+    end
+
+    def deobfuscatable(obfuscated_id)
+      Obfuscatable.show(obfuscated_id, self.obfuscatable_spin)
+    end
+
+    # Generate a default spin from the Model name
+    # This makes it easy to drop obfuscatable onto any model
+    # and produce different obfuscated ids for different models
+    def obfuscatable_default_spin
+      alphabet = Array("a".."z") 
+      number = name.split("").collect do |char|
+        alphabet.index(char)
+      end
+      number.shift(12).join.to_i
+    end
+
+  end
+
+  module InstanceMethods
+    def to_param
+      Obfuscatable.hide(self.id, self.class.obfuscatable_spin)
+    end
+
+    def deobfuscatable(obfuscated_id)
+      self.class.deobfuscatable(obfuscated_id)
+    end
+  end
+end
+
+ActiveRecord::Base.extend Obfuscatable

data/lib/obfuscatable/version.rb

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

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: obfuscatable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daisuke Taniwaki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: scatter_swap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !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: rspec-rails
+  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: capybara
+  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: guard-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'
+- !ruby/object:Gem::Dependency
+  name: guard-spork
+  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: rb-inotify
+  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 ActiveRecord IDs non-obvious
+email:
+- daisuketaniwaki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/obfuscatable.rb
+- lib/obfuscatable/version.rb
+homepage: https://github.com/dtaniwaki/obfuscatable
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Mask ActiveRecord IDs
+test_files: []