armrest 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c493f5db6bcb59d4a490038ed731e2bdeea4c39dcbbed24b67a15f8d289e982b
+  data.tar.gz: 76ae92a89cb3e3402d58270d4f8ed2596cf661dcd3c4e49c2fd8fc07280a552b
+SHA512:
+  metadata.gz: cc0ae7d618f8737c1f9e8e27c3cb2bf9b6b2a92e2811fe2108ba695863789980aa5d4ac6e5908a57ffee6b8b85691e628d5bd5828dd385ffc21c12ef35821edd
+  data.tar.gz: f01f5ae21d330449c660c3e5d3e0955540ed80c28513cf1cce9d03d9bcbaf17bda73914d27b2ff604447eb221599f23b0908d48b11027b3477a974c0c1426033

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+*.swp
+/.bundle
+/.config
+/.yardoc
+/_yardoc
+/coverage
+/doc/
+/Gemfile.lock
+/InstalledFiles
+/lib/bundler/man
+/pkg
+/rdoc
+/spec/reports
+/test/tmp
+/test/version_tmp
+/tmp

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--format documentation

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
+
+## [0.1.0]
+- Initial release.

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem dependencies in armrest.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,19 @@
+guard "bundler", cmd: "bundle" do
+  watch("Gemfile")
+  watch(/^.+\.gemspec/)
+end
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,77 @@
+# Armrest
+
+[![BoltOps Badge](https://img.boltops.com/boltops/badges/boltops-badge.png)](https://www.boltops.com)
+
+[![Gem Version](https://badge.fury.io/rb/armrest.svg)](https://badge.fury.io/rb/armrest)
+
+A very lightweight Azure library that works with the [Azure REST API](https://docs.microsoft.com/en-us/rest/api/azure/), it is not meant to be extensive.
+
+This was built because there doesn't seem to be a good library out there with the Azure features that [Terraspace](https://terraspace.cloud/) and [Terraspace Plugin Azurerm](https://github.com/boltops-tools/terraspace_plugin_azurerm) wanted to use:
+
+* Auth Chain Provider: env vars -> MSI -> CLI creds. [#6](https://github.com/boltops-tools/terraspace_plugin_azurerm/issues/6)
+* KeyVault secrets via the REST API
+
+Also, the [Microsoft Azure SDK for Ruby library was deprecated as of Feb 2021](https://github.com/Azure/azure-sdk-for-ruby/blob/master/docs/README.md) and was officially retired. It's core library [ms_rest_azure.gemspec](https://github.com/Azure/azure-sdk-for-ruby/blob/master/runtime/ms_rest_azure/ms_rest_azure.gemspec#L39) have pinned versions of gems like faraday < 2, which causes gem dependency resolution issues.
+
+This library also only makes use of the Ruby standard builtin net/http library so there's no dependency on faraday.
+
+Again, this library has no goals of being extensive. Code generated SDKs is the approach that would take for that, but not dedicating the time to do that for this library.
+
+## Usage: Ruby
+
+Resource group:
+
+```ruby
+require "armrest"
+resource_group = Armrest::Services::ResourceGroup.new
+resource_group.create_or_update(
+  name: "my-resource-group",
+  location: "eastus",
+  tags: {key1: "value1"},
+)
+```
+
+Refer to the [boltops-tools/terraspace_plugin_azurer](https://github.com/boltops-tools/terraspace_plugin_azurerm) for more examples.
+
+## Usage: CLI
+
+The main purpose of gem is to be a Ruby library that Terraspace can interact with.  The CLI interface was only built to help quickly test the code with live resources. It's essentially a way to QA.  Here are some examples:
+
+Auth:
+
+    armrest auth app
+    armrest auth msi
+    armrest auth cli
+
+The auth chain is: app -> msi -> cli
+
+    armrest auth chain
+
+You can disable MSI with `ARMREST_DISABLE_MSI=1`.
+
+Resource Group:
+
+    armrest resource_group check_existence demo
+
+Storage Account:
+
+    armrest storage_account create demofoobar123v3 --tags name:bob age:8
+
+Blob Service:
+
+    armrest blob_service set_properties --storage-account demofoobar123 --delete-retention-policy days:9 enabled:true --container-delete-retention-policy days:10 enabled:true --is-versioning-enabled
+
+Secret:
+
+    $ export ARMREST_VAULT=demo-dev-vault-test1
+    $ armrest secret show demo-dev-pass
+    secret1
+    $
+
+## Installation
+
+Add to your Gemfile
+
+Gemfile
+
+    gem "armrest"

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task default: :spec
+
+RSpec::Core::RakeTask.new
+
+require_relative "lib/armrest"
+require "cli_markdown"
+desc "Generates cli reference docs as markdown"
+task :docs do
+  mkdir_p "docs/_includes"
+  CliMarkdown::Creator.create_all(cli_class: Armrest::CLI, cli_name: "armrest")
+end

data/armrest.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "armrest/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "armrest"
+  spec.version       = Armrest::VERSION
+  spec.authors       = ["Tung Nguyen"]
+  spec.email         = ["tongueroo@gmail.com"]
+  spec.summary       = "Ruby Azure REST API Library"
+  spec.homepage      = "https://github.com/boltops-tools/armrest"
+  spec.license       = "Apache-2.0"
+
+  spec.files         = File.directory?('.git') ? `git ls-files`.split($/) : Dir.glob("**/*")
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "azure_info"
+  spec.add_dependency "hashie"
+  spec.add_dependency "memoist"
+  spec.add_dependency "rack"
+  spec.add_dependency "rainbow"
+  spec.add_dependency "thor"
+  spec.add_dependency "zeitwerk"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "cli_markdown"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/exe/armrest

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+# Trap ^C
+Signal.trap("INT") {
+  puts "\nCtrl-C detected. Exiting..."
+  sleep 0.1
+  exit
+}
+
+$:.unshift(File.expand_path("../../lib", __FILE__))
+require "armrest"
+require "armrest/cli"
+
+Armrest::CLI.start(ARGV)

data/lib/armrest/api/auth/base.rb

@@ -0,0 +1,8 @@
+module Armrest::Api::Auth
+  class Base < Armrest::Api::Base
+    def initialize(options={})
+      super
+      @camelize_request_data = false
+    end
+  end
+end

data/lib/armrest/api/auth/cli.rb

@@ -0,0 +1,36 @@
+require "json"
+
+#
+# az account get-access-token : Get a token for utilities to access Azure.
+#         The token will be valid for at least 5 minutes with the maximum at 60 minutes. If the
+#         subscription argument isn't specified, the current account is used.
+#
+# Arguments
+#     --resource         : Azure resource endpoints. Default to Azure Resource Manager.
+#     --resource-type    : Type of well-known resource.  Allowed values: aad-graph, arm, batch, data-
+#                         lake, media, ms-graph, oss-rdbms.
+#     --subscription -s  : Name or ID of subscription.
+#     --tenant -t        : Tenant ID for which the token is acquired. Only available for user and
+#                         service principal account, not for MSI or Cloud Shell account.
+module Armrest::Api::Auth
+  class CLI < Base
+    class Error < StandardError; end
+    class CliError < Error; end
+
+    def creds
+      data = get_access_token
+      data.deep_transform_keys { |k| k.underscore } # to normalize the structure to the other classes
+    end
+
+    # Looks like az account get-access-token caches the toke in ~/.azure/accessTokens.json
+    # and will update it only when it expires. So dont think we need to handle caching
+    def get_access_token
+      command = "az account get-access-token -o json --resource #{resource}"
+      logger.debug "command: #{command}"
+      out = `#{command}`
+      JSON.load(out)
+    rescue
+      raise CliError, 'Error acquiring token from the Azure az CLI'
+    end
+  end
+end

data/lib/armrest/api/auth/login.rb

@@ -0,0 +1,18 @@
+module Armrest::Api::Auth
+  class Login < Base
+    def endpoint
+      "https://login.microsoftonline.com"
+    end
+
+    def creds
+      url = "#{tenant_id}/oauth2/token"
+      resp = get(url,
+        grant_type: "client_credentials",
+        client_id: client_id,
+        client_secret: client_secret,
+        resource: resource,
+      )
+      load_json(resp)
+    end
+  end
+end

data/lib/armrest/api/auth/metadata.rb

@@ -0,0 +1,51 @@
+# GET 'https://169.254.169.254/metadata/identity/oauth2/token?api-version=2018-02-01&resource=https://management.azure.com/' HTTP/1.1 Metadata: true
+module Armrest::Api::Auth
+  class Metadata < Base
+    def initialize(options={})
+      @options = options
+    end
+
+    def creds
+      url = "metadata/identity/oauth2/token?" + Rack::Utils.build_query(query_params)
+      resp = get(url)
+      load_json(resp)
+    end
+
+    @@available = nil
+    def available?
+      return false if ENV['ARMREST_DISABLE_MSI']
+      return @@available unless @@available.nil?
+      url = "metadata/instance"
+      resp = nil
+      with_open_timeout(0.5) do
+        resp = get(url)
+      end
+      @@available = resp.code == "200"
+    rescue Net::OpenTimeout => e
+      logger.debug "#{e.class}: #{e.message}"
+      false
+    end
+
+    def query_params
+      params = { resource: resource }
+      params[:client_id] = client_id if client_id
+      params[:object_id] = object_id if @options[:object_id]
+      params[:msi_res_id] = msi_res_id if @options[:msi_res_id]
+      params
+    end
+
+    # interface method
+    def endpoint
+      "http://169.254.169.254"
+    end
+
+    # interface method
+    def headers
+      { Metadata: true }
+    end
+
+    def api_version
+      "2021-10-01"
+    end
+  end
+end

data/lib/armrest/api/base.rb

@@ -0,0 +1,133 @@
+require 'net/http'
+require 'rack'
+
+module Armrest::Api
+  class Base
+    extend Memoist
+    include Mods
+
+    def initialize(options={})
+      @options = options
+      @camelize_request_data = true
+    end
+
+    HTTP_WRITE_METHODS = %w[post patch put delete]
+    HTTP_READ_METHODS = %w[get head]
+    methods = HTTP_WRITE_METHODS + HTTP_READ_METHODS
+    methods.each do |meth|
+      define_method(meth) do |path, data={}|
+        request("Net::HTTP::#{meth.camelize}".constantize, path, data)
+      end
+      # IE:
+      # def get(path, data={})
+      #   request(Net::HTTP::Get, path, data)
+      # end
+    end
+
+    # Always translate raw json response to ruby Hash
+    def request(klass, path, data={})
+      path = standarize_path(path)
+      url = url(path)
+      req = build_request(klass, path, data)
+      http = http(url)
+      meth = klass.to_s.split('::').last.underscore
+      logger.debug "#{meth.upcase} #{url}".color(:yellow)
+      # logger.debug "req['Authorization'] #{req['Authorization']}"
+
+      resp = send_request(http, req)
+
+      logger.debug "resp #{resp}"
+      logger.debug "resp.code #{resp.code}"
+      logger.debug "resp.body #{resp.body}"
+
+      if HTTP_WRITE_METHODS.include?(meth) && resp.code !~ /^20/
+        raise Armrest::Error.new(resp)
+      end
+
+      resp
+    end
+
+    MAX_RETRIES = (ENV['ARMREST_MAX_RETRIES'] || 3).to_i
+    def send_request(http, req)
+      retries = 0
+      resp = http.request(req) # send request
+      retry_codes = [/^5/, "429"]
+      retry_code_detected = retry_codes.detect { |code| resp.code.match(code) }
+      if retry_code_detected && retries < MAX_RETRIES
+        retries += 1
+        delay = 2 ** retries
+        logger.debug "retries #{retries} sleep #{delay} and will retry."
+        sleep delay
+        resp = http.request(req) # send request
+      end
+      resp
+    end
+
+    def build_request(klass, path, data={})
+      data = camelize(data)
+      req = klass.new(path) # url includes query string and uri.path does not, must used url
+      set_headers!(req)
+
+      logger.debug "build_request data #{data}"
+
+      # Note: Need to use to_s for case statement to work right
+      case klass.to_s.split('::').last.underscore
+      when "delete", "patch",  "post",  "put"
+        text = JSON.dump(data)
+        req.body = text
+        req.content_length = text.bytesize
+      when "get"
+        req.set_form_data(data) if data && !data.empty?
+      end
+
+      req
+    end
+
+    def camelize(data)
+      return data unless @camelize_request_data
+      data.deep_transform_keys { |k| k.to_s.camelize(:lower) }
+    end
+
+    def standarize_path(path)
+      path = "/#{path}" unless path.starts_with?('/')
+      path = append_api_version(path)
+    end
+
+    def append_api_version(path)
+      separator = path.include?('?') ? '&' : '?'
+      path + separator + "api-version=#{api_version}"
+    end
+
+    def set_headers!(req)
+      headers.each do |k,v|
+        req[k.to_s] = v.to_s
+      end
+    end
+
+    # interface method
+    def headers
+      {}
+    end
+
+    def http(url)
+      uri = URI(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.open_timeout = @open_timeout || 30
+      http.read_timeout = @read_timeout || 30
+      http.use_ssl = true if uri.scheme == 'https'
+      http
+    end
+    memoize :http
+
+    def with_open_timeout(value)
+      saved, @open_timeout = @open_timeout, value
+      yield
+      @open_timeout = saved
+    end
+
+    # interface method. API endpoint does not include the /. IE: https://login.microsoftonline.com
+    def url(path)
+      "#{endpoint}#{path}"
+    end
+  end
+end