obfuscate 0.0.6 → 0.0.7

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Obfucate Changelog
 
+### 0.0.7 (May 16, 2013)
+
+* Add :append_salt option to obfuscateable
+
 ### 0.0.6 (May 11, 2013)
 
-* Implement a new method called find_obfuscated [thanks minostro]
+* Implement a new method called find_obfuscated (<a href="https://github.com/mguymon/obfuscate/pull/2">Pull #2</a>) [thanks <a href="https://github.com/minostro">minostro</a>]

data/README.md

@@ -3,12 +3,13 @@
 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_.
+The goal is to make simple obfuscated ids that are not huge. This is achieved by using an
+<a href="https://github.com/otherinbox/crypt">implementation</a> of <a href="http://www.schneier.com/blowfish.html">Blowfish</a> 
+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
+Text can be obfuscated using Blowfish's string encryption as well, but than it produces
 output that is larger than the elegant 11 character from single block encryption.
 
 https://github.com/mguymon/obfuscate
@@ -24,8 +25,8 @@ https://github.com/mguymon/obfuscate
 A simple example
 
     Obfuscate.setup do |config|
-      config.salt = "A weak salt ..."
-      config.mode = :string # defaults to :string
+      config.salt = "A weak salt ..." # Length must be between 1-56 
+      config.mode = :string           # defaults to :string
     end
 
     obfuscated = Obfuscate.obfuscate( "test" )   # "HoDruKtafqyLxZxu9s-kYQ=="
@@ -37,10 +38,10 @@ Create an initializer in `config/initializers` with:
 
     require 'obfuscate/obfuscatable'
     Obfuscate.setup do |config|
-      config.salt = "A weak salt ..."
+      config.salt = "A weak salt ..." # Length must be between 1-56 
     end
 
-Now add to models that you want to be `Obfuscatable`:
+Now add to models that you want to be `Obfuscatable`, with <a href="http://rubydoc.info/gems/obfuscate/Obfuscate/Obfuscatable/ClassMethods">possible config options</a>:
 
     class Message < ActiveRecord::Base
       obfuscatable # a hash of config overrides can be passed.
@@ -51,8 +52,9 @@ To get the 11 character `obfuscated_id`, which uses `mode :block` for the Blowfi
     message = Message.find(1)
     obfuscated = message.obfuscated_id           # "NuwhZTtHnko"
     clarified = message.clarify_id( obfuscated ) # "1"
-    
-    Message.find_by_obfuscated_id( obfuscated )
+
+    Message.find_obfuscated( obfuscated )        # raises an ActiveRecord::RecordNotFound if the found record does not exist
+    Message.find_by_obfuscated_id( obfuscated )  # returns nil if the found record does not exist
 
 Or `obfuscate` a block of text, defaults to mode :string which uses Blowfish string encryption, allowing longer
 blocks of text to be obfuscated.

data/lib/obfuscate.rb

@@ -13,7 +13,6 @@
 # License for the specific language governing permissions and limitations under
 # the License.
 
-
 require 'obfuscate/version'
 require 'obfuscate/crypt'
 require 'obfuscate/config'

data/lib/obfuscate/config.rb

@@ -27,6 +27,14 @@ class Obfuscate::Config
   def mode=(mode)
     @mode = mode.to_sym
   end
+  
+  def salt=(salt)
+    if salt.length == 0 || salt.length > 56
+      raise "Obfuscate salt length must be between 1-56"
+    else
+      @salt = salt
+    end
+  end
 
   # Check if mode is :block and remove_trailing_equal is true
   # @return [Boolean]
@@ -34,7 +42,8 @@ class Obfuscate::Config
     self.mode == :block && self.remove_trailing_equal == true
   end
 
-  # Creates a new instance of Config with applied changes
+  # Creates a new instance of Config with applied changes. Does not change
+  # the original Config.
   #
   # @param [Hash] options of configurations
   # @option options [Symbol] :salt A Model specific salt

data/lib/obfuscate/obfuscatable.rb

@@ -25,11 +25,19 @@ module Obfuscate
       # 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] :salt A Model specific salt, length must be between 1-56
+      # @option options [Symbol] :append_salt Append string to default salt and use for this Model. Overwrites the salt option.
       # @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 = {})
+        # :append_salt will append the string to the default salt
+        append_salt = options.with_indifferent_access.delete(:append_salt)
+        if append_salt
+          options[:salt] = "#{Obfuscate.config.salt}#{append_salt}"
+        end
+        
+        
         config = Obfuscate.config.apply(options)
 
         cattr_accessor :obfuscatable_config

data/lib/obfuscate/version.rb

@@ -14,5 +14,5 @@
 # the License.
 
 module Obfuscate
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/spec/lib/obfuscate/config_spec.rb

@@ -14,10 +14,23 @@
 # the License.
 
 require 'spec_helper'
+require 'obfuscate'
 require 'obfuscate/config'
 
 describe Obfuscate::Config do
 
+  it "should raise error if salt is to large" do
+    expect do 
+      Obfuscate::Config.new.salt = "a79094729c586621afe294eab90ce4c21749d54be80ef08425d372a281b8"
+    end.to raise_error(RuntimeError)
+  end
+  
+  it "should raise error if salt is empty" do
+    expect do 
+      Obfuscate::Config.new.salt = ""
+    end.to raise_error(RuntimeError)
+  end
+  
   it "should have default mode" do
     Obfuscate::Config.new.mode.should eql :string
   end

data/spec/lib/obfuscate/ofuscatable_spec.rb

@@ -20,17 +20,14 @@ 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 give a hoot and not pollute" do
     ActiveRecord::Base.method_defined?( :find_obfuscated ).should be_false
   end
 
-  it "should have config" do
-    Message.obfuscatable_config.salt.should eql "message salt"
+  it "should have appended salt" do
+    Message.obfuscatable_config.salt.should eql "Test Salt--Message--"
   end
 
-  it "should have obfuscator" do
+  it "should have crypt" do
     Message.obfuscatable_crypt.is_a?( Obfuscate::Crypt ).should be_true
   end
 
@@ -76,6 +73,7 @@ describe Obfuscate::Obfuscatable do
   end
 end
 
+Obfuscate.config.salt = "Test Salt"
 class Message < ActiveRecord::Base
-  obfuscatable :salt => 'message salt'
+  obfuscatable :append_salt => "--Message--"
 end

data/spec/lib/obfuscate_spec.rb

@@ -58,4 +58,14 @@ describe Obfuscate do
     Obfuscate.clarify(obfuscated).should eql "test obfuscation"
   end
 
+  it "should clarify existing obfuscated values" do
+    Obfuscate.setup :salt => 'obfuscate-salt', :mode => :string
+    vals = ["7a2b9e943dc32807285f4cc5e14dfb9f", "cda78d5b2ff68c1af37ed567940eaf47", "c4a175a114b3505761ffb7647e9ab5fd", "6fb25b22c552e9e0fcaa6608418de636", "f7fcbd31a844639edf16c349ce5f51f5", "a8f5535b956fea220a8cfa1127f1746f", "fef14ce49f1027ffcae3f0139e44b3f6", "17ce584c4beb2b05630970588aa296c0", "fd81080b3f5ee8b92f97c5a4ec8bba68", "fbea19fa974d59b3d3d2e8b76ee073ba"]
+    obfuscated = ["1UcIzpT8OYg1DRp3U2KJhFc4G0MFlFgMQUy93DHsz2JpjHmqTGANUUt0G8tbao_a", "1UcIzpT8OYhDPRmTdlV55HIb6bqZcTYDdyaGqTLplNhTxmkEaO_5iDzjoDYt0l_O", "1UcIzpT8OYhGb9w6jFBCJsJHCyv94Dk4DNLIDRJ4A0mxpkBs_BqAPU2MgVNI5g1k", "1UcIzpT8OYheLeZhqOq4G5b4FAjmksim0z5oSuhroRq8AM-iEjiQ1-wS7Bk8layP", "1UcIzpT8OYj0bVYbRaDtV3BD56w9rBoxQK_Rqf-gPjZqh0t3mhSoxTQIjxPEsT9K", "1UcIzpT8OYhreXIwqINLguTO1fEWY23RbbaT3RRmLqTreZTIFBuOl0lFqijoDaUM", "1UcIzpT8OYisoIwsozOMRh4W7mvhWE_Mf5yUi2TO0OLn1MGxXnB5qR2B9sgIoKsk", "1UcIzpT8OYhX9QBNegug7SzXYbutpemeij-GonXITIHSGgO8yV1QkATuqegIkJZp", "1UcIzpT8OYjJkj8IJyYAm0bUsHDHt4xn3qSpPeVm_G2u9Ow9ZNkmUjHnegJOlOyZ", "yJKFWD2DdQIg7pZmVjrMZdcplGmqbU7iwmuY54X4nn-9fnGuEOg_9hjyqR7gPce8"]
+
+    obfuscated.size.times.each do |x|
+      Obfuscate.clarify(obfuscated[x]).should eql vals[x]
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: obfuscate
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-11 00:00:00.000000000 Z
+date: 2013-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: otherinbox-crypt19
@@ -150,7 +150,6 @@ files:
 - 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:

data/spec/message.rb

@@ -1,22 +0,0 @@
-# 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