jekyll-airtable-import 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9505b58d83a93712ea299e2229c7029cf01fae5016067ea0be813e22d360e436
+  data.tar.gz: 1aa60367ee33d8c53bdbb4cf1023a315ec07a1b98fa0fd3b95428666d71a1bb4
+SHA512:
+  metadata.gz: '070952fd2c85015fc5900fb36c72d40dbbeeb4a6857ece1439bd55929f4749eba6886496eff59c152f1d09fec4760110057bcadf966a42a7519e687ddda68a30'
+  data.tar.gz: 288d0adde99cb70f6de980f76b9419e6ba1b0a1125c20afab87e04ffc32cbde59b45b26b61ecc342c241c454720d6013ddc11a18669fa3e7661ae6bcf5eba330

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 joe-irving
+
+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,108 @@
+# Jekyll Airtable importer
+
+A simple plugin that used the [Airtable gem](https://rubygems.org/gems/airtable)
+create data or collections in Jekyll.
+
+## Installation
+
+Add `gem "jekyll-airtable-import"` to your Jekyll sites Gemfile, under the
+plugins group like so:
+
+```ruby
+# If you have any plugins, put them here!
+group :jekyll_plugins do
+  gem "jekyll-airtable-import"
+end
+```
+
+## Configuration
+
+To configure your Jekyll site to import from Airtable:
+
+### 1. Add the API key to your environment
+
+Add an environment variable called `AIRTABLE_API_KEY` to all the environments that
+your site will be built in.
+
+### 2. Edit your `_config.yml` file
+
+To tell your Jekyll site which tables to import your site from by defining them
+in the `airtable` as a list of tables:
+
+```yaml
+airtable:
+  faqs:  # This key defines the name of the data, in this case it would be available under site.data.faqs
+    app: app4ghFya5hfwmfVQ # the base ID for the Airtable
+    table: tbl4ghFya5hfwmfVQ # the table that contains your data (in this case faq). Can also be the table name
+    view: viw4ghFya5hfwmfVQ # the view that you would like to import. NB this will include hidden fields in the view, but only include records in that view.
+  resources:
+    app:
+    table:
+    view:
+    combine: true # Combine any existing collections with this data? Defaults to false
+  partners:
+    app:
+    table:
+    view:
+    fields: # A list of field names that would like to INCLUDE. Important as views do not filter out hidden fields
+    - Title
+    - URL
+    - Image
+    - Summary
+  # In the below case, "trainings" are a collection - so they can be output as pages etc.
+  # To define any of the imports as collections, just add a collection hash
+  trainings:
+    app:
+    table:
+    view:
+    fields:
+    - Content
+    - Title
+    - Summary
+    - Image
+    - Booking link
+    - Start Date
+    - End date
+    collection:
+      slug: title # the field title that should be used as the slug. NB the field titles are slugified. E.g. "Start Time" would end up as start_time
+      layout: event # the name of a layout that exists in your site's (or your site's theme) _layouts folder
+      content: content # the field title that should be used as the conent. NB the field titles are slugified. E.g. "Event Description" would end up as event_description
+```
+
+#### Import Fields
+
+Each import's key defines its key in the sites data or collection. Each item in the list of imports has these fields:
+
+| Field | Required? | Notes |
+| ----: | :-------: |---|
+| app | :heavy_check_mark: | The base ID for the Airtable. Starts with `app` and can be found in an Airtable URL |
+| table | :heavy_check_mark: | The table ID or name for the collection/data/  Starts with `tbl` and can be found in an Airtable URL |
+| view |  | The view ID  (or name) for the collection/data/  Starts with `viw` and can be found in an Airtable URL |
+| fields | | A list of fields found in the headings of Airtable columns, defining the only fields to be imported |
+| collection | | If this is defined, the Airtable table will be imported into a collection rather than data. |
+| combine | | Define this as truthy for any existing collections to be combined with the imported data. Already is done automatically for data and data, or collections and collections. |
+
+
+#### Collection feilds
+
+| Field | Required? | Notes |
+| ----: | :---------: |---|
+| slug | :heavy_check_mark: | the field title that should be used as the slug. NB the field titles are slugified. E.g. "Start Time" would end up as start_time |
+| layout | :heavy_check_mark: | the name of a layout that exists in your site's (or your site's theme) _layouts folder |
+| content | :heavy_check_mark: | the field title that should be used as the conent. NB the field titles are slugified. E.g. "Event Description" would end up as event_description |
+
+## Example
+
+Check out an example here
+
+## Collaborations
+
+Fork away :)
+
+## Licence
+
+MIT
+
+## Issues
+
+Just create a new issue

data/lib/jekyll-airtable-import.rb

@@ -0,0 +1,80 @@
+require 'jekyll'
+require 'airtable'
+require 'active_support/all'
+
+module Airtable
+  # Generates Jekyll Collections and Data from Airtable bases.
+  #
+  # See https://tippingpointuk.github.io/jekyll-airtable-import for more.
+  class Generator < ::Jekyll::Generator
+    priority :medium
+
+    def parse_data(data)
+      data_parse = []
+      data.each do |item|
+        # Extract attachments to just their URL
+        item.each do |key,val|
+          if val.kind_of?(Array)
+            if val[0]['url']
+              item[key] = val[0]['url']
+            end
+          end
+        end
+        data_parse.push(item)
+      end
+      data_parse
+    end
+    def generate(site)
+      return unless site.config['airtable']
+      # Get API key from environment
+      if ENV['AIRTABLE_API_KEY']
+        api_key = ENV['AIRTABLE_API_KEY']
+      else
+        warn "No airtable api key found. Make sure your key is available as AIRTABLE_API_KEY in the local environment."
+      end
+      # Pass in api key to client
+      @client = Airtable::Client.new(api_key)
+      site.config['airtable'].each do |name, conf|
+        # Pass in the app key and table name
+        @table = @client.table(conf['app'], conf['table'])
+        # Get records where the Published field is checked
+        @records = @table.all(:view => conf['view'],:fields => conf['fields'])
+        # Extract data to a hash
+        data = @records.map { |record| record.attributes }
+        parsed_data = parse_data(data)
+        if conf['collection']
+          slug_field = conf['collection']['slug']
+          layout = conf['collection']['layout']
+          if site.collections[name]
+            new_collection = site.collections[name]
+          else
+            new_collection = Jekyll::Collection.new(site, name)
+          end
+          # new_collection = Jekyll::Collection.new(site, name)
+          parsed_data.each do |item|
+            if item[slug_field] and item[slug_field] != ''
+              content = item[conf['collection']['content']]
+              #puts content
+              slug = Jekyll::Utils.slugify(item[slug_field])
+              path = File.join(site.source, "_#{name}", "#{slug}.md")
+              doc = Jekyll::Document.new(path, collection: new_collection, site: site)
+              item.merge!({ 'layout' => layout, 'slug' => slug })
+              doc.merge_data!(item.except('id'))
+
+              doc.content = content
+              new_collection.docs << doc
+            end
+          end
+          site.collections[name] = new_collection
+        else
+          site.data[name] = data
+          if conf['combine'] and site.collections.key?(name)
+            site.collections[name].docs.each do |document|
+              site.data[name].append(document)
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-airtable-import
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- joe-irving
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: airtable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.9
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+description: 
+email:
+- joe@irving.me.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/jekyll-airtable-import.rb
+homepage: https://tippingpointuk.github.io/jekyll-airtable-import
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A simple importer from airtable, to collections or data
+test_files: []