maser-hoptoad-notifier-client 1.0.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2008-10-22
+
+* 1 Created
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/hoptoad-notifier-client
+lib/hoptoad-notifier-client
+test/hoptoad-notifier-client

data/README.txt

@@ -0,0 +1,89 @@
+= hoptoad-notifier-client
+
+Posts exceptions to http://www.optoadapp.com using their api: http://wesmaldonado.hoptoadapp.com/pages/api
+
+== DESCRIPTION:
+
+Sends exceptions to Hoptoad [http://www.hoptoadapp.com/].  Supports reporting against multiple api keys and customized error_types/messages when you're too lazy to subclass exception but still want to report something.
+
+or...
+
+A standalone tiny HoptoadNotifier.  Supports posting to multiple projects (aka api keys).  Posting exceptions or information ala Eugene Bolshakov's post http://www.taknado.com/2008/10/19/hoptoad-as-an-online-events-log with ease.
+ 
+== FEATURES/PROBLEMS:
+
+=== Features ===
+
+* Easy to use in non-rails apps and less code than doing it yourself.
+* Matches the HoptoadNotifier API
+* Supports multiple projects (api keys) so you can configure it once via an intializer in rails and have it report against many projects (or business units/features/etc.)
+
+=== Problems ===
+
+* Its only a few lines of code, so why use it at all? :)
+* I'm lazy and need to move the specs from the work project into this branch.
+
+== SYNOPSIS:
+
+  HoptoadNotifierClient.configure do |toad|
+	  # Only have one project on Hoptoad?  
+	  # Register a default and you can use the shorter HoptoadNotifierClient.notify(exception) method
+    toad.register(:default, 'default-api-key')
+
+		# What!?!?  Several projects or sub components you want to report via separate projects?
+	  # Register them with a names like :profitable_feature 
+    toad.register(:profitable_feature, 'profitable-feature-api-key')
+
+  end
+
+Sometime later in your code... 
+
+  begin
+    raise 'Not a happy camper!'
+  rescue => ex
+    # reports using :default project
+    HoptoadNotifierClient.notify(ex)
+
+	  # reports using profitable feature project, unbelievable!    
+	  HoptoadNotifierClient.create(:profitable_feature).notify(exception)
+
+	  # reports random information for the profitable feature project, unbelievable!
+		error_report = OpenStruct.new(:error_type => 'random thing', :custom_message => 'where am I?')
+    #  Hoptoad Notifcation Subject Line looks like this
+    # [Profitable Feature] : #{error_type}: #{custom_message}
+	  HoptoadNotifierClient.create(:profitable_feature).notify(error_report, more_detail_as_request_parameter)
+
+  end
+
+== REQUIREMENTS:
+
+* HTTParty
+
+== INSTALL:
+
+* TODO (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Wes Maldonado 
+
+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/Rakefile

@@ -0,0 +1,13 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "hoptoad-notifier-client"
+    s.summary = "Simple class that sends data to Hoptoad using HTTParty"
+    s.homepage = "http://github.com/maser/hoptoad-notifier-client/tree/master"
+    s.authors = ["Wes Maldonado (code)", "Martin Luder (rubygem)"]
+    s.files =  FileList["[A-Z]*", "lib/**/*"]
+    s.add_dependency 'httparty'
+  end
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 1
+:minor: 0
+:patch: 0

data/lib/hoptoad_notifier_client.rb

@@ -0,0 +1,64 @@
+class HoptoadNotifierClient
+
+  require 'rubygems'
+  require 'httparty'  
+  include HTTParty
+
+  base_uri "http://hoptoadapp.com"
+  format :xml
+  @instances = {}
+
+  class << self
+    attr_accessor :instances
+    def configure
+      yield self
+    end
+  end
+
+  def self.register(name, key)
+    @instances[name] = HoptoadNotifierClient.new(key)
+  end
+
+  def self.create(name)
+    @instances[name]
+  end
+
+  # proxy existing class level calls to original api key
+  def self.notify(error, request = {}, session = {})
+    raise "No :default project registered, register one to use this call." unless @instances.has_key?(:default)
+    @instances[:default].notify(error, request, session)
+  end
+  
+  def initialize(key)
+    raise "API Key required." unless key
+    @api_key = key
+  end
+
+  def notify(error, request = {}, session = {})
+    
+    error_type = error.respond_to?(:error_type) ? error.error_type : error.class.name
+    error_message = error.respond_to?(:custom_message) ? error.custom_message : "#{error.class.name}: #{error.message}"
+    
+    data = {'notice' => {
+            'api_key' => @api_key,
+            'request' => request,
+            'error_class' => error_type,
+            'error_message' => error_message,
+            'backtrace' => error.backtrace ||= [],
+            'environment' => ENV.to_hash,
+            'session' => session
+          }}
+    begin
+      response = self.class.post "/notices/", 
+                      :body => data.to_yaml,
+                      :headers => { 
+                                    "Content-type" => "application/x-yaml", 
+                                    "Accept" => "text/xml, application/xml"
+                                  }
+      
+    rescue Exception => e
+      puts "Something went wrong, is your API key correct? Exception was #{e}"
+      # logger.error "HoptoadNotificationClient FAILED during notification: Exception was [#{e.to_s}]" if logger
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: maser-hoptoad-notifier-client
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Wes Maldonado (code)
+- Martin Luder (rubygem)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-25 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- VERSION.yml
+- lib/hoptoad_notifier_client.rb
+has_rdoc: true
+homepage: http://github.com/maser/hoptoad-notifier-client/tree/master
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Simple class that sends data to Hoptoad using HTTParty
+test_files: []
+