action_cable_subscription_adapter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b38df6d29fc33495126ec7614d44ad2b8eca70a0
+  data.tar.gz: dc2950a586cbf0fba78d81a5e1d93656295ca39c
+SHA512:
+  metadata.gz: 8e4e5588be6327eb1fe1718f7c73ce3e0471e1c013b79fa06b046d898d22086e4c957c6fe61a448f73e842915d6e7e5d5414b0ede3b321bd3a1c23bb8ddda0ce
+  data.tar.gz: a7931494a08942917aeef316f4890d03cb239eb812634da2facff6bbc23c8c549fe6dd5911fae8c81305bdd454d194317dfc555bd8548415e77d95c4da2f0d87

data/.gitignore

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,56 @@
+# ActionCableSubscriptionAdapter
+
+Implements a configuration option that allows you to inject a custom configurable Redis client
+For ActionCable to use in its SubscriptionAdapter. This is useful if you use something like Redis::Namespace
+Which needs to be configured with a Redis URL and Namespace name usually coming from ENV vars. Rail's `cable.yml` is insufficient for this because it doesn't allow configuration of the Redis client.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'action_cable_subscription_adapter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install action_cable_subscription_adapter
+
+## Usage
+
+Inject a custom Redis client used by the ActionCable::SubscriptionAdapter
+Example:
+
+```ruby
+# config/initializers/action_cable_subscription_adapter.rb
+
+ActionCableSubscriptionAdapter.config do |c|
+  c.redis_connector = MyRedisClient.new your: "options"
+end
+```
+
+You can also pass a block that will run when the ActionCable workers are initialized:
+
+```ruby
+ActionCableSubscriptionAdapter.config do |c|
+  c.redis_connector = ->(subscription_adapter) { 
+    MyRedisClient.new your: "options"
+  }
+end
+```
+
+The custom Redis client needs to conform to the [Redis](https://github.com/redis/redis-rb) gem's API.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/DiegoSalazar/action_cable_subscription_adapter.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/action_cable_subscription_adapter.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'action_cable_subscription_adapter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "action_cable_subscription_adapter"
+  spec.version       = ActionCableSubscriptionAdapter::VERSION
+  spec.authors       = ["Diego Salazar"]
+  spec.email         = ["diego@greyrobot.com"]
+
+  spec.summary       = %q{Custom Subscription adapter to inject a redis_connector for ActionCable}
+  spec.description   = %q{Implements a SubscriptionAdapter for ActionCable which uses a configurable Redis client.}
+  spec.homepage      = "https://github.com/DiegoSalazar/action_cable_subscription_adapter"
+
+  # 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'] = "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"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "action_cable_subscription_adapter"
+
+# 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/action_cable/subscription_adapter/custom_adapter.rb

@@ -0,0 +1,10 @@
+require "action_cable/subscription_adapter/redis"
+
+# Override ActionCable's Redis adapter to use a configurable adapter
+module ActionCable::SubscriptionAdapter
+  class CustomAdapter < Redis
+    def redis_connector
+      ActionCableSubscriptionAdapter.redis_connector.call self
+    end
+  end  
+end

data/lib/action_cable_subscription_adapter.rb

@@ -0,0 +1,27 @@
+require "action_cable_subscription_adapter/version"
+require "action_cable/subscription_adapter/custom_adapter.rb"
+
+module ActionCableSubscriptionAdapter
+  # Inject a custom Redis client used by the ActionCable::SubscriptionAdapter
+  # Example:
+  # 
+  # ActionCableSubscriptionAdapter.config do |c|
+  #   c.redis_connector = MyRedisClient.new
+  # end
+  #
+  # You can also pass a block that will run when the ActionCable workers are initialized:
+  #
+  # ActionCableSubscriptionAdapter.config do |c|
+  #   c.redis_connector = ->(subscription_adapter) { MyRedisClient.new }
+  # end
+  #
+  # The custom Redis client needs to conform to the Redis gem's API.
+  #
+  mattr_accessor :redis_connector
+
+  def self.config(&block)
+    block.call self
+    @redis_connector = ->(s) { @redis_connector } unless @redis_connector.respond_to? :call
+    self
+  end
+end

data/lib/action_cable_subscription_adapter/version.rb

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

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: action_cable_subscription_adapter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Diego Salazar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-23 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'
+description: Implements a SubscriptionAdapter for ActionCable which uses a configurable
+  Redis client.
+email:
+- diego@greyrobot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- action_cable_subscription_adapter.gemspec
+- bin/console
+- bin/setup
+- lib/action_cable/subscription_adapter/custom_adapter.rb
+- lib/action_cable_subscription_adapter.rb
+- lib/action_cable_subscription_adapter/version.rb
+homepage: https://github.com/DiegoSalazar/action_cable_subscription_adapter
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Custom Subscription adapter to inject a redis_connector for ActionCable
+test_files: []