strapi_ruby 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9903f53042e56a2738031589080d7708a0286ac979d5f4f4aba8e71a914dc63f
-  data.tar.gz: 2108880a59532797595fad52bd7461c0cc4e3f12708f0d16213655f86ed1097f
+  metadata.gz: b287ea9daf48f9208a65d0b604a453ef528ec576ab8312265608fbc032f616a9
+  data.tar.gz: 2d91df1a2215a1167fd8cc4ee0c0d99c6c4a5a6edd61c61f1c80f941c1636e6b
 SHA512:
-  metadata.gz: 35b87fdf4069cbccf2fcf9988cf82fb0f46d2dbaedd73464a29cb8d95420608bcef064f77348ab7c8a9507405f1694161b6093eab3a56e671a4252284d29b70a
-  data.tar.gz: 4ca960cc893eeda6a890174f83036ab96f18aba94eca66b68febffa33330c713e361a56ece7db8c5a2401c0851caad7e126b842830d9d3824672d05e1598a1d2
+  metadata.gz: 703efd7aa92556623aca9f27b53f229dddab82becb2408d4e2c2673c6feddfe39140df14d19f3f726706d36ea859bee201dc39a26d2f436931b4008443f25146
+  data.tar.gz: 1b31b0080faa5e81d91ba171386c654eb0f19bcca6d2692eb5533335558d500691bfc4127bf180982da7df415d5531b8e4d15f7cc9167b1eb5a76ffa98b23995

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-## [Unreleased]
+## [0.1.2] - 2023-10-04
+
+- Updated README
+
+## [0.1.1] - 2023-10-04
+
+- Added logger for ClientError and ConfigError
 
 ## [0.1.0] - 2023-10-04
 

data/README.md

@@ -34,6 +34,9 @@ I think it's one of the actual coolest solution for integrating a CMS into Rails
   - [DateTime conversion](#datetime-conversion)
   - [Markdown conversion](#markdown-conversion)
   - [Faraday block](#faraday-block)
+- [Handling Errors](#handling-errors)
+  - [Errors Classes](#errors-classes)
+  - [Graceful degradation](#graceful-degradation)
 - [Contributing](#contributing)
 - [Tests](#tests)
 
@@ -151,7 +154,7 @@ StrapiRuby.delete(resource: :articles, id: 12)
 
 #### .escape_empty_answer
 
-See [`.escape_empty_answer`](#gracefuly-degrade-errors-when-they-happen)
+See [`.escape_empty_answer`](#graceful-degradation)
 
 ### Basic Example: Rails
 
@@ -507,7 +510,7 @@ default_headers = { "Content-Type" => "application/json",
 
 Depending on your utilisation, there are multiple ways to handle errors.
 
-#### Error Classes
+#### Errors Classes
 
 ```ruby
 # Config Error
@@ -527,10 +530,12 @@ class BadRequestError < ClientError
 class JSONParsingError < ClientError
 ```
 
-#### Gracefuly degrade errors when they happen
+#### Graceful degradation
 
 One way to handle errors and gracefuly degrade is using `.escape_empty_answer` and use a block to nest your data accessing code.
 
+Errors will still be logged in red in console.
+
 ##### Definition
 
 ```ruby

data/lib/strapi_ruby/errors/client_error.rb

@@ -1,46 +1,50 @@
 module StrapiRuby
   class ClientError < StandardError
+    def initialize(message)
+      super(message)
+      StrapiRuby.logger.error(message)
+    end
   end
 
   class ConnectionError < ClientError
     def initialize(message)
-      super("There is a problem while initializing the connection with Faraday: #{message}")
+      super("#{ErrorMessage.faraday_connection} #{message}")
     end
   end
 
   class UnauthorizedError < ClientError
     def initialize(message, status)
-      super("There is an error from the Strapi server with status #{status}: #{message}. Make sure your strapi_token is valid.")
+      super("#{ErrorMessage.strapi_server_status} #{status}: #{message}. Make sure your strapi_token is valid.")
     end
   end
 
   class ForbiddenError < ClientError
     def initialize(message, status)
-      super("There is an error from the Strapi server with status #{status}: #{message}. Make sure your strapi_token has the correct permissions or allow public access.")
+      super("#{ErrorMessage.strapi_server_status} #{status}: #{message}. Make sure your strapi_token has the correct permissions or allow public access.")
     end
   end
 
   class NotFoundError < ClientError
     def initialize(message, status)
-      super("There is an error from the Strapi server with status #{status}: #{message}.")
+      super("#{ErrorMessage.strapi_server_status} #{status}: #{message}.")
     end
   end
 
   class UnprocessableEntityError < ClientError
     def initialize(message, status)
-      super("There is an error from the Strapi server with status #{status}: #{message}.")
+      super("#{ErrorMessage.strapi_server_status} #{status}: #{message}.")
     end
   end
 
   class ServerError < ClientError
     def initialize(message, status)
-      super("There is an error from the Strapi server with status #{status}: #{message}. Please try again later.")
+      super("#{ErrorMessage.strapi_server_status} #{status}: #{message}. Please try again later.")
     end
   end
 
   class BadRequestError < ClientError
     def initialize(message, status)
-      super("There is an error from the Strapi server with status #{status}: #{message}. Check parameters")
+      super("#{ErrorMessage.strapi_server_status} #{status}: #{message}. Check parameters")
     end
   end
 

data/lib/strapi_ruby/errors/configuration_error.rb

@@ -1,7 +1,7 @@
 module StrapiRuby
   class ConfigurationError < StandardError
     def initialize(message)
-      super("You must configure StrapiRuby before using it. See README.md for details.\n #{message}")
+      super("#{ErrorMessage.configuration}\n #{message}")
     end
   end
 end

data/lib/strapi_ruby/errors/error_text.yml

@@ -10,4 +10,7 @@ expected_string_symbol: Invalid argument type. Expected String or Symbol.
 expected_integer: Invalid argument type. Expected Integer.
 expected_proc: Invalid argument type. Expected Proc.
 publication_state: Invalid argument. Expected :live or :preview.
-pagination: Use a single pagination method, either by page or by offset
+pagination: Use a single pagination method, either by page or by offset
+strapi_server_status: There is an error from the Strapi server with status
+faraday_connection: There is an error while implementing connection with Faraday
+configuration: You must configure StrapiRuby before using it. See README.md for details.

data/lib/strapi_ruby/errors/logger.rb

@@ -0,0 +1,21 @@
+require "colorize"
+
+module StrapiRuby
+  class << self
+    attr_writer :logger
+
+    def logger
+      @logger ||= Logger.new($stdout).tap do |log|
+        log.progname = name
+        log.formatter = proc do |severity, datetime, progname, msg|
+          case severity
+          when "ERROR"
+            "[#{datetime.strftime("%Y-%m-%d %H:%M:%S")}] #{progname} - #{severity}: #{msg}".red
+          else
+            "[#{datetime.strftime("%Y-%m-%d %H:%M:%S")}] #{progname} - #{severity}: #{msg}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/strapi_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StrapiRuby
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/strapi_ruby.rb

@@ -13,6 +13,7 @@ require_relative "strapi_ruby/configuration"
 require_relative "strapi_ruby/config"
 
 # Load errors
+require_relative "strapi_ruby/errors/logger"
 require_relative "strapi_ruby/errors/client_error"
 require_relative "strapi_ruby/errors/configuration_error"
 require_relative "strapi_ruby/errors/error_message"
@@ -24,4 +25,3 @@ module StrapiRuby
   extend Configuration
   extend Interface
 end
-

data/strapi_ruby.gemspec

@@ -36,6 +36,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
+  spec.add_dependency "colorize", "~> 1.1.0"
   spec.add_dependency "faraday", "~> 2.7"
   spec.add_dependency "redcarpet", "~> 3.6"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strapi_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Maxence Robinet
@@ -10,6 +10,20 @@ bindir: exe
 cert_chain: []
 date: 2023-10-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -96,6 +110,7 @@ files:
 - lib/strapi_ruby/errors/error_code.yml
 - lib/strapi_ruby/errors/error_message.rb
 - lib/strapi_ruby/errors/error_text.yml
+- lib/strapi_ruby/errors/logger.rb
 - lib/strapi_ruby/formatter.rb
 - lib/strapi_ruby/interface.rb
 - lib/strapi_ruby/markdown.rb