obfuscate 0.0.2

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+#idea files
+*.iml
+.idea
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    obfuscate (0.0.2)
+      crypt19 (~> 1.2.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.11)
+      activesupport (= 3.2.11)
+      builder (~> 3.0.0)
+    activerecord (3.2.11)
+      activemodel (= 3.2.11)
+      activesupport (= 3.2.11)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.11)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    coderay (1.0.8)
+    crypt19 (1.2.1)
+    diff-lcs (1.1.3)
+    ffi (1.3.1)
+    guard (1.6.2)
+      listen (>= 0.6.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      terminal-table (>= 1.4.3)
+      thor (>= 0.14.6)
+    guard-rspec (2.4.0)
+      guard (>= 1.1)
+      rspec (~> 2.11)
+    i18n (0.6.1)
+    listen (0.7.2)
+    lumberjack (1.0.2)
+    method_source (0.8.1)
+    multi_json (1.5.0)
+    pry (0.9.11.4)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.2)
+    slop (3.4.3)
+    sqlite3 (1.3.7)
+    terminal-table (1.4.5)
+    thor (0.17.0)
+    tzinfo (0.3.35)
+    yard (0.8.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (> 3.0.0)
+  guard-rspec (~> 2.4.0)
+  obfuscate!
+  rb-inotify (~> 0.8.8)
+  rspec (~> 2.12.0)
+  sqlite3 (~> 1.3.0)
+  yard (~> 0.8.0)

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,101 @@
+# Obfuscate
+
+A simple way to obfuscate ids and text. Useful when you have to make ids visible
+to users. Integrates directly with Rails 3.
+
+The goal is to make simple obfuscated ids that are not huge. This is achieved by using
+Blowfish and encrypting a single block. This produces a nice id of 11 characters (11
+since the trailing _=_ is removed by default), for example `3NINgAbOhPc`. The caveat is,
+the id must be within _99,999,999_, e.g. a max length of _8_.
+
+Text can be obfuscated using Blowfishes string encryption as well, but than it produces
+output that is larger than the elegant 11 character single block encryption.
+
+https://github.com/mguymon/obfuscate
+
+[RDoc](http://rubydoc.info/gems/obfuscate/frames)
+
+## Install
+
+    gem install obfuscate
+
+## Ruby Usage
+
+A simple example
+
+    Obfuscate.setup do |config|
+      config.salt = "A weak salt ..."
+      config.mode = :string # defaults to :string
+    end
+
+    obfuscated = Obfuscate.obfuscate( "test" )
+    clarified = Obfuscate.clarify( obfuscated )
+
+## Rails Integration
+
+Create an initializer in `config/initializers` with:
+
+    require 'obfuscate/obfuscatable'
+    Obfuscate.setup do |config|
+      config.salt = "A weak salt ..."
+    end
+
+Now add to models that you want to be `Obfuscatable`:
+
+    class Message < ActiveRecord::Base
+      obfuscatable # a hash of config overrides can be passed.
+    end
+
+To get the 11 character `obfuscated_id`, which uses `mode :block` for the Blowfish single block encryption:
+
+    message = Message.find(1)
+    obfuscated = message.obfuscated_id
+    clarified = message.clarify_id( obfuscated )
+    
+    Message.find_by_obfuscated_id( obfuscated )
+
+Or `obfuscate` a block of text, defaults to mode :string which uses Blowfish string encryption, allowing longer
+blocks of text to be obfuscated.
+
+    obfuscated = message.obfuscate( "if you use your imagination, this is a long block of text" )
+    clarified = message.clarify( obfuscated )
+    
+
+## Benchmarks
+
+Some benchmarks from my dev machine, with cpu clocking in at 2.53ghz:
+
+    Obfuscate.setup :salt => 'a very weak salt indead.'
+
+    puts Benchmark.bm { |bm|
+      ids = []
+      bm.report("obfuscate x1000:") { 
+        1000.times { ids << Obfuscate.obfuscate( rand(1...99999999), {:mode => :block} ) }
+      }
+    
+      bm.report("clarify x1000:") {
+        ids.each { |id| Obfuscate.clarify( id, {:mode => :block} ) } 
+      }
+    }
+    
+    user     system      total        real
+    obfuscate x1000: 27.110000   0.000000  27.110000 ( 27.145539)
+    clarify x1000: 27.270000   0.000000  27.270000 ( 27.304084)
+
+
+## License
+
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with this
+work for additional information regarding copyright ownership.  The ASF
+licenses this file to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+License for the specific language governing permissions and limitations under
+the License.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/obfuscate.rb

@@ -0,0 +1,67 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership. The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+
+require 'obfuscate/version'
+require 'obfuscate/crypt'
+require 'obfuscate/config'
+
+module Obfuscate
+
+  class << self
+    attr_accessor  :config
+
+    # Obfuscate text. Depends on Obfuscate.setup to be called first
+    #
+    # @param [String] text to be obfuscated
+    # @param [Hash] options overrides how obfuscation should be handled
+    # @return [String]
+    def obfuscate(text, options = {} )
+      cryptor( options ).obfuscate( text )
+    end
+
+    # Clarify obfuscated text. Depends on Obfuscate.setup to be called first
+    #
+    # @param [String] text to be clarified
+    # @param [Hash] options overrides how clarify should be handled
+    # @return [String]
+    def clarify(text, options = {} )
+      cryptor( options ).clarify( text )
+    end
+
+    # Create instance of Obfuscate::Crypt. Depends on Obfuscate.setup to be called first
+    #
+    # @param [Hash] overrides how instance should be created
+    # @return [Obfuscate::Crypt]
+    def cryptor(options = {} )
+      Obfuscate::Crypt.new( @config.apply( options ) )
+    end
+
+    # Setup Obfuscate passing in a hash and/or block
+    #
+    # @param [Hash] options of configurations
+    # @option options [Symbol] :salt A Model specific salt
+    # @option options [Symbol] :encode Enable Base64 and URL encoding for this Model. Enabled by default.
+    # @option options [Symbol] :remove_trailing_equal When in :block mode, removes the trailing = from the
+    #                                                 obfuscated text.
+    # @param [block] blk of configuration, has precedence over options Hash.
+    # @return [Obfuscate::Config]
+    def setup(options ={}, &blk)
+      @config = @config.apply(options, &blk)
+    end
+  end
+
+  self.config = Obfuscate::Config.new
+end

data/lib/obfuscate/config.rb

@@ -0,0 +1,67 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership. The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+class Obfuscate::Config
+  attr_accessor :salt, :mode, :encode, :remove_trailing_equal
+
+  def initialize
+    # defaults
+    @remove_trailing_equal = true
+    @encode = true
+    @mode = :string
+  end
+
+  # Set the mode, enforces that mode should be a Symbol
+  def mode=(mode)
+    @mode = mode.to_sym
+  end
+
+  # Check if mode is :block and remove_trailing_equal is true
+  # @return [Boolean]
+  def remove_trailing_equal?
+    self.mode == :block && self.remove_trailing_equal == true
+  end
+
+  # Creates a new instance of Config with applied changes
+  #
+  # @param [Hash] options of configurations
+  # @option options [Symbol] :salt A Model specific salt
+  # @option options [Symbol] :encode Enable Base64 and URL encoding for this Model. Enabled by default.
+  # @option options [Symbol] :remove_trailing_equal When in :block mode, removes the trailing = from the
+  #                                                 obfuscated text.
+  # @param [Block] blk of configuration, has precedence over options hash.
+  # @return [Obfuscate::Config] new instance
+  def apply(options = {}, &blk)
+    config = self.class.new
+
+    changes = self.to_hash.merge( options )
+
+    config.salt = changes[:salt] unless changes[:salt].nil?
+    config.mode = changes[:mode] unless changes[:mode].nil?
+    config.encode = changes[:encode] unless changes[:encode].nil?
+    config.remove_trailing_equal = changes[:remove_trailing_equal] unless changes[:remove_trailing_equal].nil?
+
+
+    yield(config) if blk
+
+    config
+  end
+
+  # Hash of Config
+  # @return [Hash]
+  def to_hash
+    { :salt => salt, :mode => mode, :encode => encode, :remove_trailing_equal => remove_trailing_equal }
+  end
+end

data/lib/obfuscate/crypt.rb

@@ -0,0 +1,81 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership. The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+require 'obfuscate'
+require 'crypt/blowfish'
+require 'base64'
+
+class Obfuscate::Crypt
+
+  attr_reader :config
+  attr_reader  :exec_config
+
+  # New instance of Obfuscate::Crypt
+  #
+  # @param [Obfuscate::Config]
+  def initialize( config )
+    @crypt = Crypt::Blowfish.new( config.salt )
+    @config = config
+  end
+
+  # Obfuscate text
+  #
+  # @param [Symbol] override_mode to explicit set obfuscate mode to :string or :block
+  # @return [String]
+  def obfuscate( text, override_mode = nil )
+
+    @exec_config = @config.apply( :mode => (override_mode || @config.mode) )
+
+    obfuscated = nil
+    if @exec_config.mode == :string
+      obfuscated = @crypt.encrypt_string(text)
+    elsif @exec_config.mode == :block
+      obfuscated = @crypt.encrypt_block(text.to_s.ljust(8))
+    else
+      raise "Unsupport Mode"
+    end
+
+    if @exec_config.encode
+      obfuscated = URI.escape(Base64.strict_encode64(obfuscated).strip)
+      obfuscated = obfuscated.chomp("=") if @exec_config.remove_trailing_equal?
+    end
+
+    obfuscated
+  end
+
+  # Clarify text
+  #
+  # @param [Symbol] override_mode to explicit set clarify mode to :string or :block
+  # @return [String]
+  def clarify( text, override_mode = nil )
+
+    @exec_config = @config.apply( :mode => (override_mode || @config.mode) )
+    obfuscated = text.to_s
+
+
+    if @exec_config.encode
+      obfuscated << "=" if @exec_config.remove_trailing_equal?
+      obfuscated = Base64.strict_decode64( URI.unescape(obfuscated) )
+    end
+
+    if @exec_config.mode == :string
+      @crypt.decrypt_string( obfuscated )
+    elsif @exec_config.mode == :block
+      @crypt.decrypt_block( obfuscated ).strip
+    else
+      raise "Unsupport Mode"
+    end
+  end
+end

data/lib/obfuscate/obfuscatable.rb

@@ -0,0 +1,85 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership. The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+require 'obfuscate/crypt'
+
+module Obfuscate
+  module Obfuscatable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      # Make this Model Obfuscatable. Adds method obfuscate_id which obfuscates the id to 11 characters.
+      # Cavaet: Only supports id lengths up to 8 (e.g. 99,999,999) due to use of Blowfish block encryption.
+      #
+      # @params [Hash] options to override the default config
+      # @option options [Symbol] :salt A Model specific salt
+      # @option options [Symbol] :encode Enable Base64 and URL encoding for this Model. Enabled by default.
+      # @option options [Symbol] :remove_trailing_equal When in :block mode, removes the trailing = from the
+      #                                                 obfuscated text.
+      def obfuscatable(options = {})
+        config = Obfuscate.config.apply(options)
+
+        cattr_accessor :obfuscatable_config
+        self.obfuscatable_config = config
+
+        cattr_accessor :obfuscatable_crypt
+        self.obfuscatable_crypt = Obfuscate::Crypt.new( config )
+
+        define_method :obfuscate_id do
+          self.obfuscatable_crypt.obfuscate( self.id, :block )
+        end
+
+        define_method :clarify_id do |text|
+          self.class.clarify_id( text )
+        end
+
+        class << self
+
+          # Find by obfuscated_id
+          #
+          # @return [Object]
+          def find_by_obfuscated_id( text )
+            find_by_id( clarify_id( text ) )
+          end
+
+          # Clarifies obfuscated Model id
+          # @return [String]
+          def clarify_id( text )
+            self.obfuscatable_crypt.clarify( text, :block )
+          end
+
+          # Clarify obfuscated text.
+          #
+          # @param [String] text to clarify
+          # @param [Symbol] mode to clarify, defaults to :string
+          def clarify( text, mode = :string)
+            self.obfuscatable_crypt.clarify(text, mode)
+          end
+
+          #
+          # @param [String] text to clarify
+          # @param [Symbol] mode to clarify, defaults to :string
+          def obfuscate( text, mode = :string)
+            self.obfuscatable_crypt.obfuscate(text, mode)
+          end
+        end
+      end
+    end
+
+  end
+end
+
+ActiveRecord::Base.send :include, Obfuscate::Obfuscatable

data/lib/obfuscate/version.rb

@@ -0,0 +1,18 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership. The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+module Obfuscate
+  VERSION = "0.0.2"
+end

data/obfuscate.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "obfuscate/version"
+
+Gem::Specification.new do |s|
+  s.name          = %q{obfuscate}
+  s.license       = "MIT"
+  s.version       = Obfuscate::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.homepage      = %q{https://github.com/mguymon/obfuscate}
+  s.authors       = ["Michael Guymon"]
+  s.email         = ["mguymon@tobedevoured.com"]
+  s.description   = %q{Obfuscate}
+  s.summary       = %q{Obfuscate}
+
+  s.files         = `git ls-files`.split("\n").sort
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency(%q<crypt19>, ["~> 1.2.0"])
+  s.add_development_dependency(%q<rspec>, ["~> 2.12.0"])
+  s.add_development_dependency(%q<guard-rspec>, ["~> 2.4.0"])
+  s.add_development_dependency(%q<rb-inotify>, ["~> 0.8.8"])
+  s.add_development_dependency(%q<activerecord>, ["> 3.0.0"])
+  s.add_development_dependency(%q<sqlite3>, ["~> 1.3.0"])
+  s.add_development_dependency(%q<yard>, ["~> 0.8.0"])
+end

data/spec/lib/obfuscate/config_spec.rb

@@ -0,0 +1,32 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership. The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+require 'spec_helper'
+require 'obfuscate/config'
+
+describe Obfuscate::Config do
+
+  it "should have default mode" do
+    Obfuscate::Config.new.mode.should eql :string
+  end
+
+  it "should have default encode" do
+    Obfuscate::Config.new.encode.should be_true
+  end
+
+  it "should have default remove_trailing_equal" do
+    Obfuscate::Config.new.remove_trailing_equal.should be_true
+  end
+end

data/spec/lib/obfuscate/crypt_spec.rb

@@ -0,0 +1,112 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership. The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+require 'spec_helper'
+require 'obfuscate/crypt'
+require 'crypt/blowfish'
+require 'base64'
+
+describe Obfuscate::Crypt do
+
+  describe "obfuscate block mode" do
+    before(:each) do
+      @config = Obfuscate.setup do |config|
+        config.salt = "salt-salt-salt"
+        config.mode = :block
+      end
+    end
+
+    it "should obfuscate" do
+      crypt = Obfuscate::Crypt.new( @config )
+      crypt.obfuscate("test123").should eql "R35tG3YxSQk"
+    end
+
+    it "should obfuscate including the equality" do
+      crypt = Obfuscate::Crypt.new( @config.apply(:remove_trailing_equal => false) )
+      crypt.obfuscate("test123").should eql "R35tG3YxSQk="
+    end
+
+    it "should obfuscate without encoding" do
+      crypt = Obfuscate::Crypt.new( @config.apply(:encode => false ) )
+      crypt.obfuscate("without encoding").should eql "\x8F\xC7\xE4\n,2\xA2\xA7"
+    end
+
+    it "should be able to override mode" do
+      crypt = Obfuscate::Crypt.new( @config.apply( :mode => :string ) )
+      crypt.obfuscate("test123", :block).should eql "R35tG3YxSQk"
+    end
+  end
+
+  describe "obfuscate string mode" do
+    before(:each) do
+      @config = Obfuscate.setup do |config|
+        config.salt = "salt-salt-salt"
+        config.mode = :string
+      end
+    end
+
+    it "should obfuscate" do
+      crypt = Obfuscate::Crypt.new( @config )
+      #crypt.obfuscate("test12345678").should eql ""
+      crypt.clarify( crypt.obfuscate("test12345678") ).should eql "test12345678"
+    end
+
+    it "should clarify previously obfuscated text" do
+      crypt = Obfuscate::Crypt.new( @config )
+      crypt.clarify( "j65H1jCTYh2uw/lsHweLXMw50aaENXYI" ).should eql "test12345678"
+      crypt.clarify( "4bxm/ijHwq1ekPBYEGFsr+LuJ8EZVa57" ).should eql "test12345678"
+      crypt.clarify( "y2D0gT8x3llEToou6PPbKRagVYX1NeVc" ).should eql "test12345678"
+      crypt.clarify( "T/graYvZiWE585V9fkJ5HAj1wyOothyo" ).should eql "test12345678"
+    end
+
+
+    it "should be able to override mode" do
+      crypt = Obfuscate::Crypt.new( @config.apply( :mode => :block ) )
+
+      # such a weak spec, but the encrypted string will not be the same every time
+      crypt.obfuscate("test123", :string).should_not eql "3NINgAbOhPc"
+    end
+  end
+
+  describe "clarify" do
+    before(:each) do
+      @config = Obfuscate.setup do |config|
+        config.salt = "salt-salt-salt"
+        config.mode = :string
+      end
+    end
+
+    it "should clarify" do
+      crypt = Obfuscate::Crypt.new( @config )
+      enc = crypt.obfuscate("test123456test123456test123456test123456")
+      crypt.clarify(enc).should eql "test123456test123456test123456test123456"
+    end
+
+    it "should be able to override mode" do
+      crypt = Obfuscate::Crypt.new( @config )
+      crypt.clarify( crypt.obfuscate("test123", :block), :block ).should eql "test123"
+    end
+
+    describe "block mode" do
+      it "will trim text larger than 8 characters" do
+        crypt = Obfuscate::Crypt.new( @config.apply( :mode => :block ) )
+        enc = crypt.obfuscate("1234567890")
+        crypt.exec_config.mode.should eql :block
+
+        crypt.clarify(enc).should eql "12345678"
+      end
+    end
+  end
+end

data/spec/lib/obfuscate/ofuscatable_spec.rb

@@ -0,0 +1,64 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership. The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+require 'spec_helper'
+require 'obfuscate/obfuscatable'
+
+describe Obfuscate::Obfuscatable do
+
+  it "should give a hoot and not pollute" do
+    ActiveRecord::Base.method_defined?( :find_by_obfuscated_id ).should be_false
+  end
+
+  it "should have config" do
+    Message.obfuscatable_config.salt.should eql "message salt"
+  end
+
+  it "should have obfuscator" do
+    Message.obfuscatable_crypt.is_a?( Obfuscate::Crypt ).should be_true
+  end
+
+  it "should obfuscate text" do
+    obfuscated = Message.obfuscate( "blah blah blah blah blah blah blah" )
+    Message.clarify( obfuscated ).should eql "blah blah blah blah blah blah blah"
+  end
+
+  describe "instance" do
+
+    let(:model) do
+      model = Message.new
+      model.text = "Test"
+      model.save
+
+      model
+    end
+
+    it "should obfuscate id" do
+      model.obfuscate_id.should_not be nil
+    end
+
+    it "should clarify id" do
+      model.clarify_id( model.obfuscate_id ).to_i.should eql model.id
+    end
+
+    it "should find_by_obfuscated_id" do
+      Message.find_by_obfuscated_id( model.obfuscate_id ).should eql model
+    end
+  end
+end
+
+class Message < ActiveRecord::Base
+  obfuscatable :salt => 'message salt'
+end

data/spec/lib/obfuscate/version_spec.rb

@@ -0,0 +1,22 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership. The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+require 'spec_helper'
+
+describe Obfuscate do
+  it "should have VERSION" do
+    Obfuscate::VERSION.should_not be_nil
+  end
+end

data/spec/lib/obfuscate_spec.rb

@@ -0,0 +1,61 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership. The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+require 'spec_helper'
+require 'obfuscate'
+
+describe Obfuscate do
+
+
+  it "should setup config by block" do
+    Obfuscate.setup do |config|
+      config.mode = :block
+      config.salt = "salty salt"
+    end
+
+    Obfuscate.config.mode.should eql :block
+    Obfuscate.config.salt.should eql "salty salt"
+  end
+
+  it "should setup config by hash" do
+    Obfuscate.setup :salt => 'less salt', :mode => :string
+
+    Obfuscate.config.mode.should eql :string
+    Obfuscate.config.salt.should eql "less salt"
+  end
+
+  it "should setup config by hash and overriding block" do
+    Obfuscate.setup :salt => 'less salt', :mode => :string do |config|
+      config.salt = "mega salt"
+      config.encode = false
+    end
+
+    Obfuscate.config.mode.should eql :string
+    Obfuscate.config.salt.should eql "mega salt"
+    Obfuscate.config.encode.should eql false
+  end
+
+  it "should create Crypt" do
+    Obfuscate.setup :salt => 'obfuscate-salt', :mode => :string
+    Obfuscate.cryptor.should_not be_nil
+  end
+
+  it "should obfuscate and clarify" do
+    Obfuscate.setup :salt => 'obfuscate-salt', :mode => :string
+    obfuscated = Obfuscate.obfuscate("test obfuscation")
+    Obfuscate.clarify(obfuscated).should eql "test obfuscation"
+  end
+
+end

data/spec/message.rb

@@ -0,0 +1,22 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership. The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+require 'obfuscate/obfuscatable'
+
+Obfuscate.salt = "default salt"
+
+class Message < ActiveRecord::Base
+  obfuscatable
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership. The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+require 'rubygems'
+require 'active_record'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+ActiveRecord::Base.establish_connection(
+    :adapter => 'sqlite3',
+    :database => ':memory:'
+)
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :messages, :force => true do |t|
+    t.string :text
+    t.integer :user_id
+  end
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: obfuscate
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Michael Guymon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: crypt19
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: Obfuscate
+email:
+- mguymon@tobedevoured.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/obfuscate.rb
+- lib/obfuscate/config.rb
+- lib/obfuscate/crypt.rb
+- lib/obfuscate/obfuscatable.rb
+- lib/obfuscate/version.rb
+- obfuscate.gemspec
+- spec/lib/obfuscate/config_spec.rb
+- spec/lib/obfuscate/crypt_spec.rb
+- spec/lib/obfuscate/ofuscatable_spec.rb
+- spec/lib/obfuscate/version_spec.rb
+- spec/lib/obfuscate_spec.rb
+- spec/message.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mguymon/obfuscate
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Obfuscate
+test_files: []
+has_rdoc: