mongoid-encrypted_string 0.0.1

data/.gitignore

@@ -0,0 +1,25 @@
+# Because this is a gem, ignore Gemfile.lock:
+
+Gemfile.lock
+
+# And because this is Ruby, ignore the following
+#  (source: https://github.com/github/gitignore/blob/master/Ruby.gitignore):
+
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+
+gemspec
+
+gem 'minitest'
+gem 'rake'

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['spec/**/*_spec.rb']
+end
+
+task default: :test

data/lib/mongoid/encrypted_string.rb

@@ -0,0 +1,34 @@
+require 'active_support/all'
+require 'gibberish'
+require 'mongoid'
+
+module Mongoid
+  class EncryptedString < String
+    def mongoize
+      self.class.mongoize(self)
+    end
+
+    class << self
+      attr_accessor :key
+
+      def mongoize(string)
+        aes.encrypt(string)
+      end
+
+      def demongoize(string)
+        return if string.nil?
+        
+        new(aes.decrypt(string))
+      end
+
+      def config
+        self
+      end
+
+    private
+      def aes        
+        @aes ||= Gibberish::AES.new(key || raise(StandardError, "Mongoid::EncryptedString.config.key is not set"))
+      end
+    end
+  end
+end

data/lib/mongoid/encrypted_string/global.rb

@@ -0,0 +1,3 @@
+require 'mongoid/encrypted_string'
+
+EncryptedString = Mongoid::EncryptedString

data/lib/mongoid/encrypted_string/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  class EncryptedString < String
+    VERSION = '0.0.1'
+  end
+end

data/mongoid-encrypted_string.gemspec

@@ -0,0 +1,18 @@
+$: << File.expand_path('../lib', __FILE__)
+require 'mongoid/encrypted_string/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'mongoid-encrypted_string'
+  gem.version       = Mongoid::EncryptedString::VERSION
+  gem.authors       = 'Mario Uher'
+  gem.email         = 'uher.mario@gmail.com'
+  gem.homepage      = 'https://github.com/haihappen/mongoid-encrypted_string'
+  gem.summary       = 'Encrypted string type for Mongoid.'
+  gem.description   = 'Mongoid::EncryptedString defines an encrypted string type for your Mongoid apps.'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.require_path  = 'lib'
+
+  gem.add_dependency 'gibberish'
+  gem.add_dependency 'mongoid'
+end

data/spec/encrypted_string_spec.rb

@@ -0,0 +1,55 @@
+require_relative 'spec_helper'
+
+describe Mongoid::EncryptedString do
+  let(:string) { 'foo' }
+  subject { Mongoid::EncryptedString.new(string) }
+
+
+  describe 'not setting a key' do
+    it 'raises an error' do
+      key = Mongoid::EncryptedString.config.key
+      Mongoid::EncryptedString.config.key = nil
+      Mongoid::EncryptedString.instance_variable_set :@aes, nil
+      
+      ->{
+        subject.mongoize
+      }.must_raise StandardError
+      
+      Mongoid::EncryptedString.config.key = key
+    end
+  end
+
+
+  describe :mongoize do
+    let(:value) { subject.mongoize }
+
+
+    it 'returns database friendly value' do
+      value.must_be_kind_of String
+      value.wont_equal string
+      (value.length > string.length).must_equal true
+    end
+  end
+
+
+  describe 'self.mongoize' do
+    let(:value) { Mongoid::EncryptedString.mongoize(subject) }
+
+
+    it 'returns database friendly value' do
+      value.must_be_kind_of String
+      value.wont_equal string
+    end
+  end
+
+
+  describe 'self.demongoize' do
+    let(:value) { Mongoid::EncryptedString.demongoize(Mongoid::EncryptedString.mongoize(string)) }
+
+
+    it 'returns a EncryptedString object' do
+      value.must_be_kind_of Mongoid::EncryptedString
+      value.must_equal string
+    end
+  end
+end

data/spec/global_spec.rb

@@ -0,0 +1,10 @@
+require_relative 'spec_helper'
+
+describe Mongoid::EncryptedString do
+  before { require 'mongoid/encrypted_string/global' }
+
+
+  it 'is available as ::EncryptedString too' do
+    ::EncryptedString.must_be_same_as Mongoid::EncryptedString
+  end
+end

data/spec/integration_spec.rb

@@ -0,0 +1,45 @@
+require_relative 'spec_helper'
+
+describe 'Mongoid::EncryptedString integration' do
+  let(:string) { 'foo' }
+
+
+  describe 'create document without any attributes' do
+    subject { Document.create }
+
+
+    it 'sets encrypted string to nil' do
+      subject.string.must_be_nil
+    end
+
+
+    describe "when default is set to 'foo' }" do
+      subject { DocumentWithImplicitDefault.create }
+
+
+      it 'sets encrypted string to foo' do
+        subject.string.must_equal string
+      end
+    end
+
+
+    describe "when default is set to ->{ EncryptedString.new('foo') }" do
+      subject { DocumentWithExplicitDefault.create }
+
+
+      it 'sets encrypted string to foo' do
+        subject.string.must_equal string
+      end
+    end
+  end
+
+
+  describe 'create document with attribute' do
+    subject { Document.create(string: string) }
+
+
+    it 'sets encrypted string to foo' do
+      subject.string.must_equal string
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$: << File.expand_path('../../lib', __FILE__)
+
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'minitest/spec'
+
+require 'mongoid/encrypted_string'
+
+# Load support *.rb files in ./support
+Dir[File.expand_path('../support/*.rb', __FILE__)].each { |file| require_relative file }

data/spec/support/config.rb

@@ -0,0 +1 @@
+Mongoid::EncryptedString.config.key = 'some super secure key'

data/spec/support/connection.rb

@@ -0,0 +1 @@
+Mongoid.load!(File.expand_path('../mongoid.yml', __FILE__), 'test')

data/spec/support/document.rb

@@ -0,0 +1,17 @@
+class Document
+  include Mongoid::Document
+
+  field :string, type: Mongoid::EncryptedString
+end
+
+class DocumentWithImplicitDefault
+  include Mongoid::Document
+
+  field :string, type: Mongoid::EncryptedString, default: 'foo'
+end
+
+class DocumentWithExplicitDefault
+  include Mongoid::Document
+
+  field :string, type: Mongoid::EncryptedString, default: ->{ Mongoid::EncryptedString.new('foo') }
+end

data/spec/support/mongoid.yml

@@ -0,0 +1,8 @@
+test:
+  sessions:
+    default:
+      database: mongoid_encrypted_string_test
+      hosts:
+        - localhost:27017
+      options:
+        consistency: :strong

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-encrypted_string
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Mario Uher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: gibberish
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: mongoid
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+description: Mongoid::EncryptedString defines an encrypted string type for your Mongoid
+  apps.
+email: uher.mario@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/mongoid/encrypted_string.rb
+- lib/mongoid/encrypted_string/global.rb
+- lib/mongoid/encrypted_string/version.rb
+- mongoid-encrypted_string.gemspec
+- spec/encrypted_string_spec.rb
+- spec/global_spec.rb
+- spec/integration_spec.rb
+- spec/spec_helper.rb
+- spec/support/config.rb
+- spec/support/connection.rb
+- spec/support/document.rb
+- spec/support/mongoid.yml
+homepage: https://github.com/haihappen/mongoid-encrypted_string
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Encrypted string type for Mongoid.
+test_files: []