added *~ to .gitignore, simple edit to const.py variable names, finished

Type and Value Errors on newsapi_client.py

Author: bantaisaiah

.gitignore

@@ -6,3 +6,4 @@ dist/
 *.rst
 venv/
 *log.txt
+*~

newsapi/const.py

@@ -0,0 +1,13 @@
+TOP_HEADLINES_URL = 'https://newsapi.org/v2/top-headlines'
+EVERYTHING_URL = 'https://newsapi.org/v2/everything'
+SOURCES_URL = 'https://newsapi.org/v2/sources'
+
+countries = {'ae','ar','at','au','be','bg','br','ca','ch','cn','co','cu','cz','de','eg','fr','gb','gr','hk',
+             'hu','id','ie','il','in','it','jp','kr','lt','lv','ma','mx','my','ng','nl','no','nz','ph','pl',
+             'pt','ro','rs','ru','sa','se','sg','si','sk','th','tr','tw','ua','us','ve','za'}
+
+languages = {'ar','en','cn','de','es','fr','he','it','nl','no','pt','ru','sv','ud'}
+
+categories = {'business', 'entertainment', 'general', 'health', 'science', 'sports', 'technology'}
+
+sort_method = {'relevancy','popularity','publishedAt'}

newsapi/newsapi_client.py

@@ -1,73 +1,141 @@
 import requests
 from newsapi.newsapi_auth import NewsApiAuth
+from newsapi import const
 
 
 class NewsApiClient(object):
 
-    def __init__(self, api_key, api_url='https://newsapi.org/v2/'):
-        self.url = api_url.rstrip('/')
+    def __init__(self, api_key):
         self.auth = NewsApiAuth(api_key=api_key)
 
     def get_top_headlines(self, q=None, sources=None, language=None, country=None, category=None, page_size=None,
                           page=None):
         """
-            Returns live top and breaking headlines for a country, specific category in a country, single source, or multiple 				sources..
+            Returns live top and breaking headlines for a country, specific category in a country, single source, or multiple sources..
             
             Optional parameters:
-                (str) q - return headlines w/ specified coin! Valid values are:
-                            'bitcoin', 'etheremum', 'ripple', 'bitcoin cash', etc.
+                (str) q - return headlines w/ specific keyword or phrase. For example:
+                          'bitcoin', 'trump', 'tesla', 'ethereum', etc.
                             
                 (str) sources - return headlines of news sources! some Valid values are:
-                            'bbc-news', 'the-verge', 'abc-news', 'crypto coins news',
-                            'ary news','associated press','wired','aftenposten','australian financial review','axios',
-							'bbc news','bild','blasting news','bloomberg','business insider','engadget','google news',
-							'hacker news','info money,'recode','techcrunch','techradar','the next web','the verge' etc.
+                                'bbc-news', 'the-verge', 'abc-news', 'crypto coins news',
+                                'ary news','associated press','wired','aftenposten','australian financial review','axios',
+				'bbc news','bild','blasting news','bloomberg','business insider','engadget','google news',
+				'hacker news','info money,'recode','techcrunch','techradar','the next web','the verge' etc.
 							
-				(str) language - The 2-letter ISO-639-1 code of the language you want to get headlines for. Valid values are:
-								'ar','de','en','es','fr','he','it','nl','no','pt','ru','se','ud','zh'
+		(str) language - The 2-letter ISO-639-1 code of the language you want to get headlines for. Valid values are:
+				 'ar','de','en','es','fr','he','it','nl','no','pt','ru','se','ud','zh'
                             
                 (str) country - The 2-letter ISO 3166-1 code of the country you want to get headlines! Valid values are:
-                                'ae','ar','at','au','be','bg','br','ca','ch','cn','co','cu','cz','de','eg','fr','gb','gr',    									'hk','hu','id','ie','il','in','it','jp','kr','lt','lv','ma','mx','my','ng','nl','no','nz','ph' 									'pl','pt','ro','rs','ru','sa','se','sg','si','sk','th','tr','tw','ua','us'
+                                'ae','ar','at','au','be','bg','br','ca','ch','cn','co','cu','cz','de','eg','fr','gb','gr',    									
+                                'hk','hu','id','ie','il','in','it','jp','kr','lt','lv','ma','mx','my','ng','nl','no','nz',
+                                'ph','pl','pt','ro','rs','ru','sa','se','sg','si','sk','th','tr','tw','ua','us'
 								
-				(str) category - The category you want to get headlines for! Valid values are:
-								'business','entertainment','general','health','science','sports','technology'
+		(str) category - The category you want to get headlines for! Valid values are:
+				 'business','entertainment','general','health','science','sports','technology'
 								
-				(int) page_size - The number of results to return per page (request). 20 is the default, 100 is the maximum. 
+		(int) page_size - The number of results to return per page (request). 20 is the default, 100 is the maximum. 
 								
-				(int) page - Use this to page through the results if the total results found is greater than the page size.										
+		(int) page - Use this to page through the results if the total results found is greater than the page size.									
         """
 
         # Define Payload
         payload = {}
-        payload['q'] = q
-        payload['sources'] = sources
-        payload['language'] = language
-        payload['country'] = country
-        payload['category'] = category
-        payload['pageSize'] = page_size
-        payload['page'] = page
+
+        # Keyword/Phrase
+        if q is not None:
+            if type(q) == str:
+                payload['q'] = q
+            else:
+                raise TypeError('keyword/phrase q param should be a str')
+
+        # Sources 
+        if (country is not None) or (category is not None):
+            raise ValueError('cannot mix country/category param with sources param.')
+        else:
+            if type(sources) == str:
+                payload['sources'] = sources 
+            else:
+                raise TypeError('sources param should be a str')
+
+        # Language 
+        if language is not None:
+            if type(language) == str:
+                if language in const.languages:
+                    payload['language'] = language
+                else:
+                    raise ValueError('invalid language')
+            else: 
+                raise TypeError('language param should be a string')
+
+        # Country
+        if country is not None:
+            if type(country) == str:
+                if country in const.countries: 
+                    payload['country'] = country
+                else:
+                    raise ValueError('invalid country')
+            else:
+                raise TypeError('country param should be a string') 
+        
+        # Category
+        if category is not None:
+            if type(category) == str:
+                if category in const.categories:
+                    payload['category'] = category
+                else:
+                    raise ValueError('invalid category')
+            else:
+                raise TypeError('category param should be a string')
+        
+        # Page Size
+        if page_size is not None:
+            if type(page_size) == int:
+                if page_size >= 0 and page_size <= 100:
+                    payload['pageSize'] = page_size
+                else:
+                    raise ValueError('page_size param should be an int between 1 and 100')
+            else:
+                raise TypeError('page_size param should be an int')
+
+        # Page
+        if page is not None:
+            if type(page) == int:
+                if page > 0:
+                    payload['page'] = page
+                else:
+                    raise ValueError('page param should be an int greater than 0')
+            else:
+                raise TypeError('page param should be an int')
 
         # Send Request
-        r = requests.get(self.url + '/top-headlines', auth=self.auth, timeout=30, params=payload)
+        r = requests.get(const.TOP_HEADLINES_URL, auth=self.auth, timeout=30, params=payload)
+
+        # Check Status of Request
+        if r.status_code != requests.codes.ok:
+            raise NewsAPIException(r.json())
+
         return r.json()
 
-    def get_everything(self, q=None, sources=None, domains=None, from_parameter=None, to=None, language=None,
+    def get_everything(self, q=None, sources=None, domains=None, from_param=None, to_param=None, language=None,
                        sort_by=None, page=None, page_size=None):
-	"""
+        """
             Search through millions of articles from over 5,000 large and small news sources and blogs.
             
             Optional parameters:
                 (str) q - return headlines w/ specified coin! Valid values are:
-                            'bitcoin', 'etheremum', 'ripple', 'bitcoin cash', etc.
+                            'bitcoin', 'trump', 'tesla', 'ethereum', etc
                             
                 (str) sources - return headlines of news sources! some Valid values are:
                             'bbc-news', 'the-verge', 'abc-news', 'crypto coins news',
                             'ary news','associated press','wired','aftenposten','australian financial review','axios',
 			    'bbc news','bild','blasting news','bloomberg','business insider','engadget','google news',
 		  	    'hacker news','info money,'recode','techcrunch','techradar','the next web','the verge' etc.
 							
-		(str) domains - A comma-seperated string of domains (eg bbc.co.uk, techcrunch.com, engadget.com) to restrict the 								search to. 
-		(str) from_parameter - A date and optional time for the oldest article allowed.(e.g. 2018-03-05 or 													2018-03-05T03:46:15)
+		(str) domains - A comma-seperated string of domains (eg bbc.co.uk, techcrunch.com, engadget.com) to restrict the search to. 
+
+		(str) from_parameter - A date and optional time for the oldest article allowed.
+                                       (e.g. 2018-03-05 or 2018-03-05T03:46:15)
 				
 		(str) to - A date and optional time for the newest article allowed.
 							
@@ -78,37 +146,131 @@ def get_everything(self, q=None, sources=None, domains=None, from_parameter=None
 				'relevancy'
 								
 		(int) page_size - The number of results to return per page (request). 20 is the default, 100 is the maximum.		
-		(int) page - Use this to page through the results if the total results found is greater than the page size.										
+
+		(int) page - Use this to page through the results if the total results found is greater than the page size.									
         """
 
         # Define Payload
         payload = {}
-        payload['q'] = q
-        payload['sources'] = sources
-        payload['domains'] = domains
-        payload['from'] = from_parameter
-        payload['to'] = to
-        payload['language'] = language
-        payload['sortBy'] = sort_by
-        payload['page'] = page
-        payload['pageSize'] = page_size
+
+        # Keyword/Phrase
+        if q is not None:
+            if type(q) == str:
+                payload['q'] = q
+            else:
+                raise TypeError('keyword/phrase q param should be a str')
+ 
+        # Sources 
+        if (country is not None) or (category is not None):
+            raise ValueError('cannot mix country or category param with sources param.')
+        else:
+            if type(sources) == str:
+                payload['sources'] = sources
+            else:
+                raise TypeError('sources param should be a str')
+       
+        # Domains To Search
+        if domains is not None:
+            if type(domains) == str:
+                payload['domains'] = domains
+            else:
+                raise TypeError('domains param should be a string')
+
+        # Search From This Date ... 
+        if from_param is not None:
+            if type(from_param) == str:
+                if (len(from_param)) >= 10:
+                    for i in range(len(from_param)):
+                        if (i == 4 and from_param[i] != '-') or (i == 7 and from_param[i] != '-'):
+                            raise ValueError('from_param should be in the format of YYYY-MM-DD')
+                        else:
+                            payload['from'] = from_param
+                else:
+                    raise ValueError('from_param should be in the format of YYYY-MM-DD')
+            else:
+                raist TypeError('from_param should be a string')
+
+        # ... To This Date 
+        if to_param is not None:
+            if type(to_param) == str:
+                if (len(to_param)) >= 10:
+                    for i in range(len(to_param)):
+                        if (i == 4 and to_param[i] != '-') or (i == 7 and to_param[i] != '-'):
+                            raise ValueError('to_param should be in the format of YYYY-MM-DD')
+                        else:
+                            payload['to'] = to_param
+                else:
+                    raise ValueError('to_param should be in the format of YYYY-MM-DD')
+            else:
+                raist TypeError('to_param should be a string')
+
+
+        # Language
+        if language is not None:
+            if type(language) == str:
+                if language is not in const.languages:
+                    raise ValueError('invalid language')
+                else:
+                    payload['language'] = language
+            else:
+                raise TypeError('language param should be a string')
+            
+
+        # Sort Method
+        if sort_by is not None:
+            if type(sort_by) == str:
+                if sort_by in const.sort_method:
+                    payload['sortBy'] = sort_by
+                else:
+                    raise ValueError('invalid sort')
+            else:
+                raise TypeError('sort_by param should be a string')
+          
+        # Page Size
+        if page_size is not None:
+            if type(page_size) == int:
+                if page_size >= 0 and page_size <= 100:
+                    payload['pageSize'] = page_size
+                else:
+                    raise ValueError('page_size param should be an int between 1 and 100')
+            else:
+                raise TypeError('page_size param should be an int')
+
+        # Page
+        if page is not None:
+            if type(page) == int:
+                if page > 0:
+                    payload['page'] = page
+                else:
+                    raise ValueError('page param should be an int greater than 0')
+            else:
+                raise TypeError('page param should be an int')
+
 
         # Send Request
-        r = requests.get(self.url + '/everything', auth=self.auth, timeout=30, params=payload)
+        r = requests.get(const.EVERYTHING_URL, auth=self.auth, timeout=30, params=payload)
+
+        #Check Status of Request
+        if r.status_code != requests.codes.ok:
+            raise NewsAPIException(r.json())
+
         return r.json()
 
     def get_sources(self, category=None, language=None, country=None):
-					   
-	"""
+        """
             Returns the subset of news publishers that top headlines...
             
             Optional parameters:
+                (str) category - The category you want to get headlines for! Valid values are:
+				 'business','entertainment','general','health','science','sports','technology'
 			
 		(str) language - The 2-letter ISO-639-1 code of the language you want to get headlines for. Valid values are:
 				'ar','de','en','es','fr','he','it','nl','no','pt','ru','se','ud','zh'
                             
                 (str) country - The 2-letter ISO 3166-1 code of the country you want to get headlines! Valid values are:
-                                'ae','ar','at','au','be','bg','br','ca','ch','cn','co','cu','cz','de','eg','fr','gb','gr',    									'hk','hu','id','ie','il','in','it','jp','kr','lt','lv','ma','mx','my','ng','nl','no','nz','ph' 									'pl','pt','ro','rs','ru','sa','se','sg','si','sk','th','tr','tw','ua','us'
+                                'ae','ar','at','au','be','bg','br','ca','ch','cn','co','cu','cz','de','eg','fr','gb','gr',    									
+                                'hk','hu','id','ie','il','in','it','jp','kr','lt','lv','ma','mx','my','ng','nl','no','nz',
+                                'ph','pl','pt','ro','rs','ru','sa','se','sg','si','sk','th','tr','tw','ua','us'
 								
 				(str) category - The category you want to get headlines for! Valid values are:
 						'business','entertainment','general','health','science','sports','technology'
@@ -117,13 +279,43 @@ def get_sources(self, category=None, language=None, country=None):
 
         # Define Payload
         payload = {}
-        payload['category'] = category
-        payload['language'] = language
-        payload['country'] = country
+
+        # Language
+        if language is not None:
+            if type(language) == str:
+                if language in const.languages:
+                    payload['language'] = language
+                else:
+                    raise ValueError('invalid language')
+            else: 
+                raise TypeError('language param should be a string')
+
+        # Country
+        if country is not None:
+            if type(country) == str:
+                if country in const.countries: 
+                    payload['country'] = country
+                else:
+                    raise ValueError('invalid country')
+            else:
+                raise TypeError('country param should be a string') 
+
+        # Category
+        if category is not None:
+            if type(category) == str:
+                if category in const.categories:
+                    payload['category'] = category
+                else:
+                    raise ValueError('invalid category')
+            else:
+                raise TypeError('category param should be a string')
 
         # Send Request
-        r = requests.get(self.url + '/sources', auth=self.auth, timeout=30, params=payload)
-        return r.json()
+        r = requests.get(const.SOURCES_URL, auth=self.auth, timeout=30, params=payload)
 
+        # Check Status of Request
+        if r.status_code != requests.codes.ok:
+            raise NewsAPIException(r.json())
 
+        return r.json()