redis_app_join 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 443ea24957f1e3e8ea260db70ac1206aefee6be9
+  data.tar.gz: be5d4b45715e15ef856fb3bd3ce0f92fc183baff
+SHA512:
+  metadata.gz: 3c649246ab9a2770fd5570877bc5490aafe8b86d7880f192a5bc4a5ddbb7d00d0fcf134e035a1ef16e7e1db6d5d231892ba7272d8b3fd56fbd801bd4b584ac1a
+  data.tar.gz: 8c747b2de354770ebb916a23a75e51b5a078b48b56cea9ac866971591b036b34a4c3ec75cd171be00269f08eedca35934d08bde93a4f514d7ccd92402e57f80a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redis_app_join.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Dmitry Polyakovsky
+
+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,112 @@
+# RedisAppJoin
+
+Sometimes we need to implement application level joins.  It is easy to query User table and get list of user_ids and then query the child record table for records that belong to those users.  But what if we need to combine data attributes from both tables?  This can also be a use case when querying mutliple databases or 3rd party APIs.  
+
+You can use Redis Hashes as a place to cache data needed as you are looping through records.  Warning - this is ALPHA quality software, be careful before running it in production.  
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redis_app_join'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis_app_join
+
+## Usage
+
+Create config/initializers/redis_app_join.rb or place this in environment specific config file.  You can use a different namespace, DB, driver, etc.  
+
+```ruby
+redis_conn = Redis.new(host: 'localhost', port: 6379, db: 0)
+REDIS_APP_JOIN = Redis::Namespace.new(:appjoin, redis: redis_conn)
+```
+
+In the Ruby class where you need to implement application-side join add `include RedisAppJoin`.  Here is a sample report generator that will produce a report of comments created since yesterday and include associated article title and name of user who wrote the article.
+
+```ruby
+class ReportGen
+include RedisAppJoin
+  def perform
+    comments = Comment.gte(created_at: Date.yesterday).only(:body, :article_id)
+    cache_records(records: comments)
+    comment_ids = comments.pluck(:id)
+    # =>
+    # => we also could have done  comments.pluck(:article_id)
+    article_ids = fetch_records_field(record_class: 'Comment', record_ids: comment_ids, field: 'article_id')
+    articles = Article.in(id: article_ids).only(:title, :user_id)
+    cache_records(records: articles)
+    # =>
+    user_ids = fetch_records_field(record_class: 'Article', record_ids: article_ids, field: 'user_id')
+    users = User.in(id: user_ids).only(:name)
+    cache_records(records: users)
+    # => instead of using cached comments we just query DB again
+    cached_comments = fetch_records(record_class: 'Comment', record_ids: comment_ids)
+    cached_comments.each do |comment|
+      article = fetch_records(record_class: 'Article', record_ids: [comment.article_id]).first
+      user = fetch_records(record_class: 'User', record_ids: [article.user_id]).first
+      puts [comment.body, article.title, user.name].join(',')
+    end
+    delete_records(records: comments + articles + users)
+  end
+end
+```
+
+`cache_records` expects an array of [ActiveModels](http://api.rubyonrails.org/classes/ActiveModel/Model.html).  It will loop through them creating keys using combination of class and ID.  Hash value will be record's attributes.  
+
+`delete_records` expects an array ActiveModels.  You can pass different types of records (users and articles) in the same method call.  
+
+`fetch_records` expects class name and array of IDs.  It will return an array of objects and include the original record ID as one of the attributes for each object.  
+
+`fetch_records_field` expects class name, array of IDs and the field name you want.  It will return an array of values for that feild.
+
+Data in Redis will be stored like this:
+
+```ruby
+{"db":0,"key":"appjoin:Comment:id1","ttl":-1,"type":"hash","value":{"body":"body 1","article_id":"id1"},...}
+{"db":0,"key":"appjoin:Comment:id2","ttl":-1,"type":"hash","value":{"body":"body 2","article_id":"id2"},...}
+...
+{"db":0,"key":"appjoin:Article:id1","ttl":-1,"type":"hash","value":{"title":"title 1","user_id":"id1"},...}
+{"db":0,"key":"appjoin:Article:id2","ttl":-1,"type":"hash","value":{"title":"title 2","user_id":"id2"},...}
+...
+{"db":0,"key":"appjoin:User:id1","ttl":-1,"type":"hash","value":{"name":"user 1"}, ...}
+{"db":0,"key":"appjoin:User:id2","ttl":-1,"type":"hash","value":{"name":"user 2"}, ...}
+```
+
+Comment, Article and User records will be returned like this.  
+
+```ruby
+# comment
+<OpenStruct article_id="id1", body="body 1", id="id1">
+# article
+<OpenStruct user_id="id1", title="title 1", id="id1">
+# user
+<OpenStruct name="user 1", id="id1">
+```
+
+You can do `article.title` and `user = fetch_records(record_class: 'User', record_ids: [article.user_id]).first`.
+
+### TODO:
+
+Write tests
+
+Support non-string fields.  For example, if your DB supports array fields you cannot store those attributes in Redis hash values.  
+
+Methods to fetch associated records so we can do `article.user.name` from Redis cache.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dmitrypol/redis_app_join.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redis_app_join"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/redis_app_join/version.rb

@@ -0,0 +1,3 @@
+module RedisAppJoin
+  VERSION = "0.1.0"
+end

data/lib/redis_app_join.rb

@@ -0,0 +1,41 @@
+require "redis_app_join/version"
+
+module RedisAppJoin
+
+  def cache_records(records:)
+    records.each do |record|
+      key = [record.class.name, record.id.to_s].join(':')
+      data = record.attributes.except(:_id, :id)
+      REDIS_APP_JOIN.mapped_hmset(key, data)
+    end
+  end
+
+  def delete_records(records:)
+    records.each do |record|
+      key = [record.class.name, record.id.to_s].join(':')
+      REDIS_APP_JOIN.del(key)
+    end
+  end
+
+  def fetch_records(record_class:, record_ids:)
+    output = []
+    record_ids.each do |record_id|
+      key = [record_class.titleize, record_id.to_s].join(':')
+      data = REDIS_APP_JOIN.hgetall(key)
+      # => add the key as ID attribute
+      output << OpenStruct.new(data.merge(id: record_id.to_s))
+    end
+    return output
+  end
+
+  def fetch_records_field(record_class:, record_ids:, field:)
+    output = []
+    record_ids.each do |record_id|
+      key = [record_class.titleize, record_id.to_s].join(':')
+      data = REDIS_APP_JOIN.hget(key, field)
+      output << data
+    end
+    return output
+  end
+
+end

data/redis_app_join.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis_app_join/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis_app_join"
+  spec.version       = RedisAppJoin::VERSION
+  spec.authors       = ["Dmitry Polyakovsky"]
+  spec.email         = ["dmitrypol@gmail.com"]
+
+  spec.summary       = %q{Uses Redis to cache data for application-side joins.}
+  spec.description   = %q{Instead of building your own data structures why not use Redis Hashes.}
+  spec.homepage      = "https://github.com/dmitrypol/redis_app_join"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    #spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  # =>
+  spec.add_development_dependency 'mock_redis', '~> 0.17', '>= 0.17.0'
+  # =>
+  spec.add_runtime_dependency 'redis', '~> 3.3'
+  spec.add_runtime_dependency 'redis-namespace', '~> 1.5'
+  spec.add_runtime_dependency 'readthis', '~> 1.3', '>= 1.3.0'
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: redis_app_join
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dmitry Polyakovsky
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mock_redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: readthis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+description: Instead of building your own data structures why not use Redis Hashes.
+email:
+- dmitrypol@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/redis_app_join.rb
+- lib/redis_app_join/version.rb
+- redis_app_join.gemspec
+homepage: https://github.com/dmitrypol/redis_app_join
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Uses Redis to cache data for application-side joins.
+test_files: []