live_resource-pubnub 0.0.1

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/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in live_resource-pubnub.gemspec
+gemspec
+
+gem 'live_resource', path: '/Users/Will/Projects/Balanced Tree/live_resource'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Will Madden
+
+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,48 @@
+# LiveResource::Pubnub
+
+Provides LiveResource integration with Pubnub.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'live_resource-pubnub'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install live_resource-pubnub
+
+## Usage
+
+Instantiate and supply a PubnubProtocol to the LiveResource::Builder.
+
+## Rails
+
+(Requires [live_resource-rails](http://github.com/live-resource/rails)
+
+```ruby
+# application.rb
+
+...
+
+config.live_resource[:protocol] = LiveResource::Pubnub::PubnubProtocol.new(
+  Pubnub.new(
+    publish_key:   Education::Application.config.pubnub[:publish_key],
+    subscribe_key: Education::Application.config.pubnub[:subscribe_key],
+    secret_key:    Education::Application.config.pubnub[:secret_key],
+    cipher_key:    Education::Application.config.pubnub[:cipher_key],
+    ssl:           false
+  ))
+```
+
+## 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 @@
+require "bundler/gem_tasks"

data/lib/live_resource/pubnub/pubnub_protocol.rb

@@ -0,0 +1,37 @@
+require 'live_resource/protocol'
+
+module LiveResource
+  module Pubnub
+
+    class PubnubProtocol
+      include LiveResource::Protocol
+
+      def initialize(pubnub)
+        @pubnub = pubnub
+      end
+
+      def publish_message(resource_identifier, type, params = nil)
+        params     ||= {}
+        channel_id = channel_for(resource_identifier)
+
+        message = params.merge(
+            :type           => type,
+            :':resource_id' => resource_identifier,
+        )
+
+        @pubnub.publish(
+            params.merge(
+                :channel  => channel_id,
+                :message  => message,
+                :callback => ->(x) {}
+            ))
+      end
+
+      def channel_for(resource_id)
+        resource_id
+      end
+
+    end
+
+  end
+end

data/lib/live_resource/pubnub/version.rb

@@ -0,0 +1,5 @@
+module LiveResource
+  module Pubnub
+    VERSION = "0.0.1"
+  end
+end

data/lib/live_resource/pubnub.rb

@@ -0,0 +1,8 @@
+require "live_resource/pubnub/version"
+require "live_resource/pubnub/pubnub_protocol"
+
+module LiveResource
+  module Pubnub
+    # Your code goes here...
+  end
+end

data/live_resource-pubnub.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'live_resource/pubnub/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "live_resource-pubnub"
+  spec.version       = LiveResource::Pubnub::VERSION
+  spec.authors       = ["Will Madden"]
+  spec.email         = ["will@letsgeddit.com"]
+  spec.description   = %q{Provides LiveResource integration with Pubnub.}
+  spec.summary       = %q{Provides LiveResource integration with Pubnub.}
+  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_dependency 'live_resource'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/live_resource/pubnub/pubnub_protocol_spec.rb

@@ -0,0 +1,81 @@
+require "spec_helper"
+
+include LiveResource::Pubnub
+
+describe PubnubProtocol do
+
+  it 'should include the Protocol module' do
+    expect(PubnubProtocol).to include(LiveResource::Protocol)
+  end
+
+  let(:pubnub_protocol) { PubnubProtocol.new(pubnub) }
+
+  let(:pubnub) { double('Pubnub', publish: nil) }
+
+  describe "#publish_message" do
+    subject { pubnub_protocol.publish_message(resource_id, message_type, params) }
+
+    let(:resource_id) { :some_resource }
+    let(:message_type) { 'resource:reset' }
+    let(:params) {}
+    let(:channel) { 'hashed-channel-ID' }
+
+    before do
+      pubnub_protocol.stub(channel_for: channel)
+    end
+
+    it 'should get the channel ID for the resource' do
+      pubnub_protocol.should_receive(:channel_for).with(resource_id)
+      subject
+    end
+
+    it 'should publish a message to pubnub' do
+      pubnub.should_receive(:publish)
+      subject
+    end
+
+    describe 'the message' do
+      subject { pubnub_message }
+
+      let(:pubnub_message) { @pubnub_argument[:message] }
+      let(:pubnub_channel) { @pubnub_argument[:channel] }
+      let(:pubnub_callback) { @pubnub_argument[:callback] }
+
+      before do
+        _arg = nil
+        pubnub.stub(:publish) { |arg| _arg = arg }
+        pubnub_protocol.publish_message(resource_id, message_type, params)
+        @pubnub_argument = _arg
+      end
+
+      it 'should be published on the channel for the resource' do
+        expect(channel).to be(channel)
+      end
+
+      it 'should supply a callback' do
+        expect(pubnub_callback).to_not be_nil
+      end
+
+      its([:type]) { should == message_type }
+      its([:':resource_id']) { should == resource_id }
+
+      context 'when some params are given' do
+        let(:params) { { a: 'b', c: 1, d: true } }
+
+        its([:a]) { should == 'b' }
+        its([:c]) { should == 1 }
+        its([:d]) { should == true }
+      end
+    end
+  end
+
+  describe "#channel_for" do
+    subject { pubnub_protocol.channel_for(resource_id) }
+
+    let(:resource_id) { '/a/b/c' }
+
+    it 'should return the channel ID to use to publish messages for the given resource' do
+      expect(subject).to eq resource_id
+    end
+  end
+end

data/spec/live_resource/pubnub_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe LiveResource::Pubnub do
+  it 'should have a version number' do
+    LiveResource::Pubnub::VERSION.should_not be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+def require_tree(path)
+  path = File.expand_path(path, File.dirname(__FILE__))
+
+  files = Dir.glob(File.join(path, '**/*.rb'))
+  raise "Directory '#{path}' is empty" unless files.length > 0
+
+  files.each { |file| puts "  require #{file}"; require file }
+end
+
+require_tree '../lib'

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: live_resource-pubnub
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Will Madden
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: live_resource
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides LiveResource integration with Pubnub.
+email:
+- will@letsgeddit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/live_resource/pubnub.rb
+- lib/live_resource/pubnub/pubnub_protocol.rb
+- lib/live_resource/pubnub/version.rb
+- live_resource-pubnub.gemspec
+- spec/live_resource/pubnub/pubnub_protocol_spec.rb
+- spec/live_resource/pubnub_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2026245229616821162
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2026245229616821162
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Provides LiveResource integration with Pubnub.
+test_files:
+- spec/live_resource/pubnub/pubnub_protocol_spec.rb
+- spec/live_resource/pubnub_spec.rb
+- spec/spec_helper.rb