airtable2 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8e76de7af1e8850fd762c839dcee996e5ce71e10c800548e991f80500da1c68d
+  data.tar.gz: 83ea6edb7e3a1473b1531f7dc3cee9273f6abdf2864e4c2bfa98051bd6667ea0
+SHA512:
+  metadata.gz: 651355e1f16d59ed0c96ba2088c65824bc97c707cc1cf2d34967a13a399abf6ff1e00bd424c38bc2ce5efc24bb47e0594c24b2e3ae606940cb3311a4c4da5b77
+  data.tar.gz: b5e46f6aee0d721703feaa4f615f819ac433a64d5dd625297d8d12479032dd7bf940684ab3027ef65bcdabd9d1175399ecc4ad758dabaa68155a201cdbc05435

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.vscode
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in airtable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2015 Nathan Esquenazi
+Copyright (c) 2016 Airtable
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,95 @@
+# Airtable API Wrapper for Ruby
+
+For when Airrecord is just too much.
+
+# Note on library status
+
+This is a fork of an abandoned [previous wrapper](https://github.com/nesquena/airtable-ruby). There's still plenty to do to get it up to speed with the current Airtable API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'airtable2', github: 'https://github.com/aseroff/airtable-ruby', branch: 'main'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### Creating a Client
+
+First, be sure to register for an [airtable](https://airtable.com) account,  setup a base, and create a token with the desired permissions for your base. Now, setup your Airtable client:
+
+```ruby
+# Pass in api key to client
+@client = Airtable::Client.new('your.token.goes.here')
+```
+
+### Accessing Data
+
+Now we can access our base
+
+```ruby
+@base = @client.base('appExAmPlE')
+```
+
+and its tables
+
+```ruby
+@tables = @base.tables
+```
+
+and create a new table
+
+```ruby
+@table = @base.create_table({ name: 'Names', description: 'A list of names', fields: [{ name: 'name', type: 'singleLineText' }] })
+```
+
+### Manipulating Tables
+
+You can update at a table's metadata with the `update` method:
+
+```ruby
+@table.update({ description: 'Updated description' })
+```
+
+### Querying Records
+
+Once you have access to a table from above, we can query a set of records in the table with:
+
+```ruby
+@records = @table.records
+```
+
+### 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):
+
+```ruby
+@table.add_records({ 'Name': 'name value', 'Age': 35 })
+```
+
+### Deleting Records
+
+A single record or an array of records can be destroyed by passing their ids to the `delete_records` method on a table:
+
+```ruby
+@record = @table.records[0]
+@table.delete_records(@record.id)
+```
+
+Or as a convenience, you can delete all records with the `dump` method
+
+```ruby
+@table.dump
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/aseroff/airtable-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
+end

data/airtable.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'airtable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'airtable2'
+  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.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.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_development_dependency 'bundler'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-md'
+  spec.add_development_dependency 'rubocop-minitest'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'webmock'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/airtable/base.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Object corresponding to an Airtable Base
+class Airtable::Base < Airtable::Resource
+  def initialize(token, id)
+    @token = token
+    @id = id
+    self.class.headers({ 'Authorization': "Bearer #{@token}", 'Content-Type': 'application/json' })
+  end
+
+  # Expects {name:,description:,fields:[]}
+  def create_table(table_data)
+    response = self.class.post("#{base_url}/tables",
+                               body: table_data.to_json).parsed_response
+
+    check_and_raise_error(response)
+
+    Airtable::Table.new @token, @id, response
+  end
+
+  def tables
+    response = self.class.get("#{base_url}/tables")
+
+    check_and_raise_error(response)
+
+    response['tables'].map { Airtable::Table.new(@token, @id, _1) }
+  end
+
+  protected
+
+  def base_url = "/v0/meta/bases/#{@id}"
+end

data/lib/airtable/client.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Client carrying authorization token
+class Airtable::Client
+  def initialize(token)
+    @token = token
+  end
+
+  def base(base_id)
+    Airtable::Base.new(@token, base_id)
+  end
+end

data/lib/airtable/error.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Error class
+class Airtable::Error < StandardError
+  attr_reader :message, :type
+
+  # {"error"=>{"type"=>"UNKNOWN_COLUMN_NAME", "message"=>"Could not find fields foo"}}
+
+  def initialize(error_hash)
+    @message = error_hash['message']
+    @type = error_hash['type']
+    super(@message)
+  end
+end

data/lib/airtable/record.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# 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
+    @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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Base class for authorized resources sending network requests
+class Airtable::Resource
+  include HTTParty
+  base_uri 'https://api.airtable.com'
+  # debug_output $stdout
+
+  attr_reader :id, :token
+
+  def initialize(token)
+    @token = token
+    self.class.headers({ 'Authorization': "Bearer #{@token}", 'Content-Type': 'application/json' })
+  end
+
+  def check_and_raise_error(response)
+    response['error'] ? raise(Error, response['error']) : false
+  end
+end

data/lib/airtable/table.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# Object corresponding to an Airtable Table
+class Airtable::Table < Airtable::Resource
+  attr_reader :name
+
+  def initialize(token, base_id, api_response)
+    @token = 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
+
+  def records
+    response = self.class.get(table_url)
+
+    check_and_raise_error(response)
+
+    response['records'].map { Airtable::Record.new(@token, @base_id, @table_id, _1) }
+  end
+
+  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
+  end
+
+  # limit 10 records
+  def add_records(records)
+    response = self.class.post(table_url,
+                               body: { records: Array(records).map { |fields| { fields: } } }.to_json).parsed_response
+
+    check_and_raise_error(response)
+
+    response['records'].map { Airtable::Record.new(@token, @base_id, @id, _1) }
+  end
+
+  def delete_records(record_ids)
+    params = Array(record_ids).compact.map { "records[]=#{_1}" }.join('&')
+    response = self.class.delete("#{table_url}?#{params}").parsed_response
+
+    check_and_raise_error(response)
+
+    record_ids
+  end
+
+  def dump
+    records.map(&:id).each_slice(10) do |record_id_set|
+      delete_records(record_id_set)
+      sleep(0.2)
+    end
+  end
+
+  protected
+
+  def table_url = "/v0/#{@base_id}/#{@id}"
+end

data/lib/airtable/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# Version
+module Airtable
+  VERSION = '0.2.0'
+end

data/lib/airtable.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require 'delegate'
+require 'active_support/core_ext/hash'
+require 'json'
+
+require 'airtable/version'
+require 'airtable/resource'
+require 'airtable/record'
+require 'airtable/table'
+require 'airtable/base'
+require 'airtable/client'
+require 'airtable/error'

data/test/airtable_test.rb

@@ -0,0 +1,82 @@
+# 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

@@ -0,0 +1,23 @@
+# 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

@@ -0,0 +1,15 @@
+# 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

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: airtable2
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Andrew Seroff
+- Nathan Esquenazi
+- Alexander Sorokin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-26 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-md
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easily connect to airtable data using ruby with access to all of the
+  airtable features.
+email:
+- andy@seroff.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- airtable.gemspec
+- lib/airtable.rb
+- lib/airtable/base.rb
+- lib/airtable/client.rb
+- lib/airtable/error.rb
+- lib/airtable/record.rb
+- 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
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.21
+signing_key:
+specification_version: 4
+summary: Easily connect to airtable data using ruby
+test_files: []