jahuty 3.2.1 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd60e0f72d6931901570d8d0112c23013233b95553dc1e0bfccdf54dc1dfb74c
-  data.tar.gz: 124d15d9a8f8dfd8939326ed2c49067fb59c90b2e1b254cac7d53f432090f66c
+  metadata.gz: 93d706c72d12cb61d951cc71b8add1ac154ed8b8bc57374e3d558e2b4bd8d420
+  data.tar.gz: e64a1355073ba942c5aef652032e8268e4d3a065b8cb3f5a7594d590957edc18
 SHA512:
-  metadata.gz: c80df676479909e5ba76bfe714943fa8b8803a51fac8cdae911d8ff0e5899aff3af5db1bf04ec6ee4001dd4eb8e27a6a988b7be2d4615bac020dc704cc0e7239
-  data.tar.gz: 6ff131d938e8b209bdc524f3dbb87de1a735951e476bb95ba8e5dcce558a2bc7c8be66fc22eb39390f00490631f1dfac251fe3664f5344b3bdb5f918ad874291
+  metadata.gz: 33d77db35616e1ae68f3b1ad0063e51ccfc526e35f2ef04e07851f506e5103e73af9d0d27252abf817de4ce2664206cf3edd7f9972275b96aaa582c8c38d0a7b
+  data.tar.gz: b572333f5df0d13b18ecbf29f9d22b06400622cdf9ab5408a6963f21fe154ea0fbb67cee881b3efb89cc7417ef1ef1abcd733b0681f7d72261f8ac357e175bc1

data/CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 3.3.0 - 2020-04-29
+
+- Add the `prefer_latest` configuration option to the client and render methods. This setting allows you to render a snippet's _latest_ content instead of the default _published_ content.
+
 ## 3.2.1 - 2020-03-16
 
 * Fix issue with double-enveloping the `params` query string parameter.

data/README.md

@@ -13,7 +13,7 @@ It is multi-platform, and we strive to make it run equally well on Windows, Linu
 To install, add this line to your application's `Gemfile` and run `bundle install`:
 
 ```ruby
-gem 'jahuty', '~> 3.2'
+gem 'jahuty', '~> 3.3'
 ```
 
 ## Usage
@@ -64,9 +64,35 @@ renders = jahuty.snippets.all_renders 'YOUR_TAG'
 renders.each { |render| puts render }
 ```
 
-## Parameters
+## Rendering content
 
-You can [pass parameters](https://docs.jahuty.com/liquid/parameters) into your renders using the `params` option:
+You can use the `prefer_latest` configuration option to render a snippet's _latest_ content to your team in _development_ and its _published_ content to your customers in _production_.
+
+By default, Jahuty will render a snippet's _published_ content, the content that existed the last time someone clicked the "Publish" button, to avoid exposing your creative process to customers.
+
+To render a snippet's _latest_ content, the content that currently exists in the editor, you can use the `prefer_latest` configuration option at the library or render level:
+
+```ruby
+jahuty = Jahuty::Client.new api_key: 'YOUR_API_KEY', prefer_latest: true
+```
+
+You can also prefer the latest content (or not) for a single render:
+
+```ruby
+# Render the _published_ content for all snippets...
+jahuty = Jahuty::Client.new api_key: 'YOUR_API_KEY'
+
+# ... except, render the _latest_ content for this one.
+jahuty.snippets.render YOUR_SNIPPET_ID, prefer_latest: true
+```
+
+## Passing dynamic parameters
+
+You can use the _same_ snippet to generate _different_ content by defining [variables](https://docs.jahuty.com/liquid/variables) in your snippets and setting their values via [parameters](https://docs.jahuty.com/liquid/parameters).
+
+### Snippet parameters
+
+Use the `params` option to pass parameters into your snippet:
 
 ```ruby
 jahuty = Jahuty::Client.new(api_key: 'YOUR_API_KEY')
@@ -74,12 +100,16 @@ jahuty = Jahuty::Client.new(api_key: 'YOUR_API_KEY')
 jahuty.snippets.render YOUR_SNIPPET_ID, params: { foo: 'bar' }
 ```
 
-The parameters above would be equivalent to [assigning the variable](https://docs.jahuty.com/liquid/variables) below in your snippet:
+The parameters above would be equivalent to assigning the following variable in your snippet:
 
 ```html
 {% assign foo = "bar" %}
 ```
 
+### Collection parameters
+
+Collection parameters use a slightly different syntax.
+
 If you're rendering a collection, the first dimension of the `params` key determines the parameters' scope. Use an asterisk key (`*`) to pass the same parameters to all snippets, or use a snippet id as key to pass parameters to a specific snippet.
 
 ```ruby
@@ -104,7 +134,7 @@ jahuty.snippets.all_renders 'YOUR_TAG', params: {
 }
 ```
 
-## Caching
+## Caching for performance
 
 You can use caching to control how frequently this library requests the latest content from Jahuty's API.
 
@@ -218,7 +248,7 @@ jahuty2 = Jahuty::Client.new(api_key: 'YOUR_API_KEY', expires_in: 60)
 jahuty2.snippets.render 1, expires_in: 0
 ```
 
-## Errors
+## Handling errors
 
 If an error occurs with [Jahuty's API](https://docs.jahuty.com/api#errors), a `Jahuty::Exception::Error` will be raised:
 

data/lib/jahuty/client.rb

@@ -5,11 +5,12 @@ require 'mini_cache'
 module Jahuty
   # Executes requests against Jahuty's API and returns resources.
   class Client
-    def initialize(api_key:, cache: nil, expires_in: nil)
-      @api_key    = api_key
-      @cache      = Cache::Facade.new(cache || ::MiniCache::Store.new)
+    def initialize(api_key:, cache: nil, expires_in: nil, prefer_latest: false)
+      @api_key = api_key
+      @cache = Cache::Facade.new(cache || ::MiniCache::Store.new)
       @expires_in = expires_in
-      @services   = {}
+      @services = {}
+      @prefer_latest = prefer_latest
     end
 
     # Allows services to be accessed as properties (e.g., jahuty.snippets).
@@ -17,7 +18,7 @@ module Jahuty
       if args.empty? && name == :snippets
         unless @services.key?(name)
           @services[name] = Service::Snippet.new(
-            client: self, cache: @cache, expires_in: @expires_in
+            client: self, cache: @cache, expires_in: @expires_in, prefer_latest: @prefer_latest
           )
         end
         @services[name]

data/lib/jahuty/response/handler.rb

@@ -13,9 +13,9 @@ module Jahuty
 
         @resources ||= ::Jahuty::Resource::Factory.new
 
-        if collection?(action, payload)
+        if collection?(payload)
           payload.map { |data| @resources.call resource_name, data }
-        elsif resource?(action, payload)
+        elsif resource?(payload)
           @resources.call resource_name, payload
         else
           raise ArgumentError, 'Action and payload mismatch'
@@ -24,8 +24,8 @@ module Jahuty
 
       private
 
-      def collection?(action, payload)
-        action.is_a?(Action::Index) && payload.is_a?(::Array)
+      def collection?(payload)
+        payload.is_a?(::Array)
       end
 
       def name_resource(action, response)
@@ -47,8 +47,8 @@ module Jahuty
           (response.status < 200 || response.status >= 300)
       end
 
-      def resource?(action, payload)
-        !action.is_a?(Action::Index) && payload.is_a?(::Object)
+      def resource?(payload)
+        payload.is_a?(::Object)
       end
 
       def success?(response)

data/lib/jahuty/service/snippet.rb

@@ -4,24 +4,23 @@ module Jahuty
   module Service
     # A service for interacting with snippets.
     class Snippet < Base
-      def initialize(client:, cache:, expires_in: nil)
+      def initialize(client:, cache:, expires_in: nil, prefer_latest: false)
         super(client: client)
 
         @cache = cache
         @expires_in = expires_in
+        @prefer_latest = prefer_latest
       end
 
-      def all_renders(tag, params: {}, expires_in: nil)
-        renders = index_renders tag: tag, params: params
+      def all_renders(tag, params: {}, expires_in: @expires_in, prefer_latest: @prefer_latest)
+        renders = index_renders tag: tag, params: params, prefer_latest: prefer_latest
 
         cache_renders renders: renders, params: params, expires_in: expires_in
 
         renders
       end
 
-      def render(snippet_id, params: {}, expires_in: nil)
-        expires_in ||= @expires_in
-
+      def render(snippet_id, params: {}, expires_in: @expires_in, prefer_latest: @prefer_latest)
         key = cache_key snippet_id: snippet_id, params: params
 
         render = @cache.read(key)
@@ -29,7 +28,7 @@ module Jahuty
         @cache.delete key unless render.nil? || cacheable?(expires_in)
 
         if render.nil?
-          render = show_render snippet_id: snippet_id, params: params
+          render = show_render snippet_id: snippet_id, params: params, prefer_latest: prefer_latest
 
           @cache.write key, render, expires_in: expires_in if cacheable?(expires_in)
         end
@@ -50,6 +49,8 @@ module Jahuty
       def cache_renders(renders:, params:, expires_in: nil)
         expires_in ||= @expires_in
 
+        return if renders.nil?
+
         return unless cacheable?(expires_in)
 
         global_params = params['*'] || {}
@@ -68,9 +69,10 @@ module Jahuty
         expires_in.nil? || expires_in.positive?
       end
 
-      def index_renders(tag:, params: {})
+      def index_renders(tag:, params: {}, prefer_latest: false)
         request_params = { tag: tag }
         request_params[:params] = params.to_json unless params.empty?
+        request_params[:latest] = 1 if prefer_latest
 
         action = ::Jahuty::Action::Index.new(
           resource: 'render',
@@ -80,9 +82,10 @@ module Jahuty
         @client.request action
       end
 
-      def show_render(snippet_id:, params: {})
+      def show_render(snippet_id:, params: {}, prefer_latest: false)
         request_params = {}
         request_params[:params] = params.to_json unless params.empty?
+        request_params[:latest] = 1 if prefer_latest
 
         action = ::Jahuty::Action::Show.new(
           id: snippet_id,

data/lib/jahuty/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Jahuty
-  VERSION = '3.2.1'
+  VERSION = '3.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jahuty
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.3.0
 platform: ruby
 authors:
 - Jack Clayton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-17 00:00:00.000000000 Z
+date: 2021-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -238,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Jahuty's Ruby SDK.