private_pub_plus 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b4ac9b51e06591b63f0129bf5d46d41ff2abb3bf
+  data.tar.gz: 8ab9a851ac353c79bde3218e7eaf98eadde9d998
+SHA512:
+  metadata.gz: 92681a6f81ef940a9e07357626cec5bca7ffc9983118bf3a38c0e2c09d9ffe35cab9b4e979e6db227ea0800f81d2ed948c7dac4cec862053b2c43aabc23353f2
+  data.tar.gz: 88ed9116c56e5bbee7f11e8da6d5f79a4952cf8483fee5ca0afe1b43eff887c5fbacdc9b83ff21d60e04c4c250529f97c111acbb4f6651f5d6f038478061e4a7

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Ryan Bates
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Private Pub Plus
+
+Private Pub Plus is a Ruby gem for use with Rails to publish and subscribe to messages through [Faye](http://faye.jcoglan.com/). 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.
+
+Inspired by [Private pub Gem](https://github.com/ryanb/private_pub)
+Watch [RailsCasts Episode 316](http://railscasts.com/episodes/316-private-pub) for a demonstration of Private Pub.
+
+
+## Setup
+
+Add the gem to your Gemfile and run the `bundle` command to install it. You'll probably want to add "thin" to your Gemfile as well to serve Faye.
+
+```ruby
+gem "private_pub_plus", git: "git://github.com/amritsingh/private_pub.git"
+gem "thin"
+```
+
+Run the generator to create the initial files.
+
+```
+rails g private_pub_plus:install
+```
+This will generate a file in Rails root directory - 'private_pub.ru'.
+Authentication of subscribe and publish messages can be modified based on the needs of the application.
+
+
+Next, start up Faye using the rackup file that was generated.
+
+```
+rackup private_pub.ru -s thin -E production
+```
+
+## Usage
+
+Use the `publish_to` method to send data to that channel.
+
+```ruby
+PrivatePubPlus.publish_to "/messages/new", :chat_message => "Hello, world!" do |channel, data|
+  # construct a message here. This message is sent to the subscribed clients e.g.
+  # {:channel => channel, :data => {:channel => channel, :data => data, :time => Time.now}, :ext => {:private_pub_token => <secret_token from config/private_pub.yml>}}
+end
+```
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc "Run RSpec"
+RSpec::Core::RakeTask.new do |t|
+  t.verbose = false
+end
+
+task :default => [:spec]

data/lib/generators/private_pub_plus/install_generator.rb

@@ -0,0 +1,14 @@
+module PrivatePubPlus
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      def self.source_root
+        File.dirname(__FILE__) + "/templates"
+      end
+
+      def copy_files
+        template "private_pub.yml", "config/private_pub.yml"
+        copy_file "private_pub.ru", "private_pub.ru"
+      end
+    end
+  end
+end

data/lib/generators/private_pub_plus/templates/private_pub.ru

@@ -0,0 +1,45 @@
+# Run with: rackup private_pub.ru -s thin -E production
+require "bundler/setup"
+require "yaml"
+require "faye"
+require "private_pub"
+
+module PrivatePubPlus
+  # This class is an extension for the Faye::RackAdapter.
+  # It is used inside of PrivatePubPlus.faye_app.
+  class FayeExtension
+    # Callback to handle incoming Faye messages. This authenticates both
+    # subscribe and publish calls.
+    def incoming(message, callback)
+      if message["channel"] == "/meta/subscribe"
+        authenticate_subscribe(message)
+      elsif message["channel"] !~ %r{^/meta/}
+        authenticate_publish(message)
+      end
+      callback.call(message)
+    end
+
+    private
+    def authenticate_subscribe(message)
+      # TODO:
+      # Code to authenticate the subscribe message.
+    end
+
+    def authenticate_publish(message)
+      # TODO:
+      # Code to authenticate the publish message
+      if PrivatePubPlus.config[:secret_token].nil?
+        raise Error, "No secret_token config set, ensure private_pub.yml is loaded properly."
+      elsif message["ext"]["private_pub_token"] != PrivatePubPlus.config[:secret_token]
+        message["error"] = "Incorrect token."
+      else
+        message["ext"]["private_pub_token"] = nil
+      end
+    end
+  end
+end
+
+Faye::WebSocket.load_adapter('thin')
+
+PrivatePubPlus.load_config(File.expand_path("../config/private_pub.yml", __FILE__), ENV["RAILS_ENV"] || "development")
+run PrivatePubPlus.faye_app

data/lib/generators/private_pub_plus/templates/private_pub.yml

@@ -0,0 +1,10 @@
+development:
+  server: "http://localhost:9292/faye"
+  secret_token: "secret"
+test:
+  server: "http://localhost:9292/faye"
+  secret_token: "secret"
+production:
+  server: "http://example.com/faye"
+  secret_token: "<%= defined?(SecureRandom) ? SecureRandom.hex(32) : ActiveSupport::SecureRandom.hex(32) %>"
+  signature_expiration: 3600 # one hour

data/lib/private_pub_plus/engine.rb

@@ -0,0 +1,14 @@
+module PrivatePubPlus
+  class Engine < Rails::Engine
+    # Loads the private_pub.yml file if it exists.
+    initializer "private_pub.config" do
+      path = Rails.root.join("config/private_pub.yml")
+      PrivatePubPlus.load_config(path, Rails.env) if path.exist?
+    end
+
+    # Adds the ViewHelpers into ActionView::Base
+    #initializer "private_pub.view_helpers" do
+    #  ActionView::Base.send :include, ViewHelpers
+    #end
+  end
+end

data/lib/private_pub_plus/faye_extension.rb

@@ -0,0 +1,39 @@
+module PrivatePubPlus
+  # This class is an extension for the Faye::RackAdapter.
+  # It is used inside of PrivatePubPlus.faye_app.
+  class FayeExtension
+    # Callback to handle incoming Faye messages. This authenticates both
+    # subscribe and publish calls.
+    def incoming(message, callback)
+      if message["channel"] == "/meta/subscribe"
+        authenticate_subscribe(message)
+      elsif message["channel"] !~ %r{^/meta/}
+        authenticate_publish(message)
+      end
+      callback.call(message)
+    end
+
+  private
+
+    # Ensure the subscription signature is correct and that it has not expired.
+    def authenticate_subscribe(message)
+      subscription = PrivatePubPlus.subscription(:channel => message["subscription"], :timestamp => message["ext"]["private_pub_timestamp"])
+      if message["ext"]["private_pub_signature"] != subscription[:signature]
+        message["error"] = "Incorrect signature."
+      elsif PrivatePubPlus.signature_expired? message["ext"]["private_pub_timestamp"].to_i
+        message["error"] = "Signature has expired."
+      end
+    end
+
+    # Ensures the secret token is correct before publishing.
+    def authenticate_publish(message)
+      if PrivatePubPlus.config[:secret_token].nil?
+        raise Error, "No secret_token config set, ensure private_pub.yml is loaded properly."
+      elsif message["ext"]["private_pub_token"] != PrivatePubPlus.config[:secret_token]
+        message["error"] = "Incorrect token."
+      else
+        message["ext"]["private_pub_token"] = nil
+      end
+    end
+  end
+end

data/lib/private_pub_plus/version.rb

@@ -0,0 +1,3 @@
+module PrivatePubPlus
+  VERSION = "1.0.0"
+end

data/lib/private_pub_plus.rb

@@ -0,0 +1,85 @@
+require "digest/sha1"
+require "net/http"
+require "net/https"
+require "yaml"
+
+require "private_pub_plus/faye_extension"
+require "private_pub_plus/engine" if defined? Rails
+
+module PrivatePubPlus
+  class Error < StandardError; end
+
+  class << self
+    attr_reader :config
+
+    # Resets the configuration to the default (empty hash)
+    def reset_config
+      @config = {}
+    end
+
+    # Loads the  configuration from a given YAML file and environment (such as production)
+    def load_config(filename, environment)
+      yaml = YAML.load_file(filename)[environment.to_s]
+      raise ArgumentError, "The #{environment} environment does not exist in #{filename}" if yaml.nil?
+      yaml.each { |k, v| config[k.to_sym] = v }
+    end
+
+    # Publish the given data to a specific channel. This ends up sending
+    # a Net::HTTP POST request to the Faye server.
+    def publish_to(channel, data, &block)
+      m = nil
+      if block_given?
+        m = block.call(channel, data)
+      else
+        m = message(channel, data)
+      end
+      publish_message(m)
+    end
+
+    # Sends the given message hash to the Faye server using Net::HTTP.
+    def publish_message(message)
+      raise Error, "No server specified, ensure private_pub.yml was loaded properly." unless config[:server]
+      url = URI.parse(config[:server])
+
+      form = Net::HTTP::Post.new(url.path.empty? ? '/' : url.path)
+      form.set_form_data(:message => message.to_json)
+
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = url.scheme == "https"
+      http.start {|h| h.request(form)}
+    end
+
+    # Returns a message hash for sending to Faye
+    def message(channel, data)
+      message = {:channel => channel, :data => {:channel => channel}, :ext => {:private_pub_token => config[:secret_token]}}
+      if data.kind_of? String
+        message[:data][:eval] = data
+      else
+        message[:data][:data] = data
+      end
+      message
+    end
+
+    # Returns a subscription hash to pass to the PrivatePubPlus.sign call in JavaScript.
+    # Any options passed are merged to the hash.
+    def subscription(options = {})
+      sub = {:server => config[:server], :timestamp => (Time.now.to_f * 1000).round}.merge(options)
+      sub[:signature] = Digest::SHA1.hexdigest([config[:secret_token], sub[:channel], sub[:timestamp]].join)
+      sub
+    end
+
+    # Determine if the signature has expired given a timestamp.
+    def signature_expired?(timestamp)
+      timestamp < ((Time.now.to_f - config[:signature_expiration])*1000).round if config[:signature_expiration]
+    end
+
+    # Returns the Faye Rack application.
+    # Any options given are passed to the Faye::RackAdapter.
+    def faye_app(options = {})
+      options = {:mount => "/faye", :timeout => 45, :extensions => [FayeExtension.new]}.merge(options)
+      Faye::RackAdapter.new(options)
+    end
+  end
+
+  reset_config
+end

data/spec/fixtures/private_pub.yml

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

data/spec/private_pub_plus_spec.rb

@@ -0,0 +1,141 @@
+require "spec_helper"
+
+describe PrivatePubPlus do
+  before(:each) do
+    PrivatePubPlus.reset_config
+  end
+
+  it "defaults server to nil" do
+    PrivatePubPlus.config[:server].should be_nil
+  end
+
+  it "defaults signature_expiration to nil" do
+    PrivatePubPlus.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)
+    PrivatePubPlus.subscription[:timestamp].should eq((time.to_f * 1000).round)
+  end
+
+  it "loads a simple configuration file via load_config" do
+    PrivatePubPlus.load_config("spec/fixtures/private_pub.yml", "production")
+    PrivatePubPlus.config[:server].should eq("http://example.com/faye")
+    PrivatePubPlus.config[:secret_token].should eq("PRODUCTION_SECRET_TOKEN")
+    PrivatePubPlus.config[:signature_expiration].should eq(600)
+  end
+
+  it "raises an exception if an invalid environment is passed to load_config" do
+    lambda {
+      PrivatePubPlus.load_config("spec/fixtures/private_pub.yml", :test)
+    }.should raise_error ArgumentError
+  end
+
+  it "includes channel, server, and custom time in subscription" do
+    PrivatePubPlus.config[:server] = "server"
+    subscription = PrivatePubPlus.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
+    PrivatePubPlus.config[:secret_token] = "token"
+    subscription = PrivatePubPlus.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
+    PrivatePubPlus.config[:secret_token] = "token"
+    PrivatePubPlus.message("chan", "foo").should eq(
+      :ext => {:private_pub_token => "token"},
+      :channel => "chan",
+      :data => {
+        :channel => "chan",
+        :eval => "foo"
+      }
+    )
+  end
+
+  it "formats a message hash given a channel and a hash" do
+    PrivatePubPlus.config[:secret_token] = "token"
+    PrivatePubPlus.message("chan", :foo => "bar").should eq(
+      :ext => {:private_pub_token => "token"},
+      :channel => "chan",
+      :data => {
+        :channel => "chan",
+        :data => {:foo => "bar"}
+      }
+    )
+  end
+
+  it "publish message as json to server using Net::HTTP" do
+    PrivatePubPlus.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)
+
+    PrivatePubPlus.publish_message(message).should eq(:result)
+  end
+
+  it "it should use HTTPS if the server URL says so" do
+    PrivatePubPlus.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)
+
+    PrivatePubPlus.publish_message('foo')
+  end
+
+  it "it should not use HTTPS if the server URL says not to" do
+    PrivatePubPlus.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)
+
+    PrivatePubPlus.publish_message('foo')
+  end
+
+  it "raises an exception if no server is specified when calling publish_message" do
+    lambda {
+      PrivatePubPlus.publish_message("foo")
+    }.should raise_error(PrivatePubPlus::Error)
+  end
+
+  it "publish_to passes message to publish_message call" do
+    PrivatePubPlus.should_receive(:message).with("chan", "foo").and_return("message")
+    PrivatePubPlus.should_receive(:publish_message).with("message").and_return(:result)
+    PrivatePubPlus.publish_to("chan", "foo").should eq(:result)
+  end
+
+  it "has a Faye rack app instance" do
+    PrivatePubPlus.faye_app.should be_kind_of(Faye::RackAdapter)
+  end
+
+  it "says signature has expired when time passed in is greater than expiration" do
+    PrivatePubPlus.config[:signature_expiration] = 30*60
+    time = PrivatePubPlus.subscription[:timestamp] - 31*60*1000
+    PrivatePubPlus.signature_expired?(time).should be_true
+  end
+
+  it "says signature has not expired when time passed in is less than expiration" do
+    PrivatePubPlus.config[:signature_expiration] = 30*60
+    time = PrivatePubPlus.subscription[:timestamp] - 29*60*1000
+    PrivatePubPlus.signature_expired?(time).should be_false
+  end
+
+  it "says signature has not expired when expiration is nil" do
+    PrivatePubPlus.config[:signature_expiration] = nil
+    PrivatePubPlus.signature_expired?(0).should be_false
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: private_pub_plus
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Amrit Singh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faye
+  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: 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+description: Private pub/sub messaging in Rails through Faye. Modified the private
+  pub gem from https://github.com/ryanb/private_pub to make it customizable. Removed
+  js support
+email: amrit0403@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/generators/private_pub_plus/install_generator.rb
+- lib/generators/private_pub_plus/templates/private_pub.ru
+- lib/generators/private_pub_plus/templates/private_pub.yml
+- lib/private_pub_plus.rb
+- lib/private_pub_plus/engine.rb
+- lib/private_pub_plus/faye_extension.rb
+- lib/private_pub_plus/version.rb
+- spec/fixtures/private_pub.yml
+- spec/private_pub_plus_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/amritsingh/private_pub
+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: 1.3.4
+requirements: []
+rubyforge_project: private_pub_plus
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Private pub/sub messaging in Rails.
+test_files: []