heroku_notification 0.0.1

data/README.mdown

@@ -0,0 +1,43 @@
+# HerokuNotification
+
+HerokuNotification provides an easy way of interfacing with the [Heroku
+Notifications API](https://github.com/heroku/notifications).
+
+## Usage
+
+The Notifications API requires a subject, text, and details of who or what
+you want to send the message to:
+
+    HerokuNotification.post(:subject => "Will you be my valentine?",
+                            :text => "Please help be support rampant consumerism.",
+                            :to => @user)
+
+Alternatively you can explicitly provie the recipient type and id:
+
+    HerokuNotification.post(:subject => "Will you be my valentine?",
+                            :text => "Please help be support rampant consumerism.",
+                            :to => "user",
+                            :id => 1)
+
+Include any additional parameters (e.g., `:html`) and they will be sent
+along also.
+
+## Why would I want to use this?
+
+Because you're too lazy to read the API docs for the main notifications
+service, or you don't want to have to keep up with any API changes*. Both
+are perfectly valid, and not mutually exclusive.
+
+*I'll keep this client gem in line with the currently deployed API, while
+making every effort to maintain backward compatibility in the gem.
+
+## Compatibility
+
+Test suite has currently only been confirmed on the following platforms:
+
+ * MRI Ruby 1.9.2
+
+## Contributions
+
+Patches gladly accepted. Please fork this repo, add a relevant test, and send
+me a pull request.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'rake'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+
+spec_data = File.open('heroku_notification.gemspec').read
+spec = nil
+Thread.new do
+  spec = eval("#{spec_data}")
+end.join
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = false
+  pkg.need_tar = false
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = false
+end

data/lib/heroku_notification.rb

@@ -0,0 +1,4 @@
+base_dir = File.join(File.dirname(__FILE__), "heroku_notification")
+["base", "errors"].each do |lib|
+  require File.join(base_dir, lib)
+end

data/lib/heroku_notification/base.rb

@@ -0,0 +1,17 @@
+require 'rest_client'
+class HerokuNotification
+  def self.post(params = {})
+    if !params[:to].is_a?(String) && params[:to].respond_to?(:id)
+      params[:id] = params[:to].id
+      params[:to] = params[:to].class.to_s.downcase
+    elsif params[:to].is_a?(Symbol)
+      params[:to] = params[:to].to_s
+    end
+    RestClient.post(url + '/notifications', params)
+  end
+
+  private
+    def self.url
+      ENV["NOTIFICATIONS_URL"] || "https://notifications.heroku.com"
+    end
+end

data/lib/heroku_notification/errors.rb

@@ -0,0 +1,2 @@
+class HerokuNotificationError < StandardError; end
+

data/lib/heroku_notification/rspec.rb

@@ -0,0 +1,26 @@
+require 'heroku_notification/test_unit'
+class HaveNotifiedWith
+
+  def initialize(params)
+    @params = params
+  end
+
+  def matches?(target)
+    assert_notified_with(@params)
+    true
+  rescue Spec::Expectations::ExpectationNotMetError
+    false
+  end
+
+  def failure_message
+    "expected Notification to be posted with #{@params.inspect}"
+  end
+  def negative_failure_message
+    "expected Notification to not be posted with #{@params.inspect}"
+  end
+end
+
+def have_notified_with(params)
+  HaveNotifiedWith.new(params)
+end
+include HerokuNotificationAssertions

data/lib/heroku_notification/test_unit.rb

@@ -0,0 +1,23 @@
+require 'webmock/test_unit'
+module HerokuNotificationAssertions
+  include WebMock::API
+  def assert_notified_with(params)
+    assert_requested(:post, "https://notifications.heroku.com/notifications") do |req|
+      params_in_post_body(params, req.body)
+    end
+  end
+
+  def stub_notification
+    stub_request(:post, "https://notifications.heroku.com/notifications")
+  end
+
+  private
+    def params_in_post_body(params, body)
+      params.each do |key,val|
+        encoded_pair = "#{CGI::escape(key.to_s)}=#{URI::escape(val.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))}"
+        return false unless body.index(encoded_pair)
+      end
+      return true
+    end
+
+end

data/test/heroku_notification/base_test.rb

@@ -0,0 +1,36 @@
+$:.unshift File.expand_path("..", File.dirname(__FILE__))
+require "test_helper"
+require "heroku_notification/test_unit"
+
+class User
+  def id
+    2
+  end
+end
+
+class HerokuNotificationTest < Test::Unit::TestCase
+  include HerokuNotificationAssertions
+
+  context "posting a message to a user" do
+    setup do
+      stub_request(:post, "https://notifications.heroku.com/notifications")
+    end
+
+    should "pass through the params" do
+      params = { :subject => "Will you be my valentine?",
+                 :text => "Please help be support rampant consumerism.",
+                 :html => "You make my <blink>eyes</blink>",
+                 :to   => "user",
+                 :id   => 1 }
+      HerokuNotification.post(params)
+      assert_notified_with params
+    end
+
+    should "detect the target recipient without an explicit ID" do
+      params = { :to => User.new }
+      expected_params = { :to => "user", :id => 2 }
+      HerokuNotification.post(params)
+      assert_notified_with expected_params
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'test/unit'
+require 'shoulda'
+require 'webmock/test_unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require "heroku_notification"
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: heroku_notification
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Glenn Gillen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-28 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: A client gem for interacting with the REST-based Heroku Notifications API
+email: glenn@rubypond.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.mdown
+- Rakefile
+- lib/heroku_notification/base.rb
+- lib/heroku_notification/errors.rb
+- lib/heroku_notification/rspec.rb
+- lib/heroku_notification/test_unit.rb
+- lib/heroku_notification.rb
+- test/heroku_notification/base_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/heroku/notifications_client
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- .
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.0
+signing_key: 
+specification_version: 2
+summary: A wrapper for the Heroku Notifications service
+test_files: 
+- test/heroku_notification/base_test.rb
+- test/test_helper.rb