wcc-blogs-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d1738d588e81003474759f99c0a06d8350e7bb9c
+  data.tar.gz: db3d3d0507abb807cd3c1d18fb975ce6d7114659
+SHA512:
+  metadata.gz: 274c5a18525eeb9693f2004882e9141cf9d8d2659b2b4a9cb874800b6674b0420e0963d35c6a5e715b1f69f2b18dec4b1e837608a6968b207aae05c886461227
+  data.tar.gz: c1c70c4f76d8631b5d5a90b04c4e7302ccbed22e001cb2b252d18f1858333f376e1ee1c3bbcc38f1c79b0b8e57a083889f754c18a58d8e8dcae88957e0579867

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,21 @@
+inherit_from: .rubocop_todo.yml
+
+Metrics/BlockLength:
+  Exclude:
+    - 'wcc-blogs-client.gemspec'
+    - 'spec/**/*'
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Exclude:
+    - 'spec/**/*'
+
+Style/BlockDelimiters:
+  Exclude:
+    # we like the `let(:foo) {}` syntax in specs
+    - 'spec/**/*.rb'

data/.rubocop_todo.yml

@@ -0,0 +1,46 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-05-09 17:07:57 -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: 1
+# Configuration parameters: AllowSafeAssignment.
+Lint/AssignmentInCondition:
+  Exclude:
+    - 'lib/wcc/blogs/client.rb'
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 17
+
+# 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: EnforcedStyleForMultiline.
+# SupportedStylesForMultiline: comma, consistent_comma, no_comma
+Style/TrailingCommaInHashLiteral:
+  Exclude:
+    - 'lib/wcc/blogs/client.rb'
+
+# Offense count: 7
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 106

data/Gemfile

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

data/lib/wcc/blogs/client.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module WCC::Blogs
+  class Client
+    def initialize(config:)
+      @config = config
+    end
+
+    REDIRECT_HANDLER =
+      ->(resp) {
+        location = resp.headers['Location']
+        digest = File.basename(location).gsub(/\.(fragment|json)$/, '')
+
+        @config.cache.fetch(['BlogPost', digest, File.extname(location)]) do
+          get(location, resp.effective_url)
+        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)
+      end
+
+      raise WCC::Blogs::ApiException, "#{resp.return_code}: #{resp.effective_url}"
+    end
+  end
+end

data/lib/wcc/blogs/errors.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module WCC::Blogs
+  class NotConfiguredException < StandardError
+  end
+
+  class NotFoundException < StandardError
+  end
+
+  class ApiException < StandardError
+  end
+end

data/lib/wcc/blogs/post.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module WCC::Blogs
+  class Post
+    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
+    end
+
+    attr_reader :raw
+
+    def initialize(raw)
+      @raw = raw
+    end
+
+    def author_full_name
+      return unless author
+
+      [author.firstName, author.lastName].compact.join(' ')
+    end
+
+    def date
+      publish_at || created_at
+    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)
+        end
+    end
+
+    def published?
+      return false if publishing_targets.empty?
+
+      publishing_targets.any? { |t| t['key'] == WCC::Blogs.config.publishing_target } &&
+        (publish_at.nil? || publish_at.empty? || (Time.parse(publish_at) <= Time.now))
+    end
+
+    def time_to_read
+      # TODO
+      nil
+    end
+
+    def to_param
+      slug.sub(%r{^/}, '')
+    end
+
+    def self.camelcase(str)
+      str.gsub(/_(\w)/) { Regexp.last_match(1).upcase }
+    end
+
+    %w[
+      id
+      title
+      subtitle
+      slug
+      host
+      path
+      digest
+      updated_at
+      created_at
+      publish_at
+      fragment_path
+    ].each do |method|
+      attribute = camelcase(method)
+
+      define_method method do
+        raw[attribute]
+      end
+
+      alias_method attribute, method if attribute != method
+    end
+
+    %w[
+      author
+      hero_image
+      thumbnail_image
+    ].each do |method|
+      attribute = camelcase(method)
+
+      define_method method do
+        OpenStruct.new(raw[attribute]) if raw[attribute]
+      end
+
+      alias_method attribute, method if attribute != method
+    end
+
+    %w[
+      publishing_targets
+    ].each do |method|
+      attribute = camelcase(method)
+
+      define_method method do
+        return [] unless raw[attribute]
+
+        raw[attribute].map { |val| OpenStruct.new(val) if val }
+      end
+
+      alias_method attribute, method if attribute != method
+    end
+
+    alias cache_key digest
+  end
+end

data/lib/wcc/blogs/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module WCC
+  module Blogs
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/wcc/blogs.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'wcc/blogs/client'
+require 'wcc/blogs/errors'
+require 'wcc/blogs/post'
+
+module WCC::Blogs
+  class << self
+    def configure
+      yield config
+
+      @client = WCC::Blogs::Client.new(config: config)
+
+      config
+    end
+
+    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 || 'https://papyrus.wcc/graphql'
+    end
+
+    class NilCache
+      def clear; end
+
+      def fetch(*_args)
+        yield
+      end
+    end
+  end
+end

data/wcc-blogs-client.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wcc/blogs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'wcc-blogs-client'
+  spec.version       = WCC::Blogs::VERSION
+  spec.authors       = ['Watermark Dev']
+  spec.email         = ['dev@watermark.org']
+
+  spec.summary       = File.readlines(File.expand_path('README.md', __dir__)).join
+  spec.description   = 'Simple Client for accessing WCC Blog library content'
+  spec.homepage      = 'https://github.com/watermarkchurch/papyrus/wcc-blogs-client'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 2.3'
+
+  spec.files         =
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'typhoeus', '~> 1.3'
+  spec.add_runtime_dependency 'wcc-base'
+
+  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 'webmock', '~> 3.0'
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: wcc-blogs-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Watermark Dev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  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
+  name: wcc-base
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.60.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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Simple Client for accessing WCC Blog library content
+email:
+- dev@watermark.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- Gemfile
+- README.md
+- lib/wcc/blogs.rb
+- lib/wcc/blogs/client.rb
+- lib/wcc/blogs/errors.rb
+- lib/wcc/blogs/post.rb
+- lib/wcc/blogs/version.rb
+- wcc-blogs-client.gemspec
+homepage: https://github.com/watermarkchurch/papyrus/wcc-blogs-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []