fix. make the "option_chain" and "historical_option_data" examples work again. issue #99.

Author: westonplatter

examples/historical_option_data.py

@@ -5,6 +5,7 @@
 from fast_arrow import (
     Client,
     Stock,
+    StockMarketdata,
     Option,
     OptionChain,
     OptionMarketdata
@@ -24,18 +25,19 @@
 #
 client = Client(auth_data)
 
+
 #
 # get TLT options
 #
 symbol = "TLT"
-stock = Stock.fetch(client, symbol)
-
-stock_id = stock["id"]
+md = StockMarketdata.quote_by_symbol(client, symbol)
+stock_id = md["instrument"].split("/")[-2]
 oc = OptionChain.fetch(client, stock_id, symbol)
 oc_id = oc["id"]
 next_2_eds = oc['expiration_dates'][0:1]
 ops = Option.in_chain(client, oc_id, expiration_dates=next_2_eds)
 
+
 #
 # get TLT in the middle of the current TLT trading range
 #
@@ -46,6 +48,7 @@
 higher_end = middle + diff
 urls_subset = urls[lower_end:higher_end]
 
+
 #
 # get historical data for TLT options
 #

examples/option_chain.py

@@ -2,7 +2,7 @@
 import json
 from fast_arrow import (
     Client,
-    Stock,
+    StockMarketdata,
     OptionChain,
     Option,
 )
@@ -26,13 +26,13 @@
 # fetch the stock info for TLT
 #
 symbol = "TLT"
-stock = Stock.fetch(client, symbol)
+md = StockMarketdata.quote_by_symbol(client, symbol)
 
 
 #
 # get the TLT option chain info
 #
-stock_id = stock["id"]
+stock_id = md["instrument"].split("/")[-2]
 option_chain = OptionChain.fetch(client, stock_id, symbol)
 option_chain_id = option_chain["id"]
 expiration_dates = option_chain['expiration_dates']

fast_arrow/exceptions.py

@@ -16,6 +16,12 @@ def __init__(self, message, errors=None):
         self.errors = errors
 
 
+class ApiDoesNotSupportError(Exception):
+    def __init__(self, message, errors=None):
+        super().__init__(message)
+        self.errors = errors
+
+
 class TradeExecutionError(Exception):
     def __init__(self, message, errors=None):
         super().__init__(message)

fast_arrow/resources/stock.py

@@ -1,19 +1,24 @@
+from fast_arrow.version import VERSION
+from fast_arrow.exceptions import ApiDoesNotSupportError
 from fast_arrow.resources.stock_marketdata import StockMarketdata
 
+import deprecation
+
 
 class Stock(object):
 
     @classmethod
+    @deprecation.deprecated(
+        deprecated_in="1.0.0",
+        removed_in="1.1",
+        current_version=VERSION,
+        details="Use 'StockMarketdata.quote_by_symbol'")
     def fetch(cls, client, symbol):
-        """
-        fetch data for stock
-        """
-        assert(type(symbol) is str)
-
-        url = ("https://api.robinhood.com/instruments/?symbol={0}".
-               format(symbol))
-        data = client.get(url)
-        return data["results"][0]
+        message = '''
+            Robinhood API seems to not support this endpoint.
+            Use fast_arrow.StockMarketdata.quote_by_symbol
+        '''
+        raise ApiDoesNotSupportError(message)
 
     @classmethod
     def mergein_marketdata_list(cls, client, stocks):
@@ -38,17 +43,14 @@ def mergein_marketdata_list(cls, client, stocks):
         return results
 
     @classmethod
+    @deprecation.deprecated(
+        deprecated_in="1.0.0",
+        removed_in="1.1",
+        current_version=VERSION,
+        details="Use 'StockMarketdata.quote_by_symbols'")
     def all(cls, client, symbols):
-        """"
-        fetch data for multiple stocks
-        """
-        params = {"symbol": ",".join(symbols)}
-        request_url = "https://api.robinhood.com/instruments/"
-
-        data = client.get(request_url, params=params)
-        results = data["results"]
-
-        while data["next"]:
-            data = client.get(data["next"])
-            results.extend(data["results"])
-        return results
+        message = '''
+            Robinhood API seems to not support this endpoint.
+            Use fast_arrow.StockMarketdata.quote_by_symbols
+        '''
+        raise ApiDoesNotSupportError(message)

tests/resources/test_stock.py

@@ -1,23 +1,20 @@
 from fast_arrow import Stock
-from tests.test_util import gen_vcr, gen_client
+from fast_arrow.exceptions import ApiDoesNotSupportError
+from tests.test_util import gen_client
 
+import unittest
 
-class TestStock(object):
 
-    def test_fetch_fields(self):
+class TestStock(unittest.TestCase):
+
+    def test_fetch(self):
         client = gen_client()
         symbol = "TLT"
-        with gen_vcr().use_cassette('stock_fetch.yaml'):
-            stock = Stock.fetch(client, symbol)
-
-            expected_fields = [
-                'margin_initial_ratio', 'rhs_tradability', 'id',
-                'market', 'simple_name', 'min_tick_size', 'maintenance_ratio',
-                'tradability', 'state', 'type', 'tradeable', 'fundamentals',
-                'quote', 'symbol', 'day_trade_ratio', 'name',
-                'tradable_chain_id', 'splits', 'url', 'country',
-                'bloomberg_unique', 'list_date']
+        with self.assertRaises(ApiDoesNotSupportError):
+            Stock.fetch(client, symbol)
 
-            actual_fields = list(stock.keys())
-
-            assert(set(expected_fields) == set(actual_fields))
+    def test_all(self):
+        client = gen_client()
+        symbols = ["TLT", "USO"]
+        with self.assertRaises(ApiDoesNotSupportError):
+            Stock.all(client, symbols)