wcc-blogs-client 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fe6e7e2f78e21fcfc1152bfafd4d3803092be05
-  data.tar.gz: 04e1df2e485fb58dfa0617650906c615dc986aaa
+  metadata.gz: d0ee40f5dbfa5ed338bfcfc4ef0a28cf1fac1554
+  data.tar.gz: cd4b83add94f175077a9a31062caf2a7a9a0dd64
 SHA512:
-  metadata.gz: b67d47ffa6a706f454c4c3bba183c5597a2b3cb538fa18fe23c36a7a89286cd88875b1cfebc75161f838ca5e8bcb3a7314a1de3500702b58648fdb4862f18826
-  data.tar.gz: 2ec2a66bac4f62eeefee9e24abe1ca113b92ba23014c0d74b44b2fd2b82ebbfc694a6c561ca3b87c833af3f16bf09202c7dce5991a466f57befc53c5d38bc025
+  metadata.gz: 1b3cb2d385fe25b0c312e2e742d2245f7f4e6eb1a58bc7a4b140b210bb612cab8fcb396c16afbbedfb36555f9c6ed5e73387854b5c477b8b7af3c28f99d2b9b1
+  data.tar.gz: 2efbf1c351083e6460b1e09db3a383f8e6c6c48ac9ad25720e6a3982823545e11d5080ab77d3772da86e2150e91b29ef3ba91e7dcb2ec302d0d1339b0edcd3d7

data/.rubocop.yml

@@ -14,6 +14,9 @@ Style/ClassAndModuleChildren:
 Style/Documentation:
   Enabled: false
 
+Style/DoubleNegation:
+  Enabled: false
+
 Style/MultilineBlockChain:
   Exclude:
     - 'spec/**/*'

data/Guardfile

@@ -0,0 +1,32 @@
+directories %w[lib spec]
+
+group :red_green_refactor, halt_on_fail: true do
+  guard :rspec, cmd: 'bundle exec rspec --order rand', all_on_start: false do
+    require 'guard/rspec/dsl'
+    dsl = Guard::RSpec::Dsl.new(self)
+
+    # RSpec files
+    rspec = dsl.rspec
+    watch(rspec.spec_helper) { rspec.spec_dir }
+    watch(rspec.spec_support) { rspec.spec_dir }
+    watch(rspec.spec_files)
+
+    # Ruby files
+    ruby = dsl.ruby
+    dsl.watch_spec_files_for(ruby.lib_files)
+  end
+
+  guard :rubocop, cli: ['--display-cop-names'] do
+    watch(/.+\.rb$/)
+    watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end
+
+group :autofix do
+  guard :rubocop, all_on_start: false, cli: ['--auto-correct', '--display-cop-names'] do
+    watch(/.+\.rb$/)
+    watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end
+
+scope group: :red_green_refactor

data/lib/wcc/blogs.rb

@@ -9,50 +9,14 @@ require 'wcc/blogs/errors'
 
 require 'wcc/blogs/metadata'
 require 'wcc/blogs/post'
+require 'wcc/blogs/post_summary'
 
 module WCC::Blogs
   class << self
-    def configure
-      yield config
-
-      @client = WCC::Blogs::Client.new(config: config)
-
-      config
-    end
+    attr_writer :client
 
     def client
       @client || raise(WCC::Blogs::NotConfiguredException, 'Not configured')
     end
-
-    def config
-      Config.instance
-    end
-  end
-
-  class Config
-    include Singleton
-
-    attr_accessor :publishing_target
-    attr_writer :base_url, :cache, :query_url
-
-    def base_url
-      @base_url || 'https://wcc-papyrus.herokuapp.com'
-    end
-
-    def cache
-      @cache || NilCache.new
-    end
-
-    def query_url
-      @query_url || 'http://papyrus.wcc/graphql'
-    end
-
-    class NilCache
-      def clear; end
-
-      def fetch(*_args)
-        yield
-      end
-    end
   end
 end

data/lib/wcc/blogs/client.rb

@@ -1,42 +1,87 @@
 # frozen_string_literal: true
 
+require 'faraday'
+require 'faraday-http-cache'
+require_relative 'client/response'
+
 module WCC::Blogs
   class Client
-    def initialize(config:)
-      @config = config
+    attr_reader :base_url, :publishing_target
+
+    def initialize(publishing_target:, **options)
+      @publishing_target = publishing_target
+      @base_url = options[:base_url] || 'https://di0v2frwtdqnv.cloudfront.net'
+      @connection = options[:connection] || default_connection
+      @query_defaults = options[:query_defaults] || {}
+    end
+
+    # performs an HTTP GET request to the specified path within the configured
+    # space and environment.  Query parameters are merged with the defaults and
+    # appended to the request.
+    def get(path, query = {})
+      url = URI.join(@base_url, path)
+
+      Response.new(self,
+                   { url: url, query: query },
+                   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'
+
+      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}"
+      end
+    rescue WCC::Blogs::Client::NotFoundError => e
+      raise WCC::Blogs::NotFoundException, e.message
     end
 
-    REDIRECT_HANDLER =
-      ->(resp) {
-        location = resp.headers['Location']
-        digest = File.basename(location).gsub(/\.(fragment|json)$/, '')
+    def list
+      path = '/targets/' + publishing_target + '.json'
+      get(path).assert_ok!
+    end
+
+    private
+
+    def get_http(url, query, headers = {})
+      q = @query_defaults.merge(query || {})
 
-        @config.cache.fetch(['BlogPost', digest, File.extname(location)]) do
-          get(location, resp.effective_url)
+      loop do
+        resp = @connection.get(url, q, headers)
+
+        if [301, 302, 307].include?(resp.status)
+          url = URI.join(@base_url, resp.headers['Location'])
+          next
         end
-      }
-
-    RESPONSE_HANDLERS = {
-      404 => ->(resp) {
-        raise WCC::Blogs::NotFoundException, "Blog post '#{resp.effective_url}' does not exist"
-      },
-      200 => ->(resp) {
-        resp.body
-      },
-      301 => REDIRECT_HANDLER,
-      302 => REDIRECT_HANDLER,
-    }.freeze
-
-    def get(path, base = @config.base_url)
-      url = URI.join(base, path)
-
-      resp = Typhoeus.get(url, followlocation: false)
-
-      if handler = RESPONSE_HANDLERS[resp.code]
-        return instance_exec(resp, &handler)
+
+        return resp
       end
+    end
 
-      raise WCC::Blogs::ApiException, "#{resp.return_code}: #{resp.effective_url}"
+    def default_connection
+      ::Faraday.new do |faraday|
+        faraday.use :http_cache,
+                    shared_cache: false,
+                    logger: (Rails.logger if defined?(Rails)),
+                    store: default_cache_store,
+                    serializer: Marshal
+        faraday.response :logger, (Rails.logger if defined?(Rails)), headers: false, bodies: false
+        faraday.adapter :typhoeus
+      end
+    end
+
+    def default_cache_store
+      if defined?(Rails)
+        Rails.cache
+      elsif defined?(ActiveSupport::Cache)
+        ActiveSupport::Cache.lookup_store(:memory, size: 64.megabytes)
+      end
     end
   end
 end

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

@@ -0,0 +1,106 @@
+require 'forwardable'
+
+module WCC::Blogs
+  class Client
+    Response = Struct.new(:client, :request, :raw_response) do # rubocop:disable Metrics/BlockLength
+      extend Forwardable
+
+      def_delegators :raw_response, :status, :headers
+      alias_method :code, :status
+
+      def body
+        @body ||= raw_response.body.to_s
+      end
+
+      def raw
+        @raw ||= JSON.parse(body)
+      end
+      alias_method :to_json, :raw
+
+      def next_page_url
+        raw.dig('_links', 'previous')
+      end
+
+      def next_page?
+        !!next_page_url
+      end
+
+      def next_page
+        return unless next_page_url
+        return @next_page if @next_page
+
+        np = client.get(next_page_url, request[:query])
+        @next_page = np.assert_ok!
+      end
+
+      def assert_ok!
+        return self if status >= 200 && status < 300
+
+        raise ApiError[status], self
+      end
+
+      def each_page(&block) # rubocop:disable Metrics/MethodLength
+        raise ArgumentError, 'Not a collection response' unless page_items
+
+        ret =
+          Enumerator.new do |y|
+            y << self
+
+            if next_page?
+              next_page.each_page.each do |page|
+                y << page
+              end
+            end
+          end
+
+        if block_given?
+          ret.map(&block)
+        else
+          ret.lazy
+        end
+      end
+
+      def items
+        each_page.flat_map(&:page_items)
+      end
+
+      def page_items
+        raw['items']
+      end
+
+      def count
+        total
+      end
+
+      def first
+        raise ArgumentError, 'Not a collection response' unless page_items
+
+        page_items.first
+      end
+    end
+
+    class ApiError < StandardError
+      attr_reader :response
+
+      def self.[](code)
+        case code
+        when 404
+          NotFoundException
+        else
+          ApiError
+        end
+      end
+
+      def initialize(response, message = nil)
+        @response = response
+        super(message || "An unexpected error occurred: #{response.status}")
+      end
+    end
+
+    class NotFoundError < ApiError
+      def initialize(response)
+        super(response, "Blog post '#{response.effective_url}' does not exist")
+      end
+    end
+  end
+end

data/lib/wcc/blogs/post.rb

@@ -6,16 +6,18 @@ module WCC::Blogs
     require 'time'
 
     def self.find(slug)
-      path = '/blog/' + slug.sub(%r{^/}, '') + '.json'
-      new(JSON.parse(WCC::Blogs.client.get(path))).tap do |blog|
-        raise WCC::Blogs::NotFoundException, "Blog post '#{slug}' is not published" unless blog.published?
-      end
+      new(WCC::Blogs.client.blog_post(slug).raw, client: WCC::Blogs.client)
+    end
+
+    def self.find_all
+      PostSummary.find_all.map(&:full_post)
     end
 
     attr_reader :raw
 
-    def initialize(raw)
+    def initialize(raw, client: WCC::Blogs.client)
       @raw = raw
+      @client = client
     end
 
     def author_full_name
@@ -25,12 +27,9 @@ module WCC::Blogs
     end
 
     def html
-      @html ||=
-        WCC::Blogs.config.cache.fetch(['BlogPost', fragment_path]) do
-          WCC::Blogs.client
-                    .get(fragment_path, host || WCC::Blogs.config.base_url)
-                    .force_encoding('UTF-8')
-        end
+      @html ||= @client.get(URI.join(host, fragment_path).to_s)
+                       .body
+                       .force_encoding('UTF-8')
     end
 
     def metadata
@@ -38,9 +37,7 @@ module WCC::Blogs
     end
 
     def published?
-      return false if publishing_targets.empty?
-
-      publishing_targets.any? { |t| t['key'] == WCC::Blogs.config.publishing_target }
+      true
     end
 
     def time_to_read

data/lib/wcc/blogs/post_summary.rb

@@ -0,0 +1,57 @@
+module WCC::Blogs
+  class PostSummary
+    extend WCC::Blogs::Utils
+
+    def self.find_all
+      WCC::Blogs.client.list.items.map do |summary|
+        new(summary, client: WCC::Blogs.client)
+      end
+    end
+
+    attr_reader :raw
+
+    def initialize(raw, client: WCC::Blogs.client)
+      @raw = raw
+      @client = client
+    end
+
+    def full_post
+      Post.new(@client.blog_post(slug, digest: digest).raw)
+    end
+
+    define_camelcase_alias(
+      'id',
+      'title',
+      'subtitle',
+      'slug',
+      'path',
+      'digest',
+      'fragment_path'
+    ) do |camelcase|
+      raw[camelcase]
+    end
+
+    define_camelcase_alias(
+      'date',
+      'updated_at'
+    ) do |camelcase|
+      value = raw[camelcase]
+
+      Time.parse(value) if value && value.length
+    end
+
+    define_camelcase_alias(
+      'thumbnail_image'
+    ) do |camelcase|
+      OpenStruct.new(raw[camelcase]) if raw[camelcase]
+    end
+
+    define_camelcase_alias('publishing_targets') do |camelcase|
+      targets = raw[camelcase] || []
+
+      targets.map { |val| OpenStruct.new(val) if val }
+    end
+
+    alias cache_key digest
+  end
+end

data/lib/wcc/blogs/version.rb

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

data/wcc-blogs-client.gemspec

@@ -24,12 +24,17 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'typhoeus', '~> 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'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'guard-rubocop', '~> 1.3'
   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 'webmock', '~> 3.0'
 end

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: wcc-blogs-client
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Watermark Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-04 00:00:00.000000000 Z
+date: 2019-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: typhoeus
+  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:
     - - "~>"
@@ -38,6 +52,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +150,20 @@ dependencies:
     - - "~>"
       - !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'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -119,13 +189,16 @@ files:
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - Gemfile
+- Guardfile
 - README.md
 - Rakefile
 - lib/wcc/blogs.rb
 - lib/wcc/blogs/client.rb
+- lib/wcc/blogs/client/response.rb
 - lib/wcc/blogs/errors.rb
 - lib/wcc/blogs/metadata.rb
 - lib/wcc/blogs/post.rb
+- lib/wcc/blogs/post_summary.rb
 - lib/wcc/blogs/utils.rb
 - lib/wcc/blogs/version.rb
 - wcc-blogs-client.gemspec
@@ -149,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: ''