nse_data 0.1.0

data/lib/nse_data/cache/cache_store.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module NseData
+  module Cache
+    # CacheStore class provides an in-memory caching mechanism.
+    class CacheStore
+      def initialize
+        @store = {}
+      end
+
+      # Retrieves the cached data for the given key, or fetches fresh data if not cached or expired.
+      #
+      # @param key [String] The cache key.
+      # @param ttl [Integer] The time-to-live in seconds.
+      # @yield Fetches fresh data if cache is expired or not present.
+      # @return [Object] The cached data or the result of the block if not cached or expired.
+      def fetch(key, ttl)
+        if cached?(key, ttl)
+          @store[key][:data]
+        else
+          fresh_data = yield
+          store(key, fresh_data, ttl)
+          fresh_data
+        end
+      end
+
+      # Reads data from the cache.
+      #
+      # @param key [String] The cache key.
+      # @return [Object, nil] The cached data, or nil if not present.
+      def read(key)
+        cached?(key) ? @store[key][:data] : nil
+      end
+
+      # Writes data to the cache with an expiration time.
+      #
+      # @param key [String] The cache key.
+      # @param data [Object] The data to cache.
+      # @param ttl [Integer] The time-to-live in seconds.
+      def write(key, data, ttl)
+        store(key, data, ttl)
+      end
+
+      # Deletes data from the cache.
+      #
+      # @param key [String] The cache key.
+      def delete(key)
+        @store.delete(key)
+      end
+
+      private
+
+      # Checks if the data for the given key is cached and not expired.
+      #
+      # @param key [String] The cache key.
+      # @param ttl [Integer] The time-to-live in seconds.
+      # @return [Boolean] Whether the data is cached and valid.
+      def cached?(key, ttl = nil)
+        return false unless @store.key?(key)
+
+        !expired?(key, ttl)
+      end
+
+      # Checks if the cached data for the given key has expired.
+      #
+      # @param key [String] The cache key.
+      # @param ttl [Integer] The time-to-live in seconds.
+      # @return [Boolean] Whether the cached data has expired.
+      def expired?(key, ttl)
+        stored_time = @store[key][:timestamp]
+        ttl && (Time.now - stored_time) >= ttl
+      end
+
+      # Stores the data in the cache.
+      #
+      # @param key [String] The cache key.
+      # @param data [Object] The data to cache.
+      # @param ttl [Integer] The time-to-live in seconds.
+      def store(key, data, ttl)
+        @store[key] = { data:, timestamp: Time.now, ttl: }
+      end
+    end
+  end
+end

data/lib/nse_data/cache/redis_cache_store.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+# TODO: Implement in near future :)

data/lib/nse_data/config/api_endpoints.yml

@@ -0,0 +1,56 @@
+apis:
+  all_indices:
+    path: "allIndices"
+    description: "Fetches data of all available indices."
+
+  circulars:
+    path: "circulars"
+    description: "Provides a list of circulars."
+
+  equity_master:
+    path: "equity-master"
+    description: "Fetches equity master data."
+
+  glossary:
+    path: "cmsContent?url=/glossary"
+    description: "Fetches glossary content."
+
+  holiday_clearing:
+    path: "holiday-master?type=clearing"
+    description: "Fetches clearing holiday data."
+
+  holiday_trading:
+    path: "holiday-master?type=trading"
+    description: "Fetches trading holiday data."
+
+  index_names:
+    path: "index-names"
+    description: "Fetches names of all indices."
+
+  latest_circulars:
+    path: "latest-circular"
+    description: "Provides the latest circulars."
+
+  market_data_pre_open:
+    path: "market-data-pre-open?key=ALL"
+    description: "Fetches market pre-open data for all securities."
+
+  market_status:
+    path: "marketStatus"
+    description: "Fetches the current status of the market."
+
+  market_turnover:
+    path: "market-turnover"
+    description: "Fetches turnover data for the market."
+
+  merged_daily_reports_capital:
+    path: "merged-daily-reports?key=favCapital"
+    description: "Fetches merged daily reports for capital."
+
+  merged_daily_reports_debt:
+    path: "merged-daily-reports?key=favDebt"
+    description: "Fetches merged daily reports for debt."
+
+  merged_daily_reports_derivatives:
+    path: "merged-daily-reports?key=favDerivatives"
+    description: "Fetches merged daily reports for derivatives."

data/lib/nse_data/config/base.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module NseData
+  module Config
+    # Base serves as the base class for configuration settings.
+    #
+    # It allows for storing and accessing various configuration settings
+    # through a hash-like interface.
+    #
+    # @attr_reader [Hash] settings The hash storing configuration settings.
+    class Base
+      attr_reader :settings
+
+      # Initializes the Base with optional initial settings.
+      #
+      # @param initial_settings [Hash] Optional hash of initial settings.
+      def initialize(initial_settings = {})
+        @settings = initial_settings
+      end
+
+      # Retrieves a configuration setting by key.
+      #
+      # @param key [Symbol, String] The key for the setting.
+      # @return [Object] The value associated with the key.
+      def [](key)
+        @settings[key]
+      end
+
+      # Sets a configuration setting by key.
+      #
+      # @param key [Symbol, String] The key for the setting.
+      # @param value [Object] The value to set for the key.
+      def []=(key, value)
+        @settings[key] = value
+      end
+    end
+  end
+end

data/lib/nse_data/config/logger.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'tempfile'
+require_relative 'base'
+
+module NseData
+  module Config
+    # Logger handles configuration specifically for logging.
+    #
+    # It inherits from Base to utilize the hash-like configuration
+    # interface and provides default settings for logging.
+    #
+    # @attr_reader [Logger] logger The Logger instance configured by this class.
+    class Logger < Base
+      # Creates a default temporary log file.
+      def self.default_log_file
+        return $stdout if ENV['NSE_DEV']
+
+        temp_file = Tempfile.new(['nse_data', '.log'])
+        temp_file.close # Close the file immediately after creation
+        temp_file.path # Return the file path for the Logger
+      end
+
+      # Initializes the Logger with a default or custom Logger instance.
+      #
+      # @param logger [Logger] Optional custom Logger instance.
+      def initialize(logger = ::Logger.new(self.class.default_log_file))
+        super()
+        @logger = logger
+        @settings[:logger] = logger
+        # puts "Log file created at: #{self.class.default_log_file}"
+      end
+
+      # Retrieves/Sets the Logger instance.
+      attr_accessor :logger
+    end
+  end
+end

data/lib/nse_data/http_client/base_client.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module NseData
+  module HttpClient
+    # Base class for HTTP clients
+    class BaseClient
+      # Initializes a new instance of the BaseClient class.
+      #
+      # @param base_url [String] The base URL for the HTTP client.
+      def initialize(base_url, cache_policy)
+        @base_url = base_url
+        @cache_policy = cache_policy
+      end
+
+      # Sends a GET request to the specified endpoint.
+      #
+      # @param endpoint [String] The endpoint to send the GET request to.
+      # @raise [NotImplementedError] If the method is not implemented by subclasses.
+      def get(endpoint)
+        raise NotImplementedError, 'Subclasses must implement the get method'
+      end
+
+      # TODO: Other HTTP methods like post, put, delete can be added here if needed
+    end
+  end
+end

data/lib/nse_data/http_client/faraday_client.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday-http-cache'
+require 'json'
+require_relative 'base_client'
+
+module NseData
+  module HttpClient
+    # FaradayClient class is responsible for making HTTP requests using Faraday.
+    class FaradayClient < BaseClient
+      # Sends a GET request to the specified endpoint.
+      #
+      # @param endpoint [String] The endpoint to send the request to.
+      # @param force_refresh [Boolean] Whether to force a cache refresh.
+      # @return [Faraday::Response] The response object.
+      def get(endpoint, force_refresh: false)
+        NseData.logger.debug("#{self.class}##{__method__}: invoking the endpoint #{endpoint}")
+        # 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
+
+      private
+
+      # Handles the connection to the base URL.
+      #
+      # @yield [connection] The Faraday connection object.
+      # @yieldparam connection [Faraday::Connection] The Faraday connection object.
+      # @return [Object] The result of the block execution.
+      # @raise [Faraday::Error] If there is an error with the connection.
+      def handle_connection(endpoint)
+        connection = build_faraday_connection(endpoint)
+        yield(connection)
+      rescue Faraday::Error => e
+        NseData.logger.error("#{self.class}##{__method__}: exception is raised - #{e.message}")
+        handle_faraday_error(e)
+      end
+
+      def build_faraday_connection(endpoint)
+        Faraday.new(url: @base_url) do |faraday|
+          configure_faraday(faraday)
+          apply_cache_policy(faraday, endpoint) if @cache_policy.use_cache?(endpoint)
+          faraday.adapter Faraday.default_adapter
+        end
+      end
+
+      def configure_faraday(faraday)
+        faraday.request :json
+        faraday.headers['User-Agent'] = 'NSEDataClient/1.0'
+        faraday.response :json
+        faraday.headers['Accept'] = 'application/json'
+      end
+
+      def apply_cache_policy(faraday, endpoint)
+        ttl = @cache_policy.ttl_for(endpoint)
+        faraday.use :http_cache, store: @cache_policy.cache_store, expire_after: ttl
+      end
+
+      def handle_faraday_error(error)
+        raise error.message
+      end
+    end
+  end
+end

data/lib/nse_data/version.rb

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

data/lib/nse_data.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative 'nse_data/version'
+require_relative 'nse_data/api_manager'
+require_relative 'nse_data/config/logger'
+
+# The NseData module serves as the namespace for the NSE Data gem,
+# which provides an interface to interact with and retrieve stock market data
+# from the National Stock Exchange of India.
+module NseData
+  class Error < StandardError; end
+
+  class << self
+    # This module provides functionality for accessing NSE data.
+    def define_api_methods
+      api_manager = APIManager.new
+      api_manager.endpoints.each_key do |method_name|
+        define_singleton_method("fetch_#{method_name}") do
+          api_manager.fetch_data(method_name).body
+        end
+      end
+    end
+
+    # Returns a list of all available endpoints.
+    #
+    # @return [Array] An array of endpoint names.
+    def list_all_endpoints
+      @list_all_endpoints ||= APIManager.new.load_endpoints
+    end
+
+    # Configure the logger for the NseData gem.
+    #
+    # This method allows users to customize the logger used throughout the library.
+    # To use it, call `NseData.configure` and provide a block to set up the logger.
+    #
+    # Example:
+    #
+    # NseData.configure do |config|
+    #   custom_logger = Logger.new('nse_data.log')
+    #   custom_logger.level = Logger::DEBUG
+    #   config.logger = custom_logger
+    # end
+    #
+    # @yieldparam [NseData::Config::Logger] config The configuration object to be customized.
+    def configure
+      @logger_config ||= Config::Logger.new
+      yield(@logger_config) if block_given?
+    end
+
+    # Access the configured logger.
+    #
+    # This method returns the Logger instance configured through `NseData.configure`.
+    #
+    # @return [Logger] The configured Logger instance.
+    # @raise [RuntimeError] If the logger has not been configured.
+    def logger
+      @logger_config&.logger || (raise 'Logger not configured. Please call NseData.configure first.')
+    end
+  end
+
+  # Initialize configuration with default settings.
+  @logger_config = Config::Logger.new
+end
+
+NseData.define_api_methods

data/nse_data.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/nse_data/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'nse_data'
+  spec.version = NseData::VERSION
+  spec.authors = ['Sonu Saha']
+  spec.email = ['ahasunos@gmail.com']
+
+  spec.summary = 'A Ruby gem for accessing NSE data'
+  spec.description = 'Retrieves stock market data from the NSE (National Stock Exchange) of India'
+  spec.homepage = 'https://github.com/ahasunos/nse_data'
+  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/nse_data'
+  spec.metadata['changelog_uri'] = 'https://github.com/ahasunos/nse_data/blob/main/CHANGELOG.md'
+
+  # 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

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: nse_data
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sonu Saha
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: faraday-http-cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+description: Retrieves stock market data from the NSE (National Stock Exchange) of
+  India
+email:
+- ahasunos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- doc/NseData.html
+- doc/NseData/API.html
+- doc/NseData/API/Base.html
+- doc/NseData/API/SpecialPreopen.html
+- doc/NseData/APIManager.html
+- doc/NseData/Cache.html
+- doc/NseData/Cache/CachePolicy.html
+- doc/NseData/Cache/CacheStore.html
+- doc/NseData/Client.html
+- doc/NseData/Config.html
+- doc/NseData/Config/Base.html
+- doc/NseData/Config/Logger.html
+- doc/NseData/Error.html
+- doc/NseData/HttpClient.html
+- doc/NseData/HttpClient/BaseClient.html
+- doc/NseData/HttpClient/FaradayClient.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- lib/nse_data.rb
+- lib/nse_data/api_manager.rb
+- lib/nse_data/cache/README.md
+- lib/nse_data/cache/cache_policy.rb
+- lib/nse_data/cache/cache_store.rb
+- lib/nse_data/cache/redis_cache_store.rb
+- lib/nse_data/config/api_endpoints.yml
+- lib/nse_data/config/base.rb
+- lib/nse_data/config/logger.rb
+- lib/nse_data/http_client/base_client.rb
+- lib/nse_data/http_client/faraday_client.rb
+- lib/nse_data/version.rb
+- nse_data.gemspec
+homepage: https://github.com/ahasunos/nse_data
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ahasunos/nse_data
+  source_code_uri: https://github.com/ahasunos/nse_data
+  changelog_uri: https://github.com/ahasunos/nse_data/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A Ruby gem for accessing NSE data
+test_files: []