jekyll-airtable 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8e6718da49e317d34b4dedabca793ec6faa3501
-  data.tar.gz: 752bf11b45a65f6ad9032d650e631020542b97a8
+  metadata.gz: 395f32572de790075218a8054c2f2d85edfb7d26
+  data.tar.gz: f991aff018e93d7c909fbfc8afb22555a41f4604
 SHA512:
-  metadata.gz: d1343e3d04e8441133112c4c9a212dc278a43affbab021ee5ed228341c6a7f28c6f80e556a8d09675f6b0f07e0d4225c717c67d8c435d251c182ded616972a67
-  data.tar.gz: ab5490a811c43250f19074688972264ba48f8698a8805d8c0a2c76e2623533f94080bc6728d15575d5e7e4b9dd8b139018988ef937467cb296eb8691d83b26cb
+  metadata.gz: bec4a8ec0e745078d43279e4faa5a0e919a4d3394ac1a8575337dc7c0465868d8786550d5ec059d05a58e082edeea28b2b041b552a0dc805479da6deb7a74393
+  data.tar.gz: 3ad0bc15fb63dbf0fc34b7837d50da2e6f8a797b470be20099bd1577cbc380c4c8655b0870d2ed3e52f9a6ac302dc1e3f8d422d0bf73a0208bca7704cbd0572a

data/.env.example

@@ -0,0 +1,4 @@
+SYNC_WITH_AIRTABLE='false'
+AIRTABLE_API_KEY='key'
+AIRTABLE_BASE_UID='appb'
+AIRTABLE_TABLE_NAMES='Table 1, Table 2, Table 3'

data/.gitignore

@@ -9,4 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
-.env
+.env
+.byebug_history

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jekyll-airtable (0.1.0)
+    jekyll-airtable (0.2.0)
       faraday (~> 0.11.0)
       faraday_middleware (~> 0.10.1)
       jekyll (~> 3.3)

data/README.md

@@ -4,7 +4,7 @@ This gem enables you to easily integrate Airtable with Jekyll site and use it as
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your Jekyll site Gemfile:
 
 ```ruby
 gem 'jekyll-airtable'
@@ -12,28 +12,93 @@ gem 'jekyll-airtable'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
-Or install it yourself as:
+## Usage
 
-    $ gem install jekyll-airtable
+1. Because you will have to mention/use your API key, it is VERY RECOMMENDED to use dotenv so you do not have your API key lying around in plain sight.
+```ruby
+gem 'dotenv'
+```
+run bundle install again
 
-## Usage
+2. Add this to your repo .gitignore (create one if does not exist):
+```
+.env
+```
+
+3. Copy the .env.example in this repo to the root of your project, rename it to .env then fill it for your needs.
+4. Set the SYNC_WITH_AIRTABLE key in the .env to 'true'
+
+```
+SYNC_WITH_AIRTABLE='true'
+```
+
+5. You need to add a custom plugin to get the dotenv to work, you do this by creating a folder ```_plugins``` (if does not exist already) inside your Jekyll repo
+6. Inside the ```/_plugins ```, create a file called "environment_variables_generator.rb", with this as the content:
 
-1. Add this gem to the Gemfile
-2. Run ```sh bundle install ``` on the terminal
-3. Do not forget to declare it also on the config.yml, below the "gems" or "plugins" YAML key.
-4. Then you can execute the plugin using ```sh bundle exec jekyll serve ``` or ```sh bundle exec jekyll build ```
+```ruby
+# Plugin to add environment variables to the `site` object in Liquid templates
+require 'dotenv'
+
+module Jekyll
+  class EnvironmentVariablesGenerator < Generator
+    priority :highest
+    
+    def generate(site)
+      Dotenv.overload
+      site.config['env'] = Dotenv.overload
+
+      site.config['SYNC_WITH_AIRTABLE'] = ENV['SYNC_WITH_AIRTABLE']
+      site.config['AIRTABLE_API_KEY']   = ENV['AIRTABLE_API_KEY']
+      site.config['AIRTABLE_BASE_UID']  = ENV['AIRTABLE_BASE_UID']
+      site.config['AIRTABLE_TABLE_NAMES'] = ENV['AIRTABLE_TABLE_NAMES'].split(',').map(&:strip)
+    end
+  end
+end
+```
+
+Now the secret keys can be accessed by Jekyll without being visible to the public.
+
+7. Now, you need to declare the plugins in the config.yml
+```yml
+plugins:
+  - jekyll-airtable
+  - environment_variables_generator
+```
+
+8. Finally, you can execute the plugin using ```sh bundle exec jekyll serve ``` or ```sh bundle exec jekyll build ```
+
+For production, you also have to set those keys and values.
+
+9. You then need to set the collections on the ```_config.yml ``` so that Jekyll recognizes them. The snippets below here are taken from https://github.com/galliani/airbase/blob/master/_config.yml. The collections on that repo are "use_cases", "whitepapers", and "tutorials", taken from the Airtable of "Use Cases", "Whitepapers", and "Tutorials" respectively.
+
+```yml
+collections_dir: collections
+collections:
+  use_cases:
+    output: true
+  whitepapers:
+    output: true
+  tutorials:
+    output: true
+
+defaults:
+  - scope:
+      type: "whitepapers"
+    values:
+      layout: "page" # any jekyll layout file you already have in the _layouts that you want to use for this collection type.
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll-airtable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/galliani/jekyll-airtable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -41,4 +106,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Jekyll::Airtable project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jekyll-airtable/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Jekyll::Airtable project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/galliani/jekyll-airtable/blob/master/CODE_OF_CONDUCT.md).

data/lib/jekyll-airtable/api.rb

@@ -38,7 +38,8 @@ module Jekyll
           :view,
           :cell_format,
           :time_zone,
-          :user_locale
+          :user_locale,
+          :offset
         ]
 
         return nil unless keys.include?(params_key) || 

data/lib/jekyll-airtable/client.rb

@@ -15,30 +15,43 @@ module Jekyll
 
         @connection.authorization(:Bearer, Airtable.api_key)
 
+        records = []
+        offset  = nil
+        counter = 1
+
+        begin
+          looper = "request no. #{counter}"
+          puts 'Sending ' + looper
+
+          params[:offset] = offset if !offset.nil?
+
+          data = send_get_request(table_name, params)
+          puts "Response received for the " + looper
+
+          records   << data['records']
+          offset    = data['offset']
+
+          # Pause for 1 second, just to be safe
+          sleep 1
+          counter += 1
+        end while !offset.nil?
+
+        records.flatten
+      end
+
+      private
+
+      def send_get_request(table_name, params)
         response = @connection.get do |req|
           req.url URI.escape(table_name)
 
-          default_params = params.merge(max_records: 100) unless params[:max_records]
+          default_params = params
           default_params.keys.each do |key|
             processing_query_params(req, default_params, key)
           end
         end
 
-        response.body
-      end
-
-      def retrieve_record(table_name:, record_uid:)
-        @connection = Faraday.new(url:  versioned_base_endpoint_url) do |faraday|
-          faraday.response  :logger                  # log requests to STDOUT
-          faraday.request   :url_encoded
-          faraday.adapter   Faraday.default_adapter  # make requests with Net::HTTP
-        end
-
-        @connection.authorization(:Bearer, Airtable.api_key)
-
-        response = @connection.get(URI.escape(table_name) + '/' + record_uid)
-
-        response.body
+        JSON.parse(response.body)
       end
 
     end

data/lib/jekyll-airtable/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Airtable
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/jekyll/airtable_fetcher.rb

@@ -18,24 +18,27 @@ module Jekyll
       client = Airtable.client(base_uid: site.config['AIRTABLE_BASE_UID'])
 
       site.config['AIRTABLE_TABLE_NAMES'].each do |table_name|
-        records = JSON.parse(client.list_records(table_name: table_name, params: {}))
+        records = client.list_records(table_name: table_name)
         next if records.size == 0
 
-        records_as_json      = records['records']
         converted_table_name = to_snake(table_name)
         directory_name       = "collections/_" + converted_table_name
 
         Dir.mkdir(directory_name) unless File.exists?(directory_name)
 
-        records_as_json.each do |record_hash|
-          slug     = record_hash['id']
-          out_file = File.new("#{directory_name}/#{slug}.md", "w")
+        records.each do |record|
+          fields    = record['fields']
+          # We use the first field as the primary key
+          # Then find the value of the primary key to be stored as the slug, which
+          # will be used as file name and the path to the record in the url.
+          # However, if the record has field called 'slug', it will be used instead
+          pkey      = fields.keys.first
+          slug      = fields['slug'].nil? ? fields[pkey] : fields['slug']
+          uid       = record['id']
+
+          out_file  = File.new("#{directory_name}/#{slug}.md", "w")
           out_file.puts(front_matter_mark)
-
-          # Store the uid
-          out_file.puts("uid: #{slug}")
-
-          fields = record_hash['fields']
+          out_file.puts("uid: #{uid}")
 
           fields.each do |key, value|
             snake_key = to_snake(key)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-airtable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Galih Muhammad
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-11 00:00:00.000000000 Z
+date: 2018-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,6 +129,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.example"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"