slack-incoming-webhooks-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 886b5fb87d395fdf7bd11b27e9b2b7b0a3535386
+  data.tar.gz: 6827c2d8a7caa6095dc41c28dbdbf7e772407e45
+SHA512:
+  metadata.gz: c9dc74c378f48044f4928049d05d4c3e1686f0cb4862ca3c312ac57d6a28de8884fe5d400b559c7fedcf222db0f218982187c5e9a309e1ce3656a879a15721d3
+  data.tar.gz: 25f9417ae2ee65af07af27b4ea15caa27c5f16ccede49c425366dcf416367bb3064d311031bc5e47c7a5efd288a51b37057f5240cba359d861510d158b2b48c8

data/.gitignore

@@ -0,0 +1,64 @@
+# 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
+
+# rspec failure tracking
+.rspec_status
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+var/
+etc/
+
+# 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
+
+# mac
+.DS_Store

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,19 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+cache: bundler
+git:
+  submodules: false
+before_install:
+  - gem update --system
+  - gem update bundler
+script:
+  - bundle exec rake spec
+after_success:
+  - echo "success"
+after_failure:
+  - echo "failure"
+notifications:
+  slack:
+    secure: gPy0UwXMT/GSRQFyyADs+8kQqLLDdCYi4uTcnUYNIcOgp8L+0t6DCZOKE9uaJZJLfr2RWdOMDjBkLp7UL5hpvwQKu7dBrzLa71HDudIKTQHuGEOfpTL1/x/HU36EPJAIrsRZK8c0f4wF3YJsxMMWtosMCUFe1rGb9uQMvDSUkwwYwcHRltrWIHuUazmLso4oezEkSyWM5v2z9C3BSZWf2v6l1I57j1n3EzHUn5GSabyDPFlWU/s12LPzsdOozQCzEqzmE+3imly0Fnz08w1rpwMdis+PrZIJ3Dj8BpLls/PqMTMeYaSqIm8G4Js2LlM34HJKYAWu+DfXYUy35I6fLSbH/jR3knF24Ohio6B4UNWj/Hv/Nc0EEpixcz3K4Fpm3OToiB2MGKl7ErPkWF4iLW4c6aFePg07pHR+8lyLHK/PJi8JRwzXB44q1Hf5Z1Q7z6zee6aupGK097nTUEE06/2Y3FK5qzKOTEFOZ2+U4dkTwiUUmGnEHy9teztdPAd3cH9vCicaFWQqaU/+n/P/zEEDC6q3kya9ZMdibGCRYnkFkcMkLuiqNivCL4o1LBTzC8nQFohwoa+JYB7SIpZkyIZOmV+HqQYBjL5vMW4cOLNzNVIT62oFoEIws8810On3r7i5N2OlJfy67Mj67go8VghBuCeQZCvn+OJ8tUoVauA=

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 n.h.in.m.h@gmail.com. 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 slack-incoming-webhooks-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 naoto0822
+
+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,108 @@
+# slack-incoming-webhooks-ruby
+
+[![Build Status](https://travis-ci.org/naoto0822/slack-incoming-webhooks-ruby.svg?branch=master)](https://travis-ci.org/naoto0822/slack-incoming-webhooks-ruby)
+
+Ruby Client of Slack Incoming webhooks.
+
+About Slack incoming-webhooks
+- [slack incoming webhooks](https://api.slack.com/incoming-webhooks)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slack-incoming-webhooks-ruby'
+```
+
+## Usage
+
+### Setting Incoming webhooks
+
+Start by setting up an [incoming webhook integration](https://my.slack.com/services/new/incoming-webhook/) in your Slack team.
+
+### Post to slack
+
+#### normal post
+
+```ruby
+require 'slack-incoming-webhooks-ruby'
+
+url = ENV['SLACK_WEBHOOK_URL']
+slack = Slack::IncomingWebhooks::Client.new(url)
+
+payload = Slack::Messages::Payload.new
+payload.text = 'sample text'
+slack.post(payload)
+```
+
+![normal](./images/normal.png)
+
+#### with attachment
+
+```ruby
+require 'slack-incoming-webhooks-ruby'
+
+url = ENV['SLACK_WEBHOOK_URL']
+slack = Slack::IncomingWebhooks::Client.new(url)
+payload = Slack::Messages::Payload.new
+attachment = Slack::Messages::Attachment.new
+attachment.fallback = 'sample fallback'
+attachment.color = 'good'
+attachment.title = 'sample title'
+attachment.footer = 'from sample'
+payload.attachments = [attachment]
+
+slack.post(payload)
+```
+
+![attachment](./images/attachment.png)
+
+#### with field
+
+```ruby
+require 'slack-incoming-webhooks-ruby'
+
+url = ENV['SLACK_WEBHOOK_URL']
+slack = Slack::IncomingWebhooks::Client.new(url)
+payload = Slack::Messages::Payload.new
+attachment = Slack::Messages::Attachment.new
+attachment.fallback = 'sample fallback'
+attachment.color = 'good'
+attachment.title = 'sample title'
+attachment.footer = 'from sample'
+
+field = Slack::Messages::Field.new
+field.title = "sample field"
+field.value = 'http://github.com'
+
+field2 = Slack::Messages::Field.new
+field2.title = "sample field2"
+field2.value = 'http://github2.com'
+
+attachment.fields = [field, field2]
+payload.attachments = [attachment]
+
+slack.post(payload)
+```
+
+![field](./images/field.png)
+
+## TODO
+
+- [ ] spec
+- [ ] CI
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Slack::IncomingWebhooks::Client project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/naoto0822/slack-incoming-webhooks-ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "slack-incoming-webhooks-ruby"
+
+# 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(__FILE__)

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/examples/post.rb

@@ -0,0 +1,24 @@
+require 'slack-incoming-webhooks-ruby'
+
+url = ENV['SLACK_WEBHOOK_URL']
+slack = Slack::IncomingWebhooks::Client.new(url)
+payload = Slack::Messages::Payload.new
+# payload.text = 'sample text'
+attachment = Slack::Messages::Attachment.new
+attachment.fallback = 'sample fallback'
+attachment.color = 'good'
+attachment.title = 'sample title'
+attachment.footer = 'from sample'
+
+field = Slack::Messages::Field.new
+field.title = "sample field"
+field.value = 'http://github.com'
+
+field2 = Slack::Messages::Field.new
+field2.title = "sample field2"
+field2.value = 'http://github2.com'
+
+attachment.fields = [field, field2]
+payload.attachments = [attachment]
+
+slack.post(payload)

data/lib/slack-incoming-webhooks-ruby.rb

@@ -0,0 +1,15 @@
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'json'
+
+require 'slack/version'
+require 'slack/incoming_webhooks/client'
+
+Dir[File.dirname(__FILE__) + '/slack/messages/**/*.rb'].each do |file|
+  require file
+end
+
+Dir[File.dirname(__FILE__) + '/slack/http/**/*.rb'].each do |file|
+  require file
+end

data/lib/slack/http/connection.rb

@@ -0,0 +1,29 @@
+module Slack
+module Http
+  class Connection
+    def self.send(url, payload)
+      if url.nil? || payload.nil? || payload.empty?
+        msg = 'error: url or payload is nil.'
+        return Result.new(msg: msg)
+      end
+
+      res = request(url, payload)
+      Result.new(code: res.code, msg: res.message,
+                 header: res.header, body: res.body)
+    end
+
+    def self.request(url, payload)
+      uri = URI.parse(url)
+      req = Net::HTTP::Post.new(uri.path)
+      req.set_form_data(payload: payload.to_json)
+      res = Net::HTTP.start(uri.host, uri.port,
+                            use_ssl: uri.scheme == 'https') { |http|
+        http.open_timeout = 5
+        http.read_timeout = 5
+        http.request(req)
+      }
+      res
+    end
+  end
+end
+end

data/lib/slack/http/result.rb

@@ -0,0 +1,13 @@
+module Slack
+module Http
+  class Result
+    attr_reader :code, :msg, :header, :body
+    def initialize(code: nil, msg: nil, header: nil, body: nil)
+      @code = code
+      @msg = msg
+      @header = header
+      @body = body
+    end
+  end # Result
+end # Http
+end # Slack

data/lib/slack/incoming_webhooks/client.rb

@@ -0,0 +1,13 @@
+module Slack
+module IncomingWebhooks
+  class Client
+    def initialize(url)
+      @url = url
+    end
+
+    def post(payload)
+      Slack::Http::Connection.send(@url, payload.to_params)
+    end
+  end # Client
+end # IncomingWebhooks
+end # Slack

data/lib/slack/messages/attachment.rb

@@ -0,0 +1,39 @@
+module Slack
+module Messages
+  class Attachment
+    ATTACHMENT_PARAMS = %i[
+      fallback
+      color
+      pretext
+      author_name
+      author_link
+      author_icon
+      title
+      title_link
+      text
+      fields
+      image_url
+      thumb_url
+      footer
+      footer_icon
+      ts
+    ].freeze
+
+    attr_accessor *ATTACHMENT_PARAMS
+
+    def to_params
+      params = {}
+      ATTACHMENT_PARAMS.each { |p|
+        if "#{p}" == 'fields'
+          fields = []
+          @fields.each { |f| fields.push(f.to_params) } unless @fields.nil?
+          params['fields'] = fields
+          next
+        end
+        params["#{p}"] = send(p) unless send(p).nil?
+      }
+      params
+    end
+  end # Attachment
+end # Messages
+end # Slack

data/lib/slack/messages/field.rb

@@ -0,0 +1,21 @@
+module Slack
+module Messages
+  class Field
+    FIELD_PARAMS = %i[
+      title
+      value
+      short
+    ].freeze
+
+    attr_accessor *FIELD_PARAMS
+
+    def to_params
+      params = {}
+      FIELD_PARAMS.each { |p|
+        params["#{p}"] = send(p) unless send(p).nil?
+      }
+      params
+    end
+  end # Field
+end # Messages
+end # Slack

data/lib/slack/messages/payload.rb

@@ -0,0 +1,37 @@
+module Slack
+module Messages
+  class Payload
+    PAYLOAD_PARAMS = %i[
+      channel
+      text
+      parse
+      link_names
+      attachments
+      unfurl_links
+      unfurl_media
+      username
+      as_user
+      icon_url
+      icon_emoji
+      thread_ts
+      reply_broadcast
+    ].freeze
+
+    attr_accessor *PAYLOAD_PARAMS
+
+    def to_params
+      params = {}
+      PAYLOAD_PARAMS.each { |p|
+        if "#{p}" == 'attachments'
+          attachments = []
+          @attachments.each { |a| attachments.push(a.to_params) } unless @attachments.nil?
+          params['attachments'] = attachments unless attachments.empty?
+          next
+        end
+        params["#{p}"] = send(p) unless send(p).nil?
+      }
+      params
+    end
+  end # Payload
+end # Messages
+end # Slack

data/lib/slack/version.rb

@@ -0,0 +1,3 @@
+module Slack
+  VERSION = "0.1.0"
+end

data/slack-incoming-webhooks-ruby.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "slack/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "slack-incoming-webhooks-ruby"
+  spec.version       = Slack::VERSION
+  spec.authors       = ["naoto0822"]
+  spec.email         = ["n.h.in.m.h@gmail.com"]
+
+  spec.summary       = "slack incoming webhooks ruby client."
+  spec.description   = "slack incoming webhooks ruby client."
+  spec.homepage      = "https://github.com/naoto0822/slack-incoming-webhooks-ruby"
+  spec.license       = "MIT"
+  
+  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.required_ruby_version = '>= 2.4.0'
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "travis"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: slack-incoming-webhooks-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- naoto0822
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-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.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: travis
+  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: slack incoming webhooks ruby client.
+email:
+- n.h.in.m.h@gmail.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
+- examples/post.rb
+- images/attachment.png
+- images/field.png
+- images/normal.png
+- lib/slack-incoming-webhooks-ruby.rb
+- lib/slack/http/connection.rb
+- lib/slack/http/result.rb
+- lib/slack/incoming_webhooks/client.rb
+- lib/slack/messages/attachment.rb
+- lib/slack/messages/field.rb
+- lib/slack/messages/payload.rb
+- lib/slack/version.rb
+- slack-incoming-webhooks-ruby.gemspec
+homepage: https://github.com/naoto0822/slack-incoming-webhooks-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: slack incoming webhooks ruby client.
+test_files: []