crep 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 6ec9983a55f99437b47855a38a35de0748a1fb8023dca8ef5f3f973b9be87919
-  data.tar.gz: e3830e5d8609c2aa9d1808d4d82218d7a44172b207f3fde619462c1cd38adddd
+SHA1:
+  metadata.gz: 92ca99da70b9b006895c218f962edea42d463d35
+  data.tar.gz: 282e8f310eaabe35d01e2c46cc9b93f0f132ad34
 SHA512:
-  metadata.gz: b3b1687053ac8aae4f85872331f9e16e632769765d6ca598556dd2adc76d048e68cafbe4fa0c2c0a205f0307d702c9196e73221ce9b5e3e214df24af39f3e7b0
-  data.tar.gz: 1d0ea2b9eee605d398f8e600a2bbd31698f8e44ade452862cdccfb856f96013ef8dde8454de33ee23d8d330fdb710ca0ecd79945bec282bcbdbb9fa7b7a1995c
+  metadata.gz: 72c1e5f118d38112e5ad84b1a48b261948074cad36119be45b0a298445b7cba475d10720bf66395b9304e3e15031b21e12f6850df0e85d41d5f12ca8f227195b
+  data.tar.gz: 7a7e2a8cc83a8313750e97f9567a24f6c70d9cf9550e9c34e8bf2d4d235a857473a49b2db720fa5a6820a06170551d99eac966830670ede19df023248dc826c3

data/.circleci/config.yml

@@ -0,0 +1,22 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.4.1
+    steps:
+      - checkout
+      - run:
+          name: Install dependencies
+          command: bundle install
+
+      - run:
+          name: Run the tests
+          command: bundle exec rspec
+
+      - run:
+          name: Run Danger
+          command: bundle exec danger
+          when: always
+notify:
+  webhooks:
+    - url: https://alethea3000.herokuapp.com/post/circle

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,6 @@
+<!--
+Please let us know what version of Crep you are using, so we can better pinpoint and/or solve your issue.
+Please also provide the command you ran and what you expected to happen (or in case of an unexpected crash, the crash log).
+
+Also please make sure your title and description describe your problem as clearly as possible. Questions end with a question mark.
+-->

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,10 @@
+<!--
+First of all, thank you for contributing to Crep! 🎉
+
+If your pull request fixes an issue, please reference the issue.
+For example, when your pull request fixes issue 10, add the following line:
+
+Fixes #10
+
+This will make sure that when the pull request is merged, the issue will automatically be closed.
+-->

data/.gitignore

@@ -2,7 +2,6 @@
 *.rbc
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /.config
 /_yardoc/
 /coverage/
@@ -58,3 +57,6 @@ build-iPhoneSimulator/
 .rvmrc
 
 .DS_Store
+
+# vim swp files
+*.swp

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/Changelog.md

@@ -2,20 +2,31 @@
 
 ## Added
 
--
-
 ## Removed
 
--
+## Fixed
+
+## Miscellaneous
+
+# v1.0.0
+
+## Added
+
+- Added an `apps` command that shows a list of available apps.
+- Added a warning when multiple versions of an app are found.
+- Added colorful output to the message stating if there was no version found.
+- Added deep link support to HockeyApp reporting.
+- Added the possibility to use ERB templates to generate a report layout.
+- Added the ability to supply a custom template for the crash report via a command line argument, `--template`.
+
+## Removed
 
 ## Fixed
 
--
+- Fixed an invalid identifier producing a bogus error (#46)
 
 ## Miscellaneous
 
--
-
-# 0.1.0
+# v0.1.0
 
 - Initial release.

data/Dangerfile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Run rubocop
+rubocop.lint
+
+not_declared_trivial = !github.pr_title.include?('trivial')
+
+has_lib_changes = !git.modified_files.grep(/lib/).empty?
+has_fixture_changes = !git.modified_files.grep(/fixtures/).empty?
+no_readme_changes = !git.modified_files.include?('Readme.md')
+
+no_changelog_entry = !git.modified_files.include?('Changelog.md')
+
+warn('PR is classed as Work in Progress') if github.pr_title.include? 'WIP'
+warn('Big PR') if git.lines_of_code > 500
+
+if has_lib_changes && no_changelog_entry && not_declared_trivial
+  warn('Any changes to library code should be reflected in the Changelog. Please consider adding a note there.')
+end
+
+if has_fixture_changes && no_readme_changes
+  raise("Any changes in the fixtures should be reflected in the Readme's usage example.")
+end

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Crep's dependencies in crep.gemspec
@@ -5,3 +7,6 @@ gemspec
 
 # contains Support for Statistics
 gem 'hockeyapp', git: 'https://github.com/q231950/hockeyapp.git'
+
+gem 'danger'
+gem 'danger-rubocop'

data/Gemfile.lock

@@ -0,0 +1,157 @@
+GIT
+  remote: https://github.com/q231950/hockeyapp.git
+  revision: 67bdabfdae885e59c977cf30765ac6346dd0ab57
+  specs:
+    hockeyapp (0.0.17)
+      activemodel
+      awesome_print
+      httmultiparty
+      multi_json
+      rake
+      rspec
+      simplecov
+
+PATH
+  remote: .
+  specs:
+    crep (1.0.0)
+      claide (~> 1.0.0)
+      colorize
+      hockeyapp
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.1.4)
+      activesupport (= 5.1.4)
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.3.0)
+    awesome_print (1.8.0)
+    byebug (9.1.0)
+    claide (1.0.2)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    coderay (1.1.2)
+    colored2 (3.1.2)
+    colorize (0.8.1)
+    concurrent-ruby (1.0.5)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (5.5.6)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (~> 0.9)
+      faraday-http-cache (~> 1.0)
+      git (~> 1)
+      kramdown (~> 1.5)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (~> 1)
+    danger-rubocop (0.6.0)
+      danger
+      rubocop
+    diff-lcs (1.3)
+    docile (1.1.5)
+    faraday (0.13.1)
+      multipart-post (>= 1.2, < 3)
+    faraday-http-cache (1.3.1)
+      faraday (~> 0.8)
+    git (1.3.0)
+    httmultiparty (0.3.16)
+      httparty (>= 0.7.3)
+      mimemagic
+      multipart-post
+    httparty (0.15.6)
+      multi_xml (>= 0.5.2)
+    i18n (0.9.3)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    kramdown (1.16.2)
+    method_source (0.9.0)
+    mimemagic (0.3.2)
+    minitest (5.11.3)
+    multi_json (1.13.1)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    nap (1.1.0)
+    no_proxy_fix (0.1.2)
+    octokit (4.8.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    open4 (1.3.4)
+    parallel (1.12.0)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    powerpack (0.1.1)
+    pry (0.11.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.5.1)
+      byebug (~> 9.1)
+      pry (~> 0.10)
+    public_suffix (3.0.1)
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    rubocop (0.51.0)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.15)
+  crep!
+  danger
+  danger-rubocop
+  hockeyapp!
+  pry
+  pry-byebug
+  rake (~> 10.0)
+  rspec
+  rubocop (= 0.51.0)
+
+BUNDLED WITH
+   1.16.1

data/Rakefile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 task default: :spec

data/Readme.md

@@ -0,0 +1,78 @@
+# Crep
+
+[![CircleCI](https://circleci.com/gh/xing/crep.svg?style=svg)](https://circleci.com/gh/xing/crep)
+
+*Crep - a Crash Reporter for creating appealing Crash Reports*
+
+![the crab logo](assets/logo_small.png)
+
+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 Reports 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.
+
+[ERB](http://www.stuartellis.name/articles/erb/) templates are used for the crash report layout.
+You can either use the [supplied template](https://github.com/xing/crep/blob/master/templates/default_crash_report.txt.erb) in the templates folder
+or specify your own via a command line argument.
+Example: `bundle exec crep crashes --identifier .... --template=<path to your template>`
+
+**This is what [Crep output](https://github.com/xing/crep/blob/master/spec/fixtures/report_output.txt) can look like:**
+
+```
+Reporting for YourApp (0.17.1/1114) your.bundle.identifier
+------------- #1 --------------
+Class: SomeWeirdClass
+First appeared on 2017-07-14 and occurred 50 times in 0.17.1
+Percentage: 12.5% of all 0.17.1 crashes
+File/Line: line:123
+Reason: Unknown
+Link: https://my.crash.url
+Deep Link: hockeyapp-coach://view-crash/app_id/reason_id/latest
+
+------------- #2 --------------
+Class: SomeOtherClass
+First appeared on 2017-07-14 and occurred 100 times in 0.17.1
+Percentage: 25.0% of all 0.17.1 crashes
+File/Line: line:123
+Reason: Unknown
+Link: https://my.crash.url
+Deep Link: hockeyapp-coach://view-crash/app_id/reason_id/latest
+```
+
+## 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!
+
+You can help by doing any of the following:
+
+- Reviewing pull requests
+- Bringing ideas for the new features
+- Answering questions on issues
+- Improving documentation
+
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant code](http://contributor-covenant.org/) of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Vision.md

@@ -1,6 +1,6 @@
 # Goals
 
-- Add newsletter templating to easily create a readable and actionable format for sharing crashes.
+- Add templating support for reports 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.
@@ -8,7 +8,7 @@
 # Scope
 
 - We are focusing on crashes for a specific app version.
-- Having a crash newsletter in mind, we do not expect adding crash visualisations.
+- We do not expect adding crash visualisations.
 
 ## Inspiration
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'crep'

data/bin/crep

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 $LOAD_PATH.push File.expand_path('../lib', File.dirname(__FILE__))
 

data/crep.gemspec

@@ -1,4 +1,6 @@
 
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'crep/version'
@@ -9,11 +11,19 @@ Gem::Specification.new do |spec|
   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.summary       = 'Create Crash Reports with ease.'
+  spec.description   = 'Create Crash Reports with ease. Really.'
   spec.homepage      = 'https://github.com/xing/crep'
   spec.license       = 'MIT'
 
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -23,13 +33,14 @@ Gem::Specification.new do |spec|
   spec.executables << 'crep'
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'hockeyapp'
   spec.add_dependency 'colorize'
+  spec.add_dependency 'hockeyapp'
 
   spec.add_runtime_dependency 'claide', '~> 1.0.0'
 
   spec.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop', '0.51.0'

data/lib/crep.rb

@@ -1,12 +1,10 @@
+# frozen_string_literal: true
+
 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

data/lib/crep/app_controller.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Crep
+  class AppController
+    def initialize(app_source, identifier, version, build, versions_limit)
+      @identifier = identifier&.downcase
+      @version = version
+      @build = build
+      @versions_limit = versions_limit
+
+      @app_source = app_source
+      @app_source.configure
+    end
+
+    def apps
+      filtered_apps = @app_source.apps.select do |app|
+        @identifier ? app.bundle_identifier.downcase == @identifier : true
+      end
+      filtered_apps.each do |app|
+        report_app(app.public_identifier, app.title)
+      end
+    end
+
+    def report_app(identifier, title)
+      puts "\n\t\t" + title
+      app_versions_as_string_list(identifier).each do |version_string|
+        puts "\t\t#{version_string}"
+      end
+    end
+
+    def app_versions_as_string_list(app_identifier)
+      versions = @app_source.versions(app_identifier)
+
+      filtered_versions = versions.select do |v|
+        version_match = @version ? v.version == @version : true
+        build_match = @build ? v.build == @build : true
+        version_match && build_match
+      end
+
+      AppController.versions_as_string_list(filtered_versions, @versions_limit)
+    end
+
+    def self.versions_as_string_list(versions, limit)
+      versions.first(limit).map do |v|
+        "#{v.version} (#{v.build})"
+      end
+    end
+  end
+end

data/lib/crep/command.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 require 'claide'
 require 'crep/version'
 
 module Crep
   class Command < CLAide::Command
     require 'crep/command/crashes'
+    require 'crep/command/apps'
 
     self.abstract_command = true
     self.command = 'crep'

data/lib/crep/command/apps.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'crep/command'
+require 'crep/app_controller'
+require 'crep/model/app_source/hockeyapp_app_source'
+
+module Crep
+  class Apps < Command
+    # options should accept app name and version filter
+    DEFAULT_VERSIONS_LIMIT = 5
+
+    def self.options
+      [
+        ['--identifier=<com.company.app>', 'Crep will show app information with this identifier.'],
+        ['--version=<7.10.0>', 'An optional filter for the version of an app.'],
+        ['--build=<24>', 'An optional filter for the build of an app.'],
+        ['--versions=5', "If set, Crep will limit the number of displayed versions per app. #{DEFAULT_VERSIONS_LIMIT} by default."]
+      ].concat(super)
+    end
+
+    self.summary = <<-DESC
+          Shows the apps with their versions.
+      DESC
+
+    self.description = <<-DESC
+        Display apps with their versions.
+      DESC
+
+    def initialize(argv)
+      super
+
+      @versions_limit = argv.option('versions') || DEFAULT_VERSIONS_LIMIT
+      CrepLogger.info("Versions will be limited to #{@versions_limit} per app")
+
+      @identifier = argv.option('identifier')
+      CrepLogger.info("Apps will be filtered by identifier: #{@identifier}") if @identifier
+
+      @version = argv.option('version')
+      CrepLogger.info("Version will be filtered: #{@version}") if @version
+
+      @build = argv.option('build')
+      CrepLogger.info("Build will be filtered: #{@build}") if @build
+    end
+
+    def run
+      CrepLogger.info('Reporting apps:')
+
+      app_source = HockeyAppAppSource.new
+      app_controller = AppController.new(app_source, @identifier, @version, @build, @versions_limit.to_i)
+      app_controller.apps
+    end
+  end
+end

data/lib/crep/command/crashes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'crep/command'
 require 'crep/crash_controller'
 require 'crep/model/crash_sources/hockeyapp_crash_source'
@@ -6,6 +8,7 @@ require 'hockeyapp'
 module Crep
   class Crashes < Command
     DEFAULT_TOP_COUNT = 5
+    DEFAULT_TEMPLATE = 'templates/default_crash_report.txt.erb'
 
     def self.options
       [
@@ -13,7 +16,8 @@ module Crep
         ['--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.']
+        ['--only-unresolved', 'If set, resolved crashes will be filtered out.'],
+        ['--template=templates/defaul_crash_report.txt.erb', 'Set this to specify a erb template for the report format. If no value is specifed the default temapate will be used.']
       ].concat(super)
     end
 
@@ -22,21 +26,31 @@ module Crep
     DESC
 
     self.description = <<-DESC
-      Besides the optional `top` parameter, Crep requires all other parameters.
+      Besides the optional `top`, `template` and `only-unresolved` parameters, Crep requires all other parameters.
     DESC
 
     def initialize(argv)
+      super
+
       @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')
+      @top = argv.option('top', DEFAULT_TOP_COUNT)
+      @bundle_identifier = argv.option('identifier')
+      @version = argv.option('version')
+      @build = argv.option('build')
+      @template = argv.option('template', DEFAULT_TEMPLATE)
+    end
+
+    def validate!
       super
+
+      help! 'The identifier (--identifier) is a required parameter' unless @bundle_identifier
+      help! 'The version (--version)  is a required parameter' unless @version
+      help! 'The build number (--build) is a required parameter' unless @build
     end
 
     def run
       crash_datasource = HockeyAppCrashSource.new
-      crash_controller = CrashController.new(@bundle_identifier, @top, crash_datasource, @show_only_unresolved)
+      crash_controller = CrashController.new(@bundle_identifier, @top, crash_datasource, @show_only_unresolved, @template)
       crash_controller.top_crashes(@version, @build)
     end
   end

data/lib/crep/crash_controller.rb

@@ -1,64 +1,40 @@
+# frozen_string_literal: true
+
 require 'colorize'
+require 'erb'
 
 module Crep
   class CrashController
-    def initialize(bundle_identifier, top, crash_source, show_only_unresolved)
+    attr_reader :bundle_identifier, :crashes, :app_name, :version, :build, :total_crashes, :template_path
+
+    def initialize(bundle_identifier, top, crash_source, show_only_unresolved, template_path)
       @bundle_identifier = bundle_identifier
       @top = top
       @crash_source = crash_source
       @show_only_unresolved = show_only_unresolved
       @crash_source.configure(bundle_identifier)
+      @app_name = @crash_source.app.name
+      @template_path = template_path
     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
+      @version = version
+      @build = build
+      @crashes = @crash_source.crashes(@top, version, build, @show_only_unresolved)
+      @total_crashes = @crash_source.crash_count(version: @version, build: @build)
+      report
     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
+    private def report
+      template = File.read template_path
+      renderer = ERB.new template
+      puts output = renderer.result(binding)
+      output
     end
 
-    def crash_percentage(crash:, total_crashes:)
+    private 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/logger.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Crep
+  CrepLogger = Logger.new(STDOUT)
+  CrepLogger.level = Logger::DEBUG
+  CrepLogger.datetime_format = '%Y-%m-%d %H:%M:%S'
+  CrepLogger.formatter = proc do |severity, datetime, _progname, msg|
+    case severity
+    when 'DEBUG'
+      "[DEBUG] #{datetime}: #{msg}\n".light_magenta
+    when 'ERROR'
+      "[ERROR] #{datetime}: #{msg}\n".red
+    when 'FATAL'
+      "[FATAL] #{datetime}: #{msg}\n".red
+    when 'INFO'
+      "[INFO] #{datetime}: #{msg}\n".green
+    when 'WARN'
+      "[WARNING] #{datetime}: #{msg}\n".yellow
+    else
+      "[LOG] #{datetime}: #{msg}\n"
+    end
+  end
+end

data/lib/crep/model/app_source/app_source.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Crep
+  class AppSource
+    attr_reader :version
+
+    def configure
+      CrepLogger.info('Configuration of the CrashSource can happen in the `configure` method')
+    end
+
+    def apps
+      raise 'AppSource subclass has to implement the `apps` method.'
+    end
+
+    # versions returns the versions for the given app identifier
+    def versions(_app_identifier)
+      raise 'AppSource subclass has to implement the `versions` method.'
+    end
+  end
+end

data/lib/crep/model/app_source/hockeyapp_app_source.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'crep/model/app_source/app_source'
+require 'crep/model/crash_model/version'
+require 'hockeyapp'
+
+module Crep
+  class HockeyAppAppSource < AppSource
+    def configure
+      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
+    end
+
+    def apps
+      @client.get_apps
+    end
+
+    def versions(app_identifier)
+      apps = @client.get_apps.select do |a|
+        a.public_identifier == app_identifier
+      end
+
+      raise("Unable to find app with identifier: #{app_identifier}") unless apps.count.positive?
+
+      app = apps.first
+      app.versions.map do |version|
+        Crep::Version.new(version.shortversion, version.version, app.public_identifier.downcase)
+      end
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Crep
   # App represents an App
   class App

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

@@ -1,13 +1,16 @@
+# frozen_string_literal: true
+
 module Crep
   class Crash
-    attr_reader :file_line, :occurrences, :reason, :crash_class, :registered_at, :url
+    attr_reader :file_line, :occurrences, :reason, :crash_class, :registered_at, :deep_link, :url
 
-    def initialize(file_line:, occurrences:, reason:, crash_class:, registered_at:, url:)
+    def initialize(file_line:, occurrences:, reason:, crash_class:, registered_at:, deep_link:, url:)
       @file_line = file_line
       @occurrences = occurrences
       @reason = reason
       @crash_class = crash_class
       @registered_at = registered_at
+      @deep_link = deep_link
       @url = url
     end
   end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Crep
+  class Version
+    attr_reader :version, :build, :app_identifier
+
+    def initialize(version, build, app_identifier)
+      @version = version
+      @build = build
+      @app_identifier = app_identifier
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Crep
   # This is an abstract class that defines the methods which subclasses must implement.
   class CrashSource
@@ -5,7 +7,7 @@ module Crep
 
     # Necessary configuration of the subclass can happen here
     def configure(_bundle_identifier)
-      raise 'CrashSource subclass has to implement the `configure` method.'
+      CrepLogger.info('Configuration of the CrashSource can happen in the `configure` method')
     end
 
     def crash_count(_version, _build)

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

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require 'crep/model/crash_sources/crash_source'
 require 'crep/model/crash_model/app'
 require 'crep/model/crash_model/crash'
+require 'crep/logger'
 require 'hockeyapp'
 
 module Crep
@@ -35,11 +38,13 @@ module Crep
       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)
+        deep_link = deep_link(app_id: reason.app.public_identifier, 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),
+                  deep_link: deep_link,
                   url: url)
       end
     end
@@ -48,12 +53,23 @@ module Crep
       "https://rink.hockeyapp.net/manage/apps/#{app_id}/app_versions/#{version_id}/crash_reasons/#{reason_id}"
     end
 
+    def deep_link(app_id:, reason_id:)
+      "hockeyapp-coach://view-crash/#{app_id}/#{reason_id}/latest"
+    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
+      if filtered_versions.count <= 0
+        CrepLogger.error("No version was found for #{version})#{build})")
+        raise
+      end
 
-      filtered_versions.first
+      report_version = filtered_versions.first
+
+      CrepLogger.warn("Multiple results for #{version}/#{build} were found, using the first (with ID #{report_version.id}) one that was found") unless filtered_versions.count <= 1
+
+      report_version
     end
 
     def unresolved_reasons(reasons)
@@ -65,6 +81,10 @@ module Crep
       apps = all_apps.select do |app|
         app.bundle_identifier == bundle_identifier
       end
+      unless apps.first
+        CrepLogger.error("No app with the give bundle identifier (#{bundle_identifier}) was found.")
+        raise
+      end
       apps.first
     end
 

data/lib/crep/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Crep
-  VERSION = '0.1.0'.freeze
+  VERSION = '1.0.0'
 end

data/templates/default_crash_report.txt.erb

@@ -0,0 +1,11 @@
+Reporting for <%= app_name %> (<%= version %>/<%= build %>) <%= bundle_identifier %>
+<% crashes.each_with_index do |crash, index| %>
+------------- #<%= index + 1 %> --------------
+Class: <%= crash.crash_class %>
+First appeared on <%= crash.registered_at %> and occurred <%= crash.occurrences %> times in <%= version %>
+Percentage: <%= crash_percentage(crash: crash, total_crashes: total_crashes).round(2) %>% of all <%= version %> crashes
+File/Line: <%= crash.file_line %>
+Reason: <%= crash.reason %>
+Link: <%= crash.url %>
+Deep Link: <%= crash.deep_link %>
+<% end %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crep
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Kim Dung-Pham
@@ -10,10 +10,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-13 00:00:00.000000000 Z
+date: 2018-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: hockeyapp
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -27,7 +27,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: hockeyapp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -82,6 +82,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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
@@ -124,7 +138,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.51.0
-description: Create Crash Newsletter with ease. Really.
+description: Create Crash Reports with ease. Really.
 email:
 - kim.dung-pham@xing.com
 - bas.broek@xing.com
@@ -134,32 +148,51 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
+- ".github/ISSUE_TEMPLATE.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - Changelog.md
+- Dangerfile
 - Gemfile
+- Gemfile.lock
 - LICENSE
-- README.md
 - Rakefile
+- Readme.md
 - Vision.md
+- assets/logo.png
+- assets/logo_dark.png
+- assets/logo_grapefruit.png
+- assets/logo_small.png
+- assets/logo_square.png
 - bin/console
 - bin/crep
 - bin/setup
 - crep.gemspec
 - lib/crep.rb
+- lib/crep/app_controller.rb
 - lib/crep/command.rb
+- lib/crep/command/apps.rb
 - lib/crep/command/crashes.rb
 - lib/crep/crash_controller.rb
+- lib/crep/logger.rb
+- lib/crep/model/app_source/app_source.rb
+- lib/crep/model/app_source/hockeyapp_app_source.rb
 - lib/crep/model/crash_model/app.rb
 - lib/crep/model/crash_model/crash.rb
+- lib/crep/model/crash_model/version.rb
 - lib/crep/model/crash_sources/crash_source.rb
 - lib/crep/model/crash_sources/hockeyapp_crash_source.rb
 - lib/crep/version.rb
+- templates/default_crash_report.txt.erb
 homepage: https://github.com/xing/crep
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -176,8 +209,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Create Crash Newsletter with ease.
+summary: Create Crash Reports with ease.
 test_files: []

data/README.md

@@ -1,37 +0,0 @@
-# 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).