zgcp_toolkit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fdd5f30aab3e292d7eefa9c362a0e79129cfc39d48c85b74822377d80a30cd91
+  data.tar.gz: 8f0e40f5d92bad0d83c8e856b2d81d1dc347987fb28e1e963cdeb8e29d855b3d
+SHA512:
+  metadata.gz: 462b117371427824f07fc8caf86b9d2af58e3304ebf38081e687e8c39264981a674600da0c6c69de9150d33a8975d7956af05ceab1a8ecd05d2f648d270a5590
+  data.tar.gz: be469a18442677b5ffddc406e029941c6cda7d9daa596d227f4785960d0f3e1801a7c49f28b5500ddd0d8caa80d8b56f4c0d06b7682ae89f833bf844b93d0e66

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

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 hungnt@zigexn.vn. 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 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in zgcp_toolkit.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Ngo Trung Hung
+
+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,96 @@
+# GCP Toolkit
+Manage integration between Rails & Google Cloud services.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zgcp_toolkit'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install zgcp_toolkit
+
+Next, you need to run the generator:
+
+    $ rails generate zgcp_toolkit
+
+## Logger
+Each rake task will have its own log file in Cloud Logging. The log file name on Cloud Logging are combined from the rake task `namespace`s and `task name`. The rake task also be able to access the logger object.
+
+Unexpected errors in rake tasks are caught automatically & write to a log file in Cloud Logging. And, by default, when GCP Toolkit caught an unexpected error, it push a key & value (key: `push_slack` with value: `true`) in Cloud Logging Log `jsonPayload` so that the log that should be sent on Slack can be filtered.
+
+### Usage
+
+```ruby
+namespace :tcv_transactions do
+  task :daily_import do |t, logger:|
+    logger.info("Heyyyyyy!")
+    # The error message & backtrace are sent to Cloud Logging
+    raise "Heyyyyyy Oops!"
+  end
+end
+```
+
+```ruby
+logger = ZgcpToolkit::Logger.new(:any_log_name)
+logger.info("Heyyyyyy!")
+logger.error(message: "Heyyyyy!", backtrace: ["line-1", "line-2"])
+logger.error(message: "Hello Bug !!", backtrace: ["line-1", "line-2"], push_slack: true)
+logger.warn("Hey hey nyc!")
+```
+
+- Set `send_unexpected_error_to_slack` to `false` will delete `push_slack` key from unexpected error log.
+
+```ruby
+namespace :test_log do 
+  task do: :environment do |args, logger:|
+    logger.send_unexpected_error_to_slack = false
+    raise 'errors'
+  end
+end
+```
+
+### Controller
+
+you can send controller errors to Google Cloud Loggings
+
+```ruby
+# app/controllers/application_controller.rb
+
+rescue_from StandardError do |e|
+  raise e if Rails.env.development?
+
+  logger = ZgcpToolkit::Logger.new(Rails.env)
+  logger.error_request(e, request)
+
+  # If you want send notity to slack 
+  # logger.error_request(e, request, push_slack: true)
+
+  head :internal_server_error
+end
+
+```
+
+### Note on using Pub/Sub and Cloud Function to deliver log to your Slack channel
+
+- Function invocations are charged at a flat rate regardless of the source of the invocation. This includes HTTP function invocations from HTTP requests, events forwarded to background or CloudEvent functions, and invocations resulting from the call API.
+
+- When GCP filter log to sink to Cloud Pub/Sub topic it will use CloudEvent event function so that will also count as an invocation.
+
+- When logging from the rails app, you should log error levels or higher to reduce costs.
+
+- For sending a Slack notification when a training task gets completed, a possible solution might be setting up a Pub/Sub sink for matching logs from Cloud Logging to be sent to. Details here in Exporting logs with the Google Cloud Console. If a log matches the sink’s query (look for all training status updates from AI Platform), then Cloud Logging will send the log directly to the indicated Pub/Sub topic and extra VM is not needed for this.
+
+- After sending the messages to a Pub/Sub topic, you can set up a Cloud Function to post messages to Slack (and/or to email you) when the logs indicate that the AI Platform training job is done. Please note that the Cloud Function will only run when a relevant log is posted to Pub/Sub.Details on Google Cloud Pub/Sub Triggers and Configuring Slack notifications.
+
+### References
+- https://cloud.google.com/functions/docs/calling/pubsub
+- https://cloud.google.com/logging/docs/export/configure_export_v2
+- https://cloud.google.com/cloud-build/docs/configure-third-party-notifications#slack_notifications

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 "zgcp_toolkit"
+
+# 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/lib/zgcp_toolkit.rb

@@ -0,0 +1,8 @@
+require "zgcp_toolkit/version"
+
+module ZgcpToolkit; end
+
+require 'zgcp_toolkit/logger'
+require 'zgcp_toolkit/rake/task'
+require 'zgcp_toolkit/generators/templates/zgcp_toolkit'
+require 'zgcp_toolkit/generators/zgcp_toolkit_generator'

data/lib/zgcp_toolkit/generators/templates/zgcp_toolkit.rb

@@ -0,0 +1,11 @@
+require 'dry/configurable'
+require 'google/cloud/logging'
+require 'rake/task'
+
+Rake::Task.prepend(ZgcpToolkit::Rake::Task)
+
+loggers = [:std_out]
+
+loggers.push(:google_cloud_logging) unless Rails.env.development?
+
+ZgcpToolkit::Logger.config.registered_loggers = loggers

data/lib/zgcp_toolkit/generators/zgcp_toolkit_generator.rb

@@ -0,0 +1,9 @@
+require 'rails/generators'
+
+class ZgcpToolkitGenerator < Rails::Generators::Base
+  source_root File.expand_path("../templates", __FILE__)
+
+  def copy_initializer
+    template "zgcp_toolkit.rb", "config/initializers/zgcp_toolkit.rb"
+  end
+end

data/lib/zgcp_toolkit/logger.rb

@@ -0,0 +1,104 @@
+require 'dry/configurable'
+require 'zgcp_toolkit/logger/stdout'
+require 'zgcp_toolkit/logger/google_cloud_logging'
+
+module ZgcpToolkit
+  class Logger
+    extend Dry::Configurable
+
+    AVAILABLE_LOGGERS = {
+      std_out: ZgcpToolkit::Logger::Stdout,
+      google_cloud_logging: ZgcpToolkit::Logger::GoogleCloudLogging
+    }
+
+    setting :registered_loggers, [:std_out, :google_cloud_logging], reader: true do |logger_names|
+      logger_names.map { |n| AVAILABLE_LOGGERS[n] }
+    end
+
+    class Error < StandardError; end
+    class UnsupportedLogType < Error; end
+
+    DEFAULT_BACKTRACE_LIMIT = 10
+
+    attr_accessor :send_unexpected_error_to_slack, :backtrace_limit
+    attr_reader :loggers, :log_name
+
+    def initialize(log_name)
+      @log_name = log_name
+      @send_unexpected_error_to_slack = true
+      @backtrace_limit = DEFAULT_BACKTRACE_LIMIT
+      @loggers = ZgcpToolkit::Logger.registered_loggers.map { |logger| logger.new(log_name) }
+    end
+
+    [:debug, :info, :warn, :error, :fatal, :unknown].each do |log_level_method|
+      define_method(log_level_method) do |log, push_slack: false|
+        log_object =
+          case log
+          when StandardError
+            obj = { message: log.message, backtrace: log.backtrace.first(backtrace_limit) }
+            obj.merge!(push_slack: true) if push_slack
+            obj
+          when Hash
+            log
+          when String
+            obj = { message: log }
+            obj.merge!(push_slack: true) if push_slack
+            obj
+          else
+            raise UnsupportedLogType, "#{log.class.name} is not supported!"
+          end
+        loggers.each { |a| a.send(log_level_method, log_object) }
+      end
+    end
+
+    def error_request(error, request, **args)
+      filter_request_params = format_request_env(request)
+
+      error({ message: error.message, backtrace: error.backtrace.first(backtrace_limit) }.merge!(filter_request_params).merge!(args))
+    end
+
+    def flush!
+      loggers.each { |a| a.flush! }
+    end
+
+    private
+
+    def format_request_env(request)
+      log_object = {}
+      log_object[:request]     = request_filter(request)
+      log_object[:session]     = session_filter(request)
+      log_object[:environment] = environment_filter(request)
+      log_object
+    end
+
+    def environment_filter(request)
+      result = {}
+      request.filtered_env.keys.each do |key|
+        result[key] = request.filtered_env[key]
+      end
+      result
+    end
+
+    def session_filter(request)
+      result = {}
+      result[:session_id]   = request.ssl? ? "[FILTERED]" : request.session['session_id'] || request.env['rack.session.options'][:id].inspect
+      result[:data_session] = request.session.to_hash
+      result
+    end
+
+    def request_filter(request)
+      result = {}
+      result[:url]            = request.url
+      result[:request_method] = request.request_method
+      result[:ip_address]     = request.remote_ip
+      result[:parameters]     = request.filtered_parameters.inspect
+      result[:timestamp]      = Time.current
+      result[:server]         = Socket.gethostname
+      result[:process]        = $$
+      if defined?(Rails) && Rails.respond_to?(:root)
+        result[:rails_root] = Rails.root
+      end
+      result
+    end
+  end
+end

data/lib/zgcp_toolkit/logger/google_cloud_logging.rb

@@ -0,0 +1,20 @@
+module ZgcpToolkit
+  class Logger
+    class GoogleCloudLogging
+      attr_reader :logger, :log_name
+
+      delegate :debug, :info, :warn, :error, :fatal, :unknown, to: :logger
+
+      def initialize(log_name)
+        @log_name = log_name.to_s
+        logging  = Google::Cloud::Logging.new
+        resource = Google::Cloud::Logging::Middleware.build_monitored_resource
+        @logger  = logging.logger @log_name, resource
+      end
+
+      def flush!
+        logger.writer.async_stop!
+      end
+    end
+  end
+end

data/lib/zgcp_toolkit/logger/stdout.rb

@@ -0,0 +1,24 @@
+require 'logger'
+
+module ZgcpToolkit
+  class Logger 
+    class Stdout
+      attr_reader :logger, :log_name
+
+      def initialize(log_name)
+        @log_name = log_name.to_s
+        @logger  = ::Logger.new(STDOUT)
+      end
+
+      [:debug, :info, :warn, :error, :fatal, :unknown].each do |log_level_method|
+        define_method(log_level_method) do |log|
+          logger.send(log_level_method, "#{log_name} -- #{log}")
+        end
+      end
+
+      def flush!
+        # no-op
+      end
+    end
+  end
+end

data/lib/zgcp_toolkit/rake/task.rb

@@ -0,0 +1,13 @@
+module ZgcpToolkit::Rake
+  module Task
+    def execute(args=nil)
+      task_name = self.name.gsub(':', '_')
+      logger = ZgcpToolkit::Logger.new(task_name)
+      args.with_defaults(logger: logger)
+      super
+    rescue StandardError => e
+      logger.error(e, push_slack: logger.send_unexpected_error_to_slack)
+      logger.flush!
+    end
+  end
+end

data/lib/zgcp_toolkit/version.rb

@@ -0,0 +1,3 @@
+module ZgcpToolkit
+  VERSION = '0.1.0'
+end

data/zgcp_toolkit.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/zgcp_toolkit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zgcp_toolkit"
+  spec.version       = ZgcpToolkit::VERSION
+  spec.authors       = "ZIGExN VeNtura developers"
+  spec.email         = "kuruma-dev@zigexn.vn"
+
+  spec.summary       = "GCP Toolkit"
+  spec.description   = "Manage essential toolset"
+  spec.homepage      = "https://github.com/ZIGExN/zgcp_toolkit"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) 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_dependency 'stackdriver', '~> 0.20.1'
+  spec.add_dependency 'dry-configurable', '~> 0.11.6'
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: zgcp_toolkit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ZIGExN VeNtura developers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: stackdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.1
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.6
+description: Manage essential toolset
+email: kuruma-dev@zigexn.vn
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zgcp_toolkit.rb
+- lib/zgcp_toolkit/generators/templates/zgcp_toolkit.rb
+- lib/zgcp_toolkit/generators/zgcp_toolkit_generator.rb
+- lib/zgcp_toolkit/logger.rb
+- lib/zgcp_toolkit/logger/google_cloud_logging.rb
+- lib/zgcp_toolkit/logger/stdout.rb
+- lib/zgcp_toolkit/rake/task.rb
+- lib/zgcp_toolkit/version.rb
+- zgcp_toolkit.gemspec
+homepage: https://github.com/ZIGExN/zgcp_toolkit
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/ZIGExN/zgcp_toolkit
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: GCP Toolkit
+test_files: []