norairrecord 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad051cbba9546de977583acfa8a41c9eab049dd1c1e269d65147f8973b18b84c
-  data.tar.gz: e1b5e0c786361909da7c5eadea74b91331d4ab8ac92b9386719f4f240c811996
+  metadata.gz: a5f9d1c3992d715d55a1308918a574a00b83042da2e58bfbcc9389ff51e0b6cd
+  data.tar.gz: d4372b35b219e5ffd6384c42e3687dd9019dabbb48d8bb622d395eb8aadab90a
 SHA512:
-  metadata.gz: e4dd0a771cd5f112f114753952e7ca36ca7299762de4b12f66ad931154019bc47a58b50d2cecfabd74a1393b74133d808e9e6ef9caa957a20535dfcf6d97b58b
-  data.tar.gz: 59e4fec79c29e4d94a3e3a0fc18c83d22db0983aaca2d5a02b8fb946950c501be9521e944a7da7ce475184e697f471275961e47b35c8b2e4b74e6c7c4da79b78
+  metadata.gz: 0fdcca5fc8ee492d692fe1271d60052d82ddf4c18ff4ec275e464cf9871dd52cf9996e393ac01292bc780a31dc0681c92af1485282e6b11138fea35957ae1b18
+  data.tar.gz: f023f648cb134d4de8c0773fd1a2d0882393ea7109af105f2cd9b23fde4d1eeb9d519ee695ac341912a191d3d6a3b6b946efb3d7c8bc6d60ecdaf387dacfcef5

data/README.md

@@ -29,4 +29,26 @@ stuff not in the OG:
 * custom UA
   * `Norairrecord.user_agent = "i'm the reason why you're getting 429s!"`
 * `Table#airtable_url`
-  * what it says on the tin!
+  * what it says on the tin!
+* `Table.has_subtypes`
+  * hokay so: 
+  * ```ruby
+    class Friend < Norairrecord::Table
+      # base_key/table_name, etc...
+      has_subtypes "type", { # based on 'type' column...
+        "person" => "Person", # when 'person' instantiate record as Person 
+        "shark" => "Shark"
+      }, strict: true # if strict, unmapped types will raise UnknownTypeError
+      # otherwise they will be instantiated as the base class
+    end
+
+    class Person < Friend; end
+    class Shark < Friend; end
+    
+    Friend.all
+    => [<Person>, <Person>, <Shark>]
+    ```
+* `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`

data/lib/norairrecord/client.rb

@@ -40,6 +40,7 @@ module Norairrecord
     end
 
     def handle_error(status, error)
+      raise RecordNotFoundError if status == 404
       if error.is_a?(Hash) && error['error']
         raise Error, "HTTP #{status}: #{error['error']['type']}: #{error['error']['message']}"
       else

data/lib/norairrecord/table.rb

@@ -3,8 +3,15 @@ require 'rubygems' # For Gem::Version
 module Norairrecord
   class Table
     class << self
-      attr_accessor :base_key, :table_name
-      attr_writer :api_key
+      attr_writer :api_key, :base_key, :table_name
+
+      def base_key
+        @base_key || (superclass < Table ? superclass.base_key : nil)
+      end
+
+      def table_name
+        @table_name || (superclass < Table ? superclass.table_name : nil)
+      end
 
       def client
         @@clients ||= {}
@@ -16,12 +23,12 @@ module Norairrecord
       end
 
       def has_many(method_name, options)
-        define_method(method_name.to_sym) do
+        define_method(method_name.to_sym) do |where: nil, sort: nil|
           # Get association ids in reverse order, because Airtable's UI and API
           # sort associations in opposite directions. We want to match the UI.
           ids = (self[options.fetch(:column)] || []).reverse
           table = Kernel.const_get(options.fetch(:class))
-          return table.find_many(ids) unless options[:single]
+          return table.find_many(ids, sort:, where:) unless options[:single]
 
           (id = ids.first) ? table.find(id) : nil
         end
@@ -37,23 +44,30 @@ module Norairrecord
 
       alias has_one belongs_to
 
+      def has_subtypes(column, mapping, strict: false)
+        @subtype_column = column
+        @subtype_mapping = mapping
+        @subtype_strict = strict
+      end
+
       def find(id)
         response = client.connection.get("v0/#{base_key}/#{client.escape(table_name)}/#{id}")
         parsed_response = client.parse(response.body)
 
         if response.success?
-          self.new(parsed_response["fields"], id: id, created_at: parsed_response["createdTime"])
+          self.new_with_subtype(parsed_response["fields"], id: id, created_at: parsed_response["createdTime"])
         else
           client.handle_error(response.status, parsed_response)
         end
       end
 
-      def find_many(ids)
+      def find_many(ids, where: nil, sort: nil)
         return [] if ids.empty?
 
         or_args = ids.map { |id| "RECORD_ID() = '#{id}'"}.join(',')
         formula = "OR(#{or_args})"
-        records(filter: formula).sort_by { |record| or_args.index(record.id) }
+        formula = "AND(#{formula},#{where})" if where
+        records(filter: formula, sort:).sort_by { |record| or_args.index(record.id) }
       end
 
       def update(id, update_hash = {}, options = {})
@@ -78,6 +92,18 @@ module Norairrecord
         new(fields).tap { |record| record.save(options) }
       end
 
+      def new_with_subtype(fields, id:, created_at:)
+        if @subtype_column
+          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.new(fields, id:, created_at:)
+        else
+          self.new(fields, id: id, created_at: created_at)
+        end
+      end
+
       def records(filter: nil, sort: nil, view: nil, offset: nil, paginate: true, fields: nil, max_records: nil, page_size: nil)
         options = {}
         options[:filterByFormula] = filter if filter
@@ -100,8 +126,8 @@ module Norairrecord
 
         if response.success?
           records = parsed_response["records"]
-          records = records.map { |record|
-            self.new(record["fields"], id: record["id"], created_at: record["createdTime"])
+          records.map! { |record|
+            self.new_with_subtype(record["fields"], id: record["id"], created_at: record["createdTime"])
           }
 
           if paginate && parsed_response["offset"]
@@ -122,9 +148,24 @@ module Norairrecord
           client.handle_error(response.status, parsed_response)
         end
       end
+
+      def first(options = {})
+        records(**options.merge(max_records: 1)).first
+      end
+
+      def first_where(filter, options = {})
+        first(options.merge(filter:))
+      end
+
+      def where(filter, options = {})
+        records(**options.merge(filter:))
+      end
+
       alias all records
     end
 
+
+
     attr_reader :fields, :id, :created_at, :updated_keys
 
     # This is an awkward definition for Ruby 3 to remain backwards compatible.

data/lib/norairrecord/version.rb

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

data/lib/norairrecord.rb

@@ -11,6 +11,8 @@ module Norairrecord
   attr_accessor :api_key, :throttle, :base_url, :user_agent
 
   Error = Class.new(StandardError)
+  UnknownTypeError = Class.new(Error)
+  RecordNotFoundError = Class.new(Error)
 
   def throttle?
     return true if @throttle.nil?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: norairrecord
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - nora
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-06 00:00:00.000000000 Z
+date: 2025-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -113,7 +113,7 @@ homepage: https://github.com/24c02/norairrecord
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -129,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.16
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Airtable client
 test_files: []