Add local caching

lib/index.coffee

@@ -1,6 +1,7 @@
 _           = require 'lodash'
 W           = require 'when'
 S           = require 'string'
+fs          = require 'fs'
 path        = require 'path'
 contentful  = require 'contentful'
 pluralize   = require 'pluralize'
@@ -84,18 +85,41 @@ module.exports = (opts) ->
         res
       , []
 
+    ###*
+     * Checks if a file or directory exists
+     * @param {String} path - File or directory path
+     * @return {Boolean} - returns success/failure
+    ###
+
+    fsExistsSync = (path) ->
+      try
+        fs.accessSync(path, fs.F_OK)
+        true
+      catch e
+        false
+
     ###*
      * Fetches data from Contentful for content types, and formats the raw data
+     * Stores/fetches content locally if requested
      * @param {Array} types - configured content_type objects
      * @return {Promise} - returns formatted locals object with all content
     ###
 
     get_all_content = (types) ->
+      fs.mkdirSync(opts.cache) if opts.cache && !fsExistsSync(opts.cache)
+
       W.map types, (t) ->
-        fetch_content(t)
-          .then(format_content)
-          .then((c) -> t.content = c)
-          .yield(t)
+        if opts.cache && fsExistsSync("#{opts.cache}/#{t.id}.json")
+          fetch_content_from_file(t)
+            .then(format_content)
+            .then((c) -> t.content = c)
+            .yield(t)
+        else
+          fetch_content(t)
+            .then((c) -> record_content(c, t))
+            .then(format_content)
+            .then((c) -> t.content = c)
+            .yield(t)
 
     ###*
      * Fetch entries for a single content type object
@@ -110,6 +134,30 @@ module.exports = (opts) ->
         )
       )
 
+    ###*
+     * Fetch entries for a single content type object from a local JSON file
+     * @param {Object} type - content type object
+     * @return {Promise} - returns response from JSON file
+    ###
+
+    fetch_content_from_file = (type) ->
+      contents = fs.readFileSync "#{opts.cache}/#{type.id}.json"
+      W(JSON.parse(contents))
+
+    ###*
+     * Records content from Contentful into JSON files
+     * @param {Object} content - entries API response for a content type
+     * @param {Object} type - content type object
+     * @return {Promise} - passes content through
+    ###
+
+    record_content = (content, type) ->
+      if opts.cache
+        fs.writeFile "#{opts.cache}/#{type.id}.json", JSON.stringify(content), (err,data) ->
+          throw err if err
+
+      content
+
     ###*
      * Formats raw response from Contentful
      * @param {Object} content - entries API response for a content type

readme.md

@@ -120,6 +120,10 @@ Required. Your Contentful Delivery access token (API key).
 
 Required. The space ID containing the content you wish to retrieve.
 
+#### cache
+
+Optional. (String) Allows you to cache responses from Contentful's API. The value is the path to the directory you intend to store the data in. Ex: `./contentful-data`
+
 #### preview
 
 Optional. (Boolean) Allows you use the Contentful Preview API. Also able to be accessed by setting the environment variable `CONTENTFUL_ENV` to `"develop"` (preview api) or `"production"` (default cdn).

test/fixtures/cache/about.jade

@@ -0,0 +1 @@
+h1 wow

test/fixtures/cache/app.coffee

@@ -0,0 +1,19 @@
+contentful = require '../../..'
+
+module.exports =
+  ignores: ["**/_*", "**/.DS_Store"]
+  extensions: [
+    contentful(
+      cache: './test/fixtures/cache/data'
+      access_token: 'YOUR_ACCESS_TOKEN'
+      space_id: 'aqzq2qya2jm4'
+      content_types: [
+        {
+          id: '6BYT1gNiIEyIw8Og8aQAO6'
+        }
+        {
+          id: '7CDlVsacqQc88cmIEGYWMa'
+        }
+      ]
+    )
+  ]

test/fixtures/cache/index.jade

@@ -0,0 +1,5 @@
+ul
+  - for p in contentful.blog_posts
+    li
+      h1= p.title
+      p= p.body

test/fixtures/cache/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "test",
+  "dependencies": {
+    "jade": "*"
+  }
+}

test/fixtures/cache_use/about.jade

@@ -0,0 +1 @@
+h1 wow

test/fixtures/cache_use/app.coffee

@@ -0,0 +1,19 @@
+contentful = require '../../..'
+
+module.exports =
+  ignores: ["**/_*", "**/.DS_Store"]
+  extensions: [
+    contentful(
+      cache: './test/fixtures/cache_use/data'
+      access_token: 'YOUR_ACCESS_TOKEN'
+      space_id: 'aqzq2qya2jm4'
+      content_types: [
+        {
+          id: '6BYT1gNiIEyIw8Og8aQAO6'
+        }
+        {
+          id: '7CDlVsacqQc88cmIEGYWMa'
+        }
+      ]
+    )
+  ]

test/fixtures/cache_use/data/6BYT1gNiIEyIw8Og8aQAO6.json

@@ -0,0 +1 @@
+[{"fields":{"title":"Throw Some Ds","body":"Rich Boy selling crick"}}]

test/fixtures/cache_use/data/7CDlVsacqQc88cmIEGYWMa.json

@@ -0,0 +1 @@
+[{"fields":{"title":"Throw Some Ds","body":"Rich Boy selling crick"}}]

test/fixtures/cache_use/index.jade

@@ -0,0 +1,5 @@
+ul
+  - for p in contentful.blog_posts
+    li
+      h1= p.title
+      p= p.body

test/fixtures/cache_use/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "test",
+  "dependencies": {
+    "jade": "*"
+  }
+}

test/test.coffee

@@ -8,6 +8,7 @@ path = require 'path'
 
 compile_fixture = (fixture_name, done) ->
   @public = path.join(fixture_name, 'public')
+  @data = path.join(fixture_name, 'data')
   h.project.compile(Roots, fixture_name)
 
 mock_contentful = (opts = {}) ->
@@ -74,6 +75,55 @@ describe 'contentful content type fields', ->
 
   after -> unmock_contentful()
 
+describe 'create cache', ->
+  before (done) ->
+    @title = 'Throw Some Ds'
+    @body  = 'Rich Boy selling crick'
+    mock_contentful(entries: [{fields: {title: @title, body: @body}}])
+    compile_fixture.call(@, 'cache').then(-> done()).catch(done)
+
+  it 'compiles basic project', ->
+    p = path.join(@public, 'index.html')
+    h.file.exists(p).should.be.ok
+
+  it 'creates the data directory', ->
+    p = path.join(@data)
+    h.file.exists(p).should.be.ok
+
+  it 'creates the data json', ->
+    p = path.join(@data, '6BYT1gNiIEyIw8Og8aQAO6.json')
+    h.file.exists(p).should.be.ok
+
+    h.file.contains(p, @title).should.be.true
+    h.file.contains(p, @body).should.be.true
+
+  it 'has contentful data available in views', ->
+    p = path.join(@public, 'index.html')
+    h.file.contains(p, @title).should.be.true
+    h.file.contains(p, @body).should.be.true
+
+  after ->
+    h.project.remove_folders('**/data/')
+    unmock_contentful()
+
+describe 'use cache', ->
+  before (done) ->
+    @title = 'Throw Some Ds'
+    @body  = 'Rich Boy selling crick'
+    mock_contentful(entries: [{fields: {title: @title, body: @body}}])
+    compile_fixture.call(@, 'cache_use').then(-> done()).catch(done)
+
+  it 'compiles basic project', ->
+    p = path.join(@public, 'index.html')
+    h.file.exists(p).should.be.ok
+
+  it 'has contentful data available in views', ->
+    p = path.join(@public, 'index.html')
+    h.file.contains(p, @title).should.be.true
+    h.file.contains(p, @body).should.be.true
+
+  after -> unmock_contentful()
+
 describe 'basic compile', ->
   before (done) ->
     @title = 'Throw Some Ds'