attr_secure 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6587948291c3a27b3b2d8b6d4510668b5fe2d7b0
-  data.tar.gz: 63313a924a9b32dffdc259ee965a45e4dfc20db3
+  metadata.gz: a9f970443168e1a32a5bdb022ef5e74acedc5803
+  data.tar.gz: a247cfc9a807256e6f8003346d28c08ffb4c4b5a
 SHA512:
-  metadata.gz: ca1c7c4d1868b2d980c47dbab3cda9ec2fc9ec71101bcd591aa2f241f96acfe6fc9a95382cb120a8c0def0b8f2faa38095443fa3e3ca541f54fd557a9bd59fee
-  data.tar.gz: 5a39de22e1ec572862abf2c4d78e70b26c372a553b36c63c760e168c007daea6636dba1a2ffabe48f0f01a8c9f69d4f61e98b085d4085f3a9ff9834d481053f4
+  metadata.gz: 7b204d25fcbab4c785c7993d8fb65dade0369d73b10c27cbfbf39020a97020ac3809800148b2039bd586d268c9bac113ee26c755648763728dad23a6279eb438
+  data.tar.gz: e9c3c0dbb2a835e38ea9e970e0d561ecb41964f8d418522de45469c38e51193c81b3e464b42c9c495fb29d2feb96df23cb76cd6cc693cce81cc46259d74e989f

data/.travis.yml

@@ -7,5 +7,3 @@ rvm:
 matrix:
   allow_failures:
     - rvm: jruby-19mode
-
-script: rspec spec

data/README.md

@@ -2,7 +2,8 @@
 
 [![Build Status](https://travis-ci.org/neilmiddleton/attr_secure.png?branch=master)](https://travis-ci.org/neilmiddleton/attr_secure)
 
-Securely stores ActiveRecord attributes for a given model/attribute and a predefined secret.
+Securely stores attribute values for your Ruby objects.  Also supports Active
+Record and Sequel!
 
 ```
 ENV["ATTR_SECURE_SECRET"] = "MySuperSecretKeyThatCannotBeGuessed"

data/Rakefile

@@ -1,8 +1,10 @@
 require "bundler/gem_tasks"
-require "rake/testtask"
+require "rspec/core/rake_task"
 
-Rake::TestTask.new do |t|
-  t.libs.push "lib"
-  t.test_files = FileList['test/*_test.rb']
-  t.verbose = true
+RSpec::Core::RakeTask.new(:core) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--backtrace']
 end
+
+task(:default).clear
+task default: :core

data/attr_secure.gemspec

@@ -19,7 +19,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "activerecord"
+  spec.add_development_dependency "sequel"
+  spec.add_development_dependency "sqlite3"
 
   spec.add_dependency 'fernet'
-  spec.add_dependency 'activerecord',  ' ~> 3.2.0'
 end

data/lib/attr_secure.rb

@@ -1,24 +1,38 @@
 require "attr_secure/version"
 require 'fernet'
-require 'active_record'
 
-require 'attr_secure/secure'
+require 'attr_secure/adapters/ruby'
+require 'attr_secure/adapters/active_record'
+require 'attr_secure/adapters/sequel'
 
 Fernet::Configuration.run do |config|
   config.enforce_ttl = false
 end
 
 module AttrSecure
+  #
+  # All the available adapters.
+  # The order in this list matters, as only the first valid adapter will be used
+  #
+  ADAPTERS = [
+    AttrSecure::Adapters::Sequel,
+    AttrSecure::Adapters::ActiveRecord,
+    AttrSecure::Adapters::Ruby
+  ]
 
-  def attr_secure(attribute)
+  def attr_secure(attribute, encryption_class = Secure.new)
     define_method("#{attribute}=") do |value|
-      write_attribute(attribute, Secure.new.encrypt(value.nil? ? nil : value.to_sym))
+      encrypted_value = encryption_class.encrypt(value.nil? ? nil : value)
+      self.class.attr_secure_adapter.write_attribute self, attribute, encrypted_value
     end
 
     define_method("#{attribute}") do
-      Secure.new.decrypt read_attribute(attribute.to_sym)
+      encrypted_value = self.class.attr_secure_adapter.read_attribute(self, attribute)
+      encryption_class.decrypt encrypted_value
     end
   end
-end
 
-ActiveRecord::Base.send(:extend, AttrSecure)
+  def attr_secure_adapter
+    ADAPTERS.find {|a| a.valid?(self) }
+  end
+end

data/lib/attr_secure/adapters/active_record.rb

@@ -0,0 +1,24 @@
+require 'attr_secure/secure'
+
+module AttrSecure
+  module Adapters
+    module ActiveRecord
+
+      def self.valid?(object)
+        object.respond_to?(:<) && defined?(ActiveRecord) && object < ::ActiveRecord::Base
+      end
+
+      def self.write_attribute(object, attribute, value)
+        object.send :write_attribute, attribute, value
+      end
+
+      def self.read_attribute(object, attribute)
+        object.send :read_attribute, attribute.to_sym
+      end
+    end
+  end
+end
+
+if defined?(ActiveRecord)
+  ActiveRecord::Base.send(:extend, AttrSecure)
+end

data/lib/attr_secure/adapters/ruby.rb

@@ -0,0 +1,21 @@
+require 'attr_secure/secure'
+
+module AttrSecure
+  module Adapters
+    module Ruby
+
+      def self.valid?(object)
+        true
+      end
+
+      def self.write_attribute(object, attribute, value)
+        object.instance_variable_set "@#{attribute}", value
+      end
+
+      def self.read_attribute(object, attribute)
+        object.instance_variable_get "@#{attribute}"
+      end
+
+    end
+  end
+end

data/lib/attr_secure/adapters/sequel.rb

@@ -0,0 +1,24 @@
+require 'attr_secure/secure'
+
+module AttrSecure
+  module Adapters
+    module Sequel
+
+      def self.valid?(object)
+        object.respond_to?(:<) && defined?(Sequel) && object < ::Sequel::Model
+      end
+
+      def self.write_attribute(object, attribute, value)
+        object[attribute] = value
+      end
+
+      def self.read_attribute(object, attribute)
+        object[attribute]
+      end
+    end
+  end
+end
+
+if defined?(Sequel)
+  Sequel::Model.send(:extend, AttrSecure)
+end

data/lib/attr_secure/secure.rb

@@ -1,5 +1,10 @@
 module AttrSecure
   class Secure
+    attr_reader :env
+
+    def initialize(env=ENV)
+      @env = env
+    end
 
     def encrypt(value)
       Fernet.generate(attr_secure_secret) do |generator|
@@ -10,12 +15,12 @@ module AttrSecure
     def decrypt(value)
       return nil if value.nil?
       verifier = Fernet.verifier(attr_secure_secret, value)
-      verifier.data["value"] if verifier.valid?
+      verifier.data['value'] if verifier.valid?
     end
 
     private
     def env!(key)
-      ENV.fetch(key) { raise("Missing ENV(#{key})") }
+      env.fetch(key) { raise("Missing ENV(#{key})") }
     end
 
     def attr_secure_secret

data/lib/attr_secure/version.rb

@@ -1,3 +1,3 @@
 module AttrSecure
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/spec/adapters/active_record_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe AttrSecure::Adapters::ActiveRecord do
+  let(:described)   { Class.new(ActiveRecord::Base) }
+  subject           { described.new }
+  let(:secure_mock) { double(AttrSecure::Secure) }
+
+  before do
+    described.table_name = 'fake_database'
+    described.extend(AttrSecure)
+    described.attr_secure :title, secure_mock
+  end
+
+  it 'has active record as it\'s adapter' do
+    expect(described.attr_secure_adapter).to eq(AttrSecure::Adapters::ActiveRecord)
+  end
+
+  it 'encrypts' do
+    secure_mock.should_receive(:encrypt).with('hello').and_return('encrypted')
+    subject.title = 'hello'
+    expect(subject.attributes['title']).to eq('encrypted')
+  end
+
+  it 'decrypts' do
+    secure_mock.should_receive(:encrypt).with('hello').and_return('encrypted')
+    subject.title = 'hello'
+    secure_mock.should_receive(:decrypt).with('encrypted').and_return('decrypted')
+    expect(subject.title).to eq('decrypted')
+  end
+end

data/spec/adapters/ruby_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe AttrSecure::Adapters::Ruby do
+  let(:described)   { Class.new }
+  subject           { described.new }
+  let(:secure_mock) { double(AttrSecure::Secure) }
+
+  before do
+    described.extend(AttrSecure)
+    described.attr_secure :foo, secure_mock
+  end
+
+  it 'has ruby as it\'s adapter' do
+    expect(described.attr_secure_adapter).to eq(AttrSecure::Adapters::Ruby)
+  end
+
+  it 'encrypts' do
+    secure_mock.should_receive(:encrypt).with('hello').and_return('encrypted')
+    subject.foo = 'hello'
+    expect(subject.instance_variable_get(:@foo)).to eq('encrypted')
+  end
+
+  it 'decrypts' do
+    secure_mock.should_receive(:encrypt).with('hello').and_return('encrypted')
+    subject.foo = 'hello'
+    secure_mock.should_receive(:decrypt).with('encrypted').and_return('decrypted')
+    expect(subject.foo).to eq('decrypted')
+  end
+end

data/spec/adapters/sequel_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe AttrSecure::Adapters::Sequel do
+  let(:described)   { Class.new(Sequel::Model) }
+  subject           { described.new }
+  let(:secure_mock) { double(AttrSecure::Secure) }
+
+  before do
+    described.set_dataset(:fake_database)
+    described.extend(AttrSecure)
+    described.attr_secure :title, secure_mock
+  end
+
+  it 'has sequel as it\'s adapter' do
+    expect(described.attr_secure_adapter).to eq(AttrSecure::Adapters::Sequel)
+  end
+
+  it 'encrypts' do
+    secure_mock.should_receive(:encrypt).with('hello').and_return('encrypted')
+    subject.title = 'hello'
+    expect(subject.values[:title]).to eq('encrypted')
+  end
+
+  it 'decrypts' do
+    secure_mock.should_receive(:encrypt).with('hello').and_return('encrypted')
+    subject.title = 'hello'
+    secure_mock.should_receive(:decrypt).with('encrypted').and_return('decrypted')
+    expect(subject.title).to eq('decrypted')
+  end
+end

data/spec/secure_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe AttrSecure::Secure do
+  subject     { described_class.new({'ATTR_SECURE_SECRET' => token}) }
+  let(:token) { 'fWSvpC6Eh1/FFE1TUgXpcEzMmmGc9IZSqoexzEslzKI=' }
+
+  describe 'encrypt' do
+    it "should encrypt a string" do
+      expect(subject.encrypt('encrypted')).to be_a(String)
+      expect(subject.encrypt('encrypted')).to_not be_empty
+      expect(subject.encrypt('encrypted')).to_not eq(subject.encrypt('encrypted'))
+    end
+  end
+
+  describe 'decrypt' do
+    let(:encrypted_value) { subject.encrypt('decrypted') }
+
+    it "should decrypt a string" do
+      expect(subject.decrypt(encrypted_value)).to eq('decrypted')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
 require 'attr_secure'
 
+Dir['spec/support/**/*.rb'].sort.each { |path| load File.expand_path(path) }
+
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true

data/spec/support/load_active_record.rb

@@ -0,0 +1,11 @@
+require 'active_record'
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :fake_database, :force => true do |t|
+    t.string   :title
+    t.timestamps
+  end
+end

data/spec/support/load_sequel.rb

@@ -0,0 +1,8 @@
+require 'sequel'
+
+DB = Sequel.sqlite
+
+DB.create_table :fake_database do
+  primary_key :id
+  column :title, :string
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attr_secure
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Neil Middleton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-31 00:00:00.000000000 Z
+date: 2013-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -25,13 +25,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fernet
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -42,16 +42,58 @@ dependencies:
   name: activerecord
   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: sequel
+  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: 3.2.0
+        version: '0'
+- !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: fernet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '0'
 description: Securely stores activerecord model attributes
 email:
 - neil@neilmiddleton.com
@@ -67,10 +109,18 @@ files:
 - Rakefile
 - attr_secure.gemspec
 - lib/attr_secure.rb
+- lib/attr_secure/adapters/active_record.rb
+- lib/attr_secure/adapters/ruby.rb
+- lib/attr_secure/adapters/sequel.rb
 - lib/attr_secure/secure.rb
 - lib/attr_secure/version.rb
-- spec/attr_secure_spec.rb
+- spec/adapters/active_record_spec.rb
+- spec/adapters/ruby_spec.rb
+- spec/adapters/sequel_spec.rb
+- spec/secure_spec.rb
 - spec/spec_helper.rb
+- spec/support/load_active_record.rb
+- spec/support/load_sequel.rb
 homepage: http://www.neilmiddleton.com
 licenses:
 - MIT
@@ -96,5 +146,10 @@ signing_key:
 specification_version: 4
 summary: Securely stores activerecord model attributes
 test_files:
-- spec/attr_secure_spec.rb
+- spec/adapters/active_record_spec.rb
+- spec/adapters/ruby_spec.rb
+- spec/adapters/sequel_spec.rb
+- spec/secure_spec.rb
 - spec/spec_helper.rb
+- spec/support/load_active_record.rb
+- spec/support/load_sequel.rb

data/spec/attr_secure_spec.rb

@@ -1,52 +0,0 @@
-require 'spec_helper'
-
-class FakeModelWithSecureAttributes
-  extend AttrSecure
-  attr_accessor :attributes
-
-  attr_secure :foo
-
-  def initialize(attributes={})
-    @attributes = attributes
-  end
-
-  def read_attribute(attr_name)
-    attributes[attr_name]
-  end
-
-  def write_attribute(attr_name, value)
-    attributes[attr_name] = value
-  end
-end
-
-
-ENV['ATTR_SECURE_SECRET'] = 'xxx'
-
-describe AttrSecure do
-  subject { FakeModelWithSecureAttributes.new }
-
-  it 'encrypts' do
-    encrypter = lambda { |secret|
-      assert_equal 'xxx', secret
-      'world'
-    }
-
-    Fernet.stub :generate, encrypter do |f|
-      subject.foo = 'hello'
-      expect(subject.attributes[:foo]).to eq('world')
-    end
-  end
-
-  it 'decrypts' do
-    decrypter_mock = double(Object)
-    decrypter_mock.stub(:valid?) { true }
-    decrypter_mock.stub(:data) { {'value' => 'world'} }
-
-    Fernet.stub(:generate, 'world') do
-      Fernet.stub(:verifier, decrypter_mock) do
-        subject.foo = 'hello'
-        expect(subject.foo).to eq('world')
-      end
-    end
-  end
-end