nygma 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: acc48b911647b3e575f9d15bc388b76b4115064c
-  data.tar.gz: cb9602eb62ff7b33bc1259725b206614ac67cc5f
+  metadata.gz: 2bf1c9281ff6a3733b9a06256a721bd7fe55abbc
+  data.tar.gz: 1a9b75337c2f6edc711baf911cfbeb1c6562a0e9
 SHA512:
-  metadata.gz: 9d70af21e6c4f5ceab6c2d170dc411239f2fe2d3ddda89ac19477be8d396e42ab7b206fce6e99a43c8d6175afff1c9b7bcbc8548a51420f34b7bdd073c13ff3c
-  data.tar.gz: 1c9669eb3315bb23a35e2ffd6158a7b91e661586799acf35d4953e7fae36ad46b920198348f09045710b5d975248525423ee850fbfe6c314d4eb92ceb61d98cf
+  metadata.gz: 99ad951ab5386e8f0aa53c53f91c67bdc9961162d730f9f6129d1626c18cfe583c4b29e16a47537bdea7c64bcf08564b5534206947d510e09b1fb0b6f5a48506
+  data.tar.gz: 28ba8583f924066710ec0b89da00e0c7498f22a39d58dfceb223a52cbdf5922aa91fc32d6f452b8df85d3e69d24fd47eab4d54d6809f97956cbfc0fc17650be0

data/README.md

@@ -2,15 +2,42 @@
 
 [![Build Status](https://travis-ci.org/bsodmike/Nygma.svg?branch=master)](https://travis-ci.org/bsodmike/Nygma)
 
-Gotham's very own Mr. Nygma, a Rails 4 Encryptor
+Gotham's very own Mr. Nygma, a Rails 4.2 attribute Encryptor
 
 ## Compatibility
 
-* Supports Ruby 1.9.3 and 2.
-* Travis CI for Ruby 1.9.3, 2.0.0, 2.1.0, and 2.1.5
+* Requires Ruby 2
+* Travis CI for 2.0.0, 2.1.0, and 2.2.2
 
 ## Usage
 
+Add Nygma to your Gemfile and an initialiser to your Rails app, generating the
+key and salt with `SecureRandom.hex(40)` and `SecureRandom.random_bytes(64)`.
+
+```ruby
+# config/initializers/nygma.rb
+
+Rails.application.config.encryptor = Nygma::Encryptor.crypt!(
+  'f46c1fb228aac44e55f82293a2341fb47c6f12c3721382ae7dbfe2e912941f59191efbc711f1ea5e',
+  '[d\x89\r\xF6\xEB7\x9C\n\x1F+\xCAG\xF1g\e\x9Bg\xA7-:iG\b4\x03\xED\xCE\x8F>OH\b\x80\x8F\xE3\x17j\x1D\xA6\b?3\xC4\xE4\x8D\x9Eb\xA5\xB0\xB6jS\xAD\v\xE4\xBB\xDB\xF7\xFC\xBC\x04\xFD\xE4'
+)
+```
+
+You will now be able to specify attributes within your models that need
+attribute level encryption,
+
+```ruby
+class POTUSNuclearCode < ActiveRecord::Base
+  encrypt :launch_code, :auth_token
+end
+```
+
+The world is now safe as the Chinese won't be able to grab US nuclear launch
+codes from Hillary's email account!  They'll be nicely encrypted and
+persisted to disk.
+
+### How it works
+
 ```ruby
 crypt = Nygma::Encryptor.crypt!(
   Nygma::Configuration.secure_key,

data/Rakefile

@@ -1,3 +1,4 @@
+#!/usr/bin/env rake
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -14,8 +15,18 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
 
+Bundler::GemHelper.install_tasks
 
+require 'rspec/core'
+require 'rspec/core/rake_task'
 
-Bundler::GemHelper.install_tasks
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  # spec.rspec_opts = ['-cfs --backtrace']
+end
 
+task :default => :spec

data/db/migrate/20150630040253_create_encryptable_test_models.rb

@@ -0,0 +1,8 @@
+class CreateEncryptableTestModels < ActiveRecord::Migration
+  def change
+    create_table :encryptable_test_models do |t|
+      t.string :token
+      t.string :reference
+    end
+  end
+end

data/lib/nygma/encryptable.rb

@@ -0,0 +1,56 @@
+module Nygma
+
+  module Encryptable
+
+    class << self
+      def included _klass
+        _klass.class_eval do
+          include InstanceMethods
+          extend ClassMethods
+        end
+      end
+    end
+
+    module InstanceMethods
+
+      protected
+      def encryptor
+        Rails.application.config.encryptor
+      end
+
+    end
+
+    module ClassMethods
+
+      def encrypt(*args)
+        args.each do |attribute|
+          unless has_column?(attribute)
+            Rails.logger.tagged('Nygma::Encryptable::encrypt') {
+              Rails.logger.info "Unable to encrypt missing attribute #{attribute} in #{self.name}, check your migrations!"
+            }
+          else
+            attr = "#{attribute}"
+
+            define_method("#{attr}") do
+              encryptor.decrypt(self[attribute]) if self[attribute]
+            end
+
+            define_method("#{attr}=") do |val|
+              encrypted_payload = encryptor.encrypt(val)
+              self[attribute] = encrypted_payload if encrypted_payload
+            end
+          end
+        end
+      end
+
+      private
+      def has_column?(attribute)
+        return true if self.column_names.include?(attribute.to_s)
+
+        false
+      end
+
+    end
+  end
+
+end

data/lib/nygma/engine.rb

@@ -1,5 +1,9 @@
 module Nygma
   class Engine < ::Rails::Engine
     isolate_namespace Nygma
+
+    config.before_initialize do
+      ::ActiveRecord::Base.send(:include, Encryptable)
+    end
   end
 end

data/lib/nygma/version.rb

@@ -1,3 +1,3 @@
 module Nygma
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/nygma.rb

@@ -3,5 +3,7 @@ require 'nygma/engine'
 require 'nygma/configuration'
 
 module Nygma
+  require 'nygma/encryptable'
+
   autoload :Encryptor,      'nygma/encryptor'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nygma
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Michael de Silva
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-09 00:00:00.000000000 Z
+date: 2015-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.8
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.8
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: attr_extras
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: pry-byebug
+  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: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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: fuubar
   requirement: !ruby/object:Gem::Requirement
@@ -146,8 +188,10 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- db/migrate/20150630040253_create_encryptable_test_models.rb
 - lib/nygma.rb
 - lib/nygma/configuration.rb
+- lib/nygma/encryptable.rb
 - lib/nygma/encryptor.rb
 - lib/nygma/engine.rb
 - lib/nygma/version.rb
@@ -162,9 +206,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -172,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Gotham's very own Mr. Nygma, a Rails 4 Encryptor