Merge pull request #10 from nathanramoscfa/dev

Update tests

CHANGELOG.md

@@ -7,6 +7,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 
 ## [Unreleased]
 - Asynchronous functionality for enhanced performance (planned).
+- Refactoring of codebase for improved maintainability (planned).
+
+## [0.1.3] - 2024-01-10
+
+### Updated
+
+- Updated tests to improve test coverage. 
+- Added downloads and platforms badges to README.md and index.rst.
 
 ## [0.1.2] - 2024-01-10
 

README.md

@@ -8,6 +8,8 @@
 [![Documentation Status](https://readthedocs.org/projects/coingeckoapi/badge/?version=latest)](https://coingeckoapi.readthedocs.io/en/latest/?badge=latest)
 ![PyPI](https://img.shields.io/pypi/v/pycgapi)
 ![Python Version](https://img.shields.io/pypi/pyversions/pycgapi)
+[![Downloads](https://static.pepy.tech/badge/pycgapi)](https://pepy.tech/project/pycgapi)
+![Platforms](https://img.shields.io/badge/Platforms-win--64-orange.svg?style=flat-square)
 
 ## Table of Contents
 1. [Overview](#overview)

__version__.py

@@ -1 +1 @@
-__version__ = '0.1.2'
+__version__ = '0.1.3'

docs/source/index.rst

@@ -34,6 +34,11 @@
 .. image:: https://img.shields.io/pypi/pyversions/pycgapi
    :target: https://pypi.org/project/pycgapi/
 
+.. image:: https://static.pepy.tech/badge/pycgapi
+   :target: https://pepy.tech/project/pycgapi
+
+.. image:: https://img.shields.io/badge/Platforms-win--64-orange.svg?style=flat-square
+   :target: https://www.python.org
 
 Table of Contents
 =================

tests/test_api.py

@@ -86,6 +86,27 @@ def test_get_simple_prices_by_id(self, mock_get):
         expected_df_crypto = pd.DataFrame.from_dict(mock.simple_price_response, orient='index')
         pd.testing.assert_frame_equal(df_crypto, expected_df_crypto)
 
+    # ---------- /simple/price?precision=2 ---------- #
+    @patch('requests.Session.get')
+    def test_get_simple_prices_by_id_with_precision(self, mock_get):
+        """Test fetching simple prices for cryptocurrencies."""
+        # Prepare mock responses
+        mock_get.side_effect = [MagicMock(json=lambda: mock.simple_price_response)]
+
+        # Test cryptocurrency prices with precision
+        precision = '2'
+        df_crypto = self.api.simple_prices(coin_ids=['bitcoin'], vs_currencies=['usd'], precision=precision)
+
+        # Modify the expected response based on the precision
+        expected_response_modified = {
+            'bitcoin': {
+                'usd': round(mock.simple_price_response['bitcoin']['usd'], int(precision))
+            }
+        }
+        expected_df_crypto = pd.DataFrame.from_dict(expected_response_modified, orient='index')
+
+        pd.testing.assert_frame_equal(df_crypto, expected_df_crypto)
+
     # ---------- /simple/token_price/{platform_id} ---------- #
     @patch('requests.Session.get')
     def test_get_simple_prices_by_contract(self, mock_get):
@@ -335,6 +356,24 @@ def test_coin_ohlc_data(self, mock_get):
             self.assertEqual(ohlc_df.iloc[i]['Low'], row[3])
             self.assertEqual(ohlc_df.iloc[i]['Close'], row[4])
 
+    # ---------- /coins/{id}/ohlc?precision=2 ---------- #
+    @patch('requests.Session.get')
+    def test_coin_ohlc_data_with_precision(self, mock_get):
+        """Test fetching OHLC data for a specific coin with precision."""
+        # Mock the API response
+        mock_response = MagicMock()
+        mock_response.json.return_value = mock.coins_id_ohlc_response
+        mock_get.return_value = mock_response
+
+        # Call the method with precision
+        precision = '2'  # example precision value
+        ohlc_df = self.api.coin_ohlc_data('bitcoin', precision=precision)
+
+        # Assert that the precision parameter was passed correctly
+        args, kwargs = mock_get.call_args
+        self.assertTrue('precision' in kwargs['params'])
+        self.assertEqual(kwargs['params']['precision'], precision)
+
     # ---------- /coins/{id}/ohlc for multiple tickers ---------- #
     @patch.object(CoinGeckoAPI, 'coin_ohlc_data')
     def test_multiple_coins_ohlc_data(self, mock_get):
@@ -379,20 +418,27 @@ def test_coin_by_contract(self, mock_get):
     # or
     # ---------- /coins/{id}/contract/{contract_address}/market_chart/range ---------- #
     @patch('requests.Session.get')
-    def test_contract_historical_market_data_by_days(self, mock_get):
+    def test_contract_historical_market_data_by_days_with_precision(self, mock_get):
         """Test fetching historical market data for a token from its contract address."""
         platform_id = "ethereum"
         contract_address = "0x5a98fcbea516cf06857215779fd812ca3bef1b32"
         vs_currency = "usd"
         days = "max"
+        precision = "2"
 
         # Mock response
         mock_response = MagicMock()
         mock_response.json.return_value = mock.coins_contract_address_market_chart_response
         mock_get.return_value = mock_response
 
         # Call the method
-        historical_data_df = self.api.contract_historical_market_data(platform_id, contract_address, vs_currency, days)
+        historical_data_df = self.api.contract_historical_market_data(
+            platform_id,
+            contract_address,
+            vs_currency,
+            days,
+            precision=precision
+        )
 
         # Check DataFrame structure
         expected_columns = ['price', 'market_cap', 'total_volume']
@@ -404,6 +450,11 @@ def test_contract_historical_market_data_by_days(self, mock_get):
         mock_first_row = mock.coins_contract_address_market_chart_response['prices'][0]
         self.assertEqual(first_row['price'], mock_first_row[1])
 
+        # Assert that the precision parameter was passed correctly
+        args, kwargs = mock_get.call_args
+        self.assertTrue('precision' in kwargs['params'])
+        self.assertEqual(kwargs['params']['precision'], precision)
+
     # ---------- coins/{id}/contract/{contract_address}/market_chart ---------- #
     # or
     # ---------- coins/{id}/contract/{contract_address}/market_chart/range ---------- #
@@ -855,6 +906,11 @@ def test_nft_collection_info_by_platform_and_contract(self, mock_get):
         nft_collection_df = self.api.nft_collection_info(asset_platform_id=asset_platform_id,
                                                          contract_address=contract_address)
 
+        # Add assertions to ensure the mock was called with the correct endpoint
+        expected_endpoint = f'nfts/{asset_platform_id}/contract/{contract_address}'
+        args, kwargs = mock_get.call_args
+        self.assertIn(expected_endpoint, args[0])
+
         # Verify DataFrame structure
         self.assertIsInstance(nft_collection_df, pd.DataFrame)
         self.assertTrue('id' in nft_collection_df.index.name)  # Verify 'id' is the index name
@@ -880,6 +936,16 @@ def test_nft_collection_info_by_platform_and_contract(self, mock_get):
                 # For non-dictionary type values, directly compare the value
                 self.assertEqual(nft_collection_data[key], value)
 
+    @patch('requests.Session.get')
+    def test_nft_collection_info_invalid_arguments(self, mock_get):
+        """Test fetching NFT collection data with invalid arguments."""
+        with self.assertRaises(ValueError):
+            # Call without necessary arguments
+            self.api.nft_collection_info()
+
+        # Verify that the API was not called
+        mock_get.assert_not_called()
+
     # ---------- /nfts/{id} for multiple coin ids ---------- #
     @patch('pycgapi.CoinGeckoAPI.nft_collection_info')
     def test_nft_collections_info(self, mock_nft_collection_info):
@@ -939,6 +1005,27 @@ def test_nft_collections_info(self, mock_nft_collection_info):
         with self.assertRaises(ValueError):
             self.api.nft_collections_info()
 
+    @patch('pycgapi.CoinGeckoAPI.nft_collection_info')
+    def test_nft_collections_info_with_empty_data(self, mock_nft_collection_info):
+        """Test fetching current data for multiple NFT collections with no valid data."""
+
+        # Mock responses for each NFT ID
+        nft_ids = ['invalid-nft1', 'invalid-nft2']
+        mock_responses = {
+            'invalid-nft1': {},  # Empty dict to simulate no data
+            'invalid-nft2': {}  # Empty dict to simulate no data
+        }
+
+        # Configure the mock to return an empty DataFrame for each invalid ID
+        mock_nft_collection_info.side_effect = lambda *args, **kwargs: pd.DataFrame(
+            [mock_responses.get(kwargs['nft_id'], {})])
+
+        # Test with invalid nft_ids
+        empty_nft_collections_df = self.api.nft_collections_info(nft_ids=nft_ids)
+
+        # Verify that the resulting DataFrame is empty
+        self.assertTrue(empty_nft_collections_df.empty)
+
     # ---------- EXCHANGE RATES ---------- #
 
     # ---------- /exchange_rates ---------- #