airbrake 3.1.5 → 3.1.6

data/CHANGELOG

@@ -1,3 +1,21 @@
+Version 3.1.6 - 2012-10-23 21:15:50 +0200
+===============================================================================
+
+Hrvoje Šimić (9):
+      load api key from file and env if not provided for executable
+      get a list of your projects from command line
+      create projects from command line
+      fix cli client host
+      creating deploys from command line
+      don't override extension methods
+      update heroku plan in readme
+      another fix for heroku readme
+      don't pollute global namespace with blank?
+
+Sam Umbach (1):
+      Send deploy notification on deploy:cold
+
+
 Version 3.1.5 - 2012-10-05 17:32:23 +0200
 ===============================================================================
 
@@ -923,3 +941,4 @@ Nick Quaranto (3):
 
 
 
+

data/README_FOR_HEROKU_ADDON.md

@@ -7,8 +7,8 @@ Send your application errors to our hosted service and reclaim your inbox.
 ----------------------------
 To use Airbrake on Heroku, install the Airbrake add-on:
 
-    $ heroku addons:add airbrake:basic # This adds the the basic plan.
-                                       # If you'd like another plan, specify that instead.
+    $ heroku addons:add airbrake:developer # If you'd like another plan, specify that instead.
+                                           # Check https://addons.heroku.com/airbrake for a full list of plans.
 
 2. Including the Airbrake notifier in your application
 --------------------------------------------------

data/bin/airbrake

@@ -1,46 +1,12 @@
 #!/usr/bin/env ruby
-require "airbrake"
 
-def parse_options(array = [])
-  opts = Hash[*array]
-  opts[:error]   = opts.delete("-e")  || opts.delete("--error")   { RuntimeError }
-  opts[:message] = opts.delete("-m")  || opts.delete("--message") { "I've made a huge mistake" }
-  opts[:api_key] = opts.delete("-k")  || opts.delete("--api-key")
-  opts[:host]    = opts.delete("-h")  || opts.delete("--host")
-  opts[:port]    = opts.delete("-p")  || opts.delete("--port")
-  opts
-end
+require "airbrake"
+require "airbrake/cli/runner"
+require "net/http"
+require "uri"
 
 args = ARGV.dup
 command = args.shift.strip rescue nil
+options = ARGV[1..-1]
 
-case command
-  when 'raise'
-    options = parse_options(ARGV[1..-1])
-    abort "You didn't provide API_KEY so nothing was raised."\
-          " Refer to usage for more info (airbrake --help)." unless options[:api_key]
-    Airbrake.configure do |c|
-      c.api_key = options[:api_key]
-      c.host    = options[:host] if options[:host]
-      c.port    = options[:port] if options[:port]
-    end
-    exception_id = Airbrake.notify(:error_class   => options[:error],
-                                   :error_message => "#{options[:error]}: #{options[:message]}",
-                                   :cgi_data      => ENV)
-    abort "Error sending exception to Airbrake server. Try again later." unless exception_id
-    puts "Exception sent successfully: http://airbrake.io/locate/#{exception_id}"
-  else
-    puts <<USAGE
-Usage: airbrake [COMMAND] [OPTION]...
-Commands:
-  raise                    # Raise an exception specified by ERROR and MESSAGE.
-
-Options:
-  -e, [--error=ERROR]      # Error class to raise. Default:  RuntimeError
-  -m, [--message=MESSAGE]  # Error message. Default: "I've made a huge mistake"
-  -k, [--api-key=API_KEY]  # Api key of your Airbrake application.
-  -h, [--host=HOST]        # URL of the Airbrake API server. Default: api.airbrake.io
-  -p, [--port=PORT]        # Port of the Airbrake API server. Default: 80
-  -h, [--help]             # Show this usage
-USAGE
-  end
+Runner.run!(command, options)

data/lib/airbrake.rb

@@ -2,7 +2,7 @@ require "girl_friday"
 require 'net/http'
 require 'net/https'
 require 'rubygems'
-require 'airbrake/utils/blank'
+require 'airbrake/extensions/blank'
 require 'airbrake/version'
 require 'airbrake/configuration'
 require 'airbrake/notice'

data/lib/airbrake/capistrano.rb

@@ -7,6 +7,7 @@ module Airbrake
       configuration.load do
         after "deploy",            "airbrake:deploy"
         after "deploy:migrations", "airbrake:deploy"
+        after "deploy:cold",       "airbrake:deploy"
 
         namespace :airbrake do
           desc <<-DESC

data/lib/airbrake/cli/client.rb

@@ -0,0 +1,68 @@
+require File.expand_path( "../runner", __FILE__)
+
+module Client
+  extend self
+
+  def options
+    Runner.options
+  end
+
+  def fetch_projects
+    uri = URI.parse "http://#{options.account}.airbrake.io"\
+    "/data_api/v1/projects.xml?auth_token=#{options.auth_token}"
+    http = Net::HTTP.new(uri.host,uri.port)
+    request = Net::HTTP::Get.new(uri.request_uri)
+    response = http.request(request)
+    response.body
+  end
+
+  def create_project
+    uri = URI.parse "http://#{options.account}.airbrake.io"\
+    "/data_api/v1/projects.xml"
+    http = Net::HTTP.new(uri.host,uri.port)
+    request = Net::HTTP::Post.new(uri.request_uri)
+    request.set_form_data('project[name]' => options.name,'auth_token' => options.auth_token)
+    response = http.request(request)
+    response.body
+
+    print_project_response(response.body)
+  end
+
+  def create_deploy
+    uri = URI.parse "http://airbrake.io"\
+    "/projects/1/deploys.xml"
+    http = Net::HTTP.new(uri.host,uri.port)
+    request = Net::HTTP::Post.new(uri.request_uri)
+    request.set_form_data('deploy[rails_env]' => options.rails_env,"api_key" => options.api_key)
+    response = http.request(request)
+    puts response.body
+  end
+
+  def print_projects
+    factory = ProjectFactory.new
+    projects = fetch_projects
+    factory.create_projects_from_xml(projects)
+    abort "No projects were fetched. Did you provide the correct auth token?" if projects.match(/error/m)
+    puts "\nProjects\n" + "".rjust(63,"#")
+    factory.projects.each do |project|
+      puts project
+    end
+    puts
+  end
+
+  def print_project_response(response)
+    case response
+    when /errors/
+      puts "Error creating project: #{response.gsub("\n","").scan(/.*<error[^>]*>(.*?)<\/error>.*/).last.first.gsub(/\s{1,}/," ")}"
+    when /project/
+      project = Project.new(:id => response[/<id[^>]*>(.*?)<\/id>/,1],
+                            :name => response[/<name[^>]*>(.*?)<\/name>/,1],
+                            :api_key => response[/<api-key[^>]*>(.*?)<\/api-key>/,1])
+      puts "\nProject details\n" + "".rjust(63,"#")
+      puts project
+    else
+      puts "Unexpected error. Please try again!\n"
+      puts response
+    end
+  end
+end

data/lib/airbrake/cli/options.rb

@@ -0,0 +1,41 @@
+class Options
+
+  ATTRIBUTES = [:error, :message, :api_key, :host, :port, :auth_token, :name, :account, :rails_env]
+
+  ATTRIBUTES.each do |attribute|
+    attr_reader attribute
+  end
+
+  private
+
+  # You should not write to this from outside
+  ATTRIBUTES.each do |attribute|
+    attr_writer attribute
+  end
+
+  public
+
+  # Parses all the options passed and stores them in attributes
+  def initialize(array = [])
+    opts = Hash[*array]
+    self.error         = opts.delete("-e")  || opts.delete("--error")   { RuntimeError }
+    self.message       = opts.delete("-m")  || opts.delete("--message") { "I've made a huge mistake" }
+    self.api_key       = opts.delete("-k")  || opts.delete("--api-key")    || config_from_file.api_key || ENV["AIRBRAKE_API_KEY"]
+    self.host          = opts.delete("-h")  || opts.delete("--host")       || config_from_file.host
+    self.port          = opts.delete("-p")  || opts.delete("--port")       || config_from_file.port
+    self.auth_token    = opts.delete("-t")  || opts.delete("--auth-token") || ENV["AIRBRAKE_AUTH_TOKEN"]
+    self.name          = opts.delete("-n")  || opts.delete("--name")
+    self.account       = opts.delete("-a")  || opts.delete("--account")    || ENV["AIRBRAKE_ACCOUNT"]
+    self.rails_env     = opts.delete("-E")  || opts.delete("--rails-env")  || ENV["RAILS_ENV"] || "production"
+    opts
+  end
+
+  # Fallback to read from the initializer
+  def config_from_file
+    begin
+      load "config/initializers/airbrake.rb"
+    rescue LoadError
+    end
+    Airbrake.configuration
+  end
+end

data/lib/airbrake/cli/printer.rb

@@ -0,0 +1,30 @@
+module Printer
+  def self.print(collection)
+    collection.each do |element|
+      puts element
+    end
+  end
+
+  def self.print_usage
+    puts <<-USAGE
+Usage: airbrake [COMMAND] [OPTION]...
+Commands:
+  raise                          # Raise an exception specified by ERROR and MESSAGE.
+  list                           # List all the projects for given AUTH_TOKEN and ACCOUNT.
+  create                         # Create a project with the given NAME.
+  deploy                         # Send a new deployment notification to a project that matches the API_KEY.
+
+Options:
+  -e, [--error=ERROR]            # Error class to raise. Default:  RuntimeError
+  -m, [--message=MESSAGE]        # Error message. Default: "I've made a huge mistake"
+  -k, [--api-key=API_KEY]        # Api key of your Airbrake application.
+  -h, [--host=HOST]              # URL of the Airbrake API server. Default: api.airbrake.io
+  -p, [--port=PORT]              # Port of the Airbrake API server. Default: 80
+  -t, [--auth-token=AUTH_TOKEN]  # The auth token used for API requests.
+  -a, [--account=ACCOUNT]        # The account used for API requests.
+  -n, [--name=NAME]              # The name of the project you're trying to create.
+  -E, [--rails-env=NAME]         # The name of the environment you're deploying to. Default: production
+  -h, [--help]                   # Show this usage
+   USAGE
+  end
+end

data/lib/airbrake/cli/project.rb

@@ -0,0 +1,17 @@
+class Project
+  attr_writer :name, :id, :api_key
+
+  def initialize(attributes = {})
+    attributes.keys.each do |key|
+      instance_variable_set("@#{key}",attributes[key])
+    end
+  end
+
+  def to_s
+    "#{@name}".rjust(20) + "(#{@id}):".rjust(10) + " #{@api_key}"
+  end
+
+  def valid?
+    @name && @id && @api_key
+  end
+end

data/lib/airbrake/cli/project_factory.rb

@@ -0,0 +1,36 @@
+require File.expand_path( "../project", __FILE__)
+# Responsible for creating projects when needed.
+# Creates them from XML received.
+class ProjectFactory
+  def initialize
+    @project = Project.new
+    @projects = []
+  end
+
+  def project
+    @project
+  end
+
+  def create_projects_from_xml(xml)
+    xml.split("\n").each do |line|
+      /<name[^>]*>(?<name>.*?)<\/name>/ =~ line
+      project.name    = name.capitalize if name
+      /<id[^>]*>(?<id>.*?)<\/id>/ =~ line
+      project.id      = id              if id
+      /<api-key[^>]*>(?<api_key>.*?)<\/api-key>/ =~ line
+      project.api_key = api_key         if api_key
+      check_project
+    end
+  end
+
+  def check_project
+    if @project.valid?
+      projects << @project
+      @project = Project.new
+    end
+  end
+
+  def projects
+    @projects
+  end
+end

data/lib/airbrake/cli/runner.rb

@@ -0,0 +1,48 @@
+require File.expand_path( "../project_factory", __FILE__)
+require File.expand_path( "../options", __FILE__)
+require File.expand_path( "../validator", __FILE__)
+require File.expand_path( "../printer", __FILE__)
+require File.expand_path( "../client", __FILE__)
+
+module Runner
+  extend Validator
+
+  extend self
+
+  attr_accessor :options
+
+  def run!(command, cli_options = {})
+
+    self.options = Options.new(cli_options)
+
+    case command
+    when 'raise'
+      validates :api_key
+      Airbrake.configure do |c|
+        c.api_key = options.api_key
+        c.host    = options.host if options.host
+        c.port    = options.port if options.port
+      end
+      exception_id = Airbrake.notify(:error_class   => options.error,
+                                     :error_message => "#{options.error}: #{options.message}",
+                                     :cgi_data      => ENV)
+      abort "Error sending exception to Airbrake server. Try again later." unless exception_id
+      puts "Exception sent successfully: http://airbrake.io/locate/#{exception_id}"
+
+    when "list"
+      validates :auth_token, :account
+      Client.print_projects
+
+    when "create"
+      validates :auth_token, :account
+      Client.create_project
+
+    when "deploy"
+      validates :api_key
+      Client.create_deploy
+
+    else
+      Printer.print_usage
+    end
+  end
+end

data/lib/airbrake/cli/validator.rb

@@ -0,0 +1,8 @@
+module Validator
+  def validates(*attributes)
+    attributes.each do |attribute|
+      abort "You didn't provide #{attribute.to_s.upcase}"\
+        " so no API request was made." unless Runner.options.send(attribute)
+    end
+  end
+end

data/lib/airbrake/extensions/blank.rb

@@ -0,0 +1,73 @@
+# stolen from ActiveSupport
+
+class Object
+  unless method_defined?(:blank?)
+    def blank?
+      respond_to?(:empty?) ? empty? : !self
+    end
+  end
+
+  unless method_defined?(:present?)
+    def present?
+      !blank?
+    end
+  end
+
+  unless method_defined?(:presence)
+    def presence
+      self if present?
+    end
+  end
+end
+
+class NilClass
+  unless method_defined?(:blank?)
+    def blank?
+      true
+    end
+  end
+end
+
+class FalseClass
+  unless method_defined?(:blank?)
+    def blank?
+      true
+    end
+  end
+end
+
+class TrueClass
+  unless method_defined?(:blank?)
+    def blank?
+      false
+    end
+  end
+end
+
+class Array
+  unless method_defined?(:blank?)
+    alias_method :blank?, :empty?
+  end
+end
+
+class Hash
+  unless method_defined?(:blank?)
+    alias_method :blank?, :empty?
+  end
+end
+
+class String
+  unless method_defined?(:blank?)
+    def blank?
+      self !~ /[^[:space:]]/
+    end
+  end
+end
+
+class Numeric
+  unless method_defined?(:blank?)
+    def blank?
+      false
+    end
+  end
+end

data/lib/airbrake/version.rb

@@ -1,3 +1,3 @@
 module Airbrake
-  VERSION = "3.1.5".freeze
+  VERSION = "3.1.6".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: airbrake
 version: !ruby/object:Gem::Version
-  version: 3.1.5
+  version: 3.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-05 00:00:00.000000000 Z
+date: 2012-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -306,6 +306,13 @@ files:
 - lib/airbrake/rails/middleware/exceptions_catcher.rb
 - lib/airbrake/rails.rb
 - lib/airbrake/rack.rb
+- lib/airbrake/cli/printer.rb
+- lib/airbrake/cli/project_factory.rb
+- lib/airbrake/cli/project.rb
+- lib/airbrake/cli/client.rb
+- lib/airbrake/cli/options.rb
+- lib/airbrake/cli/validator.rb
+- lib/airbrake/cli/runner.rb
 - lib/airbrake/tasks.rb
 - lib/airbrake/rails3_tasks.rb
 - lib/airbrake/configuration.rb
@@ -313,8 +320,8 @@ files:
 - lib/airbrake/rake_handler.rb
 - lib/airbrake/version.rb
 - lib/airbrake/backtrace.rb
-- lib/airbrake/utils/blank.rb
 - lib/airbrake/notice.rb
+- lib/airbrake/extensions/blank.rb
 - lib/airbrake/user_informer.rb
 - lib/airbrake.rb
 - lib/rails/generators/airbrake/airbrake_generator.rb

data/lib/airbrake/utils/blank.rb

@@ -1,53 +0,0 @@
-# stolen from ActiveSupport
-
-class Object
-  def blank?
-    respond_to?(:empty?) ? empty? : !self
-  end
-
-  def present?
-    !blank?
-  end
-
-  def presence
-    self if present?
-  end
-end
-
-class NilClass
-  def blank?
-    true
-  end
-end
-
-class FalseClass
-  def blank?
-    true
-  end
-end
-
-class TrueClass
-  def blank?
-    false
-  end
-end
-
-class Array
-  alias_method :blank?, :empty?
-end
-
-class Hash
-  alias_method :blank?, :empty?
-end
-
-class String
-  def blank?
-    self !~ /[^[:space:]]/
-  end
-end
-
-class Numeric
-  def blank?
-    false
-  end
-end