edmond-danthes 2.1.0

data/spec/danthes/faye_extension_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Danthes::FayeExtension do
+  before(:each) do
+    Danthes.startup
+    @faye = Danthes::FayeExtension.new
+    @message = { 'channel' => '/meta/subscribe', 'ext' => {} }
+  end
+
+  it 'adds an error on an incoming subscription with a bad signature' do
+    @message['subscription'] = 'hello'
+    @message['ext']['danthes_signature'] = 'bad'
+    @message['ext']['danthes_timestamp'] = '123'
+    message = @faye.incoming(@message, ->(m) { m })
+    expect(message['error']).to eq('Incorrect signature.')
+  end
+
+  it 'has no error when the signature matches the subscription' do
+    sub = Danthes.subscription(channel: 'hello')
+    @message['subscription'] = sub[:channel]
+    @message['ext']['danthes_signature'] = sub[:signature]
+    @message['ext']['danthes_timestamp'] = sub[:timestamp]
+    message = @faye.incoming(@message, ->(m) { m })
+    expect(message['error']).to be_nil
+  end
+
+  it 'has an error when signature just expired' do
+    Danthes.config[:signature_expiration] = 1
+    sub = Danthes.subscription(timestamp: 123, channel: 'hello')
+    @message['subscription'] = sub[:channel]
+    @message['ext']['danthes_signature'] = sub[:signature]
+    @message['ext']['danthes_timestamp'] = sub[:timestamp]
+    message = @faye.incoming(@message, ->(m) { m })
+    expect(message['error']).to eq('Signature has expired.')
+  end
+
+  it 'has an error when trying to publish to a custom channel with a bad token' do
+    Danthes.config[:secret_token] = 'good'
+    @message['channel'] = '/custom/channel'
+    @message['ext']['danthes_token'] = 'bad'
+    message = @faye.incoming(@message, ->(m) { m })
+    expect(message['error']).to eq('Incorrect token.')
+  end
+
+  it 'raises an exception when attempting to call a custom channel without a secret_token set' do
+    @message['channel'] = '/custom/channel'
+    @message['ext']['danthes_token'] = 'bad'
+    expect do
+      message = @faye.incoming(@message, ->(m) { m })
+    end.to raise_error('No secret_token config set, ensure danthes.yml is loaded properly.')
+  end
+
+  it 'has no error on other meta calls' do
+    @message['channel'] = '/meta/connect'
+    message = @faye.incoming(@message, ->(m) { m })
+    expect(message['error']).to be_nil
+  end
+
+  it "should not let message carry the private pub token after server's validation" do
+    Danthes.config[:secret_token] = 'good'
+    @message['channel'] = '/custom/channel'
+    @message['ext']['danthes_token'] = Danthes.config[:secret_token]
+    message = @faye.incoming(@message, ->(m) { m })
+    expect(message['ext']['danthes_token']).to be_nil
+  end
+
+end

data/spec/danthes/view_helpers_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'danthes/view_helpers'
+
+module Danthes
+  describe ViewHelpers do
+
+    let(:klass) do
+      Class.new do
+        include ActionView::Helpers::TagHelper
+        include ActionView::Context
+        include ViewHelpers
+      end
+    end
+
+    describe '#subscribe_to' do
+      it "generates javascript tag by default" do
+        expect(klass.new.subscribe_to('hello')).to match /\A<script.*<\/script>\z/
+      end
+
+      it "removes javascript tag when *include_js_tag* is set to false" do
+        expect(klass.new.subscribe_to('hello', include_js_tag: false)).to match /\Aif \(typeof Danthes \!= 'undefined'\) { Danthes.sign\(.*\) }\z/
+      end
+    end
+
+  end
+end

data/spec/danthes_spec.rb

@@ -0,0 +1,193 @@
+require 'spec_helper'
+
+describe Danthes do
+  before(:each) do
+    Danthes.startup
+  end
+
+  let(:config) { Danthes.config }
+
+  it 'defaults server to nil' do
+    expect(config[:server]).to be_nil
+  end
+
+  it 'defaults signature_expiration to nil' do
+    expect(config[:signature_expiration]).to be_nil
+  end
+
+  it 'defaults subscription timestamp to current time in milliseconds' do
+    time = Time.now
+    allow(Time).to receive(:now).and_return(time)
+    expect(Danthes.subscription[:timestamp]).to eq((time.to_f * 1000).round)
+  end
+
+  it 'loads a simple configuration file via load_config' do
+    Danthes.env = 'production'
+    Danthes.load_config('spec/fixtures/danthes.yml')
+    expect(config[:server]).to eq('http://example.com/faye')
+    expect(config[:secret_token]).to eq('PRODUCTION_SECRET_TOKEN')
+    expect(config[:signature_expiration]).to eq(600)
+    expect(config[:adapter]).to eq('thin')
+  end
+
+  it 'loads configuration file with erb via load_config' do
+    ENV['DANTHES_SERVER'] = 'http://example.com'
+    Danthes.env = 'production'
+    Danthes.load_config('spec/fixtures/danthes_with_erb.yml')
+    expect(config[:server]).to eq('http://example.com')
+  end
+
+  context 'when redis config exists' do
+    before do
+      Danthes.env = 'production'
+      Danthes.load_config('spec/fixtures/danthes.yml')
+      Danthes.load_redis_config('spec/fixtures/danthes_redis.yml')
+    end
+
+    it 'passes redis config to faye engine options' do
+      expect(config[:engine][:type]).to eq Faye::Redis
+      expect(config[:engine][:host]).to eq 'redis_host'
+      expect(config[:engine][:port]).to eq 'redis_port'
+      expect(config[:engine][:password]).to eq 'redis_password'
+      expect(config[:engine][:database]).to eq 'redis_database'
+      expect(config[:engine][:namespace]).to eq '/namespace'
+    end
+
+    it 'should pass redis config and default options to faye' do
+      expect(Faye::RackAdapter).to receive(:new) do |options|
+        expect(options[:engine]).to eq Danthes.config[:engine]
+        expect(options[:mount]).to eq '/faye'
+      end
+      Danthes.faye_app
+    end
+  end
+
+  context 'when redis config does not exist' do
+    it 'should not have :engine inside of config hash' do
+      expect(config).not_to include :engine
+    end
+
+    it 'should have mount point' do
+      expect(config[:mount]).to eq '/faye'
+    end
+  end
+
+  it 'raises an exception if an invalid environment is passed to load_config' do
+    expect do
+      Danthes.load_config('spec/fixtures/danthes.yml', 'foo')
+    end.to raise_error ArgumentError
+  end
+
+  it 'includes channel, server, and custom time in subscription' do
+    Danthes.config[:server] = 'server'
+    Danthes.config[:mount] = '/faye'
+    subscription = Danthes.subscription(timestamp: 123, channel: 'hello')
+    expect(subscription[:timestamp]).to eq(123)
+    expect(subscription[:channel]).to eq('hello')
+    expect(subscription[:server]).to eq('server/faye')
+  end
+
+  it 'returns full server url from server and mount configs' do
+    Danthes.config[:server] = 'server.com'
+    Danthes.config[:mount] = '/faye'
+    expect(Danthes.server_url).to eq('server.com/faye')
+  end
+
+  it 'does a sha1 digest of channel, timestamp, and secret token' do
+    Danthes.config[:secret_token] = 'token'
+    subscription = Danthes.subscription(timestamp: 123, channel: 'channel')
+    expect(subscription[:signature]).to eq(Digest::SHA1.hexdigest('tokenchannel123'))
+  end
+
+  it 'formats a message hash given a channel and a string for eval' do
+    Danthes.config[:secret_token] = 'token'
+    expect(Danthes.message('chan', 'foo')).to eq(
+      ext: { danthes_token: 'token' },
+      channel: 'chan',
+      data: {
+        channel: 'chan',
+        eval: 'foo'
+      }
+    )
+  end
+
+  it 'formats a message hash given a channel and a hash' do
+    Danthes.config[:secret_token] = 'token'
+    expect(Danthes.message('chan', foo: 'bar')).to eq(
+      ext: { danthes_token: 'token' },
+      channel: 'chan',
+      data: {
+        channel: 'chan',
+        data: { foo: 'bar' }
+      }
+    )
+  end
+
+  it 'publish message as json to server using Net::HTTP' do
+    Danthes.config[:server] = 'http://localhost'
+    Danthes.config[:mount] = '/faye/path'
+    message = 'foo'
+    faye = stub_request(:post, 'http://localhost/faye/path').
+             with(body: { 'message' => "\"foo\"" },
+                  headers: { 'Accept' => '*/*', 'Content-Type' => 'application/x-www-form-urlencoded', 'User-Agent' => 'Ruby' }).
+             to_return(status: 200, body: '', headers: {})
+    Danthes.publish_message(message)
+    expect(faye).to have_been_made.once
+  end
+
+  it 'it should use HTTPS if the server URL says so' do
+    Danthes.config[:server] = 'https://localhost'
+    Danthes.config[:mount] = '/faye/path'
+    http = double(:http).as_null_object
+
+    expect(Net::HTTP).to receive(:new).and_return(http)
+    expect(http).to receive(:use_ssl=).with(true)
+
+    Danthes.publish_message('foo')
+  end
+
+  it 'it should not use HTTPS if the server URL says not to' do
+    Danthes.config[:server] = 'http://localhost'
+    http = double(:http).as_null_object
+
+    expect(Net::HTTP).to receive(:new).and_return(http)
+    expect(http).to receive(:use_ssl=).with(false)
+
+    Danthes.publish_message('foo')
+  end
+
+  it 'raises an exception if no server is specified when calling publish_message' do
+    expect do
+      Danthes.publish_message('foo')
+    end.to raise_error(Danthes::Error)
+  end
+
+  it 'publish_to passes message to publish_message call' do
+    expect(Danthes).to receive(:message).with('chan', 'foo').and_return('message')
+    expect(Danthes).to receive(:publish_message).with('message').and_return(:result)
+    expect(Danthes.publish_to('chan', 'foo')).to eq(:result)
+  end
+
+  it 'has a Faye rack app instance' do
+    Danthes.env = 'production'
+    Danthes.load_config('spec/fixtures/danthes.yml')
+    expect(Danthes.faye_app).to be_kind_of(Faye::RackAdapter)
+  end
+
+  it 'says signature has expired when time passed in is greater than expiration' do
+    Danthes.config[:signature_expiration] = 30 * 60
+    time = Danthes.subscription[:timestamp] - 31 * 60 * 1000
+    expect(Danthes.signature_expired?(time)).to be_truthy
+  end
+
+  it 'says signature has not expired when time passed in is less than expiration' do
+    Danthes.config[:signature_expiration] = 30 * 60
+    time = Danthes.subscription[:timestamp] - 29 * 60 * 1000
+    expect(Danthes.signature_expired?(time)).to be_falsy
+  end
+
+  it 'says signature has not expired when expiration is nil' do
+    Danthes.config[:signature_expiration] = nil
+    expect(Danthes.signature_expired?(0)).to be_falsy
+  end
+end

data/spec/fake_app/rails_app.rb

@@ -0,0 +1,18 @@
+ENV['RAILS_ENV'] ||= 'test'
+
+require 'action_controller/railtie'
+require 'danthes'
+
+module RailsApp
+  class Application < Rails::Application
+    config.active_support.deprecation = :log
+    config.cache_classes = true
+    config.eager_load = false
+    config.root = __dir__
+    config.secret_token = 'x'*100
+    config.session_store :cookie_store, key: '_myapp_session'
+  end
+end
+
+Rails.backtrace_cleaner.remove_silencers!
+RailsApp::Application.initialize!

data/spec/fixtures/danthes.yml

@@ -0,0 +1,10 @@
+development:
+  adapter: thin
+  server: http://dev.local:9292/faye
+  secret_token: DEVELOPMENT_SECRET_TOKEN
+  signature_expiration: 600
+production:
+  adapter: thin
+  server: http://example.com/faye
+  secret_token: PRODUCTION_SECRET_TOKEN
+  signature_expiration: 600

data/spec/fixtures/danthes_redis.yml

@@ -0,0 +1,6 @@
+production:
+  host: redis_host
+  port: redis_port
+  password: redis_password
+  database: redis_database
+  namespace: '/namespace'

data/spec/fixtures/danthes_with_erb.yml

@@ -0,0 +1,10 @@
+development:
+  adapter: thin
+  server: http://dev.local:9292/faye
+  secret_token: DEVELOPMENT_SECRET_TOKEN
+  signature_expiration: 600
+production:
+  adapter: thin
+  server: <%= ENV['DANTHES_SERVER'] %>
+  secret_token: PRODUCTION_SECRET_TOKEN
+  signature_expiration: 600

data/spec/javascripts/support/jasmine.yml

@@ -0,0 +1,9 @@
+src_dir: app/assets/javascripts/compiled
+
+src_files:
+  - danthes.js
+
+spec_dir: spec/coffeescripts/compiled
+
+spec_files:
+  - danthesSpec.js

data/spec/javascripts/support/jasmine_helper.rb

@@ -0,0 +1,11 @@
+# Use this file to set/override Jasmine configuration options
+# You can remove it if you don't need it.
+# This file is loaded *after* jasmine.yml is interpreted.
+#
+# Example: using a different boot file.
+Jasmine.configure do |config|
+  config.ci_port = 8888
+  #   config.boot_dir = '/absolute/path/to/boot_dir'
+  #   config.boot_files = lambda { ['/absolute/path/to/boot_dir/file.js'] }
+end
+#

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.start do
+  add_filter 'spec'
+  minimum_coverage(76)
+end
+
+Bundler.require(:default)
+require 'faye'
+require 'faye/redis'
+require 'webmock/rspec'
+
+begin
+  require 'rails'
+rescue LoadError
+else
+  require 'fake_app/rails_app'
+end
+
+RSpec.configure do |_config|
+end

metadata

@@ -0,0 +1,274 @@
+--- !ruby/object:Gem::Specification
+name: edmond-danthes
+version: !ruby/object:Gem::Version
+  version: 2.1.0
+platform: ruby
+authors:
+- Alexander Simonov
+- Dmitry Zuev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faye
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: faye-redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard-coffeescript
+  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'
+- !ruby/object:Gem::Dependency
+  name: jasmine
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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'
+- !ruby/object:Gem::Dependency
+  name: therubyracer
+  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'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: Private pub/sub messaging in Rails through Faye. More Faye features supported.
+  Based on PrivatePub.
+email:
+- alex@simonov.me
+- mail@dmitryzuev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/danthes.js.coffee
+- defaults.reek
+- edmond-danthes.gemspec
+- lib/danthes.rb
+- lib/danthes/engine.rb
+- lib/danthes/faye_extension.rb
+- lib/danthes/version.rb
+- lib/danthes/view_helpers.rb
+- lib/generators/danthes/install_generator.rb
+- lib/generators/danthes/redis_install_generator.rb
+- lib/generators/danthes_generator.rb
+- lib/generators/templates/danthes.ru
+- lib/generators/templates/danthes.yml
+- lib/generators/templates/danthes_redis.yml
+- spec/coffeescripts/danthesSpec.js.coffee
+- spec/danthes/faye_extension_spec.rb
+- spec/danthes/view_helpers_spec.rb
+- spec/danthes_spec.rb
+- spec/fake_app/rails_app.rb
+- spec/fixtures/danthes.yml
+- spec/fixtures/danthes_redis.yml
+- spec/fixtures/danthes_with_erb.yml
+- spec/javascripts/support/jasmine.yml
+- spec/javascripts/support/jasmine_helper.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dmitryzuev/edmond-danthes
+licenses: []
+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.7.7
+signing_key:
+specification_version: 4
+summary: Private pub/sub messaging through Faye.
+test_files:
+- spec/coffeescripts/danthesSpec.js.coffee
+- spec/danthes/faye_extension_spec.rb
+- spec/danthes/view_helpers_spec.rb
+- spec/danthes_spec.rb
+- spec/fake_app/rails_app.rb
+- spec/fixtures/danthes.yml
+- spec/fixtures/danthes_redis.yml
+- spec/fixtures/danthes_with_erb.yml
+- spec/javascripts/support/jasmine.yml
+- spec/javascripts/support/jasmine_helper.rb
+- spec/spec_helper.rb