Merge pull request #2 from ravigadila/converter

Converter

Author: Ravi kumar

README.md

@@ -1 +1,76 @@
-# forex-python
+forex-python
+============
+
+Foreign exchange rates and currency conversion.
+
+Features:
+---------
+- List all currency rates.
+- Get historical rates for any day since 1999.
+- Conversion rate for one Currency(ex; USD to INR).
+- Convert amount from one currency to other.('USD 10$' to INR)
+
+Currency Source:
+---------------
+Fixer.io is a free API for current and historical foreign exchange rates published by European Central Bank.
+The rates are updated daily 3PM CET.
+
+Installation:
+------------
+
+Install using python package
+```
+$ pip install forex-python
+```
+
+Or directly cloning the repo:
+```
+$ python setup.py install
+```
+
+Examples:
+------------------
+
+Initialize class
+```python
+>>> from forex_python.converter import CurrencyRates
+>>> c = CurrencyRates()
+```
+
+list all latest currency rates for "USD"
+```python
+>>> c.get_rates('USD')
+{u'IDR': 13625.0, u'BGN': 1.7433, u'ILS': 3.8794, u'GBP': 0.68641, u'DKK': 6.6289, u'CAD': 1.3106, u'JPY': 110.36, u'HUF': 282.36, u'RON': 4.0162, u'MYR': 4.081, u'SEK': 8.3419, u'SGD': 1.3815, u'HKD': 7.7673, u'AUD': 1.3833, u'CHF': 0.99144, u'KRW': 1187.3, u'CNY': 6.5475, u'TRY': 2.9839, u'HRK': 6.6731, u'NZD': 1.4777, u'THB': 35.73, u'EUR': 0.89135, u'NOK': 8.3212, u'RUB': 66.774, u'INR': 67.473, u'MXN': 18.41, u'CZK': 24.089, u'BRL': 3.5473, u'PLN': 3.94, u'PHP': 46.775, u'ZAR': 15.747}
+```
+
+Get Conversion rate from USD to INR
+```python
+>>> c.get_rate('USD', 'INR')
+67.473
+```
+
+Convert amount from USD to INR:
+```python
+>>> c.convert('USD', 'INR', 10)
+674.73
+```
+
+Convert amount from USD to INR based on 2010-03-01 rates
+```python
+>>> import datetime
+>>> date_obj = datetime.datetime.strptime('2010-05-10', "%Y-%m-%d").date()
+>>> c.convert('EUR', 'USD', 10, date_obj)
+12.969
+```
+
+RatesNotAvailableError for invalid currency codes and missing currency code from source:
+```python
+    >>> c.get_rate('XYZ', 'INR')
+    Traceback (most recent call last):
+    RatesNotAvailableError: Currency XYZ => INR rate not available for Date latest.
+```
+
+Compleate [Documentation](http://forex-python.readthedocs.org/en/latest/?badge=latest)
+
+We welcome your feedback and support. found bug raise github issue.
+

forex-python/__init__.py docs/__init__.pyforex-python/__init__.py renamed to docs/__init__.py

@@ -2,13 +2,6 @@
 import datetime
 
 
-class RateNotFoundError(Exception):
-    """
-    Custom exception when conversion rate not found for given Country
-    """
-    pass
-
-
 class RatesNotAvailableError(Exception):
     """
     Custome Exception when http://fixer.io/ is Down are not available for currency rates
@@ -24,20 +17,20 @@ def __init__(self):
     def _source_url(self):
         return "http://api.fixer.io/"
 
-    def _get_date_string(self, date_str):
-        if date_str is None:
+    def _get_date_string(self, date_obj):
+        if date_obj is None:
             return 'latest'
         try:
-            datetime.datetime.strptime(date_str, '%Y-%m-%d')
+            date_str = date_obj.strftime('%Y-%m-%d')
             return date_str
         except ValueError:
-            raise ValueError("Incorrect date String, date_str should be YYYY-MM-DD")
+            raise ValueError("Incorrect date String, date should be YYYY-MM-DD")
 
 
 class CurrencyRates(Common):
 
-    def get_rates(self, base_cur, date_str=None):
-        date_str = self._get_date_string(date_str)
+    def get_rates(self, base_cur, date_obj=None):
+        date_str = self._get_date_string(date_obj)
         payload = {'base': base_cur}
         source_url = self._source_url() + date_str
         response = requests.get(source_url, params=payload)
@@ -46,8 +39,8 @@ def get_rates(self, base_cur, date_str=None):
             return rates
         raise RatesNotAvailableError("Currency Rates Source Not Ready")
 
-    def get_rate(self, base_cur, dest_cur, date_str=None):
-        date_str = self._get_date_string(date_str)
+    def get_rate(self, base_cur, dest_cur, date_obj=None):
+        date_str = self._get_date_string(date_obj)
         payload = {'base': base_cur, 'symbols': dest_cur}
         source_url = self._source_url() + date_str
         response = requests.get(source_url, params=payload)
@@ -59,8 +52,8 @@ def get_rate(self, base_cur, dest_cur, date_str=None):
             return rate
         raise RatesNotAvailableError("Currency Rates Source Not Ready")
 
-    def convert(self, base_cur, dest_cur, amount, date_str=None):
-        date_str = self._get_date_string(date_str)
+    def convert(self, base_cur, dest_cur, amount, date_obj=None):
+        date_str = self._get_date_string(date_obj)
         payload = {'base': base_cur, 'symbols': dest_cur}
         source_url = self._source_url() + date_str
         response = requests.get(source_url, params=payload)

forex_python/__init__.py

@@ -0,0 +1,37 @@
+from setuptools import setup, find_packages
+
+VERSION = 0.1
+
+with open('README.md') as fl:
+    LONG_DESCRIPTION = fl.read()
+
+with open('LICENSE') as fl:
+    LICENSE = fl.read()
+
+setup(
+    name='forex-python',
+    version=VERSION,
+    author='Micro Pyramid Informatic Pvt. Ltd.',
+    author_email='hello@micropyramid.com',
+    url='https://github.com/MicroPyramid/forex-python',
+    description='Foreign exchange rates and currency conversion.',
+    long_description=LONG_DESCRIPTION,
+    license=LICENSE,
+    packages=find_packages(exclude=['tests', 'tests.*']),
+    include_package_data=True,
+    install_requires=[
+        'requests',
+    ],
+    classifiers=[
+        'Intended Audience :: Developers',
+        'Operating System :: OS Independent',
+        'License :: OSI Approved :: MIT License',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.2',
+        'Programming Language :: Python :: 3.3',
+        'Programming Language :: Python :: 3.4',
+        'Topic :: Software Development :: Internationalization',
+    ],
+)

forex-python/converter.py forex_python/converter.pyforex-python/converter.py renamed to forex_python/converter.py

@@ -0,0 +1,68 @@
+from unittest import TestCase
+from forex_python.converter import CurrencyRates
+
+
+class TestBase(TestCase):
+    def setUp(self):
+        c = CurrencyRates()
+
+
+class TestGetRates(TestBase):
+    """
+    Test get_rates with valid(ex: USD) and invalid(ex: XYZ) currency code
+    """
+    def test_get_rates_valid_code(self):
+        all_rates = c.get_rates('USD')
+
+        # Check if return value of get_rates dictionary
+        self.assertTrue(isinstance(all_rates, dict))
+
+        # Test at least one rate value returned
+        self.assertTrue(len(all_rates.keys()))
+
+        # Test one rate in returned dict is float value
+        self.assertTrue(isinstance(all_rates.get('INR'), float))
+
+    def test_get_rates_invalid_code(self):
+        all_rates = c.get_rates('XYZ')
+
+        # Check if return value of get_rates dictionary
+        self.assertTrue(isinstance(all_rates, dict))
+
+        # Test no values in dict(empty dict)
+        self.assertFalse(len(all_rates.keys()))
+
+        # Test one rate in returned dict is not float value
+        self.assertFalse(isinstance(all_rates.get('INR'), float))
+
+
+class TestGetRate(TestBase):
+    """
+    Test get_rate function using valid and invalid currency codes
+    """
+
+    def test_get_rate_with_valid_codes(self):
+        rate = c.get_rate(self, 'USD', 'INR')
+
+        # check if return value is float
+        self.assertTrue(isinstance(rate, float))
+
+    def test_get_rate_with_invalid_codes(self):
+        # raise exception for invalid currency codes
+        self.assertRaises(RatesNotAvailableError, c.get_rate(self, 'ABCD', 'XYZ'))
+
+
+class TestAmountConvert(TestBase):
+    """
+    test amount conversion from one currency to other
+    """
+
+    def test_amount_convert_valid_currency(self):
+        amount = c.convert('USD', 'INR', 10)
+
+        # test if amount returned in float
+        self.assertTrue(isinstance(amount, float))
+
+    def test_amount_convert_valid_currency(self):
+        # test if amount returned in float
+        self.assertRaises(RateNotFoundError, c.convert('ABC, 'XYZ', 10))