buyerquest-opsgenie 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7770ed270998613b5497081250267d578a379d2353e0437238d6d6775bd6edef
+  data.tar.gz: 25913c9427c13b1f6059c6a626189618bec43fcb11d9c773de7cb301ebac7d51
+SHA512:
+  metadata.gz: c3f804c32619e73883050936f33f6cfed8757c633c77eaddeb2e4f23b5afc801afcc17855b93a8ff1559491defec4cc170eb42452c6174e60c32917625bb1110
+  data.tar.gz: 6185e714b3c59f410a4aa82d20c5437be09cc6da7eefcf389c3e39c854d57d89415ac7100fb51c284a7679b334527460ace2753885e1213d3e524dd6a41ae08c

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.idea
+./*.gem

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in buyerquest-opsgenie.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    buyerquest-opsgenie (0.1.0)
+      rest-client (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (3.3)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    netrc (0.11.0)
+    rake (10.5.0)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  buyerquest-opsgenie!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/README.md

@@ -0,0 +1,64 @@
+# Buyerquest Opsgenie Ruby gem
+
+This gem provides opsgenie related functionality
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'buyerquest-opsgenie'
+```
+
+And then execute:
+
+```shell
+$ bundle install
+```
+
+Or install it directly:
+
+```shell
+$ gem install buyerquest-opsgenie
+```
+
+## Usage
+
+### Alert creation
+Example:
+```ruby
+require 'buyerquest/opsgenie'
+
+# Initialise client singleton
+Buyerquest::Opsgenie::Client.init 'your-api-key-here'
+# alternatively export OPSG_API_KEY to the runtime environment and then call without any arguments:
+# Buyerquest::Opsgenie::Client.init
+
+# Prepare alert object instance
+test_alert = Buyerquest::Opsgenie::Alert.new(message: "I'm an alert from the buyerquest-opsgenie gem",
+                                             alias: 'no-duplication',
+                                             description: 'buyerquest-opsgenie gem alert')
+
+# Fire alert
+test_alert.create
+```
+
+### Heartbeat usage
+```ruby
+require 'buyerquest/opsgenie'
+
+# Initialise client singleton
+Buyerquest::Opsgenie::Client.init 'your-api-key-here'
+# alternatively export OPSG_API_KEY to the runtime environment and then call without any arguments:
+# Buyerquest::Opsgenie::Client.init
+
+# Prepare alert object instance
+test_heartbeat = Buyerquest::Opsgenie::Heartbeat.new(name: 'Test heartbeat')
+
+# Start heartbeat
+test_heartbeat.start
+```
+
+## Testing
+
+Run `rake spec` to start the test suite.

data/Rakefile

@@ -0,0 +1,7 @@
+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 "buyerquest/opsgenie"
+
+# 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/buyerquest-opsgenie.gemspec

@@ -0,0 +1,45 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "buyerquest/opsgenie/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "buyerquest-opsgenie"
+  spec.version       = Buyerquest::Opsgenie::VERSION
+  spec.authors       = ["Buyerquest DevOps Team"]
+  spec.email         = ["devops@buyerquest.com"]
+
+  spec.summary       = %q{BuyerQuest OpsGenie gem}
+  spec.description   = %q{Allows to interact with OpsGenie api. Alerts and Heartbeat operations}
+  spec.homepage      = "https://github.com/BuyerQuest/buyerquest-opsgenie"
+  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)
+    # We are going to publish rubygems
+    #spec.metadata["allowed_push_host"] = ""
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/BuyerQuest/buyerquest-opsgenie"
+    spec.metadata["changelog_uri"]   = "https://github.com/BuyerQuest/buyerquest-opsgenie"
+  else
+    raise "RubyGems 2.0 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|\.idea|\.gitignore)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency('rest-client', '~> 2.0')
+end

data/exe/opsgenie-client

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "buyerquest/opsgenie"
+
+puts "Not implemented for now"

data/lib/buyerquest-opsgenie.rb

@@ -0,0 +1,2 @@
+# Alias for require
+require 'buyerquest/opsgenie'

data/lib/buyerquest/opsgenie.rb

@@ -0,0 +1,14 @@
+require 'rest-client'
+require 'json'
+require 'uri'
+require 'buyerquest/opsgenie/version'
+require 'buyerquest/opsgenie/client'
+require 'buyerquest/opsgenie/heartbeat'
+require 'buyerquest/opsgenie/alert'
+
+
+module Buyerquest
+  module Opsgenie
+    class Error < StandardError; end
+  end
+end

data/lib/buyerquest/opsgenie/alert.rb

@@ -0,0 +1,32 @@
+module Buyerquest
+  module Opsgenie
+    class Alert
+      # @param [Hash]
+      # @option opts [String] message
+      # @option opts [String] alias
+      # @option opts [String] description
+      # @option opts [Array] tags
+      # @option opts [Hash] details
+      def initialize(opts={})
+        @message = opts[:message]
+        @opts = opts
+      end
+
+      def create
+        opsg_request ={
+            :method  => 'POST',
+            :uri     => '/alerts',
+            :payload => {
+                :message      => @message,
+                :alias        => @opts[:alias],
+                :description  => @opts[:description],
+                :tags         => @opts[:tags],
+                :details      => @opts[:details],
+            }
+        }
+
+        Buyerquest::Opsgenie::Client.execute opsg_request
+      end
+    end
+  end
+end

data/lib/buyerquest/opsgenie/client.rb

@@ -0,0 +1,40 @@
+module Buyerquest
+  module Opsgenie
+    module Client
+      OPSGENIE_API_BASE_URL = 'https://api.opsgenie.com/v2'.freeze
+
+      def self.init(api_key = nil, opts={})
+        @api_key = api_key
+        @api_key ||= ENV['OPSG_API_KEY']
+        raise "[OpsGenie Error] No api key provided" if @api_key.nil?
+      end
+
+      def self.execute(opsgenie_request)
+        uri = URI::encode(opsgenie_request[:uri])
+        method = opsgenie_request[:method].upcase
+        payload = opsgenie_request[:payload]
+        raise "[OpsGenie Error] Unknown method" unless %w(GET POST PUT PATCH DELETE).include? method
+        request = {
+            :method => method,
+            :url => "#{OPSGENIE_API_BASE_URL}#{uri}",
+            :headers => get_headers(method)
+        }
+        request[:payload] = payload.to_json unless payload.nil?
+        begin
+          response = RestClient::Request.execute(request)
+        rescue RestClient::NotFound => err
+          return nil
+        end
+        JSON.parse(response)
+      end
+
+      def self.get_headers(http_method)
+        headers = {:Authorization => "GenieKey #{@api_key}"}
+        if %w(POST PATCH).include? http_method.upcase
+          headers[:content_type] = 'application/json'
+        end
+        headers
+      end
+    end
+  end
+end

data/lib/buyerquest/opsgenie/heartbeat.rb

@@ -0,0 +1,125 @@
+module Buyerquest
+  module Opsgenie
+    class Heartbeat
+      attr_reader :name
+
+      def initialize(opts={})
+        @name = opts[:name]
+        @opts = opts
+        raise "[OpsGenie Error] No name provided" if @name.nil?
+      end
+
+      def start
+        self.update({}) unless self.add
+        self.enable
+        # Initial ping request
+        self.ping
+      end
+
+      def stop
+        self.disable
+        self.delete
+      end
+
+      def get_default_heartbeat_opts
+        {
+            :intervalUnit => "minutes",
+            :interval => 10,
+            :enabled => true,
+            :alertMessage => "Heartbeat [#{@name}] expired",
+            :alertPriority=> "P3"
+        }
+      end
+
+      def enable
+        raise "[OpsGenie Error] Can't enable non-existent heartbeat" unless exist?
+        opsg_request ={
+            :method  => 'POST',
+            :uri     => "/heartbeats/#{@name}/enable",
+        }
+        Buyerquest::Opsgenie::Client.execute opsg_request
+      end
+
+      def disable
+        raise "[OpsGenie Error] Can't enable non-existent heartbeat" unless exist?
+
+        opsg_request ={
+            :method  => 'POST',
+            :uri     => "/heartbeats/#{@name}/disable",
+        }
+        Buyerquest::Opsgenie::Client.execute opsg_request
+      end
+
+      def add
+        return false if exist?
+        default_opts = get_default_heartbeat_opts
+        payload = default_opts
+        payload = payload.merge @opts
+        payload[:name] = @name
+        opsg_request = {
+            :method  => 'POST',
+            :uri     => '/heartbeats',
+            :payload => payload
+        }
+        @exist_status =  Buyerquest::Opsgenie::Client.execute opsg_request
+        true
+      end
+
+      def ping
+        raise "[OpsGenie Error] Can't ping non-existent heartbeat" unless exist?
+        opsg_request ={
+            :method  => 'GET',
+            :uri     => "/heartbeats/#{@name}/ping",
+        }
+        Buyerquest::Opsgenie::Client.execute opsg_request
+      end
+
+      def update (opts)
+        raise "[OpsGenie Error] Can't update non-existent heartbeat" unless exist?
+        @opts = @opts.merge opts
+        default_opts = get_default_heartbeat_opts
+        payload = default_opts
+        payload = payload.merge @opts
+        payload[:name] = @name
+
+        opsg_request = {
+            :method  => 'PATCH',
+            :uri     => "/heartbeats/#{@name}",
+            :payload => payload
+        }
+        @exist_status = Buyerquest::Opsgenie::Client.execute opsg_request
+        true
+      end
+
+      def delete
+        return false unless exist?
+        opsg_request ={
+            :method  => 'DELETE',
+            :uri     => "/heartbeats/#{@name}",
+        }
+        Buyerquest::Opsgenie::Client.execute opsg_request
+        @exist_status = nil
+        true
+      end
+
+      def get
+        opsg_request ={
+            :method  => 'GET',
+            :uri     => "/heartbeats/#{@name}",
+        }
+        Buyerquest::Opsgenie::Client.execute opsg_request
+      end
+
+      def exist?
+        if @exist_status.nil?
+          @exist_status = get
+        end
+        if @exist_status.nil?
+          false
+        else
+          true
+        end
+      end
+    end
+  end
+end

data/lib/buyerquest/opsgenie/version.rb

@@ -0,0 +1,5 @@
+module Buyerquest
+  module Opsgenie
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: buyerquest-opsgenie
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Buyerquest DevOps Team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-30 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !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'
+description: Allows to interact with OpsGenie api. Alerts and Heartbeat operations
+email:
+- devops@buyerquest.com
+executables:
+- opsgenie-client
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- buyerquest-opsgenie.gemspec
+- exe/opsgenie-client
+- lib/buyerquest-opsgenie.rb
+- lib/buyerquest/opsgenie.rb
+- lib/buyerquest/opsgenie/alert.rb
+- lib/buyerquest/opsgenie/client.rb
+- lib/buyerquest/opsgenie/heartbeat.rb
+- lib/buyerquest/opsgenie/version.rb
+homepage: https://github.com/BuyerQuest/buyerquest-opsgenie
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/BuyerQuest/buyerquest-opsgenie
+  source_code_uri: https://github.com/BuyerQuest/buyerquest-opsgenie
+  changelog_uri: https://github.com/BuyerQuest/buyerquest-opsgenie
+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: BuyerQuest OpsGenie gem
+test_files: []