slack_messenger 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d6ae454046f542a25563ea04c4b951190a0ab6a
+  data.tar.gz: 9b844f70cd74566c45a2811a19062788c844285b
+SHA512:
+  metadata.gz: bf66d653c8c241b8c9e8ea77361e14f1028adac287a5b3cd437b7fe262b9be50deb374d907d16e08cb61dd8b193b031a8c8da90f05238ff607abc868063099d1
+  data.tar.gz: a0e4907a612392c028ff3e492040970060bcfaf46337080c254f4f88679f537d8bfef7c237cec7ca92f70239ce8ae0b99e1dde2270cbf2773ac8a95bd2f0e5f4

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,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 JT
+
+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,120 @@
+# SlackMessenger
+
+SlackMessenger is an easy-to-use gem to build and send messages via Slack's Incoming Webhooks API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slack_messenger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slack_messenger
+
+## Usage
+
+### Basic Usage
+
+First, setup a default API endpoint. You can create an Incoming Webhook integration on your Slack account. Use the Webhook URL provided by the integration.
+
+By default, the API endpoint is set to use `ENV['SLACK_API_ENDPOINT']`, but you can customize this in your initializers.
+
+Additionally, you may customize the default colour of your attachments here.
+
+```ruby
+# initializers/slack_messenger.rb
+SlackMessenger.configure do |config|
+  config.default_api = SlackMessenger::Api.new ENV['SOME_OTHER_VARIABLE']
+  config.attachment_color = '#eeeeee' # Color of sidebar on attachments. Set to a hex value.
+end
+```
+
+Sending a message is easy once you have an endpoint:
+
+```ruby
+message = SlackMessenger::Message.new "Message Text"
+message.send! # Your message is sent!
+```
+
+If you need further customization, you can add attachments and attachment fields to provide more information.
+
+```ruby
+# Attachment Field
+field = SlackMessenger::AttachmentField.new title: "New Field", value: "Field Text", short: false
+
+# Message Attachment
+attachment = SlackMessenger::Attachment.new text: "Attachment text", color: '#000000', fields: field
+
+# Create and sent message
+message = SlackMessenger::Message.new text: "Message Text", attachments: attachment
+message.send!
+```
+
+Attachments and fields can be passed as an array or as single objects.
+
+### Multiple  Endpoints
+
+At this stage, SlackMessenger only supports one default endpoint. Optionally, when sending message, you may create and pass another Api object when sending a message. This will override the default.
+
+```ruby
+message = SlackMessenger::Message.new text: "Message Text"
+second_api = SlackMessenger::Api.new ENV['SECOND_ENDPOINT']
+
+message.send! second_api # Overrides the configured default_api
+```
+
+#### `Api` Options
+Api objects only take a single `endpoint` argument
+
+#### `Message` Options
+Messages can take 2 options
+```ruby
+:text        # Main body of message
+:attachments # An array or single instance of Attachment objects
+```
+
+#### `Attachment` Options
+Attachments can take a number of options:
+```ruby
+:fallback    # Required plain-text summary of the attachment
+:color       # A hex value. Overrides the default attachment_color
+:pretext     # Optional text that appears above the attachment block
+:author_name # Optional text that appears at the head of attachment block
+:author_link # A URL for the author_namee (turns author_name into a link if set)
+:author_icon # A URL pointing to an image for the author_name
+:title       # Bolded text that appears at head of attachment block (below author if set)
+:title_link  # A URL for title (turns title into a link if set)
+:text        # Text that appears in attachment
+:fields      # An array or single instance of AttachmentField objects
+:image_url   # URL pointing to an image. Appears at bottom of attachment block
+:thumb_url   # URL pointing to an image. Appears at bottom of attachment block (smaller)
+:footer      # Text that appears at bottom of attachment block
+:footer_icon # URL of icon that appears in footer
+:ts          # Optional timestamp (in seconds eg Time.now.to_i)
+```
+
+#### `AttachmentField` Options
+AttachmentFields can take 3 options
+```ruby
+title:      # Bolded text at the top of field
+value:      # Unformatted text that appears in body of field
+short:      # Boolean value that sets width of field to 50% if true, otherwise is 100% of message width
+```
+
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jt-platterz/slack_messenger.
+
+
+## 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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "slack_messenger"
+
+# 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/slack_messenger/api.rb

@@ -0,0 +1,28 @@
+require 'httparty'
+require 'json'
+
+module SlackMessenger
+  class Api
+    def initialize(endpoint)
+      @endpoint = endpoint
+    end
+
+    def endpoint
+      @endpoint
+    end
+
+    def self.send(message, api = nil)
+      api = SlackMessenger.default_api if api.nil?
+
+      raise "default_api not set" if api.nil?
+      raise "No slack endpoint set" if api.endpoint.nil?
+
+      result = HTTParty.post(api.endpoint, body: message.as_json.to_json)
+      if result.code == 200
+        true
+      else
+        false
+      end
+    end
+  end
+end

data/lib/slack_messenger/attachment.rb

@@ -0,0 +1,46 @@
+module SlackMessenger
+  class Attachment
+    def initialize(options = {})
+      @fallback = options[:fallback]
+      @color = options[:color] || SlackMessenger.attachment_color
+      @pretext = options[:pretext]
+      @author_name = options[:author_name]
+      @author_link = options[:author_link]
+      @author_icon = options[:author_icon]
+      @title = options[:title]
+      @title_link = options[:title_link]
+      @text = options[:text] || ""
+
+      if options.has_key? :fields
+        @fields = options[:fields].is_a?(Array) ? options[:fields] : [options[:fields]]
+      end
+      
+      @image_url = options[:image_url]
+      @thumb_url = options[:thumb_url]
+      @footer = options[:footer]
+      @footer_icon = options[:footer_icon]
+      @ts = options[:ts] || false
+    end
+
+    def as_json
+      hash = {}
+      hash[:fallback] = @fallback unless @fallback.nil?
+      hash[:color] = @color
+      hash[:pretext] = @pretext unless @pretext.nil?
+      hash[:author_name] = @author_name unless @author_name.nil?
+      hash[:author_link] = @author_name unless @author_link.nil?
+      hash[:author_icon] = @author_icon unless @author_icon.nil?
+      hash[:title] = @title unless @title.nil?
+      hash[:title_link] = @title_link unless @title_link.nil?
+      hash[:text] = @text unless @text.nil?
+      hash[:fields] = @fields.map(&:as_json) unless @fields.nil? || @fields.empty?
+      hash[:image_url] = @image_url unless @image_url.nil?
+      hash[:thumb_url] = @thumb_url unless @thumb_url.nil?
+      hash[:footer] = @footer unless @footer.nil?
+      hash[:footer_icon] = @footer_icon unless @footer_icon.nil?
+      hash[:ts] = Time.now.to_i if @ts
+
+      hash
+    end
+  end
+end

data/lib/slack_messenger/attachment_field.rb

@@ -0,0 +1,16 @@
+module SlackMessenger
+  class AttachmentField
+    def initialize(options = {})
+      @title = options[:title]
+      @value = options[:value] || "Attachment Text"
+      @short = options[:short]
+    end
+
+    def as_json
+      hash = {value: @value}
+      hash[:title] = @title unless @title.nil?
+      hash[:short] = @title unless @short.nil?
+      hash
+    end
+  end
+end

data/lib/slack_messenger/message.rb

@@ -0,0 +1,21 @@
+module SlackMessenger
+  class Message
+    def initialize(options = {})
+      @text = options[:text] || ""
+
+      if options.has_key? :attachments
+        @attachments = options[:attachments].is_a?(Array) ? options[:attachments] : [options[:attachments]]
+      end
+    end
+
+    def send! override_api = nil
+      Api.send(self, override_api)
+    end
+
+    def as_json
+      hash = {text: @text}
+      hash[:attachments] = @attachments.map(&:as_json) unless @attachments.nil? || @attachments.empty?
+      hash
+    end
+  end
+end

data/lib/slack_messenger/version.rb

@@ -0,0 +1,3 @@
+module SlackMessenger
+  VERSION = "1.0.0"
+end

data/lib/slack_messenger.rb

@@ -0,0 +1,34 @@
+require "slack_messenger/version"
+require "slack_messenger/api"
+require "slack_messenger/message"
+require "slack_messenger/attachment"
+require "slack_messenger/attachment_field"
+
+module SlackMessenger
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  def self.default_api
+    configuration.default_api
+  end
+
+  def self.attachment_color
+    configuration.attachment_color
+  end
+
+  class Configuration
+    attr_accessor :default_api
+    attr_accessor :attachment_color
+
+    def initialize
+      self.default_api = SlackMessenger::Api.new ENV['SLACK_API_ENDPOINT']
+      self.attachment_color = '#000000'
+    end
+  end
+end

data/slack_messenger.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slack_messenger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slack_messenger"
+  spec.version       = SlackMessenger::VERSION
+  spec.authors       = ["Josh Tate"]
+  spec.email         = ["josh@joshtate.me"]
+
+  spec.summary       = "Easy sending of Slack notifications"
+  spec.homepage      = "https://github.com/jt-platterz/slack_messenger"
+  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.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "httparty", "~> 0.13"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: slack_messenger
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Josh Tate
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+description: 
+email:
+- josh@joshtate.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/slack_messenger.rb
+- lib/slack_messenger/api.rb
+- lib/slack_messenger/attachment.rb
+- lib/slack_messenger/attachment_field.rb
+- lib/slack_messenger/message.rb
+- lib/slack_messenger/version.rb
+- slack_messenger.gemspec
+homepage: https://github.com/jt-platterz/slack_messenger
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Easy sending of Slack notifications
+test_files: []
+has_rdoc: