purple-client 0.1.7.3 → 0.1.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08cd363a5b6e96500dde9beaa81ac46fdb282d6e6225d8ca19d4ba917c0b6f4f'
-  data.tar.gz: 3eb93db2b0b359bc7b455ce6282bcc02d1d50991fbd8578a0527388b785fd9e8
+  metadata.gz: b5222522b4a3c4376e2a10f9ea7e4deece8f209d4f3fe4ac22dc9e12fe4445c7
+  data.tar.gz: e29a6b0c293f9dec1b84d322a46f8a00219c44890138e05b3ec507ae186eefb6
 SHA512:
-  metadata.gz: 2653930ab7bcb2855c8ff142d401ffb8b1c676f0ca579f66fb7a780f8cb45760afff1f7f60fbabe7573091c4a877e6e5ea4d8d31d26c9dafd41a8c4d2b953095
-  data.tar.gz: f2aacc6f3e1d6ca9b6661c5ad08be55f29b12061e1b037d30aca40ef7bb397ebb2b6ef88e6df772e66abf8bb7b61d6247d7d1980b35009d9f759d3bbd48504b5
+  metadata.gz: d9b273ed8a541e201b06221cb26696b9c6035bdbf06ae3d71dd37fad084b9e04a9a4b4af107284e32b98bf4076ee9ee26d67a41b34e83060b20530b2baf67ae3
+  data.tar.gz: 2c02a529e6df950dac3b480a0d736e3de51d822e5de6307ba9e6e8d675c8fe59623449475c664bc62300e2eb13e79e05cbd2d85bd2505eee9301f66d84239629

data/README.md

@@ -1,4 +1,4 @@
-# Purple::Client
+# Purple Client
 
 Purple::Client is a small DSL that helps you describe HTTP APIs. You define a domain, paths, and response structures, and the library generates handy methods for interacting with your service.
 
@@ -59,6 +59,36 @@ end
 JobsClient.job(123)
 ```
 
+### Simple POST request
+
+```ruby
+class Amocrm::Client < Purple::Client
+  domain 'https://www.amocrm.ru'
+
+  path :oauth2 do
+    path :access_token, method: :post do
+      root_method :access_token
+
+      params do |client_id:, client_secret:, redirect_uri:, code:, grant_type: :authorization_code|
+        { client_id:, client_secret:, redirect_uri:, code:, grant_type: }
+      end
+
+      response :ok do
+        body(
+          token_type: String,
+          expires_in: Integer,
+          server_time: Integer,
+          access_token: String,
+          refresh_token: String
+        )
+      end
+
+      response :bad_request
+    end
+  end
+end
+```
+
 ### Using authorization
 
 ```ruby
@@ -121,6 +151,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
@@ -197,6 +257,30 @@ end
 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
@@ -226,6 +310,43 @@ end
 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/path.rb

@@ -27,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 }
 
@@ -38,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

@@ -82,6 +82,10 @@ class Purple::Responses::Body
         end
       elsif value.is_a?(Array)
         object[key].each do |item|
+          if value[0].is_a?(Symbol)
+            raise "Body structure definition error in key '#{key}' of structure #{substructure}."
+          end
+
           check_structure!(item, value[0])
         end
       else

data/lib/purple/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: purple-client
 version: !ruby/object:Gem::Version
-  version: 0.1.7.3
+  version: 0.1.7.5
 platform: ruby
 authors:
 - Pavel Kalashnikov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-08-12 00:00:00.000000000 Z
+date: 2025-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-initializer