wcc-blogs-client 0.7.2 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31db17ab6f4a265987b00b832872f9012ab6eb28c4fbbbb64796b0095e3662a3
-  data.tar.gz: c6722de62467c9c08fc0eca404a17e2bb269203ed49ac7cfd27ad0b2749d9d0f
+  metadata.gz: 87ed8ad6c2bba6a5ec40b965ac6e851d83500a937772af594031025641477d10
+  data.tar.gz: 0f8da147c4fd4351c8b49330eed0b137135ae06a1563c1c87ce733eacf228ca4
 SHA512:
-  metadata.gz: fa5fc97d7196188bb4a31f74c822aa79c1c5f161e4f97bb0a7be36461640d9260746609b55b044a06a14f5a561dc2f7a83370305178fa278cc7a3f4ef4b00a66
-  data.tar.gz: 59b189fa06be52a11a85d2d4f9a3d0f1d5b2747e396dc19848d88b24fc59ddf5091f643b6157d67f0b55537774899dd69360c716722ae3ac763a3475ae99839e
+  metadata.gz: 5955d420482431af87ef23296d2bc5824b129afcae1ee6b7c3311ad28db927d53252b6ed3a366f829e6151f5b099b23ade0b857afa608afd5a315dcdbb646824
+  data.tar.gz: 6c2735ee2b49e9ec94c73a6501d116954ddc32ec8584cd92dfa419a2b3db2768085e3cddf2b14fe8097a9575e4da34807eab1605068450bf7811d7e9cbeb311e

data/.rubocop.yml

@@ -1,31 +1,13 @@
-inherit_from: .rubocop_todo.yml
-
 AllCops:
-  DisplayCopNames: true
   TargetRubyVersion: 2.3
-
-Lint/AssignmentInCondition:
-  Enabled: false
-
-Metrics/BlockLength:
+  # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
+  # to ignore them, so only the ones explicitly set in this file are enabled.
+  DisabledByDefault: true
   Exclude:
+    - '**/templates/**/*'
+    - '**/vendor/**/*'
+  Include:
+    - 'lib/**/*'
+    - 'Gemfile'
     - 'wcc-blogs-client.gemspec'
-    - 'spec/**/*'
-
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
 
-Style/DoubleNegation:
-  Enabled: false
-
-Style/MultilineBlockChain:
-  Exclude:
-    - 'spec/**/*'
-
-Style/BlockDelimiters:
-  Exclude:
-    # we like the `let(:foo) {}` syntax in specs
-    - 'spec/**/*.rb'

data/.ruby-version

@@ -0,0 +1 @@
+2.7.6

data/lib/wcc/blogs/client.rb

@@ -8,6 +8,15 @@ module WCC::Blogs
   class Client
     attr_reader :base_url, :default_property, :base_path
 
+    def options
+      {
+        default_property: @default_property,
+        base_url: @base_url,
+        connection: @connection,
+        query_defaults: @query_defaults
+      }
+    end
+
     def initialize(**options)
       if options[:publishing_target]
         raise ArgumentError, 'publishing_target has been renamed to default_property'
@@ -18,7 +27,9 @@ module WCC::Blogs
       @base_path = base_url.path == '' ? '/api/v1' : base_url.path
       @base_url = base_url.to_s
       @connection = options[:connection] || default_connection
-      @query_defaults = options[:query_defaults] || {}
+      @query_defaults = options.slice(:preview)
+      @query_defaults[:preview] = 'devslikepizza' if options[:preview] == true
+      @query_defaults.merge!(options[:query_defaults] || {})
     end
 
     # performs an HTTP GET request to the specified path within the configured
@@ -99,7 +110,6 @@ module WCC::Blogs
                     store: default_cache_store,
                     serializer: Marshal
         faraday.response :logger, (Rails.logger if defined?(Rails)), headers: false, bodies: false
-        faraday.adapter :typhoeus
       end
     end
 

data/lib/wcc/blogs/collection.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
+require_relative './concerns/caching'
+
 module WCC::Blogs
   class Collection
     extend WCC::Blogs::Utils
+    include WCC::Blogs::Concerns::Caching
 
-    def self.find(key = nil)
-      new(WCC::Blogs.client.collection_show(key).raw, client: WCC::Blogs.client)
+    def self.find(key = nil, client: WCC::Blogs.client)
+      new(client.collection_show(key).raw, client: client)
     end
 
     attr_reader :raw
@@ -45,6 +48,10 @@ module WCC::Blogs
       OpenStruct.new(raw['_links'] || {})
     end
 
-    alias cache_key digest
+    private
+
+    def cache_key_without_version
+      "WCC::Blogs::Collection/#{key}"
+    end
   end
 end

data/lib/wcc/blogs/concerns/caching.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module WCC::Blogs::Concerns
+  module Caching
+    def cache_key
+      unless defined?(ActiveRecord::Base) &&
+             ActiveRecord::Base.respond_to?(:cache_versioning) &&
+             ActiveRecord::Base.cache_versioning == true
+        return cache_key_with_version
+      end
+
+      cache_key_without_version
+    end
+
+    # https://guides.rubyonrails.org/caching_with_rails.html#low-level-caching
+    def cache_key_with_version
+      [cache_key_without_version, cache_version].join('/')
+    end
+
+    def cache_version
+      updated_at&.to_i
+    end
+  end
+end

data/lib/wcc/blogs/linked_blog_post_summary.rb

@@ -12,11 +12,12 @@ module WCC::Blogs
     end
 
     def full_post
-      Post.new(@client.get(_links.self).raw)
+      Post.new(@client.get(_links.self).raw, client: @client)
     end
 
     define_camelcase_alias(
       'title',
+      'subtitle',
       'slug'
     ) do |camelcase|
       raw[camelcase]

data/lib/wcc/blogs/post.rb

@@ -1,16 +1,19 @@
 # frozen_string_literal: true
 
+require_relative './concerns/caching'
+
 module WCC::Blogs
   class Post
     extend WCC::Blogs::Utils
+    include WCC::Blogs::Concerns::Caching
     require 'time'
 
-    def self.find(slug)
-      new(WCC::Blogs.client.blog_show(slug).raw, client: WCC::Blogs.client)
+    def self.find(slug, client: WCC::Blogs.client)
+      new(client.blog_show(slug).raw, client: client)
     end
 
-    def self.find_all
-      PostSummary.find_all.map(&:full_post)
+    def self.find_all(client: WCC::Blogs.client)
+      PostSummary.find_all(client: client).map(&:full_post)
     end
 
     attr_reader :raw
@@ -26,6 +29,7 @@ module WCC::Blogs
 
     def html
       @html ||= @client.get(_links.fragment)
+                       .assert_ok!
                        .body
                        .force_encoding('UTF-8')
     end
@@ -38,11 +42,6 @@ module WCC::Blogs
       true
     end
 
-    def time_to_read
-      # TODO
-      nil
-    end
-
     def to_param
       slug.sub(%r{^/}, '')
     end
@@ -57,11 +56,14 @@ module WCC::Blogs
       'path',
       'digest',
       'fragment_path',
-      'read_time'
+      'read_time',
+      'word_count'
     ) do |camelcase|
       raw[camelcase]
     end
 
+    alias time_to_read read_time
+
     define_camelcase_alias(
       'date',
       'updated_at'
@@ -103,6 +105,10 @@ module WCC::Blogs
       related.map { |val| WCC::Blogs::LinkedBlogPostSummary.new(val, client: @client) }
     end
 
-    alias cache_key digest
+    private
+
+    def cache_key_without_version
+      "WCC::Blogs::Post/#{slug}"
+    end
   end
 end

data/lib/wcc/blogs/post_summary.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
+require_relative './concerns/caching'
+
 module WCC::Blogs
   class PostSummary
     extend WCC::Blogs::Utils
+    include WCC::Blogs::Concerns::Caching
 
-    def self.find_all
-      WCC::Blogs.client.blog_list.items.map do |summary|
-        new(summary, client: WCC::Blogs.client)
+    def self.find_all(client: WCC::Blogs.client)
+      client.blog_list.items.map do |summary|
+        new(summary, client: client)
       end
     end
 
@@ -18,7 +21,7 @@ module WCC::Blogs
     end
 
     def full_post
-      Post.new(@client.get(_links.self).raw)
+      Post.new(@client.get(_links.self).raw, client: @client)
     end
 
     define_camelcase_alias(
@@ -27,7 +30,8 @@ module WCC::Blogs
       'subtitle',
       'slug',
       'digest',
-      'read_time'
+      'read_time',
+      'word_count'
     ) do |camelcase|
       raw[camelcase]
     end
@@ -64,6 +68,10 @@ module WCC::Blogs
       values.map { |val| OpenStruct.new(val) if val }
     end
 
-    alias cache_key digest
+    private
+
+    def cache_key_without_version
+      "WCC::Blogs::PostSummary/#{slug}"
+    end
   end
 end

data/lib/wcc/blogs/property.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
+require_relative './concerns/caching'
+
 module WCC::Blogs
   class Property
     extend WCC::Blogs::Utils
+    include WCC::Blogs::Concerns::Caching
     require 'time'
 
-    def self.find(property = nil)
-      new(WCC::Blogs.client.property_show(property).raw, client: WCC::Blogs.client)
+    def self.find(property = nil, client: WCC::Blogs.client)
+      new(client.property_show(property).raw, client: client)
     end
 
     attr_reader :raw
@@ -41,6 +44,10 @@ module WCC::Blogs
       targets.map { |val| OpenStruct.new(val) if val }
     end
 
-    alias cache_key digest
+    private
+
+    def cache_key_without_version
+      "WCC::Blogs::Property/#{key}"
+    end
   end
 end

data/lib/wcc/blogs/version.rb

@@ -2,6 +2,6 @@
 
 module WCC
   module Blogs
-    VERSION = '0.7.2'
+    VERSION = '0.7.4'
   end
 end

data/lib/wcc/blogs.rb

@@ -17,10 +17,14 @@ require 'wcc/blogs/collection_summary'
 
 module WCC::Blogs
   class << self
-    attr_writer :client
+    attr_writer :client, :preview_client
 
     def client
       @client || raise(WCC::Blogs::NotConfiguredException, 'Not configured')
     end
+
+    def preview_client
+      @preview_client ||= WCC::Blogs::Client.new(**client.options.merge(preview: true))
+    end
   end
 end

data/wcc-blogs-client.gemspec

@@ -24,8 +24,8 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'faraday', '~> 0.15.4'
-  spec.add_runtime_dependency 'faraday-http-cache', '~> 1.3'
+  spec.add_runtime_dependency 'faraday', '>= 0.15.4'
+  spec.add_runtime_dependency 'faraday-http-cache', '>= 1.3'
   spec.add_runtime_dependency 'wcc-base'
 
   spec.add_development_dependency 'guard', '~> 2.15'
@@ -34,7 +34,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec_junit_formatter', '~> 0.3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.60.0'
-  spec.add_development_dependency 'typhoeus'
+  spec.add_development_dependency 'rubocop', '~> 0.71.0'
   spec.add_development_dependency 'webmock', '~> 3.0'
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: wcc-blogs-client
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.4
 platform: ruby
 authors:
 - Watermark Dev
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-28 00:00:00.000000000 Z
+date: 2022-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.15.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.15.4
 - !ruby/object:Gem::Dependency
   name: faraday-http-cache
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
@@ -142,28 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.60.0
+        version: 0.71.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.60.0
-- !ruby/object:Gem::Dependency
-  name: typhoeus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.71.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -187,7 +173,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
+- ".ruby-version"
 - Gemfile
 - Guardfile
 - README.md
@@ -197,6 +183,7 @@ files:
 - lib/wcc/blogs/client/response.rb
 - lib/wcc/blogs/collection.rb
 - lib/wcc/blogs/collection_summary.rb
+- lib/wcc/blogs/concerns/caching.rb
 - lib/wcc/blogs/errors.rb
 - lib/wcc/blogs/linked_blog_post_summary.rb
 - lib/wcc/blogs/metadata.rb
@@ -210,7 +197,7 @@ homepage: https://github.com/watermarkchurch/papyrus/wcc-blogs-client
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -225,9 +212,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: ''
 test_files: []

data/.rubocop_todo.yml

@@ -1,44 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2019-05-13 14:26:19 -0500 using RuboCop version 0.60.0.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 1
-# Configuration parameters: Include.
-# Include: **/*.gemspec
-Gemspec/RequiredRubyVersion:
-  Exclude:
-    - 'wcc-blogs-client.gemspec'
-
-# Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: line_count_dependent, lambda, literal
-Style/Lambda:
-  Exclude:
-    - 'lib/wcc/blogs/client.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
-# SupportedStyles: single_quotes, double_quotes
-Style/StringLiterals:
-  Exclude:
-    - 'Rakefile'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, no_comma
-Style/TrailingCommaInHashLiteral:
-  Exclude:
-    - 'lib/wcc/blogs/client.rb'
-
-# Offense count: 8
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 106