litecable 0.4.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4640e78d6f9a77cf9257cb0774ff249ec1b5f699
-  data.tar.gz: a2cc894fc9e355baa79d82afde6682c570ddc21c
+SHA256:
+  metadata.gz: 47a04414eade53832c4b900305ca3a034999724c0cabd6aceacb908192a6124f
+  data.tar.gz: 24c67d2cacbb5f64b5b7d63293c7fdbe143797d0102b732983fc78028469dfc9
 SHA512:
-  metadata.gz: '0588bb0b62119753f79382bfe9955f7db54a693f2625c05426bcf08f131ed8b5b10fdb1e2bd0950545e030530ecfa823383c037747e654b43e7aa650db7187cb'
-  data.tar.gz: 6365980a8eece62d0d092349ed583afb1a04e749577f994da5da004dfe4576b64c07edc8744680eecda8f9637d726e6c878a0d50cd281c322070adb67c36df37
+  metadata.gz: eb63ada090f884f750828b7c116d1066a020c87ab043d929e4ad46b035299c95972acf1d458813a34da797273e0656fc7613977cfef24c6e0765a7a8dece9a6a
+  data.tar.gz: 75314e320e2ed5f18e34c4038d467aef14e73f9b0e4fe01f61955369a52ee28e246e62662a94c3e1d1b9f7ea9999049f8d58e5f7af80479fc88a97b91055720e

data/CHANGELOG.md

@@ -1,6 +1,37 @@
 # Change log
 
-## master
+## 0.7.0 (2020-01-07)
+
+- Refactor AnyCable integration ([@palkan][])
+
+Now you only need to set AnyCable broadcast adapter:
+
+```ruby
+LiteCable.broadcast_adapter = :any_cable
+```
+
+```sh
+# or via env/config
+LITECABLE_BROADCAST_ADAPTER=any_cable ruby my_app.rb
+```
+
+- Adapterize broadcast adapters ([@palkan][])
+
+- Drop Ruby 2.4 support ([palkan][])
+
+## 0.6.0 (2019-04-12) 🚀
+
+- Drop Ruby 2.3 support ([@palkan][])
+
+## 0.5.0 (2017-12-20)
+
+- Upgrade for AnyCable 0.5.0 ([@palkan][])
+
+## 0.4.1 (2017-02-04)
+
+- Use `websocket-ruby` with sub-protocols support ([@palkan][])
+
+## 0.4.0 (2017-01-29)
 
 - Initial version. ([@palkan][])
 

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 palkan
+Copyright (c) 2017-2020 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

data/README.md

@@ -1,4 +1,5 @@
-[![Gem Version](https://badge.fury.io/rb/litecable.svg)](https://rubygems.org/gems/litecable) [![Build Status](https://travis-ci.org/anycable/litecable.svg?branch=master)](https://travis-ci.org/anycable/litecable) [![Circle CI](https://circleci.com/gh/anycable/litecable/tree/master.svg?style=svg)](https://circleci.com/gh/anycable/anycable/tree/master)
+[![Gem Version](https://badge.fury.io/rb/litecable.svg)](https://rubygems.org/gems/litecable)
+[![Build](https://github.com/palkan/litecable/workflows/Build/badge.svg)](https://github.com/palkan/litecable/actions)
 
 # Lite Cable
 
@@ -13,27 +14,23 @@ Compatible with [AnyCable](http://anycable.io) (for production usage).
 
 ## Examples
 
-- [Sinatra Lite Cable Chat](https://github.com/palkan/litecable/tree/master/examples/sinatra)
+- [Sinatra LiteCable Chat](https://github.com/palkan/litecable/tree/master/examples/sinatra)
+
+- [Connecting LiteCable to Hanami](http://gabrielmalakias.com.br/ruby/hanami/iot/2017/05/26/websockets-connecting-litecable-to-hanami.html) by [@GabrielMalakias](https://github.com/GabrielMalakias)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'litecable'
+gem "litecable"
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install litecable
+And run `bundle install`.
 
 ## Usage
 
-Please, checkout [Action Cable guides](http://guides.rubyonrails.org/action_cable_overview.html) for general information. Lite Cable aims to be compatible with Action Cable as much as possible without the loss of simplicity and _ligthness_.
+Please, checkout [Action Cable guides](http://guides.rubyonrails.org/action_cable_overview.html) for general information. Lite Cable aims to be compatible with Action Cable as much as possible without the loss of simplicity and _lightness_.
 
 You can use Action Cable javascript client without any change (precompiled version can be found [here](https://github.com/palkan/litecable/tree/master/examples/sinatra/assets/cable.js)).
 
@@ -71,36 +68,42 @@ To use Lite Cable server:
 
 ```ruby
 Rack::Builder.new do
-  map '/cable' do
+  map "/cable" do
     # You have to specify your app's connection class
     use LiteCable::Server::Middleware, connection_class: App::Connection
-    run proc { |_| [200, { 'Content-Type' => 'text/plain' }, ['OK']] }
+    run proc { |_| [200, {"Content-Type" => "text/plain"}, ["OK"]] }
   end
 end
 ```
 
 ### Using with AnyCable
 
-Lite Cable is AnyCable-compatible out-of-the-box. You should write a simple server script:
+Lite Cable is AnyCable-compatible out-of-the-box:
+
+- Set broadcast adapter to AnyCable:
 
 ```ruby
-#!/usr/bin/env ruby
+LiteCable.broadcast_adapter = :any_cable
+```
 
-require "my_app"
-require "rack"
-require "anycable"
+You can also do this via configuration, e.g., env var (`LITECABLE_BROADCAST_ADAPTER=any_cable`) or `broadcast_adapter: any_cable` in a YAML config.
 
-# Turn AnyCable compatibility mode
-LiteCable.anycable!
+- Configure connection factory:
 
-Anycable.configure do |config|
-  config.connection_factory = MyApp::Connection
-end
+```ruby
+AnyCable.connection_factory = MyApp::Connection
+```
 
-Anycable::Server.start
+Then run AnyCable along with the app:
+
+```sh
+bundle exec anycable
+
+# add -r option to load the app if it's not ./config/anycable.rb or ./config/environment.rb
+bundle exec anycable -r ./my_app.rb
 ```
 
-And then run this script along with your application. See [Sinatra example](https://github.com/palkan/litecable/tree/master/examples/sinatra) for more.
+See [Sinatra example](https://github.com/palkan/litecable/tree/master/examples/sinatra) for more.
 
 ### Configuration
 
@@ -120,9 +123,8 @@ See [config](https://github.com/palkan/litecable/blob/master/lib/lite_cable/conf
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/anycable/litecable.
+Bug reports and pull requests are welcome on GitHub at [https://github.com/palkan/litecable](https://github.com/palkan/litecable).
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
+The gem is available as open source under the terms of the [MIT License](./LICENSE.txt).

data/lib/lite_cable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "lite_cable/version"
 require "lite_cable/internal"
 require "lite_cable/logging"
@@ -14,6 +15,7 @@ module LiteCable
   require "lite_cable/channel"
   require "lite_cable/coders"
   require "lite_cable/config"
+  require "lite_cable/broadcast_adapters"
   require "lite_cable/anycable"
 
   class << self
@@ -22,8 +24,27 @@ module LiteCable
     end
 
     # Broadcast encoded message to the stream
-    def broadcast(*args)
-      LiteCable::Server.broadcast(*args)
+    def broadcast(stream, message, coder: LiteCable.config.coder)
+      broadcast_adapter.broadcast(stream, message, coder: coder)
+    end
+
+    def broadcast_adapter
+      return @broadcast_adapter if defined?(@broadcast_adapter)
+      self.broadcast_adapter = LiteCable.config.broadcast_adapter.to_sym
+      @broadcast_adapter
+    end
+
+    def broadcast_adapter=(adapter)
+      if adapter.is_a?(Symbol) || adapter.is_a?(Array)
+        adapter = BroadcastAdapters.lookup_adapter(adapter)
+      end
+
+      unless adapter.respond_to?(:broadcast)
+        raise ArgumentError, "BroadcastAdapter must implement #broadcast method. " \
+                              "#{adapter.class} doesn't implement it."
+      end
+
+      @broadcast_adapter = adapter
     end
   end
 end

data/lib/lite_cable/anycable.rb

@@ -1,21 +1,15 @@
 # frozen_string_literal: true
-module LiteCable
+
+module LiteCable # :nodoc:
   # AnyCable extensions
   module AnyCable
-    module Broadcasting # :nodoc:
-      def broadcast(stream, message, coder: nil)
-        coder ||= LiteCable.config.coder
-        Anycable.broadcast stream, coder.encode(message)
-      end
-    end
-
     module Connection # :nodoc:
       def self.extended(base)
         base.prepend InstanceMethods
       end
 
-      def create(socket, **options)
-        new(socket, **options)
+      def call(socket, **options)
+        new(socket, options)
       end
 
       module InstanceMethods # :nodoc:
@@ -29,6 +23,7 @@ module LiteCable
           @request ||= Rack::Request.new(socket.env)
         end
 
+        # rubocop: disable Metrics/MethodLength
         def handle_channel_command(identifier, command, data)
           channel = subscriptions.add(identifier, false)
           case command
@@ -50,13 +45,27 @@ module LiteCable
           close
           false
         end
+        # rubocop: enable Metrics/MethodLength
       end
     end
   end
 
-  # Patch Lite Cable  with AnyCable functionality
+  # Patch Lite Cable with AnyCable functionality
   def self.anycable!
     LiteCable::Connection::Base.extend LiteCable::AnyCable::Connection
-    LiteCable.singleton_class.prepend LiteCable::AnyCable::Broadcasting
+  end
+end
+
+if defined?(AnyCable)
+  AnyCable.configure_server do
+    # Make sure broadcast adapter is valid
+    require "lite_cable/broadcast_adapters/any_cable"
+    unless LiteCable::BroadcastAdapters::AnyCable === LiteCable.broadcast_adapter
+      raise "You should use :any_cable broadcast adapter (current: #{LiteCable.broadcast_adapter.class}). " \
+            "Set it via LITECABLE_BROADCAST_ADAPTER=any_cable or in the code/YML."
+    end
+
+    # Turn AnyCable compatibility mode for anycable RPC server automatically
+    LiteCable.anycable!
   end
 end

data/lib/lite_cable/broadcast_adapters.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "lite_cable/broadcast_adapters/base"
+
+module LiteCable
+  module BroadcastAdapters # :nodoc:
+    module_function
+
+    # rubocop: disable Metrics/AbcSize, Metrics/MethodLength
+    def lookup_adapter(args)
+      adapter, options = Array(args)
+      path_to_adapter = "lite_cable/broadcast_adapters/#{adapter}"
+      adapter_class_name = adapter.to_s.split("_").map(&:capitalize).join
+
+      unless BroadcastAdapters.const_defined?(adapter_class_name, false)
+        begin
+          require path_to_adapter
+        rescue LoadError => e
+          # We couldn't require the adapter itself.
+          if e.path == path_to_adapter
+            raise e.class, "Couldn't load the '#{adapter}' broadcast adapter for LiteCable",
+              e.backtrace
+          # Bubbled up from the adapter require.
+          else
+            raise e.class, "Error loading the '#{adapter}' broadcast adapter for LiteCable",
+              e.backtrace
+          end
+        end
+      end
+
+      BroadcastAdapters.const_get(adapter_class_name, false).new(**(options || {}))
+    end
+    # rubocop: enable Metrics/AbcSize, Metrics/MethodLength
+  end
+end

data/lib/lite_cable/broadcast_adapters/any_cable.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module LiteCable
+  module BroadcastAdapters
+    class AnyCable < Base
+      def broadcast(stream, message, coder:)
+        ::AnyCable.broadcast stream, coder.encode(message)
+      end
+    end
+  end
+end

data/lib/lite_cable/broadcast_adapters/base.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# frozen_string_literal: true
+
+module LiteCable
+  module BroadcastAdapters
+    class Base
+      def initialize(**options)
+        @options = options
+      end
+
+      private
+
+      attr_reader :options
+    end
+  end
+end

data/lib/lite_cable/broadcast_adapters/memory.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module LiteCable
+  module BroadcastAdapters
+    class Memory < Base
+      def broadcast(stream, message, coder:)
+        Server.subscribers_map.broadcast stream, message, coder
+      end
+    end
+  end
+end

data/lib/lite_cable/channel.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module LiteCable
   module Channel # :nodoc:
     require "lite_cable/channel/registry"

data/lib/lite_cable/channel/base.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module LiteCable
   # rubocop:disable Metrics/LineLength
   module Channel
@@ -128,6 +129,7 @@ module LiteCable
         action = extract_action(data)
 
         raise UnproccessableActionError unless processable_action?(action)
+
         log(:debug) { log_fmt("Perform action #{action}(#{data})") }
         dispatch_action(action, data)
       end

data/lib/lite_cable/channel/registry.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module LiteCable
   module Channel
     # Stores channels identifiers and corresponding classes.
@@ -10,6 +11,7 @@ module LiteCable
       class << self
         def add(id, channel_class)
           raise AlreadyRegisteredError if find(id)
+
           channels[id] = channel_class
         end
 
@@ -20,6 +22,7 @@ module LiteCable
         def find!(id)
           channel_class = find(id)
           raise UnknownChannelError unless channel_class
+
           channel_class
         end
 

data/lib/lite_cable/channel/streams.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module LiteCable
   # rubocop:disable Metrics/LineLength
   module Channel

data/lib/lite_cable/coders.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module LiteCable
   module Coders # :nodoc:
     require "lite_cable/coders/raw"

data/lib/lite_cable/coders/json.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "json"
 
 module LiteCable

data/lib/lite_cable/coders/raw.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module LiteCable
   module Coders
     # No-op coder

data/lib/lite_cable/config.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
-require "anyway"
-require 'logger'
+
+require "anyway_config"
+require "logger"
 
 module LiteCable
-  # Anycable configuration
+  # AnyCable configuration
   class Config < Anyway::Config
     require "lite_cable/coders/json"
     require "lite_cable/coders/raw"
@@ -11,8 +12,9 @@ module LiteCable
     config_name :litecable
 
     attr_config :logger,
-                coder: Coders::JSON,
-                identifier_coder: Coders::Raw,
-                log_level: Logger::INFO
+      coder: Coders::JSON,
+      broadcast_adapter: :memory,
+      identifier_coder: Coders::Raw,
+      log_level: Logger::INFO
   end
 end