env_compare 0.1.1 → 0.1.3.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62c65e23128c8437144d682263d6ad17a22485a1ffc4a68a3adcd8b0125e7bc3
-  data.tar.gz: 212ecb5eef50ee9003c4469cd454c57383cb95040620ea507c7bd27f861bb00b
+  metadata.gz: c1119534c3a09963aa5e16f2c11730ea7915f78c1a5efe8b3471d952bf3ec595
+  data.tar.gz: 79b778d047d032173624c4ea612d91684b897685268cfe18e20e22cded13df42
 SHA512:
-  metadata.gz: 59cae1f9c4d5484e0e74e455748fe0dfaf13a1935354b8c2b7cd62968ad0af418ece27fc0381cfe5c1703e0c58a37a6ecaa3242a8b85aab2a5716faac8b49cf0
-  data.tar.gz: eaf22b1743bb0c750c7d6bf494b48cef5206228cfec1931450be23af3fd10ee4cc5c142e9f25130bc84ab871a28c08383478c13a5ff2540798424d0ee8ffc5dd
+  metadata.gz: 9cf797bd514f23db0ccc51f81d29021fc8fb296031d52b119a82ffd327a033f48e778ff17892d05da68f6ab3fd0165a80db561661651210b3781074bff10b596
+  data.tar.gz: 3173d7ecf3810de57da910c86bbddbc5a70276a98056705251b8b80130f0379ad8506987f7055dfc14f528725753898abb1c95199e337b084fd32335c088f673

data/.rubocop.yml

@@ -16,14 +16,56 @@ require:
 Layout/LineLength:
   Max: 120
 
-Style/Documentation:
-  Enabled: false
-
-Metrics/MethodLength:
-  Max: 15
-
 Layout/DotPosition:
   EnforcedStyle: trailing
 
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+
+Metrics/MethodLength:
+  Max: 15
+
+
+Style/Documentation:
+  Enabled: false
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true

data/Gemfile

@@ -1,7 +1,9 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in env_compare.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    env_compare (0.1.0)
+    env_compare (0.1.3.pre.alpha)
       launchy
+      platform-api
       thor
 
 GEM
@@ -13,18 +14,32 @@ GEM
     ast (2.4.1)
     coderay (1.1.3)
     diff-lcs (1.3)
+    erubis (2.7.0)
+    excon (0.76.0)
+    heroics (0.1.1)
+      erubis (~> 2.0)
+      excon
+      moneta
+      multi_json (>= 1.9.2)
     launchy (2.5.0)
       addressable (~> 2.7)
     method_source (1.0.0)
+    moneta (1.0.0)
+    multi_json (1.15.0)
     parallel (1.19.1)
     parser (2.7.1.3)
       ast (~> 2.4.0)
+    platform-api (3.0.0)
+      heroics (~> 0.1.1)
+      moneta (~> 1.0.0)
+      rate_throttle_client (~> 0.1.0)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (4.0.5)
     rainbow (3.0.0)
     rake (12.3.3)
+    rate_throttle_client (0.1.2)
     regexp_parser (1.7.1)
     rexml (3.2.4)
     rspec (3.9.0)

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Jay Dorsey
+
+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

@@ -11,47 +11,99 @@ production environment variables
 This gem helps pull down the environment variables and give you
 a little interface to view & compare them with (via a UI)
 
-No server; it's all done via a CLI. It's really just a wrapper around
-some commands around the [heroku cli](https://devcenter.heroku.com/articles/heroku-cli) that does some formatting and
-munging of the output so you don't have to copy it all to Excel
-
-This gem wraps the heroku CLI tool to generates a small temporary
-HTML file & opens it using [launchy](https://github.com/copiousfreetime/launchy)
+The heavy lifting is done via the [heroku platform-api gem](https://github.com/heroku/platform-api)
+to retrieve environment variables, format them in an HTML page, and
+generate a small HTML file and open it with [launchy](https://github.com/copiousfreetime/launchy)
 
 It automates a few things:
 - Hides environment variables that match across all environments
 - Puts them in alpha order
 
 It's primarily intended to compare pre-production ENV variables
+across similar/identical environments
 
 ## Installation
 
-    # Install heroku CLI
-    brew tap heroku/brew && brew install heroku
+### Prerequisites
 
-    git clone https://github.com/jaydorsey/env_compare.git && cd env_compare
-    bundle
-    rake build
-    gem install pkg/env_compare-0.1.0.gem
+```bash
+# Install Heroku CLI
+brew tap heroku/brew && brew install heroku
+
+# Login with Heroku CLI
+heroku login
+
+# Install the heroku oauth plugin to generate an OAuth token
+heroku plugins:install heroku-cli-oauth
+
+# Create a token to access your applications
+heroku authorizations:create -d "Platform API token for environment variables"
+
+# Set the Token from above to an environment variable
+export OAUTH_TOKEN=<token>
+```
+
+If you want to add the environment variable to your shell permanently, you can
+run a variation of the command below:
 
-After installation you should have access to the `ec` executable wrapper
+```bash
+# Add permanently to `.bash_profile`
+echo 'export OAUTH_TOKEN=<token>' >>~/.bash_profile
+```
 
-> Note: There's no published gem yet. I'm not really sure how useful this is
-> but you can install via above or use the development commands below if you
-> don't want to build & install the gem locally
+### Install gem
+```bash
+gem install env_compare
+```
+
+After installation you should have access to the `ec` executable wrapper.
 
 ## Usage
+Use `ec` command to start comparing 2 or more heroku application environment variables.
+
+When only one application name is specified, output is shown in cli. Otherwise, your default browser is launched.
+
+## Compariing environment variables
+
+### Show **differences** **default*
+```bash
+ec diff heroku-app-name1 heroku-app-name2 heroku-app-name3
+```
+
+### Show **all**
+add `--all` option:
+```bash
+ec diff --all heroku-app-name1 heroku-app-name2 heroku-app-name3
+```
+
+### Themes
+- `--theme dark` **default**
+- `--theme light`
+
+For Example:
+```bash
+ec diff --theme light heroku-app-name1 heroku-app-name2
+```
+
+## Updating environment variables across multiple apps
 
-First, you need to login with heroku cli:
+You can use `ec update` to set or clear an environment variable across multiple Heroku
+applications.
 
-    heroku login
+### Update an environment variable
 
-Then, you can use the `ec` command
+```bash
+ec update heroku-app-name1 heroku-app-name2 heroku-app-name3 --key=MY_KEY --value=asdf
+```
 
-Create a file showing differences between 2 or more heroku applications:
+### Clear an environment variable
 
-    ec diff heroku-app-name1 heroku-app-name2 heroku-app-name3
+The default key value is nil; omit the `--key` argument if you want to clear an
+environment variable.
 
+```bash
+ec update heroku-app-name1 heroku-app-name2 heroku-app-name3 --key=MY_KEY
+```
 ## Development
 
 To test this on your machine locally, after cloning the repo:

data/Rakefile

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

data/bin/console

@@ -1,11 +1,11 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "env_compare"
+require 'bundler/setup'
+require 'env_compare'
 
 # 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"
+require 'pry'
 Pry.start

data/env_compare.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'launchy'
   spec.add_dependency 'thor'
+  spec.add_dependency 'platform-api'
 
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rspec'

data/exe/ec

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-require "env_compare"
+require 'env_compare'
 
-EnvCompare::CLI.start(ARGV)
+EnvCompare::Cli.start(ARGV)

data/lib/env_compare.rb

@@ -3,99 +3,7 @@
 require 'env_compare/errors'
 require 'env_compare/name_space'
 require 'env_compare/version'
-require 'erb'
-require 'launchy'
-require 'securerandom'
-require 'thor'
-require 'pry'
+require 'env_compare/cli'
 
 module EnvCompare
-  class CLI < Thor
-    attr_accessor :envs
-
-    desc 'version', 'list version'
-    def version
-      puts EnvCompare::VERSION
-    end
-
-    desc 'list ENVIRONMENT', 'List environment variables for a single environment'
-
-    def list(environment)
-      output = `heroku config -a #{environment}`
-      puts output
-    end
-
-    option :theme, type: :string, default: 'dark', desc: 'Theme to use'
-    option :all, type: :boolean, default: false, desc: 'Display all ENV variables, including matches'
-    desc 'diff heroku-app-name-1 heroku-app-name-2', 'Compare environment variables for 2+ environments'
-    def diff(*envs)
-      return list(envs.first) if envs.size == 1
-
-      heroku_results(envs)
-
-      # https://stackoverflow.com/a/5462069/2892779
-      html =
-        theme(options[:theme]).
-          result(
-            ::EnvCompare::NameSpace.new(data: calculated_output(envs), headers: ['KEY', envs].flatten).get_binding
-          )
-
-      save_and_open_file(html)
-    end
-
-    private
-
-    def all_keys
-      @all_keys ||= Set.new
-    end
-
-    def calculated_output(envs)
-      all_keys.sort.map do |key|
-        results = envs.map { |env| heroku_results[env][key] }
-        next if results.uniq.size == 1 && !options[:all]
-
-        [key, *results]
-      end.compact
-    end
-
-    def heroku_results(envs = nil)
-      @heroku_results ||=
-        envs.each_with_object({}) do |env, obj|
-          obj[env] = {}
-          lines = `heroku config -a #{env}`.split("\n").drop(1)
-
-          lines.each do |line|
-            key, _, value = line.partition(':')
-            obj[env][key.strip] = value.strip
-
-            all_keys << key.strip
-          end
-        end
-    end
-
-    def save_and_open_file(html)
-      filename = "#{SecureRandom.hex(32)}.html"
-      output = File.open(filename, 'w')
-      output.write(html)
-      output.close
-
-      full_path = File.join(Dir.pwd, output.path)
-
-      Launchy.open(full_path)
-
-      sleep(1)
-
-      File.delete(full_path)
-    end
-
-    def theme(file)
-      return ERB.new(File.read(theme_path(file))) if File.exist?(theme_path(file))
-
-      raise MissingThemeError
-    end
-
-    def theme_path(file)
-      @theme_path ||= File.join(File.dirname(__dir__), 'themes', "#{file}.erb")
-    end
-  end
 end

data/lib/env_compare/cli.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require 'erb'
+require 'launchy'
+require 'securerandom'
+require 'platform-api'
+require 'pry'
+require 'thor'
+
+module EnvCompare
+  class Cli < Thor
+    attr_accessor :envs
+
+    desc 'version', 'list version'
+    def version
+      puts EnvCompare::VERSION
+    end
+
+    desc 'list ENVIRONMENT', 'List environment variables for a single environment'
+
+    def list(environment)
+      output = `heroku config -a #{environment}`
+      puts output
+    end
+
+    option :theme, type: :string, default: 'dark', desc: 'Theme to use'
+    option :all, type: :boolean, default: false, desc: 'Display all ENV variables, including matches'
+    desc 'diff heroku-app-name-1 heroku-app-name-2', 'Compare environment variables for 2+ environments'
+    def diff(*envs)
+      return list(envs.first) if envs.size == 1
+
+      heroku_results(envs)
+
+      # https://stackoverflow.com/a/5462069/2892779
+      html =
+        theme(options[:theme]).
+          result(
+            ::EnvCompare::NameSpace.new(data: calculated_output(envs), headers: ['KEY', envs].flatten).get_binding
+          )
+
+      save_and_open_file(html)
+    end
+
+    # ec update app1 app2 KEY_NAME value
+    option :key, type: :string, desc: 'Key name'
+    option :value, type: :string, default: nil, desc: 'Value of key'
+    desc 'update heroku-app-name-1 heroku-app-name-2 MY_KEY test', 'Update environment variable for 1+ environments'
+    def update(*apps)
+      apps.each do |app|
+        update_config(app, { options[:key] =>  options[:value] })
+      end
+    end
+
+    private
+
+    def all_keys
+      @all_keys ||= Set.new
+    end
+
+    def calculated_output(envs)
+      all_keys.sort.map do |key|
+        results = envs.map { |env| heroku_results[env][key] }
+        next if results.uniq.size == 1 && !options[:all]
+
+        [key, *results]
+      end.compact
+    end
+
+    def heroku_results(app_names = nil)
+      @heroku_results ||=
+        app_names.each_with_object({}) do |app_name, obj|
+          obj[app_name] = {}
+
+          env_vars = config_vars_for_app(app_name)
+
+          env_vars.each do |key, value|
+            obj[app_name][key] = value
+
+            all_keys << key
+          end
+        end
+    end
+
+    def save_and_open_file(html)
+      filename = "#{SecureRandom.hex(32)}.html"
+      output = File.open(filename, 'w')
+      output.write(html)
+      output.close
+
+      full_path = File.join(Dir.pwd, output.path)
+
+      Launchy.open(full_path)
+
+      sleep(1)
+
+      File.delete(full_path)
+    end
+
+    def config_vars_for_app(app_name)
+      heroku.config_var.info_for_app(app_name)
+    end
+
+    def heroku
+      @heroku ||= PlatformAPI.connect_oauth(ENV['OAUTH_TOKEN'])
+    end
+
+    def theme(file)
+      return ERB.new(File.read(theme_path(file))) if File.exist?(theme_path(file))
+
+      raise MissingThemeError
+    end
+
+    def theme_path(file)
+      @theme_path ||= File.join(File.dirname(__dir__), '..', 'themes', "#{file}.erb")
+    end
+
+    def update_config(app, body)
+      heroku.config_var.update(app, body)
+    end
+  end
+end

data/lib/env_compare/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EnvCompare
-  VERSION = '0.1.1'
+  VERSION = '0.1.3-alpha'
 end

data/themes/dark.erb

@@ -1,23 +1,34 @@
 <html>
   <head>
   <style>
+  :root {
+    --black: #000;
+    --blue: #409cff;
+    --gray-object-only: #636366;
+    --orange: #ffb340;
+    --purple: #da8fff;
+  }
+
   body {
-    background: #000;
+    background: var(--black);
     font-family: Arial, Helvetica, sans-serif;
   }
+
   table {
-    color: #da8fff;
+    color: var(--purple);
     table-layout: fixed;
     width: 100%;
   }
 
-  table, th, td {
-    border: 1px solid #636366;
+  table,
+  th,
+  td {
+    border: 1px solid var(--gray-object-only);
     border-collapse: collapse;
   }
 
   th {
-    color: #ffb340;
+    color: var(--orange);
     letter-spacing: 1px;
   }
 
@@ -27,31 +38,12 @@
   }
 
   td:first-child {
-    color: #409cff;
+    color: var(--blue);
   }
   </style>
   </head>
   <body>
-    <table>
-      <tr>
-      <% headers.each_with_index do |header, idx| %>
-        <th>
-          <%= header %>&nbsp;
-          (<%= data.map { |col| col[idx] }.compact.size - 1 %> keys)
-        </th>
-      <% end %>
-      </tr>
-      <% data.each do |row| %>
-        <tr>
-          <% row.each do |cell| %>
-            <td>
-              <% unless cell.nil? %>
-                <code><%= cell %></code>
-              <% end %>
-            </td>
-          <% end %>
-        </tr>
-      <% end %>
-    </table>
+    <% table_template = EnvCompare::NameSpace.new(headers: headers, data: data) %>
+    <%= ERB.new(File.new("themes/table_template.erb").read).result(table_template.get_binding) %>
   </body>
 </html>

data/themes/light.erb

@@ -1,23 +1,33 @@
 <html>
   <head>
   <style>
+  :root {
+    --black: #000;
+    --blue: #0040dd;
+    --gray: #545456;
+    --white: #fff;
+  }
+
   body {
-    background: #fff;
+    background: var(--white);
     font-family: Arial, Helvetica, sans-serif;
   }
+
   table {
-    color: #000;
+    color: var(--black);
     table-layout: fixed;
     width: 100%;
   }
 
-  table, th, td {
-    border: 1px solid #636366;
+  table,
+  th,
+  td {
+    border: 1px solid var(--gray);
     border-collapse: collapse;
   }
 
   th {
-    color: #000;
+    color: var(--black);
     letter-spacing: 1px;
   }
 
@@ -27,31 +37,12 @@
   }
 
   td:first-child {
-    color: #409cff;
+    color: var(--blue);
   }
   </style>
   </head>
   <body>
-    <table>
-      <tr>
-      <% headers.each_with_index do |header, idx| %>
-        <th>
-          <%= header %>&nbsp;
-          (<%= data.map { |col| col[idx] }.compact.size - 1 %> keys)
-        </th>
-      <% end %>
-      </tr>
-      <% data.each do |row| %>
-        <tr>
-          <% row.each do |cell| %>
-            <td>
-              <% unless cell.nil? %>
-                <code><%= cell %></code>
-              <% end %>
-            </td>
-          <% end %>
-        </tr>
-      <% end %>
-    </table>
+    <% table_template = EnvCompare::NameSpace.new(headers: headers, data: data) %>
+    <%= ERB.new(File.new("themes/table_template.erb").read).result(table_template.get_binding) %>
   </body>
 </html>

data/themes/table_template.erb

@@ -0,0 +1,26 @@
+<table>
+  <thead>
+    <tr>
+      <% headers.each_with_index do |header, idx| %>
+        <th>
+          <%= header %>&nbsp;
+          (<%= data.map { |col| col[idx] }.compact.size %>)
+        </th>
+      <% end %>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% data.each do |row| %>
+      <tr>
+        <% row.each do |cell| %>
+          <td>
+            <% unless cell.nil? %>
+              <code><%= cell %></code>
+            <% end %>
+          </td>
+        <% end %>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: env_compare
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3.pre.alpha
 platform: ruby
 authors:
 - Jay Dorsey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-12 00:00:00.000000000 Z
+date: 2020-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: launchy
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: platform-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -109,6 +123,7 @@ files:
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
@@ -116,11 +131,13 @@ files:
 - env_compare.gemspec
 - exe/ec
 - lib/env_compare.rb
+- lib/env_compare/cli.rb
 - lib/env_compare/errors.rb
 - lib/env_compare/name_space.rb
 - lib/env_compare/version.rb
 - themes/dark.erb
 - themes/light.erb
+- themes/table_template.erb
 homepage: https://jaydorsey.com/
 licenses: []
 metadata:
@@ -139,11 +156,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Compare ENV variables across Heroku environments