anycable-rails 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 218059069aaa5214163627a02b564b9ac4f7ba97
+  data.tar.gz: 4795bab0ed2c7bda51e3811137367baa1ea68bc0
+SHA512:
+  metadata.gz: 620b6586feff596ecadcc9925ebcd8cd855c5e8618e3b7ac5393f82a7cfcbed6f2d153c6f3f6d22aa10374af69c1a2af8f460a1d7bafd8cfcb7914052806d762
+  data.tar.gz: 4783e84e750153b4747b0f5d5c216cf4fe1bc4d50925fb410702499df5236c54c2cc81cc573e66447ea37dcc9052b561a768476291ea923c23e34cfdf894b5d2

data/.gitignore

@@ -0,0 +1,40 @@
+# Numerous always-ignore extensions
+*.diff
+*.err
+*.orig
+*.log
+*.rej
+*.swo
+*.swp
+*.vi
+*~
+*.sass-cache
+*.iml
+.idea/
+
+# Sublime
+*.sublime-project
+*.sublime-workspace
+
+# OS or Editor folders
+.DS_Store
+.cache
+.project
+.settings
+.tmproj
+Thumbs.db
+
+.bundle/
+log/*.log
+*.gz
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/tmp/
+
+Gemfile.lock
+Gemfile.local
+.rspec
+*.gem
+tmp/
+coverage/

data/.hound.yml

@@ -0,0 +1,3 @@
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,53 @@
+AllCops:
+  # Include gemspec and Rakefile
+  Include:
+    - 'lib/**/*.rb'
+    - 'lib/**/*.rake'
+    - 'spec/**/*.rb'
+  Exclude:
+    - 'bin/**/*'
+    - 'spec/dummy/**/*'
+    - 'tmp/**/*'
+    - 'bench/**/*'
+    - 'lib/anycable/rpc/**/*'
+  DisplayCopNames: true
+  StyleGuideCopsOnly: false
+  TargetRubyVersion: 2.3
+
+Style/AccessorMethodName:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Enabled: false
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/StringLiterals: 
+  Enabled: false
+
+Style/SpaceInsideStringInterpolation:
+  EnforcedStyle: no_space
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
+Metrics/MethodLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/LineLength:
+  Max: 100
+  Exclude:
+    - 'spec/**/*.rb'
+
+Rails/Date:
+  Enabled: false
+
+Rails/TimeZone:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+cache: bundler
+
+rvm: 2.3.3
+
+matrix:
+  include:
+    - gemfile: gemfiles/rails5.gemfile
+    - gemfile: gemfiles/railsmaster.gemfile
+  allow_failures:
+    - gemfile: gemfiles/railsmaster.gemfile

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change log
+
+## 0.4.0
+
+- Initial version. ([@palkan][])
+
+[@palkan]: https://github.com/palkan

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+gemspec
+
+local_gemfile = "#{File.dirname(__FILE__)}/Gemfile.local"
+
+if File.exist?(local_gemfile)
+  eval(File.read(local_gemfile)) # rubocop:disable Lint/Eval
+else
+  # ??
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 palkan
+
+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,123 @@
+[![GitPitch](https://gitpitch.com/assets/badge.svg)](https://gitpitch.com/anycable/anycable/master?grs=github) [![Gem Version](https://badge.fury.io/rb/anycable-rails.svg)](https://rubygems.org/gems/anycable-rails) [![Build Status](https://travis-ci.org/anycable/anycable-rails.svg?branch=master)](https://travis-ci.org/anycable/anycable-rails) [![Circle CI](https://circleci.com/gh/anycable/anycable-rails/tree/master.svg?style=svg)](https://circleci.com/gh/anycable/anycable-rails/tree/master)
+[![Gitter](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/anycable/Lobby)
+
+# Anycable Rails
+
+AnyCable allows you to use any WebSocket server (written in any language) as a replacement for built-in Rails ActionCable server.
+
+With AnyCable you can use channels, client-side JS, broadcasting - (almost) all that you can do with ActionCable.
+
+You can even use ActionCable in development and not be afraid of compatibility issues.
+
+[Example Application](https://github.com/anycable/anycable_demo)
+
+For usage outside Rails see [AnyCable repository](https://github.com/anycable/anycable).
+
+<a href="https://evilmartians.com/">
+<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
+
+## Requirements
+
+- Ruby ~> 2.3;
+- Rails ~> 5.0;
+- Redis
+
+## How It Works?
+
+<img src="https://trello-attachments.s3.amazonaws.com/5781e0ed48e4679e302833d3/820x987/5b6a305417b04e20e75f49c5816e027c/Anycable_vs_ActionCable_copy.jpg" width="400" />
+
+## Links
+
+- [GitPitch Slides](https://gitpitch.com/anycable/anycable/master?grs=github)
+
+- RailsClub Moscow 2016 [slides](https://speakerdeck.com/palkan/railsclub-moscow-2016-anycable) and [video](https://www.youtube.com/watch?v=-k7GQKuBevY&list=PLiWUIs1hSNeOXZhotgDX7Y7qBsr24cu7o&index=4) (RU)
+
+
+## Compatible WebSocket servers
+
+- [Anycable Go](https://github.com/anycable/anycable-go)
+- [ErlyCable](https://github.com/anycable/erlycable)
+
+
+## Installation
+
+Add Anycable to your application's Gemfile:
+
+```ruby
+gem 'anycable-rails', group: :production
+```
+
+And then run:
+
+```shell
+rails generate anycable
+```
+
+to create executable.
+
+You can use _built-in_ ActionCable for test and development.
+
+## Configuration
+
+Add `config/anycable.yml`if you want to override defaults (see below):
+
+```yml
+production:
+  # gRPC server host
+  rpc_host: "localhost:50051"
+  # Redis URL (for broadcasting) 
+  redis_url: "redis://localhost:6379/2"
+  # Redis channel name
+  redis_channel: "anycable"
+
+```
+
+Anycable uses [anyway_config](https://github.com/palkan/anyway_config), thus it is also possible to set configuration variables through `secrets.yml` or environment vars.
+
+## Usage
+
+Run Anycable RPC server:
+
+```ruby
+./bin/anycable
+```
+
+and also run AnyCable-compatible WebSocket server, e.g. [anycable-go](https://github.com/anycable/anycable-go):
+
+```sh
+anycable-go -addr='localhost:3334'
+```
+
+Don't forget to set cable url in your `config/environments/production.rb`:
+
+```ruby
+config.action_cable.url = "ws://localhost:3334/cable"
+```
+
+## ActionCable Compatibility
+
+This is the compatibility list for the AnyCable gem, not for AnyCable servers (which may not support some of the features yet).
+
+Feature                  | Status 
+-------------------------|--------
+Connection Identifiers   | +
+Connection Request (cookies, params) | +
+Disconnect Handling | +
+Subscribe to channels | +
+Parameterized subscriptions | +
+Unsubscribe from channels | +
+[Subscription Instance Variables](http://edgeapi.rubyonrails.org/classes/ActionCable/Channel/Streams.html) | -
+Performing Channel Actions | +
+Streaming | +
+[Custom stream callbacks](http://edgeapi.rubyonrails.org/classes/ActionCable/Channel/Streams.html) | -
+Broadcasting | +
+Periodical Timers | -
+Disconnect remote clients | -
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/anycable/anycable-rails.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/anycable-rails.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'anycable/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "anycable-rails"
+  spec.version       = Anycable::Rails::VERSION
+  spec.authors       = ["palkan"]
+  spec.email         = ["dementiev.vm@gmail.com"]
+
+  spec.summary       = "Rails adapter for AnyCable"
+  spec.description   = "Rails adapter for AnyCable"
+  spec.homepage      = "http://github.com/anycable/anycable-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", "~> 5"
+  spec.add_dependency "anycable", "~>0.4.0"
+
+  spec.add_development_dependency "bundler", "~> 1"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", ">= 3.4"
+  spec.add_development_dependency "simplecov", ">= 0.3.8"
+  spec.add_development_dependency "pry-byebug"
+end

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails"
+require "anycable/rails"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+set -e
+
+gem install bundler --conservative
+bundle check || bundle install

data/circle.yml

@@ -0,0 +1,8 @@
+machine:
+  ruby:
+    version: 2.3.0
+
+dependencies:
+  pre:
+    - gem install bundler -v 1.11.2
+  

data/gemfiles/rails5.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 5.0.0'
+gem 'rspec-rails', '~> 3.5.0'
+
+gemspec path: '..'

data/gemfiles/railsmaster.gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'arel', github: 'rails/arel'
+gem 'rails', github: 'rails/rails'
+gem 'rspec-rails', '~> 3.5.0'
+
+gemspec path: '..'

data/lib/anycable-rails.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require "anycable/rails"

data/lib/anycable/rails.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+lib = File.expand_path("../../../../anycable/lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "anycable"
+require "anycable/rails/version"
+require "anycable/rails/actioncable/server"
+module Anycable
+  # Rails handler for AnyCable
+  module Rails
+  end
+end

data/lib/anycable/rails/actioncable/channel.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+require "action_cable"
+
+module ActionCable
+  module Channel
+    class Base # :nodoc:
+      alias handle_subscribe subscribe_to_channel
+
+      public :handle_subscribe, :subscription_rejected?
+
+      def subscribe_to_channel
+        # noop
+      end
+
+      def handle_unsubscribe
+        connection.subscriptions.remove_subscription(self)
+      end
+
+      def handle_action(data)
+        perform_action ActiveSupport::JSON.decode(data)
+      end
+
+      attr_reader :stop_streams
+
+      def stream_from(broadcasting, callback = nil, coder: nil)
+        raise ArgumentError('Unsupported') if callback.present? || coder.present? || block_given?
+        streams << broadcasting
+      end
+
+      def stop_all_streams
+        @stop_streams = true
+      end
+
+      def streams
+        @streams ||= []
+      end
+
+      def stop_streams?
+        stop_streams == true
+      end
+
+      def delegate_connection_identifiers
+        connection.identifiers.each do |identifier|
+          define_singleton_method(identifier) do
+            connection.fetch_identifier(identifier)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/anycable/rails/actioncable/connection.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+require "action_cable"
+require "anycable/rails/refinements/subscriptions"
+require "anycable/rails/actioncable/channel"
+
+module ActionCable
+  module Connection
+    class Base # :nodoc:
+      using Anycable::Refinements::Subscriptions
+
+      attr_reader :transmissions
+
+      class << self
+        def create(**options)
+          new(**options)
+        end
+
+        def identified_by(*identifiers)
+          super
+          Array(identifiers).each do |identifier|
+            define_method(identifier) do
+              instance_variable_get(:"@#{identifier}") || fetch_identifier(identifier)
+            end
+          end
+        end
+      end
+
+      def initialize(env: {}, identifiers: '{}', subscriptions: [])
+        @ids = ActiveSupport::JSON.decode(identifiers)
+
+        @cached_ids = {}
+        @env = env
+        @coder = ActiveSupport::JSON
+        @closed = false
+        @transmissions = []
+        @subscriptions = ActionCable::Connection::Subscriptions.new(self)
+
+        # Initialize channels if any
+        subscriptions.each { |id| @subscriptions.fetch(id) }
+      end
+
+      # Create a channel instance from identifier for the connection
+      def channel_for(identifier)
+        subscriptions.fetch(identifier)
+      end
+
+      def handle_open
+        connect if respond_to?(:connect)
+        send_welcome_message
+      rescue ActionCable::Connection::Authorization::UnauthorizedError
+        close
+      end
+
+      def handle_close
+        subscriptions.unsubscribe_from_all
+        disconnect if respond_to?(:disconnect)
+      end
+
+      def close
+        @closed = true
+      end
+
+      def closed?
+        @closed
+      end
+
+      def transmit(cable_message)
+        transmissions << encode(cable_message)
+      end
+
+      def dispose
+        @closed = false
+        transmissions.clear
+      end
+
+      # Generate identifiers info.
+      # Converts GlobalID compatible vars to corresponding global IDs params.
+      def identifiers_hash
+        identifiers.each_with_object({}) do |id, acc|
+          obj = instance_variable_get("@#{id}")
+          next unless obj
+          acc[id] = obj.try(:to_gid_param) || obj
+        end
+      end
+
+      def identifiers_json
+        identifiers_hash.to_json
+      end
+
+      # Fetch identifier and deserialize if neccessary
+      def fetch_identifier(name)
+        @cached_ids[name] ||= @cached_ids.fetch(name) do
+          val = @ids[name.to_s]
+          next val unless val.is_a?(String)
+          GlobalID::Locator.locate(val) || val
+        end
+      end
+
+      def logger
+        ::Rails.logger
+      end
+    end
+  end
+end

data/lib/anycable/rails/actioncable/server.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+require "action_cable"
+
+module ActionCable
+  module Server
+    # Override pubsub for ActionCable
+    class Base
+      def pubsub
+        Anycable.pubsub
+      end
+    end
+  end
+end

data/lib/anycable/rails/refinements/subscriptions.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module Anycable
+  module Refinements
+    module Subscriptions # :nodoc:
+      refine ActionCable::Connection::Subscriptions do
+        # Find or add a subscription to the list
+        def fetch(identifier)
+          add("identifier" => identifier) unless subscriptions[identifier]
+          subscriptions[identifier]
+        end
+      end
+    end
+  end
+end

data/lib/anycable/rails/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Anycable
+  module Rails
+    VERSION = "0.4.0"
+  end
+end

data/lib/generators/anycable/USAGE

@@ -0,0 +1,7 @@
+Description:
+  Generates Anycable executable
+  
+Examples:
+  rails generate anycable
+
+    This will generate Anycable executable

data/lib/generators/anycable/anycable_generator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+require "rails/generators/base"
+
+class AnycableGenerator < Rails::Generators::Base # :nodoc:
+  source_root File.expand_path('../templates', __FILE__)
+
+  def create_executable_file
+    template "script", "bin/anycable"
+    chmod "bin/anycable", 0o755
+  end
+end

data/lib/generators/anycable/templates/script

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+require ::File.expand_path('../../config/environment', __FILE__)
+require "anycable"
+require 'anycable/rails/connection'
+
+Anycable.configure do |config|
+  config.connection_factory = ActionCable.server.config.connection_class.call
+end
+
+Rails.application.eager_load!
+
+Anycable::Server.start

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: anycable-rails
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- palkan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: anycable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.8
+- !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'
+description: Rails adapter for AnyCable
+email:
+- dementiev.vm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- anycable-rails.gemspec
+- bin/console
+- bin/setup
+- circle.yml
+- gemfiles/rails5.gemfile
+- gemfiles/railsmaster.gemfile
+- lib/anycable-rails.rb
+- lib/anycable/rails.rb
+- lib/anycable/rails/actioncable/channel.rb
+- lib/anycable/rails/actioncable/connection.rb
+- lib/anycable/rails/actioncable/server.rb
+- lib/anycable/rails/refinements/subscriptions.rb
+- lib/anycable/rails/version.rb
+- lib/generators/anycable/USAGE
+- lib/generators/anycable/anycable_generator.rb
+- lib/generators/anycable/templates/script
+homepage: http://github.com/anycable/anycable-rails
+licenses:
+- MIT
+metadata: {}
+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.6.4
+signing_key: 
+specification_version: 4
+summary: Rails adapter for AnyCable
+test_files: []