api_hit_logger 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b5a91ee46006e34989796e757e296e3cb2740f927ed51facfe4f71996055029
-  data.tar.gz: 2138600bb5b88fe56ffe747123616e4eba75932176f6c1aeaa189b125c5ba9a6
+  metadata.gz: b97f560d9dbce9d608affa66d0211324b3789e801448436dbef9636840ea42f9
+  data.tar.gz: 8580dbded8673fc96618d6771e46bccbb9a9d67de6b32a0e5d09d6bf5f82924b
 SHA512:
-  metadata.gz: 20e66a1bcf7e099c7e7e0d6d36b98fdb5c0ba81776b666a2413442fc7ae7f3ef481609d1c1be700cb67537a7300724eaf6085c219cf0f2b0a41c22d2e2ffadf1
-  data.tar.gz: a4fd6c439b3089d04a8c49e4c0df3ed1a048190adc2be5f9e6881b9344d83e7e0e28797a0a76ac7d26cf5ce95146cf453339c9275a4a8a22c35367d643dd6e82
+  metadata.gz: 19865985c155a97829f75a56465ad558e1ce7407b9d84f90d494a41ae9bb2492d1be2caa737126588f6e5247658a2dce0d2c0eb2c1bfde89d35b743a60da4c9e
+  data.tar.gz: 2825f80ce6d8b8ebd511f3687d3531dca32514a59e9af1a5eff7cd7eb42a7a5adaa78ac3d693ab08f9c63db44c9bc91af15a00ba6461bb6d7bad10ca98b9d7e4

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [0.2.0] - 2025-06-25
+
+### Added
+- Support for JSON log format via configuration
+- New `ApiHitLogger.configure` block
+- Manual initializer support for customizing format, whitelist/blacklist, and log directory
+
 ## [Unreleased]
 
 ## [0.1.0] - 2025-06-19

data/README.md

@@ -27,7 +27,7 @@ require 'api_hit_logger'
 2. Add the middleware
 
 For Rails:
-# config/application.rb
+config/application.rb
 config.middleware.use ApiHitLogger::Middleware
 
 For Rack apps, update your config.ru:
@@ -41,7 +41,22 @@ Log File Location
 The logs are written to:
 log/api_hit_logs_YYYY-MM-DD.csv
 
-Each day's requests are stored in their own CSV file.
+Each day's requests are stored in their own CSV/JSON file.
+
+## Configuration
+
+To customize how API hits are logged, create a file at:
+
+
+With the following content:
+
+```ruby
+ApiHitLogger.configure do |config|
+  # Format options: :csv, :json (default: :csv)
+  config.log_format = :csv
+end
+
+If no initializer is present, default settings will be used.
 
 ## Development
 

data/lib/api_hit_logger/middleware.rb

@@ -43,7 +43,12 @@ end
     end
 
     def log_api_hit(request, status, start_time, end_time, error: nil)
-      CsvLogger.log(
+      logger_class = case ApiHitLogger.configuration&.log_format
+                     when :json then ApiHitLogger::JsonLogger
+                     else ApiHitLogger::CsvLogger
+                     end
+
+      logger_class.log(
         request: request,
         status: status,
         start_time: start_time,

data/lib/api_hit_logger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ApiHitLogger
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/api_hit_logger.rb

@@ -1,7 +1,17 @@
-require_relative "api_hit_logger/version"
-require "api_hit_logger/middleware"
-
-module ApiHitLogger
-  class Error < StandardError; end
-
-end
+require_relative "api_hit_logger/version"
+require "api_hit_logger/middleware"
+require "api_hit_logger/configuration"
+require "csv_logger"
+require "api_hit_logger/json_logger"
+
+module ApiHitLogger
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: api_hit_logger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - ChaitanyaGalande
 bindir: exe
 cert_chain: []
-date: 2025-06-23 00:00:00.000000000 Z
+date: 2025-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: csv
@@ -38,7 +38,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Rack middleware that logs API request details (method, path, IP, duration,
-  status, errors) into a CSV file, with daily file rotation
+  status, errors) into a CSV or JSON file. Supports daily rotation and format customization.
 email:
 - chaitany.galande@gmail.com
 executables: []
@@ -61,9 +61,10 @@ homepage: https://github.com/chaitanyag1-c/api_hit_logger
 licenses:
 - MIT
 metadata:
+  allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/chaitanyag1-c/api_hit_logger
   source_code_uri: https://github.com/chaitanyag1-c/api_hit_logger
-  changelog_uri: https://github.com/chaitanyag1-c/api_hit_logger
+  changelog_uri: https://github.com/chaitanyag1-c/api_hit_logger/blob/main/README.md
 rdoc_options: []
 require_paths:
 - lib
@@ -80,5 +81,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.1
 specification_version: 4
-summary: Logs API requests to a CSV file with daily rotation
+summary: Logs API requests to a CSV or JSON file with daily rotation
 test_files: []