strapi_ruby 0.1.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1ea7267c293e0bdd14967f64eedc922615f448b49d39a9ebdba914bb65b9336
-  data.tar.gz: 99c88f5464b84da4e5eb99e106b77c00436cdc413a9be26b9aa6e44e23a0a31a
+  metadata.gz: 83a9ecc38dc8ff1adf64535662413da30dff9605533c1ae8e6a551b788ee88d0
+  data.tar.gz: 3fde93cdbcfa93470db99490c3e5596730120d5a95b7edc4434a5196cbbf96b0
 SHA512:
-  metadata.gz: 96fffc52dfc440ebb3dcdefc07b26ced071d07cd96812d868388b7f4e382a2ef73814d9eb419e8c1f291c264fa68339fc3c263658b7b2535147709568b0a72e3
-  data.tar.gz: 4e8c52118420a2d2dd2273e66221fa00c38ab7639fa7898a00647e53aec279557bcbfa0fb40859e911735890f947346a0990a22dd55d639dc44b2ab3cc1115ce
+  metadata.gz: a8586e54910503bca17a6963afe7c0562a4826ca0fd390518cce4b3b4f0b537755208a4e238e45ea08a650527e7783a96f7968b6c1064e39b98fe6338c701ad3
+  data.tar.gz: 98e4aace0f601b52fdbf54907f5338c82857ae3e822dfbb52ae67209a4c2a5e26a77e60c0081967383dda165f76eec665d5362e7adeac46990bdc3f3ddfc0606

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [0.1.3] - 2023-10-20
 
+- Added error message for collection_query error
+
+## [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
 

data/README.md

@@ -10,6 +10,18 @@
 
 I think it's one of the actual coolest solution for integrating a CMS into Rails for example, so let's dive in!
 
+## Important Notice: Strapi V5 and strapi_ruby
+
+Starting from version >=1.0.0, the StrapiRuby gem is only compatible with Strapi version 5 and above. This update includes significant changes to align with the new response format introduced in Strapi v5. Key changes include:
+
+- **Flattened Response Format**: The `attributes` object has been removed, and fields are now directly part of the `data` object.
+- **ID Handling**: The `id` field has been replaced with `documentId` to uniquely identify resources.
+- **Filter Adjustments**: Filters that previously used `id` should now use `documentId`.
+
+These changes ensure that the StrapiRuby gem takes full advantage of the improvements in Strapi v5, providing a more streamlined and efficient API interaction experience. Please ensure your Strapi server is updated to version 5 or later to use this version of the gem.
+
+Following will be the documentation for 1.xx release.
+
 ## Table of contents
 
 - [Installation](#installation)
@@ -50,8 +62,6 @@ Add this line to your application's 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
@@ -105,9 +115,9 @@ data = answer.data
 meta = answer.meta
 
 # Access a specific attribute
-answer = StrapiRuby.get(resource: :articles, id: 2)
+answer = StrapiRuby.get(resource: :articles, document_id: "clkgylmcc000008lcdd868feh")
 article = answer.data
-title = article.attributes.title
+title = article.title
 
 # If an error occur, it will be raised to be rescued and displayed in the answer.
 data = answer.data # => nil
@@ -125,7 +135,7 @@ answer = StrapiRuby.get(resource: :restaurants)
 
 
 # Get a specific element
-StrapiRuby.get(resource: :restaurants, id: 1)
+StrapiRuby.get(resource: :restaurants, document_id: "clkgylmcc000008lcdd868feh")
 ```
 
 #### .post
@@ -143,7 +153,7 @@ StrapiRuby.post(resource: :articles,
 ```ruby
 # Update a specific item, return item updated
 StrapiRuby.put(resource: :articles,
-               id: 23,
+               document_id: "clkgylmcc000008lcdd868feh",
                data: {content: "'I've edited this article via a PUT request'"})
 ```
 
@@ -151,7 +161,7 @@ StrapiRuby.put(resource: :articles,
 
 ```ruby
 # Delete an item, return item deleted
-StrapiRuby.delete(resource: :articles, id: 12)
+StrapiRuby.delete(resource: :articles, document_id: "clkgylmcc000008lcdd868feh")
 
 ```
 
@@ -176,7 +186,7 @@ end
   <ul>
     <% @articles.data.each do |article| %>
       <li>
-        <%= article.attributes.title %>
+        <%= article.title %>
       </li>
     <% end %>
   </ul>
@@ -324,11 +334,11 @@ StrapiRuby.get(resource: :users, filters: { username: { "$eq" => "John" } })
 # Using $in operator to match multiples values
 StrapiRuby.get(resource: :restaurants,
                filters: {
-                 id: {
-                   "$in" => ["3", "6", "8"],
+                 documentId: {
+                   "$in" => ["clkgylmcc000008lcdd868feh", "clkgylw7d000108lc4rw1bb6s"],
                  },
                })
-# => /restaurants?filters[id][$in][0]=3&filters[id][$in][1]=6&filters[id][$in][2]=8
+# => /restaurants?filters[documentId][$in][0]=clkgylmcc000008lcdd868feh&filters[documentId][$in][0]=clkgylw7d000108lc4rw1bb6s
 
 # --------------------------------
 

data/lib/strapi_ruby/client.rb

@@ -40,7 +40,8 @@ module StrapiRuby
                           "User-Agent" => "StrapiRuby/#{StrapiRuby::VERSION}" }
 
       Faraday.new(url: url) do |faraday|
-        faraday.request :url_encoded
+        # Use FlatParamsEncoder to prevent double encoding of special characters
+        faraday.options.params_encoder = Faraday::FlatParamsEncoder
         faraday.adapter Faraday.default_adapter
         block&.call(faraday)
         faraday.headers = default_headers.merge(faraday.headers)
@@ -69,9 +70,9 @@ module StrapiRuby
 
     # rubocop:disable Metrics/AbcSize
     def handle_response(response)
-      body = convert_json_to_open_struct(response.body)
+      body = convert_json_to_open_struct(response.body) unless response.body.empty?
       case response.status
-      when 200
+      when 200, 201
         body
       when 400
         raise BadRequestError.new(body.error.message, response.status)

data/lib/strapi_ruby/endpoint/builder.rb

@@ -3,7 +3,7 @@ module StrapiRuby
     class Builder
       def initialize(options = {})
         @resource = options[:resource]
-        @id = options[:id]
+        @document_id = options[:document_id]
         @query = Query.new(options).call
         @result = nil
       end
@@ -20,7 +20,7 @@ module StrapiRuby
         @result = if collection?
                     "#{base_uri}/#{@resource}"
                   else
-                    "#{base_uri}/#{@resource}/#{@id}"
+                    "#{base_uri}/#{@resource}/#{@document_id}"
                   end
       end
 
@@ -29,7 +29,7 @@ module StrapiRuby
       end
 
       def collection?
-        @id.nil?
+        @document_id.nil?
       end
 
       def base_uri

data/lib/strapi_ruby/endpoint/strapi_parameters.rb

@@ -114,12 +114,11 @@ module StrapiRuby
               traverse_hash({ index => item }, current_key)
             end
           else
-            # We can pass values as symbols but we need to convert them to string
-            # to be able to escape them
             value = value.to_s if value.is_a?(Symbol)
+            next if value.nil? # Skip nil values
             "#{current_key}=#{CGI.escape(value)}"
           end
-        end.join("&")
+        end.compact.join("&")
       end
     end
   end

data/lib/strapi_ruby/errors/error_text.yml

@@ -13,4 +13,5 @@ publication_state: Invalid argument. Expected :live or :preview.
 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.
+configuration: You must configure StrapiRuby before using it. See README.md for details.
+collection_query: You try to use Strapi parameters on a single item but they should be used on a collection.

data/lib/strapi_ruby/formatter.rb

@@ -20,9 +20,9 @@ module StrapiRuby
       return unless StrapiRuby.config.convert_to_datetime
 
       if collection?(data)
-        data.each { |item| parse_into_datetime!(item.attributes) }
+        data.each { |item| parse_into_datetime!(item) }
       else
-        parse_into_datetime!(data.attributes)
+        parse_into_datetime!(data)
       end
     end
 
@@ -62,9 +62,9 @@ module StrapiRuby
 
     def convert_to_html!(data)
       if collection?(data)
-        data.each { |item| convert_attributes!(item.attributes) }
+        data.each { |item| convert_attributes!(item) }
       else
-        convert_attributes!(data.attributes)
+        convert_attributes!(data)
       end
     end
 

data/lib/strapi_ruby/interface.rb

@@ -30,8 +30,10 @@ module StrapiRuby
       validate_options(options)
       @endpoint = build_endpoint(options)
       answer = build_answer(http_verb, @endpoint, options)
-      data = format_data(answer.data, options)
-      meta = answer.meta
+      if answer
+        data = format_data(answer.data, options) unless answer.data.nil?
+        meta = answer.meta unless answer.meta.nil?
+      end
 
       return_success_open_struct(data, meta, options)
     rescue StrapiRuby::ClientError, StrapiRuby::ConfigurationError => e

data/lib/strapi_ruby/markdown.rb

@@ -8,6 +8,8 @@ module StrapiRuby
     include Singleton
 
     def to_html(markdown)
+      return "" if markdown.nil?
+      
       markdown_renderer.render(markdown)
     end
 

data/lib/strapi_ruby/validations.rb

@@ -14,7 +14,7 @@ module StrapiRuby
     def validate_options(options)
       validate_config_presence
       validate_resource(options)
-      validate_id(options)
+      validate_document_id(options)
       validate_show_endpoint_params(options)
       validate_body(options)
     end
@@ -47,8 +47,8 @@ module StrapiRuby
       raise TypeError, "#{ErrorMessage.expected_string_symbol} Got #{options[:resource].class.name}" unless options[:resource].is_a?(String) || options[:resource].is_a?(Symbol)
     end
 
-    def validate_id(options)
-      raise TypeError, "#{ErrorMessage.expected_integer} Got #{options[:id].class.name}" if options.key?(:id) && !options[:id].is_a?(Integer)
+    def validate_document_id(options)
+      raise TypeError, "#{ErrorMessage.expected_string} Got #{options[:document_id].class.name}" if options.key?(:document_id) && !options[:document_id].is_a?(String)
     end
 
     def validate_show_endpoint_params(options)

data/lib/strapi_ruby/version.rb

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

data/lib/strapi_ruby.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require "ostruct"
 
 require_relative "strapi_ruby/version"
 require_relative "strapi_ruby/validations"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strapi_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Maxence Robinet
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-20 00:00:00.000000000 Z
+date: 2025-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -143,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Ruby wrapper around Strapi API.