mysql2-aurora 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7aba7e92a9390880096853ce979ea85de81a8e2b4e055ff952ac1ee7b070e0f3
+  data.tar.gz: 0bac5961903f4723608a43ba16c46a9d51d9be8181c2dc83c46224f01e77b25c
+SHA512:
+  metadata.gz: 671cd2029f7e47a9e08c2951e60dc98f1f378ce0f222f9475127e037f01d6453540ca5defc0c999fe2e91ee696492c2006a42b968a2c82758d2615b0d8276dac
+  data.tar.gz: 1327aed779d6e4876ff7a32f8d5aa993c3c0213609eac6afe1da7b6b282bc83d832d117d0a52c749625948ef8d80b205ce396989763a9204a22481a296739751

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,27 @@
+# Temporary files.
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+
+# Temporary directories.
+pkg/
+tmp/
+temp/
+vendor/bundle/
+
+# Test result files.
+spec/reports
+test/tmp
+test/version_tmp
+coverage/
+.rspec_status
+
+# Document files.
+rdoc
+_yardoc
+doc
+lib/bundler/man

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,105 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - 'vendor/**/*'
+    - 'bin/{console,setup}'
+
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/ClassCheck:
+  EnforcedStyle: kind_of?
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/EmptyCaseCondition:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/RegexpLiteral:
+  AllowInnerSlashes: true
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/AlignHash:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*'
+
+Layout/ExtraSpacing:
+  AllowForAlignment: true
+
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+Layout/MultilineMethodCallBraceLayout:
+  Enabled: false
+
+Layout/SpaceInsideBlockBraces:
+  EnforcedStyleForEmptyBraces: space
+
+Lint/HandleExceptions:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+  ExcludedMethods:
+    - 'Gem::Specification.new'
+
+Metrics/ClassLength:
+  Max: 100
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/LineLength:
+  Max: 100
+  IgnoredPatterns:
+    - "'.+'"                                                      # Text
+    - '".+"'                                                      # Text
+    - '#.+'                                                       # Comment
+    - '/.+/'                                                      # Regex
+    - '([A-Z][A-Za-z\d]+::){2,}[A-Z]'                             # Long module name
+    - '([A-Z]+_){4,}[A-Z]'                                        # Long constant name
+
+Metrics/MethodLength:
+  Max: 25
+
+Performance/TimesMap:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo:     false
+language: ruby
+script:   ./bin/test
+rvm:
+  - 2.5.0
+  - 2.6.0
+env:
+  - TEST_DB_HOST='127.0.0.1' TEST_DB_USER='root' TEST_DB_PASS=''
+services:
+  - mysql

data/Dockerfile

@@ -0,0 +1,17 @@
+FROM ruby:2.6.0-alpine3.8
+
+# Create application directory.
+RUN mkdir /app
+WORKDIR /app
+
+# Install package
+RUN apk upgrade && apk add --update build-base git linux-headers libxml2-dev libxslt-dev mariadb-dev ruby-dev tzdata yaml-dev zlib-dev
+
+# Deploy application
+ADD . /app
+
+# Install gem
+RUN bundle install
+
+# Run test
+CMD ["/app/bin/test"]

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mysql2-aurora.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2019 alfa-jpn
+
+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,67 @@
+# Mysql2::Aurora
+mysql2 plugin supporting aurora failover.
+
+[![Build Status](https://travis-ci.org/alfa-jpn/mysql2-aurora.svg?branch=master)](https://travis-ci.org/alfa-jpn/mysql2-aurora)
+[![Coverage Status](https://coveralls.io/repos/github/alfa-jpn/mysql2-aurora/badge.svg?branch=master)](https://coveralls.io/github/alfa-jpn/mysql2-aurora?branch=master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/57d8ee7b6f30d413314b/maintainability)](https://codeclimate.com/github/alfa-jpn/mysql2-aurora/maintainability)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mysql2-aurora'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mysql2-aurora
+
+## Usage
+This gem extends Mysql2::Client. You can use `aurora_max_retry` option.
+
+```ruby
+Mysql2::Client.new(
+  host:             'localhost',
+  username:         'root',
+  password:         'change_me',
+  reconnect:        true,
+  aurora_max_retry: 5
+)
+```
+
+with Rails, in `database.yml`
+
+```yml
+development:
+  adapter:          mysql2
+  host:             localhost
+  username:         root
+  password:         change_me
+  reconnect:        true
+  aurora_max_retry: 5
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alfa-jpn/mysql2-aurora.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Testing
+
+```shell
+# Image build
+docker-compose build
+
+# Run tests
+docker-compose run --rm app ./bin/test
+```

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/docker-pry

@@ -0,0 +1,3 @@
+#!/bin/sh
+set -e;
+docker-compose run --rm app bundle exec pry

data/bin/docker-test

@@ -0,0 +1,3 @@
+#!/bin/sh
+set -e;
+docker-compose run --rm app /bin/sh -c "sleep 5 && /app/bin/test";

data/bin/test

@@ -0,0 +1,3 @@
+#!/bin/sh
+set -e;
+bundle exec rspec && bundle exec rubocop && bundle exec yard doc --fail-on-warning

data/docker-compose.yml

@@ -0,0 +1,17 @@
+version: '3'
+services:
+  app:
+    build:
+      context: .
+    environment:
+      TEST_DB_HOST: 'mysql'
+      TEST_DB_USER: 'root'
+      TEST_DB_PASS: 'change_me'
+    volumes:
+      - .:/app
+    depends_on:
+      - mysql
+  mysql:
+    image: mysql:5.7
+    environment:
+      MYSQL_ROOT_PASSWORD: 'change_me'

data/lib/mysql2/aurora.rb

@@ -0,0 +1,83 @@
+require 'mysql2/aurora/version'
+require 'mysql2'
+
+module Mysql2
+  # mysql2 aurora module
+  # @note This module patch Mysql2::Client
+  module Aurora
+    # Implement client patch
+    class Client
+      RETRY_INTERVAL_SECONDS = 1.5
+
+      attr_reader :client
+
+      # Initialize class
+      # @note [Override] with reconnect options
+      # @param [Hash] opts Options
+      # @option opts [Integer] aurora_max_retry Max retry count, when failover. (Default: 5)
+      def initialize(opts)
+        @opts      = Mysql2::Util.key_hash_as_symbols(opts)
+        @max_retry = @opts.delete(:aurora_max_retry) || 5
+        reconnect!
+      end
+
+      # Execute query with reconnect
+      # @note [Override] with reconnect.
+      def query(*args)
+        try_count = 0
+
+        begin
+          client.query(*args)
+        rescue Mysql2::Error => e
+          try_count += 1
+
+          if e.message&.include?('--read-only') && try_count <= @max_retry
+            warn "[mysql2-aurora] Database is readonly. Retry after #{RETRY_INTERVAL_SECONDS}seconds"
+            sleep RETRY_INTERVAL_SECONDS
+            reconnect!
+            retry
+          else
+            raise e
+          end
+        end
+      end
+
+      # Reconnect to database and Set `@client`
+      # @note If client is not connected, Connect to database.
+      def reconnect!
+        begin
+          @client&.close
+        rescue StandardError
+          nil
+        end
+        @client = Mysql2::Aurora::ORIGINAL_CLIENT_CLASS.new(@opts)
+      end
+
+      # Delegate method call to client.
+      # @param [String] name  Method name
+      # @param [Array]  args  Method arguments
+      # @param [Proc]   block Method block
+      def method_missing(name, *args, &block) # rubocop:disable Style/MethodMissingSuper, Style/MissingRespondToMissing
+        @client.public_send(name, *args, &block)
+      end
+
+      # Delegate method call to Mysql2::Client.
+      # @param [String] name  Method name
+      # @param [Array]  args  Method arguments
+      # @param [Proc]   block Method block
+      def self.method_missing(name, *args, &block) # rubocop:disable Style/MethodMissingSuper, Style/MissingRespondToMissing
+        Mysql2::Aurora::ORIGINAL_CLIENT_CLASS.public_send(name, *args, &block)
+      end
+
+      # Delegate const reference to class.
+      # @param [Symbol] name Const name
+      def self.const_missing(name)
+        Mysql2::Aurora::ORIGINAL_CLIENT_CLASS.const_get(name)
+      end
+    end
+
+    # Swap Mysql2::Client
+    ORIGINAL_CLIENT_CLASS = Mysql2.send(:remove_const, :Client)
+    Mysql2.const_set(:Client, Mysql2::Aurora::Client)
+  end
+end

data/lib/mysql2/aurora/version.rb

@@ -0,0 +1,8 @@
+module Mysql2
+  module Aurora
+    # Major Version: Support `mysql2` major version.
+    # Minor Version: Support `mysql2` minor version.
+    # Tiny Version:  Mysql2::Aurora version.
+    VERSION = '0.5.0'.freeze
+  end
+end

data/mysql2-aurora.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mysql2/aurora/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mysql2-aurora'
+  spec.version       = Mysql2::Aurora::VERSION
+  spec.authors       = ['alfa-jpn']
+  spec.email         = ['alfa.jpn@gmail.com']
+  spec.summary       = 'mysql2 plugin supporting aurora failover.'
+  spec.description   = 'mysql2 plugin supporting aurora failover.'
+  spec.homepage      = 'https://github.com/alfa-jpn/mysql2-aurora'
+  spec.license       = 'MIT'
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(/^exe\//) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(/^(test|spec|features)\//) }
+  end
+
+  spec.required_ruby_version = '>= 2.5.0'
+
+  spec.add_dependency 'mysql2', '~> 0.5.2'
+
+  spec.add_development_dependency 'bundler',   '>= 1.16'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'pry',       '~> 0.12'
+  spec.add_development_dependency 'rake',      '~> 10.0'
+  spec.add_development_dependency 'rspec',     '~> 3.0'
+  spec.add_development_dependency 'rubocop',   '~> 0.62'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+  spec.add_development_dependency 'yard',      '~> 0.9'
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: mysql2-aurora
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- alfa-jpn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.62'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.62'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: mysql2 plugin supporting aurora failover.
+email:
+- alfa.jpn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Dockerfile
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/docker-pry
+- bin/docker-test
+- bin/test
+- docker-compose.yml
+- lib/mysql2/aurora.rb
+- lib/mysql2/aurora/version.rb
+- mysql2-aurora.gemspec
+homepage: https://github.com/alfa-jpn/mysql2-aurora
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.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: mysql2 plugin supporting aurora failover.
+test_files: []