awsmeta 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 22655250d2a0f509faa429b62ea98f640c06d3b329c7a936329323f0ba5176ff
+  data.tar.gz: '036388775705add35cbb434f1922c1e01e82a9d7c971ac82d90b8ad12509d180'
+SHA512:
+  metadata.gz: 72f8db6eb94cbfb7837ab59d9ce4c233327d8b3d6b572cc6102d58d33bb29e24fea032e9ef0a1eab28b7a7673b19ec240ad1b6ce65a5b22435df298ec06eb1a7
+  data.tar.gz: f2c8ad18eb645d18e3414375596ae6b53263d20dfb697157ee7d1851c673471a772f14a20005518e2bc1ce4871afc6e0227328bf10e26e46eafb8b9acb582b1c

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+ - 2.5
+ - 2.7
+install:
+ - bundle install
+script:
+ - gem build awsmeta.gemspec
+ - rspec

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    awsmeta (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awsmeta!
+  rspec
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,24 @@
+MIT License
+-----------
+
+Copyright (c) 2020 Hayden McFarland
+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

@@ -0,0 +1,70 @@
+# awsmeta
+![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
+[![Maintainability](https://api.codeclimate.com/v1/badges/adfb8333557241e81a02/maintainability)](https://codeclimate.com/github/haydenmcfarland/awsmeta/maintainability)
+[![Build Status](https://travis-ci.org/haydenmcfarland/awsmeta.svg?branch=master)](https://travis-ci.org/haydenmcfarland/awsmeta)
+
+# How to use
+
+Add `awsmeta` to your gem file:
+
+```ruby
+gem 'awsmeta', git: 'https://github.com/haydenmcfarland/awsmeta'
+```
+
+Run `bundle install`
+
+# Example usage
+
+```ruby
+Awsmeta.credentials
+
+{
+  :code=>"Success",
+  :last_updated=>"2020-03-02T03:04:00Z",
+  :type=>"AWS-HMAC",
+  :access_key_id=>"***",
+  :secret_access_key=>"***",
+  :token=>"***",
+  :expiration=>"2020-03-02T09:39:04Z"
+}
+```
+
+```ruby
+Awsmeta.document
+
+{
+  :account_id=>"***",
+  :architecture=>"x86_64",
+  :availability_zone=>"us-west-2a",
+  :billing_products=>nil,
+  :devpay_product_codes=>nil,
+  :marketplace_product_codes=>nil,
+  :image_id=>"ami-***",
+  :instance_id=>"i-***",
+  :instance_type=>"t2.micro",
+  :kernel_id=>nil,
+  :pending_time=>"2020-03-02T02:58:35Z",
+  :private_ip=>"*.*.*.*",
+  :ramdisk_id=>nil,
+  :region=>"us-west-2",
+  :version=>"2017-09-30"
+}
+```
+
+```ruby
+Awsmeta.instance_id
+"i-***"
+```
+
+```ruby
+Awsmeta.role
+"ec2role"
+```
+
+If a role is not defined, the `credential` and `role` calls will raise
+an `A`wsmeta::Errors::ResourceNotFound` error.
+
+```ruby
+Awsmeta.role
+Awsmeta::Errors::ResourceNotFound (Not Found)
+```

data/awsmeta.gemspec

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative 'lib/awsmeta/version'
+
+Gem::Specification.new do |s|
+  s.name = 'awsmeta'
+  s.version = Awsmeta::VERSION
+  s.authors = ['haydenmcfarland']
+  s.email = ['mcfarlandsms@gmail.com']
+  s.date = '2020-02-28'
+  s.summary = 'AWS metadata loader'
+  s.description = 'AWS metadata loader'
+  s.homepage = 'https://github.com/haydenmcfarland/awsmeta'
+  s.license = 'MIT'
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  s.require_paths = ['lib']
+end

data/lib/awsmeta.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require 'uri'
+
+# require gem ruby files
+Dir[File.dirname(__FILE__) + '/**/*.rb'].sort.each { |file| require file }
+
+# Awsmeta retrieves metadata from AWS EC2 instances
+module Awsmeta
+  module_function
+
+  def credentials
+    path = ResourcePaths::Metadata::CREDENTIALS_PATH
+    result = Query.fetch("#{path}/#{role}")
+    Helpers::Hash.symbolize_and_underscore_keys(result)
+  end
+
+  def document
+    path = ResourcePaths::Dynamic::INSTANCE_IDENTITY_PATH
+    result = Query.fetch(path, true)
+    Helpers::Hash.symbolize_and_underscore_keys(result)
+  end
+
+  def instance_id
+    Query.fetch(ResourcePaths::Metadata::INSTANCE_ID_PATH)
+  end
+
+  def role
+    Query.fetch(ResourcePaths::Metadata::CREDENTIALS_PATH)
+  end
+end

data/lib/awsmeta/config.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Awsmeta
+  # contains configuration methods
+  module Config
+    module_function
+
+    def read_timeout
+      (ENV['AWSMETA_READ_TIMEOUT'] || 10).to_i
+    end
+
+    def open_timeout
+      (ENV['AWSMETA_OPEN_TIMEOUT'] || 10).to_i
+    end
+  end
+end

data/lib/awsmeta/constants.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Awsmeta
+  module Constants
+    # aws reserved host used to get instance meta-data
+    METADATA_HOST = '169.254.169.254'
+    METADATA_BASE_URL = "http://#{METADATA_HOST}"
+    METADATA_LATEST_BASE_URL = "#{METADATA_BASE_URL}/latest/%s"
+    METADATA_LATEST_URL = "#{METADATA_LATEST_BASE_URL % 'meta-data'}/%s"
+    METADATA_LATEST_DYNAMIC_URL = "#{METADATA_LATEST_BASE_URL % 'dynamic'}/%s"
+  end
+end

data/lib/awsmeta/errors/resource_not_found.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Awsmeta
+  module Errors
+    class ResourceNotFound < StandardError; end
+  end
+end

data/lib/awsmeta/extras/discovery.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Awsmeta
+  # used to process metadata responses
+  module Extras
+    # useful extras that help with integration
+    module Discovery
+      module_function
+
+      # check for if code is executing on an ec2 instance
+      def ec2?
+        return false if ENV['AWSMETA_DISABLE_EC2_DISCOVERY'] == 'true'
+
+        !Awsmeta.instance_id.nil?
+      rescue Net::OpenTimeout,
+             Errno::EHOSTUNREACH,
+             Awsmeta::Errors::ResourceNotFound
+        false
+      end
+    end
+  end
+end

data/lib/awsmeta/helpers/hash/hash.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Awsmeta
+  # used to process metadata responses
+  module Helpers
+    # a set of hash processors
+    module Hash
+      module_function
+
+      def underscore(camel_cased_word)
+        return camel_cased_word unless /[A-Z-]|::/.match?(camel_cased_word)
+
+        word = camel_cased_word.to_s.gsub('::', '/')
+        word.gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+            .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+            .tr('-', '_')
+            .downcase
+      end
+
+      def symbolize_and_underscore_keys(obj)
+        obj.each_with_object({}) do |(k, v), h|
+          h[k.nil? ? k : underscore(k).to_sym] = v
+        end
+      end
+    end
+  end
+end

data/lib/awsmeta/query.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Awsmeta
+  # contains methods to query meta data
+  module Query
+    module_function
+
+    def query_metadata(query)
+      url = Awsmeta::Constants::METADATA_LATEST_URL
+      Awsmeta::Request.request(url % query)
+    end
+
+    def query_dynamic(query)
+      url = Awsmeta::Constants::METADATA_LATEST_DYNAMIC_URL
+      Awsmeta::Request.request(url % query)
+    end
+
+    def fetch(query, dynamic = false)
+      result = dynamic ? query_dynamic(query) : query_metadata(query)
+
+      raise Awsmeta::Errors::ResourceNotFound, result[:error] unless
+        result[:resource]
+
+      result[:resource]
+    end
+  end
+end

data/lib/awsmeta/request.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Awsmeta
+  # contains methods used to request and parse metadata
+  module Request
+    module_function
+
+    def get(url)
+      uri = URI.parse(url)
+      req = Net::HTTP.new(uri.host, uri.port)
+      req.read_timeout = Awsmeta::Config.read_timeout
+      req.open_timeout = Awsmeta::Config.open_timeout
+      req.start { |http| http.get(uri.to_s) }
+    end
+
+    def safe_json_parse(string)
+      JSON.parse(string)
+    rescue JSON::ParserError
+      string
+    end
+
+    def request(url)
+      response = get(url)
+      return { error: response.message, code: response.code } if
+        response.code != '200'
+
+      result = safe_json_parse(response.body)
+      { resource: result }
+    end
+  end
+end

data/lib/awsmeta/resource_paths/dynamic.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Awsmeta
+  module ResourcePaths
+    module Dynamic
+      INSTANCE_IDENTITY_PATH = 'instance-identity/document'
+    end
+  end
+end

data/lib/awsmeta/resource_paths/metadata.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Awsmeta
+  module ResourcePaths
+    module Metadata
+      CREDENTIALS_PATH = 'iam/security-credentials'
+      INSTANCE_ID_PATH = 'instance-id'
+    end
+  end
+end

data/lib/awsmeta/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Awsmeta
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: awsmeta
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- haydenmcfarland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-28 00:00:00.000000000 Z
+dependencies: []
+description: AWS metadata loader
+email:
+- mcfarlandsms@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- awsmeta.gemspec
+- lib/awsmeta.rb
+- lib/awsmeta/config.rb
+- lib/awsmeta/constants.rb
+- lib/awsmeta/errors/resource_not_found.rb
+- lib/awsmeta/extras/discovery.rb
+- lib/awsmeta/helpers/hash/hash.rb
+- lib/awsmeta/query.rb
+- lib/awsmeta/request.rb
+- lib/awsmeta/resource_paths/dynamic.rb
+- lib/awsmeta/resource_paths/metadata.rb
+- lib/awsmeta/version.rb
+homepage: https://github.com/haydenmcfarland/awsmeta
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: AWS metadata loader
+test_files: []