postgrest 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e8867bc92b600721834d706875e5d96805c88f3c7314088c81547e907da741d7
+  data.tar.gz: c215c962a1d3f530da16bc8d16e34089438f5ee2acef7f551aa76870c60ad6dd
+SHA512:
+  metadata.gz: 49e2357915dd71ce84a784749e98c7d6d0c40f323bc2dafc4b4dc8335518b5e6e3a3af44ba87bf3e881b2f0fd5e498246eef19798999ceb9df9b995990467935
+  data.tar.gz: 9d169f87f00c70c50a2a058a099c3eed8e5d0f18e185a08df13bea077dca4a9147d64b581977294415419962e33e8739f4c5273cc1673929175fc60d09d6ce7e

data/.codeclimate.yml

@@ -0,0 +1,9 @@
+version: "2"
+plugins:
+  rubocop:
+    enabled: true
+    channel: rubocop-0-60
+    config:
+      file: ".rubocop.yml"
+exclude_patterns:
+  - "spec/"

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+bin/private_console

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  SuggestExtensions: false
+  Exclude:
+    - 'spec/**/*.rb'
+    - 'bin/**/*'
+Style/Documentation:
+  Enabled: false
+Style/HashEachMethods:
+  Enabled: false
+Lint/MissingSuper:
+  Enabled: false
+Lint/UriEscapeUnescape:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in postgrest.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    postgrest (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    docile (1.3.5)
+    method_source (1.0.0)
+    parallel (1.20.1)
+    parser (3.0.1.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.13.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  postgrest!
+  pry
+  rake (~> 12.0)
+  rspec (~> 3.5)
+  rubocop (~> 1.13.0)
+  simplecov (~> 0.21.2)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Marcelo Barreto
+
+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,103 @@
+# PostgREST
+
+## Status
+
+[![Build Status](https://api.travis-ci.org/marcelobarreto/postgrest.svg?branch=master)](https://travis-ci.org/marcelobarreto/postgrest-rb)
+[![Code Climate](https://codeclimate.com/github/marcelobarreto/postgrest-rb.svg)](https://codeclimate.com/github/marcelobareto/postgrest-rb)
+[![Code Climate](https://codeclimate.com/github/marcelobarreto/postgrest-rb/coverage.svg)](https://codeclimate.com/github/marcelobarreto/postgrest-rb)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
+[![RubyGems](http://img.shields.io/gem/dt/postgrest-rb.svg?style=flat)](http://rubygems.org/gems/postgrest-rb)
+
+Ruby client for [PostgREST](https://postgrest.org/)
+
+This gem is under development, any help are welcome :muscle:
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'postgrest'
+```
+
+And then execute:
+
+`$ bundle install`
+
+Or install it yourself as:
+
+`$ gem install postgrest`
+
+## Usage
+
+### Configuration
+
+```ruby
+db = Postgrest::Client.new(url: url, headers: headers, schema: schema)
+```
+
+### Selecting
+
+```ruby
+# Basic select
+
+db.from('todos').select('*')
+
+<Postgrest::Response:0x0000556745caa420
+  @body={:select=>"*"},
+  @count=1,
+  @data=[{"id"=>1, "title"=>"Go to the gym", "completed"=>false}],
+  @error=true,
+  @status=200,
+  @status_text="OK">
+
+# Selecting just one or more fields
+
+db.from('todos').select('title, completed')
+
+<Postgrest::Response:0x0000556745590770
+  @body={:select=>"title, completed"},
+  @count=1,
+  @data=[{"title"=>"Go to the gym", "completed"=>false}],
+  @error=true,
+  @status=200,
+  @status_text="OK">
+
+```
+
+### Inserting
+
+```ruby
+db.from('todos').insert({ title: 'Go to the gym', completed: false })
+
+<Postgrest::Response:0x00005567458aebf0 @body={:title=>"Go to the gym", :completed=>false}, @count=nil, @data="", @error=false, @status=201, @status_text="Created">
+
+# Inserting multiple rows at once
+db.from('todos').insert([
+  { title: 'Go to the gym', completed: false },
+  { title: 'Walk in the park', completed: true },
+])
+
+<Postgrest::Response:0x0000556745cdd118
+  @body=[{:title=>"Go to the gym", :completed=>false}, {:title=>"Walk in the park", :completed=>true}],
+  @count=nil,
+  @data="",
+  @error=true,
+  @status=201,
+  @status_text="Created">
+
+```
+
+## 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/marcelobarreto/postgrest.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'postgrest'
+
+# 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/postgrest.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'postgrest/version'
+require 'postgrest/http'
+require 'postgrest/client'
+require 'postgrest/query_builder'
+require 'postgrest/response'
+
+module Postgrest
+  class MissingTableError < StandardError; end
+
+  class RequestError < StandardError; end
+end

data/lib/postgrest/client.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Postgrest
+  class Client
+    DEFAULT_SCHEMA = 'public'
+
+    attr_reader :url, :headers, :schema
+
+    def initialize(url:, headers: {}, schema: DEFAULT_SCHEMA)
+      @url = URI(url)
+      @headers = headers
+      @schema = schema
+    end
+
+    def from(table)
+      raise MissingTableError if table.nil? || table.empty?
+
+      Postgrest::QueryBuilder.new(url: "#{@url}/#{table}", headers: headers, schema: schema)
+    end
+  end
+end

data/lib/postgrest/http.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+
+module Postgrest
+  class HTTP
+    class << self
+      def set_request_headers(request, headers = {})
+        headers.each do |key, value|
+          request[key] = value
+        end
+
+        headers['Content-Type'] = 'application/json'
+
+        nil
+      end
+
+      def get(uri:, query: {}, headers: {})
+        res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+          uri.query = URI.encode_www_form(query)
+          req = Net::HTTP::Get.new(uri)
+          set_request_headers(req, headers)
+          http.request(req)
+        end
+
+        data = response_is_successful?(res) ? JSON.parse(res.body) : []
+
+        Response.new({
+                       error: !response_is_successful?(res),
+                       data: data,
+                       count: data.count,
+                       status: res.code.to_i,
+                       status_text: res.message,
+                       body: query
+                     })
+      end
+
+      def post(uri:, body: {}, headers: {})
+        res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+          req = Net::HTTP::Post.new(uri)
+          req.body = body.to_json
+          req.content_type = 'application/json'
+          set_request_headers(req, headers)
+          http.request(req)
+        end
+
+        Response.new({
+                       error: !response_is_successful?(res),
+                       data: res.body,
+                       count: nil,
+                       status: res.code.to_i,
+                       status_text: res.message,
+                       body: body
+                     })
+      end
+
+      private
+
+      def response_is_successful?(response)
+        response.class.ancestors.include?(Net::HTTPSuccess)
+      end
+    end
+  end
+end

data/lib/postgrest/query_builder.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Postgrest
+  class QueryBuilder
+    attr_accessor :uri, :headers, :schema
+
+    def initialize(url:, headers:, schema:)
+      @uri = URI(url)
+      @headers = headers
+      @schema = schema
+    end
+
+    def select(columns = '*')
+      Postgrest::HTTP.get(uri: uri, query: { select: columns }, headers: headers)
+    end
+
+    # @client.from('todos').insert([
+    #   { title: 'The Shire', completed: false },
+    #   { title: 'The Shire', completed: false },
+    # ])
+
+    # @client.from('todos').insert({ name: 'The Shire', country_id: 554 })
+
+    def insert(values)
+      Postgrest::HTTP.post(uri: uri, body: values, headers: headers)
+    end
+  end
+end

data/lib/postgrest/response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Postgrest
+  class Response
+    attr_reader :error, :data, :count, :status, :status_text, :body
+
+    def initialize(params = {})
+      @error = params[:error]
+      @data = params[:data]
+      @count = params[:count]
+      @status = params[:status]
+      @status_text = params[:status_text]
+      @body = params[:body]
+    end
+  end
+end

data/lib/postgrest/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Postgrest
+  VERSION = '0.1.0'
+end

data/postgrest.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'lib/postgrest/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'postgrest'
+  spec.version       = Postgrest::VERSION
+  spec.authors       = ['Marcelo Barreto']
+  spec.email         = ['marcelobarretojunior@gmail.com']
+
+  spec.summary       = 'Ruby client for PostgREST'
+  spec.description   = 'Ruby client for PostgREST'
+  spec.homepage      = 'https://github.com/marcelobarreto/postgrest-rb'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/marcelobarreto/postgrest-rb'
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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 'pry'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'rubocop', '~> 1.13.0'
+  spec.add_development_dependency 'simplecov', '~> 0.21.2'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: postgrest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marcelo Barreto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  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.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+description: Ruby client for PostgREST
+email:
+- marcelobarretojunior@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/postgrest.rb
+- lib/postgrest/client.rb
+- lib/postgrest/http.rb
+- lib/postgrest/query_builder.rb
+- lib/postgrest/response.rb
+- lib/postgrest/version.rb
+- postgrest.gemspec
+homepage: https://github.com/marcelobarreto/postgrest-rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/marcelobarreto/postgrest-rb
+  source_code_uri: https://github.com/marcelobarreto/postgrest-rb
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby client for PostgREST
+test_files: []