wcc-jtj-client 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd533e65649b2b8f21fd9637c8d41a928a248b07fd8aa9bc0639929ccfe25791
-  data.tar.gz: 1ec8cb8c7344360cbdd4222e42d24b04db6e98a5dd2a812120ff98e011056c04
+  metadata.gz: 1bad5a870ee2626cf3ca961591d8d9ccc9d33ad6cf8ec85ac5b93347b376013a
+  data.tar.gz: 1ba7d0c5ad2fc58d904bfcc3b6fb388fd2796d5cf0dfaa2db99aa19b43fd999a
 SHA512:
-  metadata.gz: b371e59536f7fe43c8d64a3fb618afcde6f96236b06e752186dc23d45fb9ca516e003bf241fdce12fa3b49b08b3ef597282669c542c11ef3abdd96076d5b85fb
-  data.tar.gz: 2b38e61322f9389d94303e5c35929f7d0fd23a98fec705fa7d925b909ffe7fa6294c8b7b51c600e211e1283e633bbfc19ffaee8eaebba9bbdf7578bb6050ed8b
+  metadata.gz: '05091af67a5b43c4704ba50e28675b7509ab46d5f10cb1bd176d91fc6a979cd69f51a67595448e938f6c06a9ef641e047cae454cf943c72f549c232e355842e9'
+  data.tar.gz: ade4a32a1fedcced55f05cb99ba23b8dd6fcc930324ea987d75f6e485587e6785566700b30760c23becb68e48f90f855a068d39115b970ba7535243da201eeda

data/.rubocop.yml

@@ -21,8 +21,15 @@ Style/ClassAndModuleChildren:
 Style/Documentation:
   Enabled: false
 
+Style/GuardClause:
+  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/lib/wcc/jtj/client/response.rb

@@ -20,6 +20,10 @@ module WCC::JTJ
       end
       def_delegators :body, :[], :dig, :to_h
 
+      def url
+        raw_response.env.url
+      end
+
       def next_page_url
         body.dig('links', 'next_page')
       end

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

@@ -26,5 +26,12 @@ module WCC::JTJ::Client::Responses
     ) do |camelcase|
       OpenStruct.new(raw[camelcase]) if raw[camelcase]
     end
+
+    def validate!
+      unless curriculum&.id
+        raise WCC::JTJ::Client::Schemas::SchemaValidationError,
+              "Not a CurriculumShowResponse! #{raw.url}"
+      end
+    end
   end
 end

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

@@ -23,5 +23,12 @@ module WCC::JTJ::Client::Responses
     ) do |camelcase|
       OpenStruct.new(raw[camelcase]) if raw[camelcase]
     end
+
+    def validate!
+      unless total && raw['curriculums'].is_a?(Array)
+        raise WCC::JTJ::Client::Schemas::SchemaValidationError,
+              "Not a CurriculumsListResponse! #{raw.url}"
+      end
+    end
   end
 end

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

@@ -23,5 +23,12 @@ module WCC::JTJ::Client::Responses
     ) do |camelcase|
       OpenStruct.new(raw[camelcase]) if raw[camelcase]
     end
+
+    def validate!
+      unless total && raw['entries'].is_a?(Array)
+        raise WCC::JTJ::Client::Schemas::SchemaValidationError,
+              "Not an EntriesListResponse! #{raw.url}"
+      end
+    end
   end
 end

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

@@ -16,5 +16,12 @@ module WCC::JTJ::Client::Responses
     ) do |camelcase|
       OpenStruct.new(raw[camelcase]) if raw[camelcase]
     end
+
+    def validate!
+      unless entry&.id
+        raise WCC::JTJ::Client::Schemas::SchemaValidationError,
+              "Not an EntryShowResponse! #{raw.url}"
+      end
+    end
   end
 end

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

@@ -16,5 +16,12 @@ module WCC::JTJ::Client::Responses
     ) do |camelcase|
       OpenStruct.new(raw[camelcase]) if raw[camelcase]
     end
+
+    def validate!
+      unless memory_verse&.id
+        raise WCC::JTJ::Client::Schemas::SchemaValidationError,
+              "Not a MemoryVerseShowResponse! #{raw.url}"
+      end
+    end
   end
 end

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

@@ -23,5 +23,12 @@ module WCC::JTJ::Client::Responses
     ) do |camelcase|
       OpenStruct.new(raw[camelcase]) if raw[camelcase]
     end
+
+    def validate!
+      unless total && raw['memory_verses'].is_a?(Array)
+        raise WCC::JTJ::Client::Schemas::SchemaValidationError,
+              "Not a MemoryVersesListResponse! #{raw.url}"
+      end
+    end
   end
 end

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

@@ -11,9 +11,11 @@ module WCC::JTJ::Client::Schemas
     attr_reader :raw
     def_delegators :raw, :[], :dig, :to_h, :to_json
 
-    def initialize(raw, client: WCC::JTJ::Client.default)
+    def initialize(raw, client: WCC::JTJ::Client.client)
       @raw = raw
       @client = client
     end
+
+    def validate!; end
   end
 end

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module WCC::JTJ::Client::Schemas
+  class SchemaValidationError < StandardError
+  end
+end

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

@@ -3,7 +3,7 @@
 module WCC
   module JTJ
     class Client
-      VERSION = '0.1.0'
+      VERSION = '0.1.1'
     end
   end
 end

data/lib/wcc/jtj/client.rb

@@ -7,6 +7,7 @@ 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'
@@ -25,7 +26,7 @@ require_relative './client/responses/memory_verses_list_response'
 require_relative './client/responses/memory_verse_show_response'
 
 module WCC::JTJ
-  class Client
+  class Client # rubocop:disable Metrics/ClassLength
     class << self
       attr_writer :client
 
@@ -68,49 +69,79 @@ module WCC::JTJ
     def get_current
       resp = get(base_path).assert_ok!
 
-      Responses::RootResponse.new(resp, client: self)
+      Responses::RootResponse.new(resp, client: self).tap(&:validate!)
     end
 
-    def list_curriculums
-      path = File.join(base_path, 'curriculums')
+    def list_curriculums(link = nil)
+      path =
+        if link && /^https?:\/\// =~ link
+          link
+        else
+          File.join(base_path, 'curriculums')
+        end
       resp = get(path).assert_ok!
 
-      Responses::CurriculumsListResponse.new(resp, client: self)
+      Responses::CurriculumsListResponse.new(resp, client: self).tap(&:validate!)
     end
 
-    def get_curriculum(id)
-      path = File.join(base_path, 'curriculums', id.to_s)
+    def get_curriculum(id_or_link)
+      path =
+        if /^https?:\/\// =~ id_or_link.to_s
+          id_or_link
+        else
+          File.join(base_path, 'curriculums', id_or_link.to_s)
+        end
       resp = get(path).assert_ok!
 
-      Responses::CurriculumShowResponse.new(resp, client: self)
+      Responses::CurriculumShowResponse.new(resp, client: self).tap(&:validate!)
     end
 
-    def list_entries(**query)
-      path = File.join(base_path, 'entries')
+    def list_entries(link = nil, **query)
+      path =
+        if link && /^https?:\/\// =~ link
+          link
+        else
+          File.join(base_path, 'entries')
+        end
       resp = get(path, query).assert_ok!
 
-      Responses::EntriesListResponse.new(resp, client: self)
+      Responses::EntriesListResponse.new(resp, client: self).tap(&:validate!)
     end
 
-    def get_entry(id)
-      path = File.join(base_path, 'entries', id.to_s)
+    def get_entry(id_or_link)
+      path =
+        if /^https?:\/\// =~ id_or_link.to_s
+          id_or_link
+        else
+          File.join(base_path, 'entries', id_or_link.to_s)
+        end
       resp = get(path).assert_ok!
 
-      Responses::EntryShowResponse.new(resp, client: self)
+      Responses::EntryShowResponse.new(resp, client: self).tap(&:validate!)
     end
 
-    def list_memory_verses(**query)
-      path = File.join(base_path, 'memory_verses')
+    def list_memory_verses(link = nil, **query)
+      path =
+        if link && /^https?:\/\// =~ link
+          link
+        else
+          File.join(base_path, 'memory_verses')
+        end
       resp = get(path, query).assert_ok!
 
-      Responses::MemoryVersesListResponse.new(resp, client: self)
+      Responses::MemoryVersesListResponse.new(resp, client: self).tap(&:validate!)
     end
 
-    def get_memory_verse(id)
-      path = File.join(base_path, 'memory_verses', id.to_s)
+    def get_memory_verse(id_or_link)
+      path =
+        if /^https?:\/\// =~ id_or_link.to_s
+          id_or_link
+        else
+          File.join(base_path, 'memory_verses', id_or_link.to_s)
+        end
       resp = get(path).assert_ok!
 
-      Responses::MemoryVerseShowResponse.new(resp, client: self)
+      Responses::MemoryVerseShowResponse.new(resp, client: self).tap(&:validate!)
     end
     # rubocop:enable Naming/AccessorMethodName
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wcc-jtj-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Watermark Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-03 00:00:00.000000000 Z
+date: 2022-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -52,6 +52,7 @@ files:
 - 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/schema_validation_error.rb
 - lib/wcc/jtj/client/schemas/scripture.rb
 - lib/wcc/jtj/client/schemas/writer.rb
 - lib/wcc/jtj/client/utils.rb