airtable_sync 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d1acb193baf36f2a13ce8a407f969b6e75069dd21fddf3ed25c40fc65e2eb82
-  data.tar.gz: de8d079498ae0dd3557818acbb86aa7428e0812f967169c34382e92b6fa940ca
+  metadata.gz: 57ef6a46048952c273adf2104f58df8f549228f92176ef1d640806553d233fdd
+  data.tar.gz: 12f22c78538055e00367a6e69d9eb7693c3f788f97483b38441581695eeec4d5
 SHA512:
-  metadata.gz: 6a07bb6c9ae37b887b3f636c6987e07a865a4cd71e4a29c63069671ae5e94d4553c20dc5fe5c0c7f13ba0bc66412cdeb0502f930192d07928dcbeb2207501bc0
-  data.tar.gz: 8880ccee15569c4215213143f2320dfc4d3f1886b3ffb8bf38cc44db96e9d1041b00ffaf5d49a6c8315a094fb278a357a58e8a7c44207156bc1e0a4ea581ac22
+  metadata.gz: 86f58cbd861fa04d2dce488ba1f850c264ea904ddd0e878fef7597eca4f1f6c0d53ef4c1ad200db2f3438c2f4d5f204bc63d7532cef0fdce7c6252704437fc14
+  data.tar.gz: 705ef73ead60b13d593e6927ae320a28d82f236c673e361e1377d27b156322e8eef19d65c24e4db37eba00746f29b1da877e6a9b2debe5961f0b9c57a8edd9ab

data/README.md

@@ -13,9 +13,12 @@ For the latest changes, see the [CHANGELOG.md](CHANGELOG.md).
 Add this line to your application's Gemfile:
 
 ```ruby
+gem 'airrecord', github: 'vfonic/airrecord'
 gem 'airtable_sync'
 ```
 
+We need to use airrecord fork because the original gem is unfortunately poorly maintained by AirTable and community and I don't have the resources to maintain it myself.
+
 And then execute:
 
 ```bash
@@ -30,17 +33,13 @@ bundle exec rails generate airtable_sync:install
 
 ## Usage
 
-1. Generate AirTable API key
-   https://airtable.com/create/apikey
-2.
-
 ### Configuration options
 
 In `config/initializers/airtable_sync.rb` you can specify configuration options:
 
-1. `api_key`
-2. `webflow_site_id`
-3. `skip_airtable_sync` - skip synchronization for different environments.
+1. `api_key` - In order to use this gem, you need to generate AirTable API key: https://airtable.com/create/apikey
+2. `airtable_base_id` - you can set `airtable_base_id` here or override `def airtable_base_id` in your model. More on this below.
+3. `skip_airtable_sync` - if set to `true`, AirtableSync will not sync records to AirTable. This is useful for development and test environments where you don't want to sync records to AirTable.
 
 Example:
 
@@ -51,6 +50,10 @@ AirtableSync.configure do |config|
 end
 ```
 
+### Create AirTable tables
+
+You need to create the AirTable base(s) and table(s) yourself.
+
 ### Add AirtableSync to models
 
 For each model that you want to sync to AirTable, you need to run the connection generator:
@@ -61,10 +64,6 @@ bundle exec rails generate airtable_sync:connection Article
 
 Please note that this _does not_ create the AirTable table. You need to already have it or create it manually.
 
-### Create AirTable tables
-
-As mentioned above, you need to create the AirTable tables yourself.
-
 ### Set `airtable_base_id`
 
 There are couple of ways how you can set the `airtable_base_id` to be used.
@@ -79,6 +78,20 @@ AirtableSync.configure do |config|
 end
 ```
 
+#### Set `airtable_base_id` in model
+
+```rb
+# app/models/article.rb
+
+class Article < ApplicationRecord
+  include AirtableSync::RecordSync
+
+  def airtable_base_id
+    site.airtable_base_id
+  end
+end
+```
+
 ### Customize fields to synchronize
 
 By default, AirtableSync calls `#as_airtable_json` on a record to get the fields that it needs to push to AirTable. `#as_airtable_json` simply calls `#as_json` in its default implementation. To change this behavior, you can override `#as_airtable_json` in your model:
@@ -122,10 +135,10 @@ For example:
 AirtableSync::CreateRecordJob.perform_now('articles', 1, 'Stories')
 ```
 
-Or, if you want to use the default 'articles' table name:
+Or, if you want to use the default 'Articles' table name:
 
 ```ruby
-AirtableSync::CreateRecordJob.perform_now('articles', 1)
+AirtableSync::CreateRecordJob.perform_now('articles', 1) # table_name defaults to 'Articles'
 ```
 
 ### Run the initial sync

data/lib/airtable_sync/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AirtableSync
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/lib/airtable_sync.rb

@@ -7,9 +7,3 @@ require 'airrecord'
 
 module AirtableSync
 end
-
-module Airrecord
-  class Client
-    def escape(*args) = ERB::Util.url_encode(*args)
-  end
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: airtable_sync
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Viktor
@@ -10,20 +10,6 @@ bindir: bin
 cert_chain: []
 date: 2023-02-28 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: airrecord
-  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: rails
   requirement: !ruby/object:Gem::Requirement