transmitter 0.9.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 95fa3f5e66aa623d8d97effbb831019f6cea4293
+  data.tar.gz: 755e1f43093a5f4b1331340559f7c4eeed173a48
+SHA512:
+  metadata.gz: f8749d4fd1d800a9d6b09d9e56247f0db8d7a02413e4b15d1ea7569c91f9b9f9d2910d7df8530eef0dca9d8d031a008f2bcb34d522074647e6afb6e8b8bbec7c
+  data.tar.gz: 9b215a1c21eb831f6897cc1b8ccc1199f31b343016b6b4ca162f75c9f24156bd1bef9ba17434e8b2f378d6835aaac118d7a3171257ddb6f8d92312849f33f176

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 transmitter

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,70 @@
+# Transmitter
+
+Transmitter provides a conveviance method to wrap the ActionController::Live functionality in Rails 4.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'transmitter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install transmitter
+
+## Usage
+
+To use Transmitter, simply create a routable action in your controller that will represent the event source for transmitting the Server-Sent Events, and then use the `transmit` method to send accross an event and data payload to the client.
+
+The first arguement to `transmit` is the event name, the second arguement is amount of time between the client attempting to re-establish connection (in milliseconds), and the last argument is a hash containing the data that should be sent to the client.
+
+```ruby
+FoosController < ActionController::Base
+  include ActionController::Live
+
+  ...
+
+  def transmit_action
+    stream do
+      transmit event: 'event', retry: 1000, data: { my: 'really', cool: 'message' }
+    end
+  end
+
+  ...
+
+end
+```
+
+This will create a properly formatted Server-Sent Event using the functionality of ActionController::Live.
+
+To consume this event on the client side, simply use the Javascript EventSource API:
+
+```javascript
+$(document).ready(function(){
+  var source = new EventSource('your/eventsource/url');
+  source.addEventListener('your_event', function(message){
+    // now the data that you send along will be available in
+    // message.data, and will come in the form of a JSON document
+  });
+});
+```
+
+## Requirements
+
+  * Transmitter relies on the ActionController::Live functionality of Rails 4
+
+## 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
+
+## License
+
+MIT

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/lib/generators/ansible/templates/ansible.yml

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

data/lib/transmitter.rb

@@ -0,0 +1,7 @@
+require 'transmitter/sse'
+require 'transmitter/constant_resolver'
+require 'transmitter/origin'
+
+ActiveSupport.on_load(:action_controller) do
+  include Transmitter::Origin
+end

data/lib/transmitter/constant_resolver.rb

@@ -0,0 +1,17 @@
+module Transmitter
+  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/transmitter/origin.rb

@@ -0,0 +1,33 @@
+module Transmitter
+  module Origin
+    def stream
+      begin
+        set_headers
+        yield
+      ensure
+        close_connection
+      end
+    end
+
+    def transmit(opts)
+      sse.build_message(opts).stream unless stream_closed?
+    end
+
+    def close_connection
+      sse.close
+    end
+
+    def stream_closed?
+      response.stream.closed?
+    end
+
+    def set_headers
+      return if headers['Content-Type'] == 'text/event-stream'
+      headers['Content-Type'] = 'text/event-stream'
+    end
+
+    def sse
+      @sse ||= SSE.new response.stream
+    end
+  end
+end

data/lib/transmitter/sse.rb

@@ -0,0 +1,26 @@
+require 'json'
+
+module Transmitter
+  class SSE
+    attr_reader :response_stream, :message
+
+    def initialize(response_stream)
+      @response_stream = response_stream
+    end
+
+    def stream
+      response_stream.write message
+    end
+
+    def close
+      response_stream.close
+    end
+
+    def build_message(opts)
+      @message = "event: #{opts[:event]}\n"
+      @message << "retry: #{opts[:retry]}\n" if opts.has_key? :retry
+      @message << "data: #{opts[:data].to_json}\n\n"
+      self
+    end
+  end
+end

data/lib/transmitter/version.rb

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

data/spec/constant_resolver_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'transmitter/constant_resolver'
+
+describe Transmitter::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,20 @@
+require 'fixtures/fake_rails_app'
+
+class TestsController < ActionController::Base
+  include Rails.application.routes.url_helpers
+  include ActionController::Live
+
+  def new
+    render text: "new"
+  end
+
+  def create
+    head :ok
+  end
+
+  def space_beacon
+    stream do
+      transmit event: 'space', retry: 1000, data: { expanding: true }
+    end
+  end
+end

data/spec/fixtures/fake_rails_app.rb

@@ -0,0 +1,29 @@
+require 'active_support/all'
+require 'action_controller'
+require 'action_dispatch'
+require 'active_model'
+require 'active_record'
+require 'rails'
+require 'ostruct'
+require 'transmitter'
+
+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'
+          get '/test/space_beacon' => 'tests#space_beacon'
+        end
+      end
+    end
+  end
+
+  def self.application
+    @app ||= App.new
+  end
+end

data/spec/rails_integration_spec.rb

@@ -0,0 +1,20 @@
+require 'fixtures/controllers'
+require 'rspec/rails'
+require 'spec_helper'
+
+describe TestsController, type: :controller do
+  describe 'GET space_beacon' do
+    before do
+      get :space_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
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'fixtures/fake_rails_app'
+require 'fixtures/controllers'
+
+ActiveRecord::Base.establish_connection :adapter => :postgresql,
+    :adapter => 'postgresql',
+    :database => 'ansible_test',
+    :pool => 5,
+    :timeout => 5000,
+    :host => 'localhost'

data/spec/sse_spec.rb

@@ -0,0 +1,23 @@
+require 'transmitter/sse'
+
+describe Transmitter::SSE do
+  let(:io) { double('io', write: true, close: true) }
+  let(:sse) { Transmitter::SSE.new(io) }
+  let(:expected_message) { "event: message\nretry: 1000\ndata: {\"hello\":\"hello\"}\n\n" }
+
+  describe '#write' do
+    context 'with a retry specified' do
+      it 'sends data accross the pipe in the correct format' do
+        sse.build_message(event: 'message', retry: 1000, data: { hello: 'hello' }).stream
+        io.should have_received(:write).with(expected_message)
+      end
+    end
+  end
+
+  describe '#close' do
+    it 'closes the IO connection' do
+      sse.close
+      io.should have_received(:close)
+    end
+  end
+end

data/transmitter.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'transmitter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "transmitter"
+  spec.version       = Transmitter::VERSION
+  spec.authors       = ["Derek Parker"]
+  spec.email         = ["parkerderek86@gmail.com"]
+  spec.description   = "Transmitter provides a conveniance method to your Rails controllers for creating SSEs."
+  spec.summary       = "Transmitter is a conveniant way to generate Server-Sent Events"
+  spec.homepage      = "https://www.github.com/dparker1990/transmitter"
+  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"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "rspec-spies"
+  spec.add_development_dependency "pg"
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: transmitter
+version: !ruby/object:Gem::Version
+  version: 0.9.6
+platform: ruby
+authors:
+- Derek Parker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-26 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
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !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: Transmitter provides a conveniance method to your Rails controllers for
+  creating SSEs.
+email:
+- parkerderek86@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/ansible/templates/ansible.yml
+- lib/transmitter.rb
+- lib/transmitter/constant_resolver.rb
+- lib/transmitter/origin.rb
+- lib/transmitter/sse.rb
+- lib/transmitter/version.rb
+- 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
+- transmitter.gemspec
+homepage: https://www.github.com/dparker1990/transmitter
+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: Transmitter is a conveniant way to generate Server-Sent Events
+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