thunderer 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eed2e6107ca366aa72173a03e02aac6315d21a98
+  data.tar.gz: d1700a9f0bf3511b4be6ba4b5d5e8d3411e10e8a
+SHA512:
+  metadata.gz: 74e671d789053ceb11bfa8e579978d2c38c3d9fad54d889e312885f8324056c247f560bbcabd6d9a1400bc4fcacf46649abab795d7095a9ec8e07033c92d5454
+  data.tar.gz: 1a8414e53918afbb5e9f83f36f99b979c573418064ca962db96d631c09527fe21bfc20c69d2dccf13c607959ee5840b92e7c553d8636fee67011bd749174fd26

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/
+.rbenv-version

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+addons:
+  code_climate:
+    repo_token:
+      secure: kQfmRpllfvpVjss75SRQKDJ70j72doORRsr8EQyY3cJsoAnwfu8E25/JZ+ZoG25AS+Z6dNYpSH0unrsqzbaSGucFfnQD0TiGINJhs36svHhtrP+JDSxwE38PyKu3tX07TMDxfZ0ig8OfuEuB3RB+E/1/1fy4RrrDn+ZIQN0dIHs=

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in thunderer.gemspec
+gemspec
+
+group :development do
+  gem 'guard-rspec', require: false
+  gem 'guard-jasmine'
+  gem 'rsense'
+end
+
+
+group :test do
+  gem 'rspec'
+  gem 'codeclimate-test-reporter', require: nil
+end

data/Guardfile

@@ -0,0 +1,17 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' , cmd: 'bundle exec rspec'do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+
+end
+
+
+# guard :jasmine do
+#   watch(%r{spec/javascripts/spec\.(js\.coffee|js|coffee)$}) { 'spec/javascripts' }
+#   watch(%r{spec/javascripts/.+_spec\.(js\.coffee|js|coffee)$})
+#   watch(%r{spec/javascripts/fixtures/.+$})
+#   watch(%r{app/assets/javascripts/(.+?)\.(js\.coffee|js|coffee)(?:\.\w+)*$}) { |m| "spec/javascripts/#{ m[1] }_spec.#{ m[2] }" }
+# end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nick Chubarov
+
+MIT License
+
+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,32 @@
+[![Build Status](https://travis-ci.org/chubarovNick/thunderer.svg?branch=master)](https://travis-ci.org/chubarovNick/thunderer)
+[![Code Climate](https://codeclimate.com/github/chubarovNick/thunderer.png)](https://codeclimate.com/github/chubarovNick/thunderer)
+[![Dependency Status](https://gemnasium.com/chubarovNick/thunderer.svg)](https://gemnasium.com/chubarovNick/thunderer)
+# Thunderer
+
+Thunderer is gem for publishing messages through [Faye](http://faye.jcoglan.com/). It allows you to easily provide real-time updates through an open socket without tying
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'thunderer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install thunderer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/thunderer/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc 'Run RSpec'
+RSpec::Core::RakeTask.new do |t|
+  t.verbose = false
+end
+
+task default: :spec
+require 'jasmine'
+load 'jasmine/tasks/jasmine.rake'

data/app/assets/javascripts/thunderer.js

@@ -0,0 +1,93 @@
+var Thunderer = (function (doc) {
+  var handleResponse, connectToFaye, self;
+
+  self = {
+    connecting: false,
+    fayeClient: null,
+    fayeCallbacks: [],
+    subscriptions: {},
+    subscriptionObjects: {},
+    subscriptionCallbacks: {}
+  };
+
+  handleResponse = function(message) {
+    if (callback = self.subscriptionCallbacks[message.channel]) {
+      callback(message.data, message.channel);
+    }
+  };
+
+  connectToFaye = function () {
+    self.fayeClient = new Faye.Client(self.subscriptions.server);
+    self.fayeClient.addExtension(self.fayeExtension);
+    for (var i=0; i < self.fayeCallbacks.length; i++) {
+      self.fayeCallbacks[i](self.fayeClient);
+    };
+  };
+
+  self.sign = function(options) {
+    if (!self.subscriptions.server) {
+      self.subscriptions.server = options.server;
+    }
+    self.subscriptions[options.channel] = options;
+    self.faye(function(faye) {
+      var sub = faye.subscribe(options.channel, handleResponse);
+      self.subscriptionObjects[options.channel] = sub;
+      if (options.subscription) {
+        options.subscription(sub);
+      }
+    });
+  };
+
+  self.subscribe = function (channel, callback) {
+    self.subscriptionCallbacks[channel] = callback;
+  };
+
+  self.faye = function (callback) {
+    if (self.fayeClient) {
+      callback(self.fayeClient);
+    } else {
+      self.fayeCallbacks.push(callback);
+      if (self.subscriptions.server && !self.connecting) {
+        self.connecting = true;
+        if (typeof Faye === 'undefined') {
+          console.log('Faye is undefined, you should require faye.js before using Thunderer')
+        } else {
+          connectToFaye();
+        }
+      }
+    }
+  };
+
+  self.fayeExtension ={
+    outgoing: function(message, callback) {
+      if (message.channel == "/meta/subscribe") {
+        // Attach the signature and timestamp to subscription messages
+        var subscription = self.subscriptions[message.subscription];
+        if (!message.ext) message.ext = {};
+        message.ext.thunderer_signature = subscription.signature;
+        message.ext.thunderer_timestamp = subscription.timestamp;
+      }
+      callback(message);
+    }
+  };
+
+  self.subscription = function(channel) {
+    return self.subscriptionObjects[channel];
+  };
+  self.unsubscribe = function (channel) {
+    var sub = self.subscription(channel);
+    if (sub) {
+      sub.cancel();
+      delete self.subscriptionObjects[channel];
+    }
+  };
+
+  self.unsubscribeAll = function () {
+    for (var i in self.subscriptionObjects) {
+      if ( self.subscriptionObjects.hasOwnProperty(i) ) {
+        self.unsubscribe(i);
+      }
+    }
+  };
+  return self;
+}(document));

data/app/assets/javascripts/thunderer_angular.js

@@ -0,0 +1,43 @@
+(function () {
+  'use strict';
+
+   angular.module('Thunderer', [])
+
+     .factory('ThundererInterceptor', function ($q) {
+       var self = {
+         response: function (response) {
+           var rawChanels = response.headers().channels;
+           if (rawChanels) {
+             var channels = JSON.parse(rawChanels);
+             for (var i = 0; i < channels.length; i++) {
+               Thunderer.sign(channels[i]);
+             }
+           }
+           return response;
+         },
+         responseError: function (rejection) {
+           $q.reject(rejection);
+         }
+       };
+
+       return self;
+
+     })
+
+     .service('$thunderer', function () {
+
+       var self = {
+         addListener: function (channel, callback) {
+           Thunderer.subscribe(channel, callback);
+         },
+         removeListener: function (channel) {
+           Thunderer.unsubscribe(channel)
+         },
+         removeAllListners: function () {
+           Thunderer.unsubscribeAll()
+         }
+       }
+       return self;
+     })
+
+}());

data/lib/generators/thunderer/install_generator.rb

@@ -0,0 +1,19 @@
+module Thunderer
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      def self.source_root
+        File.dirname(__FILE__) + '/templates'
+      end
+
+      def copy_files
+        template 'thunderer.yml', 'config/thunderer.yml'
+        if ::Rails.version < '3.1'
+          copy_file '../../../../app/assets/javascripts/thunderer.js', 'public/javascripts/thunderer.js'
+          copy_file '../../../../app/assets/javascripts/thunderer_interceptor.js', 'public/javascripts/thunderer_interceptor.js'
+          copy_file '../../../../app/assets/javascripts/thunderer_subscription_service.js', 'public/javascripts/thunderer_subscription_service.js'
+        end
+        copy_file 'thunderer.ru', 'thunderer.ru'
+      end
+    end
+  end
+end

data/lib/generators/thunderer/templates/thunderer.ru

@@ -0,0 +1,10 @@
+# Run with: rackup thunderer.ru -s thin -E production
+require 'bundler/setup'
+require 'yaml'
+require 'faye'
+require 'thunderer'
+
+Faye::WebSocket.load_adapter('thin')
+
+Thunderer.load_config(File.expand_path('../config/thunderer.yml', __FILE__), ENV['RAILS_ENV'] || 'development')
+run Thunderer.faye_app

data/lib/generators/thunderer/templates/thunderer.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/thunderer/controller_additions.rb

@@ -0,0 +1,38 @@
+require 'active_support'
+module Thunderer
+  module ControllerAdditions
+    extend ActiveSupport::Concern
+
+    included do
+      cattr_accessor :channels, :interpolation_object
+
+      before_action :add_channels_header,only: [:index]
+
+      private
+
+      def add_channels_header
+          headers['channels'] = (self.class.channels || []).map do |channel|
+          new_str = if self.class.interpolation_object && channel
+                      object = send(self.class.interpolation_object)
+                      Thunderer::Parser.interpolate_channel channel, object
+                    else
+                      channel
+                    end
+          Thunderer.subscription(channel: new_str)
+        end.to_json
+      end
+    end
+
+    module ClassMethods
+
+      def thunderer_channels(*args)
+        options = args.extract_options!
+        options.assert_valid_keys(:object)
+        self.interpolation_object = options[:object]
+        self.channels             = Array.wrap(args)
+      end
+
+    end
+
+  end
+end

data/lib/thunderer/engine.rb

@@ -0,0 +1,20 @@
+require 'thunderer/view_helpers'
+module Thunderer
+  class Engine < ::Rails::Engine
+
+    initializer "thunderer.config" do
+      path = Rails.root.join("config/thunderer.yml")
+      Thunderer.load_config(path, Rails.env) if path.exist?
+    end
+
+    initializer :assets do |config|
+      Rails.application.config.assets.paths << File.join(
+          Gem.loaded_specs['faye'].full_gem_path, 'lib')
+    end
+
+    initializer "thunderer.view_helpers" do
+      ActionView::Base.send :include, ViewHelpers
+    end
+
+  end
+end

data/lib/thunderer/faye_extension.rb

@@ -0,0 +1,40 @@
+module Thunderer
+  # This class is an extension for the Faye::RackAdapter.
+  # It is used inside of Thunderer.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 = Thunderer.subscription(:channel => message["subscription"], :timestamp => message["ext"]["thunderer_timestamp"])
+      if message["ext"]["thunderer_signature"] != subscription[:signature]
+        message["error"] = "Incorrect signature."
+      elsif Thunderer.signature_expired? message["ext"]["thunderer_timestamp"].to_i
+        message["error"] = "Signature has expired."
+      end
+    end
+
+    # Ensures the secret token is correct before publishing.
+    def authenticate_publish(message)
+      if Thunderer.config[:secret_token].nil?
+        raise Error, "No secret_token config set, ensure thunderer.yml is loaded properly."
+      elsif message["ext"]["thunderer_secret_token"] != Thunderer.config[:secret_token]
+
+        message["error"] = "Incorrect token."
+      else
+        message["ext"]["thunderer_secret_token"] = nil
+      end
+    end
+  end
+end

data/lib/thunderer/messanger.rb

@@ -0,0 +1,50 @@
+module Thunderer
+  module Messanger
+    class ConfigurationError < StandardError; end
+
+    class << self
+      attr_reader :config
+
+      def reset_config
+        @config = {}
+      end
+
+      def configure url
+        reset_config
+        uri = URI.parse(url)
+        @config['uri'] = uri
+        @config['use_ssl'] = uri.scheme == 'https'
+      end
+
+      def post message
+        raise ConfigurationError if not_configured?
+
+        form = build_form
+        form.set_form_data(:message => message.to_json)
+        protocol.start {|h| h.request(form)}
+      end
+
+      private
+
+      def build_form
+        uri = @config['uri']
+        Net::HTTP::Post.new(uri.path.empty? ? '/' : uri.path)
+      end
+
+      def protocol
+        uri = @config['uri']
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = @config['use_ssl']
+        if @config['use_ssl']
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+        http
+      end
+
+      def not_configured?
+        @config == {}
+      end
+
+    end
+  end
+end

data/lib/thunderer/parser.rb

@@ -0,0 +1,22 @@
+module Thunderer
+  module Parser
+
+    class << self
+      def interpolate_channel channel, object
+        channel.gsub(/:\w*\b/, interpolation_hash(channel, object))
+      end
+
+      private
+
+      def interpolation_hash channel, object
+        {}.tap do |result|
+          channel.scan(/:\w*\b/).map do |interpolation_key|
+            object_method   = interpolation_key.gsub(':', '')
+            replaced_string = object.send(object_method).to_s
+            result[interpolation_key] =  replaced_string
+          end
+        end
+      end
+    end
+  end
+end

data/lib/thunderer/publish_changes.rb

@@ -0,0 +1,51 @@
+require 'active_support'
+module Thunderer
+  module PublishChanges
+    extend ActiveSupport::Concern
+
+    included do
+      after_save :publish_changes
+
+      class << self
+        attr_accessor :channels, :options, :block
+      end
+
+      private
+
+      def publish_changes
+        (self.class.channels || []).each do |channel|
+          rooted_message = if message_root?
+                             Hash[message_root, notification_message]
+                           else
+                             notification_message
+                           end
+          Thunderer.publish_to Thunderer::Parser.interpolate_channel(channel, self), rooted_message
+        end
+      end
+
+      def notification_message
+        block = self.class.block
+        block ? block.call(self) : self
+      end
+
+      def message_root
+        self.class.options[:message_root]
+      end
+
+      def message_root?
+        message_root.present?
+      end
+
+    end
+
+    module ClassMethods
+      def notify_client_to_channels *args, &block
+        @options = args.extract_options!
+        @options.assert_valid_keys(:message_root)
+        @channels = args
+        @block = block
+      end
+    end
+
+  end
+end

data/lib/thunderer/railtie.rb

@@ -0,0 +1,15 @@
+module Thunderer
+  class Railtie < Rails::Railtie
+    initializer 'thunderer.controller' do
+      ActiveSupport.on_load(:action_controller) do
+        include Thunderer::ControllerAdditions
+      end
+    end
+
+    initializer 'thunderer.active_record' do
+      ActiveSupport.on_load(:active_record) do
+        include Thunderer::PublishChanges
+      end
+    end
+  end
+end

data/lib/thunderer/version.rb

@@ -0,0 +1,3 @@
+module Thunderer
+  VERSION = '0.9.0'
+end

data/lib/thunderer/view_helpers.rb

@@ -0,0 +1,22 @@
+module Thunderer
+  module ViewHelpers
+    # Publish the given data or block to the client by sending
+    # a Net::HTTP POST request to the Faye server. If a block
+    # or string is passed in, it is evaluated as JavaScript
+    # on the client. Otherwise it will be converted to JSON
+    # for use in a JavaScript callback.
+    def publish_to(channel, data = nil, &block)
+      Thunderer.publish_to(channel, data || capture(&block))
+    end
+
+    # Subscribe the client to the given channel. This generates
+    # some JavaScript calling PrivatePub.sign with the subscription
+    # options.
+    def subscribe_to(channel)
+      subscription = Thunderer.subscription(:channel => channel)
+      content_tag "script", :type => "text/javascript" do
+        raw("Thunderer.sign(#{subscription.to_json});")
+      end
+    end
+  end
+end

data/lib/thunderer.rb

@@ -0,0 +1,66 @@
+require "thunderer/version"
+require 'thunderer/parser'
+require 'thunderer/messanger'
+require 'thunderer/publish_changes'
+require 'thunderer/faye_extension'
+require "digest/sha1"
+require "net/http"
+require "net/https"
+require 'yaml'
+require "thunderer/engine" if defined? Rails
+
+module Thunderer
+  class Error < StandardError; end
+
+  class << self
+    attr_reader :config
+    attr_reader :messanger
+
+    def reset_config
+     @config = {}
+    end
+
+    def load_config filename, environment
+      reset_config
+      config_yaml = YAML.load_file(filename)[environment]
+      raise ArgumentError, "The #{environment} environment dose not exist" unless config_yaml
+      config_yaml.each { |k,v| config[k.to_sym] = v }
+      Thunderer::Messanger.configure(config[:server])
+      @messanger = Thunderer::Messanger
+
+    end
+
+    def publish_to channel, data
+      publish_message(message(channel, data))
+    end
+
+    def publish_message(message)
+      raise Error, "No server specified, ensure private_pub.yml was loaded properly." unless config[:server]
+      url = URI.parse(config[:server])
+      messanger.post(message)
+    end
+
+    def message(channel, data)
+      {:channel => channel,
+       :data => {
+         :channel => channel,
+         :data => data},
+       :ext => {:thunderer_secret_token => config[:secret_token]}}
+    end
+
+    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
+
+    def signature_expired?(timestamp)
+      timestamp < ((Time.now.to_f - config[:signature_expiration])*1000).round if config[:signature_expiration]
+    end
+
+    def faye_app(options = {})
+      options = {mount: '/faye', timeout: 45, extensions: [FayeExtension.new] }.merge(options)
+      Faye::RackAdapter.new(options)
+    end
+  end
+end

data/spec/fixtures/thunderer.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