airbrake_symbolicate 0.1

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Brett Gibson
+
+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,23 @@
+= airbrake_symbolicate
+
+lib and cli tool to download airbrake iOS crash reports via the api and symbolicate them
+
+The idea is:
+* Find all the XCode Archive files via spotlight
+* Pull the GCGitCommitHash (or failing that CFBundleVersion) out of the Info.plist for each binary and map that to a dSYM file
+* Given an ActiveResource Error object from the Airbrake API match it up to a dSYM file and try to symbolicate the stack trace
+
+
+So far, I've only tried it out so far on ruby 1.9.2
+
+== Basic Usage
+
+Install the gem:
+  gem install airbrake_symbolicate
+  
+Run the cli:
+  airbrake_symbolicate airbrake_account_name airbrake_api_auth_token
+Where the account name is your subdomain on airbrake (as in http://airbrake_account_name.airbrakeapp.com) and the API key is the one available on the Airbrake account admin's user page (NOT the reporting API key for the project).
+This should spit out all the errors available via the API and the symbolicated backtrace if an appropriate dSYM is found. There's not much error handling.
+  
+See bin/airbrake_symbolicate for general usage from ruby.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/airbrake_symbolicate

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+
+require 'colored'
+
+if File.exists?(File.join(File.expand_path('../..', __FILE__), '.git'))
+  $:.unshift(File.expand_path('../../lib', __FILE__))
+end
+require "airbrake_symbolicate"
+
+include AirbrakeSymbolicate
+
+Airbrake.account = ENV['AIRBRAKE_ACCOUNT'] || ARGV[0]
+Airbrake.auth_token = ENV['AIRBRAKE_AUTH_TOKEN'] || ARGV[1]
+
+unless Airbrake.site && Airbrake.auth_token
+  puts "\tUsage: airbrake_symbolicate airbrake_account airbrake_auth_token"
+  puts "\tOr set AIRBRAKE_ACCOUNT and AIRBRAKE_AUTH_TOKEN environment variables."
+  puts
+  puts "\tAirbrake account and auth token must be specfied!"
+  puts "\texiting..."
+  exit
+end
+
+DIVIDER = "*" * 40
+META_FORMAT = "%20s: %s"
+
+page = 1
+begin
+  errors = Error.find(:all, :params => {:page => page})
+  errors.each do |e|
+    e.reload
+    
+    puts DIVIDER
+    puts META_FORMAT % ['message', e.error_message]
+    puts META_FORMAT % ['notices count', e.notices_count]
+    puts META_FORMAT % ['operating system', e.environment.operating_system]
+    puts META_FORMAT % ['app version', e.environment.app_version]
+    puts META_FORMAT % ['url', Error.site + Error.element_path(e.id).sub(/\.xml$/, '')]
+    
+    if bt = Symbolicator.symbolicated_backtrace(e)
+      puts "Backtrace:"
+      bt.each do |l|
+        if STDOUT.tty?
+          # symbolicated lines start with [
+          puts l.send(l[/^\[/] ? :red : :green)
+        else
+          puts l
+        end
+      end
+    else
+      puts "\tNo dSYM found"
+    end
+  end
+  page += 1
+end until errors.empty?

data/lib/airbrake_symbolicate.rb

@@ -0,0 +1,92 @@
+require 'active_resource'
+module AirbrakeSymbolicate
+  class DsymFinder
+    @@dsyms = nil
+    
+    class << self
+      def dsym_for_error(error)
+        find_dsyms  unless @@dsyms
+        
+        @@dsyms[error.environment.git_commit] || @@dsyms[error.environment.app_version]
+      end
+      
+      private 
+      
+      # use spotlight to find all the xcode archives
+      # then use the Info.plist inside those archives to try and look up a git commit hash
+      def find_dsyms
+        @@dsyms = {}
+        
+        files = `mdfind 'kMDItemKind = "Xcode Archive"'`.split("\n")
+        files.each do |f|
+          # puts `ls '#{f.chomp}'`
+          info = `find '#{f}/Products' -name Info.plist`.chomp
+          
+          if commit = plist_val(info, 'GCGitCommitHash')
+            if bin_file = Dir[File.join(f, '/dSYMs/*.dSYM/**/DWARF/*')].first
+              @@dsyms[commit] = bin_file
+            end
+          else
+            short_version = plist_val(info, 'CFBundleShortVersionString')
+            long_version = plist_val(info, 'CFBundleVersion')
+            # this is the format in HTApplicationVersion() in hoptoad-ios 
+            @@dsyms["#{CFBundleShortVersionString} (#{CFBundleVersion})"] = bin_file
+          end
+        end
+      end
+      
+      def plist_val(plist, key)
+        `/usr/libexec/PlistBuddy -c 'Print :#{key}' '#{plist}' 2>/dev/null`.chomp
+      end
+    end
+  end
+  
+  class Symbolicator
+    class << self
+      def symbolicated_backtrace(error)
+        if dsym = DsymFinder.dsym_for_error(error)
+          error.backtrace.line.map {|l| Symbolicator.symbolicate_line(dsym, l)}
+        end
+      end
+      
+      def symbolicate_line(dsym_file, line)
+        binname = File.basename(dsym_file)
+        if line[/#{binname}/] && loc = line[/0x\w+/]
+          `/usr/bin/atos -arch armv7 -o "#{dsym_file}" #{loc}`.sub(/^[-_]+/, '')
+        else
+          line
+        end.chomp
+      end
+    end
+  end
+  
+  class Airbrake < ActiveResource::Base
+    cattr_accessor :auth_token
+
+    class << self
+      def account=(a)
+        self.site = "http://#{a}.airbrakeapp.com/" if a
+      end
+      
+      def find(*arguments)
+        arguments = append_auth_token_to_params(*arguments)
+        super(*arguments)
+      end
+
+      def append_auth_token_to_params(*arguments)
+        raise RuntimeError.new("Airbrake.auth_token must be set!") if !auth_token
+        
+        opts = arguments.last.is_a?(Hash) ? arguments.pop : {}
+        opts = opts.has_key?(:params) ? opts : opts.merge(:params => {})
+        opts[:params] = opts[:params].merge(:auth_token => auth_token)
+        arguments << opts
+        arguments
+      end
+    end
+    
+  end
+  
+  class Error < Airbrake  
+  end
+  
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: airbrake_symbolicate
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Brett Gibson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-03 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: colored
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        version: "1.2"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: lib and cli tool to download airbrake iOS crash reports via the api and symbolicate them
+email: 
+- brettdgibson@gmail.com
+executables: 
+- airbrake_symbolicate
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/airbrake_symbolicate
+- lib/airbrake_symbolicate.rb
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+has_rdoc: true
+homepage: ""
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: symbolicate airbrake iOS crash reports
+test_files: []
+