latest_stock_price 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 778aa58d46b698c7ab1c11decce31b6f2689f452f020de2af52ffab4db1f84a4
-  data.tar.gz: 5db44299e9edc950fb50b47811b1a547245689335e52e2e5c92caa4af9402da8
+  metadata.gz: d377217932b62d05641a3a36e5296a20a9d7d086f2f8f4ea583f1f9f94455b86
+  data.tar.gz: 7793e6dc8cacecb53e95c3aa8bb222d2f99784287f90c88292c668f2dddaa216
 SHA512:
-  metadata.gz: ed3f4a9ff4eb85af61610f104c1cb0b6e03f478fc5617e3b2e3f8be6a04544c322dd11dcfca2c7b16a37e45143e9ad55c5dad3c3638b296d7a085e0c40117fc4
-  data.tar.gz: 83a87189ae8f73ab38792d3eff836f38842ace39740d596402e47c78a0ce50d8b9c2513144fda955a4f047db3bd94a6306bc86c981db88ebfd4965068ce55f4c
+  metadata.gz: bd7fe94714ae4a00a1a149e73cccd031eda5c78345fb45a050e7239c60618db20f62bde7e7f2dc206711e34dd8cea6ebae108a5539d14b49d2aa8a166ae013b2
+  data.tar.gz: 3ac1fe455437935ee115c3ec2d3daf204d67a1c965fb6d82c5f36f0f8d7415a1c27f446ac97bebef86b4ddd1b25fabcd209d4dc9766a4622bdde838194d8cdc7

data/CHANGELOG.md

@@ -6,4 +6,9 @@
 
 ## 1.0.1 (29-Oct-24)
 
-* Fix Folder structure
+* Fix Folder structure
+
+## 1.0.2 (29-Oct-24)
+
+* Fix README.md
+* Removed redundant `.env` file.

data/README.md

@@ -1,23 +1,108 @@
-## Read Me 
 
+### Setup
 
-## Setup
+If you don’t already have bundle, then run this in your project directory (where you’d like to use this gem): 
+
+#### 1. Add The Gem 
+
+``` 
+bundle init
+```
+
+This will add a **Gemfile** to your project directory.
+
+Inside the gem file, add the gem and dependencies like so:
+
+```
+gem 'latest_stock_price', ‘1.0.1’        # Ensure to use version 1.0.1 or above.
+gem 'dotenv', '~> 3.0.0'                 # Dependency required. 
+```
+
+To install the gems, run:
 
 ```
 bundle install
 ```
 
-#### Create Your Environment Variables File
-Copy the sample.env file to create your local .env file:
+#### 2. Configure Credentials
+
+This gem uses APIs from rapidapi.com. Ensure an account is created and gather your secret key after logging in.
+
+In your project directory, create a `.env` file using the following command:
+
+```
+touch .env
+```
+
+Open the newly created `.env` file and add:
+
+```
+# Rapid API credentials
+X_RAPIDAPI_KEY=‘Add_your_rapid_api_key_here’
+X_RAPIDAPI_HOST='latest-stock-price.p.rapidapi.com'
+```
+
+### Example Usage 
+
+As an example, create a new file in you project directory:
+
+```
+touch example.rb
+```
+
+There are 3 ways to interact with the gem:
+
+#### 1. Get all the latest stock prices:
+
+```ruby
+# example.rb
+require 'bundler/setup'
+require 'latest_stock_price'
+
+price_all = LatestStockPrice::PriceAll.fetch
+puts price_all
+```
+
+In your project repository, run the following command to get the prices of all the stocks:
+
+```ruby
+ruby example.rb # should return an object with many stock data
+```
+
+#### 2. Get the latest price of a specific stock:
+
+```ruby
+# example.rb
+require 'bundler/setup'
+require 'latest_stock_price'
+
+price = LatestStockPrice::Price.fetch("AAATECH.NS")
+puts price
+```
+
+In your project repository, run the following command to get the price of a specific stock:
+
+```
+ruby example.rb # should return an object with one stock.
+```
+
+#### 3. Get the latest prices for a specified list of stocks:
+
+```ruby
+# example.rb
+require 'bundler/setup'
+require 'latest_stock_price'
+
+prices = LatestStockPrice::Prices.fetch(['AAATECH.NS', 'AADHHOUS.NS'])
+puts prices
+```
+
+In your project repository, run the following command for a list of the stocks and their data.
 
 ```
-cp sample.env .env
+ruby example.rb # should return an object with the specified stocks.
 ```
 
-#### 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'
+### Warnings
 
-**Note:** To obtain a Rapid APi key, login to your Rapid Api account and find it in the account settings. 
+The `.env` file contains your secret key. Ensure the file does not get committed to remote repositories by adding it to your `.gitignore` file.

data/latest_stock_price.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
     s.name        = "latest_stock_price"
-    s.version     = "1.0.1"
+    s.version     = "1.0.2"
     s.summary     = "Latest stock price"
     s.authors     = ["Ciever Hassan"]
     s.description = "A gem for displaying the latest stock price."
@@ -19,8 +19,7 @@ Gem::Specification.new do |s|
                      "spec/price_all_spec.rb",
                      "spec/price_spec.rb",
                      "spec/prices_spec.rb",
-                     "spec/spec_helper.rb",
-                     "sample.env", 
+                     "spec/spec_helper.rb", 
                      "README.md",
                      "CHANGELOG.md",
                      "Gemfile",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: latest_stock_price
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Ciever Hassan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-28 00:00:00.000000000 Z
+date: 2024-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -111,7 +111,6 @@ files:
 - lib/price_all.rb
 - lib/prices.rb
 - lib/version.rb
-- sample.env
 - spec/http_client_spec.rb
 - spec/price_all_spec.rb
 - spec/price_spec.rb

data/sample.env

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