pstore_logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 38a6e72b650af79fb37cf2e51a2cc45023e0f9c795c2cd03dfcc25893070ecb2
+  data.tar.gz: 4e585f49bf52c067685f0722fd092dc1645dba7c82452cba16c31098c38a49a9
+SHA512:
+  metadata.gz: 2855141d2c6ef01940fe32adbc2fffdd93121f23ac5930b4d8712f392f35189491ad9787867c15e2cfb63a35eb2eca081d9640a2479733d7f8193ec2f015b1ed
+  data.tar.gz: fcc4bdaa4ec128b3e18e10614eadc9ce7bdde3beade4daa9a95ebeaddf896c65525baa5f9ab6d4f0ae1d97c76892d93759585beabb8a29f002b3ed465f5cbc08

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Lucian Ghinda
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,200 @@
+# PStore Logger
+
+[![Gem Version](https://badge.fury.io/rb/pstore_logger.svg)](https://badge.fury.io/rb/pstore_logger)
+[![Ruby](https://img.shields.io/badge/ruby-%3E%3D3.4.4-ruby.svg)](https://www.ruby-lang.org/en/)
+
+A simple Ruby gem for logging data (webhooks, API responses, etc.) to organized PStore files with automatic timestamping and conflict resolution.
+
+## Features
+
+- 🚀 **Simple API**: Clean, intuitive interface for saving and loading data
+- 📁 **Organized Storage**: Automatic directory creation with tag-based organization
+- ⏰ **Automatic Timestamping**: YYYY-MM-DD-HH-MM-SS filename format
+- 🔄 **Collision Handling**: Automatic conflict resolution with numbered suffixes
+- 💾 **Flexible Data**: Store any Ruby object that can be serialized by PStore
+- 🏷️ **Tagging System**: Organize logs by category/type using tags
+- 📊 **Last Entry Retrieval**: Easy access to the most recent log entry
+- 🧹 **No dependencies**: This gem has no external dependencies.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pstore_logger'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install pstore_logger
+```
+
+## Usage
+
+### Basic Setup
+
+```ruby
+require 'pstore/logger'
+
+# Initialize with a storage path and tag
+logger = PStoreLogger.new(storage_path: '/path/to/logs', tag: 'webhooks')
+```
+
+### Saving Data
+
+#### With Automatic Timestamp
+
+```ruby
+# Saves to: /path/to/logs/webhooks/2025-06-19-14-30-25.pstore
+webhook_data = { event: 'user.created', user_id: 123, email: 'user@example.com' }
+logger.save(webhook_data)
+```
+
+#### With Custom File ID
+
+```ruby
+# Saves to: /path/to/logs/webhooks/user_123.pstore
+logger.save(webhook_data, file_id: 'user_123')
+
+# If file exists, creates: user_123_1.pstore, user_123_2.pstore, etc.
+logger.save(more_data, file_id: 'user_123')
+```
+
+### Loading Data
+
+```ruby
+# Load the most recent entry
+latest_webhook = logger.load_last
+puts latest_webhook # => { event: 'user.created', user_id: 123, ... }
+```
+
+## Real-World Examples
+
+### Webhook Logger
+
+```ruby
+require 'pstore/logger'
+
+class WebhookHandler
+  def initialize
+    @logger = PStoreLogger.new(
+      storage_path: './logs/webhooks',
+      tag: 'stripe'
+    )
+  end
+
+  def handle_stripe_webhook(payload)
+    @logger.save(payload, file_id: payload[:id])
+
+    # Process the webhook
+    process_payment(payload)
+  end
+
+  def debug_last_webhook
+    @logger.load_last
+  end
+end
+```
+
+### API Response Caching
+
+```ruby
+require 'pstore/logger'
+
+class ApiClient
+  def initialize
+    @cache = PStoreLogger.new(
+      storage_path: './cache/api_responses',
+      tag: 'github'
+    )
+  end
+
+  def fetch_user(username)
+    response = api_call("/users/#{username}")
+
+    @cache.save(response, file_id: username)
+
+    response
+  end
+end
+```
+
+### Development Testing
+
+```ruby
+require 'pstore/logger'
+
+# Save test data during development
+test_logger = PStoreLogger.new(storage_path: './tmp/test_data', tag: 'fixtures')
+
+# Save complex test objects
+user_data = { id: 1, name: 'Test User', preferences: { theme: 'dark' } }
+test_logger.save(user_data, file_id: 'test_user')
+
+# Later, load the test data
+test_user = test_logger.load_last
+```
+
+## Data Structure
+
+Each PStore file contains:
+
+```ruby
+{
+  data: your_saved_object,      # Your original data
+  timestamp: Time.now           # When it was saved
+}
+```
+
+## Use Cases
+
+- **🔗 Webhook Debugging**: Capture and inspect webhook payloads
+- **📡 API Response Logging**: Store API responses for offline analysis
+- **🔍 Data Auditing**: Keep records of data changes over time
+- **🧪 Development Testing**: Persist test data between runs
+- **📊 Data Analysis**: Collect data samples for analysis
+- **🚨 Error Investigation**: Log problematic data for debugging
+
+## Requirements
+
+- Ruby >= 3.4.4
+- No additional dependencies (uses built-in PStore)
+
+## Development
+
+After checking out the repo, run:
+
+```bash
+bundle install
+```
+
+To run the tests:
+
+```bash
+bundle exec ruby -Ilib:test test/test_pstore_logger.rb
+```
+
+To run linting:
+
+```bash
+bundle exec rubocop
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lucianghinda/pstore_logger.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for version history and changes.

data/lib/pstore/logger.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'pstore'
+require 'fileutils'
+
+class PStoreLogger
+  FILENAME_TIMESTAMP_FORMAT = '%Y-%m-%d-%H-%M-%S'
+
+  def initialize(storage_path:, tag:)
+    @storage_path = storage_path
+    @tag = tag.downcase
+    @folder_path = File.join(@storage_path, @tag)
+  end
+
+  def save(data, file_id: nil)
+    filepath = file_path(file_id)
+    store = PStore.new(filepath)
+
+    store.transaction do
+      store[:data] = data
+      store[:timestamp] = Time.now
+    end
+
+    filepath
+  end
+
+  def load_last
+    return nil unless Dir.exist?(folder_path)
+
+    files = Dir.glob(File.join(folder_path, '*.pstore'))
+    return nil if files.empty?
+
+    latest_file = files.max_by { |file| File.mtime(file) }
+
+    store = PStore.new(latest_file)
+    store.transaction(true) do
+      store[:data]
+    end
+  end
+
+  private
+
+    attr_reader :folder_path
+
+    def file_path(file_id)
+      FileUtils.mkdir_p(folder_path)
+      filename = generate_filename(file_id)
+
+      File.join(folder_path, filename)
+    end
+
+    def generate_filename(file_id)
+      base_name = file_id.nil? ? Time.now.strftime(FILENAME_TIMESTAMP_FORMAT) : file_id.to_s
+
+      ensure_unique_filename(base_name)
+    end
+
+    def ensure_unique_filename(base_name)
+      base_filename = "#{base_name}.pstore"
+      filepath = File.join(folder_path, base_filename)
+
+      return base_filename unless File.exist?(filepath)
+
+      counter = 1
+      loop do
+        new_filename = "#{base_name}_#{counter}.pstore"
+        new_filepath = File.join(folder_path, new_filename)
+        break new_filename unless File.exist?(new_filepath)
+
+        counter += 1
+      end
+    end
+end

data/lib/pstore/version.rb

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

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: pstore_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lucian
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: The PStore Logger provides a simple way to log webhooksor API responses
+  to a file for further inspection using Ruby's PStore.
+email:
+- lucian@shortruby.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/pstore/logger.rb
+- lib/pstore/version.rb
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.4
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: A simple logging gem using PStore to store data
+test_files: []