asana_exception_notifier 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 280cdf0b6dca9817e839af8680186847618fb62d
+  data.tar.gz: e762aa0e5e07af7636be397bb0e2595e0a880d48
+SHA512:
+  metadata.gz: 40d1ae01172fea7925e49ddeb897584fdf295816739666a0fe1b4ccb2733287c685a193e20c7f1e943fabd7bf852d1994ae68ab78b5ce8ae3b731251a85d7ffe
+  data.tar.gz: 5cca1aa0d350e023d82ad406b4a05b0393071655f3126aef6809020cdff25567636734124803b36cab9a0bea94235d3733d3296a681bf6e684579380e7b11aca

data/.codeclimate.yml

@@ -0,0 +1,26 @@
+---
+engines:
+  bundler-audit:
+    enabled: false
+  csslint:
+    enabled: false
+  eslint:
+    enabled: false
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - Gemfile.lock
+  - "**.css"
+  - "**.js"
+  - "**.jsx"
+  - "**.rb"
+exclude_paths:
+- spec/**/*
+- examples/**/*
+- test/**/*
+- vendor/**/*
+- bin/**/*
+- .codeclimate.yml

data/.reek

@@ -0,0 +1,11 @@
+---
+Attribute:
+  enabled: false
+TooManyInstanceVariables:
+  enabled: false
+TooManyMethods:
+  enabled: false
+UtilityFunction:
+  enabled: false
+exclude_paths:
+  - examples

data/.rubocop.yml

@@ -0,0 +1,76 @@
+AllCops:
+  Exclude:
+    - washout_builder.gemspec
+    - bin/**/*
+    - Guardfile
+    - vendor/**/*
+    - examples/**/*
+  TargetRubyVersion: 2.1
+
+ClassLength:
+  Max: 500
+
+ModuleLength:
+  Max: 500
+
+Documentation:
+  Enabled: true
+
+Encoding:
+  Enabled: false
+
+LineLength:
+  Max: 200
+
+AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+IfUnlessModifier:
+  Enabled: false
+
+CaseIndentation:
+  IndentWhenRelativeTo: case
+  IndentOneStep: true
+
+MethodLength:
+  CountComments: false
+  Max: 20
+
+SignalException:
+  Enabled: false
+
+ColonMethodCall:
+  Enabled: false
+
+AsciiComments:
+  Enabled: false
+
+RegexpLiteral:
+  Enabled: false
+
+AssignmentInCondition:
+  Enabled: false
+
+ParameterLists:
+  CountKeywordArgs: false
+
+SingleLineBlockParams:
+  Methods:
+    - reduce:
+      - memo
+      - item
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/CollectionMethods:
+  Enabled: true
+
+Style/SymbolArray:
+  Enabled: true
+
+Style/ExtraSpacing:
+  Enabled: true
+
+Style/FileName:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,16 @@
+sudo: false
+cache: bundler
+language: ruby
+before_install:
+  - "echo 'gem: --no-ri --no-rdoc' > ~/.gemrc"
+  - gem install bundler
+rvm:
+- 1.9.3
+- 2.0.0
+- 2.1.5
+- 2.2.2
+- 2.2.3
+env:
+ - RAILS_ENV=test RACK_ENV=test
+notifications:
+  email: false

data/CONTRIBUTING.md

@@ -0,0 +1,46 @@
+Contributing
+============
+
+We love pull requests. Here's a quick guide.
+
+Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+
+Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+
+Fork, then clone the repo:
+
+```
+git clone git@github.com:your-username/asana_exception_notifier.git
+```
+
+Start a feature/bugfix branch.
+
+Set up your machine:
+
+```
+bundle install
+```
+
+Make sure the tests pass:
+
+```
+bundle exec rake
+```
+
+Make your change. Add tests for your change. Make the tests pass:
+
+```
+bundle exec rake
+```
+
+Push to your fork and [submit a pull request](https://github.com/bogdanRada/asana_exception_notifier/compare).
+
+At this point you're waiting on us. We like to at least comment on pull requests within three business days (and, typically, one business day). We may suggest some changes or improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted:
+
+-	Write tests.
+-	Try to follow this [style guide](https://github.com/thoughtbot/guides/tree/master/style).
+-	Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+
+Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,180 @@
+PATH
+  remote: .
+  specs:
+    asana_exception_notifier (0.0.1)
+      activesupport (>= 4.0, < 5)
+      em-http-request (~> 1.1, >= 1.1.2)
+      eventmachine (~> 1.0, >= 1.0.7)
+      exception_notification (~> 4.1, >= 4.1.4)
+      multipart_body (~> 0.2, >= 0.2.1)
+      rack (~> 1.6, >= 1.6)
+      rubyzip (~> 1.0, >= 1.0.0)
+      sys-uname (~> 1.0, >= 1.0.2)
+      tilt (>= 1.4, < 3)
+      zip-zip (~> 0.3, >= 0.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (4.2.5.1)
+      actionpack (= 4.2.5.1)
+      actionview (= 4.2.5.1)
+      activejob (= 4.2.5.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.5.1)
+      actionview (= 4.2.5.1)
+      activesupport (= 4.2.5.1)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.5.1)
+      activesupport (= 4.2.5.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.5.1)
+      activesupport (= 4.2.5.1)
+      globalid (>= 0.3.0)
+    activesupport (4.2.5.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.4.0)
+    builder (3.2.2)
+    coderay (1.1.0)
+    colored (1.2)
+    cookiejar (0.3.0)
+    coveralls (0.8.10)
+      json (~> 1.8)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.11.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    domain_name (0.5.25)
+      unf (>= 0.0.5, < 1.0.0)
+    em-http-request (1.1.3)
+      addressable (>= 2.3.4)
+      cookiejar (<= 0.3.0)
+      em-socksify (>= 0.3)
+      eventmachine (>= 1.0.3)
+      http_parser.rb (>= 0.6.0)
+    em-socksify (0.3.1)
+      eventmachine (>= 1.0.0.beta.4)
+    erubis (2.7.0)
+    eventmachine (1.0.9.1)
+    exception_notification (4.1.4)
+      actionmailer (~> 4.0)
+      activesupport (~> 4.0)
+    ffi (1.9.10)
+    github-markup (1.4.0)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    http_parser.rb (0.6.0)
+    i18n (0.7.0)
+    inch (0.7.0)
+      pry
+      sparkr (>= 0.2.0)
+      term-ansicolor
+      yard (~> 0.8.7.5)
+    json (1.8.3)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    method_source (0.8.2)
+    mime-types (2.99)
+    mini_portile2 (2.0.0)
+    minitest (5.8.4)
+    multipart_body (0.2.1)
+    netrc (0.11.0)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    rake (10.5.0)
+    redcarpet (3.3.4)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    rubyzip (1.1.7)
+    simplecov (0.11.1)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    simplecov-summary (0.0.4)
+      colored
+      simplecov
+    slop (3.6.0)
+    sparkr (0.4.1)
+    sys-uname (1.0.2)
+      ffi (>= 1.0.0)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tilt (2.0.2)
+    tins (1.6.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
+    yard (0.8.7.6)
+    zip-zip (0.3)
+      rubyzip (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  asana_exception_notifier!
+  coveralls (~> 0.7, >= 0.7)
+  github-markup (~> 1.3, >= 1.3.3)
+  inch (~> 0.6, >= 0.6)
+  rake (~> 10.5, >= 10.5)
+  redcarpet (~> 3.3, >= 3.3)
+  rspec (~> 3.4, >= 3.4)
+  simplecov (~> 0.10, >= 0.10)
+  simplecov-summary (~> 0.0.4, >= 0.0.4)
+  yard (~> 0.8, >= 0.8.7)
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2016 bogdanRada
+
+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,225 @@
+asana_exception_notifier
+========================
+
+[![Gem Version](https://badge.fury.io/rb/asana_exception_notifier.svg)](http://badge.fury.io/rb/asana_exception_notifier) [![Gem Downloads](https://ruby-gem-downloads-badge.herokuapp.com/asana_exception_notifier?type=total)](https://github.com/bogdanRada/asana_exception_notifier) [![Analytics](https://ga-beacon.appspot.com/UA-72570203-1/bogdanRada/asana_exception_notifier)](https://github.com/bogdanRada/asana_exception_notifier)
+
+Description
+-----------
+
+Simple ruby implementation to send notifications to Asana when a exception happens in Rails or Rack-based apps by creating a task and uploading exception details to the task
+
+The gem provides a notifier for sending notifications to Asana when errors occur in a Rack/Rails application [courtesy of exception_notifications gem](https://github.com/smartinez87/exception_notifications). Check out that gem for more details on setting up the rack middleware with additional options.
+
+Requirements
+------------
+
+-	Ruby 2.0 or greater
+-	Rails 4.0 or greater, Sinatra or another Rack-based application.
+
+Dependencies
+------------
+
+1.	[ActiveSuport > 4.0](https://rubygems.org/gems/activesupport)
+2.	[em-http-request >= 1.1.0](https://github.com/igrigorik/em-http-request)
+3.	[eventmachine >= 1.0.7](https://github.com/eventmachine/eventmachine)
+4.	[exception_notification >= 4.1.4](https://github.com/smartinez87/exception_notification)
+5.	[multipart_body >= 0.2.1](https://github.com/cloudmailin/multipart_body)
+6.	[tilt >= 1.4](https://github.com/rtomayko/tilt/)
+7.	[rack >= 1.6](http://rack.github.io/)
+8.	[rubyzip >= 1.0.0](https://github.com/rubyzip/rubyzip)
+9.	[zip-zip >= 0.3](https://github.com/orien/zip-zip)
+10.	[sys-uname >= 1.0.2](https://github.com/djberg96/sys-uname)
+
+Installation Instructions
+-------------------------
+
+Add the following to your Gemfile :
+
+```ruby
+  gem "asana_exception_notifier"
+```
+
+#### Options: For more options to this check [here](https://asana.com/developers/api-reference/tasks)
+
+##### asana_api_key
+
+*String, required*
+
+Your Personal Access Token from Asana. You can get it from [here](https://app.asana.com/-/account_api). Please make sure you keep the token secret, and don't commit it in your repository. I suggest to put it into an environment variable and use it from that variable.
+
+##### workspace
+
+*Integer, required*
+
+The workspace ID where the task will be created.
+
+**If you don't supply the workspace or the asana_api_key flags , the notifier will not run!!!**
+
+##### assignee
+
+*String, optional*
+
+Who will be assigned by default to the task that is going to be created. (Default: 'me'). Can be disabled by setting it to NIL value
+
+##### assignee_status
+
+*String, optional*
+
+Scheduling status of this task for the user it is assigned to. This field can only be set if the assignee is non-null. (Default: 'today'). Can be disabled by setting it to NIL value.
+
+##### due_at
+
+*Time, optional*
+
+Date and time on which this task is due, or null if the task has no due time. This takes a UTC timestamp and should not be used together with due_on. Default ( Time.now.iso8601)
+
+##### due_on
+
+*Time, optional*
+
+Date on which this task is due, or null if the task has no due date. This takes a date with YYYY-MM-DD format and should not be used together with due_at
+
+##### hearted
+
+*Boolean, optional*
+
+True if the task is hearted by the authorized user, false if not (Default: false).
+
+##### hearts
+
+*Array, optional*
+
+Array of users who will heart the task after creation. (Default: []).
+
+##### projects
+
+*Array, optional*
+
+Array of projects this task is associated with. At task creation time, this array can be used to add the task to many projects at once.(Default: []).
+
+##### followers
+
+*Array, optional*
+
+Array of users following this task. (Default: []).
+
+##### memberships
+
+*Array, optional*
+
+Array of projects this task is associated with and the section it is in. At task creation time, this array can be used to add the task to specific sections.Note that over time, more types of memberships may be added to this property.(Default: []).
+
+##### tags
+
+*Array, optional*
+
+Array of tags associated with this task. This property may be specified on creation using just an array of existing tag IDs. (Default: false).
+
+##### name
+
+*String, optional*
+
+Name of the task. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer. (Default: "[AsanaExceptionNotifier] %Exception Class Name%").
+
+##### notes
+
+*String, optional*
+
+More detailed, free-form textual information associated with the task. (Default: '')
+
+##### template_path
+
+*Array, optional*
+
+This can be used to override the default template when rendering the exception details with customized template.
+
+### Rails
+
+If you are settting up for the first time this gem, just run the following command from the terminal:
+
+```
+rails g asana_exception_notifier:install
+```
+
+This command generates an initialize file (`config/initializers/asana_exception_notifier.rb`) where you can customize your configurations.
+
+Make sure the gem is not listed solely under the `production` group, since this initializer will be loaded regardless of environment.
+
+AsanaExceptionNotifier is used as a rack middleware, or in the environment you want it to run. In most cases you would want AsanaExceptionNotifier to run on production. Thus, you can make it work by putting the following lines in your `config/environments/production.rb`:
+
+```ruby
+Rails.application.config.middleware.use ExceptionNotification::Rack
+```
+
+### Rack/Sinatra
+
+In order to use ExceptionNotification with Sinatra, please take a look in the [example application](https://github.com/smartinez87/exception_notification/tree/master/examples/sinatra).
+
+Background Notifications
+------------------------
+
+If you want to send notifications from a background process like DelayedJob, you should use the `notify_exception` method like this:
+
+```ruby
+begin
+  some code...
+rescue => exception
+  ExceptionNotifier.notify_exception(exception, notifiers: :asana)
+end
+```
+
+You can include information about the background process that created the error by including a data parameter:
+
+```ruby
+begin
+  some code...
+rescue => exception
+  ExceptionNotifier.notify_exception(exception,
+    :data => {:worker => worker.to_s, :queue => queue, :payload => payload}, notifiers: :asana)
+end
+```
+
+### Manually notify of exception
+
+If your controller action manually handles an error, the notifier will never be run. To manually notify of an error you can do something like the following:
+
+```ruby
+rescue_from Exception, :with => :server_error
+
+def server_error(exception)
+  # Whatever code that handles the exception
+
+  ExceptionNotifier.notify_exception(exception,
+    :env => request.env, :data => {:message => "was doing something wrong"}, notifiers: :asana)
+end
+```
+
+Testing
+-------
+
+To test, do the following:
+
+1.	cd to the gem root.
+2.	bundle install
+3.	bundle exec rake
+
+Contributions
+-------------
+
+Please log all feedback/issues via [Github Issues](http://github.com/bogdanRada/asana_exception_notifier/issues). Thanks.
+
+Contributing to asana_exception_notifier
+----------------------------------------
+
+-	Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+-	Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+-	Fork the project.
+-	Start a feature/bugfix branch.
+-	Commit and push until you are happy with your contribution.
+-	Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+-	Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+-	You can read more details about contributing in the [Contributing](https://github.com/bogdanRada/asana_exception_notifier/blob/master/CONTRIBUTING.md) document
+
+== Copyright
+
+Copyright (c) 2016 bogdanRada. See LICENSE.txt for further details.