ApiManager is responsible for managing API interactions, including fetching data from endpoints and handling caching behavior.
+
+
It supports configuration of caching policies, including specifying endpoints that should bypass the cache and setting custom TTL (time-to-live) values for individual endpoints. The class uses a Faraday client for making HTTP requests and integrates with a cache store for storing and retrieving cached data.
# File 'lib/api_wrapper/http_client/base_client.rb', line 19
+
+defget(endpoint)
+ raiseNotImplementedError,'Subclasses must implement the get method'
+end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/ApiWrapper/HttpClient/FaradayClient.html b/doc/ApiWrapper/HttpClient/FaradayClient.html
new file mode 100644
index 0000000..017a9cb
--- /dev/null
+++ b/doc/ApiWrapper/HttpClient/FaradayClient.html
@@ -0,0 +1,299 @@
+
+
+
+
+
+
+ Class: ApiWrapper::HttpClient::FaradayClient
+
+ — Documentation by YARD 0.9.37
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
# File 'lib/api_wrapper/http_client/faraday_client.rb', line 17
+
+defget(endpoint,force_refresh:false)
+ # Use the cache policy to determine whether to fetch from cache or refresh.
+@cache_policy.fetch(endpoint,force_refresh:)do
+ handle_connection(endpoint)do|connection|
+ connection.get(endpoint)
+ end
+ end
+end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/_index.html b/doc/_index.html
new file mode 100644
index 0000000..715d85e
--- /dev/null
+++ b/doc/_index.html
@@ -0,0 +1,195 @@
+
+
+
+
+
+
+ Documentation by YARD 0.9.37
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
By default, ApiWrapper looks for an API configuration file at config/api_endpoints.yml (see 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:
+
+
require'api_wrapper'
+
+# Fetch data from an API endpoint using the default settings
+response=ApiWrapper.fetch_data('endpoint_key')
+putsresponse.body
+
+
+
Custom Configuration
+
+
You can customize the API configuration path and cache store by configuring ApiWrapper:
+
+
require'api_wrapper'
+
+# Configure ApiWrapper with custom settings
+ApiWrapper.configuredo|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')
+putsresponse.body
+
+
+
Resetting the API Manager
+
+
If you change the configuration and want to reset the API manager, call:
This will create a new instance of ApiManager with the updated settings.
+
+
Configuration
+
+
You can adjust two main settings:
+
+
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.
+
+
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.
+
+
+
API Configuration File
+
+
Your configuration file (api_endpoints.yml) defines the base URL for the API and the available endpoints. Here’s an example:
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:
+
+
bundleexecrspec
+
+
+
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:
+
+
bundleexecrubocop
+
+
+
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 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.
+
+
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.
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/file_list.html b/doc/file_list.html
new file mode 100644
index 0000000..05465df
--- /dev/null
+++ b/doc/file_list.html
@@ -0,0 +1,59 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ File List
+
+
+
+
By default, ApiWrapper looks for an API configuration file at config/api_endpoints.yml (see 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:
+
+
require'api_wrapper'
+
+# Fetch data from an API endpoint using the default settings
+response=ApiWrapper.fetch_data('endpoint_key')
+putsresponse.body
+
+
+
Custom Configuration
+
+
You can customize the API configuration path and cache store by configuring ApiWrapper:
+
+
require'api_wrapper'
+
+# Configure ApiWrapper with custom settings
+ApiWrapper.configuredo|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')
+putsresponse.body
+
+
+
Resetting the API Manager
+
+
If you change the configuration and want to reset the API manager, call:
This will create a new instance of ApiManager with the updated settings.
+
+
Configuration
+
+
You can adjust two main settings:
+
+
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.
+
+
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.
+
+
+
API Configuration File
+
+
Your configuration file (api_endpoints.yml) defines the base URL for the API and the available endpoints. Here’s an example:
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:
+
+
bundleexecrspec
+
+
+
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:
+
+
bundleexecrubocop
+
+
+
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 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.
+
+
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.