wcc-jtj-client 0.1.8 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdb4d64889a26f6e53ddfff3e83dab47c1e91901702c0742e895ed0a70b0d663
-  data.tar.gz: 272d10469bd6d3c070d62120dd614f3ac47bb4165ec7d3b7711e351eb0cbf996
+  metadata.gz: f51c3ec96e689dafbbad91b47e6abb06f4484bb91e1ff055bef9a82b0e2211c8
+  data.tar.gz: 69f4f5fbb721f281582d897acd468906ecf612c74d1eaedd27f104b99a2364ea
 SHA512:
-  metadata.gz: 7980e36863a966b09bcb5d352d0f51db7c1b5cc6f66e30d33515ccd7f1823be3a159f6fbbf32f08e2190b8e10060e25399f0d81d62a6f77f2fbd901a38fd9983
-  data.tar.gz: 7865b6f47b76a52140ba22b3a1686e7ba93d0da6a76e7e4ef7c9544c8bcf84fe62e59712215e6f370758fceba687947f3b917697590f3b0d9074ba7b7cca1521
+  metadata.gz: 34eac411369d916aeea2dd3ed0a24642ae12e0e55235c8d125ac183ad224c95538126b65800019518361f5af4a7c159d33485570b3adca574879d810161604d8
+  data.tar.gz: a3386fb63e8e66e663e000cd169a9c2d5e956eaa3e77cbec0ff7ad0945ce39886f6e528b0adf56b9d24c9f8ab2160d7ce689b49941fd65651f17a195f3db7746

data/.rubocop.yml

@@ -1,35 +1,13 @@
-AllCops:
-  TargetRubyVersion: 2.3
-  Exclude:
-    - '**/templates/**/*'
-    - '**/vendor/**/*'
-  Include:
-    - 'lib/**/*'
-    - 'Gemfile'
-    - 'wcc-jtj-client.gemspec'
+inherit_from:
+  - http://watermarkchurch.github.io/watermarkchurch/rubocop_base.yml
 
-Metrics/LineLength:
-  Max: 120
+require:
+  - rubocop-performance
 
 Naming/FileName:
   Exclude:
-    - 'lib/wcc-jtj-client.rb' # Allow "require 'wcc-jtj-client'"
-
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
+    - 'lib/wcc-jtj-client.rb' # allow `require 'wcc-jtj-client'`
 
-Style/GuardClause:
+# We have a lot of OpenStructs in the client intentionally to model flexible JSON
+Style/OpenStructUse:
   Enabled: false
-
-Style/IfUnlessModifier:
-  Enabled: false
-
-Style/MultilineIfModifier:
-  Enabled: false
-
-# This one won't let me EnforcedStyle: slashes, do we need to upgrade rubocop?
-Style/RegexpLiteral:
-  Enabled: false

data/Gemfile

@@ -5,17 +5,20 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in wcc-events-client.gemspec
 gemspec
 
+# Lock rubocop to the same version the parent app uses
+lockfile = Bundler::LockfileParser.new(Bundler.read_file('../../Gemfile.lock'))
+parent_version = ->(spec) { lockfile.specs.find { |s| s.name == spec }.version.to_s }
+
 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 'rubocop', parent_version.call('rubocop'), require: false
+  gem 'rubocop-performance', parent_version.call('rubocop-performance'), require: false
+  gem 'rubocop-rails', parent_version.call('rubocop-rails'), require: false
+  gem 'rubocop-rspec', parent_version.call('rubocop-rspec'), require: false
+  gem 'simplecov', parent_version.call('simplecov'), require: false
+  gem 'simplecov-cobertura', parent_version.call('simplecov-cobertura')
   gem 'webmock', '~> 3.1'
 end

data/Rakefile

@@ -1,4 +1,6 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
 
 begin
   require 'rspec/core/rake_task'

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

@@ -4,7 +4,7 @@ require 'forwardable'
 
 module WCC::JTJ
   class Client
-    Response = Struct.new(:client, :request, :raw_response) do # rubocop:disable Metrics/BlockLength
+    Response = Struct.new(:client, :request, :raw_response) do
       extend Forwardable
 
       def_delegators :raw_response, :status, :headers
@@ -49,7 +49,7 @@ module WCC::JTJ
       def each_page(&block)
         ret = PaginatingEnumerable.new(self)
 
-        if block_given?
+        if block
           ret.map(&block)
         else
           ret.lazy
@@ -72,7 +72,6 @@ module WCC::JTJ
 
       def each
         page = @initial_page
-        puts 'yield page'
         yield page
 
         while page.next_page?

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

@@ -19,7 +19,7 @@ module WCC::JTJ::Client::Responses
           )
         end
     end
-    alias currentWeek current_week
+    alias_method :currentWeek, :current_week
 
     define_camelcase_alias(
       'links'
@@ -28,10 +28,10 @@ module WCC::JTJ::Client::Responses
     end
 
     def validate!
-      unless curriculum&.id
-        raise WCC::JTJ::Client::Schemas::SchemaValidationError,
-              "Not a CurriculumShowResponse! #{raw.url}"
-      end
+      return if curriculum&.id
+
+      raise WCC::JTJ::Client::Schemas::SchemaValidationError,
+        "Not a CurriculumShowResponse! #{raw.url}"
     end
   end
 end

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

@@ -5,12 +5,12 @@ module WCC::JTJ::Client::Responses
     def total
       raw['total']
     end
-    alias count total
+    alias_method :count, :total
 
     def curriculums
       raw.each_page
-         .flat_map { |page| page['curriculums'] }
-         .map do |raw_curriculum|
+        .flat_map { |page| page['curriculums'] }
+        .map do |raw_curriculum|
         WCC::JTJ::Client::Schemas::CurriculumSummary.new(
           raw_curriculum, client: @client
         )
@@ -25,10 +25,10 @@ module WCC::JTJ::Client::Responses
     end
 
     def validate!
-      unless total && raw['curriculums'].is_a?(Array)
-        raise WCC::JTJ::Client::Schemas::SchemaValidationError,
-              "Not a CurriculumsListResponse! #{raw.url}"
-      end
+      return if total && raw['curriculums'].is_a?(Array)
+
+      raise WCC::JTJ::Client::Schemas::SchemaValidationError,
+        "Not a CurriculumsListResponse! #{raw.url}"
     end
   end
 end

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

@@ -5,12 +5,12 @@ module WCC::JTJ::Client::Responses
     def total
       raw['total']
     end
-    alias count total
+    alias_method :count, :total
 
     def entries
       raw.each_page
-         .flat_map { |page| page['entries'] }
-         .map do |raw_entry|
+        .flat_map { |page| page['entries'] }
+        .map do |raw_entry|
         WCC::JTJ::Client::Schemas::EntrySummary.new(
           raw_entry, client: @client
         )
@@ -25,10 +25,10 @@ module WCC::JTJ::Client::Responses
     end
 
     def validate!
-      unless total && raw['entries'].is_a?(Array)
-        raise WCC::JTJ::Client::Schemas::SchemaValidationError,
-              "Not an EntriesListResponse! #{raw.url}"
-      end
+      return if total && raw['entries'].is_a?(Array)
+
+      raise WCC::JTJ::Client::Schemas::SchemaValidationError,
+        "Not an EntriesListResponse! #{raw.url}"
     end
   end
 end

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

@@ -28,10 +28,10 @@ module WCC::JTJ::Client::Responses
     end
 
     def validate!
-      unless entry&.id
-        raise WCC::JTJ::Client::Schemas::SchemaValidationError,
-              "Not an EntryShowResponse! #{raw.url}"
-      end
+      return if entry&.id
+
+      raise WCC::JTJ::Client::Schemas::SchemaValidationError,
+        "Not an EntryShowResponse! #{raw.url}"
     end
   end
 end

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

@@ -18,10 +18,10 @@ module WCC::JTJ::Client::Responses
     end
 
     def validate!
-      unless memory_verse&.id
-        raise WCC::JTJ::Client::Schemas::SchemaValidationError,
-              "Not a MemoryVerseShowResponse! #{raw.url}"
-      end
+      return if memory_verse&.id
+
+      raise WCC::JTJ::Client::Schemas::SchemaValidationError,
+        "Not a MemoryVerseShowResponse! #{raw.url}"
     end
   end
 end

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

@@ -5,12 +5,12 @@ module WCC::JTJ::Client::Responses
     def total
       raw['total']
     end
-    alias count total
+    alias_method :count, :total
 
     def memory_verses
       raw.each_page
-         .flat_map { |page| page['memory_verses'] }
-         .map do |raw_verse|
+        .flat_map { |page| page['memory_verses'] }
+        .map do |raw_verse|
         WCC::JTJ::Client::Schemas::MemoryVerseSummary.new(
           raw_verse, client: @client
         )
@@ -25,10 +25,10 @@ module WCC::JTJ::Client::Responses
     end
 
     def validate!
-      unless total && raw['memory_verses'].is_a?(Array)
-        raise WCC::JTJ::Client::Schemas::SchemaValidationError,
-              "Not a MemoryVersesListResponse! #{raw.url}"
-      end
+      return if total && raw['memory_verses'].is_a?(Array)
+
+      raise WCC::JTJ::Client::Schemas::SchemaValidationError,
+        "Not a MemoryVersesListResponse! #{raw.url}"
     end
   end
 end

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

@@ -4,18 +4,14 @@ 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
+        (WCC::JTJ::Client::Schemas::CurriculumSummary.new(raw['curriculum'], client: @client) if raw['curriculum'])
     end
 
     def latest_entry
       @latest_entry ||=
-        if raw['latest_entry']
-          WCC::JTJ::Client::Schemas::Entry.new(raw['latest_entry'], client: @client)
-        end
+        (WCC::JTJ::Client::Schemas::Entry.new(raw['latest_entry'], client: @client) if raw['latest_entry'])
     end
-    alias latestEntry latest_entry
+    alias_method :latestEntry, :latest_entry
 
     def current_week
       @current_week ||=
@@ -25,7 +21,7 @@ module WCC::JTJ::Client::Responses
           )
         end
     end
-    alias currentWeek current_week
+    alias_method :currentWeek, :current_week
 
     define_camelcase_alias(
       'settings',

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

@@ -9,6 +9,7 @@ module WCC::JTJ::Client::Schemas
     extend WCC::JTJ::Client::Utils
 
     attr_reader :raw
+
     def_delegators :raw, :[], :dig, :to_h, :to_json
 
     def initialize(raw, client: WCC::JTJ::Client.client)
@@ -16,6 +17,7 @@ module WCC::JTJ::Client::Schemas
       @client = client
     end
 
-    def validate!; end
+    def validate!
+    end
   end
 end

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

@@ -21,9 +21,9 @@ module WCC::JTJ::Client::Schemas
         raw[snake_case]
       end
     end
-    alias startDate start_date
-    alias endDate end_date
-    alias daysOfWeek days_of_week
+    alias_method :startDate, :start_date
+    alias_method :endDate, :end_date
+    alias_method :daysOfWeek, :days_of_week
 
     def links
       OpenStruct.new(raw['links']) if raw['links']

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

@@ -27,31 +27,23 @@ module WCC::JTJ::Client::Schemas
 
     def key_verse
       @key_verse ||=
-        if raw['key_verse']
-          WCC::JTJ::Client::Schemas::Scripture.new(raw['key_verse'], client: @client)
-        end
+        (WCC::JTJ::Client::Schemas::Scripture.new(raw['key_verse'], client: @client) if raw['key_verse'])
     end
-    alias keyVerse key_verse
+    alias_method :keyVerse, :key_verse
 
     def writer
       @writer ||=
-        if raw['writer']
-          WCC::JTJ::Client::Schemas::Writer.new(raw['writer'], client: @client)
-        end
+        (WCC::JTJ::Client::Schemas::Writer.new(raw['writer'], client: @client) if raw['writer'])
     end
 
     def podcast
       @podcast ||=
-        if raw['podcast']
-          WCC::JTJ::Client::Schemas::Podcast.new(raw['podcast'], client: @client)
-        end
+        (WCC::JTJ::Client::Schemas::Podcast.new(raw['podcast'], client: @client) if raw['podcast'])
     end
 
     def memory_verse
       @memory_verse ||=
-        if raw['memory_verse']
-          WCC::JTJ::Client::Schemas::MemoryVerse.new(raw['memory_verse'], client: @client)
-        end
+        (WCC::JTJ::Client::Schemas::MemoryVerse.new(raw['memory_verse'], client: @client) if raw['memory_verse'])
     end
 
     def links

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

@@ -16,9 +16,7 @@ module WCC::JTJ::Client::Schemas
 
     def podcast
       @podcast ||=
-        if raw['podcast']
-          WCC::JTJ::Client::Schemas::Podcast.new(raw['podcast'], client: @client)
-        end
+        (WCC::JTJ::Client::Schemas::Podcast.new(raw['podcast'], client: @client) if raw['podcast'])
     end
 
     def links

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

@@ -12,6 +12,16 @@ module WCC::JTJ::Client::Schemas
       raw[camelcase]
     end
 
+    def study_notes
+      @study_notes ||=
+        raw['study_notes']&.map do |study_note|
+          WCC::JTJ::Client::Schemas::StudyNote.new(
+            study_note, client: @client
+          )
+        end
+    end
+    alias_method :studyNotes, :study_notes
+
     def links
       OpenStruct.new(raw['links']) if raw['links']
     end

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

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

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

@@ -6,8 +6,8 @@ module WCC::JTJ::Client::Utils
   def camelcase(term)
     term
       .to_s
-      .gsub(%r{(?:_|(/))([a-z\d]*)}) { "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}" }
-      .gsub(%r{/}, '::')
+      .gsub(/(?:_|(\/))([a-z\d]*)/) { "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}" }
+      .gsub('/', '::')
   end
 
   def define_camelcase_alias(*underscore_method_names, &block)

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

@@ -3,7 +3,7 @@
 module WCC
   module JTJ
     class Client
-      VERSION = '0.1.8'
+      VERSION = '0.1.10'
     end
   end
 end

data/lib/wcc/jtj/client.rb

@@ -2,32 +2,33 @@
 
 require 'faraday'
 
-require_relative './client/version'
-require_relative './client/utils'
-require_relative './client/response'
-
-require_relative './client/schemas/base'
-require_relative './client/schemas/schema_validation_error'
-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/podcast'
-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'
+require_relative 'client/version'
+require_relative 'client/utils'
+require_relative 'client/response'
+
+require_relative 'client/schemas/base'
+require_relative 'client/schemas/schema_validation_error'
+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/study_note'
+require_relative 'client/schemas/podcast'
+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 # rubocop:disable Metrics/ClassLength
+  class Client
     class << self
       attr_writer :client
 
@@ -62,8 +63,8 @@ module WCC::JTJ
       url = URI.join(@base_url, path)
 
       Response.new(self,
-                   { url: url, query: query },
-                   get_http(url, query))
+        { url: url, query: query },
+        get_http(url, query))
     end
 
     # rubocop:disable Naming/AccessorMethodName
@@ -89,7 +90,7 @@ module WCC::JTJ
       raise ArgumentError, 'please provide curriculum ID' unless id_or_link
 
       path =
-        if /^https?:\/\// =~ id_or_link.to_s
+        if /^https?:\/\//.match?(id_or_link.to_s)
           id_or_link
         else
           File.join(base_path, 'curriculums', id_or_link.to_s)
@@ -111,17 +112,17 @@ module WCC::JTJ
       Responses::EntriesListResponse.new(resp, client: self).tap(&:validate!)
     end
 
-    def get_entry(id_or_link, preview_code: nil)
+    def get_entry(id_or_link, preview_code: nil, **query)
       raise ArgumentError, 'please provide entry ID' unless id_or_link
 
       path =
-        if /^https?:\/\// =~ id_or_link.to_s
+        if /^https?:\/\//.match?(id_or_link.to_s)
           id_or_link
         else
           File.join(base_path, 'entries', id_or_link.to_s)
         end
 
-      query = preview_code ? { preview_code: preview_code } : {}
+      query = query.merge(preview_code: preview_code) if preview_code
 
       resp = get(path, query).assert_ok!
 
@@ -153,7 +154,7 @@ module WCC::JTJ
       raise ArgumentError, 'please provide memory verse ID' unless id_or_link
 
       path =
-        if /^https?:\/\// =~ id_or_link.to_s
+        if /^https?:\/\//.match?(id_or_link.to_s)
           id_or_link
         else
           File.join(base_path, 'memory_verses', id_or_link.to_s)
@@ -166,13 +167,15 @@ module WCC::JTJ
 
     private
 
+    REDIRECT_STATUS_CODES = [301, 302, 307].freeze
+
     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)
+        if REDIRECT_STATUS_CODES.include?(resp.status)
           url = URI.join(@base_url, resp.headers['Location'])
           next
         end

data/lib/wcc-jtj-client.rb

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

data/wcc-jtj-client.gemspec

@@ -14,14 +14,15 @@ Gem::Specification.new do |spec|
   spec.description   = ''
   spec.license       = 'Not licensed for external use'
 
-  spec.required_ruby_version = '>= 2.3'
+  spec.required_ruby_version = '>= 2.7'
 
   spec.files         =
     `git ls-files -z`.split("\x0").reject do |f|
-      f.match(%r{^(test|spec|features)/})
+      f.match(/^(test|spec|features)\//)
     end
 
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'faraday'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wcc-jtj-client
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.10
 platform: ruby
 authors:
 - Watermark Dev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-21 00:00:00.000000000 Z
+date: 2023-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -55,15 +55,17 @@ files:
 - lib/wcc/jtj/client/schemas/podcast.rb
 - lib/wcc/jtj/client/schemas/schema_validation_error.rb
 - lib/wcc/jtj/client/schemas/scripture.rb
+- lib/wcc/jtj/client/schemas/study_note.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: 
+homepage:
 licenses:
 - Not licensed for external use
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -71,7 +73,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -79,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Internal Watermark.org gem, not licensed for external use.
 test_files: []