robin-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e13a9eacc13a76cc09d33d925daabaa111012ac5
+  data.tar.gz: b95f6b46420a8842fab70c0246e2c8076d04976e
+SHA512:
+  metadata.gz: f4e3cc7401e5fe5797a13ef78d1517193cf3f7e976369e5bf1bad2fbf4e07b91d0d7e022262a3e561590e7befd2c08744a1e84345b971a2a58c61260bda40cbf
+  data.tar.gz: 999148332f40ddf9a74ddb43cf8793b66ac484ae272fefe98d9238eff3c6225f4a85fb465c5093c1b131d05028b1d86d93f2dd0984aa32776c31de1c41ec782c

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/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode
+script: bundle exec rspec spec
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in robin-rails.gemspec
+gemspec
+
+group :test do
+  gem 'coveralls', :require => false
+
+  platforms :ruby do
+    gem 'sqlite3'
+  end
+
+  platforms :jruby do
+    gem 'json'
+    gem 'activerecord-jdbcsqlite3-adapter'
+  end
+end
+

data/Guardfile

@@ -0,0 +1,7 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^bin/(.+)$})         { |m| [ "spec/bin/#{m[1]}_spec.rb" ] }
+  watch(%r{^lib/(.+)\.rb$})     { |m| [ "spec" ] }
+
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jonathan Martin
+
+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,10 @@
+[![Gem Version](https://badge.fury.io/rb/robin-rails.png)](http://badge.fury.io/rb/robin-rails)
+[![Dependency Status](https://gemnasium.com/nybblr/robin-rails.png)](https://gemnasium.com/nybblr/robin-rails)
+[![Code Climate](https://codeclimate.com/github/nybblr/robin-rails.png)](https://codeclimate.com/github/nybblr/robin-rails)
+[![Coverage Status](https://coveralls.io/repos/nybblr/robin-rails/badge.png?branch=master)](https://coveralls.io/r/nybblr/robin-rails)
+[![Build Status](https://travis-ci.org/nybblr/robin-rails.png)](https://travis-ci.org/nybblr/robin-rails)
+
+Robin.js on Rails
+=================
+
+Every Batman.js app on Rails needs a sidekick. Bring realtime to the fight with Robin.js.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/robin-rails.rb

@@ -0,0 +1,11 @@
+require 'robin'
+require 'robin/rails'
+require 'robin/rails/version'
+require 'rails/engine'
+
+module Robin
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/robin.rb

@@ -0,0 +1,26 @@
+require 'active_support/core_ext/module/attribute_accessors'
+
+module Robin
+  mattr_accessor :faye_url
+  @@faye_url = 'http://localhost:9292/faye'
+
+  class << self
+    def configure
+      yield self
+    end
+
+    def publish record, event, data
+      msg = {
+        channel: channel_for(record, event),
+        data: data
+      }
+
+      uri = URI.parse("http://localhost:9292/faye")
+      Net::HTTP.post_form(uri, message: msg.to_json)
+    end
+
+    def channel_for(record, event)
+      "/#{record.class.model_name.route_key}/#{event}"
+    end
+  end
+end

data/lib/robin/rails.rb

@@ -0,0 +1,25 @@
+require 'active_support/concern'
+# require 'robin'
+
+module Robin
+  module Rails
+    extend ActiveSupport::Concern
+
+    included do
+      after_create do |record|
+        ::Robin.publish record, :created, record.attributes
+      end
+
+      after_update do |record|
+        ::Robin.publish record, :updated, record.attributes
+      end
+
+      after_destroy do |record|
+        ::Robin.publish record, :destroyed, id: record.id
+      end
+    end
+
+    module ClassMethods
+    end
+  end
+end

data/lib/robin/rails/version.rb

@@ -0,0 +1,5 @@
+module Robin
+  module Rails
+    VERSION = "0.0.1"
+  end
+end

data/robin-rails.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'robin/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "robin-rails"
+  spec.version       = Robin::Rails::VERSION
+  spec.authors       = ["Jonathan Martin"]
+  spec.email         = ["me@nybblr.com"]
+  spec.description   = %q{Every Batman.js app on Rails needs a sidekick. Bring realtime to the fight with Robin.js.}
+  spec.summary       = %q{Realtime updates are awesome and the future of web apps. But they're a pain to use from scatch for anything more complex than a couple models. We'd like things to just "autoupdate" and add functionality as desired to react to live updates. That's where Robin.js comes in.}
+  spec.homepage      = "https://github.com/nybblr/robin-rails"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  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_dependency "activesupport", ">= 4.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rails"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+end

data/spec/fixtures/dummy_model.rb

@@ -0,0 +1,4 @@
+class DummyModel < ActiveRecord::Base
+  include Robin::Rails
+end
+

data/spec/robin/rails_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'robin-rails'
+require 'active_record'
+
+require_relative '../fixtures/dummy_model'
+
+describe Robin::Rails do
+  before(:all) do
+    # Throw together a fake DB
+    ActiveRecord::Base.establish_connection(
+      :adapter  => 'sqlite3',
+      :database => ':memory:'
+    )
+
+    ActiveRecord::Migration.verbose = false
+    ActiveRecord::Schema.define do
+      create_table :dummy_models, force: true
+    end
+  end
+
+  context 'included module' do
+    before do
+      Robin.stub(:publish)
+    end
+
+    it 'calls publish after create' do
+      Robin.should_receive(:publish).with(anything, :created, anything)
+
+      DummyModel.create
+    end
+
+    it 'calls publish after update' do
+      record = DummyModel.create
+      Robin.should_receive(:publish).with(anything, :updated, anything)
+      record.save
+    end
+
+    it 'calls publish after destroy' do
+      record = DummyModel.create
+      Robin.should_receive(:publish).with(anything, :destroyed, anything)
+      record.destroy
+    end
+  end
+end

data/spec/robin_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'robin-rails'
+
+describe Robin do
+  let(:data)   { {id: 1, title: "hello"} }
+  let(:record) {
+    double(:record, class: double(model_name: double(route_key: 'records')))
+  }
+
+  context '#configure' do
+    it 'has reasonable defaults' do
+      Robin.faye_url.should == 'http://localhost:9292/faye'
+    end
+
+    it 'can override defaults' do
+      Robin.configure do |config|
+        config.faye_url = 'http://faye.local/faye'
+      end
+
+      Robin.faye_url.should == 'http://faye.local/faye'
+    end
+  end
+
+  context '#publish' do
+    it 'makes a properly formatted request' do
+      Net::HTTP.should_receive(:post_form).with(
+        anything, {message: {channel: "/records/created", data: data}.to_json}
+      )
+      Net::HTTP.stub(:post_form)
+
+      Robin.publish record, :created, data
+    end
+
+    it 'sends the request to the configured server' do
+
+        # URI.parse('http://localhost:9292/faye'),
+    end
+  end
+
+  context '#channel_for' do
+    it 'generates a path similar to a Rails route' do
+      Robin.channel_for(record, :busted).should == "/records/busted"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'coveralls'
+Coveralls.wear!

data/vendor/assets/javascripts/robin/reactor.js.coffee

@@ -0,0 +1,70 @@
+# Utility class for updating models in memory.
+Batman.Reactor =
+  # Private queue for jQuery
+  _q: $({})
+
+  # Valid batch operations
+  _verbs: ["updated", "created", "destroyed", "flushed", "batched"]
+
+  # Public interface for updating objects in Batman in a bulk/one off fashion
+  process: (verb, model, data) ->
+    if _.contains @_verbs, verb
+      @['_'+verb](model, data)
+    else
+      Batman.developer.warn("unrecognized batch operation: " + verb)
+
+  _enqueue: (model, batch_item) ->
+    @_q.queue (next) =>
+      @process(batch_item[0], model, batch_item[1])
+      next()
+
+  _getObject: (model, data) ->
+    # model = Batman.currentApp[pushed_data.model_name]
+    # data = pushed_data.model_data
+    obj = new model()
+    obj._withoutDirtyTracking -> obj.fromJSON(data)
+    return obj
+
+  # Flush every object of a certain model that matches the criterion (all comments for a post)
+  # used when you have too much data to pass through Pusher but want Batman to request updates
+  _flushed: (model, data) ->
+    # model = Batman.currentApp[reload_data.model_name]
+    match_key = data.match_key
+    match_value = data.match_value
+    Batman.developer.log("FLUSH #{model.name} - #{match_key} => #{match_value}")
+    recordsToRemove = model.get('loaded').indexedBy(match_key).get(match_value).toArray()
+    recordsToRemove.forEach (existing) =>
+      model.get('loaded').remove(existing)
+    if match_key == 'id'
+      model.find match_value, ->
+    else
+      options = {}
+      options["#{match_key}"] = match_value
+      model.load options
+
+  _batched: (model, batch) ->
+    return if batch == undefined
+    Batman.developer.log("BATCH: " + batch.length)
+    for batched_item in batch
+      @_enqueue(model, batched_item)
+
+  _created: (model, data) ->
+    Batman.developer.log("created: #{JSON.stringify(data)}")
+    obj = model.get('loaded.indexedByUnique.id').get(data["id"])
+    if obj # If object already in memory, update it
+      obj._withoutDirtyTracking -> obj.fromJSON(data)
+    else # create object in memory
+      obj = @_getObject(model, data)
+      model._mapIdentity(obj)
+
+  _updated: (model, data) ->
+    Batman.developer.log("updated #{JSON.stringify(data)}")
+    obj = model.get('loaded.indexedByUnique.id').get(data["id"])
+    if obj
+      obj._withoutDirtyTracking -> obj.fromJSON(data)
+
+  _destroyed: (model, data) ->
+    Batman.developer.log("destroyed #{JSON.stringify(data)}")
+    existing = model.get('loaded.indexedByUnique.id').get(data["id"])
+    if existing
+      model.get('loaded').remove(existing)

data/vendor/assets/javascripts/robin/robin.js.coffee

@@ -0,0 +1,44 @@
+# Push-persistence backed by Faye.
+class Batman.Robin extends Batman.Object
+  @_nest: []
+  @_verbs: ["updated", "created", "destroyed", "flushed", "batched"]
+
+  @on 'socket:ready', ->
+    @socket = Batman.currentApp.socket
+    bird() for bird in @_nest
+
+  constructor: (@model) ->
+    if @socket
+      # Go ahead and subscribe.
+      @subscribe()
+    else
+      # Add it to the nest.
+      Batman.Robin._nest.push =>
+        @socket = Batman.Robin.socket
+        @subscribe()
+
+  subscribe: ->
+    channel = @model.storageKey
+    Batman.developer.log "Subscribing to /#{channel}..."
+    for verb in @constructor._verbs
+      do (verb) =>
+        @socket.subscribe "/#{channel}/#{verb}", (data) => @delayIfXhrRequests(verb, data)
+
+  delayIfXhrRequestsWithoutDecompress: (method, data) ->
+    if Batman.Robin.activeXhrCount == 0
+      setTimeout =>
+        Batman.developer.log("Processing #{method} with data #{JSON.stringify(data)}")
+        Batman.Reactor.process(method, @model, data)
+      , 0
+    else
+      Batman.developer.log("Delaying #{method}")
+      setTimeout =>
+        @delayIfXhrRequestsWithoutDecompress(method, data)
+      , 500
+
+  delayIfXhrRequests: (method, data) ->
+    @delayIfXhrRequestsWithoutDecompress(method, data)
+
+@Robin = Batman.Robin
+@Robin.activeXhrCount = 0
+$(document).ajaxSend(=> @Robin.activeXhrCount++).ajaxComplete(=> @Robin.activeXhrCount--)

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: robin-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jonathan Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !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: '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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-rspec
+  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: Every Batman.js app on Rails needs a sidekick. Bring realtime to the
+  fight with Robin.js.
+email:
+- me@nybblr.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/robin-rails.rb
+- lib/robin.rb
+- lib/robin/rails.rb
+- lib/robin/rails/version.rb
+- robin-rails.gemspec
+- spec/fixtures/dummy_model.rb
+- spec/robin/rails_spec.rb
+- spec/robin_spec.rb
+- spec/spec_helper.rb
+- vendor/assets/javascripts/robin/reactor.js.coffee
+- vendor/assets/javascripts/robin/robin.js.coffee
+homepage: https://github.com/nybblr/robin-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+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: Realtime updates are awesome and the future of web apps. But they're a pain
+  to use from scatch for anything more complex than a couple models. We'd like things
+  to just "autoupdate" and add functionality as desired to react to live updates.
+  That's where Robin.js comes in.
+test_files:
+- spec/fixtures/dummy_model.rb
+- spec/robin/rails_spec.rb
+- spec/robin_spec.rb
+- spec/spec_helper.rb
+has_rdoc: