hangouts-chat 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28b2e028adbcf7dbe7ca389840a12c831d78b489dbc05ab5ffba189ffd735022
-  data.tar.gz: ac1ad9b4d55696001f3eb3f19c5654218d6dd420c350b819245defaaa086fbc8
+  metadata.gz: d6ed28c19b0253bb33ebc13670e57e1343330bc30da8af2640d999e47de6a362
+  data.tar.gz: 220f23a56aff96c3071ad412c8af9d3fd3e78428b28d4369d633039454f70899
 SHA512:
-  metadata.gz: 1fd3985550cfb69b9cc75e5c9d3b533eec64c7844823ffc5249f9ef0894a16cbb3522532780489394c13919c04424bbc690c68bf856d2d3d26f8559f1bd10bab
-  data.tar.gz: c3757efe0a005448322390d6b8275485f6fbb4a87a06ec4499dbe782360f792d0561f4332bcca1bc27db2c12f01b2b28d6101ff1ae8c73667199f5ee327810df
+  metadata.gz: d4eda290a5d04e9a226c58ed144cb29804a9effe0047f3d31446561640b4502b405221e5b7456b5c16e309c269e4cd81eebb0cec02c84f4e8e8965a0874aa811
+  data.tar.gz: bb649deb7a85caf301d4aed009dcb3aac3cbd24b452172f22fafffacfaa7936b453c59fd71751835dad1cb182352415b4f1ac0a600b7eabd81017e43a92e0823

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 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,36 @@
+# 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
+
+```ruby
+require 'hangouts-chat'
+```
+
+## Usage
+```ruby
+sender = HangoutsChat::Sender.new 'webhook_URL'
+sender.simple 'text'
+```
+
+### 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)
+
+
+## Comments
+For now supported only [Simple Text Messages](https://developers.google.com/hangouts/chat/reference/message-formats/basic)
+
+## TODO
+* Errors reports
+* Support [Card messages](https://developers.google.com/hangouts/chat/reference/message-formats/cards)
+* README badges etc

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,39 @@
 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
 
+    # Sends Simple Text Message
+    # @param text [String] text to send to room
+    # @return [Net::HTTPResponse] response object
     def simple(text)
       payload = { text: text }
-      @http.post payload
+      send_request(payload)
+    end
+
+    private
+
+    # Sends payload and check response
+    # @param payload [Hash] data to send by POST
+    # @return [Net::HTTPResponse] response object
+    # @raise [APIError] if got unsuccessful response
+    def send_request(payload)
+      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,13 +3,22 @@ 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
 

data/lib/hangouts_chat/version.rb

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

data/test/hangouts_chat_test.rb

@@ -23,4 +23,15 @@ class HangoutsChatTest < Minitest::Test
     assert_requested :post, @webhook_url, times: 1, body:
       { text: message }.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('Test exception')
+    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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hangouts-chat
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - enzinia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-21 00:00:00.000000000 Z
+date: 2018-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -38,18 +38,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
@@ -77,6 +101,6 @@ 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/http_test.rb
 - test/hangouts_chat_test.rb
 - test/test_helper.rb