jahuty 2.1.0 → 3.2.1

data/lib/jahuty/service/base.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Jahuty
+  module Service
+    # Provides common logic to services.
+    class Base
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/jahuty/service/snippet.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Jahuty
+  module Service
+    # A service for interacting with snippets.
+    class Snippet < Base
+      def initialize(client:, cache:, expires_in: nil)
+        super(client: client)
+
+        @cache = cache
+        @expires_in = expires_in
+      end
+
+      def all_renders(tag, params: {}, expires_in: nil)
+        renders = index_renders tag: tag, params: params
+
+        cache_renders renders: renders, params: params, expires_in: expires_in
+
+        renders
+      end
+
+      def render(snippet_id, params: {}, expires_in: nil)
+        expires_in ||= @expires_in
+
+        key = cache_key snippet_id: snippet_id, params: params
+
+        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
+
+          @cache.write key, render, expires_in: expires_in if cacheable?(expires_in)
+        end
+
+        render
+      end
+
+      private
+
+      def cache_key(snippet_id:, params: {})
+        fingerprint = Digest::MD5.new
+        fingerprint << "snippets/#{snippet_id}/render/"
+        fingerprint << params.to_json
+
+        "jahuty_#{fingerprint.hexdigest}"
+      end
+
+      def cache_renders(renders:, params:, expires_in: nil)
+        expires_in ||= @expires_in
+
+        return unless cacheable?(expires_in)
+
+        global_params = params['*'] || {}
+
+        renders.each do |render|
+          local_params = params[render.snippet_id.to_s] || {}
+          render_params = ::Jahuty::Util.deep_merge global_params, local_params
+
+          key = cache_key snippet_id: render.snippet_id, params: render_params
+
+          @cache.write key, render, expires_in: expires_in
+        end
+      end
+
+      def cacheable?(expires_in)
+        expires_in.nil? || expires_in.positive?
+      end
+
+      def index_renders(tag:, params: {})
+        request_params = { tag: tag }
+        request_params[:params] = params.to_json unless params.empty?
+
+        action = ::Jahuty::Action::Index.new(
+          resource: 'render',
+          params: request_params
+        )
+
+        @client.request action
+      end
+
+      def show_render(snippet_id:, params: {})
+        request_params = {}
+        request_params[:params] = params.to_json unless params.empty?
+
+        action = ::Jahuty::Action::Show.new(
+          id: snippet_id,
+          resource: 'render',
+          params: request_params
+        )
+
+        @client.request action
+      end
+    end
+  end
+end

data/lib/jahuty/util.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Jahuty
+  # Utility methods.
+  class Util
+    # Deeply merges two hashes like Rails.
+    #
+    # Ideally, the API and this library could use the same method to merge
+    # parameters. This library's method just needs to be deterministic and not
+    # collide distinct combinations.
+    #
+    # @see  https://github.com/rails/rails/blob/main/activesupport/lib/active_support/core_ext/hash/deep_merge.rb
+    def self.deep_merge(first_hash, other_hash, &block)
+      first_hash.merge!(other_hash) do |key, first_val, other_val|
+        if first_val.is_a?(Hash) && other_val.is_a?(Hash)
+          deep_merge(first_val, other_val, &block)
+        elsif block
+          yield(key, first_val, other_val)
+        else
+          other_val
+        end
+      end
+    end
+  end
+end

data/lib/jahuty/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jahuty
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.2.1
 platform: ruby
 authors:
 - Jack Clayton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-28 00:00:00.000000000 Z
+date: 2021-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: mini_cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,104 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
 description: Turn any page into a content-managed page.
 email:
 - jack@jahuty.com
@@ -73,8 +185,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -84,26 +198,40 @@ files:
 - bin/setup
 - jahuty.gemspec
 - lib/jahuty.rb
-- lib/jahuty/data/problem.rb
-- lib/jahuty/data/render.rb
-- lib/jahuty/exception/not_ok.rb
-- lib/jahuty/service/connect.rb
-- lib/jahuty/service/render.rb
-- lib/jahuty/snippet.rb
+- lib/jahuty/action/base.rb
+- lib/jahuty/action/index.rb
+- lib/jahuty/action/show.rb
+- lib/jahuty/api/client.rb
+- lib/jahuty/cache/facade.rb
+- lib/jahuty/client.rb
+- lib/jahuty/exception/error.rb
+- lib/jahuty/request/base.rb
+- lib/jahuty/request/factory.rb
+- lib/jahuty/resource/factory.rb
+- lib/jahuty/resource/problem.rb
+- lib/jahuty/resource/render.rb
+- lib/jahuty/response/handler.rb
+- lib/jahuty/service/base.rb
+- lib/jahuty/service/snippet.rb
+- lib/jahuty/util.rb
 - lib/jahuty/version.rb
-homepage: https://github.com/jahuty/jahuty-ruby
+homepage: https://www.jahuty.com
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
+  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: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/jahuty/data/problem.rb

@@ -1,21 +0,0 @@
-module Jahuty
-  module Data
-    class Problem
-      attr_accessor :status, :type, :detail
-
-      def initialize(status, type, detail)
-        @status = status
-        @type   = type
-        @detail = detail
-      end
-
-      def self.from(data)
-        raise ArgumentError.new "Key :status does not exist" if !data.key?(:status)
-        raise ArgumentError.new "Key :type does not exist" if !data.key?(:type)
-        raise ArgumentError.new "Key :detail does not exist" if !data.key?(:detail)
-
-        Problem.new(data[:status], data[:type], data[:detail])
-      end
-    end
-  end
-end

data/lib/jahuty/data/render.rb

@@ -1,21 +0,0 @@
-module Jahuty
-  module Data
-    class Render
-      attr_accessor :content
-
-      def initialize(content)
-        @content = content
-      end
-
-      def self.from(data)
-        raise ArgumentError.new "Key :content does not exist" if !data.key?(:content)
-
-        Render.new(data[:content])
-      end
-
-      def to_s
-        @content
-      end
-    end
-  end
-end

data/lib/jahuty/service/connect.rb

@@ -1,23 +0,0 @@
-require "faraday"
-
-module Jahuty
-  module Service
-    class Connect
-      URL = "https://api.jahuty.com"
-
-      HEADERS  = {
-        "Accept":          "application/json;q=0.9,*/*;q=0.8",
-        "Accept-Encoding": "gzip, deflate",
-        "Content-Type":    "application/json; charset=utf-8",
-        "User-Agent":      "Jahuty Ruby client #{::Jahuty::VERSION}"
-      }
-
-      def call(key)
-        Faraday.new(
-          url: URL,
-          headers: {"Authorization": "Bearer #{key}"}.merge(HEADERS)
-        )
-      end
-    end
-  end
-end

data/lib/jahuty/service/render.rb

@@ -1,25 +0,0 @@
-require "json"
-
-module Jahuty
-  class Service::Render
-    @connection
-
-    def initialize(connection)
-      @connection = connection
-    end
-
-    def call(id, options = {})
-      settings = { params: options[:params].to_json } unless options[:params].nil?
-
-      response = @connection.get("snippets/#{id}/render", settings || {})
-
-      payload = JSON.parse(response.body, symbolize_names: true)
-
-      if response.status != 200
-        raise Exception::NotOk.new(Data::Problem.from(payload))
-      end
-
-      return Data::Render.from(payload)
-    end
-  end
-end

data/lib/jahuty/snippet.rb

@@ -1,15 +0,0 @@
-module Jahuty
-  class Snippet
-    @get
-
-    class << self
-      def render(id, options = {})
-        raise "API key not set. Did you use Jahuty.key?" unless Jahuty.key?
-
-        @get ||= Service::Render.new(Service::Connect.new.call(Jahuty.key))
-
-        @get.call(id, options)
-      end
-    end
-  end
-end