jahuty 3.3.1 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7f9dd15bdc516d3e7249bba915822f742642f59c7209f47151b963ba34b53d1
-  data.tar.gz: 11bb09b250f358f13d5cafb3a585a1db525ddf988b6fea70dd19c7586a5a77a3
+  metadata.gz: dc03377d980089b275af98c4bbd57d56c9a5a7e017bd9bce90dd53c299340be7
+  data.tar.gz: d7b0463dbfd93a713cf4c718e3ef175926af4228a69d72c6798ae7ae033e1b06
 SHA512:
-  metadata.gz: 42ee47a4e2e936a10c4e14bee9990db9c170e53e852d257190cf7636d8c27ce6e7f4da04eeb1cf1ea333e00f65ffc7ed1847b0a47ec4c7ea024d067ee9bca196
-  data.tar.gz: e1ec48bb180b4f81145f4a6b939bc3a9fe64a792bbb7a513b705b49e61b4ac379dfbc0c38fb12880122282d12816d90c8798ca6b283bb8fce6befe5777eb3174
+  metadata.gz: ae1da4327c9e6e5c8bcc91f95e10f37c8d2eed73cd9b569d6b9f369f4261c2b73ee78f693b2b7d60274b33e40bb0417743638c92a2130bb9bd05492c4cd78f27
+  data.tar.gz: 9bdc2c24d3b666d17106329bd34ba18cc6643322b1b45905ef9dd1e3503f1889fb1bf7320e55e4ffca864300f39643c273782a27f7b4c0c8902730dc427d47fe

data/CHANGELOG.md

@@ -5,6 +5,14 @@ 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.4.0] - 2021-07-29
+
+### Added
+
+- Support for Ruby 3.
+- Builds for the latest versions of Ruby 2.6.x, 2.7.x, and 3.0.x.
+- A `location` parameter to the `render` method to enable display tracking.
+
 ## 3.3.1 - 2021-05-02
 
 ### Fixed

data/README.md

@@ -6,14 +6,18 @@ Welcome to the [Ruby SDK](https://docs.jahuty.com/sdks/ruby) for [Jahuty's API](
 
 ## Installation
 
-This library requires [Ruby 2.6+](https://www.ruby-lang.org/en/downloads/releases/).
+This library is tested with the following [Ruby versions](https://www.ruby-lang.org/en/downloads/releases/):
+
+* MRI 2.6.8
+* MRI 2.7.4
+* MRI 3.0.2
 
 It is multi-platform, and we strive to make it run equally well on Windows, Linux, and OSX.
 
 To install, add this line to your application's `Gemfile` and run `bundle install`:
 
 ```ruby
-gem 'jahuty', '~> 3.3'
+gem 'jahuty', '~> 3.4'
 ```
 
 ## Usage
@@ -33,11 +37,8 @@ jahuty = Jahuty::Client.new(api_key: 'YOUR_API_KEY')
 
 render = jahuty.snippets.render YOUR_SNIPPET_ID
 
-a = render.to_s
-
-b = render.content
-
-a == b  # returns true
+render.to_s
+render.content
 ```
 
 In an HTML view:
@@ -61,16 +62,14 @@ jahuty = Jahuty::Client.new(api_key: 'YOUR_API_KEY')
 
 renders = jahuty.snippets.all_renders 'YOUR_TAG'
 
-renders.each { |render| puts render }
+renders.each { |r| puts r }
 ```
 
 ## Rendering content
 
-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:
+You can use the `prefer_latest` configuration option, however, to render a snippet's _latest_ content, the content that currently exists in the editor. This allows you to render a snippet's _latest_ content to your team in _development_ and its _published_ content to your customers in _production_.
 
 ```ruby
 jahuty = Jahuty::Client.new api_key: 'YOUR_API_KEY', prefer_latest: true
@@ -134,6 +133,19 @@ jahuty.snippets.all_renders 'YOUR_TAG', params: {
 }
 ```
 
+## Tracking renders
+
+You can record where snippets are rendered using the `location` configuration option. This helps your team preview their changes, and it helps you find and replace deprecated snippets.
+
+```ruby
+jahuty = Jahuty::Client.new(api_key: 'YOUR_API_KEY')
+
+render = jahuty.snippets.render YOUR_SNIPPET_ID, location: 'https://example.com'
+]);
+```
+
+Note, this configuration option is only supported by the `render` method, not the `all_renders` method, and locations are only reported when a request is sent to Jahuty's API. As a result of this limitation, locations may not be reported in all scenarios. For example, if a call to `render` results in a cache hit, the location will not be reported.
+
 ## Caching for performance
 
 You can use caching to control how frequently this library requests the latest content from Jahuty's API.
@@ -165,10 +177,7 @@ A persistent cache allows renders to be cached across multiple requests. This re
 To configure Jahuty to use your persistent cache, pass a cache implementation to the client via the `cache` configuration option:
 
 ```ruby
-jahuty = new Jahuty::Client.new(
-  api_key: 'YOUR_API_KEY',
-  cache: cache
-)
+jahuty = new Jahuty::Client.new(api_key: 'YOUR_API_KEY', cache: cache)
 ```
 
 The persistent cache implementation you choose and configure is up to you. There are many libraries available, and most frameworks provide their own. At this time, we support any object which responds to `get(key)`/`set(key, value, expires_in:)` or `read(key)`/`write(key, value, expires_in:)` including [ActiveSupport::Cache::Store](https://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html#method-i-fetch).
@@ -190,11 +199,8 @@ You can usually configure your caching implementation with a default `:expires_i
 You can configure a default `:expires_in` for all of this library's renders by passing an integer number of seconds via the client's `:expires_in` configuration option:
 
 ```ruby
-jahuty = Jahuty::Client.new(
-  api_key: 'YOUR_API_KEY',
-  cache: cache,
-  expires_in: 60  # <- Cache all renders for sixty seconds
-)
+ # Cache all renders for sixty seconds.
+jahuty = Jahuty::Client.new(api_key: 'YOUR_API_KEY', cache: cache, expires_in: 60)
 ```
 
 If this library's default `:expires_in` is set, it will take precedence over the default `:expires_in` of the caching implementation.
@@ -224,11 +230,11 @@ By default, this library will cache each render returned by `all_renders`:
 jahuty = Jahuty::Client.new(api_key: 'YOUR_API_KEY', cache: cache)
 
 # Sends a network request, caches each render, and returns the collection.
-jahuty.snippets.all_renders 'YOUR_TAG';
+jahuty.snippets.all_renders 'YOUR_TAG'
 
 # If this reder exists in the collection, the cached value will be used instead
 # of sending a network request for the latest version.
-jahuty.snippets.render YOUR_SNIPPET_ID;
+jahuty.snippets.render YOUR_SNIPPET_ID
 ```
 
 This is a powerful feature, especially when combined with a persistent cache. Using the `all_renders` method, you can render and cache an arbitrarily large chunk of content with a single network request. Because any subsequent call to `render` a snippet in the collection will use its cached version, you can reduce the number of network requests to load your content.

data/lib/jahuty/resource/problem.rb

@@ -18,7 +18,7 @@ module Jahuty
         raise ArgumentError.new, 'Key :type missing' unless data.key?(:type)
         raise ArgumentError.new, 'Key :detail missing' unless data.key?(:detail)
 
-        Problem.new(data.slice(:status, :type, :detail))
+        Problem.new(**data.slice(:status, :type, :detail))
       end
     end
   end

data/lib/jahuty/resource/render.rb

@@ -15,7 +15,7 @@ module Jahuty
         raise ArgumentError.new, 'Key :content missing' unless data.key?(:content)
         raise ArgumentError.new, 'Key :snippet_id missing' unless data.key?(:snippet_id)
 
-        Render.new(data.slice(:content, :snippet_id))
+        Render.new(**data.slice(:content, :snippet_id))
       end
 
       def to_s

data/lib/jahuty/service/snippet.rb

@@ -20,15 +20,15 @@ module Jahuty
         renders
       end
 
-      def render(snippet_id, params: {}, expires_in: @expires_in, prefer_latest: @prefer_latest)
+      def render(snippet_id, params: {}, expires_in: @expires_in, prefer_latest: @prefer_latest, location: nil)
         key = cache_key snippet_id: snippet_id, params: params, latest: prefer_latest
 
-        render = @cache.read(key)
+        render = @cache.read key
 
         @cache.delete key unless render.nil? || cacheable?(expires_in)
 
         if render.nil?
-          render = show_render snippet_id: snippet_id, params: params, prefer_latest: prefer_latest
+          render = show_render snippet_id: snippet_id, params: params, prefer_latest: prefer_latest, location: location
 
           @cache.write key, render, expires_in: expires_in if cacheable?(expires_in)
         end
@@ -81,10 +81,11 @@ module Jahuty
         @client.request action
       end
 
-      def show_render(snippet_id:, params: {}, prefer_latest: false)
+      def show_render(snippet_id:, params: {}, prefer_latest: false, location: nil)
         request_params = {}
         request_params[:params] = params.to_json unless params.empty?
         request_params[:latest] = 1 if prefer_latest
+        request_params[:location] = location unless location.nil?
 
         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.3.1'
+  VERSION = '3.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jahuty
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 3.4.0
 platform: ruby
 authors:
 - Jack Clayton
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-02 00:00:00.000000000 Z
+date: 2021-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop-packaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -185,18 +199,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- jahuty.gemspec
 - lib/jahuty.rb
 - lib/jahuty/action/base.rb
 - lib/jahuty/action/index.rb
@@ -223,13 +228,13 @@ metadata:
   homepage_uri: https://www.jahuty.com
   source_code_uri: https://github.com/jahuty/jahuty-ruby
   changelog_uri: https://github.com/jahuty/jahuty-ruby/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -238,8 +243,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Jahuty's Ruby SDK.
 test_files: []

data/.circleci/config.yml

@@ -1,33 +0,0 @@
-version: 2.1
-orbs:
-  ruby: circleci/ruby@0.1.2
-  codecov: codecov/codecov@1.1.3
-jobs:
-  build:
-    docker:
-      - image: circleci/ruby:2.6.3-stretch-node
-    executor: ruby/default
-    steps:
-      - checkout
-      - run:
-          name: Update bundler
-          command: gem install bundler
-      - run:
-          name: Which bundler?
-          command: bundle -v
-      - ruby/bundle-install
-      - run:
-          name: Run rubocop
-          command: bundle exec rake rubocop
-      - run:
-          name: Run specs
-          command: |
-            bundle exec rspec --profile 10 \
-                              --format RspecJunitFormatter \
-                              --out test_results/rspec.xml \
-                              --format progress \
-                              $(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)
-      - store_test_results:
-          path: test_results
-      - codecov/upload:
-          file: ./coverage/coverage.xml

data/.gitignore

@@ -1,45 +0,0 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-# RSpec artifacts
-.rspec_status
-
-# Used by dotenv library to load environment variables.
-.env
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-Gemfile.lock
-.ruby-version
-.ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,23 +0,0 @@
-require:
- - rubocop-performance
- - rubocop-rspec
-AllCops:
-  TargetRubyVersion: 2.6
-  NewCops: enable
-  Exclude:
-   - vendor/bundle/**/*
-Metrics/BlockLength:
-  Exclude:
-    - 'jahuty.gemspec'
-    - 'Rakefile'
-    - '**/*.rake'
-    - 'spec/**/*.rb'
-Metrics/ModuleLength:
-  Exclude:
-    - 'spec/**/*.rb'
-RSpec/ExampleLength:
-  Exclude:
-    - 'spec/jahuty/system_spec.rb'
-RSpec/MultipleExpectations:
-  Exclude:
-    - 'spec/jahuty/system_spec.rb'

data/Gemfile

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in jahuty.gemspec
-gemspec

data/Rakefile

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec
-
-RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-performance'
-  task.requires << 'rubocop-rspec'
-end

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'jahuty/snippets'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,10 +0,0 @@
-#!/usr/bin/env bash
-# frozen_string_literal: true
-
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/jahuty.gemspec

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'jahuty/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'jahuty'
-  spec.version       = Jahuty::VERSION
-  spec.authors       = ['Jack Clayton']
-  spec.email         = ['jack@jahuty.com']
-
-  spec.summary       = 'Jahuty\'s Ruby SDK.'
-  spec.description   = 'Turn any page into a content-managed page.'
-  spec.homepage      = 'https://www.jahuty.com'
-  spec.license       = 'MIT'
-
-  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/jahuty/jahuty-ruby'
-  spec.metadata['changelog_uri'] = 'https://github.com/jahuty/jahuty-ruby/blob/master/CHANGELOG.md'
-
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.required_ruby_version = '~> 2.6'
-
-  spec.add_dependency 'faraday', '~> 1.0'
-  spec.add_dependency 'mini_cache', '~> 1.1'
-
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 12.3'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rspec_junit_formatter', '~>0.4'
-  spec.add_development_dependency 'rubocop', '~> 1.7'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.9'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.1'
-  spec.add_development_dependency 'simplecov', '~>0.20'
-  spec.add_development_dependency 'simplecov-cobertura', '~> 1.4'
-  spec.add_development_dependency 'webmock', '~> 3.11'
-end