upfluence-utils 0.12.7 → 0.12.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cc751a8c15d5d50d5a4e6233925f5842b6b5253f99f88794e9ce5764f3b0fd6
-  data.tar.gz: c8da722fb01f9d4ceebb537fd8b94e3abbde514d4c8d9a71a71659ebc9b4e2bb
+  metadata.gz: 803a89e0f85660a1e560a132ca48f0fc8c6456224127589ce64fde865fea5256
+  data.tar.gz: 648ec627139b9b2784535204420b0f96eedfdc09d0b0e2946d5750245d230088
 SHA512:
-  metadata.gz: 56eca8dbd6e79313f6901e0381d804556a138485b13dbcedf0724fa72d418417eb225929c42621b4279dffa281605aa37212913d84e49f71de4c3b6a5f3d5407
-  data.tar.gz: b3fc2813b90ba677a41078ccb7b3f940e0d2fe20470679eec30b5340423348a4481a7433d4677e26b5d41fa356e092c8170feb9601e9628121e0998dc22cdb0e
+  metadata.gz: b4597f0914e84b9dc20cb33e13fed94915e1d869fed622fbd131a0c30bbc9ec93de579fd31cfe376ed13a9426b458823acc242256801449e49f11d53c099703e
+  data.tar.gz: 0b31ac7d2ada93d55b5507be794065a0649d181061f0d252bac2a37da199b3c67d04f2fe33f80b59153b43aa816930e79c1c0ccd63ab689fa5230bd0f1476dfa

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in rbutils.gemspec
+# Specify your gem's dependencies in upfluence_utils.gemspec
 gemspec

data/README.md

@@ -1 +1,98 @@
-# Rbutils
+# Upfluence_Utils
+
+# Description
+
+Upfluence-utils is an utility box for ruby ​​projects. Some important abstractions are:
+
+- Sentry error logger
+
+- Base Api Endpoint
+
+- Middlewares
+
+- Mixins
+
+## Usage
+
+Add in your gemfile the `gem 'upfluence-utils'` and run `bundle install`
+
+### Sentry error logger
+
+Upfluence-utils provides the tool to notify sentry when a ruby error is raised.
+
+It is based on the 'sentry-ruby' sdk, you can check the [documentation](https://docs.sentry.io/platforms/ruby/)..
+
+Upfluence-utils also already provides the [basic configuration](https://docs.sentry.io/platforms/ruby/configuration/options/?original_referrer=https%3A%2F%2Fwww.google.com%2F) [here](https://github.com/upfluence/upfluence_utils/blob/fd9bb88960f7dbe04dc43180489207d2739cb0ff/lib/upfluence/error_logger/sentry.rb#L17) so it works like 'plug and play' and you just have to be aware of the environment variables.
+
+### Base ApiEndpoint
+
+The class APIEndpoint can be inherited from your new endpoint mapped class in you ruby project, so you can take advantage of some resources, like:
+
+- Healthcheck endpoint
+- Access token validation
+- Request body and serialize json_params
+- `respond_with` to easily serialize a body response
+- Base errors
+
+You can inherit like:
+```ruby
+class YourClassEndpoint < Upfluence::Endpoint::ApiEndpoint
+end
+```
+
+### Middlewares
+
+Provide some utils for http requests, such as:
+
+- Headers builder
+- Cors
+- Prometheus logger
+- Base Exceptions
+
+### Mixins
+
+Based on the concept of [mixins](https://en.wikipedia.org/wiki/Mixin#:~:text=at%20the%20time.-,Definition,mixed%20in%20with%20other%20classes.), these classes provide some good tools, like:
+
+- Pagination
+- StrongParameters (class to validate params received/sent on endpoint)
+
+you can use mixins from upfluence-utils like:
+
+```ruby
+    class YourClassEndpoint < AuthorizedEndpoint
+      include Upfluence::Mixin::Pagination
+      include Upfluence::Mixin::StrongParameters
+    end
+```
+
+#### Pagination
+
+For pagination, you can be inspired on this example:
+
+```http
+[GET] /my_entity/?per_page=1&page=1
+```
+
+```ruby
+get '/' do
+  respond_with_pagination(
+    payload:         my_entity_paginated, # this should return the paginated model, you can use active record methods to do that
+    each_serializer: MyEntity::MyEntitySerializer, # serializer related to the model
+    except:          %i[field], # some entity related you want to ignore on serialization
+    root:            'my_entity'
+  )
+end
+```
+
+#### StrongParams
+
+For StrongParams mixin, you can be inspired like this example how to permit only some specific fields on POST request:
+
+```ruby
+def create_params
+  json_params.require(:my_entity).permit(
+    :entity_name,
+    :entity_number
+  )
+end
+```

data/lib/upfluence/error_logger/null.rb

@@ -9,17 +9,19 @@ module Upfluence
         def call(env)
           @app.call(env)
         rescue => e
-          Upfluence.logger.error("Error: #{e.class}: #{e.message}")
-          e.backtrace.each do |b|
-            Upfluence.logger.error("\t#{b}")
-          end
+          notify(error)
 
           raise e
         end
       end
 
       def notify(error, *_args)
-        Upfluence.logger.error(error.inspect)
+        Upfluence.logger.error("Error: #{error.class}: #{error.message}")
+        Upfluence.logger.error("Inspect: #{error.inspect}")
+
+        error.backtrace.each do |b|
+          Upfluence.logger.error("\t#{b}")
+        end
       end
 
       def ignore_exception(*_kls); end

data/lib/upfluence/utils/version.rb

@@ -1,5 +1,5 @@
 module Upfluence
   module Utils
-    VERSION = '0.12.7'.freeze
+    VERSION = '0.12.8'.freeze
   end
 end

data/{rbutils.gemspec → upfluence_utils.gemspec}

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['dev@upfluence.com']
 
   spec.summary       = 'Upfluence common utils for Ruby projects'
-  spec.homepage      = 'https://github.com/upfluence/rbutils'
+  spec.homepage      = 'https://github.com/upfluence/upfluence_utils'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: upfluence-utils
 version: !ruby/object:Gem::Version
-  version: 0.12.7
+  version: 0.12.8
 platform: ruby
 authors:
 - Upfluence
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-02 00:00:00.000000000 Z
+date: 2024-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -303,8 +303,8 @@ files:
 - lib/upfluence/utils/thrift/middleware/request_logger.rb
 - lib/upfluence/utils/thrift/middleware/timeout.rb
 - lib/upfluence/utils/version.rb
-- rbutils.gemspec
-homepage: https://github.com/upfluence/rbutils
+- upfluence_utils.gemspec
+homepage: https://github.com/upfluence/upfluence_utils
 licenses:
 - MIT
 metadata: {}