messenger 0.6.0 → 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43b99873719b3d45b62713bed93b693e31643d6a
+  data.tar.gz: 2acb952179ba9d928f9849c2908e1e3511943d2e
+SHA512:
+  metadata.gz: 997bc584e29a1ace9b819a085b24745919d87539e3e0d3f944575883ac3d20e62071c6fe1f4f349b0131c3124319460530f4d136baa9822c1d0099e0d2cd3607
+  data.tar.gz: 758920cdfaddcac2265d8a7bcebc0b0216245e9cfec043e8139e47164d1c13c7f56983c8f60fe5673d7823e84a0084bcb798676e496d242ac944641d96268f31

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Brandon Arbini / Zencoder, Inc.
+Copyright (c) 2015 Brightcove, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -31,6 +31,20 @@ Campfire messages are sent using the HTTParty gem against the Campfire API.
     messenger campfire://api-key:room-id@subdomain.campfirenow.com "Message"
 
 
+Slack
+---
+
+Slack messages are sent using the HTTParty gem against the [incoming webhooks API](https://api.slack.com/incoming-webhooks). If the message sent is a string, the message will be delivered
+as such. If it's an object or an array of objects, those will be sent as attachments.
+
+    messenger slack://displayname@hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX/#room "Message"
+    messenger slack://displayname@hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX/#room { fallback: 'Important notice', color: '#0000ff', text: 'Man this is some super important text' }
+
+You can also specify a custom user image by passing `icon_url` or `icon_emoji` in the options block.
+
+    messenger slack://displayname@hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX/#room "Message" { icon_emoji: ':ghost:' }
+
+
 Jabber
 ------
 
@@ -48,4 +62,9 @@ Messenger will also read in ~/.messenger (a YAML file) for default config inform
     jabber_password: ########
 
 
-(c) 2010 Brandon Arbini / Zencoder, Inc.
+License
+=======
+
+Messenger is licensed under the MIT License. [View the license file](LICENSE)
+
+Copyright 2015 Brightcove, Inc

data/lib/messenger.rb

@@ -4,5 +4,7 @@ require 'messenger/result'
 require 'messenger/email'
 require 'messenger/web'
 require 'messenger/campfire'
+require 'messenger/slack'
 require 'messenger/jabber'
+require 'messenger/version_number'
 require 'messenger/version'

data/lib/messenger/messenger.rb

@@ -38,6 +38,7 @@ module Messenger
     when /\Acampfire/ then  :campfire
     when /\Ajabber/ then    :jabber
     when /\Amailto|@+/ then :email
+    when /\Aslack/ then     :slack
     end
   end
 
@@ -47,6 +48,7 @@ module Messenger
     when :http then     Messenger::Web
     when :campfire then Messenger::Campfire
     when :jabber then   Messenger::Jabber
+    when :slack then    Messenger::Slack
     else
       raise Messenger::ProtocolError, "Malformed service URL: #{url}. Either this syntax is wrong or this service type is not yet implemented."
     end

data/lib/messenger/slack.rb

@@ -0,0 +1,79 @@
+require 'httparty'
+require 'json'
+
+class Messenger::Slack
+
+  def self.valid_url?(url)
+    !!matcher(url)
+  end
+
+  # URL format:
+  #     slack://displayname@hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX/#room
+  # Slack supports the notion of attachments, so the messages can be a little fancier. If body is a string, that
+  # string will simply be sent to the room as text. `body` can also be an array of attachments, or a single attachment.
+  # Attachment reference: https://api.slack.com/docs/attachments
+  def self.deliver(url, body, options={})
+    raise Messenger::URLError, "The URL provided is invalid" unless valid_url?(url)
+    parsed_url = matcher(url)
+
+    options[:headers] ||= {}
+    response = HTTParty.post(
+      "https://#{parsed_url[:base_url]}/#{parsed_url[:key_one]}/#{parsed_url[:key_two]}/#{parsed_url[:secret]}",
+      :headers => { "Content-Type" => "application/json"}.merge(options[:headers]),
+      :body => build_message(parsed_url[:channel], parsed_url[:display_name], body, options)
+    )
+    Messenger::Result.new(success?(response), response)
+  end
+
+  def self.obfuscate(url)
+    raise Messenger::URLError, "The URL provided is invalid" unless valid_url?(url)
+    parsed_url = matcher(url)
+    "slack://#{parsed_url[:display_name]}@#{parsed_url[:base_url]}/T********/B********/************************/#{parsed_url[:channel]}"
+  end
+
+
+private
+
+  def self.build_message(channel, display_name, body, options)
+    msg = { channel: channel, username: display_name }
+
+    msg['icon_emoji'] = options[:icon_emoji] if options[:icon_emoji]
+    msg['icon_url'] = options[:icon_url] if options[:icon_url]
+
+    if body.is_a?(String)
+      msg.merge!({ text: body })
+
+    elsif body.is_a?(Array)
+      msg['attachments'] = body
+
+    elsif body.is_a?(Hash)
+      msg['attachments'] = []
+      msg['attachments'].push(body)
+    end
+
+    msg.to_json
+  end
+
+  def self.matcher(url)
+    return false unless match = url.match(/slack:\/\/(.*)@(hooks.slack.com\/services)\/([T].*?)\/([B].*?)\/(.*)\/([#@].*)/)
+
+    {
+      display_name: match[1],
+      base_url: match[2],
+      key_one: match[3],
+      key_two: match[4],
+      secret: match[5],
+      channel: match[6]
+    }
+  end
+
+  def self.success?(response)
+    case response.code
+    when 200, 201
+      true
+    else
+      false
+    end
+  end
+
+end

data/lib/messenger/version.rb

@@ -1,3 +1,3 @@
 module Messenger
-  VERSION = '0.6.0'
+  VERSION = Messenger::VersionNumber.new.to_s
 end

data/lib/messenger/version_number.rb

@@ -0,0 +1,35 @@
+require 'yaml'
+
+module Messenger
+  class VersionNumber
+
+    def initialize
+      @version = YAML.load_file('VERSION.yml')
+    end
+
+    def major
+      @version['major']
+    end
+
+    def minor
+      @version['minor']
+    end
+
+    def patch
+      @version['patch']
+    end
+
+    def to_hash
+      @version.dup
+    end
+
+    def to_a
+      [major, minor, patch]
+    end
+
+    def to_s
+      to_a.join(".")
+    end
+
+  end
+end

metadata

@@ -1,219 +1,216 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: messenger
-version: !ruby/object:Gem::Version 
-  hash: 7
-  prerelease: 
-  segments: 
-  - 0
-  - 6
-  - 0
-  version: 0.6.0
+version: !ruby/object:Gem::Version
+  version: 0.7.0
 platform: ruby
-authors: 
+authors:
 - Brandon Arbini
 - Nathan Sutton
+- Matthew McClure
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-01-11 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2015-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: scashin133-xmpp4r-simple
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: mail
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: httparty
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: trollop
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: addressable
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: shoulda
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: mocha
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: webmock
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
   type: :development
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
   type: :development
-  version_requirements: *id009
-- !ruby/object:Gem::Dependency 
-  name: rdoc
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
   type: :development
-  version_requirements: *id010
-description: "Messenger: easy message sending for various protocols."
-email: brandon@zencoder.com
-executables: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: 'Messenger: easy message sending for various protocols.'
+email: mmcclure@brightcove.com
+executables:
 - messenger
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.markdown
-files: 
+files:
+- LICENSE
+- README.markdown
+- Rakefile
+- bin/messenger
+- lib/messenger.rb
 - lib/messenger/campfire.rb
 - lib/messenger/email.rb
 - lib/messenger/errors.rb
 - lib/messenger/jabber.rb
 - lib/messenger/messenger.rb
 - lib/messenger/result.rb
+- lib/messenger/slack.rb
 - lib/messenger/version.rb
+- lib/messenger/version_number.rb
 - lib/messenger/web.rb
-- lib/messenger.rb
-- LICENSE
-- README.markdown
-- Rakefile
-- bin/messenger
 homepage: http://github.com/zencoder/messenger
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: messenger
-rubygems_version: 1.8.24
+rubygems_version: 2.4.6
 signing_key: 
-specification_version: 3
-summary: "Messenger: easy message sending"
+specification_version: 4
+summary: 'Messenger: easy message sending'
 test_files: []
-
-has_rdoc: