slangerq 0.6.1

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+require 'bundler/setup'
+
+require 'active_support/json'
+require 'active_support/core_ext/hash'
+require 'eventmachine'
+require 'em-http-request'
+require 'pusher'
+require 'thin'
+require 'slanger_helper_methods'
+require 'have_attributes'
+require 'openssl'
+require 'socket'
+require 'timecop'
+require 'pry'
+require 'webmock/rspec'
+require 'slanger'
+
+WebMock.disable!
+
+module Slanger; end
+
+def errback
+  @errback ||= Proc.new { |e| fail 'cannot connect to slanger. your box might be too slow. try increasing sleep value in the before block' }
+end
+
+RSpec.configure do |config|
+  config.formatter = 'documentation'
+  config.color = true
+  config.mock_framework = :mocha
+  config.order = 'random'
+  config.include SlangerHelperMethods
+  config.fail_fast = true
+  config.after(:each) { stop_slanger if @server_pid }
+  config.before :all do
+    Pusher.tap do |p|
+      p.host   = '0.0.0.0'
+      p.port   = 4567
+      p.app_id = 'your-pusher-app-id'
+      p.secret = 'your-pusher-secret'
+      p.key    = '765ec374ae0a69f4ce44'
+    end
+  end
+end

data/spec/unit/channel_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+require 'slanger'
+require 'oj'
+
+def clear_redis_connections
+  Slanger::Redis.instance_variables.each do |ivar|
+    Slanger::Redis.send :remove_instance_variable, ivar
+  end
+end
+
+describe 'Slanger::Channel' do
+  let(:channel) { Slanger::Channel.create channel_id: 'test' }
+
+  before(:each) do
+    EM::Hiredis.stubs(:connect).returns stub_everything('redis', :pubsub => stub_everything('redis'))
+    clear_redis_connections
+  end
+
+  after(:each) do
+    clear_redis_connections
+    EM::Hiredis.unstub(:connect)
+  end
+
+  describe '#unsubscribe' do
+    it 'decrements channel subscribers on Redis' do
+      Slanger::Redis.expects(:hincrby).
+        with('channel_subscriber_count', channel.channel_id, -1).
+        once.returns mock { expects(:callback).once.yields(2) }
+
+      channel.unsubscribe 1
+    end
+
+    it 'activates a webhook when the last subscriber of a channel unsubscribes' do
+      Slanger::Webhook.expects(:post).
+        with(name: 'channel_vacated', channel: channel.channel_id).
+        once
+
+      Slanger::Redis.expects(:hincrby).
+        with('channel_subscriber_count', channel.channel_id, -1).
+        times(3).returns mock {
+          expects(:callback).times(3).yields(2).then.yields(1).then.yields(0)
+        }
+
+      3.times { |i| channel.unsubscribe i + 1 }
+    end
+  end
+
+  describe '#subscribe' do
+    it 'increments channel subscribers on Redis' do
+      Slanger::Redis.expects(:hincrby).
+        with('channel_subscriber_count', channel.channel_id, 1).
+        once.returns mock { expects(:callback).once.yields(2) }
+      channel.subscribe { |m| nil }
+    end
+
+    it 'activates a webhook when the first subscriber of a channel joins' do
+      Slanger::Webhook.expects(:post).
+        with(name: 'channel_occupied', channel: channel.channel_id).
+        once
+
+      Slanger::Redis.expects(:hincrby).
+        with('channel_subscriber_count', channel.channel_id, 1).
+        times(3).returns mock {
+          expects(:callback).times(3).yields(1).then.yields(2).then.yields(3)
+        }
+
+      3.times { channel.subscribe { |m| nil } }
+    end
+  end
+
+  describe '#dispatch' do
+    it 'activates a webhook when client events are received' do
+      message = {
+        'event'     => 'client-test_event',
+        'channel'   => 'private-test_channel',
+        'socket_id' => '8.422225',
+        'data'      => { 'key' => 'value' }
+      }
+
+      expected_params = message.merge({
+        'name' => 'client_event',
+        'data' => Oj.dump(message['data'])
+      })
+
+      Slanger::Webhook.expects(:post).
+        with(expected_params).
+      once
+
+      channel.dispatch(message, 'private-test_channel')
+    end
+
+    it 'does not activate a webhook when non-client event messages are received' do
+      message = {
+        'event'     => 'non_client_event',
+        'channel'   => 'private-test_channel',
+        'socket_id' => '8.422225',
+        'data'      => { 'key' => 'value' }
+      }
+
+      Slanger::Webhook.expects(:post).never
+
+      channel.dispatch(message, 'private-test_channel')
+    end
+  end
+end

data/spec/unit/request_validation_spec.rb

@@ -0,0 +1,72 @@
+#encoding: utf-8
+require 'spec_helper'
+
+describe Slanger::Api::RequestValidation do
+  describe '#socket_id' do
+    it 'validation' do
+      socket_id = "POST\n/apps/99759/events\nauth_key=840543d97de9803651b1&auth_timestamp=123&auth_version=1.0&body_md5=some_md5&dummy="
+
+      expect {validate(nil)            }.not_to raise_error
+      expect {validate("1234.123455")  }.not_to raise_error
+
+      expect {validate(socket_id)      }.to     raise_error Slanger::Api::InvalidRequest
+      expect {validate("something 123")}.to     raise_error Slanger::Api::InvalidRequest
+
+      expect {validate("1234.12345 ")               }.to raise_error Slanger::Api::InvalidRequest
+      expect {validate(" 1234.12345")               }.to raise_error Slanger::Api::InvalidRequest
+      expect {validate("hello\n1234.123456\nhomakov") }.to raise_error Slanger::Api::InvalidRequest
+    end
+  end
+
+  before do
+    request = mock("request")
+    request.expects(:authenticate).times(0..2)
+    Signature::Request.expects(:new).times(0..2).returns request
+  end
+
+  describe "#channels" do
+    let(:body) { {socket_id: "1234.5678", channels: channels}.to_json }
+
+    context "with valid channels" do
+      let(:channels) { ["MY_CHANNEL", "presence-abcd", "foo-bar_1234@=,.;", "a"*164] }
+
+      it "returns an array of valid channel_id values" do
+        rv = Slanger::Api::RequestValidation.new(body, {}, "")
+
+        expect(rv.channels).to eq ["MY_CHANNEL", "presence-abcd", "foo-bar_1234@=,.;", "a"*164]
+      end
+    end
+
+    context "with invalid characters" do
+      let(:channels) { ["MY_CHANNEL:presence-abcd", "presence-abcd"] }
+
+      it "rejects invalid channels" do
+        expect{ Slanger::Api::RequestValidation.new(body, {}, "")}.to raise_error Slanger::Api::InvalidRequest
+      end
+    end
+
+    context "with invalid channel length" do
+      let(:channels) { ["a"*165] }
+
+      it "rejects names longer than 164 characters" do
+        expect{ Slanger::Api::RequestValidation.new(body, {}, "")}.to raise_error Slanger::Api::InvalidRequest
+      end
+    end
+  end
+
+  describe "#socket_id" do
+    it do
+      rv = Slanger::Api::RequestValidation.new(body("1234.5678"), {}, "")
+      expect(rv.socket_id).to eq "1234.5678"
+    end
+  end
+
+  def validate(socket_id)
+    Slanger::Api::RequestValidation.new(body(socket_id), {}, "").socket_id
+  end
+
+  def body(socket_id)
+    {socket_id: socket_id}.to_json
+  end
+end
+

data/spec/unit/webhook_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'lib/slanger/webhook'
+
+describe 'Slanger::Webhook' do
+
+  around do |example|
+    Slanger::Config.load webhook_url: 'https://example.com/pusher',
+      app_key: 'PUSHER_APP_KEY', secret: 'secret'
+    WebMock.enable!
+    Timecop.freeze(Time.now) { example.run }
+    WebMock.disable!
+    Slanger::Config.load webhook_url: nil
+  end
+
+  describe '.post' do
+    it 'make a POST request to the endpoint' do
+      payload = {
+        time_ms: Time.now.strftime('%s%L'),
+        events: [{ name: 'channel_occupied', channel: 'test channel' }]
+      }.to_json
+
+      digest   = OpenSSL::Digest::SHA256.new
+      hmac     = OpenSSL::HMAC.hexdigest(digest, Slanger::Config.secret, payload)
+
+      stub_request(:post, Slanger::Config.webhook_url).
+        with(body: payload, headers: {
+            "X-Pusher-Key"    => Slanger::Config.app_key,
+            "X-Pusher-Signature" => hmac,
+            "Content-Type" => 'application/json'
+        }).
+        to_return(:status => 200, :body => {}.to_json, :headers => {})
+
+      Slanger::Webhook.post name: 'channel_occupied', channel: 'test channel'
+
+      expect(WebMock).to have_requested(:post, Slanger::Config.webhook_url).
+        with(body: payload, headers: {
+            "X-Pusher-Key"    => Slanger::Config.app_key,
+            "X-Pusher-Signature" => hmac,
+            "Content-Type" => 'application/json'
+        })
+    end
+  end
+end

metadata

@@ -0,0 +1,392 @@
+--- !ruby/object:Gem::Specification
+name: slangerq
+version: !ruby/object:Gem::Version
+  version: 0.6.1
+platform: ruby
+authors:
+- Stevie Graham
+- Mark Burns
+- KP
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: em-hiredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: em-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+- !ruby/object:Gem::Dependency
+  name: rack-fiber_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: signature
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: pusher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.5
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+description: A websocket service compatible with Pusher libraries
+email:
+- sjtgraham@mac.com
+- markthedeveloper@gmail.com
+executables:
+- slanger
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/slanger
+- lib/slanger/api.rb
+- lib/slanger/api/event.rb
+- lib/slanger/api/event_publisher.rb
+- lib/slanger/api/request_validation.rb
+- lib/slanger/api/server.rb
+- lib/slanger/channel.rb
+- lib/slanger/config.rb
+- lib/slanger/connection.rb
+- lib/slanger/handler.rb
+- lib/slanger/logger.rb
+- lib/slanger/presence_channel.rb
+- lib/slanger/presence_subscription.rb
+- lib/slanger/private_subscription.rb
+- lib/slanger/redis.rb
+- lib/slanger/service.rb
+- lib/slanger/subscription.rb
+- lib/slanger/version.rb
+- lib/slanger/web_socket_server.rb
+- lib/slanger/webhook.rb
+- slanger.rb
+- spec/have_attributes.rb
+- spec/integration/channel_spec.rb
+- spec/integration/integration_spec.rb
+- spec/integration/presence_channel_spec.rb
+- spec/integration/private_channel_spec.rb
+- spec/integration/replaced_handler_spec.rb
+- spec/integration/ssl_spec.rb
+- spec/server.crt
+- spec/server.key
+- spec/slanger_helper_methods.rb
+- spec/spec_helper.rb
+- spec/unit/channel_spec.rb
+- spec/unit/request_validation_spec.rb
+- spec/unit/webhook_spec.rb
+homepage: https://github.com/stevegraham/slanger
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- "."
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A websocket service compatible with Pusher libraries
+test_files:
+- spec/have_attributes.rb
+- spec/integration/channel_spec.rb
+- spec/integration/integration_spec.rb
+- spec/integration/presence_channel_spec.rb
+- spec/integration/private_channel_spec.rb
+- spec/integration/replaced_handler_spec.rb
+- spec/integration/ssl_spec.rb
+- spec/server.crt
+- spec/server.key
+- spec/slanger_helper_methods.rb
+- spec/spec_helper.rb
+- spec/unit/channel_spec.rb
+- spec/unit/request_validation_spec.rb
+- spec/unit/webhook_spec.rb