prest 0.1.3 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70f03f1a6b0308bf6289c7b7c1158c17622999fd54fe788cf7f5c970d8100ed4
-  data.tar.gz: dabc32ac8bbaf16b4a44519cfa6206ee93121a5c9c666dd6e760b4bd720cf06b
+  metadata.gz: baed86642c0c37f151d41d58a12e0bf73cc8be4441e42082dec217cbb921d957
+  data.tar.gz: a506ed62ea0a49d24e5a10c2945b56a7e298114df36730d99f3fb3e3fb48d299
 SHA512:
-  metadata.gz: 61695f52e98eb93f4c9a321771ca0061ba203640a1bdf971c390767d78b08a0e2f11e3ad734213d04778bf2ae303427e183d1e957be6d4864927a92906c97390
-  data.tar.gz: 8121063ee97d2cfad9a68e68ae16b8ad12248423cd17286feae94c826fd6e6f05e2edfd88a3890c4bfecf7f2eafdf55ae3189dac2d1e097886253877096d96ed
+  metadata.gz: 3ad4dd9cd51bae9cc9626acc59fd1e114e4a666f367914b16af3135797842cf9f890a801fcc6f2509f01751c20368f15a139c53c49ab2f38b8840851146f30a0
+  data.tar.gz: 3cad6750ed114c2e4abe01ca74ec5dc708f1ed298eab7694597dfd5f7fe2e19fae35667f5c3660059b42b438b0bc39257e5e1d4a3c8abbd0bc45c56abf66ba96

data/.ruby-version

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

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.6)
       httparty (~> 0.20.0)
 
 GEM

data/README.md

@@ -54,6 +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!`).
+
+```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/client.rb

@@ -0,0 +1,74 @@
+# 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::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
+      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.3'
+  VERSION = '0.1.6'
 end

data/lib/prest.rb

@@ -1,100 +1,11 @@
 # 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].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)
-        execute_query(method, **kwargs)
-      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
-      raise Error, e.message
-    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
-      {}
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prest
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.6
 platform: ruby
 authors:
 - Juan Aparicio
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-05 00:00:00.000000000 Z
+date: 2022-09-02 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