latest_stock_price 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 11ef6cb80025100502c4e7cf4468d2abeb1f02b316379c3cfab301081d9e2827
+  data.tar.gz: 880467c51f47fe8c3e7513b9cb2fc176cf6b970098d97f430f78ffafd8a28ae5
+SHA512:
+  metadata.gz: 0ddd2e01ca5bc5cf271128cf9e0f205a4a3d263a229b5e5d82c6e977055dae96c2f189fcd4c7d83314f590843dab0a07976cf7e148f6677a6f5da15a401a28ef
+  data.tar.gz: 216e1866cd66a4706f3b0bdb58a0294852cba085d404df91ab41e07ea943c2fb2e25ad37ffe55bde52b92e2882c2b7728d141665e7e38aaa707cd3a74c12bc54

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0 (21-Oct-20)
+
+* First Release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,23 @@
+## Read Me 
+
+
+## Setup
+
+```
+bundle install
+```
+
+#### Create Your Environment Variables File
+Copy the sample.env file to create your local .env file:
+
+```
+cp sample.env .env
+```
+
+#### Set Your API Keys
+Open the .env file in your preferred text editor and add your API keys:
+# .env
+RAPIDAPI_KEY='your_actual_api_key'
+RAPIDAPI_HOST='latest-stock-price.p.rapidapi.com'
+
+**Note:** To obtain a Rapid APi key, login to your Rapid Api account and find it in the account settings. 

data/latest_stock_price.gemspec

@@ -0,0 +1,36 @@
+Gem::Specification.new do |s|
+    s.name        = "latest_stock_price"
+    s.version     = "1.0.0"
+    s.summary     = "Latest stock price"
+    s.description = "A simple hello world gem"
+    s.authors     = ["Ciever Hassan"]
+    s.email       = "ciever.a.h@hotmail.com"
+    s.homepage    = "https://github.com/ciever/latest_stock_price"
+    s.license     = "MIT"
+
+    s.files       = ["lib/latest_stock_price/http_client.rb", 
+                     "lib/latest_stock_price/latest_stock_price.rb",
+                     "lib/latest_stock_price/price_all.rb",
+                     "lib/latest_stock_price/price.rb",
+                     "lib/latest_stock_price/prices.rb",
+                     "lib/latest_stock_price/version.rb",
+                     "spec/http_client_spec.rb",
+                     "spec/price_all_spec.rb",
+                     "spec/price_spec.rb",
+                     "spec/prices_spec.rb",
+                     "spec/spec_helper.rb",
+                     "sample.env", 
+                     "README.md",
+                     "CHANGELOG.md",
+                     "Gemfile",
+                     ".rspec",
+                     "latest_stock_price.gemspec"]
+
+    s.add_development_dependency 'dotenv', '~> 3.0.0'
+    s.add_development_dependency 'rspec', '~> 3.4.0'
+    s.add_development_dependency 'webmock', '~> 3.19.1'
+
+    s.add_dependency 'net-http', '~> 0.4.1'
+    s.add_dependency 'uri', '~> 0.10.0'
+    s.add_dependency 'debug', '~> 1.8'
+end

data/lib/latest_stock_price/http_client.rb

@@ -0,0 +1,38 @@
+require 'uri'
+require 'net/http'
+require 'json'
+
+module LatestStockPrice
+  class HttpClient
+    def self.make_request(uri)
+      response = perform_request(uri)
+      parse_response(response.body)
+    end
+
+    private
+
+    def self.perform_request(uri)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+
+      request = Net::HTTP::Get.new(uri)
+      request["x-rapidapi-key"] = ENV['X_RAPIDAPI_KEY']
+      request["x-rapidapi-host"] = ENV['X_RAPIDAPI_HOST']
+      response = http.request(request)
+
+      unless response.is_a?(Net::HTTPSuccess)
+        raise "Error fetching data: #{response.code} #{response.message}"
+      end
+
+      response
+    rescue SocketError, Errno::ECONNREFUSED => e
+      raise "Network error: #{e.message}"
+    end
+
+    def self.parse_response(response_body)
+      JSON.parse(response_body)
+    rescue JSON::ParserError => e
+      raise "Error parsing response: #{e.message}"
+    end
+  end
+end

data/lib/latest_stock_price/latest_stock_price.rb

@@ -0,0 +1,7 @@
+require 'dotenv/load'
+require 'debug'
+require_relative "http_client"
+require_relative "version"   
+require_relative "price"      
+require_relative "prices"
+require_relative "price_all"

data/lib/latest_stock_price/price.rb

@@ -0,0 +1,13 @@
+module LatestStockPrice
+  class Price
+    API_BASE_URL = "https://latest-stock-price.p.rapidapi.com/equities-search"
+
+    def self.fetch(search_term) # Param example - "AAATECH.NS"
+      raise ArgumentError, "Search term cannot be nil or empty" if search_term.nil? || search_term.strip.empty?
+
+      encoded_term = URI.encode_www_form_component(search_term)
+      uri = URI("#{API_BASE_URL}?Search=#{encoded_term}")
+			LatestStockPrice::HttpClient.make_request(uri)
+    end
+  end
+end

data/lib/latest_stock_price/price_all.rb

@@ -0,0 +1,10 @@
+module LatestStockPrice
+  class PriceAll
+    API_BASE_URL = "https://latest-stock-price.p.rapidapi.com/any"
+
+    def self.fetch
+			uri = URI(API_BASE_URL)
+      LatestStockPrice::HttpClient.make_request(uri)
+    end
+  end
+end

data/lib/latest_stock_price/prices.rb

@@ -0,0 +1,13 @@
+module LatestStockPrice
+  class Prices
+    API_BASE_URL = "https://latest-stock-price.p.rapidapi.com/equities-enhanced"
+
+    def self.fetch(symbols) # Param example - ['AAATECH.NS', 'AADHHOUS.NS']
+      raise ArgumentError, "Search term cannot be nil or empty" if symbols.nil? || symbols.empty? # could improve by checking each array item
+
+			symbols_param = URI.encode_www_form_component(symbols.join(','))
+      uri = URI("#{API_BASE_URL}?Symbols=#{symbols_param}")
+			LatestStockPrice::HttpClient.make_request(uri)
+    end
+  end
+end

data/lib/latest_stock_price/version.rb

@@ -0,0 +1,3 @@
+module LatestStockPrice
+    VERSION = "1.0.0"
+end

data/sample.env

@@ -0,0 +1,3 @@
+# Rapid APi credentials
+X_RAPIDAPI_KEY='your_rapidapi_key_here'
+X_RAPIDAPI_HOST='your_rapidpia_host'

data/spec/http_client_spec.rb

@@ -0,0 +1,64 @@
+require 'debug'
+require 'spec_helper'
+require 'webmock/rspec'
+require './lib/latest_stock_price/http_client'
+
+RSpec.describe LatestStockPrice::HttpClient do
+  let(:uri) { URI('https://latest-stock-price.p.rapidapi.com/test') }
+  let(:valid_response) { { "key" => "value" }.to_json }
+  
+  before do
+    ENV['X_RAPIDAPI_KEY'] = 'dummy_key'
+    ENV['X_RAPIDAPI_HOST'] = 'dummy_host'
+  end
+
+  describe '.make_request' do
+    context 'when the request is successful' do
+      before do
+        stub_request(:get, uri)
+          .with(
+            headers: {
+              'x-rapidapi-key' => ENV['X_RAPIDAPI_KEY'],
+              'x-rapidapi-host' => ENV['X_RAPIDAPI_HOST']
+            }
+          )
+          .to_return(status: 200, body: valid_response)
+      end
+
+      it 'returns parsed JSON response' do
+        response = described_class.make_request(uri)
+        expect(response).to eq({"key" => "value"})
+      end
+    end
+
+    context 'when the request fails' do
+      before do
+        stub_request(:get, uri).to_return(status: 404, body: "")
+      end
+
+      it 'raises an error' do
+        expect { described_class.make_request(uri) }.to raise_error(RuntimeError, /Error fetching data: 404/)
+      end
+    end
+
+    context 'when there is a network error' do
+      before do
+        allow(Net::HTTP).to receive(:new).and_raise(SocketError.new('Network issue'))
+      end
+
+      it 'raises a network error' do
+        expect { described_class.make_request(uri) }.to raise_error(RuntimeError, /Network error: Network issue/)
+      end
+    end
+
+    context 'when the response cannot be parsed' do
+        before do
+          stub_request(:get, uri).to_return(status: 200, body: 'invalid json')
+        end
+      
+        it 'raises a parsing error' do
+          expect { described_class.make_request(uri) }.to raise_error(RuntimeError, /Error parsing response: .*/)
+        end
+      end
+  end
+end

data/spec/price_all_spec.rb

@@ -0,0 +1,44 @@
+require 'debug'
+require 'spec_helper'
+require 'webmock/rspec'
+require './lib/latest_stock_price/price_all'
+
+RSpec.describe LatestStockPrice::PriceAll do
+  let(:uri) { URI("https://latest-stock-price.p.rapidapi.com/any") }
+  let(:valid_response) { { "key" => "value" }.to_json }
+
+  before do
+    ENV['X_RAPIDAPI_KEY'] = 'dummy_key'
+    ENV['X_RAPIDAPI_HOST'] = 'dummy_host'
+  end
+
+  describe '.fetch' do
+    context 'when the request is successful' do
+      before do
+        stub_request(:get, uri)
+          .with(
+            headers: {
+              'x-rapidapi-key' => ENV['X_RAPIDAPI_KEY'],
+              'x-rapidapi-host' => ENV['X_RAPIDAPI_HOST']
+            }
+          )
+          .to_return(status: 200, body: valid_response)
+      end
+
+      it 'returns parsed JSON response' do
+        response = described_class.fetch
+        expect(response).to eq({"key" => "value"})
+      end
+    end
+
+    context 'when the request fails' do
+      before do
+        stub_request(:get, uri).to_return(status: 404, body: "")
+      end
+
+      it 'raises an error' do
+        expect { described_class.fetch }.to raise_error(RuntimeError, /Error fetching data: 404/)
+      end
+    end
+  end
+end

data/spec/price_spec.rb

@@ -0,0 +1,42 @@
+require 'debug'
+require 'spec_helper'
+require 'webmock/rspec'
+require './lib/latest_stock_price/price'
+
+RSpec.describe LatestStockPrice::Price do
+  let(:search_term) { "AAATECH.NS" }
+  let(:uri) { URI("https://latest-stock-price.p.rapidapi.com/equities-search?Search=#{URI.encode_www_form_component(search_term)}") }
+  let(:valid_response) { { "key" => "value" }.to_json }
+
+  before do
+    ENV['X_RAPIDAPI_KEY'] = 'dummy_key'
+    ENV['X_RAPIDAPI_HOST'] = 'dummy_host'
+  end
+
+  describe '.fetch' do
+    context 'when search term is valid' do
+      before do
+        stub_request(:get, uri)
+          .with(
+            headers: {
+              'x-rapidapi-key' => ENV['X_RAPIDAPI_KEY'],
+              'x-rapidapi-host' => ENV['X_RAPIDAPI_HOST']
+            }
+          )
+          .to_return(status: 200, body: valid_response)
+      end
+
+      it 'returns parsed JSON response' do
+        response = described_class.fetch(search_term)
+        expect(response).to eq({"key" => "value"})
+      end
+    end
+
+    context 'when search term is nil or empty' do
+      it 'raises an ArgumentError' do
+        expect { described_class.fetch(nil) }.to raise_error(ArgumentError, /Search term cannot be nil or empty/)
+        expect { described_class.fetch('') }.to raise_error(ArgumentError, /Search term cannot be nil or empty/)
+      end
+    end
+  end
+end

data/spec/prices_spec.rb

@@ -0,0 +1,42 @@
+require 'debug'
+require 'spec_helper'
+require 'webmock/rspec'
+require './lib/latest_stock_price/prices'
+
+RSpec.describe LatestStockPrice::Prices do
+  let(:symbols) { ['AAATECH.NS', 'AADHHOUS.NS'] }
+  let(:uri) { URI("https://latest-stock-price.p.rapidapi.com/equities-enhanced?Symbols=#{URI.encode_www_form_component(symbols.join(','))}") }
+  let(:valid_response) { { "key" => "value" }.to_json }
+
+  before do
+    ENV['X_RAPIDAPI_KEY'] = 'dummy_key'
+    ENV['X_RAPIDAPI_HOST'] = 'dummy_host'
+  end
+
+  describe '.fetch' do
+    context 'when symbols are valid' do
+      before do
+        stub_request(:get, uri)
+          .with(
+            headers: {
+              'x-rapidapi-key' => ENV['X_RAPIDAPI_KEY'],
+              'x-rapidapi-host' => ENV['X_RAPIDAPI_HOST']
+            }
+          )
+          .to_return(status: 200, body: valid_response)
+      end
+
+      it 'returns parsed JSON response' do
+        response = described_class.fetch(symbols)
+        expect(response).to eq({"key" => "value"})
+      end
+    end
+
+    context 'when symbols are nil or empty' do
+      it 'raises an ArgumentError' do
+        expect { described_class.fetch(nil) }.to raise_error(ArgumentError, /Search term cannot be nil or empty/)
+        expect { described_class.fetch([]) }.to raise_error(ArgumentError, /Search term cannot be nil or empty/)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,98 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  # https://rspec.info/features/3-12/rspec-core/configuration/zero-monkey-patching-mode/
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: latest_stock_price
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ciever Hassan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.19.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.19.1
+- !ruby/object:Gem::Dependency
+  name: net-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: A simple hello world gem
+email: ciever.a.h@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- latest_stock_price.gemspec
+- lib/latest_stock_price/http_client.rb
+- lib/latest_stock_price/latest_stock_price.rb
+- lib/latest_stock_price/price.rb
+- lib/latest_stock_price/price_all.rb
+- lib/latest_stock_price/prices.rb
+- lib/latest_stock_price/version.rb
+- sample.env
+- spec/http_client_spec.rb
+- spec/price_all_spec.rb
+- spec/price_spec.rb
+- spec/prices_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ciever/latest_stock_price
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Latest stock price
+test_files: []