redmine-reporting 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef8bed8213b46cf3bcd9195eb30dee2d5e5f00fc
-  data.tar.gz: e5950d703f4c767bb09cbc4b432fc58e1b1704ee
+  metadata.gz: ac501589d0737e31a91a96268028b61dbc16e021
+  data.tar.gz: a14f692beba30c48642f1dbf5a81142cfaa2ed5d
 SHA512:
-  metadata.gz: c59cbfaea3345f37012f3f879b452ad4d2dc3349812f523936c0b423fe94bcf40459161eb15f026de6e5f21cf41d7f49273872bc60c4c70af68da2152391138c
-  data.tar.gz: 79ea1aeadcfa149492f578c3090ce9848563c71eb3e5f9ef034923bdce09c20de33b9f6a6f246241c6f66fd86221395edb71762f07958cdee03c14577984e840
+  metadata.gz: 17643533787ea69e2f4fb34752b312eef4ad187c3f9af8d2d0826274987bcd852c3cba13927e1dfc333b74dd8ca20ac13e33828853dd52381389ec14b82da260
+  data.tar.gz: d970eba7db83d58045d09840b81f2ef498ce901fcbadead4b8e82406165456b75fd84bb6ddd0a483f58efdbb02378467bfa05c5d9d670cd912ccff9776eafbd8

data/README.md

@@ -1,6 +1,7 @@
 # redmine-reporting
 
-TODO: Write a gem description
+A simple gem to use with rails or any ruby project to report exceptions or other messages as issues to the Redmine project management system (http://www.redmine.org).
+
 
 ## Installation
 
@@ -16,9 +17,23 @@ Or install it yourself as:
 
     $ gem install redmine-reporting
 
+Add a initializer ```config/initializers/redmine_reporting.rb``` with the following content.
+
+```ruby
+Redmine::Reporting.configure do |config|
+  config.base_url = 'https://redmine.example.net/'
+  config.api_key = '012345678901234567890123456789012'
+  config.project = 'your-project-identifier'
+  config.tracker = 1
+  config.category = 1
+end
+```
+
+
 ## Usage
 
-TODO: Write usage instructions here
+If you are in a Rails project, the gem will automatically hook itself into the rack middleware and report any uncatched exception.
+
 
 ## Contributing
 

data/lib/redmine/reporting/configuration.rb

@@ -6,6 +6,19 @@ module Redmine
       attr_accessor :project
       attr_accessor :tracker
       attr_accessor :category
+      attr_reader :http_options
+
+      def proxy(hostname, port)
+        @http_options ||= {}
+        @http_options[:http_proxyaddr] = hostname
+        @http_options[:http_proxyport] = port
+      end
+
+      def proxy_auth(username, password)
+        @http_options ||= {}
+        @http_options[:http_proxyuser] = username
+        @http_options[:http_proxypass] = password
+      end
     end
   end
 end

data/lib/redmine/reporting/report.rb

@@ -26,20 +26,20 @@ module Redmine
       def commit
         config = Redmine::Reporting.configuration
 
-        options = {
+        options = (config.http_options || {}).merge({
           headers: {
             'Content-type' => 'application/json',
             'X-Redmine-API-Key' => config.api_key
           }
-        }
+        })
 
         if issue_id.nil?
           resp = HTTParty.post("#{config.base_url}/issues.json", options.merge({
               body: {
                 issue: {
-                  subject: @subject,
+                  subject: @subject.strip,
                   project_id: config.project,
-                  description: @description,
+                  description: @description.strip,
                   tracker_id: config.tracker,
                   category_id: config.category
                 }
@@ -49,7 +49,7 @@ module Redmine
           issue_id = resp['issue']['id'] rescue nil
 
           unless issue_id.nil?
-            File.open(issue_id_file, File::CREAT|File::TRUNC|File::RDWR, 0600) {|f| f.write(issue_id.to_s) }
+            File.open(issue_id_file, File::CREAT|File::TRUNC|File::RDWR, 0600) {|f| f.write(issue_id.to_s)}
           end
         end
 
@@ -60,13 +60,14 @@ module Redmine
         resp = HTTParty.put("#{config.base_url}/issues/#{issue_id}.json", options.merge({
             body: {
               issue: {
-                notes: "h1. #{reference_id}\n\n#{@notes}"
+                notes: "h1. #{reference_id}\n\n#{@notes}".strip
               }
             }.to_json
           }))
 
         reference_id
-      rescue Timeout::Error
+      rescue => e
+        # TODO ignore
         nil
       end
 
@@ -76,6 +77,7 @@ module Redmine
         @current_var << "#{type}. #{title}\n\n"
         data_to_syntax(content) unless content.nil?
         data_to_syntax(&block) if block_given?
+        @current_var << "\n\n"
         nil
       end
 
@@ -88,7 +90,7 @@ module Redmine
       end
 
       def output(content)
-        @current_var << content
+        @current_var << "#{content}\n"
         nil
       end
 
@@ -105,7 +107,7 @@ module Redmine
       def issue_hash
         config = Redmine::Reporting.configuration
 
-        Digest::SHA1.hexdigest([config.base_url, config.project, @subject, @description].join('//'))
+        Digest::SHA1.hexdigest([config.base_url, config.project, @subject.strip, @description.strip].join('//'))
       end
 
       def issue_id_file

data/lib/redmine/reporting/version.rb

@@ -1,5 +1,5 @@
 module Redmine
   module Reporting
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redmine-reporting
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Florian Schwab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-22 00:00:00.000000000 Z
+date: 2013-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler