proby_notifier 1.0.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.swp
+pkg/*
+.yardoc
+doc
+rdoc
+

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    proby_notifier (1.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bluecloth (2.1.0)
+    fakeweb (1.3.0)
+    rake (0.8.7)
+    shoulda (2.11.3)
+    yard (0.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bluecloth (~> 2.1.0)
+  bundler (~> 1.0.0)
+  fakeweb (~> 1.3.0)
+  proby_notifier!
+  rake (~> 0.8.7)
+  shoulda (~> 2.11.3)
+  yard (~> 0.6.4)

data/README.md

@@ -0,0 +1,53 @@
+# ProbyNotifier
+A simple library for working with the Proby task monitoring application.
+
+
+Setup
+-----
+Before notifications can be sent, you must tell ProbyNotifier your API key.  This only needs to be done once,
+and should ideally be done inside your apps initialization code.
+
+    ProbyNotifier.api_key = "b4fe1200c105012efde3482a1411a947"
+
+In addition, you can optionally give ProbyNotifier a logger to use.
+
+    ProbyNotifier.logger = Rails.logger
+
+
+Sending Notifications
+---------------------
+To send a start notification
+
+    ProbyNotifier.send_start_notification(task_api_id)
+
+To send a finish notification
+
+    ProbyNotifier.send_finish_notification(task_api_id)
+
+Specifying the `task_api_id` when calling the notification methods is optional.  If it is not provided,
+ProbyNotifier will use the value of the `PROBY_TASK_ID` environment variable.  If no task id is specified
+in the method call, and no value is set in the `PROBY_TASK_ID` environment variable, then no notification
+will be sent.
+
+
+The Resque Plugin
+-----------------
+The Resque plugin will automatically send start and finish notifications to Proby when your job
+starts and finishes.  Simply `extend ProbyNotifier::ResquePlugin` in your Resque job.  The task id
+can either be pulled from the `PROBY_TASK_ID` environment variable, or specified in the job itself
+by setting the `@proby_id` attribute to the task id.
+
+    class SomeJob
+      extend ProbyNotifier::ResquePlugin
+      @proby_id = 'abc123'  # Or simply let it use the value in the PROBY_TASK_ID environment variable
+
+      self.perform
+        do_stuff
+      end
+    end
+
+
+API Doc
+-------
+[http://rdoc.info/github/signal/proby_notifier/master/frames](http://rdoc.info/github/signal/proby_notifier/master/frames)
+

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+require 'rake/testtask'
+require 'yard'
+
+task :default => :test
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = ENV['TEST'] || "test/**/*_test.rb"
+  test.verbose = true
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+end
+
+desc 'Delete yard, and other generated files'
+task :clobber => [:clobber_yard]
+
+desc 'Delete yard generated files'
+task :clobber_yard do
+  puts 'rm -rf doc .yardoc'
+  FileUtils.rm_rf ['doc', '.yardoc']
+end
+

data/lib/proby_notifier/proby_notifier.rb

@@ -0,0 +1,88 @@
+require 'net/https'
+require 'logger'
+
+module ProbyNotifier
+
+  BASE_URL = "https://proby.signalhq.com/tasks/"
+
+  # Deliver start and finish notifications to Proby.
+  class << self
+
+    # Set your Proby API key.
+    #
+    # @param [String] api_key Your Proby API key
+    #
+    # @example
+    #   ProbyNotifier.api_key = '1234567890abcdefg'
+    def api_key=(api_key)
+      @api_key = api_key
+    end
+
+    # Set the logger to be used by Proby.
+    #
+    # @param [Logger] logger The logger you would like ProbyNotifier to use
+    #
+    # @example
+    #   ProbyNotifier.logger = Rails.logger
+    #   ProbyNotifier.logger = Logger.new(STDERR)
+    def logger=(logger)
+      @logger = logger
+    end
+
+    # Get the logger used by Proby.
+    def logger
+      @logger || Logger.new("/dev/null")
+    end
+
+    # Send a start notification for this task to Proby.
+    #
+    # @param [String] proby_task_id The id of the task to be notified. If nil, the 
+    #                               value of the +PROBY_TASK_ID+ environment variable will be used.
+    def send_start_notification(proby_task_id=nil)
+      send_notification('/start', proby_task_id)
+    end
+
+    # Send a finish notification for this task to Proby
+    #
+    # @param [String] proby_task_id The id of the task to be notified. If nil, the 
+    #                               value of the +PROBY_TASK_ID+ environment variable will be used.
+    def send_finish_notification(proby_task_id=nil)
+      send_notification('/finish', proby_task_id)
+    end
+
+    private
+
+    def send_notification(type, proby_task_id)
+      if @api_key.nil?
+        logger.warn "ProbyNotifier: No notification sent because API key is not set"
+        return nil
+      end
+
+      proby_task_id = ENV['PROBY_TASK_ID'] if is_blank?(proby_task_id)
+      if is_blank?(proby_task_id)
+        logger.warn "ProbyNotifier: No notification sent because task ID was not specified"
+        return nil
+      end
+
+      url = BASE_URL + proby_task_id + type
+      uri = URI.parse(url)
+      req = Net::HTTP::Post.new(uri.path, {'api_key' => @api_key})
+
+      http = Net::HTTP.new(uri.host, uri.port) 
+      http.open_timeout = 3
+      http.read_timeout = 3
+      http.use_ssl = true
+      res = http.start { |h| h.request(req) }
+      return res.code.to_i
+    rescue Exception => e
+      logger.error "ProbyNotifier: Proby notification failed: #{e.message}"
+      logger.error e.backtrace
+    end
+
+    def is_blank?(string)
+      string.nil? || string.strip == ''
+    end
+  end
+
+end
+

data/lib/proby_notifier/resque_plugin.rb

@@ -0,0 +1,58 @@
+module ProbyNotifier
+  # Automatically notifies Proby when this job starts and finishes.
+  #
+  #   class SomeJob
+  #     extend ProbyNotifier::ResquePlugin
+  #
+  #     self.perform
+  #       do_stuff
+  #     end
+  #   end
+  #
+  # The Proby Task ID can be set in one of two ways. The most common way is to
+  # put the ID in an ENV variable that is set in your crontab. This ID will be
+  # transparently passed to the Resque job via Redis.
+  #
+  #   0 0 * * * PROBY_TASK_ID=abc123 ./queue_some_job
+  #
+  # Alternatively, if you're not using cron and therefore don't want that
+  # support, you can just set the @proby_id ivar in the class, like so.
+  #
+  #   class SomeJob
+  #     extend ProbyNotifier::ResquePlugin
+  #     @proby_id = 'abc123'
+  #
+  #     self.perform
+  #       do_stuff
+  #     end
+  #   end
+  #
+  # Setting the @proby_id variable will take precendence over the ENV variable.
+  #
+  module ResquePlugin
+    def proby_id_bucket(*args)
+      "proby_id:#{name}-#{args.to_s}"
+    end
+
+    def before_enqueue_proby(*args)
+      return true if @proby_id
+
+      env_proby_id = ENV['PROBY_TASK_ID']
+      Resque.redis.setex(proby_id_bucket(*args), 24.hours, env_proby_id)
+      return true
+    end
+
+    def proby_id(*args)
+      @proby_id || Resque.redis.get(proby_id_bucket(*args))
+    end
+
+    def around_perform_proby(*args)
+      _proby_id = proby_id(*args)
+      ProbyNotifier.send_start_notification(_proby_id)
+      yield
+    ensure
+      ProbyNotifier.send_finish_notification(_proby_id)
+    end
+  end
+end
+

data/lib/proby_notifier/version.rb

@@ -0,0 +1,3 @@
+module ProbyNotifier
+  VERSION = "1.0.0"
+end

data/lib/proby_notifier.rb

@@ -0,0 +1,2 @@
+require 'proby_notifier/proby_notifier'
+require 'proby_notifier/resque_plugin'

data/proby_notifier.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/proby_notifier/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "proby_notifier"
+  s.license     = "MIT"
+  s.version     = ProbyNotifier::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["John Wood", "Doug Barth"]
+  s.email       = ["john@signalhq.com", "doug@signalhq.com"]
+  s.homepage    = "http://github.com/signal/proby_notifier"
+  s.summary     = %Q{A simple library for working with the Proby task monitoring application.}
+  s.description = %Q{A simple library for working with the Proby task monitoring application.}
+
+  s.rubyforge_project = "proby_notifier"
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.add_development_dependency "bundler", "~> 1.0.0"
+  s.add_development_dependency "rake", "~> 0.8.7"
+  s.add_development_dependency "yard", "~> 0.6.4"
+  s.add_development_dependency "bluecloth", "~> 2.1.0"
+  s.add_development_dependency "fakeweb", "~> 1.3.0"
+  s.add_development_dependency "shoulda", "~> 2.11.3"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end
+

data/test/proby_notifier_test.rb

@@ -0,0 +1,50 @@
+require 'test_helper'
+
+class ProbyNotifierTest < Test::Unit::TestCase
+
+  def setup
+    ENV['PROBY_TASK_ID'] = nil
+    FakeWeb.clean_registry
+  end
+
+  should "not send the notification if the api_key is not set" do
+    assert_nil ProbyNotifier.send_start_notification("abc123")
+  end
+
+  context "with an api key set" do
+    setup do
+      ProbyNotifier.api_key = '1234567890abcdefg'
+    end
+
+    should "not send the notification if a task id was not specified" do
+      assert_nil ProbyNotifier.send_start_notification
+    end
+
+    should "not send the notification if a task id is blank" do
+      assert_nil ProbyNotifier.send_start_notification("  ")
+    end
+
+    should "send a start notification if a task_id is specified in the call" do
+      FakeWeb.register_uri(:post, "https://proby.signalhq.com/tasks/abc123xyz456/start", :status => ["200", "Success"])
+      assert_equal 200, ProbyNotifier.send_start_notification("abc123xyz456")
+    end
+
+    should "send a start notification if a task_id is specified in an environment variable" do
+      ENV['PROBY_TASK_ID'] = "uuu777sss999"
+      FakeWeb.register_uri(:post, "https://proby.signalhq.com/tasks/uuu777sss999/start", :status => ["200", "Success"])
+      assert_equal 200, ProbyNotifier.send_start_notification
+    end
+
+    should "send a finish notification if a task_id is specified in the call" do
+      FakeWeb.register_uri(:post, "https://proby.signalhq.com/tasks/abc123xyz456/finish", :status => ["200", "Success"])
+      assert_equal 200, ProbyNotifier.send_finish_notification("abc123xyz456")
+    end
+
+    should "send a finish notification if a task_id is specified in an environment variable" do
+      ENV['PROBY_TASK_ID'] = "iii999ooo222"
+      FakeWeb.register_uri(:post, "https://proby.signalhq.com/tasks/iii999ooo222/finish", :status => ["200", "Success"])
+      assert_equal 200, ProbyNotifier.send_finish_notification
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'test/unit'
+require 'fakeweb'
+require 'shoulda'
+
+require 'proby_notifier'
+

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification 
+name: proby_notifier
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- John Wood
+- Doug Barth
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-17 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  type: :development
+  prerelease: false
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  name: rake
+  type: :development
+  prerelease: false
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 6
+        - 4
+        version: 0.6.4
+  name: yard
+  type: :development
+  prerelease: false
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  name: bluecloth
+  type: :development
+  prerelease: false
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  name: fakeweb
+  type: :development
+  prerelease: false
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 37
+        segments: 
+        - 2
+        - 11
+        - 3
+        version: 2.11.3
+  name: shoulda
+  type: :development
+  prerelease: false
+  requirement: *id006
+description: A simple library for working with the Proby task monitoring application.
+email: 
+- john@signalhq.com
+- doug@signalhq.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/proby_notifier.rb
+- lib/proby_notifier/proby_notifier.rb
+- lib/proby_notifier/resque_plugin.rb
+- lib/proby_notifier/version.rb
+- proby_notifier.gemspec
+- test/proby_notifier_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/signal/proby_notifier
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: proby_notifier
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: A simple library for working with the Proby task monitoring application.
+test_files: []
+