grist-grist 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e77352236c1dc254aaf3ba8b1babd19136beb839d41ab5efc9832afa84e661ed
+  data.tar.gz: 437e6530adefb67149485435eb3c74697f4de942919a856e7bde21f468c713c8
+SHA512:
+  metadata.gz: 81734bd4a76545fb675bce6bb4ebe383fabd0e1fcd885b8a173d6a264c7019af7eb432d8cba509c97801267f5fe188b0fe808a81aa0ba3879b3b96a42d290efb
+  data.tar.gz: 5771be9c324fc9194f925b3e35175515440f4ae5c4284063b3f33b2ec221525d111fa2ab80fdc405dc4ddc533b10c737e4a1e76ddd7925ff7fddfb10cad37bb0

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.ruby-version

@@ -0,0 +1 @@
+3.2.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-04-01
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at 26109239+Quentinchampenois@users.noreply.github.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 quentinchampenois
+
+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,76 @@
+# Grist::Ruby
+
+This gem provides a Ruby client for the Grist API. 
+
+⚠️ Library isn't ready to use, not actively maintained
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grist'
+```
+
+And install the gem:
+
+```bash
+$ bundle install
+```
+
+## Usage
+
+See `examples/main.rb`
+
+## Development
+
+1. Start a Grist instance locally
+```bash
+$ docker compose up -d
+```
+
+### Playground using IRB
+Then start the ruby console
+```
+$ GRIST_API_KEY=<GRIST_API_KEY> GRIST_API_URL=http://localhost:8484/api bundle exec bin/console
+```
+* GRIST_API_KEY can be found directly into your account at : http://localhost:8484/o/docs/account
+
+You can now interact with Grist, example : `$ Grist::Type::Organization.all`
+
+### Using existing examples
+
+* First example will create 1 Workspace, with 2 Documents, with 3 tables into document 'demo'.
+how to use it 
+```bash
+$  GRIST_API_KEY=a61b5bc73849e715dd9ebec0216230924021d6b6 GRIST_API_URL=http://localhost:8484/api bundle exec examples/main.r
+```
+
+* `GRIST_API_URL` base url must contain `/api` 
+
+* Second example will update records
+```bash
+GRIST_ORG_NAME=<ORGANIZATION_NAME> GRIST_API_KEY=a61b5bc73849e715dd9ebec0216230924021d6b6 GRIST_API_URL=http://localhost:8484/api bundle exec examples/update.rb
+```
+
+* `ORGANIZATION_NAME` is case-sensitive 
+
+
+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 the created tag, 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/[USERNAME]/grist-ruby. 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]/grist-ruby/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Grist::Ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/grist-ruby/blob/main/CODE_OF_CONDUCT.md).
+
+## Resources
+* https://support.getgrist.com/api/#tag/records/operation/addRecords

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/docker-compose.yml

@@ -0,0 +1,11 @@
+version: '3'
+
+services:
+  app:
+    image: gristlabs/grist:latest
+    ports:
+      - "8484:8484"
+    volumes:
+      - ./volumes/data:/persist:rw
+    environment:
+      - GRIST_SESSION_SECRET=secret

data/examples/main.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "grist"
+require "byebug"
+
+raise ArgumentError, "You must provide env var : 'GRIST_API_KEY'" if ENV.fetch("GRIST_API_KEY", "").empty?
+raise ArgumentError, "You must provide env var : 'GRIST_API_URL'" if ENV.fetch("GRIST_API_URL", "").empty?
+
+orgs = Grist::Type::Organization.all
+org = orgs.last
+
+if org.nil?
+   puts "No organization present"
+   exit 0
+end
+
+puts "Org: #{org.name} - ID: #{org.id}"
+
+ws_name = "Workspace N°#{rand(1_000)}"
+puts "Creating workspace #{ws_name}..."
+ws = org.create_workspace({ name: ws_name })
+
+puts "Creating document 'demo' into workspace '#{ws_name}'..."
+doc = ws.create_doc({
+                      name: "Demo",
+                      isPinned: true
+                    })
+
+puts "Creating document 'Github' into workspace '#{ws_name}'"
+ws.create_doc({
+                name: "Github",
+                isPinned: false
+              })
+
+puts "Creating tables for document 'demo' into workspace '#{ws_name}'..."
+doc.create_tables({
+                    "tables" => [
+                      { "id" => "Community gems",
+                        "columns" => [
+                          { "id" => "name", "fields" => { "label" => "Gem name" } },
+                          { "id" => "description", "fields" => { "label" => "Description" } },
+                          { "id" => "link", "fields" => { "label" => "RubyGems link" } }
+                        ] }
+                    ]
+                  })
+
+puts "Creating tables for document 'demo' into workspace '#{ws_name}'..."
+doc.create_tables({
+                    "tables" => [
+                      { "id" => "Standard library",
+                        "columns" => [
+                          { "id" => "name", "fields" => { "label" => "Library name" } },
+                          { "id" => "url", "fields" => { "label" => "Source code public URL" } },
+                          { "id" => "version", "fields" => { "label" => "Latest version" } }
+                        ] }
+                    ]
+                  })
+
+doc = ws.docs.first
+tables = doc.tables
+
+puts "Tables:"
+tables.each do |table|
+  puts table.id
+  puts "Total records : #{table.records.count}"
+end
+
+table = tables.last
+
+puts "Creating records into table from doc 'demo' into workspace '#{ws_name}'..."
+table.create_records("records" => [
+                       {
+                         "fields" => {
+                           "name" => "did_you_mean",
+                           "url" => "https://github.com/ruby/did_you_mean",
+                           "version" => "v2.0.0"
+                         }
+                       }
+                     ])
+
+puts "Terminated, go check at http://localhost:8484/o/demo"

data/examples/update.rb

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "grist"
+require "byebug"
+
+raise ArgumentError, "You must provide env var : 'GRIST_API_KEY'" if ENV.fetch("GRIST_API_KEY", "").empty?
+raise ArgumentError, "You must provide env var : 'GRIST_API_URL'" if ENV.fetch("GRIST_API_URL", "").empty?
+
+TABLE_NAME = "Open_source_software"
+
+org_name = ENV.fetch("GRIST_ORG_NAME", "")
+orgs = Grist::Type::Organization.all
+org = orgs.find { |org| org.name == org_name }
+
+if org&.workspaces&.empty?
+  puts "No workspaces found in organization #{org.name}. Creating a new one..."
+  ws = org.create_workspace({ name: "Grist Ruby" })
+  puts "Workspace created: #{ws.name} - ID: #{ws.id}"
+else
+  ws = org&.workspaces&.last
+  puts "Workspaces found in organization #{org.name}. Using the last one '#{ws.name}'..."
+end
+
+puts "Workspace ID: #{ws.id}"
+puts "Workspace Name: #{ws.name}"
+
+if ws.docs.empty?
+  puts "No docs found in workspace #{ws.name}. Creating a new one..."
+  doc = ws.create_doc({ name: "Getting started" })
+  puts "Doc created: #{doc.name} - ID: #{doc.id}"
+else
+  doc = ws.docs.last
+  puts "Docs found in workspace #{ws.name}. Using the last one '#{doc.name}'..."
+end
+
+puts "Doc ID: #{doc.id}"
+puts "Doc Name: #{doc.name}"
+
+table = doc.tables.find { |t| t.id == TABLE_NAME }
+if !table.nil?
+  puts "Table found in doc #{doc.name}. Using the last one '#{table.id}'..."
+  puts "Table ID: #{table.id}"
+else
+  puts "No tables found in doc #{doc.name}. Creating a new one..."
+  new_table = Grist::Type::Table.new("id" => TABLE_NAME, "columns" => [
+                                       { "id" => "name", "fields" => { "label" => "Software name" } },
+                                       { "id" => "description", "fields" => { "label" => "Description" } },
+                                       { "id" => "link", "fields" => { "label" => "Source code link" } }
+                                     ])
+  table = doc.create_tables("tables" => [new_table.to_hash])[0]
+  puts "Table created ID: #{table&.id}"
+end
+
+# TODO: WIP

data/lib/grist/accessible.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Grist
+  module Accessible
+    def access
+      id = instance_variable_get("@id")
+      request(:get, "#{path}/#{id}/access")
+    end
+  end
+end

data/lib/grist/api_routes.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Grist
+  module ApiRoutes
+    ### ORGANIZATIONS
+    ORG_ALL = "https://{gristhost}/api/orgs"
+    ORG_FIND = "https://{gristhost}/api/orgs/{orgId}"
+    ORG_UPDATE = "https://{gristhost}/api/orgs/{orgId}"
+    ORG_DELETE = "https://{gristhost}/api/orgs/{orgId}"
+    # ORG ACCESS
+    ORG_ACCESS_ALL = "https://{gristhost}/api/orgs/{orgId}/access"
+    ORG_ACCESS_UPDATE = "https://{gristhost}/api/orgs/{orgId}/access"
+    # ORG WORKSPACE
+    WORKSPACE_ALL = "https://{gristhost}/api/orgs/{orgId}/workspaces"
+    WORKSPACE_CREATE = "https://{gristhost}/api/orgs/{orgId}/workspaces"
+
+    ### WORKSPACES
+    WORKSPACE_FIND = "https://{gristhost}/api/workspaces/{workspaceId}"
+    WORKSPACE_UPDATE = "https://{gristhost}/api/workspaces/{workspaceId}"
+    WORKSPACE_DELETE = "https://{gristhost}/api/workspaces/{workspaceId}"
+    # WORKSPACE ACCESS
+    WORKSPACE_ACCESS_ALL = "https://{gristhost}/api/workspaces/{orgId}/access"
+    WORKSPACE_ACCESS_UPDATE = "https://{gristhost}/api/workspaces/{orgId}/access"
+    # WORKSPACE DOCUMENTS
+    DOC_CREATE = "https://{gristhost}/api/workspaces/{workspaceId}/docs"
+
+    ### DOCUMENTS
+    DOC_FIND = "https://{gristhost}/api/docs/{docId}"
+    DOC_UPDATE = "https://{gristhost}/api/docs/{docId}"
+    DOC_DELETE = "https://{gristhost}/api/docs/{docId}"
+    DOC_MOVE = "https://{gristhost}/api/docs/{docId}/move"
+    # DOC ACCESS
+    DOC_ACCESS_ALL = "https://{gristhost}/api/docs/{docId}/access"
+    DOC_ACCESS_UPDATE = "https://{gristhost}/api/docs/{docId}/access"
+    # DOC ACCESS
+    DOC_DL_SQL = "https://{gristhost}/api/docs/{docId}/download"
+    DOC_DL_EXCEL = "https://{gristhost}/api/docs/{docId}/download/xlsx"
+    DOC_DL_CSV = "https://{gristhost}/api/docs/{docId}/download/csv"
+    DOC_DL_TABLE_SCHEMA = "https://{gristhost}/api/docs/{docId}/download/table-schema"
+    DOC_TRUNCATE_HISTORY = "https://{gristhost}/api/docs/{docId}/states/remove"
+    DOC_FORCE_RELOAD = "https://{gristhost}/api/docs/{docId}/force-reload"
+    DOC_CLEAR_QUEUE = "https://{gristhost}/api/docs/{docId}/webhooks/queue"
+
+    ### RECORDS
+    RECORD_ALL = "https://{gristhost}/api/docs/{docId}/tables/{tableId}/records"
+    RECORD_CREATE = "https://{gristhost}/api/docs/{docId}/tables/{tableId}/records"
+    RECORD_UPDATE = "https://{gristhost}/api/docs/{docId}/tables/{tableId}/records"
+    RECORD_ADD_OR_UPDATE = "https://{gristhost}/api/docs/{docId}/tables/{tableId}/records"
+
+    ### TABLES
+    TABLE_ALL = "https://{gristhost}/api/docs/{docId}/tables"
+    TABLE_CREATE = "https://{gristhost}/api/docs/{docId}/tables"
+    TABLE_UPDATE = "https://{gristhost}/api/docs/{docId}/tables"
+
+    ### COLUMNS
+    COLUMN_ALL = "https://{gristhost}/api/docs/{docId}/tables/{tableId}/columns"
+    COLUMN_CREATE = "https://{gristhost}/api/docs/{docId}/tables/{tableId}/columns"
+    COLUMN_UPDATE = "https://{gristhost}/api/docs/{docId}/tables/{tableId}/columns"
+    COLUMN_ADD_OR_UPDATE = "https://{gristhost}/api/docs/{docId}/tables/{tableId}/columns"
+    COLUMN_DELETE = "https://{gristhost}/api/docs/{docId}/tables/{tableId}/columns/{colId}"
+
+    ### ROWS
+    ROW_DELETE = "https://{gristhost}/api/docs/{docId}/tables/{tableId}/data/delete"
+
+    ### ATTACHMENTS
+    ATTACHMENT_ALL = "https://{gristhost}/api/docs/{docId}/attachments"
+    ATTACHMENT_UPDATE = "https://{gristhost}/api/docs/{docId}/attachments"
+    ATTACHMENT_METADATA = "https://{gristhost}/api/docs/{docId}/attachments/{attachmentId}"
+    ATTACHMENT_DL_CONTENT = "https://{gristhost}/api/docs/{docId}/attachments/{attachmentId}/download"
+
+    ### WEBHOOKS
+    WEBHOOK_ALL = "https://{gristhost}/api/docs/{docId}/webhooks"
+    WEBHOOK_CREATE = "https://{gristhost}/api/docs/{docId}/webhooks"
+    WEBHOOK_UPDATE = "https://{gristhost}/api/docs/{docId}/webhooks/{webhookId}"
+    WEBHOOK_DELETE = "https://{gristhost}/api/docs/{docId}/webhooks/{webhookId}"
+
+    USER_DELETE = "https://{gristhost}/api/users/{userId}"
+  end
+end

data/lib/grist/response.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Grist
+  class Response
+    attr_reader :data, :error, :code, :type
+
+    def initialize(data: nil, error: nil, code: nil, type: nil)
+      @data = data
+      @error = error
+      @type = type
+      @code = code&.to_i
+    end
+
+    def success?
+      error.nil? && (@code >= 200 && @code < 400)
+    end
+
+    def error?
+      !error.nil? || !(@code >= 200 && @code < 400)
+    end
+
+    def not_found?
+      @code == 404
+    end
+
+    def print_error
+      err = "#{@type}: #{@error}"
+      err += " (code: #{@code})" if @code
+      err += "\n#{@type.help}" if @type.respond_to?(:help) && !@type.help.nil?
+      err
+    end
+
+    def log_error
+      return unless error?
+
+      Grist.logger.error("Grist API Error: #{@type} (code: #{@code})- #{@error}")
+    end
+  end
+end

data/lib/grist/rest.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Grist
+  module Rest
+    def request(method, endpoint, params = {})
+      uri = URI("#{::Grist.base_api_url}#{endpoint}")
+      uri.query = URI.encode_www_form(params) if method == :get
+
+      http = ::Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = !::Grist.localhost?
+
+      request = ::Net::HTTP.const_get(method.capitalize).new(uri)
+      request["Authorization"] = ::Grist.token_auth
+      request["Content-Type"] = "application/json"
+      request.body = params.to_json unless method == :get
+
+      response = http.request(request)
+
+      raise InvalidApiKey, "Invalid API key" if response.is_a?(Net::HTTPUnauthorized)
+      raise NotFound, "Resource not found at : #{request.uri}" if response.is_a?(Net::HTTPNotFound)
+
+      data = response_body(response.body)
+
+      Grist::Response.new(data: data, code: response.code)
+    rescue Net::OpenTimeout, Net::ReadTimeout, SocketError => e
+      res = Grist::Response.new(code: response&.code, error: "Grist endpoint is unreachable at #{request.uri}",
+                                type: e.class)
+      res.log_error
+      raise NetworkError, res.print_error
+    rescue APIError => e
+      res = Grist::Response.new(code: response&.code, error: e.message, type: e.class)
+      res.log_error
+      res
+    rescue StandardError, Grist::NotFound => e
+      res = Grist::Response.new(code: response&.code, error: e.message, type: e.class)
+      res.log_error
+      res
+    end
+
+    def path
+      self.class::PATH
+    end
+
+    def list(params = {})
+      request(:get, path, params)
+    end
+
+    def get(id)
+      request(:get, "#{path}/#{id}")
+    end
+
+    def create(data)
+      grist_res = request(:post, path, data)
+      puts "Creating #{path} with data: #{data}"
+      puts puts grist_res.inspect
+      return unless grist_res.success?
+
+      data.each_key do |key|
+        instance_variable_set("@#{key}", data[key])
+      end
+
+      self
+    end
+
+    def update(data)
+      id = instance_variable_get("@id")
+      grist_res = request(:patch, "#{path}/#{id}", data)
+      return unless grist_res.success?
+
+      data.each_key do |key|
+        instance_variable_set("@#{key}", data[key])
+      end
+
+      self
+    end
+
+    def delete
+      id = instance_variable_get("@id")
+      grist_res = request(:delete, "#{path}/#{id}")
+      return unless grist_res.success?
+
+      instance_variable_set("@deleted", true)
+
+      self
+    end
+
+    private
+
+    def response_body(str)
+      return {} if str.nil? || str.empty?
+
+      JSON.parse(str)
+    end
+  end
+end

data/lib/grist/searchable.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Grist
+  module Searchable
+    # Finds a record based on the given parameters.
+    # @param params [Hash] The parameters to search for
+    # @return [Array] The records that match the given parameters
+    def self.find_by(*params)
+      objs = all
+      objs.select do |obj|
+        params.all? do |key, value|
+          obj.instance_variable_get("@#{key}") == value
+        end
+      end
+    end
+  end
+end