api_wrapper 0.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a1fb3f8095d43a989fe1af85ad5929fc4831d5f8aa04d4fa0218318857510d0d
+  data.tar.gz: 9367ad54c68420f3a679d36329ce47fda8adfa72a903913834ed548762bdd21b
+SHA512:
+  metadata.gz: c8b4e19a62d31217c911541e4bec026120934ca914fe4240361d1dec27eada9f8adfd69fd8a5185a1455ff5d16a3c5d65c927d8f021bee857aa5587cea906244
+  data.tar.gz: 998d488e50643a75d6b9222c02add188dc380eef709096963e1fdb221b124fba0944b63c0aadb8ba244099e0c539e8c1e4c9c75dba836df5aebd3abd2b038ecd

data/.rubocop.yml

@@ -0,0 +1,7 @@
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+AllCops:
+    SuggestExtensions: false

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+## [0.1.6] - 2024-09-16
+### CI
+- Configure GitHub Actions to run tests on PR creation by @ahasunos in [#1](https://github.com/ahasunos/api_wrapper/pull/1)
+- Fix version bumper failure due to missing semantic gem by @ahasunos in [#2](https://github.com/ahasunos/api_wrapper/pull/2)
+
+### Fixes
+- Rename old commit files from nse_gem project by @ahasunos in [#3](https://github.com/ahasunos/api_wrapper/pull/3)
+
+### Features
+- Implement caching mechanism in the library by @ahasunos in [#5](https://github.com/ahasunos/api_wrapper/pull/5)
+- Implement client to handle HTTP requests by @ahasunos in [#6](https://github.com/ahasunos/api_wrapper/pull/6)
+- Implement API manager with API configuration & caching support by @ahasunos in [#8](https://github.com/ahasunos/api_wrapper/pull/8)
+- Implement ApiWrapper interface for end users by @ahasunos in [#9](https://github.com/ahasunos/api_wrapper/pull/9)
+
+### Documentation
+- Update documentation for ApiWrapper by @ahasunos in [#11](https://github.com/ahasunos/api_wrapper/pull/11)

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at ahasunos@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in api_wrapper.gemspec
+gemspec
+
+group :development do
+  gem 'bundler-audit', require: false
+  gem 'byebug'
+  gem 'rake', '~> 13.0'
+  gem 'rspec', '~> 3.0'
+  gem 'rubocop', '~> 1.21'
+  gem 'semantic'
+  gem 'yard', '~> 0.9.37'
+end
+
+group :test do
+  gem 'simplecov'
+  gem 'timecop'
+  gem 'webmock', '~> 3.0'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Sonu Saha
+
+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,153 @@
+`ApiWrapper` is a Ruby gem that offers an easy and flexible way to handle API interactions.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Basic Usage](#basic-usage)
+  - [Custom Configuration](#custom-configuration)
+  - [Resetting the API Manager](#resetting-the-api-manager)
+- [Configuration](#configuration)
+  - [API Configuration File](#api-configuration-file)
+- [Key Methods](#key-methods)
+- [Development](#development)
+  - [Running Tests](#running-tests)
+  - [Code Style and Linting](#code-style-and-linting)
+- [Contributing](#contributing)
+- [License](#license)
+- [Code of Conduct](#code-of-conduct)
+
+## Installation
+
+Add this to your Gemfile:
+
+
+```ruby
+gem 'api_wrapper'
+```
+
+Then run
+
+```ruby
+bundle install
+```
+
+## Usage
+
+### Basic Usage
+By default, ApiWrapper looks for an API configuration file at `config/api_endpoints.yml` (see [API Configuration File](#api-configuration-file)) in your root directory of your application and uses in-memory caching. You can fetch data from an API endpoint like this:
+
+```ruby
+require 'api_wrapper'
+
+# Fetch data from an API endpoint using the default settings
+response = ApiWrapper.fetch_data('endpoint_key')
+puts response.body
+```
+
+### Custom Configuration
+You can customize the API configuration path and cache store by configuring ApiWrapper:
+
+```ruby
+require 'api_wrapper'
+
+# Configure ApiWrapper with custom settings
+ApiWrapper.configure do |config|
+  config.api_configuration_path = 'custom/path/to/api_configuration.yml'
+  config.cache_store = CustomCacheStore.new # TODO: Update details on CustomCacheStore later
+end
+
+# Fetch data with the custom configuration
+response = ApiWrapper.fetch_data('endpoint_key')
+puts response.body
+```
+
+### Resetting the API Manager
+If you change the configuration and want to reset the API manager, call:
+```ruby
+ApiWrapper.reset_api_manager!
+```
+This will create a new instance of ApiManager with the updated settings.
+
+## Configuration
+You can adjust two main settings:
+
+1. **API Configuration Path**: This is the path to the YAML file that defines your API endpoints. By default, it’s set to config/api_endpoints.yml. You can also set it through the environment variable ENV['API_CONFIGURATION_PATH'].
+
+2. **Cache Store**: This is where API responses are stored. By default, ApiWrapper uses an in-memory cache. You can customize this to use a different cache store, such as Redis. You can also set the cache type through ENV['CACHE_STORE_TYPE'].
+
+### API Configuration File
+Your configuration file (api_endpoints.yml) defines the base URL for the API and the available endpoints. Here’s an example:
+
+```yaml
+base_url: https://api.example.com/
+apis:
+  endpoint1:
+    path: 'path/to/endpoint1'
+    description: 'Endpoint 1 description'
+    no_cache: true
+  endpoint2:
+    path: 'path/to/endpoint2'
+    description: 'Endpoint 2 description'
+    ttl: 600
+```
+
+- base_url: The base URL for all API requests.
+- apis: A list of API endpoints.
+    - path: The path to the API endpoint.
+    - description: (Optional) The description about the endpoint
+    - ttl: (Optional) The time (in seconds) that data should be cached.
+    - no_cache: (Optional) Whether to bypass caching for this endpoint.
+
+## Key Methods
+- `ApiWrapper.fetch_data(endpoint_key, force_refresh: false)`: Fetches data from the specified API endpoint.
+- `ApiWrapper.configure { |config| ... }`: Allows you to configure the gem with custom settings.
+- `ApiWrapper.reset_api_manager!`: Resets the ApiManager instance, which will use any new settings.
+
+## Development
+
+To get started with contributing to **ApiWrapper**, follow these steps:
+
+1. **Clone the repository**:
+
+   First, clone the repository to your local machine and navigate to the project directory:
+
+   ```bash
+   git clone https://github.com/ahasunos/api_wrapper.git
+   cd api_wrapper
+
+2. **Install dependencies**:
+
+   After navigating to the project directory, install the required gems using Bundler:
+
+   ```bash
+   bundle install
+   ```
+
+### Running Tests
+The project uses RSpec for testing. Before submitting any changes, make sure to run the test suite to ensure that everything works as expected:
+
+```bash
+bundle exec rspec
+```
+
+### Code Style and Linting
+To maintain consistent code quality and style, the project uses RuboCop for linting. Before submitting a pull request, ensure that your code adheres to the project's style guidelines by running RuboCop:
+
+```bash
+bundle exec rubocop
+```
+
+If RuboCop identifies any issues, it will provide suggestions for how to fix them.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ahasunos/api_wrapper. For major changes, please open an issue first to discuss what you would like to change.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the NseData project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/ahasunos/api_wrapper/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Load Bundler's gem tasks (e.g., `rake build`, `rake install`, etc.)
+require 'bundler/gem_tasks'
+
+# Load RSpec's rake task to run the test suite using `rake spec`
+require 'rspec/core/rake_task'
+
+# Define the `spec` task to run RSpec tests
+RSpec::Core::RakeTask.new(:spec)
+
+# Load RuboCop's rake task to check for style guide violations using `rake rubocop`
+require 'rubocop/rake_task'
+
+# Define the `rubocop` task to run RuboCop linter
+RuboCop::RakeTask.new
+
+# Load Yard's rake task for generating documentation using `rake yard`
+require 'yard'
+
+# Define the `yard` task to generate documentation
+YARD::Rake::YardocTask.new
+
+# By default, run both the `spec` (tests) and `rubocop` (linter) tasks
+task default: %i[spec rubocop]
+
+# Usage:
+# 1. `rake spec` - Runs the RSpec tests
+# 2. `rake rubocop` - Runs RuboCop linter for code quality checks
+# 3. `rake yard` - Generates Yard documentation (output in the `doc/` folder)
+# 4. `rake` - Runs both the tests and RuboCop checks (default task)

data/api_wrapper.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/api_wrapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'api_wrapper'
+  spec.version = ApiWrapper::VERSION
+  spec.authors = ['Sonu Saha']
+  spec.email = ['ahasunos@gmail.com']
+
+  spec.summary = 'A Ruby gem to simplify API interactions'
+  spec.description = 'ApiWrapper provides an easy-to-use interface for interacting with APIs in a configurable way'
+  spec.homepage = 'https://github.com/ahasunos/api_wrapper'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.1.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/ahasunos/api_wrapper'
+  spec.metadata['changelog_uri'] = 'https://github.com/ahasunos/api_wrapper'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '~> 2.11'
+  spec.add_dependency 'faraday-http-cache', '~> 2.5', '>= 2.5.1'
+end