ar-octopus-replication-tracking 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2e302c007223d36c21c7d0c553ae2f59eed99322
+  data.tar.gz: dd1cfed6cca7de5eaadfbeed2345bf3702deb1c2
+SHA512:
+  metadata.gz: 1bb86883c6bdb9f8b85fe5926e2a0f25743ff55766dd92a09569ef9a99955f46022c43846de23889d8c87995915cf26aadbe5ee46346f1ce435227d82bcd60f0
+  data.tar.gz: 943c551c98cecd209f2ed11da828acb9d7e896557b0fef525a14294fc7ed65fdebd3b84469420ce814870fa8b1c2b4003a06a042ae079cc28f43b27ee097fcc5

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+*.sqlite3
+.bundle
+.rvmrc
+Gemfile.lock
+gemfiles/*.lock
+pkg/*
+*.rbc
+tmp/*
+.*.sw[a-z]
+database.log

data/.rubocop.yml

@@ -0,0 +1,4 @@
+# This is the configuration used to check the rubocop source code.
+
+LineLength:
+  Max: 200

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ar-octopus.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Jong Ha
+
+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,51 @@
+# Octopus Replication Tracking
+This Gem is extension of ar-octopus to help to find replication file and position number for each shard.
+
+## Notes
+* Currently only working for mysql2 adapter
+* DB user requires to have access `show master status;` and `show slave status;`
+
+## Install
+Add this line to Gemfile:
+
+    gem 'ar-octopus-replication-tracking', git: 'git://github.com/jongmyung/octopus-replication-tracking.git'
+
+## How to Use
+Setup `shards.yml` and ready to use.
+
+```yaml
+octopus:
+  environments:
+    - development
+  development:
+    earth:
+      captain_america:
+        adapter: mysql2
+        database: captain_america_db
+      hulk:
+        adapter: mysql2
+        database: hulk_db
+      ironman:
+        adapter: mysql2
+        database: ironman_db
+    galaxy:
+      i_am_groot:
+        adapter: mysql2
+        database: i_am_grout_db
+```
+
+### Syntax
+Replication status from asia shard
+
+    > Octopus.replication_position(:captain_america)
+    => {:file_name=>"mysql-bin.000001", :position=>36668586}
+
+Replication status from europe shard
+
+    Octopus.replication_position(:ironman)
+    => {:file_name=>"mysql-bin.000001", :position=>36668583}
+    
+Replication status from slave group
+
+    Octopus.replication_position(slave_group: :galaxy)
+    => {:file_name=>"mysql-bin.000001", :position=>36668586}

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/ar-octopus-replication-tracking.gemspec

@@ -0,0 +1,27 @@
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+
+require 'octopus/replication_tracking/version'
+
+Gem::Specification.new do |s|
+  s.name = 'ar-octopus-replication-tracking'
+  s.version = Octopus::ReplicationTracking::VERSION
+  s.authors = ['Jongmyung Ha']
+  s.email = ['jongmyung@stayntouch.com']
+  s.homepage = 'https://github.com/jongmyung/octopus-replication-tracking'
+  s.summary = 'Check master/slave replication position with Octopus'
+  s.description = 'This gem allows you to find replication position with Octopus'
+
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ['lib']
+
+  s.required_ruby_version = '>= 2.1.0'
+
+  s.add_dependency 'ar-octopus', '~> 0.8.6'
+
+  s.add_development_dependency 'pry-byebug', '~> 0'
+  s.add_development_dependency 'rake', '~> 0'
+  s.add_development_dependency 'rspec', '~> 3'
+  s.add_development_dependency 'rubocop', '~> 0'
+
+  s.license = 'MIT'
+end

data/lib/ar-octopus-replication-tracking.rb

@@ -0,0 +1,2 @@
+require 'octopus'
+require 'octopus/replication_tracking'

data/lib/octopus/replication_tracking.rb

@@ -0,0 +1,7 @@
+module Octopus
+  # ReplicationTracking is Extension for Octopus Gem
+  module ReplicationTracking
+    require 'octopus/replication_tracking/base_methods'
+    require 'octopus/replication_tracking/proxy_methods'
+  end
+end

data/lib/octopus/replication_tracking/base_methods.rb

@@ -0,0 +1,23 @@
+module Octopus
+  module ReplicationTracking
+    # Extension of Octopus
+    module BaseMethods
+      def self.extended(base)
+        base.extend(ModuleMethods)
+      end
+
+      # Define Module methods
+      module ModuleMethods
+        def replication_position(shard)
+          conn = ActiveRecord::Base.connection
+
+          return unless conn.is_a?(Octopus::Proxy)
+
+          using(shard) { conn.replication_position }
+        end
+      end
+    end
+  end
+end
+
+Octopus.extend(Octopus::ReplicationTracking::BaseMethods)

data/lib/octopus/replication_tracking/proxy_methods.rb

@@ -0,0 +1,41 @@
+module Octopus
+  module ReplicationTracking
+    # Extension of Octopus::Proxy
+    module ProxyMethods
+      def self.extended(base)
+        base.send(:include, InstanceMethods)
+      end
+
+      # Define Instance methods
+      module InstanceMethods
+        def master_shard?
+          current_shard == Octopus.master_shard
+        end
+
+        def replication_position
+          master_shard? ? master_replication_status : slave_replication_status
+        end
+
+        private
+
+        def master_replication_status
+          status_result = execute('SHOW MASTER STATUS;').first
+          {
+            file_name: status_result.try(:[], 0),
+            position: status_result.try(:[], 1)
+          }
+        end
+
+        def slave_replication_status
+          status_result = execute('SHOW SLAVE STATUS;').first
+          {
+            file_name: status_result.try(:[], 5),
+            position: status_result.try(:[], 6)
+          }
+        end
+      end
+    end
+  end
+end
+
+Octopus::Proxy.extend(Octopus::ReplicationTracking::ProxyMethods)

data/lib/octopus/replication_tracking/version.rb

@@ -0,0 +1,5 @@
+module Octopus
+  module ReplicationTracking
+    VERSION = '0.1.3'.freeze
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: ar-octopus-replication-tracking
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Jongmyung Ha
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ar-octopus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.6
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: 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: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !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'
+description: This gem allows you to find replication position with Octopus
+email:
+- jongmyung@stayntouch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- ar-octopus-replication-tracking.gemspec
+- lib/ar-octopus-replication-tracking.rb
+- lib/octopus/replication_tracking.rb
+- lib/octopus/replication_tracking/base_methods.rb
+- lib/octopus/replication_tracking/proxy_methods.rb
+- lib/octopus/replication_tracking/version.rb
+homepage: https://github.com/jongmyung/octopus-replication-tracking
+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.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Check master/slave replication position with Octopus
+test_files: []