glip-poster 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf78cb00473593f849b8a6fdbddc778f677d4884
-  data.tar.gz: 36e1cb0d1738cfbebc0975ddefa2116ec809766b
+  metadata.gz: 1e04b1814536e841a21c40ef76ebc22efb374901
+  data.tar.gz: 7225cb0a4e817bf2f6f810594ec35fb94a33d0c6
 SHA512:
-  metadata.gz: ea165044446914a0c5fe3a446303ff6e42740cc4e70a6c48a3895bc17536e5d1ecc8e91d2c25c6f772a6fa4d312046af46fc0b08189c6183c1e012dd28ebaa6e
-  data.tar.gz: 94a6adeac3f4d6244c883bc85ff44ebcf3ffcf20a83aaa36045f5f8f2cf6fa754a9fb5a5d1934500c98827d52fe4e462f7bd806da8b407975b81e50cf6bc6083
+  metadata.gz: b504dff9e41d75bf616b97cfbf5ff0bbf72381b04aba84b1a11745afa54e622a232bf0070afbc3ff46dd4a40349651e0c9e84b044f293a2c6bb0076b89c32610
+  data.tar.gz: 4fa261626d489515e6229fa1577e46a264f7027e2b8291880f0c4ed2df30fbdf8c53e1f2a3f736a33bafb32dc14ba04b5d6c3b10c54d4ce68c6b7ff6fcf8a695

data/README.md

@@ -32,41 +32,37 @@ $ 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:
+This gem uses an incoming webhook integration on Glip. To create a new Glip webhook integration, in Glip.com, click on "Integrations" in the left column and then select the "Glip Webhooks" integration. After you select a conversation, a webhook URL will be presented which you will use with 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. You must have a webhook URL configured in Glip using the "Glip Webhooks" integration.
+Initialize your poster and then call the `send_message` method to send your message. You must supply the webhook URL or webhook ID configured in the desired "Glip Webhooks" integration.
 
 ```ruby
-require 'glip-poster'
+require 'glip_poster' # note underscore
 
-poster = Glip::Poster.new(YOUR_WEBHOOK_URL)
+poster = Glip::Poster.new(YOUR_WEBHOOK_URL) # or YOUR_WEBHOOK_ID (GUID)
 poster.send_message('Hi there!') # Faraday::Response
 ```
 
 You can send text in Markdown:
 
 ```ruby
-poster = Glip::Poster.new(YOUR_WEBHOOK_URL)
-poster.send_message('* Location: [The Funky Buddha Lounge](http://www.thefunkybuddha.com)\n*Beer Advocate Rating: [99](http://tinyurl.com/psf4uzq)')
+poster.send_message("* Location: [The Funky Buddha Lounge](http://www.thefunkybuddha.com)\n*Beer Advocate Rating: [99](http://tinyurl.com/psf4uzq)")
 ```
 
 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"
+  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('Hi there!', options)
 ```
 

data/Rakefile

@@ -13,7 +13,6 @@ end
 
 desc 'Generate YARD documentation.'
 task :gendoc do
-  # puts 'yard doc generation disabled until JRuby build native extensions for redcarpet or yard removes the dependency.'
   system 'yardoc'
   system 'yard stats --list-undoc'
 end

data/glip-poster.gemspec

@@ -7,14 +7,14 @@ Gem::Specification.new do |s|
   s.name        = 'glip-poster'
   s.version     = version
   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.summary     = 'Glip Poster - Ruby SDK to post messages via Glip webhooks'
+  s.description = 'A Ruby SDK to post messages via Glip webhooks'
   s.authors     = ['John Wang']
   s.email       = 'johncwang@gmail.com'
   s.homepage    = 'https://github.com/grokify/'
   s.licenses    = ['MIT']
   s.files       = Dir['lib/**/**/*'] # + Dir['bin/*']
-  s.files      += Dir['[A-Z]*']    + Dir['test/**/*']
+  s.files      += Dir['[A-Z]*'] + Dir['test/**/*']
   # s.files.reject! { |fn| fn.include? "CVS" }
   # s.required_ruby_version = '>= 1.8.7' # 1.8.7+ is tested
   s.add_dependency 'faraday', '~> 0.9', '>= 0.9'

data/lib/glip-poster/poster.rb

@@ -3,7 +3,7 @@ require 'faraday_middleware'
 
 module Glip
   class Poster
-    VERSION = '0.0.3'
+    VERSION = '0.1.0'
     GLIP_WEBHOOK_BASE_URL = 'https://hooks.glip.com/webhook/'
 
     attr_reader :webhook_url
@@ -14,11 +14,11 @@ module Glip
       set_webhook_url(webhook_url_or_id)
 
       @options = {}
-      
-      @http = Faraday.new(:url => GLIP_WEBHOOK_BASE_URL) do |faraday|
-        faraday.request  :json
+
+      @http = Faraday.new(url: GLIP_WEBHOOK_BASE_URL) do |faraday|
+        faraday.request :json
         faraday.response :logger
-        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+        faraday.adapter Faraday.default_adapter # use Net::HTTP
       end
     end
 
@@ -28,15 +28,17 @@ module Glip
       elsif webhook_url_or_id =~ %r{^https?://}
         @webhook_url = webhook_url_or_id
       else
-        raise 'must include webhook URL or id argument'
+        fail ArgumentError, 'must include webhook URL or id argument'
       end
     end
 
-    def send_message(message, opts={})
-      return @http.post do |req|
+    def send_message(message, opts = {})
+      response = @http.post do |req|
         req.url @webhook_url
-        req.body = @options.merge(opts).merge({body: message})
+        req.body = @options.merge(opts).merge(body: message)
       end
+
+      response
     end
   end
 end

data/lib/glip_poster.rb

@@ -0,0 +1 @@
+require 'glip-poster/poster'

data/test/test_base.rb

@@ -3,6 +3,6 @@ Coveralls.wear!
 
 require 'test/unit'
 require 'mocha/test_unit'
-require 'glip-poster'
+require 'glip_poster'
 
 poster = Glip::Poster.new('deadbeef')

data/test/test_setup.rb

@@ -9,7 +9,7 @@ class GlipPosterTest < Test::Unit::TestCase
   end
 
   def test_url
-    url = 'https://hooks.glip.com/webhook/11111111-2222-3333-4444-555555555555'
+    url = 'https://hooks.glip.com/webhook/11112222-3333-4444-5555-666677778888'
     poster = Glip::Poster.new(url)
     assert_equal url, poster.webhook_url
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glip-poster
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - John Wang
@@ -50,7 +50,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A Ruby SDK for post messages via Glip webhooks
+description: A Ruby SDK to post messages via Glip webhooks
 email: johncwang@gmail.com
 executables: []
 extensions: []
@@ -63,8 +63,8 @@ files:
 - README.md
 - Rakefile
 - glip-poster.gemspec
-- lib/glip-poster.rb
 - lib/glip-poster/poster.rb
+- lib/glip_poster.rb
 - test/test_base.rb
 - test/test_setup.rb
 homepage: https://github.com/grokify/
@@ -90,5 +90,5 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Glip Poster - Ruby SDK for post messages via Glip webhooks
+summary: Glip Poster - Ruby SDK to post messages via Glip webhooks
 test_files: []

data/lib/glip-poster.rb

@@ -1 +0,0 @@
-require 'glip-poster/poster'