diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..3a47e63 --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,45 @@ +name: Test + +on: [push, pull_request] + +permissions: + contents: read + +env: + CONSOLE_OUTPUT: XTerm + +jobs: + test: + name: ${{matrix.ruby}} on ${{matrix.os}} + runs-on: ${{matrix.os}}-latest + continue-on-error: ${{matrix.experimental}} + + strategy: + matrix: + os: + - ubuntu + - macos + + ruby: + - "2.7" + - "3.0" + - "3.2" + - "3.3" + + experimental: [false] + + include: + - os: ubuntu + ruby: head + experimental: true + + steps: + - uses: actions/checkout@v4 + - uses: ruby/setup-ruby@v1 + with: + ruby-version: ${{matrix.ruby}} + bundler-cache: true + + - name: run-tests + timeout-minutes: 3 + run: bundle exec rspec diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..d508b41 --- /dev/null +++ b/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, planetary origin, 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 dsiaw@degica.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/ diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..b2046df --- /dev/null +++ b/Gemfile @@ -0,0 +1,6 @@ +# frozen_string_literal: true + +source 'https://rubygems.org' + +# Specify your gem's dependencies in mysql2-iamauth.gemspec +gemspec diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..c851c08 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2020 David Siaw + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f1f8655 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# Mysql2-iamauth + +Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mysql2-iamauth`. To experiment with that code, run `bin/console` for an interactive prompt. + +TODO: Delete this and the text above, and describe your gem + +## Installation + +Add this line to your application's Gemfile: + +```ruby +gem 'mysql2-iamauth' +``` + +And then execute: + + $ bundle install + +Or install it yourself as: + + $ gem install mysql2-iamauth + +## Usage + +TODO: Write usage instructions here + +## Development + +After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. + +To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). + +## Contributing + +Bug reports and pull requests are welcome on GitHub at https://github.com/degica/mysql2-iamauth. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/degica/mysql2-iamauth/blob/master/CODE_OF_CONDUCT.md). + + +## License + +The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). + +## Code of Conduct + +Everyone interacting in the Mysql2-iamauth project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/degica/mysql2-iamauth/blob/master/CODE_OF_CONDUCT.md). diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000..82bb534 --- /dev/null +++ b/Rakefile @@ -0,0 +1,8 @@ +# frozen_string_literal: true + +require 'bundler/gem_tasks' +require 'rspec/core/rake_task' + +RSpec::Core::RakeTask.new(:spec) + +task default: :spec diff --git a/bin/console b/bin/console new file mode 100755 index 0000000..2951715 --- /dev/null +++ b/bin/console @@ -0,0 +1,15 @@ +#!/usr/bin/env ruby +# frozen_string_literal: true + +require 'bundler/setup' +require 'mysql2-iamauth' + +# 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__) diff --git a/bin/setup b/bin/setup new file mode 100755 index 0000000..dce67d8 --- /dev/null +++ b/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 diff --git a/data/README.md b/data/README.md new file mode 100644 index 0000000..6b5e918 --- /dev/null +++ b/data/README.md @@ -0,0 +1,3 @@ +# Data folder + +This is where static data required for gem operation should reside \ No newline at end of file diff --git a/exe/README.md b/exe/README.md new file mode 100755 index 0000000..3ada9af --- /dev/null +++ b/exe/README.md @@ -0,0 +1,3 @@ +# Executable folder + +There should only be one file here which has the same name as the gem, if this gem is a commandline gem. \ No newline at end of file diff --git a/lib/iamauth.rb b/lib/iamauth.rb new file mode 100644 index 0000000..97d6cbf --- /dev/null +++ b/lib/iamauth.rb @@ -0,0 +1,5 @@ +# frozen_string_literal: true + +require 'mysql2/iamauth/iam_token_provider' +require 'mysql2/iamauth/null_token_provider' +require 'mysql2/iamauth/version' diff --git a/lib/mysql2/iamauth/iam_token_provider.rb b/lib/mysql2/iamauth/iam_token_provider.rb new file mode 100644 index 0000000..6b007e5 --- /dev/null +++ b/lib/mysql2/iamauth/iam_token_provider.rb @@ -0,0 +1,62 @@ +# frozen_string_literal: true +require "aws-sdk-rds" + +module Mysql2 + module Iamauth + class IamTokenProvider + def initialize(opts) + @opts = opts + end + + def opt_host + @opts["host"] || @opts[:host] + end + + def opt_port + @opts["port"] || @opts[:port] + end + + def opt_username + @opts["username"] || @opts[:username] || @opts["user"] || @opts[:user] + end + + def endpoint + @opts.dig(:provider_params, "endpoint") || "#{opt_host}:#{opt_port}" + end + + def user_name + @opts.dig(:provider_params, "user_name") || opt_username + end + + def region + @opts.dig(:provider_params, "region") || "us-east-1" + end + + def cred_options + @opts.dig(:provider_params, "cred_options") || {} + end + + def cred_provider + @opts.dig(:provider_params, "cred_provider") || "Aws::SharedCredentials" + end + + def credentials + Kernel.const_get(cred_provider).new(cred_options) + end + + def token_generator + Aws::RDS::AuthTokenGenerator.new(credentials: credentials) + end + + def password + return "" if ENV["ASSETS_PRECOMPILE"].to_i == 1 + + token_generator.auth_token( + region: region, + endpoint: endpoint, + user_name: user_name + ) + end + end + end +end diff --git a/lib/mysql2/iamauth/null_token_provider.rb b/lib/mysql2/iamauth/null_token_provider.rb new file mode 100644 index 0000000..07e857d --- /dev/null +++ b/lib/mysql2/iamauth/null_token_provider.rb @@ -0,0 +1,15 @@ +# frozen_string_literal: true + +module Mysql2 + module Iamauth + class NullTokenProvider + def initialize(opts) + @opts = opts + end + + def password + @opts["password"] || @opts[:password] || @opts["pass"] || @opts[:pass] + end + end + end +end diff --git a/lib/mysql2/iamauth/version.rb b/lib/mysql2/iamauth/version.rb new file mode 100644 index 0000000..f10c639 --- /dev/null +++ b/lib/mysql2/iamauth/version.rb @@ -0,0 +1,7 @@ +# frozen_string_literal: true + +module Mysql2 + module Iamauth + VERSION = '0.1.0' + end +end diff --git a/mysql2-iamauth.gemspec b/mysql2-iamauth.gemspec new file mode 100644 index 0000000..b390a08 --- /dev/null +++ b/mysql2-iamauth.gemspec @@ -0,0 +1,32 @@ +# frozen_string_literal: true + +require_relative 'lib/mysql2/iamauth/version' + +Gem::Specification.new do |spec| + spec.name = 'mysql2-iamauth' + spec.version = Mysql2::Iamauth::VERSION + spec.authors = ['Degica'] + spec.email = ['dev@degica.com'] + + spec.summary = 'Mysql2-iamauth summary' + spec.description = 'Mysql2-iamauth description' + spec.homepage = 'https://github.com/degica/mysql2-iamauth' + spec.license = 'MIT' + spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0') + + spec.metadata['allowed_push_host'] = 'https://rubygems.org' + + spec.metadata['homepage_uri'] = spec.homepage + spec.metadata['source_code_uri'] = 'https://github.com/degica/mysql2-iamauth' + spec.metadata['changelog_uri'] = 'https://github.com/degica/mysql2-iamauth' + + spec.files = Dir['{exe,data,lib}/**/*'] + %w[Gemfile mysql2-iamauth.gemspec] + spec.bindir = 'exe' + spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) } + spec.require_paths = ['lib'] + + spec.add_dependency 'aws-sdk-rds' + spec.add_development_dependency 'rake' + spec.add_development_dependency 'rspec' + spec.add_development_dependency 'rubocop' +end diff --git a/spec/mysql2-iamauth_spec.rb b/spec/mysql2-iamauth_spec.rb new file mode 100644 index 0000000..47c18fe --- /dev/null +++ b/spec/mysql2-iamauth_spec.rb @@ -0,0 +1,11 @@ +# frozen_string_literal: true + +RSpec.describe Mysql2::Iamauth do + it 'has a version number' do + expect(Mysql2::Iamauth::VERSION).not_to be nil + end + + it 'does something useful' do + expect(false).to eq(true) + end +end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb new file mode 100644 index 0000000..29737c9 --- /dev/null +++ b/spec/spec_helper.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +require 'bundler/setup' +require 'mysql2/iamauth' + +RSpec.configure do |config| + # Enable flags like --only-failures and --next-failure + config.example_status_persistence_file_path = '.rspec_status' + + # Disable RSpec exposing methods globally on `Module` and `main` + config.disable_monkey_patching! + + config.expect_with :rspec do |c| + c.syntax = :expect + end +end