heroku-app-info 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 21aaa9d6492d1bb3f44800ebf2364ed78439058a145f3734ebbcd3a618b25593
+  data.tar.gz: d631cd3b3cbac5408d0bb13a3ce66d5ea46e1e16c50de893a5be8d58d2324415
+SHA512:
+  metadata.gz: b5f77cdab3c2a803b84f9523ae79a50528c3e246ce7320088007fb09f4d3b4f3c6671c6123b9863910fbbddfe70d04fc4f4e983933e7aaf4406f859b993cefa9
+  data.tar.gz: e3dc1e1ca87a0133db37a397f1518c9f88337b640d80e5ac4ca21084e7f2a909703c2760989424b494cdc27d3bbe15af3d20aad1aa20c260b94123937bb903d2

data/.dockerignore

@@ -0,0 +1,12 @@
+**/.DS_Store
+**/*~
+**/*.bak
+**/*.pid
+**/.*
+**/_yardoc/
+**/coverage/
+**/doc/
+**/pkg/
+**/spec
+**/tmp/
+**/example/

data/.editorconfig

@@ -0,0 +1,5 @@
+[*]
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true

data/.rubocop.yml

@@ -0,0 +1,5 @@
+require:
+  - standard
+
+inherit_gem:
+  standard: config/base.yml

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-06-27
+
+- Initial release /w Heroku CLI

data/Dockerfile

@@ -0,0 +1,16 @@
+ARG RUBY_VERSION
+FROM ruby:$RUBY_VERSION-slim
+
+VOLUME /workspace
+WORKDIR /workspace
+
+ARG PKG_VERSION
+ARG GEM_HOST
+
+RUN apt-get update && apt-get install -y curl gnupg2 && \
+    curl https://cli-assets.heroku.com/install-ubuntu.sh | sh && \
+    curl -O http://host.docker.internal/heroku-app-info-$PKG_VERSION.gem && \
+    gem install heroku-app-info-$PKG_VERSION.gem && \
+    rm heroku-app-info-$PKG_VERSION.gem
+
+ENTRYPOINT ["heroku-app-info"]

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in heroku-system-info.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+gem "minitest-power_assert", "~> 0.3.1"
+gem "minitest-reporters", "~> 1.7"
+
+gem "solargraph", "~> 0.50.0"
+
+gem "standard", "~> 1.3"
+
+gem "webrick", "~> 1.8"

data/LICENSE

@@ -0,0 +1,9 @@
+Copyright 2024 wtnabe
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,35 @@
+# HerokuAppInfo
+
+Provides the ability to list Heroku apps that can be accessed by your account, to retrieve detailed information about each app, database version, and other information, and to store this as JSON.
+
+It is primarily intended to be used for creating maintenance plans for Stack and others.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add heroku-app-info
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install heroku-app-info
+
+And, at the moment it depends on the Heroku CLI.
+
+[The Heroku CLI \| Heroku Dev Center](https://devcenter.heroku.com/articles/heroku-cli)
+
+## Usage
+
+```
+$ heroku-app-info -h
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 the created tag, 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/wtnabe/heroku-app-info.

data/Rakefile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "yard"
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList["spec/**/*_spec.rb"]
+end
+
+require "standard/rake"
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = [
+    "exe/*",
+    "lib/**/*.rb"
+  ]
+end
+
+task default: %i[spec standard]

data/exe/heroku-app-info

@@ -0,0 +1,12 @@
+#! /usr/bin/env ruby
+
+require_relative "../lib/heroku_app_info"
+
+module HerokuAppInfo
+  def main
+    Cli.new(root: File.dirname(__dir__)).execute
+  end
+  module_function :main
+end
+
+HerokuAppInfo.main

data/lib/heroku-app-info.rb

@@ -0,0 +1 @@
+require_relative "heroku_app_info"

data/lib/heroku_app_info/cli.rb

@@ -0,0 +1,77 @@
+require_relative "fetcher"
+require_relative "options"
+require_relative "parser"
+require_relative "writer"
+
+module HerokuAppInfo
+  class Cli
+    def initialize(root:)
+      @root = root
+    end
+    attr_reader :root
+
+    def execute
+      @options = Options.new(ARGV.dup)
+
+      set_authz! if @options.authz
+
+      @fetcher = Fetcher.new(@options)
+      @parser = Parser.new
+      if @options.show_all?
+        show_all_apps
+      else
+        apps =
+          if @options.apps.nil?
+            @parser.apps(@fetcher.all_apps)
+          else
+            @options.apps
+          end
+        dump_app_and_pg_details(apps)
+      end
+    end
+
+    #
+    # set API KEY to Environment Variable
+    #
+    # Currently, Heroku Account require MFA, so the login and password method is not supported
+    #
+    def set_authz!
+      ENV["HEROKU_API_KEY"] = @options.authz
+    end
+
+    #
+    # show all apps
+    #
+    def show_all_apps
+      puts @fetcher.all_apps
+    end
+
+    #
+    # dump each app and pg info
+    #
+    def dump_app_and_pg_details(apps)
+      writer = Writer.new(@options)
+
+      apps.each { |app|
+        raw_app = @fetcher.app(app)
+        writer.write(app, raw_app) if @options.raw_output?
+        app_info = @parser.parse(raw_app)
+        if has_pg?(app_info)
+          raw_db = @fetcher.pg(app)
+          writer.write(app, raw_db, sort: "pg") if @options.raw_output?
+          db_info = @parser.parse(raw_db)
+          writer.write(app, db_info, sort: "pg")
+        end
+        writer.write(app, app_info)
+      }
+    end
+
+    #
+    # @param [Hash] app_info
+    # @return [Boolean]
+    #
+    def has_pg?(app_info)
+      app_info.has_key?("Addons") && app_info["Addons"].grep(/postgresql/).size > 0
+    end
+  end
+end

data/lib/heroku_app_info/content_resolver.rb

@@ -0,0 +1,22 @@
+module HerokuAppInfo
+  class ContentResolver
+    #
+    # @param [String] name
+    # @param [String, Hash] info
+    # @param [String, nil] sort
+    # @return [Array] filename, content
+    #
+    def self.resolve(name, info, sort: nil)
+      ext = info.is_a?(String) ? ".txt" : ".json"
+
+      [
+        [name, sort].compact.join("_") + ext,
+        if info.is_a?(String)
+          info
+        else
+          JSON.generate(info)
+        end
+      ]
+    end
+  end
+end

data/lib/heroku_app_info/fetcher.rb

@@ -0,0 +1,79 @@
+require_relative "content_resolver"
+require "tty-which"
+
+#
+# require Heroku-cli
+#
+
+module HerokuAppInfo
+  class Fetcher
+    #
+    # @param [Options] options
+    #
+    def initialize(options = nil)
+      @options = options
+      raise HerokuCliNotFound if TTY::Which.which("heroku").nil?
+    end
+
+    #
+    # @param [String] app
+    # @return [String]
+    #
+    def app(app)
+      if (path = cache_file(app: app))
+        File.read(path)
+      else
+        `heroku apps:info #{app}`
+      end
+    end
+
+    #
+    # @param [String] app
+    # @return [String]
+    #
+    def pg(app)
+      if (path = cache_file(app: app, sort: "pg"))
+        File.read(path)
+      else
+        `heroku pg -a #{app}`
+      end
+    end
+
+    #
+    # @param [String] app
+    # @return [String]
+    #
+    def addons(app)
+      if (path = cache_file(app: app))
+        File.read(path)
+      else
+        `heroku addons -a #{app}`
+      end
+    end
+
+    #
+    # @return [String]
+    #
+    def all_apps
+      if (path = cache_file)
+        File.read(path)
+      else
+        `heroku apps -A`
+      end
+    end
+
+    #
+    # @param [String] app
+    # @param [String] sort
+    # @return [String, false]
+    #
+    def cache_file(app: nil, sort: nil)
+      return false if @options.no_cache?
+
+      filename, = ContentResolver.resolve(app || "apps", "", sort: sort)
+      path = File.join(@options.out_dir, filename)
+
+      (File.exist?(path) && File.readable?(path)) ? path : false
+    end
+  end
+end

data/lib/heroku_app_info/options.rb

@@ -0,0 +1,76 @@
+require "optparse"
+
+module HerokuAppInfo
+  class Options
+    #
+    # @param [Array] argv
+    #
+    def initialize(argv)
+      defaults!
+      @parser = cli_parser
+      @rest = @parser.parse(argv)
+    end
+    attr_reader :apps, :out_dir, :authz, :rest
+
+    #
+    # @return [Boolean]
+    #
+    def show_all?
+      @show_all
+    end
+
+    #
+    # @return [Boolean]
+    #
+    def no_cache?
+      @no_cache
+    end
+
+    def raw_output?
+      @raw_output
+    end
+
+    def defaults!
+      @out_dir = Dir.pwd
+    end
+
+    def help
+      @parser.help
+    end
+
+    #
+    # @return [OptionParser]
+    #
+    def cli_parser
+      OptionParser.new do |opt|
+        opt.on("-a", "--app-list APP,APP,APP") do |apps|
+          @apps = apps.split(",")
+        end
+        opt.on("--app-list-from FILE") do |file|
+          if File.exist?(file) && File.readable?(file)
+            @apps = File.read(file).lines(chomp: true)
+          end
+        end
+        opt.on("-n", "--no-cache") do
+          @no_cache = true
+        end
+        opt.on("-o", "--out-dir [DIR]") do |dir|
+          if File.exist?(dir) && File.directory?(dir) && File.writable?(dir)
+            @out_dir = dir
+          end
+        end
+        opt.on("-r", "--raw-output") do
+          @raw_output = true
+        end
+        opt.on("-s", "--show-all-apps", "not include detail") do
+          @show_all = true
+        end
+        opt.on("-z", "--authorizarion AUTH") do |auth|
+          @authz = auth
+        end
+
+        opt.version = VERSION
+      end
+    end
+  end
+end

data/lib/heroku_app_info/parser.rb

@@ -0,0 +1,108 @@
+require "yaml"
+
+module HerokuAppInfo
+  class Parser
+    #
+    # simple app list
+    #
+    # @param [String] apps
+    # @return [Array]
+    #
+    def apps(apps)
+      apps.lines(chomp: true).grep_v(/\A===/).map { |e|
+        /\A([^ ]+)/ =~ e
+        $1
+      }.compact
+    end
+
+    #
+    # @param [String] text
+    # @return [Hash]
+    #
+    def parse(text)
+      info = {}
+
+      last_item = nil
+      title = nil
+      text.lines(chomp: true).each { |line|
+        next if line.size < 1
+
+        data = parse_line(line.rstrip)
+
+        case data[:item]
+        when :continuation
+          info[last_item] << data[:content]
+        when :title
+          title = data[:content]
+        else
+          multi_item = app_multi_items.select { |item, type| item == data[:item] }
+          if multi_item.size > 0
+            case multi_item.values.first.to_s
+            when "Array"
+              info[data[:item]] = [data[:content]]
+            when "Hash"
+              info[data[:item]] = parse_hash_item(data[:content])
+            end
+          else
+            info[data[:item]] = data[:content]
+          end
+        end
+        last_item = data[:item] unless data[:item] == :continuation
+      }
+
+      info
+    end
+
+    #
+    # @param [String] line
+    # @return [Hash]
+    #
+    def parse_line(line)
+      case line
+      # title line
+      when /\A=== (.+)\z/
+        {
+          item: :title,
+          content: $1
+        }
+      # data line
+      when /\A(?:([A-Z][^:]+):)?(?: +(.+))?\z/
+        if !$1 && $2 # continuation
+          {
+            item: :continuation,
+            content: $2
+          }
+        else # normal
+          {
+            item: $1,
+            content: $2
+          }
+        end
+      end
+    end
+
+    #
+    # @param [String, nil] item
+    # @return [Hash]
+    #
+    def parse_hash_item(item)
+      if item.nil?
+        {}
+      else
+
+        YAML.safe_load(item.split(",").map(&:strip).join("\n"))
+      end
+    end
+
+    #
+    # @return [Hash]
+    #
+    def app_multi_items
+      {
+        "Addons" => Array,
+        "Collaborators" => Array,
+        "Dynos" => Hash
+      }
+    end
+  end
+end

data/lib/heroku_app_info/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module HerokuAppInfo
+  VERSION = "0.1.1"
+end

data/lib/heroku_app_info/writer.rb

@@ -0,0 +1,25 @@
+require_relative "content_resolver"
+require "json"
+
+module HerokuAppInfo
+  class Writer
+    #
+    # @param [Options] options
+    #
+    def initialize(options)
+      @options = options
+    end
+
+    #
+    # @param [String] app
+    # @param [String, Hash] info
+    # @param [String, nil] sort
+    # @return [Integer]
+    #
+    def write(app, info, sort: nil)
+      filename, content = ContentResolver.resolve(app, info, sort: sort)
+
+      File.write(File.join(@options.out_dir, filename), content)
+    end
+  end
+end

data/lib/heroku_app_info.rb

@@ -0,0 +1,6 @@
+module HerokuAppInfo
+  class Error < ::StandardError; end
+  class HerokuCliNotFound < Error; end # standard:disable Layout/EmptyLineBetweenDefs
+end
+
+Dir.glob("#{File.dirname(__FILE__)}/heroku_app_info/**/*.rb").sort.each { |f| require f }

data/sig/heroku_app_info/version.rbs

@@ -0,0 +1,4 @@
+module HerokuAppInfo
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: heroku-app-info
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- wtnabe
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-which
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: store Application Stack, PotgsreSQL version, etc. mainly for upgrade
+  management.
+email:
+- 18510+wtnabe@users.noreply.github.com
+executables:
+- heroku-app-info
+extensions: []
+extra_rdoc_files: []
+files:
+- ".dockerignore"
+- ".editorconfig"
+- ".rubocop.yml"
+- ".standard.yml"
+- CHANGELOG.md
+- Dockerfile
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- exe/heroku-app-info
+- lib/heroku-app-info.rb
+- lib/heroku_app_info.rb
+- lib/heroku_app_info/cli.rb
+- lib/heroku_app_info/content_resolver.rb
+- lib/heroku_app_info/fetcher.rb
+- lib/heroku_app_info/options.rb
+- lib/heroku_app_info/parser.rb
+- lib/heroku_app_info/version.rb
+- lib/heroku_app_info/writer.rb
+- sig/heroku_app_info/version.rbs
+homepage: https://github.com/wtnabe/heroku-app-info
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/wtnabe/heroku-app-info
+  source_code_uri: https://github.com/wtnabe/heroku-app-info
+  changelog_uri: https://github.com/wtnabe/heroku-app-info/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Gather and Store Heroku App infos.
+test_files: []