pg-url 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 88f00bb7a3c5071d8f2fa6ec4c41aea5666e37733b1c36c35743c287445390c3
+  data.tar.gz: bf4c9624e39b358aacf49bdd539e8af89b6d1fc91557552bfc404f2b268dfece
+SHA512:
+  metadata.gz: 053a0fc9e6ff4b6fded5f1d437132c22cbdae405b595498fcc71640fdff697323d90de1e883e09b47e6a67db977e601814a1a7808b10ecf6cddd14f113889326
+  data.tar.gz: d7fe87d1d1ff91de5bc27d7e8952d9c098b8452feea7043fa8fd28f04b645acd3f23591cad56806a1852da31516a6c26fc1a064f0c04452689d887f7f120ca61

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

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 pg-url.gemspec
+gemspec

data/README.md

@@ -0,0 +1,67 @@
+# PG::URL
+
+Postgres connection string builder gem with construction through a prompt or Ruby method.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pg-url'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pg-url
+
+## Usage
+
+### Method
+
+- `PG::URL.new` (alias `PG::URL[]`)
+
+Constructs and returns a connection string built from the parameters given.
+
+#### Parameters
+
+The parameters indicated with a check mark are **required**.
+
+- [ ] `host` - The host address that the database is hosted on. If no host is specified, then `localhost` is used as the host.
+- [ ] `port` - The port of the host address. If no port is specified (and no host is specified), then the default Postgres port `5432` will be used on `localhost`.
+- [x] `database` - The name of the Postgres database.
+- [x] `username` - The username of a user on the Postgres table
+- [ ] `password` - The password for the user specified by the `username` parameter. If the user does not have a password, this parameter can be left empty.
+
+#### Examples
+
+```ruby
+require 'pg/url'
+
+PG::URL.new(host: '192.168.2.1', database: 'db', username: 'root', password: 'test')
+#=> "postgres://root:test@192.168.2.1/db"
+
+PG::URL[host: 'pg-host.com', port: 3755, database: 'db', username: 'root']
+#=> "postgres://root@pg-host.com:3755/db"
+
+conn = {port: '4321', database: 'users', username: 'K&fB2y'}
+PG::URL[conn]
+#=> "postgres://K&fB2y@localhost:4321/users"
+```
+
+### Prompt
+
+- `PG::URL.prompt` (aliases `PG::URL.>>`, `PG::URL.request`)
+
+Constructs and returns a connection string built from details specified by the user in a prompt.
+
+## Development
+
+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/eonu/pg-url.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pg/url"
+
+# 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__)

data/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

data/lib/pg/url.rb

@@ -0,0 +1,26 @@
+require_relative 'url/prompt'
+require_relative 'url/generator'
+require_relative 'url/error'
+require_relative 'url/type'
+require_relative 'url/version'
+
+module PG
+  class URL
+    PARAMS = %i[host port database username password]
+    ALLOW_EMPTY = %i[host port password]
+
+    class << self
+      def new(**params)
+        if ((PARAMS-ALLOW_EMPTY)-params.keys).empty?
+          required = {}
+          (PARAMS-(PARAMS-params.keys)).each{|k|required[k] = params[k]}
+          Type.check(required)
+          Generator.new(params).to_s
+        else
+          raise Error::MissingParams.new((PARAMS-ALLOW_EMPTY)-params.keys)
+        end
+      end
+      alias_method :[], :new
+    end
+  end
+end

data/lib/pg/url/error.rb

@@ -0,0 +1,45 @@
+require 'string/builder'
+
+module PG
+  class URL
+    module Error
+      class MissingParams < StandardError
+        attr_reader :params
+        def initialize(params = [], message = String.new)
+          @params = params
+          case params.length
+          when 1
+            message = message.empty? ? 'Missing required connection string parameter' : message
+            super("#{message}: #{params.first}")
+          else
+            message = message.empty? ? 'Missing required connection string parameters' : message
+            super("#{message}: [#{params*', '}].")
+          end
+        end
+      end
+
+      class InvalidType < StandardError
+        using String::Builder
+
+        attr_reader :invalid
+        def initialize(invalid = [], message = String.new)
+          @invalid = invalid
+          message = message.empty? ? 'Invalid parameter type(s)' : message
+          message.build! do |s|
+            lines = []
+            invalid.each do |param|
+              line = String.build "\n" do |s2|
+                s2 << "#{param[:param]}: "
+                s2 << "Got #{param[:is_a?]}, "
+                s2 << "Expected [#{param[:expected]*', '}]"
+              end
+              lines << line
+            end
+            s << lines*', '
+          end
+          super(message)
+        end
+      end
+    end
+  end
+end

data/lib/pg/url/generator.rb

@@ -0,0 +1,34 @@
+require 'string/builder'
+
+module PG
+  class URL
+    class Generator
+      using String::Builder
+
+      def initialize(**params)
+        PARAMS.each do |param|
+          instance_variable_set("@#{param}", params[param])
+        end
+      end
+
+      def to_s
+        String.build 'postgres://' do |s|
+          s << @username
+          s << ":#{@password}" unless @password.nil? || @password.empty?
+          s << ?@
+          if @host.nil? || @host.empty?
+            s << 'localhost'
+            s << ?:
+            s << (@port.nil? ? '5432' : (@port.to_s.empty? ? '5432' : "#{@port}"))
+          else
+            s << @host
+            s << ":#{@port}" unless @port.nil? || @port.to_s.empty?
+          end
+          s << ?/
+          s << @database
+        end
+      end
+    end
+    private_constant :Generator
+  end
+end

data/lib/pg/url/prompt.rb

@@ -0,0 +1,61 @@
+require 'thor'
+require 'io/console'
+require_relative '../url.rb'
+require_relative 'generator'
+
+module PG
+  class URL
+    class Prompt < Thor
+      include Thor::Actions
+
+      no_tasks do
+        def initialize() end
+
+        def request()
+          params = {}
+          puts
+          PARAMS.each do |param|
+            params[param] = if param == :password
+              puts("Enter password (Or leave blank): ")
+              STDIN.noecho(&:gets).chomp
+            else
+              if ALLOW_EMPTY.include?(param)
+                ask("Enter #{param} (Or leave blank):")
+              else
+                value = String.new
+                valid = false
+                until valid do
+                  value = ask("Enter #{param}:")
+                  valid = true unless value.empty?
+                end
+                value
+              end
+            end
+          end
+          censored = params.dup
+          censored[:password] = "\e[93m*OBSCURED*\e[0m" unless censored[:password].nil? || censored[:password].empty?
+          puts("\n#{Generator.new(censored).to_s}")
+          valid = false
+          until valid do
+            value = ask("Correct connection string? [Y/n]")
+            if %w[Y y YES Yes yes].include? value
+              valid = true
+            elsif %w[N n NO No no].include? value
+              valid = true
+              request()
+            end
+          end
+          Generator.new(params).to_s
+        end
+      end
+    end
+
+    private_constant :Prompt
+
+    class << self
+      def prompt() Prompt.new.request end
+      alias_method :request, :prompt
+      alias_method :>>, :prompt
+    end
+  end
+end

data/lib/pg/url/type.rb

@@ -0,0 +1,36 @@
+require_relative 'error'
+
+module PG
+  class URL
+    module Type
+      CLASSES = {
+        host: [String],
+        port: [String, Integer],
+        database: [String],
+        username: [String],
+        password: [String],
+      }
+
+      class << self
+        def check(params)
+          classes = {}
+          invalid = []
+          params.each do |k,v|
+            classes[k] = v.class
+          end
+          classes.each do |k,v|
+            unless CLASSES[k].include? v
+              invalid << {
+                param: k,
+                is_a?: v,
+                expected: CLASSES[k]
+              }
+            end
+          end
+          raise Error::InvalidType.new(invalid) unless invalid.empty?
+        end
+      end
+    end
+    private_constant :Type
+  end
+end

data/lib/pg/url/version.rb

@@ -0,0 +1,5 @@
+module PG
+  class URL
+    VERSION = '0.1.0'
+  end
+end

data/pg-url.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pg/url/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pg-url"
+  spec.version       = PG::URL::VERSION
+  spec.authors       = ["Edwin Onuonga"]
+  spec.email         = ["edwinonuonga@gmail.com"]
+  spec.summary       = %q{Postgres connection string builder gem with construction through a prompt or Ruby method.}
+  spec.homepage      = "https://www.github.com/eonu/pg-url"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.7"
+
+  spec.add_runtime_dependency "string-builder", "~> 2.3"
+  spec.add_runtime_dependency "thor", "~> 0.20"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: pg-url
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Edwin Onuonga
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-06 00:00:00.000000000 Z
+dependencies:
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: string-builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+description: 
+email:
+- edwinonuonga@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pg/url.rb
+- lib/pg/url/error.rb
+- lib/pg/url/generator.rb
+- lib/pg/url/prompt.rb
+- lib/pg/url/type.rb
+- lib/pg/url/version.rb
+- pg-url.gemspec
+homepage: https://www.github.com/eonu/pg-url
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Postgres connection string builder gem with construction through a prompt
+  or Ruby method.
+test_files: []