prest 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: baed86642c0c37f151d41d58a12e0bf73cc8be4441e42082dec217cbb921d957
-  data.tar.gz: a506ed62ea0a49d24e5a10c2945b56a7e298114df36730d99f3fb3e3fb48d299
+  metadata.gz: accb2149cb0dacc0ad3fee732fb7bff9fb552d1bbea197118b29525fed9e24fe
+  data.tar.gz: b6cf166232aca1d97372acc0efdb8b8e952d4025159a638d55f779ea608e2276
 SHA512:
-  metadata.gz: 3ad4dd9cd51bae9cc9626acc59fd1e114e4a666f367914b16af3135797842cf9f890a801fcc6f2509f01751c20368f15a139c53c49ab2f38b8840851146f30a0
-  data.tar.gz: 3cad6750ed114c2e4abe01ca74ec5dc708f1ed298eab7694597dfd5f7fe2e19fae35667f5c3660059b42b438b0bc39257e5e1d4a3c8abbd0bc45c56abf66ba96
+  metadata.gz: a313c848c5bd26fd4210cdccfc0e6f79f07927dc59cca7417966ccac53c518b61f0d80c403cc6371c99c9453e21f8b08d1696af2774bbaba91945a7826c6ce48
+  data.tar.gz: 16364768bf1190a5bb884c44379873ef37841ae610d9d832b7fdc9742a13ca79601fd9442513342c8ceca4a92bfa1df27a61409488f3c6cdfe16a683a2815279

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prest (0.1.6)
+    prest (0.1.8)
       httparty (~> 0.20.0)
 
 GEM

data/README.md

@@ -54,6 +54,48 @@ Prest::Client.new('https://example.com/api', { headers: { 'Authorization' => 'Be
              .post(body: { username: 'juan-apa' })
 ```
 
+### Using raw/custom/special query parameters
+
+In ruby, duplicate keyword arguments on method calls are not accepted, so you **can not** do the following:
+
+```ruby
+Prest::Client.new('https://example.com/api').example(key: 1, key: 2).get
+# `key: 1` is overriden by `key: 2`;
+# produces: GET https://example.com/api/one/two?key=2
+```
+
+Because of this and other cases where formatting is very strict/unusual, you can pass a string which will not be formatted to the query parameters. To do this, use the following:
+
+```ruby
+# GET https://example.com/api/example?key=1&key2&other=value
+Prest::Client.new('https://example.com/api')
+             .example(__query_params: 'key=1&key=2', other: 'value')
+             .get
+```
+
+The string passed to the keyword argument `__query_params` will not be formatted, and passed as is.
+
+> **Warning**
+> `__query_params` is the only keyword argument that can be repeated across method calls:
+
+```ruby
+Prest::Client.new('https://example.com/api')
+             .one(key: '1')
+             .two(key: '2')
+             .get
+# Produces: GET https://example.com/api/one/two?key=2
+```
+
+However using `__query_params`:
+
+```ruby
+Prest::Client.new('https://example.com/api')
+             .one(__query_params: 'key=1')
+             .two(__query_params: 'key=2')
+             .get
+#Produces: GET https://example.com/api/one/two?key=1&key=2
+```
+
 ### Automatically adding the json headers
 
 Because some API's need a `Content-Type: application/json` and/or `Accept: application/json` headers, there's a built in option that can be passed to the client to add those for you:
@@ -70,18 +112,21 @@ Note: The option will merge any other header you pass to the initializer.
 ### Raising exceptions on failed HTTP requests
 
 An HTTP request is considered as failed when the status code is not between `100` and `299`.
-To automatically raise a `Prest::Error` when the HTTP request is not successful, use the bang methods (`get!`, `post!`, `put!`, `patch!` and `delete!`).
+To automatically raise a `Prest::RequestError` when the HTTP request is not successful, use the bang methods (`get!`, `post!`, `put!`, `patch!` and `delete!`).
 
 ```ruby
   # If for example the authorization headers are invalid, it will return an 401 status code.
-  # This call will raise a ::Prest::Error with the response as a json in the message.
+  # This call will raise a ::Prest::RequestError with the response as a json in the message.
 
   begin
     Prest::Client.new('https://example.com/api', { headers: { 'Authorization' => 'Bearer Token xxxyyyzzz' } })
               .users
               .get!
-  rescue Prest::Error => e
+  rescue Prest::RequestError => e
     puts e.message # "{ error: \"Invalid auth credentials\" }"
+    puts e.status # 403
+    puts e.body # "{ error: \"Invalid auth credentials\" }"
+    puts e.headers # { 'ContentType' => 'application/json' }
   end
 ```
 

data/lib/prest/client.rb

@@ -36,12 +36,19 @@ module Prest
       res = ::HTTParty.send(http_method, build_url, headers: headers, body: body)
       ::Prest::Response.new(res.code, res.parsed_response, res.headers)
     rescue ::HTTParty::ResponseError => e
-      ::Kernel.raise ::Prest::Error, e.message
+      ::Kernel.raise(::Prest::RequestError.new(status: res.status,
+                                               body: res.parsed_response,
+                                               headers: res.headers), e.message)
     end
 
     def execute_query!(*args, **kwargs)
       res = execute_query(*args, **kwargs)
-      ::Kernel.raise ::Prest::Error, res.body.to_json unless res.successful?
+
+      unless res.successful?
+        ::Kernel.raise(::Prest::RequestError.new(status: res.status,
+                                                 body: res.body.to_json,
+                                                 headers: res.headers), res.body.to_json)
+      end
 
       res
     end
@@ -49,7 +56,10 @@ module Prest
     def chain_fragment(fragment_name, *args, **kwargs)
       arguments = args.join('/')
       parsed_args = arguments.empty? ? '' : "/#{arguments}"
-      @query_params.merge!(kwargs)
+      extract_raw_query_params!(kwargs)
+      dup_kwargs = kwargs.dup
+      dup_kwargs.delete(:__query_params)
+      @query_params.merge!(dup_kwargs)
       @fragments << "#{fragment_name.gsub("__", "-")}#{parsed_args}"
     end
 
@@ -62,13 +72,26 @@ module Prest
     def build_url
       path = @fragments.join('/')
 
-      stringified_params = ''
-      @query_params.to_a.each do |key_val|
-        stringified_params += "#{key_val[0]}=#{key_val[1]}&"
-      end
+      stringified_params = @query_params.to_a.map do |key_val|
+        key_val[0] == :__query_params ? key_val[1].join('&') : "#{key_val[0]}=#{key_val[1]}"
+      end.join('&')
 
-      stringified_params = stringified_params.empty? ? '' : "?#{stringified_params[0..-2]}"
+      stringified_params = stringified_params.empty? ? '' : "?#{stringified_params}"
       "#{@base_uri}/#{path}#{stringified_params}"
     end
+
+    def array_wrap(obj)
+      obj.is_a?(::Array) ? obj : [obj]
+    end
+
+    def extract_raw_query_params!(kwargs)
+      return unless kwargs.key?(:__query_params)
+
+      @query_params[:__query_params] = if @query_params[:__query_params].is_a?(::Array)
+                                         @query_params[:__query_params] + array_wrap(kwargs[:__query_params])
+                                       else
+                                         array_wrap(kwargs[:__query_params])
+                                       end
+    end
   end
 end

data/lib/prest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Prest
-  VERSION = '0.1.6'
+  VERSION = '0.1.8'
 end

data/lib/prest.rb

@@ -8,4 +8,16 @@ require_relative 'prest/response'
 
 module Prest
   class Error < StandardError; end
+
+  # Error for when a request is unsuccessful.
+  class RequestError < StandardError
+    attr_reader :status, :body, :headers
+
+    def initialize(status:, body: '', headers: {})
+      super()
+      @status = status
+      @body = body
+      @headers = headers
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prest
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors:
 - Juan Aparicio
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-02 00:00:00.000000000 Z
+date: 2023-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty