Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update changelog for initial release #40

Merged
merged 2 commits into from
Sep 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 20 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,22 @@
## [Unreleased]
# Changelog

## [0.1.0] - 2024-09-04
[0.1.0] - 2024-09-10

- Initial release
## Added
- **Caching Mechanism**: Implemented a scalable & flexible caching mechanism to reduce unnecessary API requests. Currently, it supports in-memory caching, with configurable features like custom TTL, disable caching for certain APIs or force refresh API calls.

- **Logger Configuration**: Implemented a custom logging system that can be configured by users. By default, logs are written to system temporary files.

- **HttpClient**: Implemented a flexible HTTP client using Faraday, with support for future extensions to other libraries, if needed.

- **ApiManager**: Implemented an API Manager that sets up the base URL, loads API endpoints from a YAML file, creates dynamic methods for each endpoint, and integrates the caching mechanism with configurable TTL for API calls and no-caching for some endpoints.

- **RSpec Tests**: Added RSpec tests for core classes with code coverage over 90%.

- **Security Audit**: Verified gem dependencies using bundler-audit to ensure no known vulnerabilities.

## Usage Notes
For usage instructions, please refer to the documentation available in the README file.

## Future Work
**Core Logic Extraction**: Plan to extract the core API interaction logic into a separate gem.
2 changes: 1 addition & 1 deletion lib/nse_data/version.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# frozen_string_literal: true

module NseData
VERSION = '0.1.14'
VERSION = '0.1.0'
end
Loading