mina_slack_notify 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9da4af26e463afd7dd12fb075b9e41c506730857
+  data.tar.gz: 940f99745412a35279edc254066f545a8a3b5dea
+SHA512:
+  metadata.gz: 594ecf9ac53cb79dc8319612c19985d27b55f049ccc9f0cd96aefb032181bce66c42cbb1f2688ae074413a76cb489aa7b1dc82d0dcb44a1168d366fabe82f88e
+  data.tar.gz: 1a89726770e3d88eebc5e768617c14cc7623c2e22ea1bf120417f444c60dc7eb300a5d45525150187a9408a07a650c452916b55ae347609f3588646fbf12fa2b

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mina_slack_notify.gemspec
+gemspec
+
+gem 'httparty'

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    mina_slack_notify (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httparty (0.13.7)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.3)
+    multi_xml (0.5.5)
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  httparty
+  mina_slack_notify!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tam Nguyen
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tam Nguyen
+
+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,95 @@
+# MinaSlackNotify
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mina_slack_notify`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mina_slack_notify'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mina_slack_notify
+
+## Usage example
+
+    require 'mina_slack_notify/tasks'
+    ...
+    # Required mina_slack_notify options
+    ...
+    set :application, "app_name"
+    ...
+
+    ...
+    # example: mina deploy env=developmet
+    if !ENV['env'].nil? && ENV['env'] == "production"
+      set :domain, '[ip_or_domain_production]'
+      set :server_name, "production"
+      puts "You are running on producion"
+    else
+      set :domain, '[ip_or_domain_development]'
+      set :server_name, "development"
+      puts "You are running on developmet"
+    end
+    ...
+    set :slack_api_token, 'xxxyyyzzz'
+    set :slack_channels, ['#general', '@mbajur', '#nerd']
+    set :slack_team_domain, 'team_domain'
+    set :slack_author, %x[git config user.email]
+
+    task :deploy do
+      deploy do
+        invoke :'slack:notify_deploy_started'
+        ...
+
+        to :launch do
+          ...
+          invoke :'slack:notify_deploy_finished'
+        end
+      end
+    end
+
+## Available Tasks
+
+* `slack:notify_deploy_started`
+* `slack:notify_deploy_finished`
+
+## Available Options
+
+| Option                    | Description                                                                          |
+| ------------------------- | ------------------------------------------------------------------------------------ |
+| __slack_api_token__       | API auth token.                                                                      |
+| __slack_channels__        | Array of channels (or users) where notifications will be sent to.                    |
+| slack_username            | Name of bot. <br> _default: Deploy_                                                  |
+| slack_author              | Author of a deploy displayed in deploy messages. <br> _default: Someone_             |
+| slack_link_names          | Find and link channel names and usernames. <br> _default: 1_                         |
+| slack_parse               | Change how messages are treated. [Read more] (https://api.slack.com/docs/formatting) <br> _default: full_ |
+| slack_icon_url            | URL to an image to use as the icon for this message <br> _default: nil_ |
+| slack_icon_emoji          | emoji to use as the icon for this message. Overrides `slack_icon_url`. <br> _default: :slack:_ |
+
+__* required options__
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` 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/ntamvl/mina_slack_notify. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mina_slack_notify"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mina_slack_notify/tasks.rb

@@ -0,0 +1,103 @@
+require 'json'
+require 'httparty'
+
+# ## Settings
+# Any and all of these settings can be overriden in your `deploy.rb`.
+
+# ### slack_api_token
+# Sets the slack api auth token.
+set_default :slack_api_token, ''
+set_default :slack_team_domain, ''
+
+# ### slack_channels
+# Sets the channels where notifications will be sent to.
+set_default :slack_channels, []
+
+# ### slack_username
+# Sets the notification 'from' user label
+set_default :slack_username, 'Mina'
+
+# slack_author
+# Sets the deployment author name
+set_default :slack_author, 'Mina'
+
+# ### slack_link_names
+# Sets the deployment author name
+set_default :slack_link_names, 1
+
+# slack_parse
+# Sets the deployment author name
+set_default :slack_parse, 'full'
+
+# icon_url
+# URL to an image to use as the icon for this message
+set_default :slack_icon_url, ''
+
+# icon_emoji
+# Sets emoji to use as the icon for this message. Overrides `slack_icon_url`
+set_default :slack_icon_emoji, ':slack:'
+
+# Control Tasks
+namespace :slack do
+
+  # slack:notify_deploy_started
+  desc "Send slack notification about new deploy start"
+  task :notify_deploy_started => :environment do
+    queue  %[echo "-----> Sending start notification to Slack"]
+    text = "[Deploying] #{slack_author} is deploying #{application} on #{domain}...\n"
+
+    for channel in slack_channels
+      send_message(
+        channel: channel,
+        text:    text
+      )
+    end
+  end
+
+  # slack:notify_deploy_finished
+  desc "Send slack notification about deploy finish"
+  task :notify_deploy_finished => :environment do
+    queue  %[echo "-----> Sending finish notification to Slack"]
+
+    text  = "#{slack_author} finished deploying #{application}."
+    text += " on server #{domain} \n" if domain != nil
+
+    for channel in slack_channels
+      send_message(
+        channel:     channel,
+        text:        text,
+        attachments: attachments
+      )
+    end
+  end
+
+  # slack:notify_deploy_finished
+  desc "Send slack notification about deploying"
+  task :notify_deploying => :environment do
+    queue  %[echo "-----> Sending finish notification to Slack"]
+
+    # text  = "[auto deployment] *#{slack_author}* finished deploying *#{application}*."
+    # text += " on server #{domain} \n" if domain != nil
+    # git_logs = %x[git log --stat]
+
+    git_logs = %x[git log --pretty=format:"%an (%h) %s" -n 5]
+    text = "*#{slack_author.delete!("\n")}* deployed #{application} in #{server_name} (#{domain}) \n"
+    git_logs.each_line do |line|
+      text += "> #{line}"
+    end
+
+    for channel in slack_channels
+      send_message(
+        channel:     channel,
+        text:        text,
+        attachments: attachments
+      )
+    end
+  end
+
+  def send_message(params = {})
+    slack_url = "https://#{slack_team_domain}.slack.com/services/hooks/slackbot?token=#{slack_api_token}&channel=%23#{params[:channel]}"
+    HTTParty.post(slack_url, {body: params[:text]})
+  end
+
+end

data/lib/mina_slack_notify/version.rb

@@ -0,0 +1,3 @@
+module MinaSlackNotify
+  VERSION = "0.1.1"
+end

data/lib/mina_slack_notify.rb

@@ -0,0 +1,5 @@
+require "mina_slack_notify/version"
+
+module MinaSlackNotify
+  # Your code goes here...
+end

data/mina_slack_notify.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mina_slack_notify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mina_slack_notify"
+  spec.version       = MinaSlackNotify::VERSION
+  spec.authors       = ["Tam Nguyen"]
+  spec.email         = ["nguyentamvinhlong@gmail.com"]
+
+  spec.summary       = "Adds tasks to aid in the Slack notifications"
+  spec.description   = "Mina bindings for Slack"
+  spec.homepage      = "https://github.com/ntamvl/mina_slack_notify"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://feels.com'"
+  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 { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "httparty"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: mina_slack_notify
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Tam Nguyen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Mina bindings for Slack
+email:
+- nguyentamvinhlong@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mina_slack_notify.rb
+- lib/mina_slack_notify/tasks.rb
+- lib/mina_slack_notify/version.rb
+- mina_slack_notify.gemspec
+homepage: https://github.com/ntamvl/mina_slack_notify
+licenses:
+- MIT
+metadata: {}
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Adds tasks to aid in the Slack notifications
+test_files: []