purple-client 0.1.7.2 → 0.1.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69afc0be89db74d4a3b76af2c93c31652ba2443491f5e9c20303e263cb3075d5
-  data.tar.gz: de1de5487aeca7098cda9d761f026b988c3d2ee7b77d2bd0c5737467ca80bb47
+  metadata.gz: '08cd363a5b6e96500dde9beaa81ac46fdb282d6e6225d8ca19d4ba917c0b6f4f'
+  data.tar.gz: 3eb93db2b0b359bc7b455ce6282bcc02d1d50991fbd8578a0527388b785fd9e8
 SHA512:
-  metadata.gz: 66fd354ebdab532ca2a35b3972eb2a7d6a8d49d1fd764b0f61e3629d9032338ca117de2240c73d26e140a6e0b31e96223cbf6d701d56ec71b1eab5f0b0e2030b
-  data.tar.gz: 79fe2ed7920d8115ffb53bde9a2619604df8e9a981e70b83096839b2fd898381747d5f42736644e87d5f63d36c7377dd4110b9332d486900c06a9dd94a8d16e8
+  metadata.gz: 2653930ab7bcb2855c8ff142d401ffb8b1c676f0ca579f66fb7a780f8cb45760afff1f7f60fbabe7573091c4a877e6e5ea4d8d31d26c9dafd41a8c4d2b953095
+  data.tar.gz: f2aacc6f3e1d6ca9b6661c5ad08be55f29b12061e1b037d30aca40ef7bb397ebb2b6ef88e6df772e66abf8bb7b61d6247d7d1980b35009d9f759d3bbd48504b5

data/README.md

@@ -174,6 +174,58 @@ 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
+```
+
+### 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
+```
+
 ## 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

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.3"
 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.3
 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