regres 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e312522da0cab27dd8fd7262306fa9abe5217705
+  data.tar.gz: be572b4191f9473cfee1f6b9a2e5c84b1dc547a4
+SHA512:
+  metadata.gz: d20b5df1455daffd9d8523cf4a005e51697557902e50a4d9be7b7218c350343108b25a1cc6e807f122415ebb8a530a86a5ff8437bbf5a092ad6c3e8ab93187bb
+  data.tar.gz: e9b22c8b22d66a8cef54c44c14dba14c129af758684e61e4945790a6186402a4f6ec1325eafaa521fc575b14f9ff008b87587e594d73bdf32e8b1331f417c634

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Peter Cooper
+
+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,84 @@
+# Regres – Simple Redis-like Data Storage on Postgres
+
+A prototype Ruby library for presenting a simple data storage interface (initially just key/value), backed by Postgres and inspired by Redis.
+
+## Simple Example
+
+```ruby
+db = Regres.new
+db.set("mykey", "hello, world")
+db.get("mykey")   # => "hello, world"
+```
+
+Note that all Regres needs is an accessible Postgres database. By default it uses the `regres_default` table and will create this if it doesn't exist.
+
+The motivation is that I love Redis and its API but there are places where I want the same ease of use backed by a standard, persistent RDBMS, such as when building simple Heroku apps (where a decent sized Redis database is expensive).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'regres'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install regres
+
+## Usage
+
+To connect:
+
+    db = Regres.new
+
+Or, more elaborately:
+
+    db = Regres.new("postgres://user:pass@host:5432/dbname")
+    # ... do stuff ...
+    db.close
+
+*Note: If the `DATABASE_URL` environment variable exists, this will be used if no connection URL is specified. Alternatively, it will default to the current user on `localhost`, as the Pg gem does.*
+
+Then issue commands:
+
+    db.set(key, value)
+    db.get(key)
+    db.del(key)
+
+Those are all of the commands for now.
+
+## TODOs
+
+Some things to work on next:
+
+* ~~Basic key/value storage with strings~~
+* `keys` command
+* `rename` command
+* `exists` command
+* Support `inc` and `decr` style manipulation of values
+* Support Redis-style expiry times for keys
+* Use json columns to support more complex data structures (e.g. hashes)
+* Support lists via Postgres arrays(?)
+* Support sets via Postgres arrays(?)
+* Better support multiple tables
+* Could this be a drop-in/substitute for the Redis client library with the right API?
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/peterc/regres.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "regres"
+
+# 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/edm.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'regres/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "regres"
+  spec.version       = Regres::VERSION
+  spec.authors       = ["Peter Cooper"]
+  spec.email         = ["git@peterc.org"]
+
+  spec.summary       = %q{Easy schemaless key/value storage on top of Postgres.}
+  spec.homepage      = "https://github.com/peterc/regres"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_dependency "pg", "~> 1.0.0"
+end

data/lib/regres.rb

@@ -0,0 +1,28 @@
+require "pg"
+
+require "regres/version"
+require "regres/connection"
+require "regres/table"
+
+require "forwardable"
+
+class Regres
+  extend Forwardable
+
+  attr_reader :connection, :table
+
+  def initialize(options = {})
+    defaults = {
+      table: 'regres_default'
+    }
+
+    @options = defaults.merge(options)
+
+    @connection = Connection.new(@options[:url])
+
+    @table = Table.new(@connection, @options[:table])
+  end
+
+  def_delegators :@table, :get, :set, :del
+  def_delegators :@connection, :close
+end

data/lib/regres/connection.rb

@@ -0,0 +1,41 @@
+require 'uri'
+require 'forwardable'
+
+class Regres
+  class Connection
+    extend Forwardable
+
+    attr_reader :connection
+
+    def self.parse_url(url)
+      uri = URI(url)
+
+      {
+        user: uri.user,
+        password: uri.password,
+        host: uri.host,
+        port: uri.port || 5432,
+        dbname: uri.path.sub(/^\//, '')
+      }
+    rescue
+      {}
+    end
+
+    def initialize(url = nil)
+      defaults = {
+        user: ENV['USER'],
+        dbname: ENV['USER'],
+        host: "localhost",
+        sslmode: "prefer"
+      }
+
+      url ||= ENV['DATABASE_URL'] if ENV['DATABASE_URL'].to_s.start_with?('postgres')
+
+      options = defaults.merge(self.class.parse_url(url))
+
+      @connection = PG.connect(options)
+    end
+
+    def_delegators :@connection, :query, :close
+  end
+end

data/lib/regres/table.rb

@@ -0,0 +1,44 @@
+class Regres
+  class Table
+    def initialize(connection, name)
+      @connection = connection
+      @name = name[/^[\w\_\-]+/]
+
+      create unless exists?
+    end
+
+    def create
+      @connection.query(%{
+        CREATE TABLE #{@name} (k varchar(255) primary key, v text, unique (k))
+      })
+    end
+
+    def exists?
+      res = @connection.query(%{SELECT EXISTS (SELECT 1 FROM information_schema.tables WHERE table_name = $1)}, [@name])
+
+      res.first == {"exists" => "t"}
+    end
+
+    def set(k, v)
+      @connection.query(%{
+        INSERT INTO #{@name} (k, v) VALUES ($1, $2)
+        ON CONFLICT (k) DO UPDATE SET v = $2 WHERE #{@name}.k = $1
+        }, [k, v])
+
+      v
+    end
+
+    def get(k)
+      res = @connection.query(%{
+        SELECT v FROM #{@name} WHERE k = $1
+        }, [k]).first
+
+      res && res['v']
+    end
+
+    def del(k)
+      @connection.query(%{DELETE FROM #{@name} WHERE k = $1}, [k])
+      true
+    end
+  end
+end

data/lib/regres/version.rb

@@ -0,0 +1,3 @@
+class Regres
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: regres
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Peter Cooper
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: 
+email:
+- git@peterc.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- edm.gemspec
+- lib/regres.rb
+- lib/regres/connection.rb
+- lib/regres/table.rb
+- lib/regres/version.rb
+homepage: https://github.com/peterc/regres
+licenses:
+- MIT
+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.6.10
+signing_key: 
+specification_version: 4
+summary: Easy schemaless key/value storage on top of Postgres.
+test_files: []