supabase_api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ee663907558d623c67c158f5fdfdad29ace31bf9d15a8163e831d638fb692e2
-  data.tar.gz: 68e363c2c76fc08a314770f37a0d3523e6e37da3429bae85ab7392203856eeac
+  metadata.gz: 84f7e5cb75c6780f9e5d92c3754ba8bc47a4025435138c15a3eca2277bf94c0b
+  data.tar.gz: 3e8dd8a4d6660f151ad4e710a6b2deddc00ffa053246a97936473f13dd373b2a
 SHA512:
-  metadata.gz: 7e2002ed63e05801f30f65aea4c3b75fcd4419a9d81f67640f1f572f97fda35842357aebae70907a2210c638b6fd24abf9b76c9b3d1fdf70f051d94d6138785a
-  data.tar.gz: 99a263b473b85f14f95172da8770efac671a450b05e8cf7d3dfb31ef4e7b03f6bbaac054d4c3a298c0f24437ad59d8fa14c97915f189f95269e3992171af18d7
+  metadata.gz: 29bada7921d062dd522ceb7859c846649859c9032e571914af230275c1f109cdd712f2121a920d82cb8ccc56131f10340486b83c2d97e5a0387a982634555796
+  data.tar.gz: c265459ec9dae8192f9637a6c80711fc5966aa6a55880b9a1132598b266fa5dd6ae35d1209ad933bf26498f8ace7419a964af5157ed707e83d90bd6cdaa878c0

data/README.md

@@ -1,22 +1,87 @@
 # SupabaseApi
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/supabase_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+Hi, this is a Ruby wrapper to access your Supabase tables via REST API in a manner similar to ActiveRecord model.
 
-TODO: Delete this and the text above, and describe your gem
+DISCLAIMER: This is not an official Ruby SDK.
 
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add supabase_api
+```bash
+$ bundle add supabase_api
+```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install supabase_api
+```bash
+$ gem install supabase_api
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+
+### Setup
+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'
+```
+
+### With Rails
+Create a ruby PORO class for your Supabase tables and inherit from the `SupabaseApi::Record` class.
+
+```ruby
+class Book < SupabaseApi::Record
+  def self.table_name
+    # put the name of the table you want to connect with from Supabase
+    'books' # or 'Books', whatever you fancy
+  end
+end
+```
+
+Then after that you can access your Supabase table just like a `ActiveRecord`-backed models.
+
+```ruby
+book_id_in_supabase = 100
+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)
+
+# Assuming the books table has 'status' string column
+book.status = 'archived'
+book.save
+
+# If you want to create a new book record
+new_book = Book.new(
+  name: 'New Book',
+  status: 'pending'
+)
+new_book.save
+
+# or
+book = Book.create(
+  name: 'New Book',
+  status: 'pending'
+)
+book.id # => 100
+
+# In case you regret creating it, you can delete the record
+book.destroy
+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.
+- add more graceful and robust error handler.
+
 
 ## Development
 
@@ -26,7 +91,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/supabase_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/supabase_api/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/galliani/supabase_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/galliani/supabase_api/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -34,4 +99,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the SupabaseApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/supabase_api/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the SupabaseApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/galliani/supabase_api/blob/master/CODE_OF_CONDUCT.md).

data/lib/supabase_api/version.rb

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

data/supabase_api.gemspec

@@ -6,7 +6,6 @@ Gem::Specification.new do |spec|
   spec.name = "supabase_api"
   spec.version = SupabaseApi::VERSION
   spec.authors = ["Galih Muhammad"]
-  spec.email = ["galih.rubyist@gmail.com"]
 
   spec.summary = "A ruby client for Supabase tables to be consumed as ruby class via the REST API"
   spec.homepage = "https://github.com/galliani/supabase_api"
@@ -32,7 +31,4 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   spec.add_dependency "httparty"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: supabase_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Galih Muhammad
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-10 00:00:00.000000000 Z
+date: 2022-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -26,7 +26,6 @@ dependencies:
         version: '0'
 description:
 email:
-- galih.rubyist@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []