purple-client 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d18a27dc35385412674a327de6cb947d1b4d8efe4e4032acc9edc1513ce24da
-  data.tar.gz: 3611ed61c25f22b6f9f458894ca52bf611b10874051073485e9e67317529c3b5
+  metadata.gz: 426284067d37937cf20cc78132fc5286f4d691ae66cb25177f01c7219e844667
+  data.tar.gz: e08e9819a221659f94b9bbb54b41aa59a23ee1bc7fb2b8ca829e5a8039173325
 SHA512:
-  metadata.gz: 5e5bc2479a7b5b259113e76ca91d1578a180afa3b792c12608bdb03d0c23b28e5ddfd1aa3ee3ecf96b32700fd140ed84dcb6330b19da3fd908ea97fa14600f2d
-  data.tar.gz: 30e8ca1120a40557ffda8a51c531ee06c34807e3696ff424c056bf237819765b6f0171c115da9089234088e4a4ae9b32d366a67143149112a401c7862ea1bad0
+  metadata.gz: 0eb4508617a8198b6dd0cddfef087aabe63b65c4a8825bfe759caf379aa2a3adbb0b7705181363a937d2fa818b7d77458da4dcd244ba0da03ce2a0184d6df2cd
+  data.tar.gz: 22df3ed5def051f3a9fb372143a19e830276cd70a18756940ce1ec807b732273353788128c818fe5d3c303081b09d0904d9afd8bac281151e620d1a1e1ef4154

data/README.md

@@ -1,43 +1,153 @@
 # Purple::Client
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/purple/client`. To experiment with that code, run `bin/console` for an interactive prompt.
+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.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
+Add the gem to your project:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add purple-client
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or install it manually with:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install purple-client
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+Below are some basic examples of how to define requests and call them. Each
+snippet defines a custom class that inherits from `Purple::Client`.
+
+### Simple GET request
+
+```ruby
+class StatusClient < Purple::Client
+  domain 'https://api.example.com'
+
+  path :status do
+    response :ok do
+      body :default
+    end
+    root_method :status
+  end
+end
+
+# Performs GET https://api.example.com/status
+StatusClient.status
+```
+
+### Path with a dynamic parameter
+
+```ruby
+class JobsClient < Purple::Client
+  domain 'https://api.example.com'
+
+  path :jobs do
+    path :job_id, is_param: true do
+      response :ok do
+        body id: Integer, name: String
+      end
+      root_method :job
+    end
+  end
+end
+
+# Performs GET https://api.example.com/jobs/123
+JobsClient.job(123)
+```
+
+### Using authorization
+
+```ruby
+class ProfileClient < Purple::Client
+  domain 'https://api.example.com'
+  authorization :bearer, 'TOKEN'
+
+  path :profile do
+    response :ok do
+      body :default
+    end
+    root_method :profile
+  end
+end
+
+# Authorization header will be sent automatically
+ProfileClient.profile
+```
+
+### Nested paths
+
+```ruby
+class PostsClient < Purple::Client
+  domain 'https://api.example.com'
+
+  path :users do
+    path :user_id, is_param: true do
+      path :posts do
+        response :ok do
+          body [{ id: Integer, title: String }]
+        end
+        root_method :user_posts
+      end
+    end
+  end
+end
+
+# Performs GET https://api.example.com/users/7/posts
+PostsClient.user_posts(user_id: 7)
+```
+
+### Callbacks with additional arguments
+
+```ruby
+class EventsClient < Purple::Client
+  domain 'https://api.example.com'
+
+  additional_callback_arguments :resource
+
+  callback do |url, params, headers, response, resource|
+    StoreEvent.call(url:, params:, headers:, response:, resource:)
+  end
+
+  path :events do
+    response :ok do
+      body :default
+    end
+    root_method :events
+  end
+end
+
+resource = SomeModel.find(1)
+EventsClient.events(resource:)
+```
+
+`additional_callback_arguments` lets you specify parameter names that will be
+extracted from the call and passed to your callback. In the example above the
+`resource` keyword argument is removed from the request parameters, but is
+available inside the callback so you can associate the stored event with a
+record of your choice.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then run
+`rake spec` to execute the tests. You can also run `bin/console` for an interactive
+prompt to experiment with the library.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, then run
+`bundle exec rake release`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/purple-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/purple-client/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/[USERNAME]/purple-client. Contributors are expected to adhere
+to the [code of conduct](https://github.com/[USERNAME]/purple-client/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).
 
-Everyone interacting in the Purple::Client project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/purple-client/blob/main/CODE_OF_CONDUCT.md).

data/lib/purple/client.rb

@@ -43,8 +43,8 @@ module Purple
         end
       end
 
-      def path(name, method: :get)
-        path = Path.new(name:, parent: @parent_path, method:, client: self)
+      def path(name, method: :get, is_param: false)
+        path = Path.new(name:, parent: @parent_path, method:, client: self, is_param:)
 
         @paths ||= []
         @paths << path
@@ -62,10 +62,20 @@ module Purple
       def root_method(method_name)
         current_path = @parent_path
 
-        define_singleton_method method_name do |**args, &block|
-          params = current_path.request.params.call(**args) if current_path.request.params.is_a?(Proc)
+        define_singleton_method method_name do |*call_args, **kw_args, &block|
+          if current_path.is_param
+            value = kw_args[current_path.name] || call_args.first
+            current_path.with(value)
+            kw_args[current_path.name] = value
+          end
 
-          current_path.execute(params, args, &block)
+          callback_arguments = additional_callback_arguments.map do |arg|
+            kw_args.delete(arg)
+          end
+
+          params = current_path.request.params.call(**kw_args) if current_path.request.params.is_a?(Proc)
+
+          current_path.execute(params, kw_args, *callback_arguments, &block)
         end
       end
 
@@ -106,6 +116,14 @@ module Purple
           super
         end
       end
+
+      def additional_callback_arguments(*array)
+        if array.empty?
+          @additional_callback_arguments || []
+        else
+          @additional_callback_arguments = array
+        end
+      end
     end
   end
 end

data/lib/purple/path.rb

@@ -9,24 +9,44 @@ module Purple
     option :client
     option :name
     option :parent
+    option :is_param, default: -> { false }
     option :children, default: -> { [] }
     option :method, optional: true
     option :request, optional: true, default: -> { Purple::Request.new }
     option :responses, optional: true, default: -> { [] }
 
     def full_path
-      parent.nil? ? name : "#{parent.full_path}/#{name}"
+      current_path = is_param ? @param_value : name
+      parent.nil? ? current_path : "#{parent.full_path}/#{current_path}"
+    end
+
+    def with(*args)
+      @param_value = args.first
     end
 
     def method_missing(method_name, *args, &)
       if children.any? { |child| child.name == method_name }
-        children.find { |child| child.name == method_name }
+        child = children.find { |child| child.name == method_name }
+
+        if child.is_param
+          child.with(*args)
+        end
+
+        if child.children.any?
+          child
+        else
+          callback_arguments = additional_callback_arguments.map do |arg|
+            kw_args.delete(arg)
+          end
+
+          child.execute(*args, *callback_arguments)
+        end
       else
         super
       end
     end
 
-    def execute(params = {}, args = {})
+    def execute(params = {}, args = {}, *callback_arguments)
       headers = {
         'Accept' => 'application/json',
         'Content-Type' => 'application/json'
@@ -43,7 +63,12 @@ module Purple
         conn.headers = headers
       end
 
+      unless client.domain.start_with?('http')
+        raise ArgumentError, "Invalid URL: #{client.domain}. Ensure you have set protocol (http/https) in the client domain."
+      end
+
       url = "#{client.domain}/#{full_path}"
+
       response = case method
                  when :get
                    connection.get(url, params)
@@ -64,7 +89,7 @@ module Purple
                    {}
                  end
 
-        client.callback&.call(url, params, headers, JSON.parse(response.body))
+        client.callback&.call(url, params, headers, JSON.parse(response.body), *callback_arguments)
 
         if block_given?
           yield(resp_structure.status, object)

data/lib/purple/response.rb

@@ -16,7 +16,8 @@ class Purple::Response
     forbidden: 403,
     not_found: 404,
     too_many_requests: 429,
-    internal_server_error: 500
+    internal_server_error: 500,
+    gateway_timeout: 504,
   }.freeze
 
   def status_code

data/lib/purple/responses/body.rb

@@ -82,7 +82,12 @@ class Purple::Responses::Body
           check_structure!(item, value[0])
         end
       else
-        check_type!(object, key, value)
+        if object.nil?
+          raise BodyStructureMismatchError.new(key, value, nil, object),
+            "Expected a non-nil value for '#{key}' in response body. Expected response structure: #{substructure}"
+        else
+          check_type!(object, key, value)
+        end
       end
     end
   end

data/lib/purple/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: purple-client
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Pavel Kalashnikov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-18 00:00:00.000000000 Z
+date: 2025-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-initializer