hangouts-chat 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6ed28c19b0253bb33ebc13670e57e1343330bc30da8af2640d999e47de6a362
-  data.tar.gz: 220f23a56aff96c3071ad412c8af9d3fd3e78428b28d4369d633039454f70899
+  metadata.gz: a8912faeb8ba44836f727d6808f70e52d5104b217a9f07c76c151b47cd15fd6c
+  data.tar.gz: bc62156c4dfd29a2f850ce00ca85b296a362f58d5bac8ee72cd66ae18b52851c
 SHA512:
-  metadata.gz: d4eda290a5d04e9a226c58ed144cb29804a9effe0047f3d31446561640b4502b405221e5b7456b5c16e309c269e4cd81eebb0cec02c84f4e8e8965a0874aa811
-  data.tar.gz: bb649deb7a85caf301d4aed009dcb3aac3cbd24b452172f22fafffacfaa7936b453c59fd71751835dad1cb182352415b4f1ac0a600b7eabd81017e43a92e0823
+  metadata.gz: 25bbbd87c104205605c1ff8a4e41a56e9103d30815b0e028b837a3bc4e6a63bb0851d23efdd54c47103fde804a406206c608e81cc6586e78e7ffd1d045573e87
+  data.tar.gz: c608f5466ad57ae5cb72f52c91dccadf225caa77d44ee05ad10885684329a78bdf44ba1c136625850c5861cb813edbe3993ee92e88c5964c79034977d03d6eb1

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 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

data/README.md

@@ -13,11 +13,26 @@ require 'hangouts-chat'
 ```
 
 ## Usage
+### 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 = [{ keyValue: { topLabel: 'Order No.', content: '12345' } },
+            { keyValue: { topLabel: 'Status', content: 'In Delivery' } }]
+
+sender.card(header, sections)
+```
+
 ### 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'
@@ -26,11 +41,18 @@ sender.simple 'text'
 
 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
 
-## Comments
-For now supported only [Simple Text Messages](https://developers.google.com/hangouts/chat/reference/message-formats/basic)
+## Tests
+All tests are use usual Minitest `assert` syntax.
+To run tests execute `rake tests`.
 
-## TODO
-* Errors reports
-* Support [Card messages](https://developers.google.com/hangouts/chat/reference/message-formats/cards)
-* README badges etc
+## Changelog
+Changelog is available [here](CHANGELOG.md).

data/lib/hangouts_chat/version.rb

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

data/lib/hangouts_chat.rb

@@ -24,6 +24,16 @@ module HangoutsChat
       send_request(payload)
     end
 
+    # Sends Card Message
+    # @since 0.0.4
+    # @param header [Hash] card header content
+    # @param sections [Array<Hash>] card widgets array
+    # @return [Net::HTTPResponse] response object
+    def card(header, sections)
+      payload = { cards: [header: header, sections: sections] }
+      send_request(payload)
+    end
+
     private
 
     # Sends payload and check response

data/test/hangouts_chat_test.rb

@@ -24,12 +24,26 @@ class HangoutsChatTest < Minitest::Test
       { 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 = [{ 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_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')
+      @sender.simple('Exception test')
     end
     assert_match(/^HTTP 403 Forbidden$/, exception.message)
     assert_match(/^Body:\nResponse body$/, exception.message)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hangouts-chat
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - enzinia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-25 00:00:00.000000000 Z
+date: 2018-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop