slackpost 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3af1268aea6ef6f47d8779c6cd8c847098deb5b9b7f76c307a85c822bfe921d
-  data.tar.gz: e2dbd4647b2341078821d1538848889fa520d29b3f126598c1f96b8fa4919867
+  metadata.gz: 6aa7e1774c5a0b9a4542c511a0e1c17ab9324b9f12d5f0e7cd5d216c1458d9f7
+  data.tar.gz: 7c963de9c738334066bb48e6c3ea48f7f0aadca1e85c3de9c7f740ec91e9acbb
 SHA512:
-  metadata.gz: 5df6cd0a6298ac14745bde2ec00e715875300679a957a4e3dd2269b89d411eefe63d8185993b21dab10b3c2eb98a2c74d990b36c77a9b9a311b43bbe756a0b26
-  data.tar.gz: f4b1929a53f19010bdfc1b9692e8dcd97c20655891a716a95fd48c752b7283f3d5c90f54c162228601823ecc9221b20c95635bbf635c39f194c94c7802e43d3b
+  metadata.gz: a86b8fcb64f296e897d374afe6e60b8fbecad6d0bafc0d2a22b632f13c139675f2e07562a762a21c30f3ee7b854a7ed40eab8c5b9543448c65547077e8623e07
+  data.tar.gz: e39b6844d495b25dbdf2e987de23ae7f3c969128250a5281ffef9e2d90733f40fbfceabb1486068f7509b88c5bdc51a09ca34cde2170f0880d436d97a494c6db

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    slackpost (0.1.0)
+    slackpost (0.1.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,8 +1,8 @@
 # Slackpost
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/slackpost`. To experiment with that code, run `bin/console` for an interactive prompt.
+This is the simplest gem you will find to send messages to slack from your application. Although there are some
+similar gems, this one is focused on simplicity and usability. Also, it does not have any other gem dependencies!
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -22,7 +22,29 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+First, you need some lines in your app, in order to configure the slack incoming webhook. If you are not sure what 
+token do you need, refer to this page: https://api.slack.com/incoming-webhooks
+
+```ruby
+require 'slackpost'
+
+Slackpost.configure do |config|
+  config.slack_token = "T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
+end
+```
+
+That's it! And now you can use the static methods `send_message` and `send_attachemnt`, like this:
+
+```ruby
+Slackpost.send_message("This is a test", 'test_channel')
+
+Slackpost.send_attachment("This is a test attachment", 'test_channel',
+                          "attachment title", "attachment message", "#0055bb")
+
+```
+
+This gem is active and will be under development, so new features are absolutely welcome. However keep in mind that
+the purpose of this gem is to be simple. If you need more specific features, please take a look at other gems.
 
 ## Development
 
@@ -32,12 +54,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/slackpost. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/guillermijas/slackpost.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Slackpost project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/slackpost/blob/master/CODE_OF_CONDUCT.md).

data/lib/slackpost/version.rb

@@ -1,3 +1,3 @@
 module Slackpost
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

data/lib/slackpost.rb

@@ -18,14 +18,14 @@ module Slackpost
       yield(config)
     end
 
-    def simple_msg_to_channel(msg, channel)
+    def send_message(msg, channel)
       body = { channel: channel,
                link_names: 1,
                text: msg }
-      send_slackpost(body)
+      send_slack(body)
     end
 
-    def attachment_msg_to_channel(msg, channel, att_title, att_value, att_color)
+    def send_attachment(msg, channel, att_title, att_value, att_color)
       body = { channel: channel,
                link_names: 1,
                text: msg,
@@ -33,10 +33,12 @@ module Slackpost
                                color: att_color,
                                fields: [{ title: att_title,
                                           value: att_value }] }] }
-      send_slackpost(body)
+      send_slack(body)
     end
 
-    def send_slackpost(body)
+    private
+
+    def send_slack(body)
       uri = URI.parse("https://hooks.slack.com/services/#{config.slack_token}")
       response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
         request = Net::HTTP::Post.new(uri)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slackpost
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Guillermo Mora