airtable2 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e76de7af1e8850fd762c839dcee996e5ce71e10c800548e991f80500da1c68d
-  data.tar.gz: 83ea6edb7e3a1473b1531f7dc3cee9273f6abdf2864e4c2bfa98051bd6667ea0
+  metadata.gz: 8f8968193253823a000c9f38c14185208b89a4dfd77d9ff6ab0a5b5f8b3f595e
+  data.tar.gz: 06c31cfbcc19f156ab7e498e7e6b6f9f0ca4b749aecb523124f85df7d8a452c2
 SHA512:
-  metadata.gz: 651355e1f16d59ed0c96ba2088c65824bc97c707cc1cf2d34967a13a399abf6ff1e00bd424c38bc2ce5efc24bb47e0594c24b2e3ae606940cb3311a4c4da5b77
-  data.tar.gz: b5e46f6aee0d721703feaa4f615f819ac433a64d5dd625297d8d12479032dd7bf940684ab3027ef65bcdabd9d1175399ecc4ad758dabaa68155a201cdbc05435
+  metadata.gz: 6bbbc8e341a9a16969df15e605d0e379138915066968abd3581b635d6bf66349526ae7f88d483384a5248f6f72c97f1f85d32e2a4a7e3e49c223f339d07cedc0
+  data.tar.gz: f8f0c2a7f3400519a07082a7c1640ae80947c7d4c4143d6b0d82e50068c01176d0f3aaeeeee392d9926647574f65185fc69382a147fa68b0bad4c2603dc2f59d

data/.yardopts

@@ -0,0 +1,5 @@
+-o docs 
+-r README.md 
+-q
+--protected 
+--private 

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,14 +41,20 @@ and its tables
 @tables = @base.tables
 ```
 
-and create a new table
+and a table's records, so you can navigate the has_many chain the way God intended:
 
 ```ruby
-@table = @base.create_table({ name: 'Names', description: 'A list of names', fields: [{ name: 'name', type: 'singleLineText' }] })
+@client.bases.first.tables.first.records.first
 ```
 
 ### Manipulating Tables
 
+Create a new table with:
+
+```ruby
+@table = @base.create_table({ name: 'Names', description: 'A list of names', fields: [{ name: 'name', type: 'singleLineText' }] })
+```
+
 You can update at a table's metadata with the `update` method:
 
 ```ruby
@@ -86,6 +92,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,6 +28,7 @@ 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.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/airtable/base.rb

@@ -3,12 +3,13 @@
 # Object corresponding to an Airtable Base
 class Airtable::Base < Airtable::Resource
   def initialize(token, id)
-    @token = token
+    super(token)
     @id = id
-    self.class.headers({ 'Authorization': "Bearer #{@token}", 'Content-Type': 'application/json' })
   end
 
   # Expects {name:,description:,fields:[]}
+  # @see https://airtable.com/developers/web/api/create-table
+  # @return [Airtable::Table]
   def create_table(table_data)
     response = self.class.post("#{base_url}/tables",
                                body: table_data.to_json).parsed_response
@@ -18,6 +19,8 @@ class Airtable::Base < Airtable::Resource
     Airtable::Table.new @token, @id, response
   end
 
+  # @see https://airtable.com/developers/web/api/get-base-schema
+  # @return [Array]<Airtable::Table>
   def tables
     response = self.class.get("#{base_url}/tables")
 
@@ -26,7 +29,14 @@ class Airtable::Base < Airtable::Resource
     response['tables'].map { Airtable::Table.new(@token, @id, _1) }
   end
 
+  # Instantiate table in base
+  # @return [Airtable::Table]
+  def table(table_id)
+    Airtable::Table.new(@token, @id, table_id)
+  end
+
   protected
 
+  # Endpoint for bases
   def base_url = "/v0/meta/bases/#{@id}"
 end

data/lib/airtable/client.rb

@@ -1,12 +1,38 @@
 # frozen_string_literal: true
 
 # Client carrying authorization token
-class Airtable::Client
-  def initialize(token)
-    @token = token
+class Airtable::Client < Airtable::Resource
+  # @see https://airtable.com/developers/web/api/list-bases
+  # @return [Array]<Airtable::Base>
+  def bases
+    response = self.class.get('/v0/meta/bases').parsed_response
+
+    check_and_raise_error(response)
+
+    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 base
+  # @return [Airtable::Base]
   def base(base_id)
     Airtable::Base.new(@token, base_id)
   end
+
+  # @see https://airtable.com/developers/web/api/get-user-id-scopes
+  # @return [Hash]
+  def whoami
+    response = self.class.get('/v0/meta/whoami').parsed_response
+
+    check_and_raise_error(response)
+
+    response
+  end
 end

data/lib/airtable/record.rb

@@ -5,12 +5,11 @@ class Airtable::Record < Airtable::Resource
   attr_reader :fields
 
   def initialize(token, base_id, table_id, api_response)
-    @token = token
+    super(token)
     @base_id = base_id
     @table_id = table_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' })
   end
 end

data/lib/airtable/resource.rb

@@ -13,6 +13,7 @@ class Airtable::Resource
     self.class.headers({ 'Authorization': "Bearer #{@token}", 'Content-Type': 'application/json' })
   end
 
+  # If API response is an error, raises an Airtable::Error with the error message
   def check_and_raise_error(response)
     response['error'] ? raise(Error, response['error']) : false
   end

data/lib/airtable/table.rb

@@ -5,14 +5,15 @@ class Airtable::Table < Airtable::Resource
   attr_reader :name
 
   def initialize(token, base_id, api_response)
-    @token = token
+    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' })
   end
 
+  # @see https://airtable.com/developers/web/api/list-records
+  # @return [Array<Airtable::Record>]
   def records
     response = self.class.get(table_url)
 
@@ -21,6 +22,14 @@ class Airtable::Table < Airtable::Resource
     response['records'].map { Airtable::Record.new(@token, @base_id, @table_id, _1) }
   end
 
+  # Instantiate record in table
+  # @return [Airtable::Table]
+  def record(record_id)
+    Airtable::Table.new(@token, @base_id, @id, record_id)
+  end
+
+  # @see https://airtable.com/developers/web/api/update-table
+  # @return [Airtable::Table]
   def update(table_data)
     response = self.class.patch("/v0/meta/bases/#{@base_id}/tables/#{@id}",
                                 body: table_data.to_json).parsed_response
@@ -30,7 +39,9 @@ class Airtable::Table < Airtable::Resource
     Airtable::Table.new @token, @base_id, response
   end
 
-  # limit 10 records
+  # @note API maximum of 10 records at a time
+  # @see https://airtable.com/developers/web/api/create-records
+  # @return [Array<Airtable::Record>]
   def add_records(records)
     response = self.class.post(table_url,
                                body: { records: Array(records).map { |fields| { fields: } } }.to_json).parsed_response
@@ -40,6 +51,9 @@ class Airtable::Table < Airtable::Resource
     response['records'].map { Airtable::Record.new(@token, @base_id, @id, _1) }
   end
 
+  # @note API maximum of 10 records at a time
+  # @see https://airtable.com/developers/web/api/delete-multiple-records
+  # @return [Array] Deleted record ids
   def delete_records(record_ids)
     params = Array(record_ids).compact.map { "records[]=#{_1}" }.join('&')
     response = self.class.delete("#{table_url}?#{params}").parsed_response
@@ -49,6 +63,7 @@ class Airtable::Table < Airtable::Resource
     record_ids
   end
 
+  # Deletes all table's records
   def dump
     records.map(&:id).each_slice(10) do |record_id_set|
       delete_records(record_id_set)
@@ -58,5 +73,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.0'
+  VERSION = '0.2.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: airtable2
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Andrew Seroff
@@ -10,44 +10,30 @@ 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'
+        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: json
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -55,7 +41,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -69,7 +55,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -83,7 +69,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -97,7 +83,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-md
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -111,7 +97,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-md
+  name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -125,7 +111,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-minitest
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -139,7 +125,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -175,6 +161,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".yardopts"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -188,9 +175,6 @@ 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
 homepage: https://github.com/aseroff/airtable-ruby
 licenses:
 - MIT
@@ -214,5 +198,5 @@ requirements: []
 rubygems_version: 3.5.21
 signing_key:
 specification_version: 4
-summary: Easily connect to airtable data using ruby
+summary: For when Airrecord is just too much.
 test_files: []

data/test/airtable_test.rb

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-
-describe Airtable do
-  before do
-    @client_key = '12345'
-    @app_key = 'appXXV84Qu'
-    @sheet_name = 'Test'
-  end
-
-  describe 'with Airtable' do
-    it 'should allow client to be created' do
-      @client = Airtable::Client.new(@client_key)
-
-      assert_kind_of Airtable::Client, @client
-      @table = @client.table(@app_key, @sheet_name)
-
-      assert_kind_of Airtable::Table, @table
-    end
-
-    it 'should fetch record set' do
-      stub_airtable_response!("https://api.airtable.com/v0/#{@app_key}/#{@sheet_name}",
-                              { 'records' => [], 'offset' => 'abcde' })
-      @table = Airtable::Client.new(@client_key).table(@app_key, @sheet_name)
-      @records = @table.records
-
-      assert_equal 'abcde', @records.offset
-    end
-
-    it 'should select records based on a formula' do
-      query_str = "OR(RECORD_ID() = 'recXYZ1', RECORD_ID() = 'recXYZ2', RECORD_ID() = 'recXYZ3', RECORD_ID() = 'recXYZ4')"
-      escaped_query = HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER.call(filterByFormula: query_str)
-      request_url = "https://api.airtable.com/v0/#{@app_key}/#{@sheet_name}?#{escaped_query}"
-      stub_airtable_response!(request_url, { 'records' => [] })
-      @table = Airtable::Client.new(@client_key).table(@app_key, @sheet_name)
-      @select_records = @table.select(formula: query_str)
-
-      assert_empty @select_records.records
-    end
-
-    it 'should raise an ArgumentError if a formula is not a string' do
-      stub_airtable_response!("https://api.airtable.com/v0/#{@app_key}/#{@sheet_name}",
-                              { 'records' => [], 'offset' => 'abcde' })
-      @table = Airtable::Client.new(@client_key).table(@app_key, @sheet_name)
-      _ { proc { @table.select(formula: { foo: 'bar' }) } }.must_raise ArgumentError
-    end
-
-    it 'should allow creating records' do
-      stub_airtable_response!("https://api.airtable.com/v0/#{@app_key}/#{@sheet_name}",
-                              { 'fields' => { 'name' => 'Sarah Jaine', 'email' => 'sarah@jaine.com', 'foo' => 'bar' }, 'id' => '12345' }, :post)
-      table = Airtable::Client.new(@client_key).table(@app_key, @sheet_name)
-      record = Airtable::Record.new(name: 'Sarah Jaine', email: 'sarah@jaine.com')
-      table.create(record)
-
-      assert_equal '12345', record['id']
-      assert_equal 'bar', record['foo']
-    end
-
-    it 'should allow updating records' do
-      record_id = '12345'
-      stub_airtable_response!("https://api.airtable.com/v0/#{@app_key}/#{@sheet_name}/#{record_id}",
-                              { 'fields' => { 'name' => 'Sarah Jaine', 'email' => 'sarah@jaine.com', 'foo' => 'bar' }, 'id' => record_id }, :put)
-      table = Airtable::Client.new(@client_key).table(@app_key, @sheet_name)
-      record = Airtable::Record.new(name: 'Sarah Jaine', email: 'sarah@jaine.com', id: record_id)
-      table.update(record)
-
-      assert_equal '12345', record['id']
-      assert_equal 'bar', record['foo']
-    end
-
-    it 'should raise an error when the API returns an error' do
-      stub_airtable_response!("https://api.airtable.com/v0/#{@app_key}/#{@sheet_name}",
-                              { 'error' => { 'type' => 'UNKNOWN_COLUMN_NAME', 'message' => 'Could not find fields foo' } }, :post, 422)
-      table = Airtable::Client.new(@client_key).table(@app_key, @sheet_name)
-      record = Airtable::Record.new(foo: 'bar')
-      assert_raises Airtable::Error do
-        table.create(record)
-      end
-    end
-  end
-end

data/test/record_test.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-
-describe Airtable do
-  describe Airtable::Record do
-    it 'should not return id in fields_for_update' do
-      record = Airtable::Record.new(name: 'Sarah Jaine', email: 'sarah@jaine.com', id: 12_345)
-      _(record.fields_for_update).wont_include(:id)
-    end
-
-    it 'returns new columns in fields_for_update' do
-      record = Airtable::Record.new(name: 'Sarah Jaine', email: 'sarah@jaine.com', id: 12_345)
-      record[:website] = 'http://sarahjaine.com'
-      _(record.fields_for_update).must_include(:website)
-    end
-
-    it 'returns fields_for_update in original capitalization' do
-      record = Airtable::Record.new('Name' => 'Sarah Jaine')
-      _(record.fields_for_update).must_include('Name')
-    end
-  end
-end

data/test/test_helper.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require 'airtable'
-require 'webmock/minitest'
-require 'minitest/pride'
-require 'minitest/autorun'
-
-def stub_airtable_response!(url, response, method = :get, status = 200)
-  stub_request(method, url)
-    .to_return(
-      body: response.to_json,
-      status: status,
-      headers: { 'Content-Type' => 'application/json' }
-    )
-end