feat: Migrate to strapi v5

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    strapi_ruby (0.1.4)
+    strapi_ruby (1.0.1)
       colorize (~> 1.1.0)
       faraday (~> 2.7)
       redcarpet (~> 3.6)

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)
@@ -43,15 +55,13 @@ I think it's one of the actual coolest solution for integrating a CMS into Rails
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's Gemfile - **make sure to take at least 1.0.1 version**
 
 ```ruby
 # Gemfile
-    gem "strapi_ruby"
+    gem 'strapi_ruby', '~> 1.0.1'
 ```
 
-
-
 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,15 +153,15 @@ 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'"})
 ```
 
 #### .delete
 
 ```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
 
 # --------------------------------
 

lib/strapi_ruby.rb

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

lib/strapi_ruby/client.rb

@@ -40,7 +40,8 @@ def set_connection(options, &block)
                           "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 @@ def build_data_payload(body)
 
     # 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)

lib/strapi_ruby/endpoint/builder.rb

@@ -3,7 +3,7 @@ module Endpoint
     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 @@ def build_endpoint
         @result = if collection?
                     "#{base_uri}/#{@resource}"
                   else
-                    "#{base_uri}/#{@resource}/#{@id}"
+                    "#{base_uri}/#{@resource}/#{@document_id}"
                   end
       end
 
@@ -29,7 +29,7 @@ def append_query
       end
 
       def collection?
-        @id.nil?
+        @document_id.nil?
       end
 
       def base_uri

lib/strapi_ruby/endpoint/strapi_parameters.rb

@@ -114,12 +114,11 @@ def traverse_hash(hash, parent_key = nil)
               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

lib/strapi_ruby/formatter.rb

@@ -20,9 +20,9 @@ def convert_to_datetime!(data)
       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 @@ def collection?(data)
 
     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
 

lib/strapi_ruby/interface.rb

@@ -30,8 +30,10 @@ def request(http_verb, options = {})
       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

lib/strapi_ruby/markdown.rb

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

lib/strapi_ruby/validations.rb

@@ -14,7 +14,7 @@ def validate_config(config)
     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 @@ def validate_resource(options)
       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)

lib/strapi_ruby/version.rb

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

spec/client/client_spec.rb

@@ -4,20 +4,20 @@
   let(:client) { StrapiRuby::Client.new(strapi_server_uri: "https://www.example.com") }
 
   before do
-    stub_request(:get, "https://www.example.com/articles/1").to_return(status: 200, body: '{"data": {"attributes":{"id": 1, "title": "Example"}}}')
-    stub_request(:post, "https://www.example.com/articles").to_return(status: 200, body: '{"data": {"attributes": {"title": "This is a new example"}}}')
-    stub_request(:put, "https://www.example.com/articles/1").to_return(status: 200, body: '{"data": {"attributes": {"title": "This is a modified example"}}}')
-    stub_request(:delete, "https://www.example.com/articles/1").to_return(status: 200, body: '{"data": {"attributes": {"title": "This is a deleted example"}}}')
+    stub_request(:get, "https://www.example.com/articles/clkgylw7d000108lc4rw1bb6s").to_return(status: 200, body: '{"data" :{"documentId": "clkgylw7d000108lc4rw1bb6s", "title": "Example"}}')
+    stub_request(:post, "https://www.example.com/articles").to_return(status: 200, body: '{"data": {"documentId": "clkgylw7d000108lc4rw1bb6s", "title": "This is a new example"}}')
+    stub_request(:put, "https://www.example.com/articles/clkgylw7d000108lc4rw1bb6s").to_return(status: 200, body: '{"data": {"documentId": "clkgylw7d000108lc4rw1bb6s", "title": "This is a modified example"}}')
+    stub_request(:delete, "https://www.example.com/articles/clkgylw7d000108lc4rw1bb6s").to_return(status: 200, body: '{"data": {"documentId": "clkgylw7d000108lc4rw1bb6s", "title": "This is a deleted example"}}')
   end
 
   describe "#get" do
     it "sends a GET request to the specified endpoint" do
-      faraday_response = client.connection.get("/articles/1")
+      faraday_response = client.connection.get("/articles/clkgylw7d000108lc4rw1bb6s")
       expect(faraday_response.status).to eq(200)
     end
 
     it "returns an OpenStruct object" do
-      response = client.get("/articles/1")
+      response = client.get("/articles/clkgylw7d000108lc4rw1bb6s")
       expect(response.class).to eq(OpenStruct)
     end
 
@@ -41,7 +41,7 @@
       expect(faraday_response.status).to eq(200)
       response = client.post("/articles", { title: "This is a new example" })
       p
-      expect(response.data.attributes.title).to eq("This is a new example")
+      expect(response.data.title).to eq("This is a new example")
     end
 
     it "returns an OpenStruct object" do
@@ -65,57 +65,57 @@
 
   describe "#put" do
     it "sends a PUT request to the specified endpoint" do
-      faraday_response = client.connection.put("/articles/1", { title: "This is a modified example" })
+      faraday_response = client.connection.put("/articles/clkgylw7d000108lc4rw1bb6s", { title: "This is a modified example" })
       expect(faraday_response.status).to eq(200)
 
-      response = client.put("/articles/1", { title: "This is a modified example" })
-      expect(response.data.attributes.title).to eq("This is a modified example")
+      response = client.put("/articles/clkgylw7d000108lc4rw1bb6s", { title: "This is a modified example" })
+      expect(response.data.title).to eq("This is a modified example")
     end
 
     it "returns an OpenStruct object" do
-      response = client.put("/articles/1", { title: "This is a modified example" })
+      response = client.put("/articles/clkgylw7d000108lc4rw1bb6s", { title: "This is a modified example" })
       expect(response.class).to eq(OpenStruct)
     end
 
     it "handles connection errors gracefully" do
       allow_any_instance_of(Faraday::Connection).to receive(:put).and_raise(Faraday::ConnectionFailed.new("Connection failed"))
-      expect { client.put("/resource/1", {}) }.to raise_error(StrapiRuby::ConnectionError)
+      expect { client.put("/resource/clkgylw7d000108lc4rw1bb6s", {}) }.to raise_error(StrapiRuby::ConnectionError)
     end
     it "handles timeout errors gracefully" do
       allow_any_instance_of(Faraday::Connection).to receive(:put).and_raise(Faraday::TimeoutError.new("Timeout Error"))
-      expect { client.put("/resource/1", {}) }.to raise_error(StrapiRuby::ConnectionError)
+      expect { client.put("/resource/clkgylw7d000108lc4rw1bb6s", {}) }.to raise_error(StrapiRuby::ConnectionError)
     end
     it "handles other errors gracefully" do
       allow_any_instance_of(Faraday::Connection).to receive(:put).and_raise(StandardError.new("Something bad happened"))
-      expect { client.put("/resource/1", {}) }.to raise_error(StrapiRuby::ConnectionError)
+      expect { client.put("/resource/clkgylw7d000108lc4rw1bb6s", {}) }.to raise_error(StrapiRuby::ConnectionError)
     end
   end
 
   describe "#delete" do
     it "sends a DELETE request to the specified endpoint" do
-      faraday_response = client.connection.delete("/articles/1")
+      faraday_response = client.connection.delete("/articles/clkgylw7d000108lc4rw1bb6s")
       expect(faraday_response.status).to eq(200)
 
-      response = client.delete("/articles/1")
-      expect(response.data.attributes.title).to eq("This is a deleted example")
+      response = client.delete("/articles/clkgylw7d000108lc4rw1bb6s")
+      expect(response.data.title).to eq("This is a deleted example")
     end
 
     it "returns an OpenStruct object" do
-      response = client.put("/articles/1", { title: "This is a deleted example" })
+      response = client.put("/articles/clkgylw7d000108lc4rw1bb6s", { title: "This is a deleted example" })
       expect(response.class).to eq(OpenStruct)
     end
 
     it "handles connection errors gracefully" do
       allow_any_instance_of(Faraday::Connection).to receive(:delete).and_raise(Faraday::ConnectionFailed.new("Connection failed"))
-      expect { client.delete("/resource/1") }.to raise_error(StrapiRuby::ConnectionError)
+      expect { client.delete("/resource/clkgylw7d000108lc4rw1bb6s") }.to raise_error(StrapiRuby::ConnectionError)
     end
     it "handles timeout errors gracefully" do
       allow_any_instance_of(Faraday::Connection).to receive(:delete).and_raise(Faraday::TimeoutError.new("Timeout Error"))
-      expect { client.delete("/resource/1") }.to raise_error(StrapiRuby::ConnectionError)
+      expect { client.delete("/resource/clkgylw7d000108lc4rw1bb6s") }.to raise_error(StrapiRuby::ConnectionError)
     end
     it "handles other errors gracefully" do
       allow_any_instance_of(Faraday::Connection).to receive(:delete).and_raise(StandardError.new("Something bad happened"))
-      expect { client.delete("/resource/1") }.to raise_error(StrapiRuby::ConnectionError)
+      expect { client.delete("/resource/clkgylw7d000108lc4rw1bb6s") }.to raise_error(StrapiRuby::ConnectionError)
     end
   end
 
@@ -146,15 +146,15 @@
 
   describe "#handle_response" do
     context "when the response status is 200" do
-      let(:response) { double(status: 200, message: "OK", body: '{"data": {"id": 1, "name": "Example"}}') }
+      let(:response) { double(status: 200, message: "OK", body: '{"data": {"documentId": "clkgylw7d000108lc4rw1bb6s", "title": "Example"}}') }
 
       it "returns an OpenStruct object" do
         expect(client.send(:handle_response, response)).to be_a(OpenStruct)
       end
 
       it "parses the JSON data into the OpenStruct object" do
-        expect(client.send(:handle_response, response).data.id).to eq(1)
-        expect(client.send(:handle_response, response).data.name).to eq("Example")
+        expect(client.send(:handle_response, response).data.documentId).to eq("clkgylw7d000108lc4rw1bb6s")
+        expect(client.send(:handle_response, response).data.title).to eq("Example")
       end
     end
 

spec/config/config_spec.rb

@@ -17,7 +17,6 @@
         config.strapi_server_uri = "https://example.com"
         config.strapi_token = "124"
         config.faraday = faraday_string
-        p config
         expect { config.call }.to raise_error(TypeError)
       end
     end