norairrecord 0.1.4 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 910e4c4f488a1f1fb996144d7bc2bd023eca3d386681937af92c337d8f8e2b26
-  data.tar.gz: 55979229a04ec5ad233f49d2858b1179af6c47dc0eaf3c7f260cc808f55083d9
+  metadata.gz: d2413a6757fd7aa66b83507ab161d8305bd233b29739652cc0c05302df835ed0
+  data.tar.gz: 468978e1acae10b550e887affa319a24a6fa4a41ab6200b0193d36866d31364c
 SHA512:
-  metadata.gz: 80beee3c36c56253974af2053e669df452f0d4af0ff5ad88b05eabf2afc7673706848563d57b298a7565a88fa831700d77325b46300e48351a0607e7753d87a0
-  data.tar.gz: 66f75e0a29877db15f9463ae95f65a3b2521f623c0ffa45bf3ddbfb261ff5f67b049d5df68d1f58fcaa21e14988918ecefe4d53d9fab0fcae4c3371a556ab690
+  metadata.gz: 26ee966a87a85da8c545c9ab8a49c6d654dd2fdb33891e21954b13eedbd1041c9a18e03ba06cf903a7930800166cbb8d7906db3c20ad8ea6dc92d5e250e7f68a
+  data.tar.gz: 696a61147478f307b86e7adceb7464ccbc1a023756a076feadc4240f27e6e2482ea9289c47b38e9995e255df20f66da16b1a675e4599baf41a54e04bc58acb01

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`
@@ -48,3 +49,7 @@ stuff not in the OG:
     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

@@ -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}",
@@ -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
@@ -54,12 +61,13 @@ module Norairrecord
         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 = {})
@@ -140,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.
@@ -260,7 +283,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
@@ -278,8 +301,8 @@ 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

data/lib/norairrecord/version.rb

@@ -1,3 +1,3 @@
 module Norairrecord
-  VERSION = "0.1.4"
+  VERSION = "0.2.1"
 end

data/lib/norairrecord.rb

@@ -11,7 +11,8 @@ module Norairrecord
   attr_accessor :api_key, :throttle, :base_url, :user_agent
 
   Error = Class.new(StandardError)
-  UnknownTypeError = 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.4
+  version: 0.2.1
 platform: ruby
 authors:
 - nora
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-06 00:00:00.000000000 Z
+date: 2025-02-03 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: []