hangouts-chat 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28b2e028adbcf7dbe7ca389840a12c831d78b489dbc05ab5ffba189ffd735022
-  data.tar.gz: ac1ad9b4d55696001f3eb3f19c5654218d6dd420c350b819245defaaa086fbc8
+  metadata.gz: 69ed8b47b674154e8659e4089f70fe8f74bc7b6721a4cd6d9b907c487ad014b0
+  data.tar.gz: d3f323a0c4d91517cbfc40c643038d580c251925c146007a1befe1759809494c
 SHA512:
-  metadata.gz: 1fd3985550cfb69b9cc75e5c9d3b533eec64c7844823ffc5249f9ef0894a16cbb3522532780489394c13919c04424bbc690c68bf856d2d3d26f8559f1bd10bab
-  data.tar.gz: c3757efe0a005448322390d6b8275485f6fbb4a87a06ec4499dbe782360f792d0561f4332bcca1bc27db2c12f01b2b28d6101ff1ae8c73667199f5ee327810df
+  metadata.gz: 4c4f191fa52600b96c73850515a2dc3f1c95839ec3d528ec46123845ab87f62ac235da1f77348ddbe2697c314dacd7ccf94916065008d9aa8dab80db58d58647
+  data.tar.gz: b0ea2b1d2ebaf6c1a1d6e4b3614b46a4a15bafff09033a7f82dbfdebf29b7efe5298188a43df17f40733a26f4d4f570fb92ba60283554b281c8baf77c5b78183

data/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+
+## 0.1.0
+
+- Added ability to specify a thread when send messages (thanks to @hazi)
+
+## 0.0.6
+
+- Fixed proxy ENV support for ruby versions < 2.5.0
+
+## 0.0.5
+
+- Resolved missing dependencies for development and testing
+
+## 0.0.4
+
+- Added Card Messages support
+
+## 0.0.3
+
+- Added YARD documentation
+- Added HangoutsChat::Sender::APIError exception for unsuccessful responses
+
+## 0.0.2
+
+- Added tests
+- Improved appearance
+- Added and performed rubocop code analyze
+
+## 0.0.1
+
+- Initial version with Hangouts Chat simple text messages support

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 enzinia
+
+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,86 @@
+[![Gem Version](https://badge.fury.io/rb/hangouts-chat.svg)](https://badge.fury.io/rb/hangouts-chat)
+[![Build Status](https://travis-ci.org/enzinia/hangouts-chat.svg?branch=master)](https://travis-ci.org/enzinia/hangouts-chat)
+[![Maintainability](https://api.codeclimate.com/v1/badges/c6106eab23781ab0be46/maintainability)](https://codeclimate.com/github/enzinia/hangouts-chat/maintainability)
+[![Inline docs](http://inch-ci.org/github/enzinia/hangouts-chat.svg?branch=master)](http://inch-ci.org/github/enzinia/hangouts-chat)
+
+# Hangouts Chat gem
+Send messages to [Hangouts Chat](https://gsuite.google.com/products/chat/) rooms using incoming webhooks.
+
+## Installation
+```
+$ gem install hangouts-chat
+```
+
+or add to your Gemfile
+
+```
+gem 'hangouts-chat'
+```
+
+## Usage
+```ruby
+require 'hangouts_chat'
+```
+### Simple Text Message
+Simple messages that appear inline as if typed by a user. Details and format: [Simple Text Messages](https://developers.google.com/hangouts/chat/reference/message-formats/basic)
+```ruby
+sender = HangoutsChat::Sender.new 'webhook_URL'
+sender.simple 'text'
+```
+
+### Card Message
+More complex messages that have UI elements with actions and HTML support. Details and format: [Card messages](https://developers.google.com/hangouts/chat/reference/message-formats/cards)
+```ruby
+sender = HangoutsChat::Sender.new 'webhook_URL'
+header = { title: 'Pizza Bot Customer Support',
+           subtitle: 'pizzabot@example.com',
+           imageUrl: 'https://goo.gl/aeDtrS' }
+sections = [{ widgets: [{ keyValue: { topLabel: 'Order No.', content: '12345' } },
+                        { keyValue: { topLabel: 'Status', content: 'In Delivery' } }] }]
+
+sender.card(header, sections)
+```
+
+### Message to thread
+
+```ruby
+# Create new thread
+sender = HangoutsChat::Sender.new 'webhook_URL'
+res = sender.simple 'text'
+
+# Response parse
+res_json = JSON.parse(res.body)
+thread_name = res_json.dig("thread", "name") #=> "spaces/SPACES_ID/threads/THREADS_ID"
+
+# Send to thread (simple)
+sender.simple('res message', thread: thread_name)
+
+# Send to thread (card)
+header = {...}
+sections = {...}
+sender.card(header, sections, thread: thread_name)
+```
+
+### How to get Webhook URL
+1. Open channel to which you want to send messages
+2. Click on the channel name in top bar and select 'Configure webhooks'
+3. Click on 'Add webhook' and fill name for bot, that will be display messages
+4. Click on 'Save' and copy 'Webhook URL'
+
+Details: [Setting up an incoming webhook](https://developers.google.com/hangouts/chat/how-tos/webhooks)
+
+## Contributing
+Please feel free to contribute any changes, that you want too see in this gem.
+Feature requests are also accepted.
+
+Before Pull Request submitting please check
+* Changed or added code has tests and YARD documentation
+* All tests are pass
+* `rubocop` doesn't report any offenses
+
+## Tests
+All tests are use usual Minitest `assert` syntax.
+To run tests execute `rake tests`.
+
+## Changelog
+Changelog is available [here](CHANGELOG.md).

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+desc 'Run tests'
+task default: :test

data/lib/hangouts_chat.rb

@@ -1,16 +1,54 @@
 require_relative 'hangouts_chat/version'
 require_relative 'hangouts_chat/http'
+require_relative 'hangouts_chat/exceptions'
 
+# Main namespace
 module HangoutsChat
+  # Provide methods to send messages to Hangouts Chat rooms using webhooks API
   class Sender
+    # @return [String] Webhook URL, given on initialization
+    attr_reader :url
+
+    # Creates Sender object
+    # @param webhook_url [String] URL for incoming webhook
     def initialize(webhook_url)
       @url = webhook_url
       @http = HTTP.new(@url)
     end
 
-    def simple(text)
+    # Sends Simple Text Message
+    # @param text [String] text to send to room
+    # @param thread [String] it will be sent as a reply (`nil` is a new thread will be created)
+    # @return [Net::HTTPResponse] response object
+    def simple(text, thread: nil)
       payload = { text: text }
-      @http.post payload
+      send_request(payload, thread: thread)
+    end
+
+    # Sends Card Message
+    # @since 0.0.4
+    # @param header [Hash] card header content
+    # @param sections [Array<Hash>] card widgets array
+    # @param thread [String] it will be sent as a reply (`nil` is a new thread will be created)
+    # @return [Net::HTTPResponse] response object
+    def card(header, sections, thread: nil)
+      payload = { cards: [header: header, sections: sections] }
+      send_request(payload, thread: thread)
+    end
+
+    private
+
+    # Sends payload and check response
+    # @param payload [Hash] data to send by POST
+    # @param thread [String] it will be sent as a reply (`nil` is a new thread will be created)
+    # @return [Net::HTTPResponse] response object
+    # @raise [APIError] if got unsuccessful response
+    def send_request(payload, thread: nil)
+      payload[:thread] = { name: thread } if thread
+
+      response = @http.post payload
+      raise APIError, response unless response.is_a?(Net::HTTPSuccess)
+      response
     end
   end
 end

data/lib/hangouts_chat/exceptions.rb

@@ -0,0 +1,16 @@
+require 'net/http/response'
+
+module HangoutsChat
+  class Sender
+    # Unsuccessful API respond exception
+    class APIError < StandardError
+      # Creates exception object with generated message
+      # @param response [Net::HTTPResponse] API response
+      def initialize(response)
+        msg = "HTTP #{response.code} #{response.msg}\n"
+        msg += "Body:\n#{response.body}"
+        super(msg)
+      end
+    end
+  end
+end

data/lib/hangouts_chat/http.rb

@@ -3,20 +3,28 @@ require 'json'
 
 module HangoutsChat
   class Sender
+    # Unsuccessful respond exception
+    class APIError < StandardError; end
+
+    # Service class to send HTTP POST requests
     class HTTP
+      # Creates HTTP::Post object with JSON content type
+      # @param url [String] URL to send request
       def initialize(url)
         @uri = URI(url)
         @req = Net::HTTP::Post.new(@uri)
         @req['Content-Type'] = 'application/json'
       end
 
+      # Sends HTTP POST request
+      # @param payload [String] request body to send
+      # @return [Net::HTTPResponse] response object
       def post(payload)
         @req.body = payload.to_json
 
-        res = Net::HTTP.start(@uri.hostname, @uri.port, use_ssl: true) do |http|
+        Net::HTTP.start(@uri.hostname, @uri.port, :ENV, use_ssl: true) do |http|
           http.request(@req)
         end
-        res
       end
     end
   end

data/lib/hangouts_chat/version.rb

@@ -1,3 +1,4 @@
 module HangoutsChat
-  VERSION = '0.0.2'.freeze
+  # Library version
+  VERSION = '0.1.0'.freeze
 end

data/test/hangouts_chat_test.rb

@@ -23,4 +23,55 @@ class HangoutsChatTest < Minitest::Test
     assert_requested :post, @webhook_url, times: 1, body:
       { text: message }.to_json
   end
+
+  def test_card_message_request
+    stub_request(:any, /chat\.googleapis\.com/).to_return(status: 200)
+    header = { title: 'Pizza Bot Customer Support',
+               subtitle: 'pizzabot@example.com',
+               imageUrl: 'https://goo.gl/aeDtrS' }
+    sections = [{ widgets: [{ keyValue: { topLabel: 'Order No.', content: '12345' } },
+                            { keyValue: { topLabel: 'Status', content: 'In Delivery' } }] }]
+
+    @sender.card(header, sections)
+
+    assert_requested :post, @webhook_url, times: 1, body:
+      { cards: [header: header, sections: sections] }.to_json
+  end
+
+  def test_simple_message_threaded_request
+    stub_request(:any, /chat\.googleapis\.com/).to_return(status: 200)
+    message = 'Test simple message'
+    thread = 'spaces/space_id/threads/threads_id'
+
+    @sender.simple(message, thread: thread)
+
+    assert_requested :post, @webhook_url, times: 1, body:
+      { text: message, thread: { name: thread} }.to_json
+  end
+
+  def test_card_message_threaded_request
+    stub_request(:any, /chat\.googleapis\.com/).to_return(status: 200)
+    header = { title: 'Pizza Bot Customer Support',
+               subtitle: 'pizzabot@example.com',
+               imageUrl: 'https://goo.gl/aeDtrS' }
+    sections = [{ widgets: [{ keyValue: { topLabel: 'Order No.', content: '12345' } },
+                            { keyValue: { topLabel: 'Status', content: 'In Delivery' } }] }]
+    thread = 'spaces/space_id/threads/threads_id'
+
+    @sender.card(header, sections, thread: thread)
+
+    assert_requested :post, @webhook_url, times: 1, body:
+      { cards: [header: header, sections: sections], thread: { name: thread} }.to_json
+  end
+
+  def test_api_error_exception_message
+    stub_request(:any, /chat\.googleapis\.com/)
+      .to_return(status: [403, 'Forbidden'], body: 'Response body')
+
+    exception = assert_raises HangoutsChat::Sender::APIError do
+      @sender.simple('Exception test')
+    end
+    assert_match(/^HTTP 403 Forbidden$/, exception.message)
+    assert_match(/^Body:\nResponse body$/, exception.message)
+  end
 end

data/test/test_helper.rb

@@ -1,5 +1,5 @@
 require 'minitest/autorun'
 require 'webmock/minitest'
-require 'hangouts-chat'
+require 'hangouts_chat'
 
 WebMock.disable_net_connect!(net_http_connect_on_start: true)

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: hangouts-chat
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - enzinia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-21 00:00:00.000000000 Z
+date: 2021-02-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -38,18 +66,42 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
-description: |-
-  Send messages to G Suite Hangouts Chat rooms using
-                       incoming webhooks and Net::HTTP::Post
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+description: Send messages to G Suite Hangouts Chat rooms using incoming webhooks
+  and Net::HTTP::Post
 email: vkukovskij@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
 - lib/hangouts_chat.rb
+- lib/hangouts_chat/exceptions.rb
 - lib/hangouts_chat/http.rb
 - lib/hangouts_chat/version.rb
-- test/hangouts-chat/http_test.rb
+- test/hangouts_chat/http_test.rb
 - test/hangouts_chat_test.rb
 - test/test_helper.rb
 homepage: https://github.com/enzinia/hangouts-chat
@@ -71,12 +123,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Library for sending messages to Hangouts Chat rooms
 test_files:
-- test/hangouts-chat/http_test.rb
-- test/hangouts_chat_test.rb
 - test/test_helper.rb
+- test/hangouts_chat_test.rb
+- test/hangouts_chat/http_test.rb