prest 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abce07b88fce37bc8244e708a8b564499673c4de5391822387b5eb85219803a1
-  data.tar.gz: 5afd7519510296c17262f61bebe61731fbba16dbfee484a7cfbbbc2a97c92ab5
+  metadata.gz: accb2149cb0dacc0ad3fee732fb7bff9fb552d1bbea197118b29525fed9e24fe
+  data.tar.gz: b6cf166232aca1d97372acc0efdb8b8e952d4025159a638d55f779ea608e2276
 SHA512:
-  metadata.gz: efaadb1850294c22ce5cc28693017ba5302b44ec1ee944f12612cb4b55672fd96d2ef97ff30fba56c0653e8bd179c863b53aee88370110958a72eab7b7d75fee
-  data.tar.gz: d6d1ce0b137b599c0a3964c2d13fdf8065ecd16446135402ebb1d30a65add4864a246bde27f9b1bbf5ca4af6d20af00169adb696d7094cb0049fa63bbe9df7e0
+  metadata.gz: a313c848c5bd26fd4210cdccfc0e6f79f07927dc59cca7417966ccac53c518b61f0d80c403cc6371c99c9453e21f8b08d1696af2774bbaba91945a7826c6ce48
+  data.tar.gz: 16364768bf1190a5bb884c44379873ef37841ae610d9d832b7fdc9742a13ca79601fd9442513342c8ceca4a92bfa1df27a61409488f3c6cdfe16a683a2815279

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prest (0.1.7)
+    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:

data/lib/prest/client.rb

@@ -56,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
 
@@ -69,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.7'
+  VERSION = '0.1.8'
 end

metadata

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