exception_notification-redmine 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a4f3e09e0c4a178a42ea58d78ca5c39744463531
+  data.tar.gz: f671f36eb35d3f4d158453e41ff417d289e2baa0
+SHA512:
+  metadata.gz: 6c43bfbfef407ea3cdd04fee98175149dd282980c2c76f77348b1811f743435ee99dd47de39894d7d14636c1b96568efcfe8d43287a4779e1c695946f17a4a4b
+  data.tar.gz: a42974a96adac7a09128174eb1c83047b121a4a722e22e22598f3ddb169f0cef74d66d9d7b86f02698deff8b1debb9e3aaefcb41005d54ccc0b43c0bf86656aa

data/.gitignore

@@ -0,0 +1,73 @@
+# Compiled source #
+###################
+*.com
+*.class
+*.dll
+*.exe
+*.o
+*.so
+
+# Packages #
+############
+# it's better to unpack these files and commit the raw source
+# git has its own built in compression methods
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# Logs and databases #
+######################
+*.log
+*.sql
+*sqlite*
+
+# Rubymine config dir #
+#######################
+.idea
+
+# Rails database config #
+########################
+config/database.yml
+
+# Rails 3.1 #
+#############
+.sass-cache/
+
+# Misc #
+########
+*~
+*.cache
+*.pid
+tmp/*
+tmp/**/*
+db/cstore/**
+doc/api
+doc/app
+doc/plugins
+coverage/*
+*.tmproj
+Capfile
+doc/*.dot
+*.sw?
+.svn
+.rake_tasks
+.bundle
+
+
+# xcode noise #
+###############
+build/*
+*.pbxuser
+*.mode1v3
+
+# OS generated files #
+######################
+.DS_Store*
+ehthumbs.db
+Icon?
+Thumbs.db

data/CHANGELOG

@@ -0,0 +1,4 @@
+Version 0.0.1: Initial release
+Version 0.0.2: Use a custom field to avoid creation of same issue multiple times
+Version 0.1.0: Version bump, add README.md, TODO.md and LICENCE
+Version 0.1.1: Update README.md

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Nuxos Asia - richard.piacentini@nuxos.asia
+
+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,59 @@
+# ExceptionNotification::Redmine
+
+This gem add a Redmine notifier to Exception Notification.
+
+This Ruby gem is an extension of the [exception_notification gem](http://rubygems.org/gems/exception_notification) to support creating issues in Redmine.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'exception_notification-redmine'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install exception_notification-redmine
+
+## Usage
+
+**IMPORTANT:** You must create a custom field named `x_checksum` in your Redmine project for the Redmine notifier to work properly
+
+As of Rails 3 ExceptionNotification-Redmine is used as a rack middleware, or in the environment you want it to run. In most cases you would want ExceptionNotification-Redmine to run on production. Thus, you can make it work by putting the following lines in your `config/environments/production.rb`:
+
+```ruby
+Whatever::Application.config.middleware.use ExceptionNotification::Rack,
+  # host_url: url of your Redmine host
+  # issues_url: issues.json (Redmine REST API)
+  # api_key: the api key of the user that will be used to create the Redmine issue
+  # project_id: create issues in the project with the given id, where id is either project_id or project identifier
+  # tracker_id: create issues with the given tracker_id
+  # assigned_to_id: create issues which are assigned to the given user_id
+  # priority_id: create issues with the given priority_id
+  # status_id: create issues with the given status_id
+  # x_checksum_cf_id: custom field used to avoid creation of the same issue multiple times. You must use the DOM id assigned by Redmine to this field in the issue form. You can find it by creating an issue manually in your project and inspecting the HTML form, you should see something like name="issue[custom_field_values][19]", in this case the id would be 19.
+  
+  :redmine => {
+    :host_url => "http://redmine.example.com",
+    :issues_url => "issues.json",
+    :api_key => "123456",
+    :project_id => "test-project",
+    :tracker_id => "1", # Bug
+    :assigned_to_id => "123",
+    :priority_id => "6", # Urgent
+    :status_id => "1", # New
+    :x_checksum_cf_id => "19" # DOM id in Redmine issue form
+  }
+```
+## Contributing
+
+1. Fork it ( https://github.com/Nuxos-Asia/exception_notification-redmine/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/TODO.md

@@ -0,0 +1 @@
+- improve formatting of issue description

data/exception_notification-redmine.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'exception_notification/redmine/version'
+
+Gem::Specification.new do |s|
+  s.name = 'exception_notification-redmine'
+  s.version       = ExceptionNotification::Redmine::VERSION
+  s.authors = ["Richard Piacentini", "Suttipong Wisittanakorn"]
+  s.date = "2014-10-28"
+  s.summary = "This gem add a Redmine notifier to Exception Notification"
+  s.description = "This Ruby gem is an extension of the exception_notification gem to support creating issues in Redmine"
+  s.homepage = "https://github.com/Nuxos-Asia/exception_notification-redmine"
+  s.email = ["richard.piacentini@nuxos.asia", "safe@nuxos.asia"]
+  s.license = "MIT"
+
+  s.post_install_message = "*** Please read the README.MD file to setup the Redmine Notifier."
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_dependency("exception_notification", "~> 4.0.1")
+  s.add_dependency("httparty", "~> 0.10.2")
+  s.add_dependency("json", "~> 1.8.1")
+  
+  s.add_development_dependency "bundler", "~> 1.7"
+  s.add_development_dependency "rake", "~> 10.0"
+  
+end

data/lib/exception_notification/redmine.rb

@@ -0,0 +1,2 @@
+# This file exists to support gem autoloading by bundler.
+require 'exception_notifier/redmine'

data/lib/exception_notification/redmine/version.rb

@@ -0,0 +1,5 @@
+module ExceptionNotification
+  module Redmine
+    VERSION = "0.1.1"
+  end
+end

data/lib/exception_notifier/redmine.rb

@@ -0,0 +1 @@
+require 'exception_notifier/redmine/redmine'

data/lib/exception_notifier/redmine/redmine.rb

@@ -0,0 +1,81 @@
+require 'action_dispatch'
+require 'httparty'
+require 'json'
+
+module ExceptionNotifier
+  
+  class RedmineNotifier
+
+    def initialize(config)
+      @config = config
+    end
+
+    def call(exception, options={})
+      env = options[:env]
+      issue = compose_issue(options, exception)
+      create_issue(issue) unless issue_exist?(issue)
+    end
+
+    private
+
+    def compose_issue(options, exception)
+      env = options[:env]
+
+      unless env.nil?
+        options[:body] ||= {}
+        options[:body][:server] = Socket.gethostname
+        options[:body][:process] = $$
+        options[:body][:rails_root] = Rails.root if defined?(Rails)
+        options[:body][:exception] = { :error_class => exception.class.to_s,
+                                       :message => exception.message.inspect,
+                                       :backtrace => exception.backtrace }
+        options[:body][:data] = (env['exception_notifier.exception_data'] || {}).merge(options[:data] || {})
+
+        issue = {}
+        issue[:project_id] = @config[:project_id]
+        issue[:tracker_id] = @config[:tracker_id]
+        issue[:status_id] = @config[:status_id]
+        issue[:priority_id] = @config[:priority_id]
+        issue[:assigned_to_id] = @config[:assigned_to_id]
+        issue[:subject] = compose_subject(options, exception)
+        issue[:custom_fields] = [{ :id    => @config[:x_checksum_cf_id],
+                                   :value => encode_subject(issue[:subject])}]
+        issue[:description] = options[:body][:exception].inspect
+        issue
+      end
+    end
+
+    def compose_subject(options, exception)
+      env = options[:env]
+      kontroller = env['action_controller.instance'] || MissingController.new
+      subject = "#{kontroller.controller_name}##{kontroller.action_name}" if kontroller
+      subject << " (#{exception.class})"
+      subject << " #{exception.message.inspect}" if options[:verbose_subject]
+      subject.length > 120 ? subject[0...120] + "..." : subject
+    end
+
+    def issues_url(params = {})
+      default_params = { :key => @config[:api_key] }
+      encoded_params = URI.encode_www_form(default_params.merge(params))
+      "#{@config[:host_url]}/#{@config[:issues_url]}?#{encoded_params}"
+    end
+
+    def create_issue(issue)
+      options = { :body => { :issue => issue }.to_json,
+                  :headers => { "Content-Type" => "application/json" } }
+      response = ::HTTParty.send(:post, issues_url, options)
+    end
+
+    def issue_exist?(issue)
+      x_checksum = issue[:custom_fields][0][:value]
+      response = ::HTTParty.send(:get, issues_url("project_id" => @config[:project_id],
+                                                  "cf_#{@config[:x_checksum_cf_id]}" => x_checksum))
+      raise "Unexpected Response" if response.nil? || response["total_count"].nil?
+      response["total_count"] > 0
+    end
+
+    def encode_subject(subject)
+      Digest::SHA2.hexdigest(subject)
+    end
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: exception_notification-redmine
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Richard Piacentini
+- Suttipong Wisittanakorn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: exception_notification
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: This Ruby gem is an extension of the exception_notification gem to support
+  creating issues in Redmine
+email:
+- richard.piacentini@nuxos.asia
+- safe@nuxos.asia
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- TODO.md
+- exception_notification-redmine.gemspec
+- lib/exception_notification/redmine.rb
+- lib/exception_notification/redmine/version.rb
+- lib/exception_notifier/redmine.rb
+- lib/exception_notifier/redmine/redmine.rb
+homepage: https://github.com/Nuxos-Asia/exception_notification-redmine
+licenses:
+- MIT
+metadata: {}
+post_install_message: "*** Please read the README.MD file to setup the Redmine Notifier."
+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.2.2
+signing_key: 
+specification_version: 4
+summary: This gem add a Redmine notifier to Exception Notification
+test_files: []