cloudwatch_logs_insights_url_builder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76f321c616c87f935c6698cd13d763fea55e3ded22ceeccc7bf3ce9e4444d644
+  data.tar.gz: 55a903d5832dae43ec348b7c35df2bf3f9cd4a5a7212fa09db2c0f61e3c245c9
+SHA512:
+  metadata.gz: 443eebdfe8bf3530385502ae71a20c824ae80237feeb74c8072967cbe2a23e35851a35b3587cecf20ac455c1278c6b2701bff9c4054940bba4e1dcc9beef017e
+  data.tar.gz: 6faec77bd5a6bed72d28e6a417ad7dfe1495cb9b602f922bdca2abf279b2c1858aa47cb18ee97cdc50fb1b4963e29d11bcda243fc391ef4003e504488b3726b5

data/.github/workflows/rspec.yml

@@ -0,0 +1,25 @@
+name: rspec
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Bundler and gem install
+        run: |
+          gem install bundler
+          bundle install --jobs 4
+
+      - name: Run rspec
+        run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  SuggestExtensions: false
+
+Layout/LineLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/AbcSize:
+  Max: 32
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/MethodLength:
+  Max: 16
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.6.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at n.yamakita@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    cloudwatch_logs_insights_url_builder (0.0.4)
+      url
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    json (2.6.3)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.2)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.44.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (2.4.2)
+    url (0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cloudwatch_logs_insights_url_builder!
+  rake
+  rspec
+  rubocop
+  simplecov
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Naomichi Yamakita
+
+MIT License
+
+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,29 @@
+# cloudwatch_logs_url_builder
+
+![rspec](https://github.com/naomichi-y/cloudwatch_logs_url_builder/actions/workflows/rspec.yml/badge.svg)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Generate AWS Console URL for Amazon CloudWatch.
+
+## Installation
+
+```
+gem 'cloudwatch_logs_insights_url_builder'
+```
+
+## Usage
+
+```ruby
+require 'cloudwatch_logs_insights_url_builder'
+
+builder = CloudWatchLogsInsightsUrlBuilder.new
+builder.time_type = 'ABSOLUTE'
+builder.start_time = 24 * 3600
+builder.end_time = 0
+
+query = 'fields @timestamp, @message, @logStream, @log\n| sort @timestamp desc\n| limit 2'
+log_groups = ['/aws/cloudtrail']
+
+# https://us-east-1.console.aws.amazon.com/cloudwatch/home?...
+builder.log_insights_url(query, log_groups)
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require './lib/cloudwatch_logs_url_builder'
+
+# 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"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cloudwatch_logs_ingihts_url_builder.gemspec

@@ -0,0 +1,32 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'cloudwatch_logs_insights_url_builder'
+  spec.version       = '0.0.1'
+  spec.authors       = ['naomichi-y']
+  spec.email         = ['n.yamakita@gmail.com']
+
+  spec.summary       = 'Generate AWS Console URL for Amazon CloudWatch.'
+  spec.description   = 'Specify log groups and filters to generate URLs accessible to the AWS Console.'
+  spec.homepage      = 'https://github.com/naomichi-y/cloudwatch_logs_insights_url_builder'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+
+  spec.add_dependency 'url'
+end

data/lib/cloudwatch_logs_insights_url_builder/criteria.rb

@@ -0,0 +1,39 @@
+class CloudWatchLogsInsightsUrlBuilder
+  class Criteria
+    def initialize
+      @conditions = []
+    end
+
+    def add(key, value)
+      case value
+      when Array
+        result = +encode_key("~#{key}~(")
+
+        value.each do |v|
+          result << "#{encode_key("~'")}#{encode_value(v)}"
+        end
+
+        @conditions << result + encode_key(')')
+
+      when String
+        @conditions << "#{encode_key("~#{key}~'")}#{encode_value(value)}"
+      else
+        @conditions << "#{encode_key("~#{key}~")}#{encode_value(value)}"
+      end
+    end
+
+    def build
+      "#{encode_key('~(')}#{@conditions.join.delete_prefix(encode_key('~'))}#{encode_key(')')}"
+    end
+
+    private
+
+    def encode_key(key)
+      URI.encode_www_form_component(URI.encode_www_form_component(key)).gsub('%', '$')
+    end
+
+    def encode_value(value)
+      URI.encode_www_form_component(value).gsub('%', '*')
+    end
+  end
+end

data/lib/cloudwatch_logs_insights_url_builder.rb

@@ -0,0 +1,38 @@
+require 'url'
+require 'cloudwatch_logs_insights_url_builder/criteria'
+
+class CloudWatchLogsInsightsUrlBuilder
+  attr_accessor :time_type, :timezone, :start_time, :end_time
+
+  STRING_TIME_FORMAT = '%Y-%m-%dT%T.000Z'.freeze
+
+  def initialize(region)
+    @region = region
+    @time_type = 'RELATIVE'
+    @timezone = 'Local'
+    @unit = 'minutes'
+    @start_time = -86_400
+    @end_time = 0
+  end
+
+  def log_insights_url(query, log_groups = [])
+    url = +"https://#{@region}.console.aws.amazon.com/cloudwatch/home?region=#{@region}#logsV2:logs-insights"
+    url << URI.encode_www_form_component('?queryDetail=').gsub('%', '$')
+
+    start_time = @start_time.is_a?(Time) ? @start_time.strftime(STRING_TIME_FORMAT) : @start_time
+    end_time = @end_time.is_a?(Time) ? @end_time.strftime(STRING_TIME_FORMAT) : @end_time
+
+    builder = CloudWatchLogsInsightsUrlBuilder::Criteria.new
+    builder.add('end', end_time)
+    builder.add('start', start_time)
+    builder.add('timeType', @time_type)
+    builder.add('unit', 'seconds') if @time_type == 'RELATIVE'
+    builder.add('tz', @timezone)
+    builder.add('editorString', query)
+    builder.add('isLiveTail', false)
+    builder.add('source', log_groups) if log_groups.size.positive?
+
+    url << builder.build
+    url
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: cloudwatch_logs_insights_url_builder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- naomichi-y
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: url
+  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'
+description: Specify log groups and filters to generate URLs accessible to the AWS
+  Console.
+email:
+- n.yamakita@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/rspec.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cloudwatch_logs_ingihts_url_builder.gemspec
+- lib/cloudwatch_logs_insights_url_builder.rb
+- lib/cloudwatch_logs_insights_url_builder/criteria.rb
+homepage: https://github.com/naomichi-y/cloudwatch_logs_insights_url_builder
+licenses: []
+metadata:
+  homepage_uri: https://github.com/naomichi-y/cloudwatch_logs_insights_url_builder
+  source_code_uri: https://github.com/naomichi-y/cloudwatch_logs_insights_url_builder
+  changelog_uri: https://github.com/naomichi-y/cloudwatch_logs_insights_url_builder
+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.0.1
+signing_key: 
+specification_version: 4
+summary: Generate AWS Console URL for Amazon CloudWatch.
+test_files: []