airtable2 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fb935ffab4d6e71ec8d1d5b2dc3d333e8e594694efa066cdfb5b9cc2bc127c6
-  data.tar.gz: 5df0a4d75e41a62e7e37083ebe86a8a907424bdc07b85415fd3322ee97c31564
+  metadata.gz: 32bae2cc155c84b948c193c8ea5677288ea7123aeded90f6e6121ba196d0a4c7
+  data.tar.gz: 8efc8479bf004389e25aee1bdc8b88b60dfbc395078dfa4935f4a65afa93bbe4
 SHA512:
-  metadata.gz: c685dbee77e83356da763e04a4d21cd9045f590790fa1a07a3311fffa5e57f35a46c6ccad9a48763dcf42a6b056ab71421ff8303853f8e50f12e08ea6b03ed50
-  data.tar.gz: 2a4ca8fc25b2dd248c36f5256ce3c7d57d087ada7048aa41276b20e7deb058e79e60800bcd30b71fe421dfe149fa28038b6240f3f078163c0a0367ef2ca4a0d7
+  metadata.gz: 9f0993c56aa18abf1fc80089ebf8b08d377ff70476c04b4df619dd6637a4439bf034a0af2b8f90660244464ceeefc137fd836cd99493b00415ea7108cead000b
+  data.tar.gz: b1b30151a67ff2ce1f2eb479327ef1a959fa4ca9d671ecd33553d3a75c746f1193010e5d3e1ab457cfbd3ca9e25d385a2c85cc5d850e1a3b2766ddfd65160647

data/README.md

@@ -10,7 +10,7 @@ This is a fork of an abandoned [previous wrapper](https://github.com/nesquena/ai
 
 Add this line to your application's Gemfile:
 
-    gem 'airtable2', github: 'https://github.com/aseroff/airtable-ruby', branch: 'main'
+    gem 'airtable2'
 
 And then execute:
 
@@ -41,12 +41,15 @@ and its tables
 @tables = @base.tables
 ```
 
-and a table's records, so you can navigate the has_many chain the way God intended:
+and a table's records, so you can navigate the belongs_to/has_many relationships the way God intended:
 
 ```ruby
-@client.bases.first.tables.first.records.first
+@record = @client.bases.first.tables.first.records.first
+@base = @record.table.base
 ```
 
+Note that objects' child records are memoized to avoid unnecessary API calls. If sensitive to stale data, be sure to use the objects instantiated most recently.
+
 ### Manipulating Tables
 
 Create a new table with:
@@ -71,10 +74,10 @@ Once you have access to a table from above, we can query a set of records in the
 
 ### Inserting Records
 
-A single record or an array of records can be inserted using the `add_records` method on a table (max 10 at a time):
+A single record or an array of records can be inserted using the `create_records` method on a table (max 10 at a time):
 
 ```ruby
-@table.add_records({ 'Name': 'name value', 'Age': 35 })
+@table.create_records({ 'Name': 'name value', 'Age': 35 })
 ```
 
 ### Deleting Records
@@ -92,6 +95,10 @@ Or as a convenience, you can delete all records with the `dump` method
 @table.dump
 ```
 
+## Complete documentation
+
+YARD-generated documentation is hosted on [GitHub Pages](https://aseroff.github.io/airtable-ruby/).
+
 ## Contributing
 
 1. Fork it ( https://github.com/aseroff/airtable-ruby/fork )

data/airtable.gemspec

@@ -9,19 +9,17 @@ Gem::Specification.new do |spec|
   spec.version       = Airtable::VERSION
   spec.authors       = ['Andrew Seroff', 'Nathan Esquenazi', 'Alexander Sorokin']
   spec.email         = ['andy@seroff.co']
-  spec.summary       = 'Easily connect to airtable data using ruby'
+  spec.summary       = 'For when Airrecord is just too much.'
   spec.description   = 'Easily connect to airtable data using ruby with access to all of the airtable features.'
   spec.homepage      = 'https://github.com/aseroff/airtable-ruby'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0")
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(docs|test)/}) }
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 3.1'
-  spec.add_dependency 'activesupport'
-  spec.add_dependency 'httparty'
-  spec.add_dependency 'json'
+  spec.add_dependency 'httparty', '>= 0.14.0'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'minitest'
@@ -30,7 +28,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-md'
   spec.add_development_dependency 'rubocop-minitest'
   spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rake'
   spec.add_development_dependency 'webmock'
-  spec.add_development_dependency 'yard'
+
   spec.metadata['rubygems_mfa_required'] = 'true'
+  spec.metadata['github_repo'] = 'ssh://github.com/aseroff/airtable-ruby'
 end

data/lib/airtable/base.rb

@@ -2,15 +2,15 @@
 
 # Object corresponding to an Airtable Base
 class Airtable::Base < Airtable::Resource
-  def initialize(token, id)
-    @token = token
+  def initialize(token, id, tables = nil)
+    super(token)
     @id = id
-    self.class.headers({ 'Authorization': "Bearer #{@token}", 'Content-Type': 'application/json' })
+    @tables = tables
   end
 
-  # Expects {name:,description:,fields:[]}
-  # @see https://airtable.com/developers/web/api/create-table
+  # @param table_data [Hash] Payload for table creation. Expects {name:,description:,fields:[]}
   # @return [Airtable::Table]
+  # @see https://airtable.com/developers/web/api/create-table
   def create_table(table_data)
     response = self.class.post("#{base_url}/tables",
                                body: table_data.to_json).parsed_response
@@ -20,17 +20,20 @@ class Airtable::Base < Airtable::Resource
     Airtable::Table.new @token, @id, response
   end
 
+  # @return [Array<Airtable::Table>]
   # @see https://airtable.com/developers/web/api/get-base-schema
-  # @return [Array]<Airtable::Table>
   def tables
-    response = self.class.get("#{base_url}/tables")
+    @tables ||= begin
+      response = self.class.get("#{base_url}/tables")
 
-    check_and_raise_error(response)
+      check_and_raise_error(response)
 
-    response['tables'].map { Airtable::Table.new(@token, @id, _1) }
+      response['tables'].map { Airtable::Table.new(@token, @id, _1['id'], _1) }
+    end
   end
 
   # Instantiate table in base
+  # @param table_id [String] ID of table
   # @return [Airtable::Table]
   def table(table_id)
     Airtable::Table.new(@token, @id, table_id)
@@ -38,6 +41,6 @@ class Airtable::Base < Airtable::Resource
 
   protected
 
-  # Instantiate table in base
+  # Endpoint for bases
   def base_url = "/v0/meta/bases/#{@id}"
 end

data/lib/airtable/client.rb

@@ -2,13 +2,8 @@
 
 # Client carrying authorization token
 class Airtable::Client < Airtable::Resource
-  def initialize(token)
-    @token = token
-    self.class.headers({ 'Authorization': "Bearer #{@token}", 'Content-Type': 'application/json' })
-  end
-
+  # @return [Array<Airtable::Base>]
   # @see https://airtable.com/developers/web/api/list-bases
-  # @return [Array]<Airtable::Base>
   def bases
     response = self.class.get('/v0/meta/bases').parsed_response
 
@@ -17,22 +12,22 @@ class Airtable::Client < Airtable::Resource
     response['bases'].map { Airtable::Base.new(@token, _1['id']) }
   end
 
-  # @see https://airtable.com/developers/web/api/create-base
-  # def create_base(base_data)
-  #   response = self.class.post('/v0/meta/bases'
-  #                              body: base_data.to_json).parsed_response
-  #   check_and_raise_error(response)
-  #   Airtable::Base.new @token, response
-  # end
+  # Instantiate workspace
+  # @param workspace_id [String] ID of workspace
+  # @return [Airtable::Workspace]
+  def workspace(workspace_id)
+    Airtable::Workspace.new(@token, workspace_id)
+  end
 
   # Instantiate base
+  # @param base_id [String] ID of base
   # @return [Airtable::Base]
   def base(base_id)
     Airtable::Base.new(@token, base_id)
   end
 
+  # @return [Hash] User's data based on token
   # @see https://airtable.com/developers/web/api/get-user-id-scopes
-  # @return [Hash]
   def whoami
     response = self.class.get('/v0/meta/whoami').parsed_response
 

data/lib/airtable/record.rb

@@ -2,15 +2,44 @@
 
 # Object corresponding to an Airtable Record
 class Airtable::Record < Airtable::Resource
-  attr_reader :fields
-
-  def initialize(token, base_id, table_id, api_response)
-    @token = token
+  def initialize(token, base_id, table_id, id, data = nil)
+    super(token)
     @base_id = base_id
     @table_id = table_id
-    api_response.deep_symbolize_keys.each do |key, value|
-      instance_variable_set(:"@#{key}", value)
+    @id = id
+    @data = data
+  end
+
+  # Return record data, retrieve if not present
+  # @return [Hash]
+  # @see https://airtable.com/developers/web/api/get-record
+  def data
+    @data ||= begin
+      response = self.class.get(record_url).parsed_response
+
+      check_and_raise_error(response)
+
+      response
     end
-    self.class.headers({ 'Authorization': "Bearer #{@token}", 'Content-Type': 'application/json' })
   end
+
+  # Instantiate record's table
+  # @return [Airtable::Table]
+  def table = Airtable::Table.new(token, @base_id, @table_id)
+
+  # @return [Airtable::Record]
+  # @see https://airtable.com/developers/web/api/update-record
+  def update(record_data)
+    response = self.class.patch(record_url,
+                                body: { fields: record_data }.to_json).parsed_response
+
+    check_and_raise_error(response)
+
+    Airtable::Record.new @token, @base_id, @table_id, response['id'], response
+  end
+
+  protected
+
+  # Endpoint for records
+  def record_url = "/v0/#{@base_id}/#{@table_id}/#{@id}"
 end

data/lib/airtable/table.rb

@@ -4,46 +4,55 @@
 class Airtable::Table < Airtable::Resource
   attr_reader :name
 
-  def initialize(token, base_id, api_response)
-    @token = token
+  def initialize(token, base_id, id, data = nil)
+    super(token)
     @base_id = base_id
-    api_response.deep_symbolize_keys.each do |key, value|
-      instance_variable_set(:"@#{key}", value)
-    end
-    self.class.headers({ 'Authorization': "Bearer #{@token}", 'Content-Type': 'application/json' })
+    @id = id
+    @data = data
   end
 
-  # @see https://airtable.com/developers/web/api/list-records
+  # Return table model, retrieve if not present
+  # @return [Hash]
+  # @see https://airtable.com/developers/web/api/get-base-schema
+  def data = @data ||= base.tables.find { _1.id == @id }.data
+
+  # Instantiate table's base
+  # @return [Airtable::Base]
+  def base = Airtable::Base.new(token, @base_id)
+
   # @return [Array<Airtable::Record>]
+  # @see https://airtable.com/developers/web/api/list-records
   def records
-    response = self.class.get(table_url)
+    @records ||= begin
+      response = self.class.get(table_url)
 
-    check_and_raise_error(response)
+      check_and_raise_error(response)
 
-    response['records'].map { Airtable::Record.new(@token, @base_id, @table_id, _1) }
+      response['records'].map { Airtable::Record.new(@token, @base_id, @id, _1['id'], _1) }
+    end
   end
 
   # Instantiate record in table
-  # @return [Airtable::Table]
-  def record(record_id)
-    Airtable::Table.new(@token, @base_id, @id, record_id)
-  end
+  # @param record_id [String] ID of record
+  # @return [Airtable::Record]
+  def record(record_id) = Airtable::Record.new(@token, @base_id, @id, record_id)
 
-  # @see https://airtable.com/developers/web/api/update-table
   # @return [Airtable::Table]
+  # @see https://airtable.com/developers/web/api/update-table
   def update(table_data)
     response = self.class.patch("/v0/meta/bases/#{@base_id}/tables/#{@id}",
                                 body: table_data.to_json).parsed_response
 
     check_and_raise_error(response)
 
-    Airtable::Table.new @token, @base_id, response
+    Airtable::Table.new @token, @base_id, response['id'], response
   end
 
-  # @note API maximum of 10 records at a time
-  # @see https://airtable.com/developers/web/api/create-records
+  # @param [Array] Record objects to create
   # @return [Array<Airtable::Record>]
-  def add_records(records)
+  # @see https://airtable.com/developers/web/api/create-records
+  # @note API maximum of 10 records at a time
+  def create_records(records)
     response = self.class.post(table_url,
                                body: { records: Array(records).map { |fields| { fields: } } }.to_json).parsed_response
 
@@ -52,8 +61,10 @@ class Airtable::Table < Airtable::Resource
     response['records'].map { Airtable::Record.new(@token, @base_id, @id, _1) }
   end
 
-  # @see https://airtable.com/developers/web/api/delete-multiple-records
+  # @param [Array] IDs of records to delete
   # @return [Array] Deleted record ids
+  # @see https://airtable.com/developers/web/api/delete-multiple-records
+  # @note API maximum of 10 records at a time
   def delete_records(record_ids)
     params = Array(record_ids).compact.map { "records[]=#{_1}" }.join('&')
     response = self.class.delete("#{table_url}?#{params}").parsed_response
@@ -73,5 +84,6 @@ class Airtable::Table < Airtable::Resource
 
   protected
 
+  # Endpoint for tables
   def table_url = "/v0/#{@base_id}/#{@id}"
 end

data/lib/airtable/version.rb

@@ -2,5 +2,5 @@
 
 # Version
 module Airtable
-  VERSION = '0.2.1'
+  VERSION = '0.2.3'
 end

data/lib/airtable/workspace.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Object corresponding to an Airtable Workspace
+class Airtable::Workspace < Airtable::Resource
+  def initialize(token, id)
+    super(token)
+    @id = id
+  end
+
+  # @param base_data [Hash] Payload for base
+  # @see https://airtable.com/developers/web/api/create-base
+  def create_base(base_data)
+    response = self.class.post('/v0/meta/bases',
+                               body: base_data.merge({ workspaceId: @id }).to_json).parsed_response
+
+    check_and_raise_error(response)
+
+    Airtable::Base.new @token, response
+  end
+end

data/lib/airtable.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 require 'httparty'
-require 'delegate'
-require 'active_support/core_ext/hash'
 require 'json'
 
 require 'airtable/version'
@@ -10,5 +8,6 @@ require 'airtable/resource'
 require 'airtable/record'
 require 'airtable/table'
 require 'airtable/base'
+require 'airtable/workspace'
 require 'airtable/client'
 require 'airtable/error'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: airtable2
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Andrew Seroff
@@ -10,50 +10,22 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-26 00:00:00.000000000 Z
+date: 2024-10-28 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -153,7 +125,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -167,7 +139,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -195,27 +167,6 @@ files:
 - README.md
 - Rakefile
 - airtable.gemspec
-- docs/Airtable.html
-- docs/Airtable/Base.html
-- docs/Airtable/Client.html
-- docs/Airtable/Error.html
-- docs/Airtable/Record.html
-- docs/Airtable/Resource.html
-- docs/Airtable/Table.html
-- docs/_index.html
-- docs/class_list.html
-- docs/css/common.css
-- docs/css/full_list.css
-- docs/css/style.css
-- docs/file.README.html
-- docs/file_list.html
-- docs/frames.html
-- docs/index.html
-- docs/js/app.js
-- docs/js/full_list.js
-- docs/js/jquery.js
-- docs/method_list.html
-- docs/top-level-namespace.html
 - lib/airtable.rb
 - lib/airtable/base.rb
 - lib/airtable/client.rb
@@ -224,14 +175,13 @@ files:
 - lib/airtable/resource.rb
 - lib/airtable/table.rb
 - lib/airtable/version.rb
-- test/airtable_test.rb
-- test/record_test.rb
-- test/test_helper.rb
+- lib/airtable/workspace.rb
 homepage: https://github.com/aseroff/airtable-ruby
 licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
+  github_repo: ssh://github.com/aseroff/airtable-ruby
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -247,8 +197,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.21
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
-summary: Easily connect to airtable data using ruby
+summary: For when Airrecord is just too much.
 test_files: []