norairrecord 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5f9d1c3992d715d55a1308918a574a00b83042da2e58bfbcc9389ff51e0b6cd
-  data.tar.gz: d4372b35b219e5ffd6384c42e3687dd9019dabbb48d8bb622d395eb8aadab90a
+  metadata.gz: 0f5fc9903052fc25fe8bdd071a9989ab92561387d0dabc70ad82045a8335eab1
+  data.tar.gz: d445e59398dbb6c10e08ce645ad12f2dd8dd763ca16334f4ca93477ebe8c9d37
 SHA512:
-  metadata.gz: 0fdcca5fc8ee492d692fe1271d60052d82ddf4c18ff4ec275e464cf9871dd52cf9996e393ac01292bc780a31dc0681c92af1485282e6b11138fea35957ae1b18
-  data.tar.gz: f023f648cb134d4de8c0773fd1a2d0882393ea7109af105f2cd9b23fde4d1eeb9d519ee695ac341912a191d3d6a3b6b946efb3d7c8bc6d60ecdaf387dacfcef5
+  metadata.gz: 6c78431764c880fbf87535717d223b9ce805c7b6a38a45a64dcf649b073c6dae6d4d322a7130a59d5f0e3cef51389887858568f260a83f34c8cca6e66ef1f3d8
+  data.tar.gz: c97892cf8cb38a5ac9103e6e5358c4993e3fcca8f0e5e42a8d68ac9e22daad3d83320dcf9cc8592e46bd26965ff394fac9fbfdce385d341682aa6f6ab73467eb

data/README.md

@@ -26,6 +26,7 @@ stuff not in the OG:
 * custom endpoint URL
   * handy for inspecting/ratelimiting
   * `Norairrecord.base_url = "https://somewhere_else"`
+  * or `ENV['AIRTABLE_ENDPOINT_URL']`
 * custom UA
   * `Norairrecord.user_agent = "i'm the reason why you're getting 429s!"`
 * `Table#airtable_url`
@@ -51,4 +52,7 @@ stuff not in the OG:
 * `Norairrecord::RecordNotFoundError`
   * never again wonder if an error is because you goofed up an ID or you're getting ratelimited
 * `where` argument on `has_many` lookups
-* `Table#first`, `Table#first_where`
+* `Table#first`, `Table#first_where`
+* you're not gonna believe it:
+  * `Table.batch_`{update,upsert,create,save}
+  * makes ratelimits much less painful

data/lib/norairrecord/client.rb

@@ -16,7 +16,7 @@ module Norairrecord
 
     def connection
       @connection ||= Faraday.new(
-        url: Norairrecord.base_url || "https://api.airtable.com",
+        url: Norairrecord.base_url || ENV['AIRTABLE_ENDPOINT_URL'] || "https://api.airtable.com",
         headers: {
           "Authorization" => "Bearer #{api_key}",
           "User-Agent"    => Norairrecord.user_agent || "Airrecord (nora's version)/#{Norairrecord::VERSION}",

data/lib/norairrecord/table.rb

@@ -2,6 +2,8 @@ require 'rubygems' # For Gem::Version
 
 module Norairrecord
   class Table
+    BATCH_SIZE = 10
+
     class << self
       attr_writer :api_key, :base_key, :table_name
 
@@ -64,7 +66,7 @@ module Norairrecord
       def find_many(ids, where: nil, sort: nil)
         return [] if ids.empty?
 
-        or_args = ids.map { |id| "RECORD_ID() = '#{id}'"}.join(',')
+        or_args = ids.map { |id| "RECORD_ID() = '#{id}'" }.join(',')
         formula = "OR(#{or_args})"
         formula = "AND(#{formula},#{where})" if where
         records(filter: formula, sort:).sort_by { |record| or_args.index(record.id) }
@@ -87,7 +89,6 @@ module Norairrecord
         end
       end
 
-
       def create(fields, options = {})
         new(fields).tap { |record| record.save(options) }
       end
@@ -97,7 +98,7 @@ module Norairrecord
           clazz = self
           st = @subtype_mapping[fields[@subtype_column]]
           raise Norairrecord::UnknownTypeError, "#{fields[@subtype_column]}?????" if @subtype_strict && st.nil?
-          clazz =  Kernel.const_get(st) if st
+          clazz = Kernel.const_get(st) if st
           clazz.new(fields, id:, created_at:)
         else
           self.new(fields, id: id, created_at: created_at)
@@ -125,22 +126,19 @@ module Norairrecord
         parsed_response = client.parse(response.body)
 
         if response.success?
-          records = parsed_response["records"]
-          records.map! { |record|
-            self.new_with_subtype(record["fields"], id: record["id"], created_at: record["createdTime"])
-          }
+          records = map_new parsed_response["records"]
 
           if paginate && parsed_response["offset"]
             records.concat(records(
-              filter: filter,
-              sort: sort,
-              view: view,
-              paginate: paginate,
-              fields: fields,
-              offset: parsed_response["offset"],
-              max_records: max_records,
-              page_size: page_size,
-            ))
+                             filter: filter,
+                             sort: sort,
+                             view: view,
+                             paginate: paginate,
+                             fields: fields,
+                             offset: parsed_response["offset"],
+                             max_records: max_records,
+                             page_size: page_size,
+                           ))
           end
 
           records
@@ -161,10 +159,105 @@ module Norairrecord
         records(**options.merge(filter:))
       end
 
-      alias all records
-    end
+      def map_new(arr)
+        arr.map do |record|
+          self.new_with_subtype(record["fields"], id: record["id"], created_at: record["createdTime"])
+        end
+      end
+
+      def batch_update(recs, options = {})
+        res = []
+        recs.each_slice(BATCH_SIZE) do |chunk|
+          body = {
+            records: chunk.map do |record|
+              {
+                fields: record.update_hash,
+                id: record.id,
+              }
+            end,
+            **options
+          }.to_json
+
+          response = client.connection.patch("v0/#{base_key}/#{client.escape(table_name)}", body, { 'Content-Type' => 'application/json' })
+          parsed_response = client.parse(response.body)
+          if response.success?
+            res.concat(parsed_response["records"])
+          else
+            client.handle_error(response.status, parsed_response)
+          end
+        end
+        map_new res
+      end
+
+      def batch_upsert(recs, merge_fields, options = {}, include_ids: nil, hydrate: false)
+        merge_fields = Array(merge_fields) # allows passing in a single field
 
+        created, updated, records = [], [], []
 
+        recs.each_slice(BATCH_SIZE) do |chunk|
+          body = {
+            records: chunk.map { |rec| { fields: rec.fields, id: (include_ids ? rec.id : nil) }.compact },
+            **options,
+            performUpsert: { fieldsToMergeOn: merge_fields }
+          }.to_json
+
+          response = client.connection.patch("v0/#{base_key}/#{client.escape(table_name)}", body, { 'Content-Type' => 'application/json' })
+          parsed_response = response.success? ? client.parse(response.body) : client.handle_error(response.status, client.parse(response.body))
+
+          if response.success?
+            created.concat(parsed_response.fetch('createdRecords', []))
+            updated.concat(parsed_response.fetch('updatedRecords', []))
+            records.concat(parsed_response.fetch('records', []))
+          else
+            client.handle_error(response.status, parsed_response)
+          end
+        end
+
+        if hydrate && records.any?
+          record_hash = records.map { |record| [record["id"], self.new_with_subtype(record["fields"], id: record["id"], created_at: record["createdTime"])] }.to_h
+
+          created.map! { |id| record_hash[id] }.compact!
+          updated.map! { |id| record_hash[id] }.compact!
+          records = record_hash.values
+        end
+
+        { created:, updated:, records: }
+      end
+
+      def batch_create(recs, options = {})
+        records = []
+        recs.each_slice(BATCH_SIZE) do |chunk|
+          body = {
+            records: chunk.map { |record| { fields: record.serializable_fields } },
+            **options
+          }.to_json
+
+          response = client.connection.post("v0/#{base_key}/#{client.escape(table_name)}", body, { 'Content-Type' => 'application/json' })
+          parsed_response = client.parse(response.body)
+
+          if response.success?
+            records.concat(parsed_response["records"])
+          else
+            client.handle_error(response.status, parsed_response)
+          end
+        end
+        map_new records
+      end
+
+      def upsert(fields, merge_fields, options = {})
+        record = batch_upsert([self.new(fields)], merge_fields, options)&.dig(:records, 0)
+        record ? new(record) : nil
+      end
+
+      def batch_save(records)
+        res = []
+        to_be_created, to_be_updated = records.partition &:new_record?
+        res.concat(batch_create(to_be_created))
+        res.concat(batch_update(to_be_updated))
+      end
+
+      alias all records
+    end
 
     attr_reader :fields, :id, :created_at, :updated_keys
 
@@ -201,10 +294,10 @@ module Norairrecord
       fields[key] = value
     end
 
-    def patch(update_hash = {}, options = {})
-      update_hash.reject! { |key, value| @fields[key] == value }
-      return @fields if update_hash.empty? # don't hit AT if we don't have real changes
-      @fields.merge!(self.class.update(self.id, update_hash, options).reject { |key, _| updated_keys.include?(key) })
+    def patch(updates = {}, options = {})
+      updates.reject! { |key, value| @fields[key] == value }
+      return @fields if updates.empty? # don't hit AT if we don't have real changes
+      @fields.merge!(self.class.update(self.id, updates, options).reject { |key, _| updated_keys.include?(key) })
     end
 
     def create(options = {})
@@ -230,11 +323,13 @@ module Norairrecord
     def save(options = {})
       return create(options) if new_record?
       return true if @updated_keys.empty?
+      self.fields = self.class.update(self.id, self.update_hash, options)
+    end
 
-      update_hash = Hash[@updated_keys.map { |key|
+    def update_hash
+      Hash[@updated_keys.map { |key|
         [key, fields[key]]
       }]
-      self.fields = self.class.update(self.id, update_hash, options)
     end
 
     def destroy
@@ -255,7 +350,7 @@ module Norairrecord
     end
 
     def comment(text)
-      response = client.connection.post("v0/#{self.class.base_key}/#{client.escape(self.class.table_name)}/#{self.id}/comments", {text:}.to_json, { 'Content-Type' => 'application/json' })
+      response = client.connection.post("v0/#{self.class.base_key}/#{client.escape(self.class.table_name)}/#{self.id}/comments", { text: }.to_json, { 'Content-Type' => 'application/json' })
       parsed_response = client.parse(response.body)
 
       if response.success?
@@ -273,6 +368,7 @@ module Norairrecord
       self.class == other.class &&
         serializable_fields == other.serializable_fields
     end
+
     alias eql? ==
 
     def hash
@@ -283,7 +379,7 @@ module Norairrecord
     def transaction(&block)
       txn_updates = {}
 
-      singleton_class.alias_method :original_setter, :[]=
+      singleton_class.define_method(:original_setter, method(:[]=))
 
       define_singleton_method(:[]=) do |key, value|
         txn_updates[key] = value
@@ -301,13 +397,12 @@ module Norairrecord
       rescue => e
         raise
       ensure
-        singleton_class.alias_method :[]=, :original_setter
-        singleton_class.remove_method :original_setter
+        singleton_class.define_method(:[]=, method(:original_setter))
+        singleton_class.remove_method(:original_setter)
       end
       result
     end
 
-
     protected
 
     def fields=(fields)

data/lib/norairrecord/version.rb

@@ -1,3 +1,3 @@
 module Norairrecord
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: norairrecord
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - nora
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-24 00:00:00.000000000 Z
+date: 2025-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday