wcc-blogs-client 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0ee40f5dbfa5ed338bfcfc4ef0a28cf1fac1554
-  data.tar.gz: cd4b83add94f175077a9a31062caf2a7a9a0dd64
+  metadata.gz: b57eccdc0dfb25b616fd887781eb5e3f18b0f00f
+  data.tar.gz: 9a0d581af31bbdc61ba14cfe8a4d90ce99957c21
 SHA512:
-  metadata.gz: 1b3cb2d385fe25b0c312e2e742d2245f7f4e6eb1a58bc7a4b140b210bb612cab8fcb396c16afbbedfb36555f9c6ed5e73387854b5c477b8b7af3c28f99d2b9b1
-  data.tar.gz: 2efbf1c351083e6460b1e09db3a383f8e6c6c48ac9ad25720e6a3982823545e11d5080ab77d3772da86e2150e91b29ef3ba91e7dcb2ec302d0d1339b0edcd3d7
+  metadata.gz: f418d9d819344d62bf97154b6eb4b516d742e1929e50ba6f295eb43844d9e89d222659d0f4ffc0d6146a90430dc1392a9c1002ee11b57cabd011b04546b51fa6
+  data.tar.gz: a2f240ce41b866dfa44e8cda879c522f7e41523cb979f145db96b2db2894dd3c7153afb50678f64294bc17dbeb411e2c845805fbe9ebe8540304940636793e41

data/.rubocop.yml

@@ -1,5 +1,9 @@
 inherit_from: .rubocop_todo.yml
 
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3
+
 Lint/AssignmentInCondition:
   Enabled: false
 

data/Guardfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 directories %w[lib spec]
 
 group :red_green_refactor, halt_on_fail: true do

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_helper"
 
 Bundler::GemHelper.install_tasks

data/lib/wcc/blogs.rb

@@ -10,6 +10,10 @@ require 'wcc/blogs/errors'
 require 'wcc/blogs/metadata'
 require 'wcc/blogs/post'
 require 'wcc/blogs/post_summary'
+require 'wcc/blogs/linked_blog_post_summary'
+require 'wcc/blogs/property'
+require 'wcc/blogs/collection'
+require 'wcc/blogs/collection_summary'
 
 module WCC::Blogs
   class << self

data/lib/wcc/blogs/client.rb

@@ -6,11 +6,17 @@ require_relative 'client/response'
 
 module WCC::Blogs
   class Client
-    attr_reader :base_url, :publishing_target
+    attr_reader :base_url, :default_property, :base_path
 
-    def initialize(publishing_target:, **options)
-      @publishing_target = publishing_target
-      @base_url = options[:base_url] || 'https://di0v2frwtdqnv.cloudfront.net'
+    def initialize(**options)
+      if options[:publishing_target]
+        raise ArgumentError, 'publishing_target has been renamed to default_property'
+      end
+
+      @default_property = options[:default_property]
+      base_url = URI.parse(options[:base_url] || 'https://di0v2frwtdqnv.cloudfront.net')
+      @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] || {}
     end
@@ -26,27 +32,40 @@ module WCC::Blogs
                    get_http(url, query))
     end
 
-    def blog_post(slug, digest: nil) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-      path = '/blog/' + slug.sub(%r{^/}, '')
-      path += '/' + digest if digest
-      path += '.json'
+    def property_show(property = nil)
+      property ||= default_property
+      raise ArgumentError, 'No Property given' unless property
+
+      path = base_path + '/property/' + property
+      get(path).assert_ok!
+    end
+
+    def collection_show(key)
+      path = base_path + '/collection/' + key
+      get(path).assert_ok!
+    end
+
+    def blog_list(property: nil, year: nil)
+      property ||= default_property
+      raise ArgumentError, 'No Property given' unless property
+
+      path = base_path + '/property/' + property + '/blog'
+      path += '/' + year if year
+      get(path).assert_ok!
+    end
+
+    def blog_show(slug, digest: nil)
+      path = base_path + '/blog/' + slug.sub(%r{^/}, '')
+      path += '/' + digest + '.json' if digest
 
       get(path).tap do |resp|
         resp.assert_ok!
-        next if resp.raw['publishingTargets'].any? { |t| t['key'] == publishing_target }
-
-        raise WCC::Blogs::NotFoundException,
-              "Blog post '#{slug}' is not published to #{publishing_target}"
+        check_default_property(resp)
       end
     rescue WCC::Blogs::Client::NotFoundError => e
       raise WCC::Blogs::NotFoundException, e.message
     end
 
-    def list
-      path = '/targets/' + publishing_target + '.json'
-      get(path).assert_ok!
-    end
-
     private
 
     def get_http(url, query, headers = {})
@@ -64,6 +83,14 @@ module WCC::Blogs
       end
     end
 
+    def check_default_property(resp)
+      return unless default_property
+      return if resp.raw['publishedProperties'].any? { |t| t['key'] == default_property }
+
+      raise WCC::Blogs::NotFoundException,
+            "Blog post '#{resp.raw['slug']}' is not published to #{default_property}"
+    end
+
     def default_connection
       ::Faraday.new do |faraday|
         faraday.use :http_cache,

data/lib/wcc/blogs/client/response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 
 module WCC::Blogs
@@ -18,7 +20,7 @@ module WCC::Blogs
       alias_method :to_json, :raw
 
       def next_page_url
-        raw.dig('_links', 'previous')
+        raw.dig('_links', 'next')
       end
 
       def next_page?

data/lib/wcc/blogs/collection.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module WCC::Blogs
+  class Collection
+    extend WCC::Blogs::Utils
+
+    def self.find(key = nil)
+      new(WCC::Blogs.client.collection_show(key).raw, client: WCC::Blogs.client)
+    end
+
+    attr_reader :raw
+
+    def initialize(raw, client: WCC::Blogs.client)
+      @raw = raw
+      @client = client
+    end
+
+    def to_param
+      key
+    end
+
+    define_camelcase_alias(
+      'key',
+      'title',
+      'digest'
+    ) do |camelcase|
+      raw[camelcase]
+    end
+
+    def posts
+      @posts ||=
+        (raw['posts'] || []).map do |summary|
+          PostSummary.new(summary, client: @client)
+        end
+    end
+
+    def _links
+      OpenStruct.new(raw['_links'] || {})
+    end
+
+    alias cache_key digest
+  end
+end

data/lib/wcc/blogs/collection_summary.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module WCC::Blogs
+  class CollectionSummary
+    extend WCC::Blogs::Utils
+
+    attr_reader :raw
+
+    def initialize(raw, client: WCC::Blogs.client)
+      @raw = raw
+      @client = client
+    end
+
+    define_camelcase_alias(
+      'key',
+      'title'
+    ) do |camelcase|
+      raw[camelcase]
+    end
+
+    def posts
+      @posts ||=
+        (raw['posts'] || []).map do |summary|
+          WCC::Blogs::LinkedBlogPostSummary.new(summary, client: @client)
+        end
+    end
+  end
+end

data/lib/wcc/blogs/linked_blog_post_summary.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module WCC::Blogs
+  class LinkedBlogPostSummary
+    extend WCC::Blogs::Utils
+
+    attr_reader :raw
+
+    def initialize(raw, client: WCC::Blogs.client)
+      @raw = raw
+      @client = client
+    end
+
+    def full_post
+      Post.new(@client.get(_links.self).raw)
+    end
+
+    define_camelcase_alias(
+      'title',
+      'slug'
+    ) do |camelcase|
+      raw[camelcase]
+    end
+
+    define_camelcase_alias(
+      'date'
+    ) do |camelcase|
+      value = raw[camelcase]
+
+      Time.parse(value) if value&.length
+    end
+
+    def _links
+      OpenStruct.new(raw['_links'] || {})
+    end
+  end
+end

data/lib/wcc/blogs/metadata.rb

@@ -12,13 +12,15 @@ module WCC::Blogs
 
     define_camelcase_alias(
       'id',
-      'canonical_link',
+      'canonical_url',
       'meta_description',
       'meta_flag'
     ) do |camelcase|
       raw[camelcase]
     end
 
+    alias canonical_link canonical_url
+
     define_camelcase_alias('meta_keywords') do |camelcase|
       next unless keywords = raw[camelcase]
 

data/lib/wcc/blogs/post.rb

@@ -6,7 +6,7 @@ module WCC::Blogs
     require 'time'
 
     def self.find(slug)
-      new(WCC::Blogs.client.blog_post(slug).raw, client: WCC::Blogs.client)
+      new(WCC::Blogs.client.blog_show(slug).raw, client: WCC::Blogs.client)
     end
 
     def self.find_all
@@ -21,13 +21,11 @@ module WCC::Blogs
     end
 
     def author_full_name
-      return unless author
-
-      [author.firstName, author.lastName].compact.join(' ')
+      author&.fullName
     end
 
     def html
-      @html ||= @client.get(URI.join(host, fragment_path).to_s)
+      @html ||= @client.get(_links.fragment)
                        .body
                        .force_encoding('UTF-8')
     end
@@ -53,6 +51,7 @@ module WCC::Blogs
       'id',
       'title',
       'subtitle',
+      'summary',
       'slug',
       'host',
       'path',
@@ -68,23 +67,41 @@ module WCC::Blogs
     ) do |camelcase|
       value = raw[camelcase]
 
-      Time.parse(value) if value && value.length
+      Time.parse(value) if value&.length
     end
 
     define_camelcase_alias(
       'author',
       'hero_image',
-      'thumbnail_image'
+      'thumbnail_image',
+      'flags'
     ) do |camelcase|
       OpenStruct.new(raw[camelcase]) if raw[camelcase]
     end
 
-    define_camelcase_alias('publishing_targets') do |camelcase|
+    def _links
+      OpenStruct.new(raw['_links'] || {})
+    end
+
+    define_camelcase_alias(
+      'published_properties',
+      'categories',
+      'tags'
+    ) do |camelcase|
       targets = raw[camelcase] || []
 
       targets.map { |val| OpenStruct.new(val) if val }
     end
 
+    def collection
+      CollectionSummary.new(raw['collection'], client: @client) if raw['collection']
+    end
+
+    define_camelcase_alias('related_posts') do |camelcase|
+      related = raw[camelcase] || []
+      related.map { |val| WCC::Blogs::LinkedBlogPostSummary.new(val, client: @client) }
+    end
+
     alias cache_key digest
   end
 end

data/lib/wcc/blogs/post_summary.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module WCC::Blogs
   class PostSummary
     extend WCC::Blogs::Utils
 
     def self.find_all
-      WCC::Blogs.client.list.items.map do |summary|
+      WCC::Blogs.client.blog_list.items.map do |summary|
         new(summary, client: WCC::Blogs.client)
       end
     end
@@ -16,7 +18,7 @@ module WCC::Blogs
     end
 
     def full_post
-      Post.new(@client.blog_post(slug, digest: digest).raw)
+      Post.new(@client.get(_links.self).raw)
     end
 
     define_camelcase_alias(
@@ -24,9 +26,7 @@ module WCC::Blogs
       'title',
       'subtitle',
       'slug',
-      'path',
-      'digest',
-      'fragment_path'
+      'digest'
     ) do |camelcase|
       raw[camelcase]
     end
@@ -37,19 +37,29 @@ module WCC::Blogs
     ) do |camelcase|
       value = raw[camelcase]
 
-      Time.parse(value) if value && value.length
+      Time.parse(value) if value&.length
     end
 
     define_camelcase_alias(
-      'thumbnail_image'
+      'author',
+      'thumbnail_image',
+      'flags'
     ) do |camelcase|
       OpenStruct.new(raw[camelcase]) if raw[camelcase]
     end
 
-    define_camelcase_alias('publishing_targets') do |camelcase|
-      targets = raw[camelcase] || []
+    def _links
+      OpenStruct.new(raw['_links'] || {})
+    end
+
+    define_camelcase_alias(
+      'published_properties',
+      'categories',
+      'tags'
+    ) do |camelcase|
+      values = raw[camelcase] || []
 
-      targets.map { |val| OpenStruct.new(val) if val }
+      values.map { |val| OpenStruct.new(val) if val }
     end
 
     alias cache_key digest

data/lib/wcc/blogs/property.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module WCC::Blogs
+  class Property
+    extend WCC::Blogs::Utils
+    require 'time'
+
+    def self.find(property = nil)
+      new(WCC::Blogs.client.property_show(property).raw, client: WCC::Blogs.client)
+    end
+
+    attr_reader :raw
+
+    def initialize(raw, client: WCC::Blogs.client)
+      @raw = raw
+      @client = client
+    end
+
+    def to_param
+      key
+    end
+
+    define_camelcase_alias(
+      'key',
+      'digest'
+    ) do |camelcase|
+      raw[camelcase]
+    end
+
+    def _links
+      OpenStruct.new(raw['_links'] || {})
+    end
+
+    define_camelcase_alias(
+      'accepted_tags',
+      'categories'
+    ) do |camelcase|
+      targets = raw[camelcase] || []
+
+      targets.map { |val| OpenStruct.new(val) if val }
+    end
+
+    alias cache_key digest
+  end
+end

data/lib/wcc/blogs/utils.rb

@@ -2,6 +2,8 @@
 
 module WCC::Blogs
   module Utils
+    module_function
+
     def camelcase(term)
       term
         .to_s

data/lib/wcc/blogs/version.rb

@@ -2,6 +2,6 @@
 
 module WCC
   module Blogs
-    VERSION = '0.4.0'.freeze
+    VERSION = '0.6.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wcc-blogs-client
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Watermark Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-12 00:00:00.000000000 Z
+date: 2020-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -195,10 +195,14 @@ files:
 - lib/wcc/blogs.rb
 - lib/wcc/blogs/client.rb
 - lib/wcc/blogs/client/response.rb
+- lib/wcc/blogs/collection.rb
+- lib/wcc/blogs/collection_summary.rb
 - lib/wcc/blogs/errors.rb
+- lib/wcc/blogs/linked_blog_post_summary.rb
 - lib/wcc/blogs/metadata.rb
 - lib/wcc/blogs/post.rb
 - lib/wcc/blogs/post_summary.rb
+- lib/wcc/blogs/property.rb
 - lib/wcc/blogs/utils.rb
 - lib/wcc/blogs/version.rb
 - wcc-blogs-client.gemspec
@@ -222,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: ''