slack_tsuribari 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 27b61f76c23e7c65fae3944fd22612fe4638bd770c6d64240c12a2754248cbd1
+  data.tar.gz: adbcafd65c338a0478387008cdb8f0e4af7839657034236a610a02d1ed843c28
+SHA512:
+  metadata.gz: fa659bd30956fb58fbf26eb8e1f9bfd95c5ea114e1a15ba5f05e47d98bf11fa84833e5fe3e9734621c3d2ff451144ab4a13de51526a7871e580a9b05c52cdfd2
+  data.tar.gz: 96dc2d0b186cd2a1554f9f0ad6175f6949658ed420d05ef98eb15faab736a6d8aae85f5552ea37c40ff92ee061769d0b3727f551adb8e22ad47c9391910f67b8

data/.github/workflows/ruby.yml

@@ -0,0 +1,24 @@
+name: gem test
+
+on: [push, pull_request]
+
+jobs:
+
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.5.7', '2.6.5', '2.7.0' ]
+
+    steps:
+      - uses: actions/checkout@v1
+
+      - name: Set up Ruby version
+        uses: actions/setup-ruby@master
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - run: gem install bundler --no-document
+      - run: bundle install --jobs 4 --retry 3
+      - run: bundle exec rake spec
+      - run: bundle exec rubocop

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/.rubocop.yml

@@ -0,0 +1,37 @@
+AllCops:
+  Exclude:
+    - "slack_tsuribari.gemspec"
+    - "Gemfile"
+    - "Rakefile"
+    - "bin/*"
+    - "slack_tsuribari/version.rb"
+    - "spec/spec_helper.rb"
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 20
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/ParameterLists:
+  Enabled: false
+
+
+Style/HashEachMethods:
+  Enabled: false
+
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Change log
+
+### 0.1.0 / 2020-03-29
+* first release

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 nekosatoru@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_tsuribari.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 nekomaho
+
+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,125 @@
+# SlackTsuribari
+SlackTsuribari is a Slack Incoming Webhook wrapper for ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slack_tsuribari'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slack_tsuribari
+
+## Usage
+To post a message to a slack an easy way, create a hook object and send data with Angler.easy_throw!.
+```ruby
+hook = SlackTsuribari::Hook.config('https://hooks.slack.com/services/webhook_url')
+SlackTsuribari::Angler.easy_throw!(hook, 'test message')
+```
+Use Angler.throw! If you need a bit more control, like adding color.
+
+```ruby
+hook = SlackTsuribari::Hook.config('https://hooks.slack.com/services/webhook_url')
+payload = {
+  attachments: [
+    fallback: 'test message',
+    text: 'test message',
+    color: '#00FF00',
+  ]
+}
+SlackTsuribari::Angler.throw!(hook, payload)
+```
+
+The second argument of throw! can specify the payload of slack's Incoming Webhook.
+See Setup Instructions of Incoming Webhook and [Adding secondary attachment](https://api.slack.com/messaging/composing/layouts#attachments)
+for arguments that can be specified in the payload.
+
+### proxy setting
+If a proxy is needed, it can be configured as follows
+
+```ruby
+hook = SlackTsuribari::Hook.config do |config|
+  config.uri = 'https://hooks.slack.com/services/webhook_url'
+  config.proxy_addr = '127.0.0.1'
+  config.proxy_port = 8080
+  config.proxy_user = 'test'
+  config.proxy_pass = 'password'
+  config.no_proxy = '192.168.1.1'
+end
+SlackTsuribari::Angler.easy_throw!(hook, 'test message')
+```
+
+### pre payload setting
+In config you can also set the `channel`, `username`, `text` and icon to post.
+The `channel` is set when you change the channel to post.
+```ruby
+hook = SlackTsuribari::Hook.config do |config|
+  config.uri = 'https://hooks.slack.com/services/webhook_url'
+  config.pre_payload.channel = 'sample_channel'
+end
+SlackTsuribari::Angler.easy_throw!(hook, 'test message')
+```
+
+The `username` allows you to change the name of the post.
+```ruby
+hook = SlackTsuribari::Hook.config do |config|
+  config.uri = 'https://hooks.slack.com/services/webhook_url'
+  config.pre_payload.username = 'Robot'
+end
+SlackTsuribari::Angler.easy_throw!(hook, 'test message')
+```
+
+The `text` allows you to set the text to be posted. If text is specified with `easy_throw!` or `throw!`, its setting is preferred.
+```ruby
+hook = SlackTsuribari::Hook.config do |config|
+  config.uri = 'https://hooks.slack.com/services/webhook_url'
+  config.pre_payload.text = 'pre payload text'
+end
+SlackTsuribari::Angler.easy_throw!(hook) # => throw 'pre payload text'
+SlackTsuribari::Angler.throw!(hook) # => throw 'pre payload text'
+
+SlackTsuribari::Angler.easy_throw!(hook, 'text') # => throw 'text'
+SlackTsuribari::Angler.throw!(hook, {text: 'text'}) # => throw 'text'
+```
+
+If you want to set an icon, put a value in either `icon_url` or `icon_emoji`.
+The `icon_url` is the URL of the icon.
+The `icon_emoji` is the text of the emoji to be set for the icon.
+```ruby
+hook = SlackTsuribari::Hook.config do |config|
+  config.uri = 'https://hooks.slack.com/services/webhook_url'
+  config.pre_payload.icon_url = 'path to icon url'
+end
+SlackTsuribari::Angler.easy_throw!(hook, 'test message')
+```
+
+```ruby
+hook = SlackTsuribari::Hook.config do |config|
+  config.uri = 'https://hooks.slack.com/services/webhook_url'
+  config.pre_payload.icon_emoji = ':+1:'
+end
+SlackTsuribari::Angler.easy_throw!(hook, 'test message')
+```
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nekomaho/slack-tsuribari. 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "slack_tsuribari"
+
+# 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

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/slack_tsuribari.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative 'slack_tsuribari/version'
+
+require_relative 'slack_tsuribari/hook'
+require_relative 'slack_tsuribari/angler'

data/lib/slack_tsuribari/angler.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'slack_tsuribari/connection'
+
+module SlackTsuribari
+  module Angler
+    class << self
+      def easy_throw!(hook, message = nil)
+        payload = message.nil? ? nil : { text: message }
+        throw_action(hook, payload, true)
+      end
+
+      def throw!(hook, payload = nil)
+        throw_action(hook, payload, true)
+      end
+
+      private
+
+      def throw_action(hook, payload, auto_detach)
+        hook.attach(payload)
+        Connection.new(hook.uri, hook.proxy_setting).post(hook.payload_to_json).tap do
+          hook.detach if auto_detach
+        end
+      end
+    end
+  end
+end

data/lib/slack_tsuribari/connection.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'net/http'
+
+module SlackTsuribari
+  class Connection
+    attr_reader :scheme, :host, :port, :path
+    attr_reader :proxy_addr, :proxy_port, :proxy_user, :proxy_pass, :no_proxy
+
+    def initialize(uri, options = {})
+      URI.parse(uri).tap do |parse_uri|
+        @scheme = parse_uri.scheme
+        @host = parse_uri.host
+        @path = parse_uri.path
+        @port = parse_uri.port
+      end
+      @proxy_addr = options[:proxy_addr] || :ENV
+      @proxy_port = options[:proxy_port] || nil
+      @proxy_user = options[:proxy_user] || nil
+      @proxy_pass = options[:proxy_pass] || nil
+      @no_proxy = options[:no_proxy] || nil
+    end
+
+    def post(data, header = { 'Content-Type' => 'application/json' })
+      Net::HTTP.new(host, port, proxy_addr, proxy_port, proxy_user, proxy_pass, no_proxy).yield_self do |http|
+        http.use_ssl = scheme == 'https'
+        http.post(path, data, header)
+      end
+    end
+  end
+end

data/lib/slack_tsuribari/hook.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module SlackTsuribari
+  class Hook
+    PrePayload = Struct.new(:channel, :username, :text, :icon_url, :icon_emoji) do
+      def to_h
+        %I[channel username text icon_url icon_emoji].each_with_object({}) do |attr, hash|
+          hash[attr] = send(attr) unless send(attr).nil?
+        end
+      end
+
+      def nil?
+        %I[channel username text icon_url icon_emoji].all? { |attr| send(attr).nil? }
+      end
+    end
+
+    Config = Struct.new(
+      :uri,
+      :proxy_addr,
+      :proxy_port,
+      :proxy_user,
+      :proxy_pass,
+      :no_proxy,
+      :pre_payload,
+      keyword_init: true
+    )
+
+    class << self
+      def config(uri = nil)
+        config = Config.new(pre_payload: PrePayload.new)
+
+        if block_given?
+          yield(config)
+        else
+          config.uri = uri
+        end
+        new(config)
+      end
+    end
+
+    class NoPayloadError < StandardError; end
+
+    attr_reader :config, :payload
+
+    def initialize(config)
+      @config = config
+    end
+
+    def uri
+      config.uri
+    end
+
+    def proxy_setting
+      {
+        proxy_addr: config.proxy_addr,
+        proxy_port: config.proxy_port,
+        proxy_user: config.proxy_user,
+        proxy_pass: config.proxy_pass,
+        no_proxy: config.no_proxy
+      }
+    end
+
+    def payload_to_json
+      payload.to_json
+    end
+
+    def attach(payload)
+      return @payload if !@payload.nil? && payload.nil? # when not detached and new payload is nil
+      raise NoPayloadError if payload.nil? && config.pre_payload.nil?
+
+      @payload = config.pre_payload.to_h.merge(payload.nil? ? {} : payload)
+    end
+
+    def detach
+      @payload = nil
+    end
+  end
+end

data/lib/slack_tsuribari/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SlackTsuribari
+  VERSION = '0.1.0'
+end

data/slack_tsuribari.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_tsuribari/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slack_tsuribari"
+  spec.version       = SlackTsuribari::VERSION
+  spec.authors       = ["nekomaho"]
+  spec.email         = ["nekosatoru@gmail.com"]
+
+  spec.summary       = %q{This gem can post messages to the channel using slack's incoming webhook.}
+  spec.description   = %q{A gem to help post to slack using webhook}
+  spec.homepage      = "https://github.com/nekomaho/slack-tsuribari"
+  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.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "< 1.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: slack_tsuribari
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- nekomaho
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: A gem to help post to slack using webhook
+email:
+- nekosatoru@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/slack_tsuribari.rb
+- lib/slack_tsuribari/angler.rb
+- lib/slack_tsuribari/connection.rb
+- lib/slack_tsuribari/hook.rb
+- lib/slack_tsuribari/version.rb
+- slack_tsuribari.gemspec
+homepage: https://github.com/nekomaho/slack-tsuribari
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: This gem can post messages to the channel using slack's incoming webhook.
+test_files: []