Elixir Cached Contentful!

A simple way to fetch data from Contentful and cache them to avoid over 9000 API requests!!

There are only basic functionalities for entries and assets. More features coming soon, so enjoy this for now.

If you want to contribute, do a pull request with an argument why it should be merged and we will determine if it's awesome enough.

Cheers and enjoy!

Dependencies

• Poison
• Httpoison

Installation

Add cached_contentful to your dependency list

{:cached_contentful, git: "https://github.com/weareyipyip/elixir-cached-contentful.git", tag: "0.4.1"}

Configuration

Do some configuration

config :cached_contentful,
    space_id: "YOUR_SPACE_ID",
    access_token: "YOUR_ACCESS_TOKEN",
    environment: "YOUR_ENVIRONMENT",
    default_language: "en-US",
    auto_update: false,
    update_interval: 24 * 60 * 60 * 1000 # Refresh every 24 hours (milliseconds)

• spaceid = Is the contentful space id that you want to use (REQUIRED)
• access_token = Token that matches the space (REQUIRED)
• default_language = Default Space language (REQUIRED)
• environment = The space environment you want to use (REQUIRED)
• auto_update = Set if you want the entries to be automatically updated via the worker.
• update_interval = Interval for updating the entries (OPTIONAL)

Usage

Entries

Get all the entries params:

• lanuage

CachedContentful.Api.getEntries("en-US")

Get all entries by type params:

• Entry Type
• lanuage

CachedContentful.Api.getEntriesByType("entrytype", "nl")

Get entry by id params:

• Entry Type
• lanuage

CachedContentful.Api.getEntryById("s0m3l0n61D", "en-US")

Update entries with fresh new data from the Contentful API:

CachedContentful.Api.updateEntries

Custom entry queries

With custom queries you can fetch specific or filtered data and cache them.

CachedContentful.Api.customEntrySearch(name, options, update, language)

Parameters

name (String) The name of the cache to save the results in. This will make sure that one call is being made and saved into a process for instant retrieval.

options (Map, default = %{}) Here you can set the queries for the Contentful request in a form of a map. For example:

%{
	"content_type": "blogPost",
	"order": "sys.createdAt"
}

update (Boolean, default = false) This is an optional paramter, but can be set to true if you want to update the results.

language Provide the language you want to content in.

You can find all the query options in the Contentful Contet delivery API

Example

# Fetching and saving data in the cache
CachedContentful.Api.customEntrySearch(
    "ordered_blogposts",
    %{"content_type": "blogPost", "order": "sys.createdAt"}
    )
    
# Update the current cache
CachedContentful.Api.customEntrySearch(
    "ordered_blogposts",
    %{"content_type": "blogPost", "order": "-sys.createdAt"},
    true
    )

Assets

Get all the assets:

CachedContentful.Api.getAssets

Get asset by id

CachedContentful.Api.getAssetById("s0m3l0n61D")

Update entries with fresh new data from the Contentful API:

CachedContentful.Api.updateAssets