pgpool-pcpwrapper 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea74c8c4046641b7d2b9097a194af0bccdd32b9f
+  data.tar.gz: 7140469102d3a3200a61ff9b822d8e06cedd309d
+SHA512:
+  metadata.gz: 87608b0b0d054b56a67d1e0c2b0e585d7e417ebffaefae068bf9950c8389e8fe11535e3f19c570401b42762cb15a0eb06194a889c4a1b13e4acd8daa504281c1
+  data.tar.gz: 9e6bdb31f19725cdaa76dffb998a87a71c176b87f39fd2020d2d83ca1e49350b67cc1187bc36d674d9d6edf1a390f4399f8e8aeef9a38f7d5ccb535ca24d1d37

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/.ruby-version
+/.rubocop.yml
+/**/.*.swp
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,7 @@
+Metrics/LineLength:
+  Max: 155
+  Enable: false
+
+Metrics/MethodLength:
+  Max: 40
+

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Javier Juarez
+
+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,41 @@
+# PGPool::Wrapper
+
+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/pgpool/pcpwrapper`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+This is a little gem to help with the PGPool PCP administration interface
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pgpool-pcpwrapper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pgpool-pcpwrapper
+
+## Usage
+
+So simple, instantiate a Pgpoll::Wrapper::CommandLauncher and send the appropiate commands through the PCP interface. There are only two commands implemented ad this moment, pcp_node_count and pcp_node_info
+
+## 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/jjuarez/pgpool-pcpwrapper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'pgpool/pcpwrapper'
+require 'pry'
+
+Pry.start

data/bin/setup

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

data/lib/core_extensions/string/percentage.rb

@@ -0,0 +1,6 @@
+# A bit of spicy monkey patching
+class String
+  def percentage?
+    /\A[-+]?\d+\z/ =~ self && to_i >= 0 && to_i <= 100
+  end
+end

data/lib/pgpool/command_launcher.rb

@@ -0,0 +1,63 @@
+require 'mixlib/shellout'
+require 'pgpool/response'
+
+module PGPool
+  #
+  # = class: CommandLauncher, a simple wrapper for PCP PGPool management CLI
+  class CommandLauncher
+    DEFAULT_PREFIX     = '/usr/sbin'
+    PCP_NODE_COUNT_EXE = 'pcp_node_count'
+    PCP_NODE_INFO_EXE  = 'pcp_node_info'
+
+    private
+
+    def launch(command_str)
+      command = ::Mixlib::ShellOut.new(command_str)
+
+      command.run_command
+      command.error!
+      command
+    end
+
+    def extract_number_of_nodes
+      launch(@pcp_node_count_command).stdout.to_i
+    end
+
+    public
+
+    attr_reader :number_of_nodes
+
+    def initialize(hostname, port, user, password, timeout, options = {})
+      options = { prefix: DEFAULT_PREFIX }.merge(options)
+
+      @hostname = hostname
+      @port     = port
+      @user     = user
+      @password = password
+      @timeout  = timeout
+
+      @pcp_command_options    = "#{@timeout} #{@hostname} #{@port} #{@user} #{@password}"
+      @pcp_node_count_command = "#{File.join(options[:prefix], PCP_NODE_COUNT_EXE)} #{@pcp_command_options}"
+      @pcp_node_info_command  = "#{File.join(options[:prefix], PCP_NODE_INFO_EXE)} #{@pcp_command_options}"
+
+      self
+    end
+
+    def number_of_nodes
+      @number_of_nodes ||= extract_number_of_nodes
+    end
+
+    def valid_node_id?(node_id)
+      node_id >= 0 && node_id < number_of_nodes
+    end
+
+    def node_information(node_id)
+      fail("Invalid node id(#{node_id}) must be between 0 and #{number_of_nodes - 1}") unless valid_node_id?(node_id)
+      Response.new(node_id, launch("#{@pcp_node_info_command} #{node_id}"))
+    end
+
+    def nodes_information
+      number_of_nodes.times.map { |node_id| node_information(node_id) }
+    end
+  end
+end

data/lib/pgpool/node_info.rb

@@ -0,0 +1,63 @@
+module PGPool
+  #
+  # = class: NodeInfo, PORO
+  class NodeInfo
+    INITIALIZING      = 0 # This state is only used during the initialization.
+    UP_NO_CONNECTIONS = 1 # Node is up. No connections yet.
+    UP                = 2 # Node is up. Connections are pooled.
+    DOWN              = 3 # Node is down.
+
+    private
+
+    def status=(status)
+      fail("Invalid status: #{status}") unless [INITIALIZING, UP_NO_CONNECTIONS, UP, DOWN].include?(status)
+
+      @status = status
+    end
+
+    public
+
+    def self.build_from_raw_data(id, command_raw_data)
+      hostname, port, status, weight = command_raw_data.split(' ')
+
+      NodeInfo.new(id, hostname, port, status, weight)
+    end
+
+    attr_reader :id, :hostname, :port, :weight, :status
+
+    def initialize(id, hostname, port, status, weight)
+      @id         = id.to_i
+      @hostname   = hostname
+      @port       = port.to_i
+      @weight     = weight.to_f
+
+      self.status = status.to_i
+
+      self
+    end
+
+    def initializing?
+      status == INITIALIZING
+    end
+
+    def up?
+      (status == UP || status == UP_NO_CONNECTIONS)
+    end
+
+    def down?
+      status == DOWN
+    end
+
+    def to_hash
+      { id: id, hostname: hostname, port: port, status: status, weight: weight }
+    end
+
+    def inspect
+      to_hash.inspect
+    end
+
+    def to_s
+      inspect
+    end
+  end
+end

data/lib/pgpool/pcpwrapper.rb

@@ -0,0 +1,42 @@
+require 'forwardable'
+require 'core_extensions/string/percentage'
+require 'pgpool/command_launcher'
+require 'pgpool/response'
+require 'pgpool/node_info'
+require 'pgpool/version'
+
+#
+# = module: PGPool module as namespace
+module PGPool
+  #
+  # = class: PCPWrapper, the main gem module
+  class PCPWrapper
+    extend Forwardable
+
+    DEFAULT_TIMEOUT  = 10
+    DEFAULT_HOSTNAME = 'localhost'
+    DEFAULT_PORT     = 9898
+    DEFAULT_USER     = 'postgres'
+    DEFAULT_PASSWORD = 'postgres'
+
+    def_delegators :@command_launcher, :valid_node_id?, :node_information, :nodes_information
+
+    def initialize(parameters = {})
+      parameters = {
+        hostname: DEFAULT_HOSTNAME,
+        port:     DEFAULT_PORT,
+        user:     DEFAULT_USER,
+        password: DEFAULT_PASSWORD,
+        timeout:  DEFAULT_TIMEOUT
+      }.merge(parameters)
+
+      @command_launcher = CommandLauncher.new(
+        parameters[:hostname],
+        parameters[:port],
+        parameters[:user],
+        parameters[:password],
+        parameters[:timeout])
+      self
+    end
+  end
+end

data/lib/pgpool/response.rb

@@ -0,0 +1,72 @@
+require 'pgpool/node_info'
+
+module PGPool
+  #
+  # = class: Response
+  class Response
+    OK      = 0
+    UNKNOWN = 1  # Unknown Error (should not occur)
+    EOF     = 2  # EOF Error
+    NOMEM   = 3  # Memory shortage
+    READ    = 4  # Error while reading from the server
+    WRITE   = 5  # Error while writing to the server
+    TIMEOUT = 6  # Timeout
+    INVAL   = 7  # Argument(s) to the PCP command was invalid
+    CONN    = 8  # Server connection error
+    NOCONN  = 9  # No connection exists
+    SOCK    = 10 # Socket error
+    HOST    = 11 # Hostname resolution error
+    BACKEND = 12 # PCP process error on the server
+    AUTH    = 13 # Authorization failure
+
+    ERROR_MESSAGES = {
+      OK:      'No error',
+      UNKNOWN: 'Unknown Error',
+      EOF:     'EOF Error',
+      NOMEM:   'Memory shortage',
+      READ:    'Error while reading from the server',
+      WRITE:   'Error while writing to the server',
+      TIMEOUT: 'Timeout',
+      INVAL:   'Argument(s) to the PCP command was invalid',
+      CONN:    'Server connection error',
+      NOCONN:  'No connection exists',
+      SOCK:    'Socket error',
+      HOST:    'Hostname resolution error',
+      BACKEND: 'PCP process error on the server',
+      AUTH:    'Authorization failure'
+    }
+
+    attr_reader :status, :node_info
+
+    def initialize(node_id, command)
+      @status    = command.exitstatus
+      @node_info = success? ? NodeInfo.build_from_raw_data(node_id, command.stdout) : command.stderr
+
+      self
+    end
+
+    def success?
+      status == OK
+    end
+
+    def error?
+      status != OK
+    end
+
+    def error_message
+      ERROR_MESSAGES[@status]
+    end
+
+    def to_hash
+      { status: @status, node_info: @node_info }
+    end
+
+    def inspect
+      to_hash.inspect
+    end
+
+    def to_s
+      "#{inspect}"
+    end
+  end
+end

data/lib/pgpool/version.rb

@@ -0,0 +1,5 @@
+#
+# = module: PGPool namespace
+module PGPool
+  VERSION = '0.1.3'
+end

data/pgpool-pcpwrapper.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pgpool/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pgpool-pcpwrapper'
+  spec.version       = PGPool::VERSION
+  spec.authors       = ['Javier Juarez']
+  spec.email         = ['jjuarez@tuenti.com']
+
+  spec.summary       = 'A PGPool PCP interface wrapper.'
+  spec.description   = 'A PGPool PCP interface wrapper.'
+  spec.homepage      = 'https://github.com/jjuarez/pgpool-pcpwrapper'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    fail 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version     = '>= 1.9'
+  spec.required_rubygems_version = '>= 1.8'
+
+  spec.add_dependency 'mixlib-shellout', '~> 2.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'rubocop', '~> 0.34'
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: pgpool-pcpwrapper
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Javier Juarez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mixlib-shellout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.34'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.34'
+description: A PGPool PCP interface wrapper.
+email:
+- jjuarez@tuenti.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/core_extensions/string/percentage.rb
+- lib/pgpool/command_launcher.rb
+- lib/pgpool/node_info.rb
+- lib/pgpool/pcpwrapper.rb
+- lib/pgpool/response.rb
+- lib/pgpool/version.rb
+- pgpool-pcpwrapper.gemspec
+homepage: https://github.com/jjuarez/pgpool-pcpwrapper
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.8'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A PGPool PCP interface wrapper.
+test_files: []