glip-poster 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b72ca65835c0688d71743550c8109b05598e1359
+  data.tar.gz: 8ea536b2c136393622648fb818c18536b4e7fba1
+SHA512:
+  metadata.gz: 85189e54802e9e589c1ace75df7557eedf27f0d85af38b6fbfea1ecafbf5a4fd2a8f7ea6e6f1f41388e8e25cbff6e1a15d5eae2df262f0877a4cdad0e77ce8f3
+  data.tar.gz: 599b917ea7a74090050e4f3f161fb41b80f648ab3f6b891a1c1c55118a7d44d4d6711da74551ee254bb1bcc87081d1f569503124cf5dd93801ccc64eb4811609

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+CHANGELOG
+---------
+- **2016-01-30**: 0.0.1
+  - Initial release
+  

data/Gemfile

@@ -0,0 +1,10 @@
+source ENV['GEM_SOURCE'] || 'https://rubygems.org'
+
+gem 'coveralls'
+gem 'faraday', '~> 0.9.0'
+gem 'faraday_middleware'
+gem 'logger'
+gem 'mocha'
+gem 'rake'
+gem 'simplecov'
+gem 'test-unit'

data/Gemfile.lock

@@ -0,0 +1,63 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coveralls (0.8.10)
+      json (~> 1.8)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.11.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6.0)
+    docile (1.1.5)
+    domain_name (0.5.25)
+      unf (>= 0.0.5, < 1.0.0)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.10.0)
+      faraday (>= 0.7.4, < 0.10)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    json (1.8.3)
+    logger (1.2.8)
+    metaclass (0.0.4)
+    mime-types (2.99)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    multipart-post (2.0.0)
+    netrc (0.11.0)
+    power_assert (0.2.7)
+    rake (10.5.0)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    simplecov (0.11.1)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    test-unit (3.1.7)
+      power_assert
+    thor (0.19.1)
+    tins (1.6.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls
+  faraday (~> 0.9.0)
+  faraday_middleware
+  logger
+  mocha
+  rake
+  simplecov
+  test-unit
+
+BUNDLED WITH
+   1.11.2

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 John Wang
+ 
+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,123 @@
+Glip Poster
+========================
+
+[![Gem Version][gem-version-svg]][gem-version-link]
+[![Build Status][build-status-svg]][build-status-link]
+[![Coverage Status][coverage-status-svg]][coverage-status-link]
+[![Dependency Status][dependency-status-svg]][dependency-status-link]
+[![Code Climate][codeclimate-status-svg]][codeclimate-status-link]
+[![Scrutinizer Code Quality][scrutinizer-status-svg]][scrutinizer-status-link]
+[![Downloads][downloads-svg]][downloads-link]
+[![Docs][docs-rubydoc-svg]][docs-rubydoc-link]
+[![License][license-svg]][license-link]
+
+## Installation
+
+### Via Bundler
+
+Add 'glip-poster' to Gemfile and then run `bundle`:
+
+```sh
+$ echo "gem 'glip-poster'" >> Gemfile
+$ bundle
+```
+
+### Via RubyGems
+
+```sh
+$ gem install glip-poster
+```
+
+## Usage
+
+First you have to initialize your poster and then you can use `send_message` to send your message.
+
+```ruby
+poster = Glip::Poster.new(YOUR_WEBHOOK_URL)
+poster.send_message('Hello World!') # 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)')
+```
+
+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",
+}
+poster = Glip::Poster.new(YOUR_WEBHOOK_URL)
+poster.send_message('Hello Beer!', options)
+```
+
+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!')
+```
+
+## Supported Ruby Versions
+
+This library supports and is [tested against](https://travis-ci.org/grokify/glip-poster-ruby) the following Ruby implementations:
+
+1. Ruby 2.3.0
+2. Ruby 2.2.0
+3. Ruby 2.1.0
+4. Ruby 2.0.0
+5. Ruby 1.9.3
+6. [JRuby](http://jruby.org/)
+7. [Rubinius](http://rubinius.com/)
+
+## Releases
+
+Releases with release notes are availabe on [GitHub releases](https://github.com/grokify/glip-poster/releases). Release notes include a high level description of the release as well as lists of non-breaking and breaking changes.
+
+### Change Log
+
+See [CHANGELOG.md](CHANGELOG.md)
+
+## Links
+
+Project Repo
+
+* https://github.com/grokify/glip-poster-ruby
+
+Glip
+
+* https://glip.com
+
+## Contributing
+
+1. Fork it ( http://github.com/grokify/glip-poster-ruby/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 new Pull Request
+
+ [gem-version-svg]: https://badge.fury.io/rb/glip-poster.svg
+ [gem-version-link]: http://badge.fury.io/rb/glip-poster
+ [downloads-svg]: http://ruby-gem-downloads-badge.herokuapp.com/glip-poster
+ [downloads-link]: https://rubygems.org/gems/glip-poster
+ [build-status-svg]: https://api.travis-ci.org/grokify/glip-poster-ruby.svg?branch=master
+ [build-status-link]: https://travis-ci.org/grokify/glip-poster-ruby
+ [coverage-status-svg]: https://coveralls.io/repos/grokify/glip-poster-ruby/badge.svg?branch=master
+ [coverage-status-link]: https://coveralls.io/r/grokify/glip-poster-ruby?branch=master
+ [dependency-status-svg]: https://gemnasium.com/grokify/glip-poster-ruby.svg
+ [dependency-status-link]: https://gemnasium.com/grokify/glip-poster-ruby
+ [codeclimate-status-svg]: https://codeclimate.com/github/grokify/glip-poster-ruby/badges/gpa.svg
+ [codeclimate-status-link]: https://codeclimate.com/github/grokify/glip-poster-ruby
+ [scrutinizer-status-svg]: https://scrutinizer-ci.com/g/grokify/glip-poster-ruby/badges/quality-score.png?b=master
+ [scrutinizer-status-link]: https://scrutinizer-ci.com/g/grokify/glip-poster-ruby/?branch=master
+ [docs-rubydoc-svg]: https://img.shields.io/badge/docs-rubydoc-blue.svg
+ [docs-rubydoc-link]: http://www.rubydoc.info/gems/glip-poster/
+ [license-svg]: https://img.shields.io/badge/license-MIT-blue.svg
+ [license-link]: https://github.com/grokify/glip-poster-ruby/blob/master/LICENSE.txt

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the library.'
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/test_*.rb'
+  t.verbose = false
+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

@@ -0,0 +1,22 @@
+lib = 'glip-poster'
+lib_file = File.expand_path("../lib/#{lib}/poster.rb", __FILE__)
+File.read(lib_file) =~ /\bVERSION\s*=\s*["'](.+?)["']/
+version = $1
+
+Gem::Specification.new do |s|
+  s.name        = 'glip-poster'
+  s.version     = version
+  s.date        = '2016-01-30'
+  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']
+  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.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'
+  s.add_dependency 'faraday_middleware', '~> 0', '>= 0'
+end

data/lib/glip-poster.rb

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

data/lib/glip-poster/poster.rb

@@ -0,0 +1,46 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module Glip
+  class Poster
+    VERSION = '0.0.1'
+    GLIP_WEBHOOK_BASE_URL = 'https://hooks.glip.com/webhook/'
+
+    attr_reader :webhook_url
+    attr_accessor :options
+    attr_accessor :http
+
+    def initialize(webhook_url_or_id)
+      webhook_uri(webhook_url_or_id)
+
+      @options = {}
+      
+      @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
+      end
+    end
+
+    def webhook_uri(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?://}
+        @webhook_url = webhook_url_or_id
+      else
+        raise 'must include webhook URL or id argument'
+      end
+    end
+
+    def send_message(message, opts={})
+      opts = @options.merge opts
+      opts[:body] = message
+
+      res = @http.post do |req|
+        req.url @webhook_url
+        req.body = opts
+      end
+      return res
+    end
+  end
+end

data/test/test_base.rb

@@ -0,0 +1,8 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'test/unit'
+require 'mocha/test_unit'
+require 'glip-poster'
+
+poster = Glip::Poster.new('deadbeef')

data/test/test_setup.rb

@@ -0,0 +1,42 @@
+require './test/test_base.rb'
+
+class GlipPosterTest < Test::Unit::TestCase
+  def test_setup
+    poster = Glip::Poster.new('deadbeef')
+
+    assert_equal 'Glip::Poster', poster.class.name
+    assert_equal 'https://hooks.glip.com/webhook/deadbeef', poster.webhook_url
+  end
+
+  def test_url
+    url = 'https://hooks.glip.com/webhook/11111111-2222-3333-4444-555555555555'
+    poster = Glip::Poster.new(url)
+    assert_equal url, poster.webhook_url
+  end
+
+  def test_farday
+    poster = Glip::Poster.new('deadbeef')
+    Faraday::Connection.any_instance.stubs(:post).returns(Faraday::Response.new)
+    res = poster.send_message('Hello World!')
+    assert_equal 'Faraday::Response', res.class.name
+  end
+
+  def test_raise
+    assert_raise do
+      poster = Glip::Poster.new
+    end
+
+    assert_raise do
+      poster = Glip::Poster.new('dead/beef')
+    end
+  end
+
+  def test_options
+    poster = Glip::Poster.new('deadbeef')
+
+    assert_equal true, poster.options.is_a?(Hash)
+
+    poster.options[:icon] = 'http://example.com/icon.png'
+    assert_equal 'http://example.com/icon.png', poster.options[:icon]
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: glip-poster
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Wang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby SDK for post messages via Glip webhooks
+email: johncwang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- glip-poster.gemspec
+- lib/glip-poster.rb
+- lib/glip-poster/poster.rb
+- test/test_base.rb
+- test/test_setup.rb
+homepage: https://github.com/grokify/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Glip Poster - Ruby SDK for post messages via Glip webhooks
+test_files: []