rocketchat-notifier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2622333fc371bf6c54a450b70e734d56b7fc3142
+  data.tar.gz: 5439f80607a681fec869800b553737706ce33757
+SHA512:
+  metadata.gz: 4f81b6b012edcd7827d3918d06a2e1141ae4ad01a3601bcca34136b09d3ebe117de7a439ff0244de504bcb2267aad70142168007123313fd37b7b88b7dff5988
+  data.tar.gz: e9fa86df1e7d662550bb33b32b6f403f2fb22dd18e537a0412d64f2efe82261d05eacb9d31e8e6216120f3705cbcb9022b2e04ad4c790befe42f18f4f21b07ed

data/.gitignore

@@ -0,0 +1,42 @@
+*.rbc
+capybara-*.html
+.rspec
+/log
+/tmp
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+/coverage/
+/spec/tmp
+**.orig
+rerun.txt
+pickle-email-*.html
+
+# TODO Comment out these rules if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+config/secrets.yml
+
+# dotenv
+# TODO Comment out this rule if environment variables can be committed
+.env
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalize the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv
+
+# Ignore Byebug command history file.
+.byebug_history

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at christoph@bajohr.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    rocketchat-notifier (0.1.0)
+      httparty (~> 0.13.7, >= 0.13.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httparty (0.13.7)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.3)
+    minitest (5.9.1)
+    multi_xml (0.5.5)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.13)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  rocketchat-notifier!
+
+BUNDLED WITH
+   1.13.6

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Christoph Bajohr
+
+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,116 @@
+# Rocket.Chat Notifier Gem
+rocket.chat notifier gem, for firing event notifications to a rocket chat incoming webhook.
+
+## Installation
+
+Add this line to your application's *Gemfile*:
+
+```ruby
+gem 'rocket-chat-notifier'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rocket-chat-notifier
+
+create an initializer config *rocket-chat-notifier.rb* to *config/initializers/* and add the following content and add your webhook url:
+
+```ruby
+RocketChatNotifier.configure do |config|
+  # replace webhook_url with your incoming rocket chat webhook url
+  config.webhook_url = "https://my.rocket.chat/hook/WEBHOOK-TOKEN"
+
+  # enable verbose debug information with the following line | default: false
+  # config.verbose_mode = true
+end
+```
+
+And you are ready to go
+
+## Usage
+
+Fire a notification with: `RocketChatNotifier.notify "my message"`
+
+Optional parameters:
+* emoji: set a avatar emoji (`ok`, or `smile` e.g.)
+* event: set a eventname (will be shown as "username" in rocket.chat)
+* attachment: set an attachment hash. Example:
+```ruby
+  {
+    "title": "Rocket.Chat",
+    "title_link": "https://rocket.chat",
+    "text": "Rocket.Chat, the best open source chat",
+    "image_url": "https://rocket.chat/images/mockup.png",
+    "color": "#764FA5"
+  }
+```
+
+Use the optional parameters as named parameters.
+
+Example:
+
+```ruby
+RocketChatNotifier.notify 'my message', emoji: 'ok', event: 'my notifier', attachment: {title: 'my att. title', text: 'attachment text', color: '#FF0000'}
+```
+
+Additionally you will need a parser script for your rocket.chat for the incoming webhook integration.
+
+If you don't want to code one yourself, here is a working script with basic functionality for you:
+https://github.com/cbajohr/rocket-chat-notifier/wiki/rocket.chat---incoming-webhook-parser-script-example
+
+
+## Post examples
+
+Example JSON that is pushed by the gem.
+
+Simple:
+```JSON
+{
+  "message": "my message\nwith second line",
+  "event": "my notifier",
+  "emoji": "ok",
+  "attachment": {
+    "title": "my att. title",
+    "text": "attachment text",
+    "color": "#FF0000"
+  }
+}
+```
+
+Extended with some optional parameters:
+```JSON
+{
+  "message": "my message\nwith second line",
+  "event": "my notifier",
+  "emoji": "ok",
+  "attachment": {
+    "title": "my att. title",
+    "text": "attachment text",
+    "color": "#FF0000"
+  }
+}
+```
+
+## ToDos / Roadmap
+
+* unit tests
+* message templates
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cbajohr/rocket-chat-notifier. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rocket/chat/notifier"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rocketchat/notifier.rb

@@ -0,0 +1,42 @@
+require "rocketchat/notifier/version"
+require "httparty"
+
+module RocketChatNotifier
+  class << self
+    attr_accessor :webhook_url, :verbose_mode
+
+    def configure
+      yield self
+
+      raise "\nrocket chat notifier - configuration error: missing `webhook_url` in initializer" unless webhook_url
+    end
+
+    def notify(message, event: '', emoji: '', attachment: [{}])
+      Rails.logger.debug("\nintitializing rocket chat notifier ") if verbose_mode == true
+      raise "\nrocket chat notifier - error: empty rocket chat message, message text is mandatory" unless message
+
+      Rails.logger.debug("\nparsing options: \n  message: `#{message}`\n  event: `#{event}`\n  emoji: `#{emoji}`\n  attachment: `#{attachment}`") if verbose_mode == true
+
+      request_body = {
+        message: message
+      }
+
+      request_body[:event] = event if event.present?
+      request_body[:emoji] = emoji if emoji.present?
+      request_body[:attachment] = attachment if attachment.present?
+
+      begin
+        Rails.logger.debug("\nsending rocket chat notification request to webhook url:\n#{webhook_url}") if verbose_mode == true
+
+        response = JSON.parse HTTParty.post(webhook_url, body: request_body).body
+
+        Rails.logger.debug("\nrocket chat response:\n#{response.inspect}\n") if verbose_mode == true
+        warn("\nrocket chat notifier - warning: rocket chat could not be notified. rocket chat response: `#{response['error']}`") unless response['success'] || response['success'] == true
+      rescue
+        warn("\nrocket chat notifier - warning: could not connect to rocket chat webhook url or parse JSON result, check your webhook_url")
+      end
+
+      response
+    end
+  end
+end

data/lib/rocketchat/notifier/version.rb

@@ -0,0 +1,5 @@
+module RocketChat
+  module Notifier
+    VERSION = "0.1.0"
+  end
+end

data/rocket-chat-notifier.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rocketchat/notifier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rocketchat-notifier"
+  spec.version       = RocketChat::Notifier::VERSION
+  spec.authors       = ["Christoph Bajohr"]
+  spec.email         = ["christoph@bajohr.org"]
+
+  spec.summary       = "rocket.chat notifier gem"
+  spec.description   = "rocket.chat notifier gem, for firing event notifications to a rocket chat incoming webhook. For further information visit the github page: https://github.com/cbajohr/rocketchat-notifier"
+  spec.homepage      = "https://github.com/cbajohr/rocketchat-notifier"
+  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)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_dependency "httparty", "~> 0.13.7", ">= 0.13.7"
+end
+

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: rocketchat-notifier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christoph Bajohr
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+description: 'rocket.chat notifier gem, for firing event notifications to a rocket
+  chat incoming webhook. For further information visit the github page: https://github.com/cbajohr/rocketchat-notifier'
+email:
+- christoph@bajohr.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rocketchat/notifier.rb
+- lib/rocketchat/notifier/version.rb
+- rocket-chat-notifier.gemspec
+homepage: https://github.com/cbajohr/rocketchat-notifier
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+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.6.7
+signing_key: 
+specification_version: 4
+summary: rocket.chat notifier gem
+test_files: []