oceanex-slanger 0.7.1 → 0.7.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 873ad2c526e6058fc9422328e63bd2b87913fe63ec17d3d6cba0b4809db514f8
-  data.tar.gz: facd5b203fdcf1bc86df73bf079f3aec92964747e30a5909b71ef31afec0b8ad
+  metadata.gz: 8cb0189c2d4a320b9a58018e24cfd43e6d6e26155f8b85ea93ffd2a797e22262
+  data.tar.gz: faf6ff49096ab54b3b5f9b7328d2597694307a0337a8228130638b308db2f57a
 SHA512:
-  metadata.gz: e204ea34edcfb2e7a254e9ba35dc177f5378c4df304c43801720ed011e157f7bad4ae81df838c5a2c95901d2c07423e8e3a8ccc2ffa3107d61a10074cb5fab3a
-  data.tar.gz: 94a8da1071538d9b6620aaadc814ebbd33623a1c3f30a527e51d329c9b33668b30bc931b20e20526996ac20ff7bf50f8b074bb0000af1eb58c31d6635a065498
+  metadata.gz: a35a8aaf716ea4466ade705d8588d68b5a5a6e66141acd027305842f687a36595b18d70829fc0b321faf0a21b7a979bae95b68b6667d764b1819ef7625e45a3f
+  data.tar.gz: be92ee218d13219007403e6fda737e8b0e9512b6a2f5762fc23691e8077695cade690ec8a47c014a427336265665ffdd27f5321904e8a920d3fc451319191d69

data/README.md

@@ -1,59 +1,24 @@
-# Slanger
+# OceanEx Slanger
+[![Gem Version](https://badge.fury.io/rb/oceanex-slanger.svg)](https://badge.fury.io/rb/oceanex-slanger) [![Build Status](https://travis-ci.com/jobleeyoui/slanger.svg?branch=master)](https://travis-ci.com/jobleeyoui/slanger)
 
-Though Slanger has been deprecated by its authors, it is still popular due to its scalability through kubernetes.
-This is the most important reason I decide to continue to maintain slanger. The maintenance will continue until future notice or better option comes out. 
+The OceanEx Slanger inherits from the unmaintained Slanger. The project is backed by OceanEx dev team.
 
-Feel free to log any issues or contribute to code base.
+We will do regularly bug fixes and security updates. 
 
-**Important! Slanger is not supposed to be included in your Gemfile. RubyGems is used as a distribution mechanism. If you include it in your app, you will likely get dependency conflicts. PRs updating dependencies for compatibility with your app will be closed. Thank you for reading and enjoy Slanger!**
+We might further add more features or provide performance improvements for OceanEx Slanger. The maintenance will continue until we find better option. 
 
-## Typical usage
+Feel free to log any issue or contribute to the code base.
 
-```
-gem install slanger
-redis-server &> /dev/null &
-
-slanger --app_key 765ec374ae0a69f4ce44 --secret your-pusher-secret
-```
-
-Slanger is a standalone server ruby implementation of the Pusher protocol.  It
-is not designed to run inside a Rails or sinatra app, but it can be easily
-installed as a gem.
-
-Bundler has multiple purposes, one of which is useful for installation.
-
-## About
+**Important! OceanEx Slanger is not supposed to be included in your Gemfile. RubyGems is used as a distribution mechanism. If you include it in your app, you will likely get dependency conflicts. 
+PRs updating dependencies for compatibility with your app will be closed!**
 
-Slanger is an open source server implementation of the Pusher protocol written
-in Ruby. It is designed to scale horizontally across N nodes and to be agnostic
-as to which Slanger node a subscriber is connected to, i.e subscribers to the
-same channel are NOT required to be connected to the same Slanger node.
-Multiple Slanger nodes can sit behind a load balancer with no special
-configuration. In essence it was designed to be very easy to scale.
-
-Presence channel state is shared using Redis. Channels are lazily instantiated
-internally within a given Slanger node when the first subscriber connects. When
-a presence channel is instantiated within a Slanger node, it queries Redis for
-the global state across all nodes within the system for that channel, and then
-copies that state internally. Afterwards, when subscribers connect or
-disconnect the node publishes a presence message to all interested nodes, i.e.
-all nodes with at least one subscriber interested in the given channel.
-
-Slanger is smart enough to know if a new channel subscription belongs to the
-same user. It will not send presence messages to subscribers in this case. This
-happens when the user has multiple browser tabs open for example. Using a chat
-room backed by presence channels as a real example, one would not want
-"Barrington" to show up N times in the presence roster because Barrington
-has the chat room open in N browser tabs.
-
-Slanger was designed to be highly available and partition tolerant with
-eventual consistency, which in practise is instantaneous.
+OceanEx Slanger is a standalone server ruby implementation of the Pusher protocol.  It is not designed to run inside a Rails or sinatra app, but it can be easily installed as a gem.
 
 # How to use it
 
 ## Requirements
 
-- Ruby 2.1.2 or greater
+- Ruby 2.6.3 or greater
 - Redis
 
 ## Server setup
@@ -77,19 +42,60 @@ If you want to run multiple slanger instances in a cluster, one option will be t
 A basic config can be found in the folder `examples`.
 Haproxy can be also used for SSL termination, leaving slanger to not have to deal with SSL checks and so on, making it lighter.
 
+## Installation instruction
+
+The OceanEx Slanger depends on ruby 2.6.3 and above, please install ruby 2.6.3 first before install the OceanEx Slanger.
+It could also run perfectly on the latest 2.7.1. If you want to align with the latest ruby, you might clone the source
+code and compile yourself. 
+
+### Linux(Ubuntu)
+
+You could install the right version of ruby via rbenv
+
+```
+sudo apt-get install rbenv
+rbenv install 2.6.3
+rbenv global 2.6.3
+```
+
+Then install the OceanEx Slanger
+
+```
+gem install oceanex-slanger
+```
+
+### Mac
+
+Install the ruby version via home brew
 
-## Starting the service
+```
+brew install ruby
+```
 
-Slanger is packaged as a Rubygem. Installing the gem makes the 'slanger' executable available. The `slanger` executable takes arguments, of which two are mandatory: `--app_key` and `--secret`. These can but do not have to be the same as the credentials you use for Pusher. They are required because Slanger performs the same HMAC signing of API requests that Pusher does.
+You might also install via rbenv 
+```
+brew install rbenv
+rbenv install 2.6.3
+rbenv global 2.6.3
+```
 
-__IMPORTANT:__ Redis must be running where Slanger expects it to be (either on localhost:6379 or somewhere else you told Slanger it would be using the option flag) or Slanger will fail silently. I haven't yet figured out how to get em-hiredis to treat an unreachable host as an error
+Installation might fail when some dependent gems builds their native extension. This is due to the c compiler converts the warning to error when do so.
 
-```bash
-$ gem install slanger
+If you see installation fails due to `implicit-function-declaration`, you could try the following step to suppress the warning.
 
-$ redis-server &> /dev/null &
+```
+gem install oceanex-slanger -- --with-cflags="-Wno-error=implicit-function-declaration"
+```
+
+## Start the OceanEx Slanger in local environment
+
+Both the app key and app secret are just random string, you could choose any string. However, it is recommended to be long
+enough to keep secure.
+
+Oceanex Slanger also depends on redis service, specify the redis url when launching the OceanEx Slanger. 
 
-$ slanger --app_key 765ec374ae0a69f4ce44 --secret your-pusher-secret
+```
+slanger --app_key $APP_KEY --secret $APP_SECRET -r $REDIS_URL
 ```
 
 If all went to plan you should see the following output to STDOUT
@@ -113,31 +119,31 @@ Slanger API server listening on port 4567
 Slanger WebSocket server listening on port 8080
 ```
 
-## Ubuntu upstart script
+## Start the OceanEx Slanger in Docker environment 
+
+The OceanEx Slanger supports running in docker environment and such approach is already encapsulated in the make command.
+The dependent Redis docker image is also automatically downloaded and started.
 
-If you're using Ubuntu, you might find this upscript very helpful. The steps below will create an init script that will make slanger run at boot and restart if it fails.
-Open `/etc/init/slanger` and add:
+For the app key and app secret, please check `docker-compose.yaml` and modify as needed.
+
+### Build the docker image
 ```
-start on started networking and runlevel [2345]
-stop on runlevel [016]
-respawn
-script
-    LANG=en_US.UTF-8 /usr/local/rvm/gems/ruby-RUBY_VERISON/wrappers/slanger --app_key KEY --secret SECRET --redis_address redis://REDIS_IP:REDIS_PORT/REDIS_DB
-end script
+make build
 ```
-This example assumes you're using rvm and a custom redis configuration
 
-Then, to start / stop the service, just do
+### Start the OceanEx slanger
 ```
-service slanger start
-service slanger stop
+make up
 ```
 
+### Stop the service
+```
+make down
+```
 
-## Modifying your application code to use the Slanger service
-
-Once you have a Slanger instance listening for incoming connections you need to alter you application code to use the Slanger endpoint instead of Pusher. Fortunately this is very simple, unobtrusive, easily reversable, and very painless.
+## Modifying your application code to use the OceanEx Slanger service
 
+Once you have a OceanEx Slanger instance listening for incoming connections you need to alter you application code to use the OceanEx Slanger endpoint instead of Pusher. Fortunately this is very simple, unobtrusive, easily reversable, and very painless.
 
 First you will need to add code to your server side component that publishes events to the Pusher HTTP REST API, usually this means telling the Pusher client to use a different host and port, e.g. consider this Ruby example
 
@@ -165,7 +171,7 @@ Of course you could proxy all requests to `ws.example.com` to port 8080 of your
 
 # Configuration Options
 
-Slanger supports several configuration options, which can be supplied as command line arguments at invocation. You can also supply a yaml file containing config options. If you use the config file in combination with other configuration options, the values passed on the command line will win. Allows running multiple instances with only a few differences easy.
+OceanEx Slanger supports several configuration options, which can be supplied as command line arguments at invocation. You can also supply a yaml file containing config options. If you use the config file in combination with other configuration options, the values passed on the command line will win. Allows running multiple instances with only a few differences easy.
 
 ```
 -k or --app_key This is the Pusher app key you want to use. This is a required argument on command line or in optional config file
@@ -193,39 +199,28 @@ Slanger supports several configuration options, which can be supplied as command
 --pid_file  The path to a file you want slanger to write it's PID to. Optional.
 ```
 
-# Why use Slanger instead of Pusher?
-
-There a few reasons you might want to use Slanger instead of Pusher, e.g.
-
-- You operate in a heavily regulated industry and are worried about sending data to 3rd parties, and it is an organisational requirement that you own your own infrastructure.
-- You might be travelling on an airplane without internet connectivity as I am right now. Airplane rides are very good times to get a lot done, unfortunately external services are also usually unreachable. Remove internet connectivity as a dependency of your development envirionment by running a local Slanger instance in development and Pusher in production.
-- Remove the network dependency from your test suite.
-- You want to extend the Pusher protocol or have some special requirement. If this applies to you, chances are you are out of luck as Pusher is unlikely to implement something to suit your special use case, and rightly so. With Slanger you are free to modify and extend its behavior anyway that suits your purpose.
-
-# Why did you write Slanger
-
-I wanted to write a non-trivial evented app. I also want to write a book on evented programming in Ruby as I feel there is scant good information available on the topic and this project is handy to show publishers.
-
-Pusher is an awesome service, very reasonably priced, and run by an awesome crew. Give them a spin on your next project.
-
-# Author
+# Original Author
 
 - Stevie Graham
 
-# Core Team
+# Original Core Team
 
 - Stevie Graham
 - Mark Burns
 
-# Contributors
+# Original Contributors
 
 - Stevie Graham
 - Mark Burns
 - Florian Gilcher
 - Claudio Poli
 
-# Maintainer
-- joblee
+# Current Core Team and Contributor
+- Joblee
+- Steve
+- Meng
+- Sniper
+- Jiayu
 
 
-© 2020 a joblee joint.
+© 2020 a OceanEx joint.

data/lib/slanger/api/server.rb

@@ -32,7 +32,7 @@ module Slanger
         EventPublisher.publish(valid_request.channels, event)
 
         status 202
-        return Oj.dump({}, mode: :compat)
+        Oj.dump({}, mode: :compat)
       end
 
       post "/apps/:app_id/channels/:channel_id/events" do
@@ -42,7 +42,7 @@ module Slanger
         EventPublisher.publish(valid_request.channels, event)
 
         status 202
-        return Oj.dump({}, mode: :compat)
+        Oj.dump({}, mode: :compat)
       end
 
       def valid_request

data/lib/slanger/channel.rb

@@ -24,15 +24,17 @@ module Slanger
       end
 
       def lookup(channel_id)
-        all.detect { |o| o.channel_id == channel_id }
+        all[channel_id]
       end
 
       def create(params = {})
-        new(params).tap { |r| all << r }
+        new(params).tap do |channel|
+          all[channel.channel_id] = channel
+        end
       end
 
       def all
-        @all ||= []
+        @all ||= {}
       end
 
       def unsubscribe(channel_id, subscription_id)

data/lib/slanger/connection.rb

@@ -22,7 +22,7 @@ module Slanger
       begin
         send_payload nil, "pusher:error", e
       rescue EventMachine::WebSocket::WebSocketError
-        # Raised if connecection already closed. Only seen with Thor load testing tool
+        # Raised if connection already closed. Only seen with Thor load testing tool
       end
     end
 

data/lib/slanger/version.rb

@@ -1,3 +1,3 @@
 module Slanger
-  VERSION = "0.7.1"
+  VERSION = "0.7.1.5"
 end

metadata

@@ -1,14 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: oceanex-slanger
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.1.5
 platform: ruby
 authors:
-- joblee
+- Joblee
+- Steve
+- Meng
+- Sniper
+- Jiayu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2020-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -100,14 +104,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.4.4
+        version: 6.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.4.4
+        version: 6.0.3
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +146,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.6
+        version: 1.1.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.6
+        version: 1.1.7
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -304,7 +308,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 13.0.1
-description: The oceanex slanger inherits from unmaintained project slanger and continue
+description: The Oceanex Slanger inherits from unmaintained project Slanger and continue
   to provide update and fixes
 email:
 - jobleeyoui@gmail.com
@@ -349,13 +353,13 @@ files:
 - spec/unit/channel_spec.rb
 - spec/unit/request_validation_spec.rb
 - spec/unit/webhook_spec.rb
-homepage: https://github.com/jobleeyoui/slanger
+homepage: https://github.com/OceanEx/slanger
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/jobleeyoui/slanger
-  source_code_uri: https://github.com/jobleeyoui/slanger/archive/v0.7.0.zip
-  changelog_uri: https://github.com/jobleeyoui/slanger/releases
+  homepage_uri: https://github.com/OceanEx/slanger
+  source_code_uri: https://github.com/OceanEx/slanger/archive/v0.7.1.4.zip
+  changelog_uri: https://github.com/OceanEx/slanger/releases
 post_install_message: 
 rdoc_options: []
 require_paths: