rack_push 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Oliver Nightingale
+
+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.rdoc

@@ -0,0 +1,17 @@
+= rack_push
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Oliver Nightingale. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rack_push"
+    gem.summary = %Q{rack interface for with pusher}
+    gem.description = %Q{rack interface for with pusher}
+    gem.email = "oliver.n@new-bamboo.co.uk"
+    gem.homepage = "http://github.com/olivernn/rack_push"
+    gem.authors = ["Oliver Nightingale"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rack_push #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/rack_push.rb

@@ -0,0 +1,13 @@
+require 'rack'
+require 'pusher'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/jem')
+
+require 'rack_push/request'
+require 'rack_push/app'
+
+module Rack
+  module Push
+    
+  end
+end

data/lib/rack_push/app.rb

@@ -0,0 +1,38 @@
+module Rack
+  module Push
+    class App
+      def initialize app, options
+        @app = app
+        @path = options[:path] || '/pusher'
+        @method = options[:method] || :post
+        Pusher.key = options[:key]
+        Pusher.app_id = options[:app_id]
+        Pusher.secret = options[:secret]
+      end
+
+      def call(env)
+        request = Push::Request.new(env)
+        if push_this request
+          if request.well_formed?
+            Pusher[request.channel].trigger(
+              request.event,
+              request.event_data,
+              request.socket_id
+            )
+            [200, {"Content-Type" => "text/plain", "Content-Length" => "0"}, [""]]
+          else
+            [412, {"Content-Type" => "text/plain", "Content-Length" => "0"}, [""]]
+          end
+        else
+          @app.call(env)
+        end
+      end
+
+      private
+
+      def push_this request
+        (request.request_method.downcase.to_sym == @method) && (!!request.path_info.match(%r{^#{@path}/[\w-]*$}))
+      end
+    end
+  end
+end

data/lib/rack_push/request.rb

@@ -0,0 +1,43 @@
+module Rack
+  module Push
+    class Request < Rack::Request
+      include Rack::Utils
+
+      attr_reader :env
+
+      def initialize(env)
+        @env = env
+        super(env)
+      end
+
+      def channel
+        path_info.split('/').last
+      end
+
+      [:event, :socket_id].each do |param|
+        define_method param do
+          str = ""
+          query_string.split(query_string_seperator).each do |pair|
+            str = pair.gsub("#{param}=", "") if pair.match("#{param}=")
+          end
+          str
+        end
+      end
+
+      def event_data
+        self.body.rewind
+        self.body.read
+      end
+
+      def well_formed?
+        !event.empty? && !socket_id.empty? && !channel.empty? && !event_data.empty?
+      end
+
+      private
+
+      def query_string_seperator
+        query_string.match(";") ? ";" : "&"
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'test/unit'
+require 'rack/test'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rack_push'
+
+
+class Test::Unit::TestCase
+  def self.test(name, &block)
+    test_name = "test_#{name.gsub(/\s+/,'_')}".to_sym
+    defined = instance_method(test_name) rescue false
+    raise "#{test_name} is already defined in #{self}" if defined
+    if block_given?
+      define_method(test_name, &block)
+    else
+      define_method(test_name) do
+        flunk "No implementation provided for #{name}"
+      end
+    end
+  end
+end 

data/test/test_rack_push.rb

@@ -0,0 +1,80 @@
+require 'helper'
+
+class TestRackPush < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def setup
+    TestRackPush.class_eval { def app; using_default_params; end }
+    Pusher.key = 'pusher_key'
+    Pusher.app_id = 'app_id'
+    Pusher.secret = 'secret'
+  end
+
+  def using_default_params
+    # default url for Rack::Push is '/pusher'
+    Rack::Push::App.new lambda { |env|
+      [200, {'Content-Length' => '10', 'Content-Type' => 'text/plain'}, ["NOT PUSHER"]]
+    }, :key => 'pusher_key', :app_id => 'app_id', :secret => 'secret'
+  end
+
+  def using_custom_params
+    Rack::Push::App.new lambda { |env|
+      [200, {'Content-Length' => '10', 'Content-Type' => 'text/plain'}, ["NOT PUSHER"]]
+    }, :key => 'pusher_key', :app_id => 'app_id', :secret => 'secret', :path => '/customized/path', :method => :put
+  end
+
+  test "bypassing Rack::Push" do
+    Pusher['my_channel'].expects(:trigger).never
+    get '/not_pusher'
+    assert last_response.ok?
+    assert_equal "NOT PUSHER", last_response.body
+  end
+
+  test "sending a request to pusher" do
+    mock_channel = mock('channel')
+    mock_channel.stubs(:trigger)
+    Pusher.stubs(:[]).returns(mock_channel)
+    Pusher['my_channel'].expects(:trigger).with('my_event', '{"title":"pushing"}', '123')
+    post '/pusher/my_channel?event=my_event&socket_id=123', '{"title":"pushing"}'
+    assert last_response.ok?
+    assert_not_equal "NOT PUSHER", last_response.body
+  end
+
+  test "ignoring wrong request methods" do
+    Pusher['my_channel'].expects(:trigger).never
+    put '/pusher/my_channel?event=my_event&socket_id=123', '{"title":"pushing"}'
+    assert last_response.ok?
+    assert_equal "NOT PUSHER", last_response.body
+  end
+
+  test "handling missing parameters" do
+    Pusher['my_channel'].expects(:trigger).never
+    post '/pusher/my_channel?event=my_event', '{"title":"pushing"}'
+    assert_equal 412, last_response.status
+  end
+
+  test "trying to push no data" do
+    Pusher['my_channel'].expects(:trigger).never
+    post '/pusher/my_channel?event=my_event&socket_id=123'
+    assert_equal 412, last_response.status
+  end
+
+  test "bypassing when using custom params" do
+    TestRackPush.class_eval { def app; using_custom_params; end }
+    Pusher['my_channel'].expects(:trigger).never
+    get '/not_pusher'
+    assert last_response.ok?
+    assert_equal "NOT PUSHER", last_response.body
+  end
+
+  test "sending a request to pusher when using custom params" do
+    TestRackPush.class_eval { def app; using_custom_params; end }
+    mock_channel = mock('channel')
+    mock_channel.stubs(:trigger)
+    Pusher.stubs(:[]).returns(mock_channel)
+    Pusher['my_channel'].expects(:trigger).with('my_event', '{"title":"pushing"}', '123')
+    put '/customized/path/my_channel?event=my_event&socket_id=123', '{"title":"pushing"}'
+    assert last_response.ok?
+    assert_not_equal "NOT PUSHER", last_response.body
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: rack_push
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Oliver Nightingale
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-04 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: rack interface for with pusher
+email: oliver.n@new-bamboo.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rack_push.rb
+- lib/rack_push/app.rb
+- lib/rack_push/request.rb
+- test/helper.rb
+- test/test_rack_push.rb
+has_rdoc: true
+homepage: http://github.com/olivernn/rack_push
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: rack interface for with pusher
+test_files: 
+- test/helper.rb
+- test/test_rack_push.rb