prest 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70f03f1a6b0308bf6289c7b7c1158c17622999fd54fe788cf7f5c970d8100ed4
-  data.tar.gz: dabc32ac8bbaf16b4a44519cfa6206ee93121a5c9c666dd6e760b4bd720cf06b
+  metadata.gz: 64b97c654e18ed1cd49daaa3923f1dc3eb227216311e051977db5e5cdffa0999
+  data.tar.gz: f8e546e1f5feacdd22a8cea434840957d455d61ca70bf80ef627a3ecda2e08e6
 SHA512:
-  metadata.gz: 61695f52e98eb93f4c9a321771ca0061ba203640a1bdf971c390767d78b08a0e2f11e3ad734213d04778bf2ae303427e183d1e957be6d4864927a92906c97390
-  data.tar.gz: 8121063ee97d2cfad9a68e68ae16b8ad12248423cd17286feae94c826fd6e6f05e2edfd88a3890c4bfecf7f2eafdf55ae3189dac2d1e097886253877096d96ed
+  metadata.gz: f6c29682362e53853dc48d4f5b26bce57a2b33814b91418aa15afec036a942f31cdb8c58628cc21da64488d46d3d9c28793578c2efb7cc62472524c413cd3453
+  data.tar.gz: 1be14eb778ccb8c8f9218abe9db5c29089234b290154a98c167359bad911de9a130775a669239b48edd6695b5eb75a8c7c1c5602b6a5089cbda9183b4eab5496

data/CHANGELOG.md

@@ -6,4 +6,12 @@
 
 ## [0.1.1] - 2022-07-22
 
-- Wraps endpoints response in a `Prest::Response` object for easier access to the response data 
+- Wraps endpoints response in a `Prest::Response` object for easier access to the response data
+
+## [0.1.2] - 2022-08-05
+
+- Change how urls are built. Underscore in the fragment building stays as an underscore. Dashes are made with `__`
+
+## [0.1.3] - 2022-08-05
+
+- Add `Prest::Service` object for easier rails integration with service-object pattern

data/Gemfile.lock

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

data/README.md

@@ -54,6 +54,24 @@ Prest::Client.new('https://example.com/api', { headers: { 'Authorization' => 'Be
              .post(body: { username: 'juan-apa' })
 ```
 
+### 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!` ).
+
+```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.
+
+  begin
+    Prest::Client.new('https://example.com/api', { headers: { 'Authorization' => 'Bearer Token xxxyyyzzz' } })
+              .users
+              .get!
+  rescue Prest::Error => e
+    puts e.message # "{ error: \"Invalid auth credentials\" }"
+  end
+```
+
 ### Accessing the response
 
 ```ruby

data/lib/prest/version.rb

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

data/lib/prest.rb

@@ -10,7 +10,7 @@ module Prest
   # Main wrapper class for Prest. To use the gem, call:
   # Prest::Client.new('https://base_uri.com', { headers: { 'Authorization' => 'Bearer token' }})
   class Client < BasicObject
-    SUPPORTED_HTTP_VERBS = %i[get post put patch delete].freeze
+    SUPPORTED_HTTP_VERBS = %i[get post put patch delete get! post! put! patch! delete!].freeze
 
     def initialize(base_uri, options = {})
       @base_uri = base_uri
@@ -21,7 +21,11 @@ module Prest
 
     def method_missing(method, *args, **kwargs)
       if SUPPORTED_HTTP_VERBS.include?(method)
-        execute_query(method, **kwargs)
+        if method.to_s.end_with?('!')
+          execute_query!(method[0..-2], **kwargs)
+        else
+          execute_query(method, **kwargs)
+        end
       else
         chain_fragment(method.to_s, *args, **kwargs)
         self
@@ -38,7 +42,14 @@ 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
-      raise Error, e.message
+      ::Kernel.raise ::Prest::Error, e.message
+    end
+
+    def execute_query!(*args, **kwargs)
+      res = execute_query(*args, **kwargs)
+      ::Kernel.raise ::Prest::Error, res.body.to_json unless res.successful?
+
+      res
     end
 
     def chain_fragment(fragment_name, *args, **kwargs)

metadata

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