ansible-sse 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d3390748c842d7980b7b0bc3468fe163f9107bac
+  data.tar.gz: d2b641406e0bdd4138c9caaa813dfa69487245da
+SHA512:
+  metadata.gz: 6a130fec5f8e7d2ee83c270e0ba5dcc44dfa8e96dd8100d2aa60cae7e9af0371046eff4ee2054a7826c94341f455f69172fd06affaa993450e0dd1380bd81224
+  data.tar.gz: 947927464314aee692199b08911a56a82262c8fdb007c8157d60b7c01fbefe3c96ec3e3d7a03224a0e9b2efebfe831f19be7ac4b3634632036000c134ff2a38f

data/.gitignore

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm gemset use ansible

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ansible.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Derek Parker
+
+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,33 @@
+# Ansible
+
+Ansible provides a conveniant way to declaratively stream Server-Sent Events to the client using Rails 4.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ansible'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ansible
+
+## Usage
+
+To use Ansible, simply add this to your controller for any model you want to transmit events for:
+
+```ruby
+transmit :model
+```
+
+## Contributing
+
+1. Fork it
+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,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :spec do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task default: [:spec]

data/ansible.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ansible/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ansible-sse"
+  spec.version       = Ansible::VERSION
+  spec.authors       = ["Derek Parker"]
+  spec.email         = ["parkerderek86@gmail.com"]
+  spec.description   = "Ansible allows you to stream events to a partial using ActionController::Live"
+  spec.summary       = "Real time updates to browser using ActionController::Live"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rails", "4.0.0.rc1"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "rspec-spies"
+  spec.add_development_dependency "pg"
+end

data/lib/ansible.rb

@@ -0,0 +1,7 @@
+require 'ansible/sse'
+require 'ansible/constant_resolver'
+require 'ansible/transmit'
+
+ActiveSupport.on_load(:action_controller) do
+  extend Ansible::Transmit
+end

data/lib/ansible/constant_resolver.rb

@@ -0,0 +1,17 @@
+module Ansible
+  class ConstantResolver
+    def initialize(name)
+      @name = name
+    end
+
+    def lookup_constant
+      name.constantize
+    end
+
+    private
+
+    def name
+      @name.to_s.titleize
+    end
+  end
+end

data/lib/ansible/sse.rb

@@ -0,0 +1,19 @@
+module Ansible
+  class SSE
+    attr_reader :stream
+
+    def initialize(stream)
+      @stream = stream
+    end
+
+    def write(event, message)
+      stream.write "event: #{event}\n"
+      stream.write "retry: 1000\n"
+      stream.write "data: #{message}\n\n"
+    end
+
+    def close
+      stream.close
+    end
+  end
+end

data/lib/ansible/transmit.rb

@@ -0,0 +1,72 @@
+module Ansible
+  module Transmit
+    def self.extended(base)
+      base.class_eval { include ActionController::Live }
+    end
+
+    def transmit(name)
+      beacon_name = :"#{name}_ansible_beacon"
+      build_route beacon_name
+      model = ConstantResolver.new(name).lookup_constant
+
+      model.extend TransmitModalHelper
+
+      define_method beacon_name, beacon_action
+      name
+    end
+
+    def build_route(beacon_name)
+      controller_name = self.to_s.underscore.gsub('_controller', '')
+      Rails.application.routes.draw do
+        Rails.application.routes.routes.named_routes.each do |path, route|
+          get path, route.defaults
+        end
+        get "/#{controller_name}/#{beacon_name}" => "#{controller_name}##{beacon_name}"
+      end
+    end
+
+    private
+
+    def beacon_action
+      Proc.new do
+        begin
+          beacon = __method__
+          model = ConstantResolver.new(beacon.to_s.split("_").first).lookup_constant
+
+          headers['Content-Type'] = 'text/event-stream'
+          sse = SSE.new(response.stream)
+
+          model.on_new_message do |event, message|
+            sse.write event, message
+          end
+        ensure
+          sse.close
+        end
+      end
+    end
+
+    module TransmitModalHelper
+      def self.extended(base)
+        base.class_eval do
+          after_commit :notify
+
+          def notify
+            self.class.connection.execute "NOTIFY #{self.class.table_name}, #{self.class.connection.quote attributes}"
+          end
+        end
+      end
+
+      def on_new_message
+        listen
+
+        self.class.connection.wait_for_notify do |event, pid, message|
+          yield event, message
+        end
+      end
+
+      def listen
+        self.class.connection.execute "LISTEN #{table_name}"
+      end
+    end
+  end
+end

data/lib/ansible/version.rb

@@ -0,0 +1,7 @@
+module Ansible
+  MAJOR = 0
+  MINOR = 0
+  TINY = 1
+
+  VERSION = [MAJOR, MINOR, TINY].join "."
+end

data/lib/generators/ansible/templates/ansible.yml

@@ -0,0 +1,5 @@
+development:
+  thing: yeah
+
+test:
+  thing: yeah

data/spec/constant_resolver_spec.rb

@@ -0,0 +1,11 @@
+require 'ansible/constant_resolver'
+
+describe Ansible::ConstantResolver do
+  describe '#lookup_constant' do
+    before { class Space; end }
+
+    it 'resolves the constant' do
+      described_class.new("Space").lookup_constant.should eq Space
+    end
+  end
+end

data/spec/fixtures/controllers.rb

@@ -0,0 +1,21 @@
+require 'fixtures/fake_rails_app'
+
+class Space < ActiveRecord::Base; end
+
+class TestsController < ActionController::Base
+  include Rails.application.routes.url_helpers
+
+  transmit :space
+
+  def new
+    render text: "new"
+  end
+
+  def create
+    head :ok
+  end
+
+  def space_params
+    params.require(:space).permit(:expanding)
+  end
+end

data/spec/fixtures/fake_rails_app.rb

@@ -0,0 +1,28 @@
+require 'active_support/all'
+require 'action_controller'
+require 'action_dispatch'
+require 'active_model'
+require 'active_record'
+require 'rails'
+require 'ostruct'
+require 'ansible'
+
+module Rails
+  class App
+    def env_config; {} end
+
+    def routes
+      return @routes if defined? @routes
+
+      @routes = ActionDispatch::Routing::RouteSet.new.tap do |routes|
+        routes.draw do
+          post '/test' => "tests#create"
+        end
+      end
+    end
+  end
+
+  def self.application
+    @app ||= App.new
+  end
+end

data/spec/rails_integration_spec.rb

@@ -0,0 +1,26 @@
+require 'fixtures/controllers'
+require 'rspec/rails'
+require 'spec_helper'
+
+describe TestsController, type: :controller do
+  describe 'GET space_ansible_beacon' do
+    before do
+      Space.stub(:on_new_message).and_yield('space', '{"expanding":true}')
+      get :space_ansible_beacon
+    end
+
+    it 'sets the content-type to text/event-stream' do
+      response.headers['Content-Type'].should eq 'text/event-stream'
+    end
+
+    it 'sends the next messages in the que concerning the current modal' do
+      sleep 0.1 until response.stream.closed?
+      response.body.should eq %{event: space\nretry: 1000\ndata: {"expanding":true}\n\n}
+    end
+
+    it 'does not override predefined routes' do
+      post :create
+      response.should be_ok
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rspec-spies'
+
+ActiveRecord::Base.establish_connection :adapter => :postgresql,
+    :adapter => 'postgresql',
+    :database => 'ansible_test',
+    :pool => 5,
+    :timeout => 5000,
+    :host => 'localhost'
+
+RSpec.configure do |config|
+  config.before do
+    Pathname.new(__FILE__).expand_path.join('../').to_s
+  end
+end

data/spec/sse_spec.rb

@@ -0,0 +1,23 @@
+require 'ansible/sse'
+
+describe Ansible::SSE do
+  let(:io) { stub(write: true) }
+  let(:sse) { Ansible::SSE.new(io) }
+
+  describe '#write' do
+    context 'with an event specified' do
+      it 'sends data accross the pipe in the correct format' do
+        io.should_receive(:write).with("event: message\n")
+        io.should_receive(:write).with(%{data: {\"hello\":\"hello\"}\n\n})
+        sse.write(:message, '{"hello":"hello"}')
+      end
+    end
+  end
+
+  describe '#close' do
+    it 'closes the IO connection' do
+      io.should_receive :close
+      sse.close
+    end
+  end
+end

data/spec/transmit_spec.rb

@@ -0,0 +1,27 @@
+require 'action_controller'
+require 'ansible/transmit'
+
+class TestsController < ActionController::Base
+  extend Ansible::Transmit
+
+  transmit :space
+
+  def create
+    head :ok
+  end
+end
+
+describe Ansible::Transmit do
+  describe '.transmit' do
+    let(:controller) { TestsController.new }
+    let(:action_name) { :space_ansible_beacon }
+
+    it 'defines a method in the format name_ansible_beacon' do
+      controller.should respond_to action_name
+    end
+
+    it 'allows the action to be routable' do
+      controller.hidden_actions.should_not include action_name
+    end
+  end
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: ansible-sse
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Derek Parker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.0.rc1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: pry
+  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-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'
+- !ruby/object:Gem::Dependency
+  name: rspec-spies
+  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: pg
+  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: Ansible allows you to stream events to a partial using ActionController::Live
+email:
+- parkerderek86@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ansible.gemspec
+- lib/ansible.rb
+- lib/ansible/constant_resolver.rb
+- lib/ansible/sse.rb
+- lib/ansible/transmit.rb
+- lib/ansible/version.rb
+- lib/generators/ansible/templates/ansible.yml
+- spec/constant_resolver_spec.rb
+- spec/fixtures/controllers.rb
+- spec/fixtures/fake_rails_app.rb
+- spec/rails_integration_spec.rb
+- spec/spec_helper.rb
+- spec/sse_spec.rb
+- spec/transmit_spec.rb
+homepage: ''
+licenses:
+- MIT
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Real time updates to browser using ActionController::Live
+test_files:
+- spec/constant_resolver_spec.rb
+- spec/fixtures/controllers.rb
+- spec/fixtures/fake_rails_app.rb
+- spec/rails_integration_spec.rb
+- spec/spec_helper.rb
+- spec/sse_spec.rb
+- spec/transmit_spec.rb