prest 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8a009d1db76e802ed1e416845134d08d466f21b26c90aea89929a8efbf875ea
-  data.tar.gz: b5a860ff089a4b2652fce692e0d9b441333384b6545cca661cf8f143bef67ff8
+  metadata.gz: aef2d0096f535fe7a735571b6d3a556aed2ec746e50378b13e2b4218a788dc29
+  data.tar.gz: 7ae1c9c4fcc036adcc7484453caeda0fd31e78c5318666a2b20a9ad516de2cbe
 SHA512:
-  metadata.gz: d1522ea4ef50f8c66e5c21510f87e23a4a5fa1191f2cc5b585c12de698dcd6f1889b427119773fdd8e5af4d55cd412890b1b94e1c3194f093232ec2c8238242b
-  data.tar.gz: a0922e5d6b4577481cee58bcc0ea37a26c5ad5710499709d49b1af2371b9966dcb1e8135dc06f4fb43a764d2c94703a9f5aefb4a5024d7c7c28c2dd708e6141e
+  metadata.gz: 5ed398def4e6713c62bcab45447ed7f466c517b6786e9bf3ea3f419cab97d8e48c5ca336e6e2b0995e4f4a6ace68476b3aa31d753d6fef061f630e6062b07a73
+  data.tar.gz: 7f748b2cf758c6d41bb8d907d631f31167970dd54a3b9b9751c73d98f56c960525ae10990e17ad391c5b3d24d0fb80435f18232d7c8e5cf668e6bdad80142826

data/.rubocop.yml

@@ -1,10 +1,11 @@
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 2.7.0
   NewCops: disable
 
 Metrics/BlockLength:
   Exclude:
     - "spec/**/*"
+
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: single_quotes

data/CHANGELOG.md

@@ -3,3 +3,15 @@
 ## [0.1.0] - 2022-07-20
 
 - Initial release
+
+## [0.1.1] - 2022-07-22
+
+- 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

@@ -7,4 +7,5 @@ gemspec
 
 gem 'rake', '~> 13.0'
 gem 'rspec', '~> 3.0'
-gem 'rubocop', '~> 1.21'
+gem 'rubocop', '~> 1.21', require: false
+gem 'simplecov', '~> 0.21.2', require: false, group: :test

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prest (0.1.0)
+    prest (0.1.5)
       httparty (~> 0.20.0)
 
 GEM
@@ -9,6 +9,7 @@ GEM
   specs:
     ast (2.4.2)
     diff-lcs (1.5.0)
+    docile (1.4.0)
     httparty (0.20.0)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
@@ -50,6 +51,12 @@ GEM
     rubocop-ast (1.19.1)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
     unicode-display_width (2.2.0)
 
 PLATFORMS
@@ -61,6 +68,7 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)
+  simplecov (~> 0.21.2)
 
 BUNDLED WITH
    2.3.7

data/README.md

@@ -1,6 +1,11 @@
 # Prest
 
-Programmaticcally communicate with any REST API.
+[![Gem Version](https://badge.fury.io/rb/prest.svg)](https://badge.fury.io/rb/prest)
+[![Ruby](https://github.com/gogrow-dev/prest/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/gogrow-dev/prest/actions/workflows/main.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/f81b2e00be4d8eaa5e81/maintainability)](https://codeclimate.com/github/gogrow-dev/prest/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/f81b2e00be4d8eaa5e81/test_coverage)](https://codeclimate.com/github/gogrow-dev/prest/test_coverage)
+
+Programmatically communicate with any REST API.
 
 ## Installation
 
@@ -34,6 +39,10 @@ Prest::Client.new('https://example.com/api').users(name: 'Juan', created_at: '20
 Prest::Client.new('https://example.com/api').users(2).pulls(1).comments.get
 # This translates to making a GET https://example.com/api/users/2/pulls/1/comments
 
+# To make requests to url which have a dash in it, use a double __
+Prest::Client.new('https://example.com/api').job__posts(1).get
+# This translates to making a GET https://example.com/api/job-posts/1
+
 # To pass headers to the request, pass them to the client constructor
 Prest::Client.new('https://example.com/api', { headers: { 'Authorization' => 'Bearer Token xxxyyyzzz' } })
              .users
@@ -45,29 +54,92 @@ 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
+response = Prest::Client.new('https://example.com/api').users.get
+
+response[:users] # is equivalent to response.body[:users]
+# You can access the body directly from the response object
+
+response.successful? # is equivalent to response.status is between 200-299
+
+response.status # returns the status code of the response
+response.headers # returns the headers of the response
+response.body # returns the body of the response
+```
+
 ### Rails service-like approach
 
 ```ruby
 # app/services/github.rb
-class Github
-  BASE_URL = 'https://api.github.com'
+class Github < Prest::Service
+  private
 
-  def new
-    Prest::Client.new(BASE_URL, { headers: headers })
+  def base_uri
+    'https://api.github.com'
+  end
+
+  def options
+    {
+      headers: {
+        'access_token' => 'xxxyyyzzz'
+      }
+    }
+  end
+end
+
+# Then, you can use it like this anywhere in your app:
+
+Github.users('juan-apa').pulls.get
+```
+
+You can also define an initializer to pass values in runtime to your service:
+
+```ruby
+# app/services/github.rb
+class Github < Prest::Service
+  def initialize(organization)
+    @organization = organization
   end
 
   private
 
-  def headers
+  def base_uri
+    'https://api.github.com'
+  end
+
+  def options
     {
-      'access_token' => 'xxxyyyzzz'
+      headers: {
+        'access_token' => 'xxxyyyzzz',
+        'org' => @organization
+      }
     }
   end
 end
 
 # Then, you can use it like this anywhere in your app:
 
-Github.new.users('juan-apa').pulls.get
+Github.new('gogrow-dev').users.get
 ```
 
 ## Development

data/lib/prest/response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Prest
+  # Main wrapper class for Prest Response.
+  class Response
+    extend ::Forwardable
+
+    def_delegator :@body, :[]
+
+    attr_reader :status, :body, :headers
+
+    def initialize(status, body, headers)
+      @status = status
+      @body = body
+      @headers = headers
+    end
+
+    def successful?
+      @status.between?(100, 399)
+    end
+  end
+end

data/lib/prest/version.rb

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

data/lib/prest.rb

@@ -2,6 +2,7 @@
 
 require 'httparty'
 require_relative 'prest/version'
+require_relative 'prest/response'
 
 module Prest
   class Error < StandardError; end
@@ -9,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
@@ -20,28 +21,42 @@ 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
       end
     end
 
-    def respond_to_missing?(_)
+    def respond_to_missing?(_, _)
       true
     end
 
     private
 
     def execute_query(http_method, body: {})
-      ::HTTParty.send(http_method, build_url, headers: headers, body: 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}/"
+      parsed_args = arguments.empty? ? '' : "/#{arguments}"
       @query_params.merge!(kwargs)
-      @fragments << "#{fragment_name.tr("_", "-")}/#{parsed_args}"
+      @fragments << "#{fragment_name.gsub("__", "-")}#{parsed_args}"
     end
 
     def headers
@@ -60,4 +75,37 @@ module Prest
       "#{@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.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Juan Aparicio
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-20 00:00:00.000000000 Z
+date: 2022-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -41,6 +41,7 @@ files:
 - README.md
 - Rakefile
 - lib/prest.rb
+- lib/prest/response.rb
 - lib/prest/version.rb
 - prest.gemspec
 homepage: https://gogrow.dev