slack-incoming-webhooks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e9488331ba45f6066c5fddfd33cff93decc0b3cc
+  data.tar.gz: 8f2c3e47025f193555be8e2b4d41114ce18c44fc
+SHA512:
+  metadata.gz: 67eb4e6be927f15387c05ed3c0a70c3c2d4f620635eb145106e4734561334854c859d3080917cf72ea246d9d58cd0e68d8411b582c1875dd4909084369926cdb
+  data.tar.gz: 5463129c70110bdd2cbf39eda765ba711b231a8b50cff985f88accb840c3e8b8437d132b051dcb3f45a4d27149e6783926b694a115d4bf96f716dcefedbf4a7f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

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, 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,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in slack-incoming-webhooks.gemspec
+gemspec
+
+group :development, :test do
+  gem 'awesome_print'
+  gem 'pry'
+end
+
+group :test do
+  gem 'rspec', '~> 3.3.0'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Shohei Yamasaki
+
+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,109 @@
+# Slack::Incoming::Webhooks
+A simple wrapper for posting to slack.
+
+## Example
+```ruby
+require 'slack-incoming-webhooks'
+
+slack = Slack::Incoming::Webhooks.new "WEBHOOK_URL"
+slack.post "Hello World"
+
+# => if your webhook is setup, will message "Hello World"
+# => to the default channel you set in slack
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slack-incoming-webhooks'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slack-incoming-webhooks
+
+## Usage
+
+### Setting Defaults
+On initialization you can set default payloads by passing an options hash.  
+Options please refer to [incoming-webhooks](https://api.slack.com/incoming-webhooks).
+
+```ruby
+slack = Slack::Incoming::Webhooks.new "WEBHOOK_URL", channel: '#other-channel',
+                                                     username: 'monkey-bot'
+```
+
+Once a notifier has been initialized, you can update the default channel or username or attachments .
+
+```ruby
+slack.channel  = '#other-channel'
+slack.username = 'monkey-bot'
+slack.attachments = { color: '#36a64f',  title: 'Slack API Documentation' }
+```
+
+### Attachments
+It is possible to create more richly-formatted messages using [Attachments](https://api.slack.com/docs/attachments).  
+slack-incoming-webhooks supports Attachments.
+
+```ruby
+attachments = {
+  fallback: "Required plain-text summary of the attachment.",
+  color: "#36a64f",
+  pretext: "Optional text that appears above the attachment block",
+  title: "Slack API Documentation",
+  title_link: "https://api.slack.com/",
+  text: "Optional text that appears within the attachment",
+  image_url: "http://my-website.com/path/to/image.jpg"
+}
+
+slack.post "with an attachment", attachments: [attachments]
+```
+
+or setting defaults.
+
+```ruby
+slack = Slack::Incoming::Webhooks.new "WEBHOOK_URL", attachments: [attachments]
+slack.post "with an attachment"
+```
+
+or attachments method.
+
+```ruby
+slack.attachments = { color: '#36a64f', title: 'Slack API Documentation' }
+```
+## Console
+run `bin/console` for an interactive prompt that will allow you to experiment.
+
+```bash
+$ bin/console
+
+[1] pry(main)> slack = Slack::Incoming::Webhooks.new "WEBHOOK_URL"
+=> #<Slack::Incoming::Webhooks:0x007fae6b871e48
+[2] pry(main)> slack.post "Hello world!"
+=> #<Net::HTTPOK 200 OK readbody=true>
+```
+
+## Testing
+```bash
+$ rspec
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/slack-incoming-webhooks/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 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "slack/incoming/webhooks"
+
+# 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 "pry"
+require "awesome_print"
+Pry.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/slack/incoming/webhooks.rb

@@ -0,0 +1,21 @@
+require "slack/incoming/webhooks/configuration"
+require "slack/incoming/webhooks/connection"
+require "slack/incoming/webhooks/request"
+require "slack/incoming/webhooks/version"
+
+module Slack
+  module Incoming
+    class Webhooks
+      include Configuration
+      include Connection
+      include Request
+
+      attr_accessor :webhook_url, :payload
+
+      def initialize(webhook_url, payload={})
+        @webhook_url = webhook_url
+        @payload     = payload
+      end
+    end
+  end
+end

data/lib/slack/incoming/webhooks/configuration.rb

@@ -0,0 +1,29 @@
+module Slack
+  module Incoming
+    module Configuration
+      def channel
+        payload[:channel]
+      end
+
+      def channel= channel
+        payload[:channel] = channel
+      end
+
+      def username
+        payload[:username]
+      end
+
+      def username= username
+        payload[:username] = username
+      end
+
+      def attachments
+        payload[:attachments]
+      end
+
+      def attachments= attachments
+        payload[:attachments] = [attachments]
+      end
+    end
+  end
+end

data/lib/slack/incoming/webhooks/connection.rb

@@ -0,0 +1,18 @@
+require 'net/http'
+require 'net/https'
+require 'uri'
+
+module Slack
+  module Incoming
+    module Connection
+      def connection
+        uri = URI.parse(webhook_url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        http.ssl_version = :TLSv1
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        http
+      end
+    end
+  end
+end

data/lib/slack/incoming/webhooks/request.rb

@@ -0,0 +1,15 @@
+require 'uri'
+require 'json'
+
+module Slack
+  module Incoming
+    module Request
+      def post message, options={}
+        uri = URI.parse(webhook_url)
+        req = Net::HTTP::Post.new(uri.request_uri)
+        req.set_form_data(payload: payload.merge(options).merge(text: message).to_json)
+        connection.request(req)
+      end
+    end
+  end
+end

data/lib/slack/incoming/webhooks/version.rb

@@ -0,0 +1,7 @@
+module Slack
+  module Incoming
+    class Webhooks
+      VERSION = "0.1.0"
+    end
+  end
+end

data/slack-incoming-webhooks.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slack/incoming/webhooks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slack-incoming-webhooks"
+  spec.version       = Slack::Incoming::Webhooks::VERSION
+  spec.authors       = ["Shohei Yamasaki"]
+  spec.email         = ["s-yamasaki@pepabo.com"]
+
+  spec.summary       = %q{A simple wrapper for posting to slack.}
+  spec.description   = %q{A simple wrapper for posting to slack.}
+  spec.homepage      = "https://github.com/shoyan/slack-incoming-webhooks"
+  spec.license       = "MIT"
+
+  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.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: slack-incoming-webhooks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shohei Yamasaki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: A simple wrapper for posting to slack.
+email:
+- s-yamasaki@pepabo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/slack/incoming/webhooks.rb
+- lib/slack/incoming/webhooks/configuration.rb
+- lib/slack/incoming/webhooks/connection.rb
+- lib/slack/incoming/webhooks/request.rb
+- lib/slack/incoming/webhooks/version.rb
+- slack-incoming-webhooks.gemspec
+homepage: https://github.com/shoyan/slack-incoming-webhooks
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A simple wrapper for posting to slack.
+test_files: []