armrest 0.1.0

data/lib/armrest/api/handle_response.rb

@@ -0,0 +1,23 @@
+require "hashie"
+
+module Armrest::Api
+  module HandleResponse
+    def load_json(resp)
+      if ok?(resp.code)
+        data = JSON.load(resp.body).deep_transform_keys(&:underscore)
+        Response.new(data)
+      else
+        logger.info "Error: Non-successful http response status code: #{resp.code}"
+        logger.info "headers: #{resp.each_header.to_h.inspect}"
+        raise "Azure API called failed"
+      end
+    end
+
+    # Note: 422 is Unprocessable Entity. This means an invalid data payload was sent.
+    # We want that to error and raise
+    def ok?(http_code)
+      http_code =~ /^20/ ||
+      http_code =~ /^40/
+    end
+  end
+end

data/lib/armrest/api/main.rb

@@ -0,0 +1,34 @@
+module Armrest::Api
+  class Main < Base
+    def headers
+      {
+        "Authorization" => authorization,
+        "Content-Type" => "application/json",
+      }
+    end
+
+    # cache key is the resource/audience. IE:
+    # {
+    #   "https://management.azure.com" => {...},
+    #   "https://vault.azure.com" => {...},
+    # }
+    @@creds_cache = {}
+    def authorization
+      creds = @@creds_cache[resource]
+      if creds && Time.now < Time.at(creds['expires_on'].to_i)
+        return bearer_token(creds)
+      end
+
+      provider = Armrest::Auth.new(@options).provider
+      if provider
+        creds = provider.creds
+        @@creds_cache[resource] = creds
+        bearer_token(creds)
+      end
+    end
+
+    def bearer_token(creds)
+      "#{creds['token_type']} #{creds['access_token']}"
+    end
+  end
+end

data/lib/armrest/api/mods.rb

@@ -0,0 +1,8 @@
+module Armrest::Api
+  module Mods
+    include Armrest::Logging
+    include HandleResponse
+    include Settings
+    include VERSION
+  end
+end

data/lib/armrest/api/response.rb

@@ -0,0 +1,5 @@
+module Armrest::Api
+  class Response < Hashie::Mash
+    disable_warnings
+  end
+end

data/lib/armrest/api/settings.rb

@@ -0,0 +1,37 @@
+require "azure_info"
+
+module Armrest::Api
+  module Settings
+    def client_id
+      @options[:client_id] || ENV['ARM_CLIENT_ID'] || ENV['AZURE_CLIENT_ID']
+    end
+
+    def client_secret
+      @options[:client_secret] || ENV['ARM_CLIENT_SECRET'] || ENV['AZURE_CLIENT_SECRET']
+    end
+
+    def tenant_id
+      @options[:tenant_id] || ENV['ARM_TENANT_ID'] || ENV['AZURE_TENANT_ID'] || AzureInfo.tenant_id
+    end
+
+    def resource
+      @options[:resource] || "https://management.azure.com"
+    end
+
+    def subscription_id
+      @options[:subscription_id] || ENV['ARM_SUBSCRIPTION_ID'] || ENV['AZURE_SUBSCRIPTION_ID'] || AzureInfo.subscription_id
+    end
+
+    def location
+      @options[:location] || ENV['ARM_LOCATION'] || ENV['AZURE_LOCATION'] || AzureInfo.location
+    end
+
+    def group
+      @options[:group] || ENV['ARM_GROUP'] || AzureInfo.group
+    end
+
+    def endpoint
+      @options[:endpoint] || "https://management.azure.com"
+    end
+  end
+end

data/lib/armrest/api/version.rb

@@ -0,0 +1,8 @@
+module Armrest::Api
+  module VERSION
+    # vault uses 7.1
+    def api_version
+      @options[:api_version] || "2021-04-01"
+    end
+  end
+end

data/lib/armrest/auth.rb

@@ -0,0 +1,48 @@
+module Armrest
+  class Auth
+    include Armrest::Logging
+
+    def initialize(options={})
+      @options = options
+    end
+
+    def provider
+      providers.each do |meth|
+        provider = send(meth)
+        if provider
+          logger.debug "Resolved auth provider: #{provider}"
+          return provider
+        end
+      end
+      nil
+    end
+
+  private
+    def providers
+      if @options[:type]
+        ["#{@options[:type]}_credentials"]
+      else # full chain
+        [
+          :app_credentials,
+          :msi_credentials,
+          :cli_credentials,
+        ]
+      end
+    end
+
+    def app_credentials
+      return unless ENV['ARM_CLIENT_ID'] || ENV['AZURE_CLIENT_ID']
+      Armrest::Api::Auth::Login.new(@options)
+    end
+
+    def msi_credentials
+      api = Armrest::Api::Auth::Metadata.new(@options)
+      api if api.available?
+    end
+
+    def cli_credentials
+      return unless File.exist?("#{ENV['HOME']}/.azure/accessTokens.json")
+      Armrest::Api::Auth::CLI.new(@options)
+    end
+  end
+end

data/lib/armrest/autoloader.rb

@@ -0,0 +1,25 @@
+require "zeitwerk"
+
+module Armrest
+  class Autoloader
+    class Inflector < Zeitwerk::Inflector
+      def camelize(basename, _abspath)
+        map = self.class.camelize_map
+        map[basename.to_sym] || super
+      end
+
+      def self.camelize_map
+        { cli: "CLI", msi: "MSI", version: "VERSION" }
+      end
+    end
+
+    class << self
+      def setup
+        loader = Zeitwerk::Loader.new
+        loader.inflector = Inflector.new
+        loader.push_dir(File.dirname(__dir__)) # lib
+        loader.setup
+      end
+    end
+  end
+end

data/lib/armrest/cli/auth.rb

@@ -0,0 +1,16 @@
+class Armrest::CLI
+  class Auth
+    def initialize(options={})
+      @options = options
+    end
+
+    def run
+      provider = Armrest::Auth.new(@options).provider
+      if provider
+        puts JSON.pretty_generate(provider.creds)
+      else
+        puts "Unable to authenticate"
+      end
+    end
+  end
+end

data/lib/armrest/cli/base.rb

@@ -0,0 +1,7 @@
+class Armrest::CLI
+  class Base
+    def initialize(options={})
+      @options = options
+    end
+  end
+end

data/lib/armrest/cli/blob_container.rb

@@ -0,0 +1,29 @@
+class Armrest::CLI
+  class BlobContainer < Armrest::Command
+    class_option :storage_account, desc: "Storage account name"
+
+    desc "get", "Check existence of blob container"
+    long_desc Help.text("blob_container/get")
+    def get(name)
+      exist = Armrest::Services::BlobContainer.new(options).get(name: name)
+      if exist
+        puts "Blob container exists: #{name}"
+      else
+        puts "Blob container does not exist: #{name}"
+      end
+    end
+
+    desc "create", "Create or update Blob container"
+    long_desc Help.text("blob_container/create")
+    def create(name)
+      resp = Armrest::Services::BlobContainer.new(options).create(name: name)
+      if resp.code == "201"
+        puts "Blob container created: #{name}"
+      else
+        puts "Blob container unable to create: #{name}"
+        puts "resp:"
+        pp resp
+      end
+    end
+  end
+end

data/lib/armrest/cli/blob_service.rb

@@ -0,0 +1,25 @@
+class Armrest::CLI
+  class BlobService < Armrest::Command
+    class_option :storage_account, desc: "Storage account name"
+
+    desc "get_properties", "Check existence of blob container"
+    long_desc Help.text("blob_container/get_properties")
+    def get_properties
+      result = Armrest::Services::BlobService.new(options).get_properties
+      puts JSON.pretty_generate(result)
+    end
+
+    desc "create", "Create or update Blob container"
+    long_desc Help.text("blob_container/create")
+    option :delete_retention_policy, type: :hash, desc: "days:7 enabled:true"
+    option :container_delete_retention_policy, type: :hash, desc: "days:7 enabled:true"
+    option :is_versioning_enabled, type: :boolean, desc: "Enables versioning"
+    def set_properties
+      props = options.dup
+      props.delete(:storage_account)
+      resp = Armrest::Services::BlobService.new(options).set_properties(props)
+      puts "resp:"
+      pp resp
+    end
+  end
+end

data/lib/armrest/cli/help/blob_service/set_properties.md

@@ -0,0 +1,4 @@
+## Examples
+
+    export STORAGE_ACCOUNT=mystorageaccount
+    armrest blob_service set_properties --storage-account $STORAGE_ACCOUNT --delete-retention-policy days:7 enabled:true --container-delete-retention-policy days:8 enabled:true

data/lib/armrest/cli/help/completion.md

@@ -0,0 +1,20 @@
+## Examples
+
+    armrest completion
+
+Prints words for TAB auto-completion.
+
+    armrest completion
+    armrest completion hello
+    armrest completion hello name
+
+To enable, TAB auto-completion add the following to your profile:
+
+    eval $(armrest completion_script)
+
+Auto-completion example usage:
+
+    armrest [TAB]
+    armrest hello [TAB]
+    armrest hello name [TAB]
+    armrest hello name --[TAB]

data/lib/armrest/cli/help/completion_script.md

@@ -0,0 +1,3 @@
+To use, add the following to your `~/.bashrc` or `~/.profile`
+
+    eval $(armrest completion_script)

data/lib/armrest/cli/help/connect.md

@@ -0,0 +1,3 @@
+## Examples
+
+    armrest connect

data/lib/armrest/cli/help.rb

@@ -0,0 +1,11 @@
+class Armrest::CLI
+  module Help
+    class << self
+      def text(namespaced_command)
+        path = namespaced_command.to_s.gsub(':','/')
+        path = File.expand_path("../help/#{path}.md", __FILE__)
+        IO.read(path) if File.exist?(path)
+      end
+    end
+  end
+end

data/lib/armrest/cli/resource_group.rb

@@ -0,0 +1,29 @@
+class Armrest::CLI
+  class ResourceGroup < Armrest::Command
+    desc "check_existence", "Check existence of resource group"
+    long_desc Help.text("resource_group/check_existence")
+    def check_existence(name)
+      exist = Armrest::Services::ResourceGroup.new(options).check_existence(name: name)
+      if exist
+        puts "Resource group exists: #{name}"
+      else
+        puts "Resource group does not exist: #{name}"
+      end
+    end
+
+    desc "create_or_update", "Create or update resource group"
+    long_desc Help.text("resource_group/create_or_update")
+    option :location, description: "location"
+    option :tags, type: :hash, description: "--tags=name:bob age:8"
+    def create_or_update(name)
+      resp = Armrest::Services::ResourceGroup.new(options).create_or_update(options.merge(name: name))
+      if resp.code == "201"
+        puts "Resource group created: #{name}"
+      else
+        puts "Resource group unable to create: #{name}"
+        puts "resp:"
+        pp resp
+      end
+    end
+  end
+end

data/lib/armrest/cli/secret.rb

@@ -0,0 +1,11 @@
+class Armrest::CLI
+  class Secret < Armrest::Command
+    desc "show", "Runs show operations."
+    long_desc Help.text("secret/show")
+    option :version, aliases: %w[v], description: "secret version"
+    option :vault, description: "vault name"
+    def show(name)
+      puts Armrest::Services::KeyVault::Secret.new(options).show(name: name)
+    end
+  end
+end

data/lib/armrest/cli/storage_account.rb

@@ -0,0 +1,32 @@
+class Armrest::CLI
+  class StorageAccount < Armrest::Command
+    desc "check_name_availability", "Check availability of storage account"
+    long_desc Help.text("storage_account/check_name_availability")
+    def check_name_availability(name)
+      result = Armrest::Services::StorageAccount.new(options).check_name_availability(name: name)
+      if result.name_available
+        puts "Storage account is available: #{name}"
+      else
+        puts "Storage account is not available: #{name}"
+        pp result
+      end
+    end
+
+    desc "create", "Create storage account"
+    long_desc Help.text("storage_account/create")
+    option :location, description: "location"
+    option :tags, type: :hash, description: "--tags=name:bob age:8"
+    def create(name)
+      resp = Armrest::Services::StorageAccount.new(options).create(options.merge(name: name))
+      puts "resp:"
+      pp resp
+      if resp.code == "202"
+        puts "Storage account created: #{name}"
+      elsif resp.code =~ /^20/
+        puts "Storage account updated: #{name}"
+      else
+        puts "Storage account unable to create: #{name}"
+      end
+    end
+  end
+end

data/lib/armrest/cli.rb

@@ -0,0 +1,49 @@
+module Armrest
+  class CLI < Command
+    class_option :verbose, type: :boolean
+    class_option :noop, type: :boolean
+
+    desc "blob_container SUBCOMMAND", "blob_container subcommands"
+    long_desc Help.text(:blob_container)
+    subcommand "blob_container", BlobContainer
+
+    desc "blob_service SUBCOMMAND", "blob_service subcommands"
+    long_desc Help.text(:blob_service)
+    subcommand "blob_service", BlobService
+
+    desc "resource_group SUBCOMMAND", "resource_group subcommands"
+    long_desc Help.text(:resource_group)
+    subcommand "resource_group", ResourceGroup
+
+    desc "secret SUBCOMMAND", "secret subcommands"
+    long_desc Help.text(:secret)
+    subcommand "secret", Secret
+
+    desc "storage_account SUBCOMMAND", "storage_account subcommands"
+    long_desc Help.text(:storage_account)
+    subcommand "storage_account", StorageAccount
+
+    desc "auth [TYPE]", "Auth to Azure API. When type is not provided the full credentials chain is checked"
+    long_desc Help.text(:auth)
+    def auth(type=nil)
+      Auth.new(options.merge(type: type)).run
+    end
+
+    desc "completion *PARAMS", "Prints words for auto-completion."
+    long_desc Help.text(:completion)
+    def completion(*params)
+      Completer.new(CLI, *params).run
+    end
+
+    desc "completion_script", "Generates a script that can be eval to setup auto-completion."
+    long_desc Help.text(:completion_script)
+    def completion_script
+      Completer::Script.generate
+    end
+
+    desc "version", "prints version"
+    def version
+      puts VERSION
+    end
+  end
+end

data/lib/armrest/command.rb

@@ -0,0 +1,89 @@
+require "thor"
+
+# Override thor's long_desc identation behavior
+# https://github.com/erikhuda/thor/issues/398
+class Thor
+  module Shell
+    class Basic
+      def print_wrapped(message, options = {})
+        message = "\n#{message}" unless message[0] == "\n"
+        stdout.puts message
+      end
+    end
+  end
+end
+
+module Armrest
+  class Command < Thor
+    class << self
+      def dispatch(m, args, options, config)
+        # Allow calling for help via:
+        #   armrest command help
+        #   armrest command -h
+        #   armrest command --help
+        #   armrest command -D
+        #
+        # as well thor's normal way:
+        #
+        #   armrest help command
+        help_flags = Thor::HELP_MAPPINGS + ["help"]
+        if args.length > 1 && !(args & help_flags).empty?
+          args -= help_flags
+          args.insert(-2, "help")
+        end
+
+        #   armrest version
+        #   armrest --version
+        #   armrest -v
+        version_flags = ["--version", "-v"]
+        if args.length == 1 && !(args & version_flags).empty?
+          args = ["version"]
+        end
+
+        super
+      end
+
+      # Override command_help to include the description at the top of the
+      # long_description.
+      def command_help(shell, command_name)
+        meth = normalize_command_name(command_name)
+        command = all_commands[meth]
+        alter_command_description(command)
+        super
+      end
+
+      def alter_command_description(command)
+        return unless command
+
+        # Add description to beginning of long_description
+        long_desc = if command.long_description
+            "#{command.description}\n\n#{command.long_description}"
+          else
+            command.description
+          end
+
+        # add reference url to end of the long_description
+        unless website.empty?
+          full_command = [command.ancestor_name, command.name].compact.join('-')
+          url = "#{website}/reference/armrest-#{full_command}"
+          long_desc += "\n\nHelp also available at: #{url}"
+        end
+
+        command.long_description = long_desc
+      end
+      private :alter_command_description
+
+      # meant to be overriden
+      def website
+        ""
+      end
+
+      # https://github.com/erikhuda/thor/issues/244
+      # Deprecation warning: Thor exit with status 0 on errors. To keep this behavior, you must define `exit_on_failure?` in `Lono::CLI`
+      # You can silence deprecations warning by setting the environment variable THOR_SILENCE_DEPRECATION.
+      def exit_on_failure?
+        true
+      end
+    end
+  end
+end

data/lib/armrest/completer/script.rb

@@ -0,0 +1,8 @@
+class Armrest::Completer
+  class Script
+    def self.generate
+      bash_script = File.expand_path("script.sh", File.dirname(__FILE__))
+      puts "source #{bash_script}"
+    end
+  end
+end

data/lib/armrest/completer/script.sh

@@ -0,0 +1,10 @@
+_armrest() {
+  COMPREPLY=()
+  local word="${COMP_WORDS[COMP_CWORD]}"
+  local words=("${COMP_WORDS[@]}")
+  unset words[0]
+  local completion=$(armrest completion ${words[@]})
+  COMPREPLY=( $(compgen -W "$completion" -- "$word") )
+}
+
+complete -F _armrest armrest