deploy-info 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e359963ce3d6e67dc704ad1b479e3de0efe05d36
+  data.tar.gz: ac403a7fea14a45888baf6e0eed78a67c57effd6
+SHA512:
+  metadata.gz: 967779ad952e52d021a93cb31859601d48bcaa698d89a2d0886f9106deabece9db9c4f263561636afa1c93774407c9c9aadde0aa2e6dfa56c84b167463a33e93
+  data.tar.gz: df1f64fc711c60461705d092276b51fd86cbbef802691228d96bb0e3cc3e98b28ddd8e28b58c58c1142a982f2e77ce960abea713555f6636eed67ed4f8b2eadc

data/.gitignore

@@ -0,0 +1,8 @@
+*~
+*#
+.#*
+\#*#
+.*.sw[a-z]
+*.un~
+pkg/
+vendor/

data/.gitlab-ci.yml

@@ -0,0 +1,36 @@
+before_script:
+  - ruby -v
+  - which ruby
+  - gem install bundler --no-ri --no-rdoc
+  - bundle install --jobs $(nproc) --path vendor/bundle
+
+test:Ruby 2.2:
+  image: ruby:2.2
+  cache:
+    paths:
+      - .bundle
+      - vendor/bundle
+  script:
+    - bundle exec rubocop
+  tags:
+    - ruby
+  except:
+    - tags
+
+release:Ruby 2.2:
+  image: ruby:2.2
+  cache:
+    paths:
+      - .bundle
+      - vendor/bundle
+  script:
+    - bundle exec rubocop
+    - bundle exec rake build
+  artifacts:
+    name: "deploy-info-$CI_BUILD_REF_NAME"
+    paths:
+      - pkg/*.gem
+  tags:
+    - ruby
+  only:
+    - tags

data/.rubocop.yml

@@ -0,0 +1,12 @@
+Style/ModuleFunction:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+AllCops:
+  Include:
+    - lib/

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gem 'github_api' # => Github API Interaction
+# => gem 'hashie' # => Data Structure
+# => gem 'logify' # => Logging
+gem 'mixlib-cli' # => Option Parsing
+gem 'rack-cache' # => Cache Responses
+gem 'sinatra' # => Web Server
+gem 'sinatra-contrib' # => For namespaces
+
+group :development do
+  gem 'rake'
+  gem 'rspec'
+  gem 'rubocop'
+end

data/Gemfile.lock

@@ -0,0 +1,91 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    ast (2.3.0)
+    backports (3.6.8)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    github_api (0.14.5)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      oauth2 (~> 1.0)
+    hashie (3.4.4)
+    jwt (1.5.4)
+    mixlib-cli (1.7.0)
+    multi_json (1.12.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    oauth2 (1.2.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    parser (2.3.1.2)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rack (1.6.4)
+    rack-cache (1.6.1)
+      rack (>= 0.4)
+    rack-protection (1.5.3)
+      rack
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rainbow (2.1.0)
+    rake (11.2.2)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.2)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.42.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    sinatra (1.4.7)
+      rack (~> 1.5)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    sinatra-contrib (1.4.7)
+      backports (>= 2.0)
+      multi_json
+      rack-protection
+      rack-test
+      sinatra (~> 1.4.0)
+      tilt (>= 1.3, < 3)
+    thread_safe (0.3.5)
+    tilt (2.0.5)
+    unicode-display_width (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  github_api
+  mixlib-cli
+  rack-cache
+  rake
+  rspec
+  rubocop
+  sinatra
+  sinatra-contrib
+
+BUNDLED WITH
+   1.12.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Brian Dwyer - Intelligent Digital Services
+
+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,58 @@
+# Deploy-Info
+* Deployment Notification Provider for RunDeck
+* Pulls information potentially not readily available to RunDeck
+* One simple POST from RunDeck instead of a script (NewRelic Deploys require a JSON POST)
+* Maybe Eventually: Record last deployed revision locally and feed it back for consumption/display inside RunDeck
+
+## Background
+This project's initial purpose is/was to fire off NewRelic & Rollbar deployment notifications from RunDeck.  It can be difficult to grab information such as a commit SHA when you may just be deploying a branch from RunDeck.  This serves to fill that gap and ensure the revision field is populated appropriately, and it can also be utilized to keep your NewRelic API key out of visibility in the RunDeck console.
+
+**NOTE:** This API should **NOT** be exposed to the world unless you plan to secure it with a reverse-proxy or something.  It is intended to only be bound to `localhost` on the same server as RunDeck.
+
+## Running as a Service
+You'll likely want to run this as a service, `SystemD` or `Upstart` will likely be your friend in this regard.
+
+## Security
+You should lock down permissions on all configuration files in this project to only the user which this runs as...
+
+To run this project securely, **DON'T** run it as the RunDeck user.
+
+## Caching
+This leans on `rack-cache` to serve as a caching mechanism.  The objective here was to make sure we don't pummel the Chef API with redundant queries.
+* Timeout can be configured via the `cache_timeout` setting. **Default:** *30 seconds*
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'deploy-info'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install deploy-info
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bdwyertech/deploy-info. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'bundler/setup'
+require 'chef-rundeck'
+
+# 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

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/deploy-info.gemspec

@@ -0,0 +1,44 @@
+# encoding: UTF-8
+# rubocop: disable LineLength
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'deploy-info/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'deploy-info'
+  spec.version       = DeployInfo::VERSION
+  spec.authors       = ['Brian Dwyer']
+  spec.email         = ['bdwyer@IEEE.org']
+
+  spec.summary       = %(Deployment Notification and State Provider)
+  # => spec.description   = %q(TODO: Write a longer description or delete this line.)
+  spec.homepage      = 'https://github.com/bdwyertech/deploy-info'
+  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'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # => Dependencies
+  spec.add_runtime_dependency 'github_api', '~> 0.14'
+  spec.add_runtime_dependency 'mixlib-cli', '~> 1.6'
+  spec.add_runtime_dependency 'rack-cache', '~> 1.6'
+  spec.add_runtime_dependency 'sinatra', '~> 1.4'
+  spec.add_runtime_dependency 'sinatra-contrib', '~> 1.4'
+
+  # => Development Dependencies
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+end

data/exe/deploy-info

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# Deployment Information Provider for RunDeck
+# Brian Dwyer - Intelligent Digital Services - 9/1/16
+
+lib = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+# => Catch Ctrl+C's to avoid stack traces
+Signal.trap('INT') { abort }
+
+require 'deploy-info'
+
+DeployInfo::CLI.run(ARGV)

data/lib/deploy-info.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+# rubocop: disable LineLength
+# Deployment Information Provider for RunDeck
+# Brian Dwyer - Intelligent Digital Services - 9/1/16
+
+require 'deploy-info/cli'
+require 'deploy-info/config'
+require 'deploy-info/state'
+require 'deploy-info/util'
+require 'deploy-info/version'
+
+# => Deployment Information API
+module DeployInfo
+  # => The Sinatra API should be Lazily-Loaded, such that the CLI arguments and/or configuration files are respected
+  autoload :API, 'deploy-info/api'
+end

data/lib/deploy-info/api.rb

@@ -0,0 +1,124 @@
+# Encoding: UTF-8
+# rubocop: disable LineLength
+#
+# Gem Name:: deploy-info
+# DeployInfo:: API
+#
+# Copyright (C) 2016 Brian Dwyer - Intelligent Digital Services
+#
+# All rights reserved - Do Not Redistribute
+#
+
+# => NOTE: Anything other than a STATUS 200 will trigger an error in the RunDeck plugin due to a hardcode in org.boon.HTTP
+
+require 'sinatra/base'
+require 'sinatra/namespace'
+require 'json'
+require 'rack/cache'
+require 'deploy-info/notifier'
+require 'deploy-info/config'
+require 'deploy-info/state'
+
+# => Deployment Information Provider for RunDeck
+module DeployInfo
+  # => HTTP API
+  class API < Sinatra::Base
+    #######################
+    # =>    Sinatra    <= #
+    #######################
+
+    # => Configure Sinatra
+    enable :logging, :static, :raise_errors # => disable :dump_errors, :show_exceptions
+    set :port, Config.port || 8080
+    set :bind, Config.bind || 'localhost'
+    set :environment, Config.environment || :production
+
+    # => Enable NameSpace Support
+    register Sinatra::Namespace
+
+    if development?
+      require 'sinatra/reloader'
+      register Sinatra::Reloader
+    end
+
+    use Rack::Cache do
+      set :verbose, true
+      set :metastore,   'file:' + File.join(Dir.tmpdir, 'rack', 'meta')
+      set :entitystore, 'file:' + File.join(Dir.tmpdir, 'rack', 'body')
+    end
+
+    ########################
+    # =>    JSON API    <= #
+    ########################
+
+    # => Current Configuration & Healthcheck Endpoint
+    get '/config' do
+      content_type 'application/json'
+      JSON.pretty_generate(
+        [
+          DeployInfo.inspect + ' is up and running!',
+          'Author: ' + Config.author,
+          'Environment: ' + Config.environment.to_s,
+          'Root: ' + Config.root.to_s,
+          'Config File: ' + (Config.config_file if File.exist?(Config.config_file)).to_s,
+          'State File: ' + (Config.state_file if File.exist?(Config.state_file)).to_s,
+          { State: State.state.map { |n| n[:name] } },
+          'Params: ' + params.inspect,
+          'Cache Timeout: ' + Config.cache_timeout.to_s,
+          'BRIAN IS COOooooooL',
+          { AppConfig: Config.options },
+          { 'Sinatra Info' => env }
+        ].compact
+      )
+    end
+
+    get '/state' do
+      content_type 'application/json'
+      State.state.to_json
+    end
+
+    ########################
+    # =>    JSON API    <= #
+    ########################
+
+    namespace '/deploy/v1' do
+      # => Define our common namespace parameters
+      before do
+        # => This is a JSON API
+        content_type 'application/json'
+
+        # => Make the Params Globally Accessible
+        Config.define_setting :query_params, params
+
+        # => Parameter Overrides
+        Github.configure do |cfg|
+          cfg.oauth_token = params['gh_oauth_token'] || Config.github_oauth_token
+        end
+      end
+
+      # => Clean Up
+      after do
+        # => Reset the API Client to Default Values
+        # => Notifier.reset!
+      end
+
+      # => Notify Deploys
+      post '/notify' do
+        resp = {}
+        resp['NewRelic'] = JSON.parse(Notifier.newrelic.body) if params['nr_app_id']
+        resp['Rollbar'] = JSON.parse(Notifier.rollbar.body) if params['rb_token']
+        resp.to_json
+      end
+
+      # => Retrieve Currently Deployed Revision
+      get '/revision' do
+        # => PLACEHOLDER
+      end
+
+      # => Parse Revision
+      post '/revision' do
+        Notifier.revision
+      end
+    end
+  end
+end

data/lib/deploy-info/cli.rb

@@ -0,0 +1,102 @@
+# Encoding: UTF-8
+# rubocop: disable LineLength, MethodLength, AbcSize
+#
+# Gem Name:: deploy-info
+# DeployInfo:: CLI
+#
+# Copyright (C) 2016 Brian Dwyer - Intelligent Digital Services
+#
+# All rights reserved - Do Not Redistribute
+#
+
+require 'mixlib/cli'
+require 'deploy-info/config'
+require 'deploy-info/util'
+
+module DeployInfo
+  #
+  # => Deploy-Info Launcher
+  #
+  module CLI
+    extend self
+    #
+    # => Options Parser
+    #
+    class Options
+      # => Mix-In the CLI Option Parser
+      include Mixlib::CLI
+
+      option :github_oauth_token,
+             short: '-g TOKEN',
+             long: '--github-oauth-token TOKEN',
+             description: 'OAuth Token to use for querying GitHub'
+
+      option :nr_api_key,
+             short: '-n KEY',
+             long: '--nr-api-key KEY',
+             description: 'NewRelic API Key for deploy notifications to NewRelic'
+
+      option :cache_timeout,
+             short: '-t CACHE_TIMEOUT',
+             long: '--timeout CACHE_TIMEOUT',
+             description: 'Sets the cache timeout in seconds for API query response data.'
+
+      option :config_file,
+             short: '-c CONFIG',
+             long: '--config CONFIG',
+             description: 'The configuration file to use, as opposed to command-line parameters (optional)'
+
+      option :state_file,
+             short: '-s STATE',
+             long: '--state-json STATE',
+             description: "The JSON file containing node state & auditing information (Default: #{Config.state_file})"
+
+      option :bind,
+             short: '-b HOST',
+             long: '--bind HOST',
+             description: "Listen on Interface or IP (Default: #{Config.bind})"
+
+      option :port,
+             short: '-p PORT',
+             long: '--port PORT',
+             description: "The port to run on. (Default: #{Config.port})"
+
+      option :environment,
+             short: '-e ENV',
+             long: '--env ENV',
+             description: 'Sets the environment for deploy-info to execute under. Use "development" for more logging.',
+             default: 'production'
+    end
+
+    # => Launch the Application
+    def run(argv = ARGV)
+      # => Parse CLI Configuration
+      cli = Options.new
+      cli.parse_options(argv)
+
+      # => Parse JSON Config File (If Specified & Exists)
+      json_config = Util.parse_json_config(cli.config[:config_file])
+
+      # => Grab the Default Values
+      default = DeployInfo::Config.options
+
+      # => Merge Configuration (JSON File Wins)
+      config = [default, json_config, cli.config].compact.reduce(:merge)
+
+      # => Apply Configuration
+      DeployInfo::Config.setup do |cfg|
+        cfg.config_file         = config[:config_file]
+        cfg.cache_timeout       = config[:cache_timeout].to_i
+        cfg.bind                = config[:bind]
+        cfg.port                = config[:port]
+        cfg.state_file          = config[:state_file]
+        cfg.environment         = config[:environment].to_sym
+        cfg.github_oauth_token  = config[:github_oauth_token]
+        cfg.nr_api_key          = config[:nr_api_key]
+      end
+
+      # => Launch the API
+      DeployInfo::API.run!
+    end
+  end
+end

data/lib/deploy-info/config.rb

@@ -0,0 +1,83 @@
+# Encoding: UTF-8
+#
+# Gem Name:: deploy-info
+# DeployInfo:: Config
+#
+# Copyright (C) 2016 Brian Dwyer - Intelligent Digital Services
+#
+# All rights reserved - Do Not Redistribute
+#
+
+require 'deploy-info/helpers/configuration'
+require 'pathname'
+
+module DeployInfo
+  # => This is the Configuration module.
+  module Config
+    extend self
+    extend Configuration
+
+    # => Gem Root Directory
+    define_setting :root, Pathname.new(File.expand_path('../../../', __FILE__))
+
+    # => My Name
+    define_setting :author, 'Brian Dwyer - Intelligent Digital Services'
+
+    # => Application Environment
+    define_setting :environment, :production
+
+    # => Sinatra Configuration
+    define_setting :port, '9128'
+    define_setting :bind, 'localhost'
+    define_setting :cache_timeout, 30
+
+    # => Config File
+    define_setting :config_file, File.join(root, 'config', 'config.json')
+
+    # => State File
+    define_setting :state_file, File.join(root, 'config', 'state.json')
+
+    #
+    # => API Configuration
+    #
+    # => Github OAuth Token
+    define_setting :github_oauth_token
+
+    # => NewRelic API Key
+    define_setting :nr_api_key
+
+    #
+    # => Facilitate Dynamic Addition of Configuration Values
+    #
+    # => @return [class_variable]
+    #
+    def add(config = {})
+      config.each do |key, value|
+        define_setting key.to_sym, value
+      end
+    end
+
+    #
+    # => Facilitate Dynamic Removal of Configuration Values
+    #
+    # => @return nil
+    #
+    def clear(config)
+      Array(config).each do |setting|
+        delete_setting setting
+      end
+    end
+
+    #
+    # => List the Configurable Keys as a Hash
+    #
+    # @return [Hash]
+    #
+    def options
+      map = DeployInfo::Config.class_variables.map do |key|
+        [key.to_s.tr('@', '').to_sym, class_variable_get(:"#{key}")]
+      end
+      Hash[map]
+    end
+  end
+end

data/lib/deploy-info/git.rb

@@ -0,0 +1,43 @@
+# Encoding: UTF-8
+# rubocop: disable LineLength
+#
+# Gem Name:: deploy-info
+# DeployInfo:: Git
+#
+# Copyright (C) 2016 Brian Dwyer - Intelligent Digital Services
+#
+# All rights reserved - Do Not Redistribute
+#
+
+require 'deploy-info/config'
+require 'github_api'
+
+module DeployInfo
+  # => This is the Git Module. It interacts with Git resources.
+  module Git
+    extend self
+
+    def ghclient
+      # => Instantiate a new GitHub Client
+      Github::Client.new
+    end
+
+    def revision # rubocop: disable AbcSize
+      # => Grab the Supplied Revision
+      rev = Config.query_params['revision'] || return
+      return rev unless Config.query_params['gh_repo']
+
+      # => Break down the Params
+      org, repo = Config.query_params['gh_repo'].split('/').map { |r| String(r) }
+      return rev unless org && repo
+
+      begin
+        # => Pull the Shorthand SHA
+        ghclient.git_data.trees.get(org, repo, rev).first[1][0, 7]
+      rescue Github::Error::NotFound
+        # => Return the Supplied Revision if Github Borks
+        rev
+      end
+    end
+  end
+end

data/lib/deploy-info/helpers/configuration.rb

@@ -0,0 +1,57 @@
+# Encoding: UTF-8
+#
+# Gem Name:: deploy-info
+# Helper:: Configuration
+#
+# Author: Eli Fatsi - https://www.viget.com/articles/easy-gem-configuration-variables-with-defaults
+# Contributor: Brian Dwyer - Intelligent Digital Services
+#
+
+# => Configuration Helper Module
+module Configuration
+  #
+  # => Provides a method to configure an Application
+  # => Example:
+  #      DeployInfo::Config.setup do |cfg|
+  #        cfg.config_file = 'abc.json'
+  #        cfg.app_name = 'GemBase'
+  #      end
+  #
+  def setup
+    yield self
+  end
+
+  def define_setting(name, default = nil)
+    class_variable_set("@@#{name}", default)
+
+    define_class_method "#{name}=" do |value|
+      class_variable_set("@@#{name}", value)
+    end
+
+    define_class_method name do
+      class_variable_get("@@#{name}")
+    end
+  end
+
+  def delete_setting(name)
+    remove_class_variable("@@#{name}")
+
+    delete_class_method(name)
+  rescue NameError # => Handle Non-Existent Settings
+    return
+  end
+
+  private
+
+  def define_class_method(name, &block)
+    (class << self; self; end).instance_eval do
+      define_method name, &block
+    end
+  end
+
+  def delete_class_method(name)
+    (class << self; self; end).instance_eval do
+      undef_method name
+    end
+  end
+end

data/lib/deploy-info/notifier.rb

@@ -0,0 +1,82 @@
+# Encoding: UTF-8
+# rubocop: disable LineLength, AbcSize, MethodLength
+#
+# Gem Name:: deploy-info
+# DeployInfo:: Notifier
+#
+# Copyright (C) 2016 Brian Dwyer - Intelligent Digital Services
+#
+# All rights reserved - Do Not Redistribute
+#
+
+require 'deploy-info/git'
+require 'json'
+require 'net/http'
+require 'uri'
+
+module DeployInfo
+  # => Deploy Notification Methods
+  module Notifier
+    extend self
+
+    ########################
+    # =>    NewRelic    <= #
+    ########################
+
+    def newrelic
+      return unless Config.query_params['nr_app_id']
+
+      # => Grab the NewRelic Application ID
+      nr_app_id = Config.query_params['nr_app_id']
+
+      # => Build the URI & POST Request
+      uri = URI.parse("https://api.newrelic.com/v2/applications/#{nr_app_id}/deployments.json")
+      request = Net::HTTP::Post.new(uri)
+
+      # => Set Headers
+      request.content_type = 'application/json'
+      request['X-Api-Key'] = Config.query_params['nr_api_key'] || Config.nr_api_key
+      puts Config.nr_api_key
+
+      # => Build the JSON Payload
+      request.body = {
+        deployment: {
+          revision: Git.revision,
+          user: Config.query_params['user'],
+          description: Config.query_params['comment']
+        }
+      }.to_json
+
+      # => Send the Deployment Notification
+      Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        http.request(request)
+      end
+    end
+
+    #######################
+    # =>    Rollbar    <= #
+    #######################
+
+    def rollbar
+      # => Build the Data Structure
+      data = {}
+      data[:access_token] = Config.query_params['rb_token']
+      data[:environment] = Config.query_params['environment']
+      data[:revision] = Git.revision
+      data[:local_username] = Config.query_params['user']
+      data[:comment] = Config.query_params['comment']
+
+      # => Parse the Destination API URI
+      uri = URI.parse('https://api.rollbar.com/api/1/deploy/')
+
+      # => Construct the POST Request
+      request = Net::HTTP::Post.new(uri)
+      request.set_form_data(data)
+
+      # => Send the Deployment Notification
+      Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        http.request(request)
+      end
+    end
+  end
+end

data/lib/deploy-info/state.rb

@@ -0,0 +1,92 @@
+# Encoding: UTF-8
+# rubocop: disable LineLength
+#
+# Gem Name:: deploy-info
+# DeployInfo:: State
+#
+# Copyright (C) 2016 Brian Dwyer - Intelligent Digital Services
+#
+# All rights reserved - Do Not Redistribute
+#
+
+require 'deploy-info/config'
+require 'deploy-info/util'
+
+module DeployInfo
+  # => This is the State controller.  It manages State information
+  module State
+    extend self
+
+    ##############################
+    # =>   State Operations   <= #
+    ##############################
+
+    attr_accessor :state
+
+    def state
+      @state ||= Util.parse_json_config(Config.state_file) || []
+    end
+
+    def find_state(app)
+      state.detect { |h| h[:name].casecmp(app).zero? }
+    end
+
+    def update_state(hash) # rubocop: disable AbcSize
+      # => Check if App Already Exists
+      existing = find_state(hash[:name])
+      if existing # => Update the Existing App
+        state.delete(existing)
+        audit_string = [DateTime.now, hash[:creator]].join(' - ')
+        existing[:last_modified] = existing[:last_modified].is_a?(Array) ? existing[:last_modified].take(5).unshift(audit_string) : [audit_string]
+        hash = existing
+      end
+
+      # => Update the State
+      state.push(hash)
+
+      # => Write Out the Updated State
+      write_state
+    end
+
+    # => Add Node to the State
+    def add_state(app, user, params) # rubocop: disable MethodLength, AbcSize
+      # => Create an App-State Object
+      (n = {}) && (n[:name] = app)
+      n[:created] = DateTime.now
+      n[:creator] = user
+      # => Parse our Field Values
+      %w(type).each do |opt|
+        n[opt.to_sym] = params[opt] if params[opt]
+      end
+      # => Parse our Booleans
+      %w(protected).each do |opt|
+        n[opt.to_sym] = true if params[opt] && %w(true 1).any? { |x| params[opt].to_s.casecmp(x).zero? }
+      end
+      # => Build the Updated State
+      update_state(n)
+      # => Return the Added App
+      find_state(node)
+    end
+
+    # => Remove App from the State
+    def delete_state(app)
+      # => Find the App
+      existing = find_state(app)
+      return 'App not present in state' unless existing
+      # => Delete the App from State
+      state.delete(existing)
+      # => Write Out the Updated State
+      write_state
+      # => Return the Deleted App
+      existing
+    end
+
+    def write_state
+      # => Sort & Unique State
+      state.sort_by! { |h| h[:name].downcase }.uniq!
+
+      # => Write Out the Updated State
+      Util.write_json_config(Config.state_file, state)
+    end
+  end
+end

data/lib/deploy-info/util.rb

@@ -0,0 +1,64 @@
+# Encoding: UTF-8
+# rubocop: disable LineLength
+#
+# Gem Name:: deploy-info
+# DeployInfo:: Util
+#
+# Copyright (C) 2016 Brian Dwyer - Intelligent Digital Services
+#
+# All rights reserved - Do Not Redistribute
+#
+
+require 'json'
+
+module DeployInfo
+  # => Utility Methods
+  module Util
+    extend self
+
+    ########################
+    # =>    File I/O    <= #
+    ########################
+
+    # => Define JSON Parser
+    def parse_json_config(file = nil, symbolize = true)
+      return unless file && ::File.exist?(file.to_s)
+      begin
+        ::JSON.parse(::File.read(file.to_s), symbolize_names: symbolize)
+      rescue JSON::ParserError
+        return
+      end
+    end
+
+    # => Define JSON Writer
+    def write_json_config(file, object)
+      return unless file && object
+      begin
+        File.open(file, 'w') { |f| f.write(JSON.pretty_generate(object)) }
+      end
+    end
+
+    #############################
+    # =>    Serialization    <= #
+    #############################
+
+    def serialize(response)
+      # => Serialize Object into JSON Array
+      JSON.pretty_generate(response.map(&:name).sort_by(&:downcase))
+    end
+
+    def serialize_csv(csv)
+      # => Serialize a CSV String into an Array
+      return unless csv && csv.is_a?(String)
+      csv.split(',')
+    end
+
+    def serialize_revisions(branches, tags)
+      # => Serialize Branches/Tags into JSON Array
+      # => Branches = String, Tags = Key/Value
+      branches = branches.map(&:name).sort_by(&:downcase)
+      tags = tags.map(&:name).sort_by(&:downcase).reverse.map { |tag| { name: "Tag: #{tag}", value: tag } }
+      JSON.pretty_generate(branches + tags)
+    end
+  end
+end

data/lib/deploy-info/version.rb

@@ -0,0 +1,3 @@
+module DeployInfo
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: deploy-info
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brian Dwyer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: github_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: mixlib-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rack-cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- bdwyer@IEEE.org
+executables:
+- deploy-info
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- deploy-info.gemspec
+- exe/deploy-info
+- lib/deploy-info.rb
+- lib/deploy-info/api.rb
+- lib/deploy-info/cli.rb
+- lib/deploy-info/config.rb
+- lib/deploy-info/git.rb
+- lib/deploy-info/helpers/configuration.rb
+- lib/deploy-info/notifier.rb
+- lib/deploy-info/state.rb
+- lib/deploy-info/util.rb
+- lib/deploy-info/version.rb
+homepage: https://github.com/bdwyertech/deploy-info
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: Deployment Notification and State Provider
+test_files: []