supabase_api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84f7e5cb75c6780f9e5d92c3754ba8bc47a4025435138c15a3eca2277bf94c0b
-  data.tar.gz: 3e8dd8a4d6660f151ad4e710a6b2deddc00ffa053246a97936473f13dd373b2a
+  metadata.gz: 19e109b4ba10480413356a7a64e56e72f9e3d3efe6e4c8723e56bb0daad000b3
+  data.tar.gz: 28caa806525353af39a39b07a06d1e1675dbe1e5fa7f3fcdf9c2b30c967ade89
 SHA512:
-  metadata.gz: 29bada7921d062dd522ceb7859c846649859c9032e571914af230275c1f109cdd712f2121a920d82cb8ccc56131f10340486b83c2d97e5a0387a982634555796
-  data.tar.gz: c265459ec9dae8192f9637a6c80711fc5966aa6a55880b9a1132598b266fa5dd6ae35d1209ad933bf26498f8ace7419a964af5157ed707e83d90bd6cdaa878c0
+  metadata.gz: 688301121727380971f25ce30a238e4a0cabb5c9ccaa9d38f3974557b517a847a519537b9243709ca94c0c95a1272f5817859fcebf086d92355a2b9940f8f4c1
+  data.tar.gz: 7546f6fca428c0af286f8c5c24ea7795b7348f2beb77b22b73416a78fd33a3bfd3dba1173de58991fab3ab2018c78054ecbab99280f27c7ab34af54724d612bc

data/Gemfile

@@ -8,6 +8,9 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.0"
+gem 'simplecov', require: false, group: :test
+gem 'simplecov-shields-badge', require: false
+
 gem "webmock"
 gem "rubocop", "~> 1.21"
 

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    supabase_api (0.1.0)
+    supabase_api (0.3.0)
       httparty
+      rack
 
 GEM
   remote: https://rubygems.org/
@@ -14,6 +15,7 @@ GEM
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
+    docile (1.4.0)
     dotenv (2.7.6)
     hashdiff (1.0.1)
     httparty (0.20.0)
@@ -28,6 +30,7 @@ GEM
     parser (3.1.2.0)
       ast (~> 2.4.1)
     public_suffix (4.0.7)
+    rack (2.2.4)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.5.0)
@@ -58,6 +61,14 @@ GEM
     rubocop-ast (1.19.1)
       parser (>= 3.1.1.0)
     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-shields-badge (0.1.0)
+      simplecov (~> 0.15)
+    simplecov_json_formatter (0.1.4)
     unicode-display_width (2.2.0)
     webmock (3.14.0)
       addressable (>= 2.8.0)
@@ -73,6 +84,8 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)
+  simplecov
+  simplecov-shields-badge
   supabase_api!
   webmock
 

data/README.md

@@ -1,4 +1,5 @@
-# SupabaseApi
+# Supabase Api Ruby Client [![Gem](https://img.shields.io/gem/v/supabase_api?color=blue&label=version)](https://rubygems.org/gems/supabase_api) ![Build Status](https://github.com/galliani/supabase_api/workflows/spec/badge.svg)  [![Coverage](https://github.com/galliani/supabase_api/blob/main/badge.svg)](https://github.com/galliani/supabase_api) ![Commit](https://img.shields.io/github/last-commit/galliani/supabase_api)
+
 
 Hi, this is a Ruby wrapper to access your Supabase tables via REST API in a manner similar to ActiveRecord model.
 
@@ -27,10 +28,21 @@ Run these commands on the config or initializer file.
 ```ruby
 # setups
 require 'supabase_api' # if not using Rails
-SupabaseApi::Sample.base_url = 'https://yourrandomapisubdomain.supabase.co'
-SupabaseApi::Sample.api_key = 'veryrandomlongstring'
+SupabaseApi::Config.base_url = 'https://yourrandomapisubdomain.supabase.co'
+SupabaseApi::Config.api_key = 'veryrandomlongstring'
+```
+
+For production usage, of course it is recommended to use ENV variables manager like Figaro or Dotenv, which then will make your setup like this:
+```ruby
+# setups
+require 'supabase_api' # if not using Rails
+SupabaseApi::Config.base_url = ENV['SUPABASE_API_BASE_URL']
+SupabaseApi::Config.api_key = ENV['SUPABASE_API_KEY']
 ```
 
+This setup should be called as early as need be. If using rails, you can put it under `config/initializers` directory inside a file named `supabase_api.rb` as per the usual convention.
+
+
 ### With Rails
 Create a ruby PORO class for your Supabase tables and inherit from the `SupabaseApi::Record` class.
 
@@ -45,6 +57,7 @@ end
 
 Then after that you can access your Supabase table just like a `ActiveRecord`-backed models.
 
+### Querying Data
 ```ruby
 book_id_in_supabase = 100
 Book.find(book_id_in_supabase)
@@ -52,6 +65,19 @@ Book.find(book_id_in_supabase)
 # The line below will yield the same like above but will not raise any exception
 book = Book.find_by_id(book_id_in_supabase)
 
+# or you could call .where
+Book.where(id: 100) # would yield the same result as above, also not raising exception
+
+# .where works like you expect, passing another key-value pair as arguments
+Book.where(name: 'some name of the book')
+
+```
+
+### Mutating Data
+
+```ruby
+book = Book.find(book_id_in_supabase)
+
 # Assuming the books table has 'status' string column
 book.status = 'archived'
 book.save
@@ -77,9 +103,7 @@ Book.find(100) # will raise an exception SupabaseApi::RecordNotFound
 
 ## TODO List
 - add pagination.
-- add command `.where` for the Record class to be able to query the table.
-- add command `.update` for the Record instance.
-- add command `#update` for the Record class to have multiple upserts.
+- adapt command `#create` and `#update`  for the Record class to have multiple inserts and upserts respectively.
 - add more graceful and robust error handler.
 
 

data/badge.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="114" height="20" role="img" aria-label="coverage: 99.57%"><title>coverage: 99.57%</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="114" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="61" height="20" fill="#555"/><rect x="61" width="53" height="20" fill="#4c1"/><rect width="114" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="315" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="510">coverage</text><text x="315" y="140" transform="scale(.1)" fill="#fff" textLength="510">coverage</text><text aria-hidden="true" x="865" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="430">99.57%</text><text x="865" y="140" transform="scale(.1)" fill="#fff" textLength="430">99.57%</text></g></svg>

data/lib/supabase_api/client.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'httparty'
+require 'rack'
 
 module SupabaseApi
   class Client
@@ -25,9 +26,9 @@ module SupabaseApi
       }
     end
 
-    def list(table_name)
+    def list(table_name, params = {})
       self.class.get(
-        self.class.list_endpoint(table_name),
+        self.class.list_endpoint(table_name, params),
         headers: @headers.merge({
           'Range': '0-9'
         })
@@ -35,12 +36,7 @@ module SupabaseApi
     end
 
     def find(table_name, id)
-      self.class.get(
-        self.class.filtered_by_id_endpoint(table_name, id),
-        headers: @headers.merge({
-          'Range': '0-9'
-        })
-      )
+      list(table_name, { id: id })
     end
 
     def create(table_name, body)
@@ -56,7 +52,7 @@ module SupabaseApi
 
     def update(table_name, id, body)
       self.class.patch(
-        self.class.filtered_by_id_endpoint(table_name, id),
+        self.class.list_endpoint(table_name, { id: id }),
         body:     body.to_json,
         headers:  @headers.merge({
           'Content-Type': 'application/json',
@@ -67,11 +63,7 @@ module SupabaseApi
 
     def destroy(table_name, id)
       self.class.delete(
-        self.class.filtered_by_id_endpoint(table_name, id),
-        headers:  @headers.merge({
-          'Content-Type': 'application/json',
-          'Prefer':       'return=representation'
-        })
+        self.class.list_endpoint(table_name, { id: id })
       )      
     end
 
@@ -81,12 +73,16 @@ module SupabaseApi
       base_url + "/rest/#{api_version}/#{table_name}"
     end
 
-    def self.list_endpoint(table_name)
-      "#{collection_endpoint(table_name)}?select=*"
-    end
+    def self.list_endpoint(table_name, params = {})
+      if params
+        query_string = Rack::Utils.build_query(params)
+        adjusted_query_string = query_string.gsub('=','=eq.')
+      end
+
+      url = "#{collection_endpoint(table_name)}?select=*"
+      return url if adjusted_query_string.nil? || adjusted_query_string.empty?
 
-    def self.filtered_by_id_endpoint(table_name, id)
-      "#{list_endpoint(table_name)}&id=eq.#{id}"
-    end    
+      url + '&' + adjusted_query_string
+    end
   end
 end

data/lib/supabase_api/record.rb

@@ -7,14 +7,19 @@ module SupabaseApi
     end
 
     def self.all
+      where()
+    end
+
+    def self.where(params = {})
       output = []
 
-      response = Client.new.list(table_name)
+      response = Client.new.list(table_name, params)
+
       response.parsed_response.each do |record_hash|
         output << new(record_hash)
       end
 
-      output
+      output      
     end
 
     def self.find(id)

data/lib/supabase_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SupabaseApi
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/supabase_api.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   spec.add_dependency "httparty"
+  spec.add_dependency "rack"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: supabase_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Galih Muhammad
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-11 00:00:00.000000000 Z
+date: 2022-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 executables: []
@@ -39,6 +53,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- badge.svg
 - lib/supabase_api.rb
 - lib/supabase_api/client.rb
 - lib/supabase_api/config.rb