jekyll-gdrive 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 719bbba214913cefb73468b8aa6542ea6b7b4202
-  data.tar.gz: 82de8b6c9547bdc7d6904c1481da2c0eb1e379a8
+  metadata.gz: 208531d9b84e92237cd3af0bc03826e17e6b088f
+  data.tar.gz: ecd4d899db376f71c7a6ff418504ef1728d2c9c8
 SHA512:
-  metadata.gz: ea474057a9e558379f6e6ada345ef0d363d58b977e031f49ff44857ec2d08a7cdf1ee6b7a5b6ca6ff7e705bd3299b822e0a284e6cbb56110ee3e3c268666877a
-  data.tar.gz: c94eddbb04990a5b7edb090e7310df7c4f1d82785dc49edefc52317eb7fb833d7298c0a30c7a4f44f055adb505e4e9e3c33c48c69eedb7ad5a16cf3270d2669f
+  metadata.gz: 2070cc9782ace522aac70935e49402128c035c66e05551efaa97a0d0b1ce86044e652f15e8a5bc063c3288557cbf4ddf8b0ce6340640c17987f9ad6cf9d5fc54
+  data.tar.gz: 329a2314635d1de54c54d8e0166f08fa83eda7d1ab15d6e809ccb648da0dd253d1a54ab48688fa837e9d7b2fb81fb8845d561e591758004fb0ba3215e52a9e1e

data/README.md

@@ -62,6 +62,22 @@ Example:
   </table>
 ```
 
+## Caching
+
+Google's Drive API is not incredibly fast. When working in `jekyll serve --watch` mode you'll quickly get tired of waiting for the spreadsheet data to load on every refresh.
+
+To work around this you can specify a cache period for the gdrive plugin in the Jekyll configuration:
+
+```yaml
+gdrive:
+   sheet: "My sheet"
+   cache_period: 5 minutes
+```
+
+This will store the sheet in a local `_gdrive_cache` file and only reload the sheet data once every 5 minutes.
+
+You can specify the time in `seconds`, `minutes` or `hours`.
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/jekyll-gdrive/fork )

data/lib/jekyll/gdrive/generator.rb

@@ -2,12 +2,38 @@ module Jekyll
   module Gdrive
     class Generator < Jekyll::Generator
       def generate(site)
-        sheet_name = site.config['gdrive'] && site.config['gdrive']['sheet']
-        credentials = ENV['GDRIVE'] && ENV['GDRIVE'].split(":")
+        sheet_name   = site.config['gdrive'] && site.config['gdrive']['sheet']
+        cache_period = site.config['gdrive'] && site.config['gdrive']['cache_period']
+        credentials  = ENV['GDRIVE'] && ENV['GDRIVE'].split(":")
 
         raise "No sheet specified for the GDrive Data Plugin\nSet 'gdrive.sheet' in your '_config.yml'" unless sheet_name
         raise "No credentials specified for the GDrive Data Plugin\nSet it in a GRDIVE environment variable\nEg.: export GDRIVE_TOKEN=<client_id>:<client_secret>:<refresh_token>\nRun 'jekyll gdrive' to get an export statement you can cut and past" unless credentials
 
+        data = load_from_cache(cache_period)
+        unless data
+          sheet = load_from_sheet(sheet_name, credentials)
+
+          data = []
+
+          (0..sheet.num_rows).each do |row|
+            data[row] = []
+            (0..sheet.num_cols).each do |col|
+              data[row][col] = sheet[row+1, col+1]
+            end
+          end
+
+          # remove empty rows
+          while data.last.all? {|c| c == "" || c.nil? }
+            data.pop
+          end
+
+          store_in_cache(data) if cache_period
+        end
+
+        site.data['google_sheet'] = data
+      end
+
+      def load_from_sheet(sheet_name, credentials)
         client = Google::APIClient.new(
           :application_name => "Jekyll GDrive Plugin",
           :application_version => Jekyll::Gdrive::VERSION
@@ -19,25 +45,47 @@ module Jekyll
         auth.fetch_access_token!()
 
         session = GoogleDrive.login_with_oauth(auth.access_token)
+        session.file_by_title(sheet_name).worksheets.first
+      end
 
-        sheet = session.file_by_title(sheet_name).worksheets.first
+      def store_in_cache(data)
+        File.open("_gdrive_cache", "w") do |file|
+          file.write YAML.dump({
+            "ts" => Time.now.to_i,
+            "data" => data
+          })
+        end
+      end
 
-        data = []
+      def load_from_cache(cache_period)
+        cache_seconds = period_to_seconds(cache_period)
+        return nil unless cache_seconds
+        return nil unless cache_seconds > 0
 
-        (0..sheet.num_rows).each do |row|
-          data[row] = []
-          (0..sheet.num_cols).each do |col|
-            data[row][col] = sheet[row+1, col+1]
-          end
-        end
+        cache = YAML.load(File.read("_gdrive_cache")) rescue nil
+        return nil unless cache
+        return nil if Time.at(cache['ts'].to_i) + period_to_seconds(cache_period) < Time.now
 
-        # remove empty rows
-        while data.last.all? {|c| c == "" || c.nil? }
-          data.pop
+        cache['data']
+      end
+
+      def period_to_seconds(period)
+        return nil unless period
+
+        _, value, unit = *period.match(/(\d+)\s*(s|second|seconds|m|minute|minutes|h|hour|hours)/)
+
+        return puts "Bad time period for GDrive cache '#{period}'" unless value && unit
+
+        multiplier = case unit
+        when "s", "second", "seconds"
+          1
+        when "m", "minute", "minutes"
+          60
+        when "h", "hour", "hours"
+          60 * 60
         end
 
-        puts "Site data for google sheet: #{data}"
-        site.data['google_sheet'] = data
+        multiplier * value.to_i
       end
     end
   end

data/lib/jekyll/gdrive/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Gdrive
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-gdrive
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mathias Biilmann Christensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-12 00:00:00.000000000 Z
+date: 2014-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler