bugsnag-error-users 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 52d35afe044f5b6eca4a568544c39a03e54cee75
+  data.tar.gz: d6d2ca20fac97e5263e7ec3b99ce752601d649a2
+SHA512:
+  metadata.gz: 8dfb7fc4a3772cbbb1cd0e776155be6bc3c81d179e396ddeba44093053b35eba7f9c4d5e2c9698d4d5b3f813ae7203d4c032882432fe334053535bcba42591b6
+  data.tar.gz: 609e3fcddb54771279eeabb0994e9934eed3bc8bd110f930baf68886f931f830096211e197757201605501bd8988a0fefe51c954bafce1e09b3c062129588fdb

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.6
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bugsnag-error-users.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Christopher Butcher
+
+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.md

@@ -0,0 +1,47 @@
+# Bugsnag Error Users (a Rake task)
+[![Build Status](https://api.travis-ci.org/repositories/chrisbutcher/bugsnag-error-users.svg)](https://travis-ci.org/chrisbutcher/bugsnag-error-users)
+
+Fetch usernames from Bugsnag error URLs. Something I'd like to see Bugsnag support via their API. Consider this gem a temporary solution.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bugsnag-error-users'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bugsnag-error-users
+
+## Usage
+
+Once installed, set your Bugsnag API auth token, via an initializer:
+```ruby
+# config/initializers/bugsnag-api.rb
+Bugsnag::Api.configure do |config|
+  config.auth_token = "API_TOKEN"
+end
+```
+
+Then, you can run the rake task, passing in a Bugsnag error URL as a parameter:
+```bash
+$ rake bugsnag:error_users[https://bugsnag.com/<organization>/<project>/errors/<error_id>]
+```
+
+A unique list of user names and ids of affected users will be printed to your terminal.
+Note: query params will be ignored, so you can just paste the error URL directly from your browser.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/chrisbutcher/bugsnag-error-users. Contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bugsnag-error-users.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bugsnag-error-users/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bugsnag-error-users"
+  spec.version       = BugsnagErrorUsers::VERSION
+  spec.authors       = ["Christopher Butcher"]
+  spec.email         = ["christopher.butcher@shopify.com"]
+
+  spec.summary       = %q{Fetch usernames from Bugsnag error urls.}
+  spec.description   = %q{Fetch usernames from Bugsnag error urls.}
+  spec.homepage      = "https://github.com/chrisbutcher/bugsnag-error-users"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "mocha"
+  spec.add_runtime_dependency "bugsnag-api"
+end

data/lib/bugsnag-error-users/fetcher.rb

@@ -0,0 +1,62 @@
+require 'bugsnag/api'
+
+module BugsnagErrorUsers
+  class StdoutPrinter
+    def self.write(str)
+      print(str)
+    end
+  end
+
+  class Fetcher
+    attr_reader :error_url
+
+    def initialize(error_url)
+      @error_url = error_url
+    end
+
+    def fetch
+      error_id = error_id_from_url(error_url)
+
+      if error_id.nil?
+        StdoutPrinter.write "Invalid Bugsnag error URL. Example: https://bugsnag.com/<organization>/<project_name>/errors/<error_id>"
+        return []
+      end
+
+      StdoutPrinter.write "Fetching user names from error id: #{error_id}. (Each '.' is an event page fetched): "
+      events = fetch_events(error_id)
+      print "\n"
+      extract_usernames(events)
+    end
+
+    private
+
+    def error_id_from_url(raw_url)
+      parsed_url = URI.parse(raw_url)
+      match = /errors\/([a-f0-9]+)/.match(parsed_url.path)
+      match[1] if match && match[1]
+    end
+
+    def fetch_events(error_id)
+      events, results_size = fetch_events_page(error_id, per_page: 100)
+      return events if results_size < 100
+
+      until results_size < 100
+        events_new, results_size = fetch_events_page(error_id, per_page: 100, offset: events.last[:id])
+        events.concat(events_new)
+      end
+
+      events
+    end
+
+    def fetch_events_page(error_id, options={})
+      events = Bugsnag::Api.error_events(error_id, options); StdoutPrinter.write '.'
+      [events, events.size]
+    end
+
+    def extract_usernames(events)
+      events.map do |event|
+        "#{event[:meta_data][:User][:name]}, ##{event[:meta_data][:User][:id]}"
+      end.compact.uniq.sort
+    end
+  end
+end

data/lib/bugsnag-error-users/railtie.rb

@@ -0,0 +1,9 @@
+require "rails"
+
+class BugsnagErrorUsers::Railtie < Rails::Railtie
+  railtie_name :bugsnag_error_users
+
+  rake_tasks do
+    load "tasks/bugsnag-error-users.rake"
+  end
+end

data/lib/bugsnag-error-users/version.rb

@@ -0,0 +1,3 @@
+module BugsnagErrorUsers
+  VERSION = "0.1.0"
+end

data/lib/bugsnag-error-users.rb

@@ -0,0 +1,3 @@
+require "bugsnag-error-users/version"
+require 'bugsnag-error-users/fetcher'
+require 'bugsnag-error-users/railtie' if defined?(Rails)

data/lib/tasks/bugsnag-error-users.rake

@@ -0,0 +1,24 @@
+namespace :bugsnag do
+  desc "Extract exception event user names from bugsnag error url"
+  task :error_users, [:error_url] => :environment do |t, args|
+    abort unless bugsnag_token_present?
+
+    fetcher = BugsnagErrorUsers::Fetcher.new(args.error_url)
+    user_names = fetcher.fetch
+
+    user_names.each do |user_name|
+      puts user_name
+    end
+  end
+
+  private
+
+  def bugsnag_token_present?
+    if Bugsnag::Api.configuration.auth_token.present?
+      true
+    else
+      puts "Aborting! Bugsnag::Api.configuration.auth_token must be set. See the bugsnag-error-users README."
+      false
+    end
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: bugsnag-error-users
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christopher Butcher
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bugsnag-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fetch usernames from Bugsnag error urls.
+email:
+- christopher.butcher@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bugsnag-error-users.gemspec
+- lib/bugsnag-error-users.rb
+- lib/bugsnag-error-users/fetcher.rb
+- lib/bugsnag-error-users/railtie.rb
+- lib/bugsnag-error-users/version.rb
+- lib/tasks/bugsnag-error-users.rake
+homepage: https://github.com/chrisbutcher/bugsnag-error-users
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Fetch usernames from Bugsnag error urls.
+test_files: []