crep 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6ec9983a55f99437b47855a38a35de0748a1fb8023dca8ef5f3f973b9be87919
+  data.tar.gz: e3830e5d8609c2aa9d1808d4d82218d7a44172b207f3fde619462c1cd38adddd
+SHA512:
+  metadata.gz: b3b1687053ac8aae4f85872331f9e16e632769765d6ca598556dd2adc76d048e68cafbe4fa0c2c0a205f0307d702c9196e73221ce9b5e3e214df24af39f3e7b0
+  data.tar.gz: 1d0ea2b9eee605d398f8e600a2bbd31698f8e44ade452862cdccfb856f96013ef8dde8454de33ee23d8d330fdb710ca0ecd79945bec282bcbdbb9fa7b7a1995c

data/.gitignore

@@ -0,0 +1,60 @@
+*.gem
+*.rbc
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/.config
+/_yardoc/
+/coverage/
+/InstalledFiles
+/doc/
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+# rspec failure tracking
+.rspec_status
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,17 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-12-09 23:28:51 +0100 using RuboCop version 0.51.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+

data/Changelog.md

@@ -0,0 +1,21 @@
+# Next up
+
+## Added
+
+-
+
+## Removed
+
+-
+
+## Fixed
+
+-
+
+## Miscellaneous
+
+-
+
+# 0.1.0
+
+- Initial release.

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Crep's dependencies in crep.gemspec
+gemspec
+
+# contains Support for Statistics
+gem 'hockeyapp', git: 'https://github.com/q231950/hockeyapp.git'

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2017 XING SE
+
+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,37 @@
+# Crep
+
+*Crep - a Crash Reporter for creating appealing Crash Newsletters*
+
+We use Crep at [XING](https://www.xing.com) to create our Crash Newsletters for [iOS](https://www.xing.com/ios) and [Android](https://www.xing.com/android) within the _Mobile Releases Team_. It currently uses [HockeyApp](https://rink.hockeyapp.net) as a crash source, so if you are using Hockey, you should definitely give Crep a try.
+
+In case you are creating Crash Newsletters and have a different crash source in mind - check out the contributing section!
+
+## Install
+
+Please follow our guide in the [Installation Instructions](https://github.com/xing/crep/wiki/Install).
+
+## Usage
+
+Provide a `CREP_HOCKEY_API_TOKEN`: 
+
+`export CREP_HOCKEY_API_TOKEN='abcde'`
+
+Run Crep:
+
+`bundle exec crep crashes --identifier='com.example.company' --version='1.23.0' --build='42' --only-unresolved`
+
+The `--only-unresolved` flag filters out any crashes marked as resolved.
+
+## Test
+
+Run `bundle exec rspec` in order to run the tests.
+
+## Contributing
+
+🎁 Bug reports and pull requests for new features are most welcome!
+
+👷🏼 In case you want to use a different crash source - feel free to add on, we are looking forward to your pull request, we'd love to help!
+
+## 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,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/Vision.md

@@ -0,0 +1,15 @@
+# Goals
+
+- Add newsletter templating to easily create a readable and actionable format for sharing crashes.
+- Add multiple crash sources, making it easier for anyone to plug and play.
+- Enable newsletters or results to be easily published on sites like GitHub.
+- Cultivate an inclusive open source community through respectful discussion.
+
+# Scope
+
+- We are focusing on crashes for a specific app version.
+- Having a crash newsletter in mind, we do not expect adding crash visualisations.
+
+## Inspiration
+
+This project is inspired by our effort to share crash insights and cultivate teams to feel repsonsibility to fix them at [XING](https://www.xing.com) and aims to raise awareness and fix crashes across all teams.

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'crep'
+
+# 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(__FILE__)

data/bin/crep

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.push File.expand_path('../lib', File.dirname(__FILE__))
+
+require 'crep'
+
+Crep.run

data/bin/setup

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

data/crep.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'crep/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'crep'
+  spec.version       = Crep::VERSION
+  spec.authors       = ['Kim Dung-Pham', 'Bas Broek', 'Serghei Moret']
+  spec.email         = ['kim.dung-pham@xing.com', 'bas.broek@xing.com', 'serghei.moret@xing.com']
+
+  spec.summary       = 'Create Crash Newsletter with ease.'
+  spec.description   = 'Create Crash Newsletter with ease. Really.'
+  spec.homepage      = 'https://github.com/xing/crep'
+  spec.license       = 'MIT'
+
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = 'bin'
+  # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables << 'crep'
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'hockeyapp'
+  spec.add_dependency 'colorize'
+
+  spec.add_runtime_dependency 'claide', '~> 1.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop', '0.51.0'
+end

data/lib/crep.rb

@@ -0,0 +1,13 @@
+require 'crep/version'
+require 'crep/command'
+require 'claide'
+require 'logger'
+
+module Crep
+  XINGLogger = Logger.new(STDOUT)
+  XINGLogger.level = Logger::DEBUG
+
+  def self.run
+    Command.run(ARGV)
+  end
+end

data/lib/crep/command.rb

@@ -0,0 +1,15 @@
+require 'claide'
+require 'crep/version'
+
+module Crep
+  class Command < CLAide::Command
+    require 'crep/command/crashes'
+
+    self.abstract_command = true
+    self.command = 'crep'
+    self.version = Crep::VERSION
+    self.description = <<-DESC
+      Crep is a crash reporter
+    DESC
+  end
+end

data/lib/crep/command/crashes.rb

@@ -0,0 +1,43 @@
+require 'crep/command'
+require 'crep/crash_controller'
+require 'crep/model/crash_sources/hockeyapp_crash_source'
+require 'hockeyapp'
+
+module Crep
+  class Crashes < Command
+    DEFAULT_TOP_COUNT = 5
+
+    def self.options
+      [
+        ['--top=5', "If set, Crep will show the top x crashes. #{DEFAULT_TOP_COUNT} by default."],
+        ['--identifier=<com.company.app>', 'Crep will show crashes for the app with this bundle identifier'],
+        ['--version=<7.10.0>', 'The version of the App.'],
+        ['--build=<24>', 'The Build number of the App.'],
+        ['--only-unresolved', 'If set, resolved crashes will be filtered out.']
+      ].concat(super)
+    end
+
+    self.summary = <<-DESC
+      Shows a list of crashes
+    DESC
+
+    self.description = <<-DESC
+      Besides the optional `top` parameter, Crep requires all other parameters.
+    DESC
+
+    def initialize(argv)
+      @show_only_unresolved = argv.flag?('only-unresolved', false)
+      @top = argv.option('top') || DEFAULT_TOP_COUNT
+      @bundle_identifier = argv.option('identifier') || raise('Missing `identifier` parameter')
+      @version = argv.option('version') || raise('Missing `version` parameter')
+      @build = argv.option('build') || raise('Missing `build` parameter')
+      super
+    end
+
+    def run
+      crash_datasource = HockeyAppCrashSource.new
+      crash_controller = CrashController.new(@bundle_identifier, @top, crash_datasource, @show_only_unresolved)
+      crash_controller.top_crashes(@version, @build)
+    end
+  end
+end

data/lib/crep/crash_controller.rb

@@ -0,0 +1,64 @@
+require 'colorize'
+
+module Crep
+  class CrashController
+    def initialize(bundle_identifier, top, crash_source, show_only_unresolved)
+      @bundle_identifier = bundle_identifier
+      @top = top
+      @crash_source = crash_source
+      @show_only_unresolved = show_only_unresolved
+      @crash_source.configure(bundle_identifier)
+    end
+
+    # returns list of top crashes for the given build
+    def top_crashes(version, build)
+      crashes = @crash_source.crashes(@top, version, build, @show_only_unresolved)
+      total_crashes = @crash_source.crash_count(version: version,
+                                                build: build)
+      report(crashes: crashes,
+             total_crashes: total_crashes,
+             app_name: @crash_source.app.name,
+             identifier: @crash_source.app.bundle_identifier,
+             version: version,
+             build: build)
+    end
+
+    def report(crashes:, total_crashes:, app_name:, identifier:, version:, build:)
+      puts("Reporting for #{app_name} (#{version}/#{build}) #{identifier}")
+
+      crash_reports = crashes_report(crashes: crashes, total_crashes: total_crashes, version: version)
+      empty_message = total_crashes == 0 ? "Look mom, no crashes... yet!" : "Look mom, no unresolved crashes... yet!"
+      puts(empty_message.green) if crash_reports.empty?
+
+      crash_reports.each_with_index do |crash_report, i|
+        puts("\n------------- ##{(i + 1)} --------------")
+        crash_report.each do |line|
+          puts(line)
+        end
+      end
+    end
+
+    def crashes_report(crashes:, total_crashes:, version:)
+      crashes.map do |crash|
+        percentage = crash_percentage(crash: crash, total_crashes: total_crashes)
+        crash_report(crash: crash, percentage: percentage, version: version)
+      end
+    end
+
+    def crash_percentage(crash:, total_crashes:)
+      crash.occurrences.to_f / total_crashes.to_f * 100.0
+    end
+
+    def crash_report(crash:, percentage:, version:)
+      raise 'Crash info does not fulfill the requirements' unless crash.is_a? Crep::Crash
+      report = []
+      report.push "Class: #{crash.crash_class}"
+      report.push "First appeared on #{crash.registered_at} and occurred #{crash.occurrences} times in #{version}"
+      report.push "Percentage: #{percentage.round(2)}% of all #{version} crashes"
+      report.push "File/Line: #{crash.file_line}"
+      report.push "Reason: #{crash.reason}" # crash.reason[0..80]
+      report.push "Link: #{crash.url}"
+      report
+    end
+  end
+end

data/lib/crep/model/crash_model/app.rb

@@ -0,0 +1,11 @@
+module Crep
+  # App represents an App
+  class App
+    attr_reader :name, :bundle_identifier
+
+    def initialize(name, bundle_identifier)
+      @name = name
+      @bundle_identifier = bundle_identifier
+    end
+  end
+end

data/lib/crep/model/crash_model/crash.rb

@@ -0,0 +1,14 @@
+module Crep
+  class Crash
+    attr_reader :file_line, :occurrences, :reason, :crash_class, :registered_at, :url
+
+    def initialize(file_line:, occurrences:, reason:, crash_class:, registered_at:, url:)
+      @file_line = file_line
+      @occurrences = occurrences
+      @reason = reason
+      @crash_class = crash_class
+      @registered_at = registered_at
+      @url = url
+    end
+  end
+end

data/lib/crep/model/crash_sources/crash_source.rb

@@ -0,0 +1,19 @@
+module Crep
+  # This is an abstract class that defines the methods which subclasses must implement.
+  class CrashSource
+    attr_reader :app
+
+    # Necessary configuration of the subclass can happen here
+    def configure(_bundle_identifier)
+      raise 'CrashSource subclass has to implement the `configure` method.'
+    end
+
+    def crash_count(_version, _build)
+      raise 'CrashSource subclass has to implement the `crash_count` method.'
+    end
+
+    def crashes(_top, _version, _build, _show_only_unresolved)
+      raise 'CrashSource subclass has to implement the `crashes` method.'
+    end
+  end
+end

data/lib/crep/model/crash_sources/hockeyapp_crash_source.rb

@@ -0,0 +1,77 @@
+require 'crep/model/crash_sources/crash_source'
+require 'crep/model/crash_model/app'
+require 'crep/model/crash_model/crash'
+require 'hockeyapp'
+
+module Crep
+  # The HockeyApp Crash Source
+  class HockeyAppCrashSource < CrashSource
+    def configure(bundle_identifier)
+      HockeyApp::Config.configure do |config|
+        raise 'Missing API token (CREP_HOCKEY_API_TOKEN)' unless ENV['CREP_HOCKEY_API_TOKEN']
+        config.token = ENV['CREP_HOCKEY_API_TOKEN']
+      end
+
+      @client = HockeyApp.build_client
+      @hockeyapp_app = hockeyapp(bundle_identifier, @client)
+      @app = App.new(@hockeyapp_app.title, bundle_identifier)
+    end
+
+    def crashes(top, version, build, show_only_unresolved)
+      version = version(version: version, build: build)
+      crash_groups(version, show_only_unresolved).take(top.to_i)
+    end
+
+    def crash_count(version:, build:)
+      statistics = @client.get_statistics @hockeyapp_app
+      statistics_filtered_by_version = statistics.select do |statistic|
+        statistic.shortversion == version && statistic.version == build
+      end
+      statistics_filtered_by_version.first.crashes
+    end
+
+    def crash_groups(version, show_only_unresolved)
+      reasons = version.crash_reasons('sort' => 'number_of_crashes', 'order' => 'desc')
+      unresolved_reasons = show_only_unresolved ? unresolved_reasons(reasons) : reasons
+      unresolved_reasons.map do |reason|
+        url = url(app_id: reason.app.public_identifier, version_id: version.id, reason_id: reason.id)
+        Crash.new(file_line: "#{reason.file}:#{reason.line}",
+                  occurrences: reason.number_of_crashes,
+                  reason: reason.reason,
+                  crash_class: reason.crash_class,
+                  registered_at: Date.parse(reason.created_at),
+                  url: url)
+      end
+    end
+
+    def url(app_id:, version_id:, reason_id:)
+      "https://rink.hockeyapp.net/manage/apps/#{app_id}/app_versions/#{version_id}/crash_reasons/#{reason_id}"
+    end
+
+    def version(version:, build:)
+      filtered_versions = filtered_versions_by_version_and_build(@hockeyapp_app.versions, version, build)
+
+      raise "No version was found for #{version})#{build})" unless filtered_versions.count > 0
+
+      filtered_versions.first
+    end
+
+    def unresolved_reasons(reasons)
+      reasons.reject(&:fixed)
+    end
+
+    def hockeyapp(bundle_identifier, client)
+      all_apps = client.get_apps
+      apps = all_apps.select do |app|
+        app.bundle_identifier == bundle_identifier
+      end
+      apps.first
+    end
+
+    def filtered_versions_by_version_and_build(versions, version_filter, build_filter)
+      versions.select do |version|
+        (version.shortversion == version_filter) && (version.version == build_filter)
+      end
+    end
+  end
+end

data/lib/crep/version.rb

@@ -0,0 +1,3 @@
+module Crep
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: crep
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kim Dung-Pham
+- Bas Broek
+- Serghei Moret
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hockeyapp
+  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'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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'
+- !ruby/object:Gem::Dependency
+  name: claide
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 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: rspec
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+description: Create Crash Newsletter with ease. Really.
+email:
+- kim.dung-pham@xing.com
+- bas.broek@xing.com
+- serghei.moret@xing.com
+executables:
+- crep
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Changelog.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- Vision.md
+- bin/console
+- bin/crep
+- bin/setup
+- crep.gemspec
+- lib/crep.rb
+- lib/crep/command.rb
+- lib/crep/command/crashes.rb
+- lib/crep/crash_controller.rb
+- lib/crep/model/crash_model/app.rb
+- lib/crep/model/crash_model/crash.rb
+- lib/crep/model/crash_sources/crash_source.rb
+- lib/crep/model/crash_sources/hockeyapp_crash_source.rb
+- lib/crep/version.rb
+homepage: https://github.com/xing/crep
+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.7.4
+signing_key: 
+specification_version: 4
+summary: Create Crash Newsletter with ease.
+test_files: []