prest 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aef2d0096f535fe7a735571b6d3a556aed2ec746e50378b13e2b4218a788dc29
-  data.tar.gz: 7ae1c9c4fcc036adcc7484453caeda0fd31e78c5318666a2b20a9ad516de2cbe
+  metadata.gz: abce07b88fce37bc8244e708a8b564499673c4de5391822387b5eb85219803a1
+  data.tar.gz: 5afd7519510296c17262f61bebe61731fbba16dbfee484a7cfbbbc2a97c92ab5
 SHA512:
-  metadata.gz: 5ed398def4e6713c62bcab45447ed7f466c517b6786e9bf3ea3f419cab97d8e48c5ca336e6e2b0995e4f4a6ace68476b3aa31d753d6fef061f630e6062b07a73
-  data.tar.gz: 7f748b2cf758c6d41bb8d907d631f31167970dd54a3b9b9751c73d98f56c960525ae10990e17ad391c5b3d24d0fb80435f18232d7c8e5cf668e6bdad80142826
+  metadata.gz: efaadb1850294c22ce5cc28693017ba5302b44ec1ee944f12612cb4b55672fd96d2ef97ff30fba56c0653e8bd179c863b53aee88370110958a72eab7b7d75fee
+  data.tar.gz: d6d1ce0b137b599c0a3964c2d13fdf8065ecd16446135402ebb1d30a65add4864a246bde27f9b1bbf5ca4af6d20af00169adb696d7094cb0049fa63bbe9df7e0

data/.ruby-version

@@ -0,0 +1 @@
+3.1.1

data/Gemfile.lock

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

data/README.md

@@ -54,21 +54,37 @@ Prest::Client.new('https://example.com/api', { headers: { 'Authorization' => 'Be
              .post(body: { username: 'juan-apa' })
 ```
 
+### 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:
+
+```ruby
+Prest::Client.new('https://example.com/api', { json: true })
+             .users
+             .get
+# Makes a GET https://example.com/api/users with headers Content-Type: application/json and Accept: application/json
+```
+
+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

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+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 get! post! put! patch! delete!].freeze
+
+    def initialize(base_uri, options = {})
+      @base_uri = base_uri
+      @options = options
+      @fragments = []
+      @query_params = {}
+    end
+
+    def method_missing(method, *args, **kwargs)
+      if SUPPORTED_HTTP_VERBS.include?(method)
+        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
+      end
+    end
+
+    def respond_to_missing?(_, _)
+      true
+    end
+
+    private
+
+    def execute_query(http_method, body: {})
+      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::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)
+
+      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
+
+    def chain_fragment(fragment_name, *args, **kwargs)
+      arguments = args.join('/')
+      parsed_args = arguments.empty? ? '' : "/#{arguments}"
+      @query_params.merge!(kwargs)
+      @fragments << "#{fragment_name.gsub("__", "-")}#{parsed_args}"
+    end
+
+    def headers
+      tmp_headers = @options[:headers] || {}
+      tmp_headers.merge!('Content-Type' => 'application/json', 'Accept' => 'application/json') if @options[:json]
+      tmp_headers
+    end
+
+    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 = stringified_params.empty? ? '' : "?#{stringified_params[0..-2]}"
+      "#{@base_uri}/#{path}#{stringified_params}"
+    end
+  end
+end

data/lib/prest/service.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Prest
+  # Base Service Object from which to extend to integrate with api's using the Prest gem.
+  class Service < BasicObject
+    def method_missing(method, *args, **kwargs)
+      client.__send__(method, *args, **kwargs)
+    end
+
+    def self.method_missing(method, *args, **kwargs)
+      new.__send__(:client).__send__(method, *args, **kwargs)
+    end
+
+    def self.respond_to_missing?(_, _)
+      true
+    end
+
+    def respond_to_missing?(_, _)
+      true
+    end
+
+    protected
+
+    def client
+      @client ||= ::Prest::Client.new(base_uri, options)
+    end
+
+    def base_uri
+      ::Kernel.raise(Error, 'Implement in subclass')
+    end
+
+    def options
+      {}
+    end
+  end
+end

data/lib/prest/version.rb

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

data/lib/prest.rb

@@ -1,111 +1,23 @@
 # frozen_string_literal: true
 
 require 'httparty'
+require_relative 'prest/client'
+require_relative 'prest/service'
 require_relative 'prest/version'
 require_relative 'prest/response'
 
 module Prest
   class Error < StandardError; end
 
-  # 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 get! post! put! patch! delete!].freeze
+  # Error for when a request is unsuccessful.
+  class RequestError < StandardError
+    attr_reader :status, :body, :headers
 
-    def initialize(base_uri, options = {})
-      @base_uri = base_uri
-      @options = options
-      @fragments = []
-      @query_params = {}
-    end
-
-    def method_missing(method, *args, **kwargs)
-      if SUPPORTED_HTTP_VERBS.include?(method)
-        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
-      end
-    end
-
-    def respond_to_missing?(_, _)
-      true
-    end
-
-    private
-
-    def execute_query(http_method, body: {})
-      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
-    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)
-      arguments = args.join('/')
-      parsed_args = arguments.empty? ? '' : "/#{arguments}"
-      @query_params.merge!(kwargs)
-      @fragments << "#{fragment_name.gsub("__", "-")}#{parsed_args}"
-    end
-
-    def headers
-      @options[:headers] || {}
-    end
-
-    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 = stringified_params.empty? ? '' : "?#{stringified_params[0..-2]}"
-      "#{@base_uri}/#{path}#{stringified_params}"
-    end
-  end
-
-  # Base Service Object from which to extend to integrate with api's using the Prest gem.
-  class Service < BasicObject
-    def method_missing(method, *args, **kwargs)
-      client.__send__(method, *args, **kwargs)
-    end
-
-    def self.method_missing(method, *args, **kwargs)
-      new.__send__(:client).__send__(method, *args, **kwargs)
-    end
-
-    def self.respond_to_missing?(_, _)
-      true
-    end
-
-    def respond_to_missing?(_, _)
-      true
-    end
-
-    protected
-
-    def client
-      @client ||= ::Prest::Client.new(base_uri, options)
-    end
-
-    def base_uri
-      ::Kernel.raise(Error, 'Implement in subclass')
-    end
-
-    def options
-      {}
+    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.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Juan Aparicio
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-10 00:00:00.000000000 Z
+date: 2022-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -33,6 +33,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -41,7 +42,9 @@ files:
 - README.md
 - Rakefile
 - lib/prest.rb
+- lib/prest/client.rb
 - lib/prest/response.rb
+- lib/prest/service.rb
 - lib/prest/version.rb
 - prest.gemspec
 homepage: https://gogrow.dev