strapi_ruby 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b57f00940ff27f894585565de2df3b5df945331e961232b5588af966e1fe40b
-  data.tar.gz: f0c734f9fade77f6bdd03dd505cedd40acc3f798bc566f3753ec879b204a1c08
+  metadata.gz: a1ea7267c293e0bdd14967f64eedc922615f448b49d39a9ebdba914bb65b9336
+  data.tar.gz: 99c88f5464b84da4e5eb99e106b77c00436cdc413a9be26b9aa6e44e23a0a31a
 SHA512:
-  metadata.gz: 366d106cf1f9e421d2205e962643c19dfad4971f035163efbe8e900787898e1fabc8d50669b00ac7921e2bfa9bbb1f9891aa41f183630b7050f29e77e150e91c
-  data.tar.gz: eb616feadc6c363b2f89d21735373b35cc5705b2f0c59345acd33bba67fba1711e40adef3dbb0129d241c0f2b2aecb7c5bf4b163bffe18112b7511e0ffd22a1d
+  metadata.gz: 96fffc52dfc440ebb3dcdefc07b26ced071d07cd96812d868388b7f4e382a2ef73814d9eb419e8c1f291c264fa68339fc3c263658b7b2535147709568b0a72e3
+  data.tar.gz: 4e8c52118420a2d2dd2273e66221fa00c38ab7639fa7898a00647e53aec279557bcbfa0fb40859e911735890f947346a0990a22dd55d639dc44b2ab3cc1115ce

data/CHANGELOG.md

@@ -1,6 +1,15 @@
+## [0.1.3] - 2023-10-20
+
+- Check for errors when using collection strapi parameters like sort/filters... on single items
+- Fix Typo on ConfigError => ConfigurationError
+
+## [0.1.2] - 2023-10-04
+
+- Updated README
+
 ## [0.1.1] - 2023-10-04
 
-- Added logger for ClientError and ConfigError
+- Added logger for ClientError and ConfigurationError
 
 ## [0.1.0] - 2023-10-04
 

data/README.md

@@ -15,10 +15,11 @@ I think it's one of the actual coolest solution for integrating a CMS into Rails
 - [Installation](#installation)
 - Usage:
   - [API](#api):
-    - [get](#get)
-    - [post](#post)
-    - [put](#put)
-    - [delete](#delete)
+    - [.get](#get)
+    - [.post](#post)
+    - [.put](#put)
+    - [.delete](#delete)
+    - [.escape_empty_answer](#escape_empty_answer)
   - [Basic Example: Rails](#basic-example-rails)
   - [Strapi Parameters](#strapi-parameters):
     - [populate](#populate)
@@ -34,6 +35,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)
 
@@ -43,13 +47,15 @@ Add this line to your application's Gemfile:
 
 ```ruby
 # Gemfile
-
     gem "strapi_ruby"
 ```
 
+
+
 Then if you use Rails, run in your terminal to generate a config initializer. Otherwise copy paste and fill the config block.
 
 ```bash
+bundle
 rake strapi_ruby:config
 ```
 
@@ -151,7 +157,7 @@ StrapiRuby.delete(resource: :articles, id: 12)
 
 #### .escape_empty_answer
 
-See [`.escape_empty_answer`](#gracefuly-degrade-errors-when-they-happen)
+See [`Graceful degradation`](#graceful-degradation)
 
 ### Basic Example: Rails
 
@@ -163,7 +169,7 @@ def home
 end
 ```
 
-```ruby
+```erb
 # home.html.erb
 
 <% StrapiRuby.escape_empty_answer(@articles) do %>
@@ -327,7 +333,7 @@ StrapiRuby.get(resource: :restaurants,
 # --------------------------------
 
 # Complex filtering with $and and $or
-RubyStrapi.get(resource: :books,
+StrapiRuby.get(resource: :books,
                filters: {
                  "$or" => [
                    {
@@ -394,7 +400,7 @@ StrapiRuby.get(resource: :articles, locale: :fr)
 
 #### publication_state
 
-Use `preview` or `live`
+Use `:preview` or `:live`
 
 ```ruby
 StrapiRuby.get(resource: :articles, publication_state: :preview)
@@ -507,7 +513,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,7 +533,7 @@ 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.
 

data/lib/strapi_ruby/client.rb

@@ -48,15 +48,13 @@ module StrapiRuby
     end
 
     def performs_request
-      begin
-        yield
-      rescue Faraday::ConnectionFailed => e
-        raise ConnectionError, "#{ErrorMessage.connection_failed} #{e.message}"
-      rescue Faraday::TimeoutError => e
-        raise ConnectionError, "#{ErrorMessage.timeout} #{e.message}"
-      rescue StandardError => e
-        raise ConnectionError, "#{ErrorMessage.unexpected} #{e.message}"
-      end
+      yield
+    rescue Faraday::ConnectionFailed => e
+      raise ConnectionError, "#{ErrorMessage.connection_failed} #{e.message}"
+    rescue Faraday::TimeoutError => e
+      raise ConnectionError, "#{ErrorMessage.timeout} #{e.message}"
+    rescue StandardError => e
+      raise ConnectionError, "#{ErrorMessage.unexpected} #{e.message}"
     end
 
     def convert_json_to_open_struct(json)

data/lib/strapi_ruby/endpoint/builder.rb

@@ -17,10 +17,10 @@ module StrapiRuby
       private
 
       def build_endpoint
-        @result = if builds_collection?
-                    "#{base_uri}/#{@resource}/#{@id}"
-                  else
+        @result = if collection?
                     "#{base_uri}/#{@resource}"
+                  else
+                    "#{base_uri}/#{@resource}/#{@id}"
                   end
       end
 
@@ -28,8 +28,8 @@ module StrapiRuby
         @result += @query if @query
       end
 
-      def builds_collection?
-        !@id.nil?
+      def collection?
+        @id.nil?
       end
 
       def base_uri

data/lib/strapi_ruby/endpoint/strapi_parameters.rb

@@ -6,6 +6,7 @@ module StrapiRuby
       private
 
       def sort(args)
+        check_collection
         build_query_from_args(args, :sort)
       end
 
@@ -18,6 +19,7 @@ module StrapiRuby
       end
 
       def filters(args)
+        check_collection
         build_query_from_args(args, :filters)
       end
 
@@ -25,54 +27,39 @@ module StrapiRuby
         raise TypeError, "#{ErrorMessage.expected_integer} Got #{number.class.name}" unless number.is_a?(Integer)
 
         check_single_pagination
+        check_collection
         @result += "#{prefix}pagination[pageSize]=#{number}"
       end
 
-      # Sets the page number for the query result.
-      #
-      # @param number [Integer] An Integer representing the page number.
-      #
-      # @return [String] The updated query string with the page number option added.
       def page(number)
         raise TypeError, "#{ErrorMessage.expected_integer} Got #{number.class.name}" unless number.is_a?(Integer)
 
         check_single_pagination
+        check_collection
         @result += "#{prefix}pagination[page]=#{number}"
       end
 
-      # Sets the offset for the query result.
-      #
-      # @param number [Integer] An Integer representing the offset.
-      #
-      # @return [String] The updated query string with the offset option added.
       def start(number)
         raise TypeError, "#{ErrorMessage.expected_integer} Got #{number.class.name}" unless number.is_a?(Integer)
 
         check_single_pagination
+        check_collection
         @result += "#{prefix}pagination[start]=#{number}"
       end
 
-      # Sets the limit for the query result.
-      #
-      # @param number [Integer] An Integer representing the limit.
-      #
-      # @return [String] The updated query string with the limit option added.
       def limit(number)
         raise TypeError unless number.is_a?(Integer)
 
         check_single_pagination
+        check_collection
         @result += "#{prefix}pagination[limit]=#{number}"
       end
 
-      ##
-      # Sets the locale for the query result.
-      #
-      # @params arg [String, Symbol] A String or Symbol representing the locale.
-      #
-      # @return [String] The updated query string with the locale option added.
       def locale(arg)
         raise TypeError, "#{ErrorMessage.expected_string_symbol} Got #{arg.class.name}" unless arg.is_a?(String) || arg.is_a?(Symbol)
 
+        check_collection
+
         @result += "#{prefix}locale=#{arg}"
       end
 
@@ -80,11 +67,11 @@ module StrapiRuby
         raise TypeError, "#{ErrorMessage.expected_string_symbol} Got #{arg.class.name}" unless arg.is_a?(String) || arg.is_a?(Symbol)
         raise ArgumentError, "#{ErrorMessage.publication_state} Got #{arg}" unless arg.to_sym == :live || arg.to_sym == :preview
 
+        check_collection
+
         @result += "#{prefix}publicationState=#{arg}"
       end
 
-      # Checks params don't combine pagination methods.
-      #
       def check_single_pagination
         return unless (@options.key?(:page) && @options.key?(:start)) ||
                       (@options.key(:page) && @options.key?(:limit)) ||
@@ -94,9 +81,16 @@ module StrapiRuby
         raise ArgumentError, ErrorMessage.pagination
       end
 
-      # builds the prefix for the query string (either "?" or "&" depending on whether the query string is empty or not).
-      #
-      # @return [String] A String representing the prefix.
+      def collection?
+        @options[:id].nil?
+      end
+
+      def check_collection
+        return if collection?
+
+        raise ArgumentError, ErrorMessage.collection_query
+      end
+
       def prefix
         @result.empty? ? "?" : "&"
       end

data/lib/strapi_ruby/interface.rb

@@ -20,23 +20,22 @@ module StrapiRuby
 
     def escape_empty_answer(answer)
       return answer.error.message if answer.data.nil? && answer.error
+
       yield
     end
 
     private
 
     def request(http_verb, options = {})
-      begin
-        validate_options(options)
-        @endpoint = build_endpoint(options)
-        answer = build_answer(http_verb, @endpoint, options)
-        data = format_data(answer.data, options)
-        meta = answer.meta
+      validate_options(options)
+      @endpoint = build_endpoint(options)
+      answer = build_answer(http_verb, @endpoint, options)
+      data = format_data(answer.data, options)
+      meta = answer.meta
 
-        return_success_open_struct(data, meta, options)
-      rescue StrapiRuby::ClientError, StrapiRuby::ConfigError => e
-        return_error_open_struct(e, options)
-      end
+      return_success_open_struct(data, meta, options)
+    rescue StrapiRuby::ClientError, StrapiRuby::ConfigurationError => e
+      return_error_open_struct(e, options)
     end
 
     def build_answer(http_verb, endpoint, options)
@@ -53,7 +52,7 @@ module StrapiRuby
       options[:show_endpoint] || StrapiRuby.config.show_endpoint
     end
 
-    def return_success_open_struct(data, meta, error = nil, options = {})
+    def return_success_open_struct(data, meta, _error = nil, options = {})
       if show_endpoint?(options)
         OpenStruct.new(data: data,
                        meta: meta,
@@ -63,7 +62,7 @@ module StrapiRuby
       end
     end
 
-    def return_error_open_struct(error, options = {})
+    def return_error_open_struct(error, _options = {})
       OpenStruct.new(error: OpenStruct.new(message: "#{error.class}: #{error.message}"),
                      endpoint: @endpoint,
                      data: nil,

data/lib/strapi_ruby/tasks/config.rake

@@ -20,7 +20,7 @@ namespace :strapi_ruby do
     config.strapi_server_uri = "YOUR_SERVER_URI"
     config.strapi_token = "YOUR_TOKEN"
   end
-  CONFIG
+      CONFIG
       File.write(config_file, config)
       puts "StrapiRuby configuration file created at config/initializers/strapi_ruby.rb."
     end

data/lib/strapi_ruby/validations.rb

@@ -26,7 +26,7 @@ module StrapiRuby
     end
 
     def validate_show_endpoint_config(show_endpoint)
-      raise TypeError, "#{ErrorMessage.expected_boolean}" unless [true, false].include?(show_endpoint)
+      raise TypeError, ErrorMessage.expected_boolean unless [true, false].include?(show_endpoint)
     end
 
     def validate_faraday_block(faraday)
@@ -52,7 +52,7 @@ module StrapiRuby
     end
 
     def validate_show_endpoint_params(options)
-      raise TypeError, "#{ErrorMessage.expected_boolean}" if options[:show_endpoint] && ![true, false].include?(options[:show_endpoint])
+      raise TypeError, ErrorMessage.expected_boolean if options[:show_endpoint] && ![true, false].include?(options[:show_endpoint])
     end
 
     def validate_body(options)

data/lib/strapi_ruby/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strapi_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Maxence Robinet
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-11 00:00:00.000000000 Z
+date: 2023-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -90,6 +90,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".DS_Store"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
@@ -97,7 +98,6 @@ files:
 - README.md
 - Rakefile
 - assets/strapi_ruby_logo.png
-- features.md
 - lib/strapi_ruby.rb
 - lib/strapi_ruby/client.rb
 - lib/strapi_ruby/config.rb
@@ -120,7 +120,6 @@ files:
 - lib/strapi_ruby/version.rb
 - rubocop.txt
 - sig/strapi_ruby.rbs
-- strapi_ruby-0.1.0.gem
 - strapi_ruby.gemspec
 homepage: https://github.com/saint-james-fr/strapi_ruby
 licenses:

data/features.md

@@ -1,7 +0,0 @@
-# Features
-
-- I want to be able to configure using a YAML file
-- I want to have a simple API to unpack and read fetched data
-- I want to have easy support for SEO plugin
-- I want to do all GET Operations
-- I want to do all POST operations