Merge pull request #1 from brandedcrate/master

transfer improvements back to errbit organization

Author: stevecrozz

errbit_github_plugin.gemspec

@@ -6,11 +6,12 @@ require 'errbit_github_plugin/version'
 Gem::Specification.new do |spec|
   spec.name          = "errbit_github_plugin"
   spec.version       = ErrbitGithubPlugin::VERSION
-  spec.authors       = ["Cyril Mougel"]
-  spec.email         = ["cyril.mougel@gmail.com"]
-  spec.description   = %q{Add Github issue tracker plugin to errbit}
-  spec.summary       = %q{Add Github issue tracker plugin to errbit}
-  spec.homepage      = ""
+  spec.authors       = ["Stephen Crosby", "Cyril Mougel"]
+  spec.email         = ["stevecrozz@gmail.com", "cyril.mougel@gmail.com"]
+
+  spec.description   = %q{GitHub integration for Errbit}
+  spec.summary       = %q{GitHub integration for Errbit}
+  spec.homepage      = "https://github.com/brandedcrate/errbit_github_plugin"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

lib/errbit_github_plugin.rb

@@ -3,7 +3,10 @@
 require 'errbit_github_plugin/issue_tracker'
 require 'errbit_github_plugin/rails'
 
-ErrbitPlugin::Register.add_issue_tracker(
-  'IssueTrackers::GithubIssuesTracker',
-  ErrbitGithubPlugin::IssueTracker
-)
+module ErrbitGithubPlugin
+  def self.root
+    File.expand_path '../..', __FILE__
+  end
+end
+
+ErrbitPlugin::Registry.add_issue_tracker(ErrbitGithubPlugin::IssueTracker)

lib/errbit_github_plugin/issue_tracker.rb

@@ -3,22 +3,41 @@
 module ErrbitGithubPlugin
   class IssueTracker < ErrbitPlugin::IssueTracker
 
-    def label; 'github'; end
-    def note
-      'Please configure your github repository in the <strong>GITHUB REPO</strong> field above.<br/>' <<
-      'Instead of providing your username & password, you can link your Github account ' <<
-      'to your user profile, and allow Errbit to create issues using your OAuth token.'
-    end
+    LABEL = 'github'
+
+    NOTE = 'Please configure your github repository in the <strong>GITHUB ' <<
+           'REPO</strong> field above.<br/> Instead of providing your ' <<
+           'username & password, you can link your Github account to your ' <<
+           'user profile, and allow Errbit to create issues using your ' <<
+           'OAuth token.'
 
-    def fields
-      {
-        :username => {
-          :placeholder => "Your username on GitHub"
-        },
-        :password => {
-          :placeholder => "Password for your account"
-        }
+    FIELDS = {
+      :username => {
+        :placeholder => "Your username on GitHub"
+      },
+      :password => {
+        :placeholder => "Password for your account"
       }
+    }
+
+    def self.label
+      LABEL
+    end
+
+    def self.note
+      NOTE
+    end
+
+    def self.fields
+      FIELDS
+    end
+
+    def self.body_template
+      @body_template ||= ERB.new(File.read(
+        File.join(
+          ErrbitGithubPlugin.root, 'views', 'github_issues_body.txt.erb'
+        )
+      ))
     end
 
     attr_accessor :oauth_token
@@ -34,39 +53,41 @@ def project_id
       app.github_repo
     end
 
-    def check_params
-      if Fields.detect {|f| self[f[0]].blank? }
-        errors.add :base, 'You must specify your GitHub username and password'
+    def errors
+      errors = []
+      if self.class.fields.detect {|f| params[f[0]].blank? }
+        errors << [:base, 'You must specify your GitHub username and password']
       end
+      errors
     end
 
-    def create_issue(problem, reported_by = nil)
+    def github_client
       # Login using OAuth token, if given.
       if oauth_token
-        client = Octokit::Client.new(:login => username, :oauth_token => oauth_token)
+        Octokit::Client.new(
+          :login => params['username'], :oauth_token => oauth_token)
       else
-        client = Octokit::Client.new(:login => username, :password => password)
+        Octokit::Client.new(
+          :login => params['username'], :password => params['password'])
       end
+    end
 
+    def create_issue(problem, reported_by = nil)
       begin
-        issue = client.create_issue(
+        issue = github_client.create_issue(
           project_id,
-          issue_title(problem),
-          body_template.result(binding).unpack('C*').pack('U*')
+          "[#{ problem.environment }][#{ problem.where }] #{problem.message.to_s.truncate(100)}",
+          self.class.body_template.result(binding).unpack('C*').pack('U*')
         )
         @url = issue.html_url
         problem.update_attributes(
           :issue_link => issue.html_url,
-          :issue_type => Label
+          :issue_type => self.class.label
         )
 
       rescue Octokit::Unauthorized
         raise ErrbitGithubPlugin::AuthenticationError, "Could not authenticate with GitHub. Please check your username and password."
       end
     end
-
-    def body_template
-      @@body_template ||= ERB.new(File.read(Rails.root + "app/views/issue_trackers/github_issues_body.txt.erb").gsub(/^\s*/, ''))
-    end
   end
 end

lib/errbit_github_plugin/version.rb

@@ -1,3 +1,3 @@
 module ErrbitGithubPlugin
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

views/github_issues_body.txt.erb

@@ -0,0 +1,45 @@
+[See this exception on Errbit](<%= problem.url %> "See this exception on Errbit")
+<% if notice = problem.notices.first %>
+# <%= notice.message %> #
+## Summary ##
+<% if notice.request['url'].present? %>
+  ### URL ###
+  [<%= notice.request['url'] %>](<%= notice.request['url'] %>)"
+<% end %>
+### Where ###
+<%= notice.where %>
+
+### Occured ###
+<%= notice.created_at.to_s(:micro) %>
+
+### Similar ###
+<%= (notice.problem.notices_count - 1).to_s %>
+
+## Params ##
+```
+<%= pretty_hash(notice.params) %>
+```
+
+## Session ##
+```
+<%= pretty_hash(notice.session) %>
+```
+
+## Backtrace ##
+```
+<% notice.backtrace_lines.each do |line| %><%= line.number %>:  <%= line.file_relative %> -> **<%= line.method %>**
+<% end %>
+```
+
+## Environment ##
+
+<table>
+<% for key, val in notice.env_vars %>
+  <tr>
+    <td><%= key %>:</td>
+    <td><%= val %></td>
+  </tr>
+<% end %>
+</table>
+<% end %>
+