couch_potato-extensions 0.0.1

data/README.md

@@ -0,0 +1,33 @@
+Some additions/extensions to CouchPotato, because awesome needs more awesome.
+
+### Encrypted attributes
+
+A simple way to encrypt specific attributes with a specific password and salt.
+Each attribute can be encrypted differently, by specifying password and salt
+when declaring them.
+
+    require 'couch_potato'
+    require 'couch_potato/extensions'
+    
+    class User
+      include CouchPotato::Persistence
+      include CouchPotato::Extensions::Encryption
+      encrypted\_property :email, :password => "your mum", :salt => "your dad"
+    end
+
+Of course what's the point if you can't query that stuff? Fret not, help is near:
+
+    class User
+      view :by_email, :key => :email, :type => CouchPotato::Extensions::EncryptedViewSpec
+    end
+    
+    CouchPotato.database.view(User.by_email(:key => "paul@example.com"))
+
+Easy as pie!
+
+Speaking of easy, so far it's both very simple, because that's what I need, only views
+with one key are supported so far.
+
+License: MIT baby!
+
+Sponsored by [Peritor](http://peritor.com)

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['spec/*_spec.rb']
+end
+
+NAME='couch_potato-extensions'
+
+def gemspec_file
+  "#{NAME}.gemspec"
+end
+
+def gem_file
+  "#{NAME}-#{source_version}.gem"
+end
+
+def source_version
+  line = File.read("lib/#{NAME.gsub(/-/, "/")}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+task :build do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end

data/lib/couch_potato/extensions.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.dirname(__FILE__) + "/extensions/persistence")
+require File.expand_path(File.dirname(__FILE__) + "/extensions/encryption")
+require File.expand_path(File.dirname(__FILE__) + "/extensions/encrypted_property")
+require File.expand_path(File.dirname(__FILE__) + "/extensions/encrypted_view_spec")
+
+module CouchPotato
+  module Extensions
+    VERSION = '0.0.1'
+  end
+end

data/lib/couch_potato/extensions/encrypted_property.rb

@@ -0,0 +1,46 @@
+require 'bcrypt'
+
+module CouchPotato
+  module Extensions
+    class EncryptedProperty
+      attr_reader :type, :name
+      
+      def initialize(owner, name, options = {})
+        @type = owner
+        @name = name
+        @options = options
+        
+        define_accessors(name)
+      end
+      
+      def define_accessors(name)
+        type.class_eval do
+          define_method(name) do
+            instance_variable_get("@#{name}")
+          end
+          
+          define_method("#{name}=") do |value|
+            instance_variable_set("@#{name}", value)
+          end
+        end
+      end
+
+      def build(object, json)
+        value = json[name.to_s].nil? ? json[name.to_sym] : json[name.to_s]
+        object.send "#{name}=", decrypt(value)
+      end
+
+      def serialize(json, object)
+        json[name] = encrypt(object.send(name))
+      end
+      
+      def encrypt(value)
+        Base64.encode64(EzCrypto::Key.encrypt_with_password(@options[:password], @options[:salt], value))
+      end
+      
+      def decrypt(value)
+        EzCrypto::Key.decrypt_with_password(@options[:password], @options[:salt], Base64.decode64(value))
+      end
+    end
+  end
+end

data/lib/couch_potato/extensions/encrypted_view_spec.rb

@@ -0,0 +1,20 @@
+module CouchPotato
+  module Extensions
+    class EncryptedViewSpec < CouchPotato::View::ModelViewSpec
+      
+      def view_parameters
+        parameters = super
+        if parameters[:key]
+          parameters[:key] = find_and_encrypt_key_attribute(parameters[:key])
+        end
+        parameters
+      end
+      
+      def find_and_encrypt_key_attribute(key)
+        property = klass.properties.find{|property| property.name.to_s == options[:key].to_s}
+        return key if not property
+        property.encrypt(key)
+      end
+    end
+  end
+end

data/lib/couch_potato/extensions/encryption.rb

@@ -0,0 +1,15 @@
+require 'ezcrypto'
+
+module CouchPotato
+  module Extensions
+    module Encryption
+      def self.included(base)
+        base.instance_eval do
+          def encrypted_property(name, options = {})
+            properties << CouchPotato::Extensions::EncryptedProperty.new(self, name, options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/couch_potato/extensions/persistence.rb

@@ -0,0 +1,10 @@
+module CouchPotato
+  module Persistence
+    def attributes
+      self.class.properties.inject({}) do |result, property|
+        result[property.name] = send(property.name)
+        result
+      end
+    end
+  end
+end

data/spec/encrypted_property_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe CouchPotato::Extensions::EncryptedProperty do
+  class SecureDocument
+    include CouchPotato::Persistence
+    include CouchPotato::Extensions::Encryption
+    encrypted_property :body, :salt => 'Va7JYeT7t08vMweYU6F6dO', :password => "coffee! more coffee!"
+  end
+  
+  describe "setting up" do
+    it "should add the declared property to the internal list" do
+      SecureDocument.properties.find()
+    end
+  end
+  
+  describe "accessing attributes" do
+    it "should add attribute accessors" do
+      document = SecureDocument.new
+      document.respond_to?(:body).should == true
+      document.respond_to?(:body=).should == true
+    end
+    
+    it "should set the attribute" do
+      document = SecureDocument.new(:body => "very important")
+      document.body.should == 'very important'
+    end
+  end
+  
+  describe "saving documents" do
+    let(:document) { SecureDocument.new(:body => "very important") }
+
+    it "should encrypt the property when accessing the document hash" do
+      body = document.to_hash[:body]
+      body.should_not == nil
+      body.should_not == 'very important'
+      body.should == Base64.encode64(EzCrypto::Key.encrypt_with_password("coffee! more coffee!", "Va7JYeT7t08vMweYU6F6dO", "very important"))
+    end
+  end
+  
+  describe "loading documents" do
+    let(:document) { SecureDocument.new(:body => "very important") } 
+    
+    it "should decrypt the attributes" do
+      CouchPotato.database.save_document document
+      loaded_document = CouchPotato.database.load_document(document.id)
+      loaded_document.body.should == "very important"
+    end
+  end
+end

data/spec/encrypted_view_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe CouchPotato::Extensions::EncryptedViewSpec do
+  class SecureUser
+    include CouchPotato::Persistence
+    include CouchPotato::Extensions::Encryption
+    encrypted_property :email, :salt => 'Va7JYeT7t08vMweYU6F6dO', :password => "coffee! more coffee!"
+    
+    view :by_email, :key => :email, :type => CouchPotato::Extensions::EncryptedViewSpec
+  end
+  
+  before(:each) do
+    @encrypted_email = Base64.encode64(EzCrypto::Key.encrypt_with_password("coffee! more coffee!", "Va7JYeT7t08vMweYU6F6dO", "paul@example.com"))
+  end
+  
+  let(:user) do
+    user = SecureUser.new(:email => "paul@example.com")
+    CouchPotato.database.save_document(user)
+    user
+  end
+  
+  it "should encrypt the key before running the view" do
+    CouchPotato.database.send(:database).should_receive(:view) do |url, parameters|
+      parameters[:key].should == @encrypted_email
+      {"rows" => {}}
+    end
+    
+    CouchPotato.database.view(SecureUser.by_email(:key => 'paul@example.com'))
+  end
+  
+  it "should find documents with an encrypted email" do
+    user
+    results = CouchPotato.database.view(SecureUser.by_email(:key => 'paul@example.com'))
+    results.first.should == user
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'spec'
+require 'couch_potato'
+
+$:.unshift(File.expand_path(File.dirname(__FILE__) + "../lib"))
+
+CouchPotato::Config.database_name = 'couch_potato-extentions_test'
+def recreate_db
+  CouchPotato.couchrest_database.recreate!
+end
+recreate_db
+
+
+require 'couch_potato/extensions/encryption'
+require 'couch_potato/extensions/encrypted_property'
+require 'couch_potato/extensions/persistence'
+require 'couch_potato/extensions/encrypted_view_spec'

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: couch_potato-extensions
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mathias Meyer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-12 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: couch_potato
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ezcrypto
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id003
+description: See summary, it says it all, trust me.
+email: meyer@paperplanes.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- Rakefile
+- lib/couch_potato/extensions/encrypted_property.rb
+- lib/couch_potato/extensions/encrypted_view_spec.rb
+- lib/couch_potato/extensions/encryption.rb
+- lib/couch_potato/extensions/persistence.rb
+- lib/couch_potato/extensions.rb
+- spec/encrypted_property_spec.rb
+- spec/encrypted_view_spec.rb
+- spec/spec_helper.rb
+- README.md
+has_rdoc: true
+homepage: http://github.com/mattmatt/couch_potato-extensions
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Some extensions for CouchPotato, because more awesome is always a good thing.
+test_files: []
+