wcc-jtj-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bd533e65649b2b8f21fd9637c8d41a928a248b07fd8aa9bc0639929ccfe25791
+  data.tar.gz: 1ec8cb8c7344360cbdd4222e42d24b04db6e98a5dd2a812120ff98e011056c04
+SHA512:
+  metadata.gz: b371e59536f7fe43c8d64a3fb618afcde6f96236b06e752186dc23d45fb9ca516e003bf241fdce12fa3b49b08b3ef597282669c542c11ef3abdd96076d5b85fb
+  data.tar.gz: 2b38e61322f9389d94303e5c35929f7d0fd23a98fec705fa7d925b909ffe7fa6294c8b7b51c600e211e1283e633bbfc19ffaee8eaebba9bbdf7578bb6050ed8b

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - '**/templates/**/*'
+    - '**/vendor/**/*'
+  Include:
+    - 'lib/**/*'
+    - 'Gemfile'
+    - 'wcc-jtj-client.gemspec'
+
+Metrics/LineLength:
+  Max: 120
+
+Naming/FileName:
+  Exclude:
+    - 'lib/wcc-jtj-client.rb' # Allow "require 'wcc-jtj-client'"
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/MultilineIfModifier:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wcc-events-client.gemspec
+gemspec
+
+group :development, :test do
+  gem 'capybara', '>= 2.15'
+  gem 'guard', '~> 2.15'
+  gem 'guard-rspec', '~> 4.7'
+  gem 'guard-rubocop', '~> 1.3'
+  gem 'rake', '~> 12.3'
+  gem 'rspec', '~> 3.0'
+  gem 'rspec_junit_formatter', '~> 0.4.1'
+  gem 'rubocop', '~> 0.59.2', require: false
+  gem 'rubocop-performance', require: false
+  gem 'simplecov', '~> 0.21.2', require: false
+  gem 'simplecov-cobertura', '~> 1.4'
+  gem 'webmock', '~> 3.1'
+end

data/README.md

@@ -0,0 +1 @@
+Internal Watermark.org gem, not licensed for external use.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

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

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module WCC::JTJ
+  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 raw
+        @raw ||= raw_response.body.to_s
+      end
+      alias_method :to_json, :raw
+
+      def body
+        @body ||= JSON.parse(raw)
+      end
+      def_delegators :body, :[], :dig, :to_h
+
+      def next_page_url
+        body.dig('links', 'next_page')
+      end
+
+      def next_page?
+        !next_page_url.nil?
+      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)
+        ret = PaginatingEnumerable.new(self)
+
+        if block_given?
+          ret.map(&block)
+        else
+          ret.lazy
+        end
+      end
+
+      def count
+        total
+      end
+    end
+
+    class PaginatingEnumerable
+      include Enumerable
+
+      def initialize(initial_page)
+        raise ArgumentError, 'Must provide initial page' unless initial_page
+
+        @initial_page = initial_page
+      end
+
+      def each
+        page = @initial_page
+        puts 'yield page'
+        yield page
+
+        while page.next_page?
+          page = page.next_page
+          yield page
+        end
+      end
+    end
+
+    class ApiError < StandardError
+      attr_reader :response
+
+      def self.[](code)
+        case code
+        when 404
+          NotFoundError
+        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, 'Resource does not exist')
+      end
+    end
+  end
+end

data/lib/wcc/jtj/client/responses/base.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module WCC::JTJ::Client::Responses
+  # The abstract base class of all responses
+  class Base < WCC::JTJ::Client::Schemas::Base
+  end
+end

data/lib/wcc/jtj/client/responses/curriculum_show_response.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module WCC::JTJ::Client::Responses
+  class CurriculumShowResponse < Base
+    def curriculum
+      @curriculum ||=
+        if raw['curriculum']
+          WCC::JTJ::Client::Schemas::CurriculumSummary.new(
+            raw['curriculum'], client: @client
+          )
+        end
+    end
+
+    def current_week
+      @current_week ||=
+        raw['current_week']&.map do |entry|
+          WCC::JTJ::Client::Schemas::Entry.new(
+            entry, client: @client
+          )
+        end
+    end
+    alias currentWeek current_week
+
+    define_camelcase_alias(
+      'links'
+    ) do |camelcase|
+      OpenStruct.new(raw[camelcase]) if raw[camelcase]
+    end
+  end
+end

data/lib/wcc/jtj/client/responses/curriculums_list_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module WCC::JTJ::Client::Responses
+  class CurriculumsListResponse < Base
+    def total
+      raw['total']
+    end
+    alias count total
+
+    def curriculums
+      raw.each_page
+         .flat_map { |page| page['curriculums'] }
+         .map do |raw_curriculum|
+        WCC::JTJ::Client::Schemas::CurriculumSummary.new(
+          raw_curriculum, client: @client
+        )
+      end
+    end
+
+    define_camelcase_alias(
+      'params',
+      'links'
+    ) do |camelcase|
+      OpenStruct.new(raw[camelcase]) if raw[camelcase]
+    end
+  end
+end

data/lib/wcc/jtj/client/responses/entries_list_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module WCC::JTJ::Client::Responses
+  class EntriesListResponse < Base
+    def total
+      raw['total']
+    end
+    alias count total
+
+    def entries
+      raw.each_page
+         .flat_map { |page| page['entries'] }
+         .map do |raw_entry|
+        WCC::JTJ::Client::Schemas::EntrySummary.new(
+          raw_entry, client: @client
+        )
+      end
+    end
+
+    define_camelcase_alias(
+      'params',
+      'links'
+    ) do |camelcase|
+      OpenStruct.new(raw[camelcase]) if raw[camelcase]
+    end
+  end
+end

data/lib/wcc/jtj/client/responses/entry_show_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module WCC::JTJ::Client::Responses
+  class EntryShowResponse < Base
+    def entry
+      @entry ||=
+        if raw['entry']
+          WCC::JTJ::Client::Schemas::Entry.new(
+            raw['entry'], client: @client
+          )
+        end
+    end
+
+    define_camelcase_alias(
+      'links'
+    ) do |camelcase|
+      OpenStruct.new(raw[camelcase]) if raw[camelcase]
+    end
+  end
+end

data/lib/wcc/jtj/client/responses/memory_verse_show_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module WCC::JTJ::Client::Responses
+  class MemoryVerseShowResponse < Base
+    def memory_verse
+      @memory_verse ||=
+        if raw['memory_verse']
+          WCC::JTJ::Client::Schemas::MemoryVerse.new(
+            raw['memory_verse'], client: @client
+          )
+        end
+    end
+
+    define_camelcase_alias(
+      'links'
+    ) do |camelcase|
+      OpenStruct.new(raw[camelcase]) if raw[camelcase]
+    end
+  end
+end

data/lib/wcc/jtj/client/responses/memory_verses_list_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module WCC::JTJ::Client::Responses
+  class MemoryVersesListResponse < Base
+    def total
+      raw['total']
+    end
+    alias count total
+
+    def memory_verses
+      raw.each_page
+         .flat_map { |page| page['memory_verses'] }
+         .map do |raw_verse|
+        WCC::JTJ::Client::Schemas::MemoryVerseSummary.new(
+          raw_verse, client: @client
+        )
+      end
+    end
+
+    define_camelcase_alias(
+      'params',
+      'links'
+    ) do |camelcase|
+      OpenStruct.new(raw[camelcase]) if raw[camelcase]
+    end
+  end
+end

data/lib/wcc/jtj/client/responses/root_response.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module WCC::JTJ::Client::Responses
+  class RootResponse < Base
+    def curriculum
+      @curriculum ||=
+        if raw['curriculum']
+          WCC::JTJ::Client::Schemas::CurriculumSummary.new(raw['curriculum'], client: @client)
+        end
+    end
+
+    def latest_entry
+      @latest_entry ||=
+        if raw['latest_entry']
+          WCC::JTJ::Client::Schemas::Entry.new(raw['latest_entry'], client: @client)
+        end
+    end
+    alias latestEntry latest_entry
+
+    def current_week
+      @current_week ||=
+        raw['current_week']&.map do |summary|
+          WCC::JTJ::Client::Schemas::EntrySummary.new(
+            summary, client: @client
+          )
+        end
+    end
+    alias currentWeek current_week
+
+    define_camelcase_alias(
+      'settings',
+      'links'
+    ) do |camelcase|
+      OpenStruct.new(raw[camelcase]) if raw[camelcase]
+    end
+  end
+end

data/lib/wcc/jtj/client/schemas/base.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../utils'
+
+module WCC::JTJ::Client::Schemas
+  # The abstract base class of all schemas
+  class Base
+    extend Forwardable
+    extend WCC::JTJ::Client::Utils
+
+    attr_reader :raw
+    def_delegators :raw, :[], :dig, :to_h, :to_json
+
+    def initialize(raw, client: WCC::JTJ::Client.default)
+      @raw = raw
+      @client = client
+    end
+  end
+end

data/lib/wcc/jtj/client/schemas/curriculum_summary.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative '../utils'
+
+module WCC::JTJ::Client::Schemas
+  class CurriculumSummary < Base
+    define_camelcase_alias(
+      'id',
+      'title',
+      'start_date',
+      'end_date',
+      'days_of_week'
+    ) do |camelcase|
+      raw[camelcase]
+    end
+
+    def links
+      OpenStruct.new(raw['links']) if raw['links']
+    end
+  end
+end

data/lib/wcc/jtj/client/schemas/entry.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative '../utils'
+
+module WCC::JTJ::Client::Schemas
+  class Entry < Base
+    define_camelcase_alias(
+      'id',
+      'date',
+      'title',
+      'central_truth',
+      'reflection',
+      'discussion_questions',
+      'tags'
+    ) do |camelcase|
+      raw[camelcase]
+    end
+
+    def scriptures
+      @scriptures ||=
+        raw['scriptures']&.map do |scripture|
+          WCC::JTJ::Client::Schemas::Scripture.new(
+            scripture, client: @client
+          )
+        end
+    end
+
+    def key_verse
+      @key_verse ||=
+        if raw['key_verse']
+          WCC::JTJ::Client::Schemas::Scripture.new(raw['key_verse'], client: @client)
+        end
+    end
+    alias keyVerse key_verse
+
+    def writer
+      @writer ||=
+        if raw['writer']
+          WCC::JTJ::Client::Schemas::Writer.new(raw['writer'], client: @client)
+        end
+    end
+
+    def links
+      OpenStruct.new(raw['links']) if raw['links']
+    end
+  end
+end

data/lib/wcc/jtj/client/schemas/entry_summary.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative '../utils'
+
+module WCC::JTJ::Client::Schemas
+  class EntrySummary < Base
+    define_camelcase_alias(
+      'id',
+      'date',
+      'scripture',
+      'title',
+      'tags'
+    ) do |camelcase|
+      raw[camelcase]
+    end
+
+    def links
+      OpenStruct.new(raw['links']) if raw['links']
+    end
+  end
+end

data/lib/wcc/jtj/client/schemas/memory_verse.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative '../utils'
+
+module WCC::JTJ::Client::Schemas
+  class MemoryVerse < Base
+    define_camelcase_alias(
+      'id',
+      'curriculum_id',
+      'reference',
+      'version',
+      'html',
+      'start_date',
+      'end_date'
+    ) do |camelcase|
+      raw[camelcase]
+    end
+
+    def links
+      OpenStruct.new(raw['links']) if raw['links']
+    end
+  end
+end

data/lib/wcc/jtj/client/schemas/memory_verse_summary.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative '../utils'
+
+module WCC::JTJ::Client::Schemas
+  class MemoryVerseSummary < Base
+    define_camelcase_alias(
+      'id',
+      'curriculum_id',
+      'reference',
+      'start_date',
+      'end_date'
+    ) do |camelcase|
+      raw[camelcase]
+    end
+
+    def links
+      OpenStruct.new(raw['links']) if raw['links']
+    end
+  end
+end

data/lib/wcc/jtj/client/schemas/scripture.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../utils'
+
+module WCC::JTJ::Client::Schemas
+  class Scripture < Base
+    define_camelcase_alias(
+      'reference',
+      'version',
+      'html'
+    ) do |camelcase|
+      raw[camelcase]
+    end
+
+    def links
+      OpenStruct.new(raw['links']) if raw['links']
+    end
+  end
+end

data/lib/wcc/jtj/client/schemas/writer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../utils'
+
+module WCC::JTJ::Client::Schemas
+  class Writer < Base
+    define_camelcase_alias(
+      'id',
+      'name',
+      'bio'
+    ) do |camelcase|
+      raw[camelcase]
+    end
+
+    def links
+      OpenStruct.new(raw['links']) if raw['links']
+    end
+  end
+end

data/lib/wcc/jtj/client/utils.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module WCC::JTJ::Client::Utils
+  module_function
+
+  def camelcase(term)
+    term
+      .to_s
+      .gsub(%r{(?:_|(/))([a-z\d]*)}) { "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}" }
+      .gsub(%r{/}, '::')
+  end
+
+  def define_camelcase_alias(*underscore_method_names, &block)
+    underscore_method_names.each do |method|
+      attribute = camelcase(method)
+
+      define_method(method) { instance_exec(attribute, &block) }
+      alias_method attribute, method if attribute != method
+    end
+  end
+end

data/lib/wcc/jtj/client/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module WCC
+  module JTJ
+    class Client
+      VERSION = '0.1.0'
+    end
+  end
+end

data/lib/wcc/jtj/client.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+require_relative './client/version'
+require_relative './client/utils'
+require_relative './client/response'
+
+require_relative './client/schemas/base'
+require_relative './client/schemas/curriculum_summary'
+require_relative './client/schemas/entry_summary'
+require_relative './client/schemas/entry'
+require_relative './client/schemas/scripture'
+require_relative './client/schemas/writer'
+require_relative './client/schemas/memory_verse_summary'
+require_relative './client/schemas/memory_verse'
+
+require_relative './client/responses/base'
+require_relative './client/responses/root_response'
+require_relative './client/responses/curriculums_list_response'
+require_relative './client/responses/curriculum_show_response'
+require_relative './client/responses/entries_list_response'
+require_relative './client/responses/entry_show_response'
+require_relative './client/responses/memory_verses_list_response'
+require_relative './client/responses/memory_verse_show_response'
+
+module WCC::JTJ
+  class Client
+    class << self
+      attr_writer :client
+
+      def client
+        @client || raise(StandardError, 'Not configured')
+      end
+    end
+
+    attr_reader :base_url, :default_property, :base_path
+
+    def options
+      {
+        base_url: @base_url,
+        base_path: @base_path,
+        connection: @connection,
+        query_defaults: @query_defaults
+      }
+    end
+
+    def initialize(**options)
+      base_url = URI.parse(options[:base_url] || 'https://jtj.watermark.org')
+      @base_path = base_url.path == '' ? '/api' : base_url.path
+      @base_url = base_url.to_s
+      @connection = options[:connection] || Faraday.new
+      @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
+
+    # rubocop:disable Naming/AccessorMethodName
+    def get_current
+      resp = get(base_path).assert_ok!
+
+      Responses::RootResponse.new(resp, client: self)
+    end
+
+    def list_curriculums
+      path = File.join(base_path, 'curriculums')
+      resp = get(path).assert_ok!
+
+      Responses::CurriculumsListResponse.new(resp, client: self)
+    end
+
+    def get_curriculum(id)
+      path = File.join(base_path, 'curriculums', id.to_s)
+      resp = get(path).assert_ok!
+
+      Responses::CurriculumShowResponse.new(resp, client: self)
+    end
+
+    def list_entries(**query)
+      path = File.join(base_path, 'entries')
+      resp = get(path, query).assert_ok!
+
+      Responses::EntriesListResponse.new(resp, client: self)
+    end
+
+    def get_entry(id)
+      path = File.join(base_path, 'entries', id.to_s)
+      resp = get(path).assert_ok!
+
+      Responses::EntryShowResponse.new(resp, client: self)
+    end
+
+    def list_memory_verses(**query)
+      path = File.join(base_path, 'memory_verses')
+      resp = get(path, query).assert_ok!
+
+      Responses::MemoryVersesListResponse.new(resp, client: self)
+    end
+
+    def get_memory_verse(id)
+      path = File.join(base_path, 'memory_verses', id.to_s)
+      resp = get(path).assert_ok!
+
+      Responses::MemoryVerseShowResponse.new(resp, client: self)
+    end
+    # rubocop:enable Naming/AccessorMethodName
+
+    private
+
+    def get_http(url, query, headers = {})
+      q = @query_defaults.merge(query || {})
+
+      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
+
+        return resp
+      end
+    end
+  end
+end

data/lib/wcc-jtj-client.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative './wcc/jtj/client'

data/wcc-jtj-client.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wcc/jtj/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'wcc-jtj-client'
+  spec.version       = WCC::JTJ::Client::VERSION
+  spec.authors       = ['Watermark Dev']
+  spec.email         = ['dev@watermark.org']
+
+  spec.summary       = File.readlines(File.expand_path('README.md', __dir__)).join
+  spec.description   = ''
+  spec.license       = 'Not licensed for external use'
+
+  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 'faraday'
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: wcc-jtj-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Watermark Dev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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'
+description: ''
+email:
+- dev@watermark.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/wcc-jtj-client.rb
+- lib/wcc/jtj/client.rb
+- lib/wcc/jtj/client/response.rb
+- lib/wcc/jtj/client/responses/base.rb
+- lib/wcc/jtj/client/responses/curriculum_show_response.rb
+- lib/wcc/jtj/client/responses/curriculums_list_response.rb
+- lib/wcc/jtj/client/responses/entries_list_response.rb
+- lib/wcc/jtj/client/responses/entry_show_response.rb
+- lib/wcc/jtj/client/responses/memory_verse_show_response.rb
+- lib/wcc/jtj/client/responses/memory_verses_list_response.rb
+- lib/wcc/jtj/client/responses/root_response.rb
+- lib/wcc/jtj/client/schemas/base.rb
+- lib/wcc/jtj/client/schemas/curriculum_summary.rb
+- lib/wcc/jtj/client/schemas/entry.rb
+- lib/wcc/jtj/client/schemas/entry_summary.rb
+- lib/wcc/jtj/client/schemas/memory_verse.rb
+- lib/wcc/jtj/client/schemas/memory_verse_summary.rb
+- lib/wcc/jtj/client/schemas/scripture.rb
+- lib/wcc/jtj/client/schemas/writer.rb
+- lib/wcc/jtj/client/utils.rb
+- lib/wcc/jtj/client/version.rb
+- wcc-jtj-client.gemspec
+homepage: 
+licenses:
+- Not licensed for external use
+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: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Internal Watermark.org gem, not licensed for external use.
+test_files: []