tiny-redis 0.0.6 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 296d4a807a3c3b5e48431861ee59db71ab270deb37010204277a7bd6935d3417
-  data.tar.gz: b8df4e1e70c27b9c3e16855f6aed442c382fe08f01151de7167bb6ac136bd417
+  metadata.gz: 8c236e078a3ad9d288d914e7d5fc619e96f4433cef270f98b855a2386fcf5d36
+  data.tar.gz: 9338b6fe43cb44d45fcedc9a467dcc084c20c54cf5725db638fc1d9b7e40dace
 SHA512:
-  metadata.gz: 58e6454be3bd2c63fc2044e9b28a1ced1612eef0f23126936b95e0228a667c8860b50fa12a667125dfa8b69663e70f5b24c7d48d8df8ede8d52a7d57ac40ef88
-  data.tar.gz: 7b0a4758ced66d46eae7a477b10aceb582f54afc2716bca057aadf61c64f65c8cc9ed44800ec881e165aaddd2356a6f64149c6212430b783993a51f44a9cb4b8
+  metadata.gz: 645f66c4ef3977ba17641e754df5b073b626a0e619343a0fac6375dd80effc93d2e4e424b6e6307dc05de018f4a9976783a33a54cd96755212b4297ec86663a0
+  data.tar.gz: c477d52f392bf03bbbdf36fe06bb9e8219bfd89151a53995232c7de5da1c452741f1e1ec18db32ab8658785300d5f491a5ad5c48103d9543df226b8f5d8660a7

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Pavel Zaitsev
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+### tiny-redis
+
+Tiny Redis - encrypted barebones JSON formatted orm.
+Encryption is Rails Credentials based.
+
+Steps to use:
+```
+   add to Gemfile:
+   gem 'tiny-redis'
+
+   bundle install
+
+   rails g tiny_redis
+
+   this will install initalizer that creates a pool of redis connections
+```
+
+## How to use
+
+```
+   class User
+   include Tiny::Redis
+
+   attr_accessor :email
+   alias_method :index, :email # this will tie your records method to indexing parameter
+   end
+```
+Set up credentials:
+```
+   rails credentials:edit --environment development
+
+   add:
+   user:
+     encryptkey: abcdabcdabcdadbvabcdabcdabcdadbv
+```
+
+Now your records in redis are encrypted. If you wish for more security you can remove config/master.key after server starts. And investigate SE Linux address space protection so hacker can't pry encryption key from the app so easily.
+
+Have fun! 🎉

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Tiny::Redis'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/tasks/tiny/redis_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :tiny_redis do
+#   # Task goes here
+# end

data/lib/tiny/redis.rb

@@ -0,0 +1,53 @@
+require "tiny/redis/railtie"
+require 'redis'
+require 'connection_pool'
+
+module Tiny
+  module Redis
+
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    def save(filter)
+      key, crypt = self.class.setup(index)
+
+      $redis.with do |r|
+        r.set(key, crypt.encrypt_and_sign(self.to_json(except: filter)))
+      end
+    end
+
+    module ClassMethods
+      def load(index)
+        key, crypt = setup(index)
+
+        $redis.with do |r|
+          encrypted = r.get(key)
+          return nil if encrypted.nil?
+          JSON.parse(crypt.decrypt_and_verify(encrypted), object_class: self)
+        end
+      end
+
+      def setup(index)
+        key = Digest::SHA1.hexdigest(index)
+        encrypt_key = Rails.application.credentials.user[:encryptkey]
+        crypt = ActiveSupport::MessageEncryptor.new(encrypt_key)
+        return [key, crypt]
+      end
+    end
+
+    attr_accessor   :errors
+    def initialize(params = {})
+      @errors = ActiveModel::Errors.new(self)
+
+      params.present? && params.each do |k,v|
+        self[k] = v
+      end
+    end
+
+    def []=(key, value)
+      return if key == 'errors' # PATCH if error sneaks in, ruins whole validation process
+      send("#{key}=", value)
+    end
+  end
+end

data/lib/tiny/redis/railtie.rb

@@ -0,0 +1,6 @@
+module Tiny
+  module Redis
+    class Railtie < ::Rails::Railtie
+    end
+  end
+end

data/lib/tiny/redis/version.rb

@@ -0,0 +1,5 @@
+module Tiny
+  module Redis
+    VERSION = '0.0.11'
+  end
+end

metadata

@@ -1,69 +1,81 @@
 --- !ruby/object:Gem::Specification
 name: tiny-redis
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.11
 platform: ruby
 authors:
 - Pavel Zaitsev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-25 00:00:00.000000000 Z
+date: 2020-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activemodel
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 6.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 6.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.2
 - !ruby/object:Gem::Dependency
-  name: connection_pool
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.3
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.3
+        version: '4.2'
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: connection_pool
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: 2.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
-description: tiny opinionated ORM for model objects, encryption provided.
-email: pavel@arslogi.ca
+        version: 2.2.3
+description: Encrypted Redis ORM for rails, active record style
+email:
+- pavel@arslogi.ca
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/tiny-redis.rb
-homepage: http://blog.arslogi.ca/tiny-redis
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/tasks/tiny/redis_tasks.rake
+- lib/tiny/redis.rb
+- lib/tiny/redis/railtie.rb
+- lib/tiny/redis/version.rb
+homepage: https://blog.arslogi.ca/
 licenses:
 - MIT
-metadata:
-  source_code_uri: https://github.com/pavelz/tiny-redis
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -82,5 +94,5 @@ requirements: []
 rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
-summary: tiny redis encrypted orm
+summary: encrypted redis orm
 test_files: []

data/lib/tiny-redis.rb

@@ -1,50 +0,0 @@
-require 'connection_pool'
-require 'redis'
-
-module TinyRedis
-  def self.included(klass)
-    klass.extend(ClassMethods)
-  end
-
-  def save(filter)
-    key, crypt = self.class.setup(index)
-
-    $redis.with do |r|
-      r.set(key, crypt.encrypt_and_sign(self.to_json(except: filter)))
-    end
-  end
-
-  module ClassMethods
-    def load(index)
-      key, crypt = setup(index)
-
-      $redis.with do |r|
-        encrypted = r.get(key)
-        return nil if encrypted.nil?
-        JSON.parse(crypt.decrypt_and_verify(encrypted), object_class: self)
-      end
-    end
-
-    def setup(index)
-      key = Digest::SHA1.hexdigest(index)
-      encrypt_key = Rails.application.credentials.user[:encryptkey]
-      crypt = ActiveSupport::MessageEncryptor.new(encrypt_key)
-      return [key, crypt]
-    end
-  end
-
-  attr_accessor   :errors
-  def initialize(params = {})
-    @errors = ActiveModel::Errors.new(self)
-
-    params.present? && params.each do |k,v|
-      self[k] = v
-    end
-  end
-
-  def []=(key, value)
-    return if key == 'errors' # PATCH if error sneaks in, ruins whole validation process
-    send("#{key}=", value)
-  end
-end
-