google-hangout-webhook 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 85342443ed01bd0c54548359048667e8c1d8145e60e97cb41f204e80cae95043
+  data.tar.gz: 2c9a0360b9d6c118506481f09d785181abec2905f5a7556b0822a80695faa297
+SHA512:
+  metadata.gz: 2cce7864122a598a2243b1319c724ab5d79351d42f96ced7d24328fe57477772494134c570d79668884639d99d7dee47b75717a667643a8ac8330d3193f527cb
+  data.tar.gz: 98bec277e4d9b21db70d5842ce2053da145d563b8abbcfd54ca5366f51cfcaaaf267630146f471b58ff12e2f0a1f4d10cbca9de50740539442c4d7508290f7b6

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/.idea
+/google-hangout-webhook-*
+/Gemfile.lock
+/hangout.yml

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+### Version - 0.0.1
+
+* Specify yml configure file
+* Setup pre message (if needed)
+* Send message to google hangout

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in google-hangout-webhook.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Saimon Lovell
+
+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,101 @@
+# Google Hangout Webhook
+
+This gem allows you to use google webhook to send messages.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'google-hangout-webhook'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install google-hangout-webhook
+
+## Configuration
+
+You will have to create a webhook first.
+To learn how to create a webhook please visit here
+[Incoming webhooks](https://www.youtube.com/watch?time_continue=1&v=ThKvlgnLyDk).  
+Once you have created a webhook take the **name** of the webhook and use it as
+**channel** name.
+
+If you are using Rails then run the rake task
+`bundle exec rake google_hangout:setup` with will create all the necessary files
+below.
+
+Create a yml configuration file (if you have not used the rake task above) that
+will have all the necessary data which you should put in your **.gitignore** file.
+Lets assume you create a file called **google-hangout.yml** in **config** folder.
+Now the file should look similar to this below:
+
+```yml
+---
+channels:
+  sync:
+    url: 'https://chat.googleapis.com/v1/spaces/...../messages?key=...&token=....'
+
+  import:
+    url: 'https://chat.googleapis.com/v1/spaces/...../messages?key=...&token=....'
+
+  export:
+    url: 'https://chat.googleapis.com/v1/spaces/...../messages?key=...&token=....'
+```
+
+The channels are just a label for your convenience. They can be anything and
+does not have to match the webhook name at all. All channel names must be lower
+case (if possible) and should not have any spaces or special characters in them.
+Think of it as you are declaring a variable. You can use any webhook at any
+time using the channels.
+
+## Rails
+
+For Rails create a file in the **initializers** folder and put the following.
+
+```ruby
+GoogleHangout = Google::Hangout::Webhook::Message.new('config/google-hangout.yml')
+```
+
+## Usage
+
+First create an instance of the class and pass the location where you have your
+hangout Configuration (as mentioned above). Then just broadcast your message
+using a channel name.
+
+```ruby
+# Skip first line if you are using Rails
+GoogleHangout = Google::Hangout::Webhook::Message.new('config/google-hangout.yml')
+
+GoogleHangout.broadcast(:sync, 'Something went wrong with sync ID....')
+GoogleHangout.broadcast(:import, 'Failed to import file...')
+GoogleHangout.broadcast(:export, 'Export timed out for report ID...')
+```
+
+The method **broadcast** takes two parameters.
+First is the channel and second is the text message.
+```ruby
+GoogleHangout.broadcast(<channel>, <message>)
+```
+
+For more information regarding how you can style the text please visit:
+[Simple Text Messages](https://developers.google.com/hangouts/chat/reference/message-formats/basic)
+
+
+#### Pre-Message
+
+If you want to setup a pre-message that will prepend to all message string then after creating
+instance of the class just set the **pre_message** as shown below.
+
+```ruby
+GoogleHangout.pre_message = ['*', Rails.env.capitalize, "*\n"].join
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "google/hangout/webhook"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/google-hangout-webhook.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'google/hangout/webhook/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'google-hangout-webhook'
+  spec.version       = Google::Hangout::Webhook::VERSION
+  spec.authors       = ['Saimon Lovell']
+  spec.email         = ['staysynchronize@gmail.com']
+
+  spec.summary       = %q{Google Hangout Webhook}
+  spec.description   = %q{This gem allows you ruby application or rails to send webhook messages to Google hangout.}
+  spec.homepage      = 'https://gitlab.com/slovell/google-hangout-webhook'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://gitlab.com/slovell/google-hangout-webhook'
+    spec.metadata['changelog_uri'] = 'https://gitlab.com/slovell/google-hangout-webhook/blob/master/CHANGELOG.md'
+  else
+    raise 'RubyGems 2.1 or newer is required to protect against public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rest-client', '~> 2.0'
+
+  spec.add_development_dependency 'pry', '~> 0.1'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/hangout.example.yml

@@ -0,0 +1,10 @@
+---
+channels:
+  sync:
+    url: 'https://chat.googleapis.com/v1/spaces/...../messages?key=...&token=....'
+
+  import:
+    url: 'https://chat.googleapis.com/v1/spaces/...../messages?key=...&token=....'
+
+  export:
+    url: 'https://chat.googleapis.com/v1/spaces/...../messages?key=...&token=....'

data/lib/google/hangout/Rakefile

@@ -0,0 +1,2 @@
+path = File.expand_path(__dir__)
+Dir.glob("#{path}/tasks/**/*.rake").each { |f| import f }

data/lib/google/hangout/railtie.rb

@@ -0,0 +1,12 @@
+require 'rails'
+
+module Google::Hangout::Webhook
+  class Railtie < Rails::Railtie
+    railtie_name 'google-hangout-webhook'
+
+    rake_tasks do
+      path = File.expand_path(__dir__)
+      Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+    end
+  end
+end

data/lib/google/hangout/tasks/google_hangout.rake

@@ -0,0 +1,43 @@
+namespace :google_hangout do
+  desc 'Setup an example config yaml file for google hangout webhook'
+  task :setup do
+    puts ''
+    puts 'Setting up google hangout webhooks...'
+    puts ''
+    config_file = Rails.root.join('config/google-hangout.yml').to_s
+    initializer_file = Rails.root.join('config/initializers/google_hangout_webhook.rb').to_s
+
+    if File.exist?(config_file)
+      puts 'Config file already exist! Skipping'
+    else
+      puts 'Creating [config/google-hangout.yml] file.'
+      File.open(config_file, 'w') do |file|
+        file.write('---')
+        file.write("\n")
+        file.write('channels:')
+        file.write("\n")
+        file.write('  cheannel_name:')
+        file.write("\n")
+        file.write('    url: \'https://chat.googleapis.com/v1/spaces/...../messages?key=...&token=....\'')
+        file.write("\n")
+      end
+    end
+
+    if File.exist?(initializer_file)
+      puts 'setup file already exist in initializers. Skipping'
+    else
+      puts 'Creating [config/initializers/google_hangout_webhook.rb] file.'
+      File.open(initializer_file, 'w') do |file|
+        file.write('GoogleHangout = Google::Hangout::Webhook::Message.new(\'config/google-hangout.yml\')')
+        file.write("\n")
+        file.write('GoogleHangout.pre_message = [\'*\', Rails.env.upcase, "*\n"].join')
+        file.write("\n")
+      end
+    end
+
+    puts ''
+    puts 'Process complete.'
+    puts ''
+    true
+  end
+end

data/lib/google/hangout/webhook.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'google/hangout/webhook/version'
+require 'google/hangout/railtie.rb' if defined?(Rails)
+
+require 'rest-client'
+require 'yaml'
+require 'json'
+
+
+module Google
+  module Hangout
+    module Webhook
+      class Message
+        attr_accessor :config_path, :settings, :pre_message, :response
+        
+        def initialize(config_path)
+          self.config_path = config_path
+          self.settings = YAML.load_file(config_path)
+          self.pre_message = ''
+        end
+
+        def reload
+          self.settings = YAML.load_file(config_path)
+        end
+
+        def broadcast(channel, message)
+          raise "Channel name #{channel.to_s} not found" if settings['channels'][channel.to_s].nil?
+          raise "Channel url is missing" if settings['channels'][channel.to_s]['url'].nil?
+
+          self.response = RestClient.post(
+            settings['channels'][channel.to_s]['url'],
+            { text: [pre_message, message].join }.to_json,
+            { content_type: :json, accept: :json }
+          )
+        rescue StandardError => e
+          error = "Google Hangout Error: #{e.message}"
+          puts error
+          raise error
+        end
+
+      end
+    end
+  end
+end

data/lib/google/hangout/webhook/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Google
+  module Hangout
+    module Webhook
+      VERSION = '0.0.1'
+    end
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: google-hangout-webhook
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Saimon Lovell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This gem allows you ruby application or rails to send webhook messages
+  to Google hangout.
+email:
+- staysynchronize@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- google-hangout-webhook.gemspec
+- hangout.example.yml
+- lib/google/hangout/Rakefile
+- lib/google/hangout/railtie.rb
+- lib/google/hangout/tasks/google_hangout.rake
+- lib/google/hangout/webhook.rb
+- lib/google/hangout/webhook/version.rb
+homepage: https://gitlab.com/slovell/google-hangout-webhook
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://gitlab.com/slovell/google-hangout-webhook
+  source_code_uri: https://gitlab.com/slovell/google-hangout-webhook
+  changelog_uri: https://gitlab.com/slovell/google-hangout-webhook/blob/master/CHANGELOG.md
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Google Hangout Webhook
+test_files: []