nse_data 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3bde71fd80e3987e026f0e1192363af2592eda5507b7bcc90de9ae0360514ad4
+  data.tar.gz: 3440701773c045b2c4cdf183b7bbbc1066f4405118a3ce017bfba3f76b2cd5b0
+SHA512:
+  metadata.gz: c101e627bde2635a0d0bfda069c8470ca6327a0bb1e26ee1718070b93cc9c0997ae819ec0c9cb6f48ab8b80066c190d537832556a1ba0c1c67f79bbea778d412
+  data.tar.gz: f33ee4792bf817af6626020db3c4f4212251828ee472e8e498c79ac370a98a9284f3f7337d44b410b09e665a216f2768caae80beb979f10b332b7b6937461614

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+[0.1.0] - 2024-09-10
+
+## 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.

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,24 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nse_data.gemspec
+gemspec
+
+# Specify your gem's dependencies in nse_data.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 '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,179 @@
+# NseData
+## Table of Contents
+- [NseData](#nsedata)
+  - [Table of Contents](#table-of-contents)
+  - [Features](#features)
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [High-Level Interface](#high-level-interface)
+    - [Low-Level API](#low-level-api)
+  - [Configuration](#configuration)
+    - [Example](#example)
+    - [APIs Available](#apis-available)
+  - [Development](#development)
+    - [Running Tests](#running-tests)
+    - [Code Style and Linting](#code-style-and-linting)
+  - [Contributing](#contributing)
+  - [License](#license)
+  - [Code of Conduct](#code-of-conduct)
+
+**NseData** is a Ruby gem designed to interact with the National Stock Exchange (NSE) of India's API, providing an easy-to-use interface for developers to retrieve stock market data. The gem offers a high-level API for most users and a lower-level API for advanced users who need more control over the interactions.
+
+## Features
+- Fetch stock market data from multiple NSE APIs
+- High-level and low-level API interfaces
+- Simple and clear error handling for HTTP requests
+- Ruby 3.1 and 3.2 support with a test matrix across different OS
+- Easy integration with CI/CD and coverage tools
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nse_data'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install nse_data
+```
+
+## Available Methods
+
+- fetch_all_indices
+- fetch_circulars
+- fetch_equity_master
+- fetch_glossary
+- fetch_holiday_clearing
+- fetch_holiday_trading
+- fetch_index_names
+- fetch_latest_circulars
+- fetch_market_data_pre_open
+- fetch_market_status
+- fetch_market_turnover
+- fetch_merged_daily_reports_capital
+- fetch_merged_daily_reports_debt
+- fetch_merged_daily_reports_derivatives
+
+## Usage
+
+### High-Level Interface
+The high-level interface is designed to be simple and user-friendly. You can instantiate an object and call the available methods:
+
+```ruby
+require 'nse_data'
+
+puts NseData.list_all_endpoints # Returns all the available APIs in the library
+puts NseData.fetch_all_indices # Returns the response.body of allIndices endpoint of NSE
+```
+
+### Low-Level API
+For advanced users, the lower-level APIManager class offers more control over requests:
+
+```ruby
+require 'nse_data'
+
+api_manager = NseData::APIManager.new
+response = api_manager.fetch_data('index_names')
+puts response.body # Returns index names in JSON format
+```
+
+where `index_names` is the name of the API routing to the path of https://www.nseindia.com/api/index-names
+
+## Configuration
+The gem uses an `api_endpoints.yml` file located in the config directory. This file maps API names to their respective endpoint URLs.
+
+### Example
+```yaml
+  all_indices:
+    path: "allIndices"
+    description: "Fetches data of all available indices."
+```
+
+### APIs Available
+  - **all_indices**: Fetches data of all available indices.
+  - **circulars**: Provides a list of circulars.
+  - **equity_master**: Fetches equity master data.
+  - **glossary**: Fetches glossary content.
+  - **holiday_clearing**: Fetches clearing holiday data.
+  - **holiday_trading**: Fetches trading holiday data.
+  - **index_names**: Fetches names of all indices.
+  - **latest_circulars**: Provides the latest circulars.
+  - **market_data_pre_open**: Fetches market pre-open data for all securities.
+  - **market_status**: Fetches the current status of the market.
+  - **market_turnover**: Fetches turnover data for the market.
+  - **merged_daily_reports_capital**: Fetches merged daily reports for capital.
+  - **merged_daily_reports_debt**: Fetches merged daily reports for debt.
+  - **merged_daily_reports_derivatives**: Fetches merged daily reports for derivatives.
+
+Please refer to the [api_endpoints.yml](lib/nse_data/config/api_endpoints.yml) file for the actual endpoint routing information.
+
+## Development
+
+To get started with contributing to **NseData**, 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/nse_data.git
+   cd nse_data
+
+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.
+
+## Debugging
+### NseData::Config::Logger
+The `NseData::Config::Logger` class is part of the NseData gem, providing configurable logging capabilities for your application. By default, it logs to a temporary file in the system's temporary directory, but it can be customized to suit your needs.
+
+#### Usage
+
+By default, the Logger class logs to a temporary file. You can configure it as follows:
+```ruby
+NseData.configure do |config|
+  custom_logger = Logger.new($stdout)
+  config.logger = custom_logger
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ahasunos/nse_data. 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/[USERNAME]/nse_data/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,72 @@
+# 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]
+
+require_relative 'lib/nse_data'
+
+namespace :docs do
+  desc 'Update README with dynamically defined methods'
+  task :update_readme do
+    # Ensure the API methods are defined
+    NseData.define_api_methods
+
+    # List all methods defined on NseData
+    methods = NseData.methods(false).grep(/^fetch_/)
+
+    # Read the existing README
+    readme_path = 'README.md'
+    readme_content = File.read(readme_path)
+
+    # Define markers for where to insert the methods section
+    start_marker = '## Available Methods'
+    end_marker = '## Usage'
+    start_index = readme_content.index(start_marker) + start_marker.length
+    end_index = readme_content.index(end_marker)
+
+    if start_index && end_index
+      methods_section = readme_content[start_index...end_index]
+      new_methods_section = "#{start_marker}\n\n"
+      methods.each do |method|
+        new_methods_section += "- #{method}\n"
+      end
+
+      # Write back the updated README
+      updated_content = readme_content.sub(methods_section, new_methods_section)
+      File.write(readme_path, updated_content)
+
+      puts 'README updated with the following methods:'
+      methods.each { |method| puts "- #{method}" }
+    else
+      puts 'Could not find markers to update in README.md'
+    end
+  end
+end
+
+# 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)
+# 5. `rake docs:update_readme` - Update readme with available methods generated dynamically in nse_data.rb