httpigeon 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9a75a860ebdb91a4efcfe5d69f7e7a04da7b6f1762b2a67fb1d9ec5aefe2cab
-  data.tar.gz: 47f3ac2004f2d716888b36febc71e411ae5afdc8d62bc1a47b536c8fa100a1e8
+  metadata.gz: 500fac14ff3591858c0547ea049891de72ffa58747e76ddb1f5faf3cd2a12ba8
+  data.tar.gz: 2f6bce6c474bed8bd6cf9168b8f4271a7d4483145d89a5674a72ce6f83c88ac6
 SHA512:
-  metadata.gz: e8f8f90f1aa68d59f67e4c3fe51932450755c291092ba7e9baa0e8f17502d09c7adc6186c9f1c229a5b54470192dd6b0c0e4d8e4e6c69dc1dab4d051b923dfbc
-  data.tar.gz: dfd927e24af3dfc5c08d9c7e6a7a9767e5f9207b87286143b580c33f36525f24f87a9656dc133b84807f84001f9381ab380ed4dc6286444b40c1ab5f664ff59d
+  metadata.gz: 114d33029253f8ebd4a9dac5e8815f59b1d8a369ab9be4e971d1711da8df4f24618885876902138bd4d7c4888dd89a7d108da8c82296a8d1c996071c5444141f
+  data.tar.gz: fe8312258406cd6f78a162ce3f5f704afcb4091526083802a1bb724b759d5481ff859f885099ecbaacae888df72378e24c7cebb7c1c79704c4ba141b2a92aba8

data/.github/workflows/release-please.yaml

@@ -1,5 +1,8 @@
 name: release-please
-on: [pull_request]
+on:
+  push:
+    branches:
+      - main
 
 jobs:
   release-please:
@@ -19,8 +22,8 @@ jobs:
   publish-gem:
     uses: ./.github/workflows/publish.yaml
     needs: [ release-please ]
-    # if: needs.release-please.outputs.release_created
+    if: needs.release-please.outputs.release_created
     with:
       public_publish: 'true'
-      private_publish: 'false'
+      private_publish: 'true'
     secrets: inherit # implicitly forward secrets to called workflow

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [2.1.0](https://github.com/dailypay/httpigeon/compare/v2.0.1...v2.1.0) (2024-01-05)
+
+
+### Features
+
+* **response:** [NO-TICKET] parsed_response tests and json support ([#31](https://github.com/dailypay/httpigeon/issues/31)) ([e169215](https://github.com/dailypay/httpigeon/commit/e169215e1394927cb9137e1691196aa535ffd25d))
+
+## [2.0.1](https://github.com/dailypay/httpigeon/compare/v2.0.0...v2.0.1) (2023-12-21)
+
+
+### Bug Fixes
+
+* **request:** Handle edge cases in response parsing ([#29](https://github.com/dailypay/httpigeon/issues/29)) ([7818562](https://github.com/dailypay/httpigeon/commit/7818562736b5c5258b77357c73f24926e46eb458))
+
 ## [2.0.0](https://github.com/dailypay/httpigeon/compare/v1.3.0...v2.0.0) (2023-10-25)
 
 

data/README.md

@@ -1,4 +1,4 @@
-# HTTPigeon
+# HTTPigeon [![Gem Version](https://badge.fury.io/rb/httpigeon.svg)](https://badge.fury.io/rb/httpigeon)
 
 As early as 2000 years ago, and as late as 20 years ago, messenger pigeons (a.k.a homing pigeons) were an established and reliable means of long distance communication. This library is dedicated to messenger pigeons and all their contributions towards ancient and modern civilization ❤️.
 
@@ -21,12 +21,18 @@ end
 ```
 
 **Instantiating with a block:**
+
+- **NOTE:** This pretty much works the same way as passing a block to `Faraday.new`. Any config you can use with `Faraday` directly, you can do with `HTTPigeon::Request`
+
 ```ruby
+require "faraday/retry"
+
 # @option [String] base_url the base URI (required)
-request = HTTPigeon::Request.new(base_url: 'https://dummyjson.com') do |connection|
-  # connection is an instance of Faraday::Connection
-  connection.headers['foo'] = 'barzzz'
-  connection.options['timeout'] = 15
+request = HTTPigeon::Request.new(base_url: 'https://dummyjson.com') do |config|
+  # config is an instance of Faraday::Connection
+  config.headers['foo'] = 'barzzz'
+  config.options['timeout'] = 15
+  config.request :retry, { max: 5 }
   ...
 end
 
@@ -46,7 +52,7 @@ request.run(path: '/users/1')
 # @param event_type [String] for filtering/scoping the logs (default: 'http.outbound')
 # @param log_filters [Array<Symbol, String>] specifies keys in URL, headers and body to be redacted before logging.
 #    Can define keys for both Hash and String payloads (default: [])
-request = HTTPigeon::Request.new(base_url: 'https://dummyjson.com', headers: { Accept: 'application/json' }, log_filters: [:api_key, 'access_token', '(client_id=)(\w+)'])
+request = HTTPigeon::Request.new(base_url: 'https://dummyjson.com', headers: { Accept: 'application/json' }, log_filters: [:api_key, 'access_token', '/(client_id=)(\w+)/'])
 request.run(path: '/users/1')
 ```
 
@@ -120,9 +126,9 @@ Examples assume you set `:redactor_string` in your initializer to `[REDACTED]`
 | `"email"` OR `:email` | Hash | `{ "email": "atuny0@sohu.com" }` | `{ "email": "atu...[REDACTED]" }` | Filters will get applied to nested objects as well. There's no limit on depth |
 | `"email::[REDACTED]"` | Hash | `{ "email": "atuny0@sohu.com" }` | `{ "email": "[REDACTED]" }` | Replacement can be whatever you want and is applied as-is |
 | `"/email/"` | Hash | `{ "email": "atuny0@sohu.com" }` | `{ "email": "atuny0@sohu.com" }` | Regex filters will not get applied to hash keys. This is a design decision to prevent bugs |
-| `"/(email=)(.*\\.[a-z]+)(&\|$)/"` | String | `https://dummyjson.com/users?email=atuny0@sohu.com` | `https://dummyjson.com/users?email=atu...[REDACTED]` | Regex filters must be in proper regex format but wrapped in a string. If no replacement is specified, [regex grouping](https://learn.microsoft.com/en-us/dotnet/standard/base-types/grouping-constructs-in-regular-expressions) MUST be used |
-| `"/email=.*\\.[a-z]+(&\|$)/::email=[REDACTED]"` | String | `https://dummyjson.com/users?email=atuny0@sohu.com` | `https://dummyjson.com/users?email=[REDACTED]` | Replacement can be whatever you want and is applied as-is. No need to use regex grouping when explicitly specifying a replacement |
-| `"(email=)(.*\\.[a-z]+)(&\|$)"` OR `"email"` | String | `https://dummyjson.com/users?email=atuny0@sohu.com` | `https://dummyjson.com/users?email=atuny0@sohu.com` | String filters must be defined in proper regex format, otherwise they will be ignored. This is a design descision to prevent bugs |
+| `"/(email=)(.*\.[a-z]+)(&\|$)/"` | String | `https://dummyjson.com/users?email=atuny0@sohu.com` | `https://dummyjson.com/users?email=atu...[REDACTED]` | Regex filters must be in proper regex format but wrapped in a string. If no replacement is specified, [regex grouping](https://learn.microsoft.com/en-us/dotnet/standard/base-types/grouping-constructs-in-regular-expressions) MUST be used |
+| `"/email=.*\.[a-z]+(&\|$)/::email=[REDACTED]"` | String | `https://dummyjson.com/users?email=atuny0@sohu.com` | `https://dummyjson.com/users?email=[REDACTED]` | Replacement can be whatever you want and is applied as-is. No need to use regex grouping when explicitly specifying a replacement |
+| `"(email=)(.*\.[a-z]+)(&\|$)"` OR `"email"` | String | `https://dummyjson.com/users?email=atuny0@sohu.com` | `https://dummyjson.com/users?email=atuny0@sohu.com` | String regex filters must be wrapped in forward slashes(i.e `/[you-regex]/`), otherwise they will be ignored. This is a design descision to prevent bugs |
 
 There are some ready-made, tokenized filter patterns available that you can take advantage of for **URLs** and/or **URI encoded requests**:
   - HTTPigeon::FilterPatterns::EMAIL

data/bin/console

@@ -7,8 +7,7 @@ require "httpigeon"
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
+require "pry"
 # Pry.start
 
 require "irb"

data/lib/httpigeon/request.rb

@@ -32,12 +32,14 @@ module HTTPigeon
 
     def initialize(base_url:, options: nil, headers: nil, adapter: nil, logger: nil, event_type: nil, log_filters: nil)
       @base_url = base_url
-      @event_type = event_type
-      @log_filters = log_filters || []
-      @logger = logger || default_logger
 
       request_headers = default_headers.merge(headers.to_h)
-      base_connection = Faraday.new(url: base_url)
+
+      base_connection = Faraday.new(url: base_url).tap do |config|
+        config.headers.deep_merge!(request_headers)
+        config.options.merge!(options.to_h)
+        config.response :httpigeon_logger, logger if logger.is_a?(HTTPigeon::Logger)
+      end
 
       @connection = if block_given?
                       yield(base_connection) && base_connection
@@ -47,7 +49,7 @@ module HTTPigeon
                         faraday.options.merge!(options.to_h)
                         faraday.request :url_encoded
                         faraday.adapter adapter || Faraday.default_adapter
-                        faraday.response :httpigeon_logger, @logger
+                        faraday.response :httpigeon_logger, default_logger(event_type, log_filters) unless logger.is_a?(HTTPigeon::Logger)
                       end
                     end
     end
@@ -67,15 +69,29 @@ module HTTPigeon
 
     private
 
-    attr_reader :path, :logger, :event_type, :log_filters
+    attr_reader :logger, :event_type, :log_filters
 
     def parse_response
-      JSON.parse(response_body).with_indifferent_access
+      parsed_body = response_body.is_a?(String) ? JSON.parse(response_body) : response_body
+      deep_with_indifferent_access(parsed_body)
     rescue JSON::ParserError
       response_body.presence
     end
 
-    def default_logger
+    def deep_with_indifferent_access(obj)
+      case obj
+      when Hash
+        obj.transform_values do |value|
+          deep_with_indifferent_access(value)
+        end.with_indifferent_access
+      when Array
+        obj.map { |item| deep_with_indifferent_access(item) }
+      else
+        obj
+      end
+    end
+
+    def default_logger(event_type, log_filters)
       HTTPigeon::Logger.new(event_type: event_type, log_filters: log_filters)
     end
 

data/lib/httpigeon/version.rb

@@ -1,3 +1,3 @@
 module HTTPigeon
-  VERSION = "2.0.0".freeze
+  VERSION = "2.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: httpigeon
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - 2k-joker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-25 00:00:00.000000000 Z
+date: 2024-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday