purple-client 0.1.7.2 → 0.1.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69afc0be89db74d4a3b76af2c93c31652ba2443491f5e9c20303e263cb3075d5
-  data.tar.gz: de1de5487aeca7098cda9d761f026b988c3d2ee7b77d2bd0c5737467ca80bb47
+  metadata.gz: 81f0cb64364ec0312d07b900ae67a2e65137d03818c6b3e2c1b8631221ea9a65
+  data.tar.gz: 7404f01d3ba5714093d62fbac16218b263f20c43d0b29391add9fd9833ccdb29
 SHA512:
-  metadata.gz: 66fd354ebdab532ca2a35b3972eb2a7d6a8d49d1fd764b0f61e3629d9032338ca117de2240c73d26e140a6e0b31e96223cbf6d701d56ec71b1eab5f0b0e2030b
-  data.tar.gz: 79fe2ed7920d8115ffb53bde9a2619604df8e9a981e70b83096839b2fd898381747d5f42736644e87d5f63d36c7377dd4110b9332d486900c06a9dd94a8d16e8
+  metadata.gz: ab18072bf25f80e0ded0dc7d3f317230fb93e400cbc9a563bf0d6be68b3c166458bf94f39877eb6dc535bce4c1e8c962b002699e3f4e08702effee65ba86e397
+  data.tar.gz: ef5033eb7da7a10bf033583603906b31176a63222e95e5f18bbdcab613b4ac775d4cb76594419c796206d65680dfc836d88ffe8f62973b38ad867a81928a1c8d

data/README.md

@@ -121,6 +121,36 @@ end
 PostsClient.user_posts(user_id: 7)
 ```
 
+### Paths nested under parameters
+
+When a path segment is marked with `is_param: true`, any paths nested
+inside it will not have a `root_method` generated. Instead of calling a
+root method, you need to chain the segment methods manually.
+
+```ruby
+class BrowserClient < Purple::Client
+  domain 'https://api.example.com'
+
+  path :browser do
+    path :id, is_param: true do
+      path :web, method: :post do
+        response :ok do
+        end
+
+        response :bad_request do
+          body do |res|
+            puts res
+          end
+        end
+      end
+    end
+  end
+end
+
+# root_method :web will not work here
+BrowserClient.browser.id('123').web
+```
+
 ### Callbacks with additional arguments
 
 ```ruby
@@ -174,6 +204,119 @@ class AccountsClient < Purple::Client
 end
 ```
 
+### Optional fields
+
+Sometimes an API response omits certain keys. You can mark those fields as
+optional in the body definition so their absence doesn't raise validation errors.
+
+```ruby
+class CalendarClient < Purple::Client
+  domain 'https://api.example.com'
+
+  path :schedule do
+    response :ok do
+      body(
+        day: { type: Integer, optional: true },
+      )
+    end
+    root_method :schedule
+  end
+end
+
+# The `day` attribute may be missing in the response
+CalendarClient.schedule
+```
+
+### Allow blank fields
+
+Some APIs return keys that are present but contain `null` or empty string values.
+You can mark those fields with `allow_blank` so blank values do not raise
+validation errors.
+
+```ruby
+class ProfilesClient < Purple::Client
+  domain 'https://api.example.com'
+
+  path :profile do
+    response :ok do
+      body(
+        middle_name: { type: String, allow_blank: true },
+      )
+    end
+    root_method :profile
+  end
+end
+
+# The `middle_name` attribute may be blank or omitted in the response
+ProfilesClient.profile
+```
+
+### Array responses
+
+When an endpoint returns an array of objects, you can use `:array_of` to
+describe the structure of each element in the array.
+
+```ruby
+class MerchantsClient < Purple::Client
+  domain 'https://api.example.com'
+
+  path :merchants do
+    response :ok do
+      structure = {
+        id: Integer,
+        name: String,
+        address: String,
+        work_time: String,
+        accepts_qr: { type: String, optional: true }
+      }
+
+      body(:array_of, **structure)
+    end
+    root_method :merchants
+  end
+end
+
+# Each array element will be validated against the structure
+MerchantsClient.merchants
+```
+
+### Response body processing
+
+After the body structure is validated, you can supply a block to `body`
+to transform or handle the parsed response. This is useful for mapping
+error payloads to simpler return values or for normalizing data.
+
+```ruby
+class MessagesClient < Purple::Client
+  domain 'https://api.example.com'
+
+  path :messages do
+    response :unprocessable_entity do
+      structure = {
+        status: Integer,
+        type: String,
+        title: String,
+        detail: String
+      }
+
+      body(**structure) do |res|
+        case res.type
+        when 'errors/invalid_recipient'
+          :not_found
+        else
+          res
+        end
+      end
+    end
+    root_method :send_message
+  end
+end
+
+# Returns :not_found when the recipient is invalid, otherwise returns the
+# parsed response body.
+MessagesClient.send_message
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then run

data/lib/purple/client/version.rb

@@ -0,0 +1,7 @@
+require_relative '../version'
+
+module Purple
+  class Client
+    VERSION = Purple::VERSION
+  end
+end

data/lib/purple/client.rb

@@ -6,7 +6,8 @@ require 'purple/requests/authorization'
 require 'purple/response'
 require 'purple/responses/body'
 require 'purple/boolean'
-require_relative "version"
+require_relative 'version'
+require_relative 'client/version'
 
 module Purple
   class Client

data/lib/purple/path.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require 'dry-initializer'
+require 'faraday'
+require 'active_support/core_ext/hash/deep_merge'
+require 'active_support/core_ext/object/inclusion'
 
 module Purple
   class Path
@@ -24,7 +27,7 @@ module Purple
       @param_value = args.first
     end
 
-    def method_missing(method_name, *args, &)
+    def method_missing(method_name, *args, **kw_args, &)
       if children.any? { |child| child.name == method_name }
         child = children.find { |child| child.name == method_name }
 
@@ -35,7 +38,7 @@ module Purple
         if child.children.any?
           child
         else
-          callback_arguments = additional_callback_arguments.map do |arg|
+          callback_arguments = client.additional_callback_arguments.map do |arg|
             kw_args.delete(arg)
           end
 

data/lib/purple/response.rb

@@ -12,6 +12,7 @@ class Purple::Response
   CODES = {
     ok: 200,
     created: 201,
+    accepted: 202,
     bad_request: 400,
     unauthorized: 401,
     unprocessable_entity: 422,

data/lib/purple/responses/body.rb

@@ -2,6 +2,7 @@
 
 require 'purple/responses'
 require 'purple/responses/object'
+require "active_support/core_ext/string/inflections"
 
 class Purple::Responses::Body
   extend Dry::Initializer[undefined: false]
@@ -75,6 +76,8 @@ class Purple::Responses::Body
 
           check_type!(object, key, value[:type])
         else
+          next if object[key].nil?
+
           check_structure!(object[key], substructure[key])
         end
       elsif value.is_a?(Array)

data/lib/purple/responses/object.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 # Purple returns objects as responses from API. This is a base class for all responses objects.
+require 'active_support/core_ext/module/delegation'
 class Purple::Responses::Object
   attr_accessor :attributes
 

data/lib/purple/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Purple
-  VERSION = "0.1.7.2"
+  VERSION = "0.1.7.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: purple-client
 version: !ruby/object:Gem::Version
-  version: 0.1.7.2
+  version: 0.1.7.4
 platform: ruby
 authors:
 - Pavel Kalashnikov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-07-08 00:00:00.000000000 Z
+date: 2025-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-initializer
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Build API wrappers faster
 email:
 - kalashnikovisme@gmail.com
@@ -40,6 +68,7 @@ files:
 - Rakefile
 - lib/purple/boolean.rb
 - lib/purple/client.rb
+- lib/purple/client/version.rb
 - lib/purple/path.rb
 - lib/purple/request.rb
 - lib/purple/requests/authorization.rb