slackly 0.0.1.pre.rc1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1530ff7ddef013f0fc511960354b370729c44fa8
-  data.tar.gz: 6e08be987ba67e7ee001b7039584b64983172b0b
+  metadata.gz: 15be28ce0b3e3609ed9d263a2fe2e559a4b07a35
+  data.tar.gz: 899521b635ab50f1209dda6d2117a8c8f8bea18d
 SHA512:
-  metadata.gz: 0f2e84a5e392453b82b56cd2fcb15f146a8057ae2e0f49bb2523e8b52cede00d72693874f68cac085979265315b6f5d56f258b98b1e645e9b46a90d90b38cce5
-  data.tar.gz: bfdc4b8eefaedfb5316bf6baf1685cc3a0cc8a261e085141cc437e122a931f43d16a3db81d13cbe0cb9db8277dffc12e5727461da6c04c3d4674db67eacc4d0e
+  metadata.gz: f10c0e603eb9e7c83976273218a0e04c820f1abe84e5b5b14128e31fc509f3781dc2a7763c053d0a3c16bc658b2ee850cac56742c9aed9c82ab446ac350521e9
+  data.tar.gz: a9968c77758428f96ae67d54d80b78ddfe54db948113466fcff3e42d63148b3e6685b8055a8333e4d0c1662951fb9bbe3681a953ff650d93776cb1c79805dfdb

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010-2015 Pedro Carriço
+
+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,62 @@
+# Slackly
+
+## Description
+Slackly is a simple and easy way to send messages to your Slack channels using the incoming webhooks integration.
+You can use it directly in your code or through the command line.
+
+## Installation
+```
+gem install slackly
+```
+
+## Usage
+In your code:
+```
+s = Slackly.new(webhook_url)
+s.message(text: 'Hello from Slackly')
+```
+
+Command line:
+```
+slackly message 'Hello from Slackly!'
+```
+
+## Configuration
+In your code:
+```
+# these options will be the default client options and may be overriden by the message options
+client_options = {
+  username: 'slackly',
+  icon_emoji: ':ghost:'
+}
+s = Slackly.new(webhook_url, client_options)
+
+# these options will be sent for this message and will override any client options
+message_options = {
+  text: 'Hello from Slackly',
+  channel: '#slackly'
+}
+s.message(message_options)
+```
+
+The command line needs a JSON configuration file in order to configure the webhook, it defaults to './slackly.json'
+but you can override it with the `-c` configuration.
+The JSON configuration file must must have a `webhook_url` option in order for the command line to work:
+
+```
+slackly message 'Hello from Slackly!' -c path_to/config.json
+```
+
+Both the code version and JSON configuration file accept any configuration option provided by Slack as described in
+[here](https://api.slack.com/incoming-webhooks).
+
+## Contributing
+
+1. Fork it (https://github.com/pedrocarrico/slackly/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
+
+## License
+Slackly is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/bin/slackly

@@ -1,6 +1,5 @@
 #!/usr/bin/env ruby
 require 'optparse'
-require_relative '../lib/slackly'
 
 options = {
   config: './slackly.json'
@@ -8,12 +7,12 @@ options = {
 
 option_parser = OptionParser.new do |opts|
   executable_name = File.basename($PROGRAM_NAME)
-  opts.banner = "Usage: #{executable_name} send \"message\" [options]
+  opts.banner = "Usage: #{executable_name} message 'text' [options]
 Options:
 "
   opts.on('-c CONFIG',
           '--config path_to/config.json',
-          "alernate JSON configuration file, defaults to ./slackly.json") do |config|
+          'alernate JSON configuration file, defaults to ./slackly.json') do |config|
     options[:config] = config
   end
 
@@ -27,37 +26,39 @@ end
 begin
   option_parser.parse!
   if ARGV.empty?
-    STDERR.puts "Error: you must supply an action"
+    STDERR.puts 'Error: you must supply an action'
     STDERR.puts option_parser.help
     exit 1
   end
 
   case ARGV[0]
-  when 'send'
+  when 'message'
+    require_relative '../lib/slackly'
+
     if ARGV[1].nil?
-      STDERR.puts "Error: you must supply a message"
+      STDERR.puts 'Error: you must supply a message'
       STDERR.puts option_parser.help
       exit 1
     end
 
     if !File.exist?(options[:config]) || !File.readable?(options[:config])
-      STDERR.puts "Error: ensure you supply a valid and readable JSON config file"
+      STDERR.puts 'Error: ensure you supply a valid and readable JSON config file'
       STDERR.puts option_parser.help
       exit 1
     end
 
     begin
-      slackly_config = JSON.parse(File.read(options[:config]))
-    rescue JSON::ParserError => e
-      STDERR.puts "Error: file \"#{options[:config]}\" is not a valid JSON file"
+      slackly_config = JSON.parse(File.read(options[:config]), symbolize_names: true)
+    rescue JSON::ParserError
+      STDERR.puts 'Error: file \"#{options[:config]}\" is not a valid JSON file'
       STDERR.puts option_parser.help
       exit 1
     end
 
-    s = Slackly.new(slackly_config["webhook_url"])
-    s.send_message(slackly_config.merge({text: ARGV[1]}))
+    s = Slackly.new(slackly_config[:webhook_url])
+    s.message(slackly_config.merge(text: ARGV[1]))
   when 'version'
-    puts "Slackly version is #{Gem::Specification::load("#{File.dirname(__FILE__)}/../slackly.gemspec").version}"
+    puts "Slackly version is #{Gem::Specification.load("#{File.dirname(__FILE__)}/../slackly.gemspec").version}"
   else
     STDERR.puts option_parser
   end

data/lib/slackly/version.rb

@@ -1,3 +1,3 @@
 module Slackly
-  VERSION = '0.0.1-rc1'.freeze
+  VERSION = '0.1.0'.freeze
 end

data/lib/slackly.rb

@@ -1,30 +1,38 @@
-require "net/http"
-require "json"
+require 'net/http'
+require 'json'
 
 class Slackly
-  attr_accessor :webhook_url
+  class InvalidMessageTextError < StandardError; end
+
+  attr_accessor :webhook_uri
   attr_accessor :client_options
 
   DEFAULT_OPTIONS = {
-    'username' => 'slackly',
-    'text' => 'Hello from slackly! Check me out at https://github.com/pedrocarrico/slackly!',
-    'icon_emoji' => ':sunglasses:',
-    'unfurl_links' => true
+    username: 'slackly',
+    icon_emoji: ':sunglasses:',
+    unfurl_links: true
   }.freeze
 
-  def initialize(webhook_url, client_options={})
-    @webhook_url = webhook_url
+  def initialize(webhook_url, client_options = {})
+    @webhook_uri = URI.parse(webhook_url)
     @client_options = DEFAULT_OPTIONS.merge(client_options)
   end
 
-  def send_message(message_options={})
-    uri = URI.parse(webhook_url)
-    request = Net::HTTP::Post.new(uri.request_uri)
+  def message(message_options = {})
+    fail Slackly::InvalidMessageTextError, 'Please supply a valid message text' if message_options[:text].nil?
+
+    request = Net::HTTP::Post.new(webhook_uri.request_uri)
     request.body = "payload=#{client_options.merge(message_options).to_json}"
-    Net::HTTP.start(uri.host, uri.port, use_ssl: ('https' == uri.scheme)) do |http|
+    Net::HTTP.start(webhook_uri.host, webhook_uri.port, use_ssl: webhook_uses_ssl?) do |http|
       http.request(request)
     end
-  rescue => e
-    STDERR.puts "Error while sending notification to Slack: #{e.message}"
+  rescue => exception
+    STDERR.puts "Error while sending message to Slack: #{exception.message}"
+  end
+
+  private
+
+  def webhook_uses_ssl?
+    'https' == webhook_uri.scheme
   end
 end

data/slackly.gemspec

@@ -3,12 +3,13 @@ require_relative 'lib/slackly/version'
 Gem::Specification.new do |s|
   s.name        = 'slackly'
   s.version     = Slackly::VERSION
-  s.date        = Time.now.strftime("%Y-%m-%d")
+  s.date        = Time.now.strftime('%Y-%m-%d')
   s.summary     = 'Slackly'
-  s.description = 'Slackly is a simple and easy way to send messages to your Slack channes using the incoming webhooks integration.'
+  s.description = 'Slackly is a simple and easy way to send messages to your Slack channels using the incoming'\
+                  ' webhooks integration.'
   s.authors     = ['Pedro Carriço']
   s.email       = 'pedro.carrico@gmail.com'
-  s.files       = ['lib/slackly.rb', 'lib/slackly/version.rb', 'slackly.gemspec']
+  s.files       = ['lib/slackly.rb', 'lib/slackly/version.rb', 'slackly.gemspec', 'LICENSE', 'README.md']
   s.executables = 'slackly'
   s.homepage    = 'http://www.github.com/pedrocarrico/slackly'
   s.license     = 'MIT'
@@ -17,4 +18,5 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.2'
 
   s.add_development_dependency 'bundler', '~> 1.8', '>= 1.8.2'
+  s.add_development_dependency 'rubocop', '~> 0.30.1', '0.30.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slackly
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre.rc1
+  version: 0.1.0
 platform: ruby
 authors:
 - Pedro Carriço
@@ -50,7 +50,27 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.2
-description: Slackly is a simple and easy way to send messages to your Slack channes
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.30.1
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.30.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.30.1
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.30.1
+description: Slackly is a simple and easy way to send messages to your Slack channels
   using the incoming webhooks integration.
 email: pedro.carrico@gmail.com
 executables:
@@ -58,6 +78,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - bin/slackly
 - lib/slackly.rb
 - lib/slackly/version.rb
@@ -77,9 +99,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2