ops 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c5858a2e0dde21d89b70cb34b9e96ca51829443c
-  data.tar.gz: d502e55582d6d4ff4b027c7f5dc507c2f1816da4
+SHA256:
+  metadata.gz: cfa4c11946baaa93a8d4683795a32c455ec879214e7275b7b58a9d5bcc7c93a0
+  data.tar.gz: dde535ba99c5a2772a154a791d6199c57d27e7b9ebc5feb7257aad070fa14404
 SHA512:
-  metadata.gz: eb1b3cafc156a9da0719726ca846d84c74d1ab2da4fd0689573a640515878413538d33688f113a1d25fa2a9d8360fb4d4b9933ce640281ad8178ff4639fabff4
-  data.tar.gz: f70c5bcdb1be85cf20d36064a72035301f75a2f1bef054838924c710915e27691dc25200c5bd816d370543fea98c88a1138217f8b3fdf32e2fae877c617071d4
+  metadata.gz: 4da7f53d6755daf5d6d9118846018bf71f85129d584271577ebe9bc96d8339ec8d6337a44ad01415c31a2b8bf333f71a9060dbdcbf102d2023f9ce02e2a3c21b
+  data.tar.gz: a776b7876b2528378e8f49ce8421b6e2ed7789226c69c14d1e607fab354ddd57e121000062f92e1e23511d2068e03e35f261a88915ca632db0f3cd86f70dbd5e

data/README.md

@@ -8,22 +8,23 @@ This gem provides standardized support for obtaining environment, version, and h
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 **Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
 
-- [Installation](#installation)
-  - [For Rails apps:](#for-rails-apps)
-  - [For Sinatra apps:](#for-sinatra-apps)
-- [Adding Custom Heartbeats](#adding-custom-heartbeats)
-- [The Configuration Service Adapter (Optional)](#the-configuration-service-adapter-optional)
-  - [Running tests](#running-tests)
+- [Ops](#ops)
+  - [Installation](#installation)
+    - [For Rails apps:](#for-rails-apps)
+    - [For Sinatra apps:](#for-sinatra-apps)
+  - [Adding Custom Heartbeats](#adding-custom-heartbeats)
+  - [The Configuration Service Adapter (Optional)](#the-configuration-service-adapter-optional)
+    - [Running tests](#running-tests)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
 
 **You will likely want to block or restrict access to the following routes:**
 
-Route         | Notes
---------------| -----
-`/ops/env`    | Exposes all of your environment variables (e.g. any API keys set as environment variables) to the public
-`/ops/config` | Exposes all of your configuration keys and values to the public (if you're using a configuration service).
+| Route         | Notes                                                                                                      |
+| ------------- | ---------------------------------------------------------------------------------------------------------- |
+| `/ops/env`    | Exposes all of your environment variables (e.g. any API keys set as environment variables) to the public   |
+| `/ops/config` | Exposes all of your configuration keys and values to the public (if you're using a configuration service). |
 
 Typical usage:
 

data/lib/ops/revision.rb

@@ -1,6 +1,8 @@
+require 'yaml'
+
 module Ops
   class Revision
-    attr_writer :branch_source
+    attr_reader :file_root
 
     def initialize(new_headers = {}, opts = Ops.config)
       @file_root = opts.file_root.to_s # convert to string in case they pass us a Pathname
@@ -8,114 +10,52 @@ module Ops
       @headers = new_headers
     end
 
-    def version_or_branch
-      @version ||= if version_file?
-                     chomp(version_file).gsub('^{}', '')
-                   elsif development? && branch_source.call =~ /^\* (.*)$/
-                     Regexp.last_match(1)
-                   else
-                     'Unknown (VERSION file is missing)'
-                   end
-    end
-
-    def previous_versions
-      @previous_versions ||= get_previous_by_time
-    end
-
-    def get_previous_by_time
-      get_previous_versions.sort_by { |a| a[:time] }
-    end
-
-    def get_previous_versions
-      Dir["#{path}/../*"].each_with_object([]) do |dir, array|
-        next if dir =~ /#{current_dir}$/
-        version, revision = File.join(dir, 'VERSION'), File.join(dir, 'REVISION')
-        array << stats_hash(version: version, revision: revision) if File.exist?(version) && File.exist?(revision)
-      end
-    end
-
-    def path
-      File.absolute_path file_root
-    end
-
-    def current_dir
-      file_root.split('/').last
-    end
-
-    def stats_hash(files)
-      { version:  get_version(files[:version]),
-        revision: get_revision(files[:revision]),
-        time:     get_time(files[:revision]) }
-    end
-
-    def get_version(file)
-      chomp(file).gsub('^{}', '')
-    end
+    attr_reader :environment
 
-    def get_revision(file)
-      chomp file
+    def headers
+      @headers.select { |k, v| k.match(/^[-A-Z_].*$/) }
     end
 
-    def chomp(file)
-      File.read(file).chomp
+    def info
+      @info ||= build_info.merge(deploy_info)
     end
 
-    def get_time(file)
-      File.stat(file).mtime
+    def previous_info
+      @previous_info ||= previous_build_info.merge(previous_deploy_info)
     end
 
-    attr_reader :file_root
-
-    attr_reader :environment
-
-    def development?
-      environment == 'development'
-    end
-
-    def version_file
-      @version_file ||= File.join(file_root, 'VERSION')
-    end
+    private
 
-    def version_file?
-      File.exist? version_file
+    def build_info
+      info_from_file('BUILD-INFO')
     end
 
-    def revision_file
-      @revision_file ||= File.join(file_root, 'REVISION')
+    def previous_build_info
+      info_from_file('PREVIOUS-BUILD-INFO')
     end
 
-    def revision_file?
-      File.exist? revision_file
+    def deploy_info
+      info_from_file('DEPLOY-INFO')
     end
 
-    def deploy_date
-      @deploy_date ||= if version_file?
-                         get_time version_file
-                       elsif development?
-                         'Live'
-                       else
-                         'Unknown (VERSION file is missing)'
-                       end
+    def previous_deploy_info
+      info_from_file('PREVIOUS-DEPLOY-INFO')
     end
 
-    def last_commit
-      @last_commit ||= if revision_file?
-                         chomp revision_file
-                       elsif development? && `git show` =~ /^commit (.*)$/
-                         Regexp.last_match(1)
-                       else
-                         'Unknown (REVISION file is missing)'
-                       end
+    def info_from_file(name)
+      if file_exists?(name)
+        parse_info_file(name)
+      else
+        {name.downcase.gsub('-', '_') => "No #{name} file found"}
+      end
     end
 
-    def headers
-      @headers.select { |k, v| k.match(/^[-A-Z_].*$/) }
+    def parse_info_file(filename)
+      YAML.safe_load(File.read(File.join(file_root, filename))) if file_exists?(filename)
     end
 
-    private
-
-    def branch_source
-      @branch_source ||= -> { `git branch` }
+    def file_exists?(file_name)
+      File.exist?(File.join(file_root, file_name))
     end
   end
 end

data/lib/ops/server/views/version.erb

@@ -1,25 +1,4 @@
 <div class="container">
-  <div class="spacer"></div>
-  <div id="version">
-    <div class="label">
-      <%= "#{app_name} Version" %>
-    </div>
-    <div class="value">
-      <%= version_link @version.version_or_branch %>
-    </div>
-  </div>
-  <div class="spacer"></div>
-  <div id="date">
-    <div class="label">Date Deployed</div>
-    <div class="value"><%= @version.deploy_date %></div>
-  </div>
-  <div class="spacer"></div>
-  <div id="commit">
-    <div class="label">Last Commit</div>
-    <div class="value">
-      <%= commit_link(@version.last_commit)%>
-    </div>
-  </div>
   <div class="spacer"></div>
   <div id="host">
     <div class="label">Host</div>
@@ -31,33 +10,31 @@
     <div class="value"><%= @version.environment %></div>
   </div>
   <div class="spacer"></div>
-  <div id="previous_versions">
-    <div class="label">Previous Versions</div>
-    <div class="value">
-      <% unless @previous_versions.empty? %>
-        <table>
-          <tr class="header">
-            <td>Time</td>
-            <td>Version</td>
-            <td>Commit</td>
-          </tr>
-          <% @previous_versions.each_with_index do |version, i| %>
-            <tr class="<%= i%2==0 ? 'even' : nil %>">
-              <td>
-                <%= version[:time].strftime('%x %X') %>
-              </td>
-              <td>
-                <%= version_link(version[:version]) %>
-              </td>
-              <td>
-                <%= commit_link(version[:revision]) %>
-              </td>
-            </tr>
-          <% end %>
-        </table>
-      <% end %>
+  <h3>Current Deploy Info</h3>
+  <% @version.info.each do |key, value| %>
+    <div class="spacer"></div>
+    <div>
+      <div class="label">
+        <%= key.to_s.gsub('_',' ').capitalize %>
+      </div>
+      <div class="value">
+        <%= value %>
+      </div>
     </div>
-  </div>
+  <% end %>
+  <div class="spacer"></div>
+  <h3>Previous Deploy Info</h3>
+  <% @version.previous_info.each do |key, value| %>
+    <div class="spacer"></div>
+    <div>
+      <div class="label">
+        <%= key.to_s.gsub('_',' ').capitalize %>
+      </div>
+      <div class="value">
+        <%= value %>
+      </div>
+    </div>
+  <% end %>
   <div class="spacer"></div>
   <div id="headers">
     <div class="label">Headers</div>

data/lib/ops/server.rb

@@ -4,9 +4,7 @@ require 'json'
 
 module Ops
   class Server < Sinatra::Base
-    dir = File.dirname(File.expand_path('', __FILE__))
-    set :views, "#{dir}/server/views"
-    # set :views, File.dirname(File.expand_path('/../server/views', __FILE__))
+    set :views, "#{File.dirname(File.expand_path('', __FILE__))}/server/views"
 
     helpers Ops::Helpers
 
@@ -14,11 +12,10 @@ module Ops
       env.each_with_object({}) { |(k, v), headers| headers[k] = v }
     end
 
-    def jsonified_version(version, previous_versions, headers)
+    def jsonified_version(version, headers)
       JSON.generate(
-        version: version.version_or_branch,
-        revision: version.last_commit,
-        previous_versions: previous_versions,
+        info: version.info,
+        previous_info: version.previous_info,
         headers: headers
       )
     end
@@ -34,12 +31,11 @@ module Ops
 
     get '/version/?:format?', provides: %i(html json) do
       @version = Revision.new(request_headers)
-      @previous_versions = @version.previous_versions
       @headers = @version.headers
 
       if json_request?
         content_type 'application/json'
-        return jsonified_version(@version, @previous_versions, @headers)
+        return jsonified_version(@version, @headers)
       end
 
       erb :version

data/lib/ops/version.rb

@@ -1,3 +1,3 @@
 module Ops
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ops
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Michael Pelz-Sherman
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-23 00:00:00.000000000 Z
+date: 2022-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -83,8 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Provide ops info endpoints.