rails_chat 0.0.1

data/spec/rails_chat/faye_extension_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+
+describe RailsChat::FayeExtension do
+  before(:each) do
+    RailsChat.reset_config
+    @faye = RailsChat::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"]["rails_chat_signature"] = "bad"
+    @message["ext"]["rails_chat_timestamp"] = "123"
+    message = @faye.incoming(@message, lambda { |m| m })
+    message["error"].should eq("Incorrect signature.")
+  end
+
+  it "has no error when the signature matches the subscription" do
+    sub = RailsChat.subscription(:channel => "hello")
+    @message["subscription"] = sub[:channel]
+    @message["ext"]["rails_chat_signature"] = sub[:signature]
+    @message["ext"]["rails_chat_timestamp"] = sub[:timestamp]
+    message = @faye.incoming(@message, lambda { |m| m })
+    message["error"].should be_nil
+  end
+
+  it "has an error when signature just expired" do
+    RailsChat.config[:signature_expiration] = 1
+    sub = RailsChat.subscription(:timestamp => 123, :channel => "hello")
+    @message["subscription"] = sub[:channel]
+    @message["ext"]["rails_chat_signature"] = sub[:signature]
+    @message["ext"]["rails_chat_timestamp"] = sub[:timestamp]
+    message = @faye.incoming(@message, lambda { |m| m })
+    message["error"].should eq("Signature has expired.")
+  end
+
+  it "has an error when trying to publish to a custom channel with a bad token" do
+    RailsChat.config[:secret_token] = "good"
+    @message["channel"] = "/custom/channel"
+    @message["ext"]["rails_chat_token"] = "bad"
+    message = @faye.incoming(@message, lambda { |m| m })
+    message["error"].should 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"]["rails_chat_token"] = "bad"
+    lambda {
+      message = @faye.incoming(@message, lambda { |m| m })
+    }.should raise_error("No secret_token config set, ensure rails_chat.yml is loaded properly.")
+  end
+
+  it "has no error on other meta calls" do
+    @message["channel"] = "/meta/connect"
+    message = @faye.incoming(@message, lambda { |m| m })
+    message["error"].should be_nil
+  end
+
+  it "should not let message carry the RailsChat token after server's validation" do
+    RailsChat.config[:secret_token] = "good"
+    @message["channel"] = "/custom/channel"
+    @message["ext"]["rails_chat_token"] = RailsChat.config[:secret_token]
+    message = @faye.incoming(@message, lambda { |m| m })
+    message['ext']["rails_chat_token"].should be_nil
+  end
+
+end

data/spec/rails_chat_spec.rb

@@ -0,0 +1,141 @@
+require "spec_helper"
+
+describe RailsChat do
+  before(:each) do
+    RailsChat.reset_config
+  end
+
+  it "defaults server to nil" do
+    RailsChat.config[:server].should be_nil
+  end
+
+  it "defaults signature_expiration to nil" do
+    RailsChat.config[:signature_expiration].should be_nil
+  end
+
+  it "defaults subscription timestamp to current time in milliseconds" do
+    time = Time.now
+    Time.stub!(:now).and_return(time)
+    RailsChat.subscription[:timestamp].should eq((time.to_f * 1000).round)
+  end
+
+  it "loads a simple configuration file via load_config" do
+    RailsChat.load_config("spec/fixtures/rails_chat.yml", "production")
+    RailsChat.config[:server].should eq("http://example.com/faye")
+    RailsChat.config[:secret_token].should eq("PRODUCTION_SECRET_TOKEN")
+    RailsChat.config[:signature_expiration].should eq(600)
+  end
+
+  it "raises an exception if an invalid environment is passed to load_config" do
+    lambda {
+      RailsChat.load_config("spec/fixtures/rails_chat.yml", :test)
+    }.should raise_error ArgumentError
+  end
+
+  it "includes channel, server, and custom time in subscription" do
+    RailsChat.config[:server] = "server"
+    subscription = RailsChat.subscription(:timestamp => 123, :channel => "hello")
+    subscription[:timestamp].should eq(123)
+    subscription[:channel].should eq("hello")
+    subscription[:server].should eq("server")
+  end
+
+  it "does a sha1 digest of channel, timestamp, and secret token" do
+    RailsChat.config[:secret_token] = "token"
+    subscription = RailsChat.subscription(:timestamp => 123, :channel => "channel")
+    subscription[:signature].should eq(Digest::SHA1.hexdigest("tokenchannel123"))
+  end
+
+  it "formats a message hash given a channel and a string for eval" do
+    RailsChat.config[:secret_token] = "token"
+    RailsChat.message("chan", "foo").should eq(
+      :ext => {:rails_chat_token => "token"},
+      :channel => "chan",
+      :data => {
+        :channel => "chan",
+        :eval => "foo"
+      }
+    )
+  end
+
+  it "formats a message hash given a channel and a hash" do
+    RailsChat.config[:secret_token] = "token"
+    RailsChat.message("chan", :foo => "bar").should eq(
+      :ext => {:rails_chat_token => "token"},
+      :channel => "chan",
+      :data => {
+        :channel => "chan",
+        :data => {:foo => "bar"}
+      }
+    )
+  end
+
+  it "publish message as json to server using Net::HTTP" do
+    RailsChat.config[:server] = "http://localhost"
+    message = 'foo'
+    form = mock(:post).as_null_object
+    http = mock(:http).as_null_object
+
+    Net::HTTP::Post.should_receive(:new).with('/').and_return(form)
+    form.should_receive(:set_form_data).with(message: 'foo'.to_json)
+
+    Net::HTTP.should_receive(:new).with('localhost', 80).and_return(http)
+    http.should_receive(:start).and_yield(http)
+    http.should_receive(:request).with(form).and_return(:result)
+
+    RailsChat.publish_message(message).should eq(:result)
+  end
+
+  it "it should use HTTPS if the server URL says so" do
+    RailsChat.config[:server] = "https://localhost"
+    http = mock(:http).as_null_object
+
+    Net::HTTP.should_receive(:new).and_return(http)
+    http.should_receive(:use_ssl=).with(true)
+
+    RailsChat.publish_message('foo')
+  end
+
+  it "it should not use HTTPS if the server URL says not to" do
+    RailsChat.config[:server] = "http://localhost"
+    http = mock(:http).as_null_object
+
+    Net::HTTP.should_receive(:new).and_return(http)
+    http.should_receive(:use_ssl=).with(false)
+
+    RailsChat.publish_message('foo')
+  end
+
+  it "raises an exception if no server is specified when calling publish_message" do
+    lambda {
+      RailsChat.publish_message("foo")
+    }.should raise_error(RailsChat::Error)
+  end
+
+  it "publish_to passes message to publish_message call" do
+    RailsChat.should_receive(:message).with("chan", "foo").and_return("message")
+    RailsChat.should_receive(:publish_message).with("message").and_return(:result)
+    RailsChat.publish_to("chan", "foo").should eq(:result)
+  end
+
+  it "has a Faye rack app instance" do
+    RailsChat.faye_app.should be_kind_of(Faye::RackAdapter)
+  end
+
+  it "says signature has expired when time passed in is greater than expiration" do
+    RailsChat.config[:signature_expiration] = 30*60
+    time = RailsChat.subscription[:timestamp] - 31*60*1000
+    RailsChat.signature_expired?(time).should be_true
+  end
+
+  it "says signature has not expired when time passed in is less than expiration" do
+    RailsChat.config[:signature_expiration] = 30*60
+    time = RailsChat.subscription[:timestamp] - 29*60*1000
+    RailsChat.signature_expired?(time).should be_false
+  end
+
+  it "says signature has not expired when expiration is nil" do
+    RailsChat.config[:signature_expiration] = nil
+    RailsChat.signature_expired?(0).should be_false
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'json'
+require 'faye'
+Bundler.require(:default)
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: rails_chat
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- ! '[CISROR Team, Erfan Mansuri]'
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faye
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: jasmine
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+description: ! 'RailsChat is a Ruby gem for use with Rails to publish and subscribe
+  to messages through Faye. It allows you to easily provide real-time updates through
+  an open socket without tying up a Rails process. All channels are private so users
+  can only listen to events you subscribe them to. Refrence gem: https://github.com/ryanb/private_pub'
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/stylesheets/emoticons.css
+- app/assets/images/emoticons.png
+- app/assets/javascripts/rails_chat.js
+- app/assets/javascripts/emoticons.js
+- app/assets/javascripts/emoticons_defination.js
+- lib/rails_chat.rb
+- lib/rails_chat/view_helpers.rb
+- lib/rails_chat/faye_extension.rb
+- lib/rails_chat/engine.rb
+- lib/generators/rails_chat/templates/rails_chat.ru
+- lib/generators/rails_chat/templates/rails_chat.yml
+- lib/generators/rails_chat/install_generator.rb
+- spec/rails_chat/faye_extension_spec.rb
+- spec/fixtures/rails_chat.yml
+- spec/javascripts/support/jasmine_runner.rb
+- spec/javascripts/support/jasmine_config.rb
+- spec/javascripts/support/jasmine.yml
+- spec/javascripts/rails_chat_spec.js
+- spec/spec_helper.rb
+- spec/rails_chat_spec.rb
+- Rakefile
+- Gemfile
+- LICENSE
+- README.md
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.4
+requirements: []
+rubyforge_project: rails_chat
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ! 'RailsChat is a Ruby gem for use with Rails to publish and subscribe to
+  messages through Faye. It allows you to easily provide real-time updates through
+  an open socket without tying up a Rails process. All channels are private so users
+  can only listen to events you subscribe them to. Refrence gem: https://github.com/ryanb/private_pub'
+test_files: []