train-pgsql 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3a5a7f95a8bbb5fa60e7582b24b6bd7ba271dd659ff66e524c13aa6f4790b86d
+  data.tar.gz: b9350bb9dcad6c1ed426b0a58ff663d4f676e3058494a047f3ba754c0d439368
+SHA512:
+  metadata.gz: 707700dcf6d3067f7082d2973a5c1f14235a78a4b026f3c042af70c1c9e63c20822b52fe0553731a05cb618f53e58833159e5f090d0a38068b17aaac5344552d
+  data.tar.gz: 2e7a11fa24fff87cb75d7effa39646276b6ab7e589d97de2dd176b33af3d9d04c2c6ba9541c10f0fc6178bc222221ea8f6a01f8a76b6a6edf67b84d8ebaccea6

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "pry"
+  gem "bundler"
+  gem "rake"
+  gem "chefstyle"
+end

data/README.md

@@ -0,0 +1,38 @@
+# train-pgsql - Train Plugin for connecting via pgsql
+
+This plugin allows applications that rely on Train to communicate via postgres SQL.
+
+
+## Installation
+
+You will have to build this gem yourself to install it as it is not yet on
+Rubygems.Org. For this there is a rake task which makes this a one-liner:
+
+```bash
+rake install:local
+```
+
+## Transport parameters
+
+| Option     | Explanation         | Default    |
+| ---------- | ------------------- | ---------- |
+| `host`     | Hostname            | (required) |
+| `user`     | Username to connect | (required) |
+| `password` | Password to connect | (required) |
+| `database` | Database to connect | `postgres` |
+| `port`     | Remote port         | `5432`     |
+
+## Example use
+
+This will work for a Cisco IOS XE device with Telnet enabled:
+```ruby
+require "train"
+train  = Train.create("pgsql", {
+            host:     "localhost",
+            user:     "username",
+            password: "password",
+         })
+conn   = train.connection
+result = conn.run_command("show version\n")
+conn.close
+```

data/lib/train-pgsql.rb

@@ -0,0 +1,6 @@
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require "train-pgsql/version"
+require "train-pgsql/transport"
+require "train-pgsql/connection"

data/lib/train-pgsql/connection.rb

@@ -0,0 +1,67 @@
+require 'train'
+require 'pg'
+
+module TrainPlugins
+  module Pgsql
+    class Connection < Train::Plugins::Transport::BaseConnection
+      def initialize(options)
+        super(options)
+      end
+
+      def platform
+        Train::Platforms.name('pgsql').in_family('sql')
+        force_platform!('pgsql',
+                        release: TrainPlugins::Pgsql::VERSION)
+      end
+
+      def close
+        return if @connection.nil?
+
+        logger.info format('[Pgsql] Closed connection to %s:%d', @options[:host], @options[:port])
+        @connection.finish
+      ensure
+        @connection = nil
+      end
+
+      def uri
+        "pgsql://#{options[:user]}@#{@options[:host]}:#{@options[:port]}/"
+      end
+
+      def run_command_via_connection(query)
+        stdout = ''
+        stderr = ''
+        exit_status = 0
+
+        logger.debug format('[Pgsql] Sending command (%s) to %s:%d', query, @options[:host], @options[:port])
+        connection.exec(query) do |result|
+          result.each_row do |values|
+            stdout += values.join(', ') + "\n"
+          end
+          stdout = stdout.strip
+        end
+
+        CommandResult.new(stdout, stderr, exit_status)
+      rescue PG::Error => e
+        raise Train::TransportError, "Pgsql exec failed (#{e.message})"
+      end
+
+      def connection
+        @connection ||= connect
+      end
+
+      def connect
+        logger.info format('[Pgsql] Opening connection to %s:%d', @options[:host], @options[:port])
+
+        @connection = PG::Connection.new(
+          host: @options[:host],
+          port: @options[:port],
+          user: @options[:user],
+          password: @options[:password],
+          dbname: @options[:database]
+        )
+
+        @connection
+      end
+    end
+  end
+end

data/lib/train-pgsql/transport.rb

@@ -0,0 +1,22 @@
+require "train-pgsql/connection"
+
+module TrainPlugins
+  module Pgsql
+    class Transport < Train.plugin(1)
+      name "pgsql"
+
+      option :host,     required: true
+      option :user,     required: true
+      option :password, required: true
+      option :database, default: "postgres"      
+      option :port,     default: 5432
+
+      # Non documented options for development
+      option :debug_pgsql,   default: false
+
+      def connection(_instance_opts = nil)
+        @connection ||= TrainPlugins::Pgsql::Connection.new(@options)
+      end
+    end
+  end
+end

data/lib/train-pgsql/version.rb

@@ -0,0 +1,5 @@
+module TrainPlugins
+  module Pgsql
+    VERSION = '1.0.0'.freeze
+  end
+end

data/train-pgsql.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'train-pgsql/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'train-pgsql'
+  spec.version       = TrainPlugins::Pgsql::VERSION
+  spec.authors       = ['Cris Barbero']
+  spec.email         = ['cris.barbero@stridehealth.com']
+  spec.summary       = 'Train Transport for PostgreSQL connections'
+  spec.description   = 'Allows applications using Train connect via pg sql'
+  spec.homepage      = 'https://github.com/coveredinc/train-pgsql'
+  spec.license       = 'Apache-2.0'
+
+  spec.files = %w[
+    README.md train-pgsql.gemspec Gemfile
+  ] + Dir.glob(
+    'lib/**/*', File::FNM_DOTMATCH
+  ).reject { |f| File.directory?(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'train', '~> 3.0'
+  spec.add_dependency 'pg', '~> 1.0'
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: train-pgsql
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cris Barbero
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: train
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Allows applications using Train connect via pg sql
+email:
+- cris.barbero@stridehealth.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- lib/train-pgsql.rb
+- lib/train-pgsql/connection.rb
+- lib/train-pgsql/transport.rb
+- lib/train-pgsql/version.rb
+- train-pgsql.gemspec
+homepage: https://github.com/coveredinc/train-pgsql
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: Train Transport for PostgreSQL connections
+test_files: []