glip-poster 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 652a7577d32a48468782db353cff8b3a33100932
-  data.tar.gz: dac5bc38a6d65a508a5fd72b1a593dbe544a7f38
+  metadata.gz: cf78cb00473593f849b8a6fdbddc778f677d4884
+  data.tar.gz: 36e1cb0d1738cfbebc0975ddefa2116ec809766b
 SHA512:
-  metadata.gz: cb5b4fdfea8ba97cfc240fe20eef786d06d0c8ecb07b4fc1191b06202d10309533bfd36c4c9138dbc201b1dc3d7e7ea5896b40c210295153f121c5a4dbb4b941
-  data.tar.gz: f52d98e4e1c9867d1d27c755301ff0b97823b9b6431ba78d32b192e285c93ccfc3759c4c1f341bbf0e847ce6cd5ddbac8b3645ad66095922846414aac8e8b08a
+  metadata.gz: ea165044446914a0c5fe3a446303ff6e42740cc4e70a6c48a3895bc17536e5d1ecc8e91d2c25c6f772a6fa4d312046af46fc0b08189c6183c1e012dd28ebaa6e
+  data.tar.gz: 94a6adeac3f4d6244c883bc85ff44ebcf3ffcf20a83aaa36045f5f8f2cf6fa754a9fb5a5d1934500c98827d52fe4e462f7bd806da8b407975b81e50cf6bc6083

data/README.md

@@ -1,5 +1,5 @@
 Glip Poster
-========================
+===========
 
 [![Gem Version][gem-version-svg]][gem-version-link]
 [![Build Status][build-status-svg]][build-status-link]
@@ -11,11 +11,13 @@ Glip Poster
 [![Docs][docs-rubydoc-svg]][docs-rubydoc-link]
 [![License][license-svg]][license-link]
 
+`glip-poster` is a simple gem to make your integration with Glip (https://glip.com/) easier. It supports only incoming communications (from you to Glip).
+
 ## Installation
 
 ### Via Bundler
 
-Add 'glip-poster' to Gemfile and then run `bundle`:
+Add `glip-poster` to your `Gemfile` and then run `bundle`:
 
 ```sh
 $ echo "gem 'glip-poster'" >> Gemfile
@@ -28,13 +30,25 @@ $ bundle
 $ gem install glip-poster
 ```
 
+## Glip setup
+
+This gem will use a incoming webHook integration on Glip. First, you need to create a new Glip webhook integration. In Glip.com, click on 'Integrations' if the left column and then select the "Glip Webhooks" integration. After you select a conversation, a webhook URL will be displayed for you which will be used by this gem to post messages to. The URL looks like the following:
+
+```http
+https://hooks.glip.com/webhook/11112222-3333-4444-5555-666677778888
+```
+
+You can instantiate the `Glip::Poster` class with the full URL or the webhook ID (GUID) only.
+
 ## Usage
 
-First you have to initialize your poster and then you can use `send_message` to send your message.
+First you have to initialize your poster and then you can use `send_message` to send your message. You must have a webhook URL configured in Glip using the "Glip Webhooks" integration.
 
 ```ruby
+require 'glip-poster'
+
 poster = Glip::Poster.new(YOUR_WEBHOOK_URL)
-poster.send_message('Hello World!') # Faraday::Response
+poster.send_message('Hi there!') # Faraday::Response
 ```
 
 You can send text in Markdown:
@@ -47,13 +61,13 @@ poster.send_message('* Location: [The Funky Buddha Lounge](http://www.thefunkybu
 You can use an options array if you don't want to use the default settings.
 
 ```ruby
-options => {
-  :icon": "http://example.com/icon.png",
-  :activity": "Activity Alert",
-  :title": "A New Incoming Message Has Been Received",
+options = {
+  icon: "http://example.com/icon.png",
+  activity: "Activity Alert",
+  title: "A New Incoming Message Has Been Received"
 }
 poster = Glip::Poster.new(YOUR_WEBHOOK_URL)
-poster.send_message('Hello Beer!', options)
+poster.send_message('Hi there!', options)
 ```
 
 You can preset your options:
@@ -61,8 +75,8 @@ You can preset your options:
 ```ruby
 poster = Glip::Poster.new(YOUR_WEBHOOK_URL)
 poster.options[:icon] = 'http://example.com/icon.png'
-poster.options = {:icon => 'http://example.com/icon.png'}
-poster.send_message('Hello World!')
+poster.options = {icon: 'http://example.com/icon.png'}
+poster.send_message('Hi there!')
 ```
 
 ## Supported Ruby Versions

data/Rakefile

@@ -2,7 +2,7 @@ require 'rake'
 require 'rake/testtask'
 
 desc 'Default: run unit tests.'
-task :default => :test
+task default: :test
 
 desc 'Test the library.'
 Rake::TestTask.new do |t|

data/glip-poster.gemspec

@@ -6,7 +6,7 @@ version = $1
 Gem::Specification.new do |s|
   s.name        = 'glip-poster'
   s.version     = version
-  s.date        = '2016-01-30'
+  s.date        = '2016-01-31'
   s.summary     = 'Glip Poster - Ruby SDK for post messages via Glip webhooks'
   s.description = 'A Ruby SDK for post messages via Glip webhooks'
   s.authors     = ['John Wang']

data/lib/glip-poster/poster.rb

@@ -3,7 +3,7 @@ require 'faraday_middleware'
 
 module Glip
   class Poster
-    VERSION = '0.0.2'
+    VERSION = '0.0.3'
     GLIP_WEBHOOK_BASE_URL = 'https://hooks.glip.com/webhook/'
 
     attr_reader :webhook_url
@@ -11,7 +11,7 @@ module Glip
     attr_accessor :http
 
     def initialize(webhook_url_or_id)
-      webhook_uri(webhook_url_or_id)
+      set_webhook_url(webhook_url_or_id)
 
       @options = {}
       
@@ -22,7 +22,7 @@ module Glip
       end
     end
 
-    def webhook_uri(webhook_url_or_id)
+    def set_webhook_url(webhook_url_or_id)
       if webhook_url_or_id.to_s !~ %r{/}
         @webhook_url = GLIP_WEBHOOK_BASE_URL + webhook_url_or_id
       elsif webhook_url_or_id =~ %r{^https?://}
@@ -33,14 +33,10 @@ module Glip
     end
 
     def send_message(message, opts={})
-      opts = @options.merge opts
-      opts[:body] = message
-
-      res = @http.post do |req|
+      return @http.post do |req|
         req.url @webhook_url
-        req.body = opts
+        req.body = @options.merge(opts).merge({body: message})
       end
-      return res
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glip-poster
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-30 00:00:00.000000000 Z
+date: 2016-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -62,7 +62,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- glip-poster-0.0.1.gem
 - glip-poster.gemspec
 - lib/glip-poster.rb
 - lib/glip-poster/poster.rb