tokenifier 0.0.1 → 0.1.0

data/README.md

@@ -1,30 +1,56 @@
 # Tokenifier
 
 Tokenifier is a Gibberish gem wrapper.
-It provides an approach to encrypt and decrypt structures like Strings, Hashes.
+It provides an approach to encrypt and decrypt structures like Numeric, String and Hash.
+
+[![Build Status](https://secure.travis-ci.org/ludo/tokenifier.png)](http://travis-ci.org/ludo/tokenifier)
+
 
 ## Installation
 
+Install the gem
+
+    gem install tokenifier
+
+Tokenifier will install gibberish the gem as dependency
+
+    require "tokenifier"
+
+Thats it.
+
+
+
+## Rails
+
 Put the string into Gemfile
 
-    gem "tokenifier"
+    gem "tokenifier", "~> 0.1"
+
+Run tokenifier:install generator
 
-Add config/tokenifier.yml in rails application
+    rails g tokenifier:install
+
+Rails generator will create config/tokenifier.yml with unique secret strings.
 
     development:
       secret: 7e991d82a0dd42b0afa293a339308c6f
 
+You have to use a permanent secret string to decrypt tokens.
+If no secret defined for environment Tokenifier uses random secret string each execution time.
+
+
+
 ## Usage
 
-To encrypt data into hash
+To encrypt data
 
-    Tokenifier.encrypt("string")          # => 
-    Tokenifier.encrypt(:key => 'value')   # => 
+    Tokenifier.encrypt("string")          # => "U2FsdGVkX1+YHpkTh..."
+    Tokenifier.encrypt(:key => 'value')   # => "U2FsdGVkX18ts+aRd..."
 
-To decrypt data into hash
+To decrypt data
 
-    Tokenifier.decrypt(" ...")            # => 
-    Tokenifier.decrypt(" ...")            # => 
+    Tokenifier.decrypt("U2FsdGVkX1+...")  # => "string"
+    Tokenifier.decrypt("U2FsdGVkX18...")  # => {"key" => "value"}
 
 Errors handling
 
@@ -33,12 +59,14 @@ Errors handling
 
     Tokenifier.decrypt("malformed hash")  # => raises Tokenifier::Error
 
-Using custom secret
+Custom secret usage
 
     data = Tokenifier.encrypt("string", :secret => 'secret')
     Tokenifier.decrypt(data, :secret => 'secret')               # => "string"
     Tokenifier.decrypt(data)                                    # => raises Tokenifier::Error, "Got a malformed string"
 
+
+
 ## CLI usage
 
 Usage:
@@ -51,8 +79,8 @@ Commands:
     e|encrypt - Does data encryption of any string data
     d|decrypt - Does data decryption from hashed data.
 
-    NOTE: You have to use permanent secret to decryption data.
-          Tokinifier generates dafult secret each execution time.
+    NOTE: You have to use a permanent secret to decrypt a data.
+          Tokinifier generates random secret string each execution time instead.
 
 Examples:
 

data/lib/tokenifier/cipher.rb

@@ -1,8 +1,12 @@
+require 'yaml'
+
 module Tokenifier
   module Cipher
 
     def secret
-      @secret ||= Tokenifier::Rails.secret || Tokenifier::Random.secret
+      @secret ||= load_rails_secret
+      @secret ||= Tokenifier::Random.secret
+      @secret
     end
 
     def cipher(*args, &block)
@@ -10,5 +14,32 @@ module Tokenifier
       block_given? ? yield(aes) : aes
     end
 
+    def load_rails_secret
+      return unless defined?(Rails)
+
+      filename = Rails.root.join('config', 'tokenifier.yml')
+
+      puts filename
+
+      if File.exists?(filename)
+        config = YAML.load(
+          ERB.new(
+            IO.read(filename)
+          ).result
+        )[Rails.env]
+
+        @secret = config['secret']
+      else
+        @secret = Tokenifier::Random.secret
+
+        Rails.logger.warn "*** Tokenifier warning:"
+        Rails.logger.warn "*** Config tokenifier.yml file not found."
+        Rails.logger.warn "*** Run rails g tokenifier:install to generate one"
+        Rails.logger.warn "*** Using secret: #{@secret}"
+      end
+
+      @secret
+    end
+
   end
 end

data/lib/tokenifier/cli.rb

@@ -14,24 +14,24 @@ module Tokenifier
 
 Usage:
 
-        tokenifier [options] COMMAND 'custom string'
+    tokenifier [options] COMMAND 'custom string'
 
 Commands:
 
-        s|secret - Generates secret string
-        e|encrypt - Does data encryption of any string data
-        d|decrypt - Does data decryption from hashed data.
+    s|secret - Generates secret string
+    e|encrypt - Does data encryption of any string data
+    d|decrypt - Does data decryption from hashed data.
 
-        NOTE: You have to use permanent secret to decryption data.
-              Tokinifier generates dafult secret each execution time.
+    NOTE: You have to use a permanent secret to decrypt a data.
+          Tokinifier generates random secret string each execution time instead.
 
 Examples:
 
-        tokenifier encrypt "CUSTOM DATA"
-        tokenifier decrypt "CUSTOM DATA"
+     tokenifier encrypt "CUSTOM DATA"
+     tokenifier decrypt "CUSTOM DATA"
 
-        tokenifier --secret MYSECRET e "CUSTOM DATA"
-        tokenifier --secret MYSECRET d "ENCRYPTED DATA"
+     tokenifier --secret MYSECRET e "CUSTOM DATA"
+     tokenifier --secret MYSECRET d "ENCRYPTED DATA"
 
 
 USAGE

data/lib/tokenifier/version.rb

@@ -1,3 +1,3 @@
 module Tokenifier
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/lib/tokenifier.rb

@@ -1,7 +1,6 @@
 require 'gibberish'
 require 'tokenifier/error'
 require 'tokenifier/random'
-require 'tokenifier/rails'
 require 'tokenifier/cipher'
 require 'tokenifier/encrypt'
 require 'tokenifier/decrypt'

data/spec/cipher_spec.rb

@@ -48,4 +48,28 @@ describe Tokenifier::Cipher do
 
   end
 
+  describe ".load_rails_secret" do
+
+    let(:rails) { Class.new }
+
+    before {
+      rails.stub_chain(:root, :join).and_return(File.expand_path('../support/config/tokenifier.yml', __FILE__))
+      rails.stub_chain(:logger).and_return(mock(:logger, :warn => nil))
+      rails.stub(:env).and_return('test')
+    }
+
+    specify {
+      with_stub_const(:Rails, rails) do
+        subject.load_rails_secret.should == 'aaabbbccc'
+      end
+    }
+
+    specify {
+      without_const(:Rails) do
+        subject.load_rails_secret.should_not == 'aaabbbccc'
+      end
+    }
+
+  end
+
 end

data/spec/encrypt_spec.rb

@@ -22,14 +22,12 @@ describe Tokenifier::Encrypt do
 
     context "a few key-value pairs" do
       let(:hsh) { {:a => 2, :b => 'string 123', :c => true} }
-      let(:expected) { "c:true#a:2#b:string 123" }
+      let(:expected) { "a:2#b:string 123#c:true" }
       specify { packed.should == expected }
     end
 
     context "we are not supporting nested hashes yet due simplicity of solution" do
-      let(:hsh) { {:a => 2, :b => 'string 123', :sub => { :a => 33 } } }
-      let(:expected) { "sub:a33#a:2#b:string 123" }
-      specify { packed.should == expected }
+      pending
     end
 
   end

data/spec/spec_helper.rb

@@ -1 +1,34 @@
-require 'tokenifier'
+require 'tokenifier'
+
+def without_const(const)
+  if Object.const_defined?(const)
+    begin
+      @const = const
+      Object.send(:remove_const, const)
+      yield
+    ensure
+      Object.const_set(const, @const)
+    end
+  else
+    yield
+  end
+end
+
+def with_stub_const(const, value)
+  if Object.const_defined?(const)
+    begin
+      @const = const
+      Object.const_set(const, value)
+      yield
+    ensure
+      Object.const_set(const, @const)
+    end
+  else
+    begin
+      Object.const_set(const, value)
+      yield
+    ensure
+      Object.send(:remove_const, const)
+    end
+  end
+end

data/spec/support/config/tokenifier.yml

@@ -0,0 +1,2 @@
+test:
+  secret: aaabbbccc

data/spec/tekenifier_spec.rb

@@ -25,8 +25,4 @@ describe Tokenifier do
     specify { data.should == decrypted }
   end
 
-  context "rails support" do
-    
-  end
-
 end

data/tokenifier.gemspec

@@ -1,4 +1,4 @@
-require 'lib/tokenifier/version'
+require File.expand_path('../lib/tokenifier/version', __FILE__)
 
 Gem::Specification.new do |s|
   s.name          = 'tokenifier'

metadata

@@ -1,63 +1,47 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: tokenifier
-version: !ruby/object:Gem::Version 
-  hash: 29
+version: !ruby/object:Gem::Version
+  version: 0.1.0
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
 platform: ruby
-authors: 
+authors:
 - Dmtiry Larkin
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-12-23 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-12-23 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: gibberish
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70275141515140 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 1
-        - 2
-        version: "1.2"
+      - !ruby/object:Gem::Version
+        version: '1.2'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70275141515140
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70275141514640 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 2
-        - 6
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.6.0
   type: :development
-  version_requirements: *id002
-description: Tokenifier is a Gibberish gem wrapper. It provides an aproach to encrypt and decrypt structures like Strings, Hashes.
-email: 
+  prerelease: false
+  version_requirements: *70275141514640
+description: Tokenifier is a Gibberish gem wrapper. It provides an aproach to encrypt
+  and decrypt structures like Strings, Hashes.
+email:
 - dmitry.larkin@gmail.com
-executables: 
+executables:
 - tokenifier
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/generators/tokenifier/install/install_generator.rb
 - lib/generators/tokenifier/install/templates/config/tokenifier.yml.erb
 - lib/generators/tokenifier/install/USAGE
@@ -66,7 +50,6 @@ files:
 - lib/tokenifier/decrypt.rb
 - lib/tokenifier/encrypt.rb
 - lib/tokenifier/error.rb
-- lib/tokenifier/rails.rb
 - lib/tokenifier/random.rb
 - lib/tokenifier/version.rb
 - lib/tokenifier.rb
@@ -75,6 +58,7 @@ files:
 - spec/encrypt_spec.rb
 - spec/random_spec.rb
 - spec/spec_helper.rb
+- spec/support/config/tokenifier.yml
 - spec/tekenifier_spec.rb
 - bin/tokenifier
 - Rakefile
@@ -82,41 +66,33 @@ files:
 - tokenifier.gemspec
 homepage: https://github.com/ludo/tokenifier
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Tokenifier Gem
-test_files: 
+test_files:
 - spec/cipher_spec.rb
 - spec/decrypt_spec.rb
 - spec/encrypt_spec.rb
 - spec/random_spec.rb
 - spec/spec_helper.rb
+- spec/support/config/tokenifier.yml
 - spec/tekenifier_spec.rb

data/lib/tokenifier/rails.rb

@@ -1,18 +0,0 @@
-if env_caller
-  require 'rails'
-  
-  Rails.logger.info "I am required in rails"
-
-  filename = File.expand_path(env_caller + "/../../config/tokenifier.yml")
-
-  if File.exists?(filename)
-    Rails.logger.info YAML::load(
-      ERB.new(
-        IO.read(filename)
-      ).result
-    )[Rails.env].inspect
-  else
-    Rails.logger.info "Config file not found"
-  end
-
-end