update readme, get message fix

Author: devinaconley

.env.template

@@ -0,0 +1,3 @@
+# .env // template
+
+NEYNAR_KEY=

README.md

@@ -41,3 +41,14 @@ for an example that uses on-chain frame transactions, see the [weth frame](https
 
 and for a more advanced example involving multiplayer games, supabase integration, dynamic image rendering, and more,
 see [rock paper scissors](https://github.com/devinaconley/rock-paper-scissors)
+
+
+## roadmap
+
+upcoming features and improvements
+- mint actions
+- eip 712 signatures
+- generated library documentation
+- dynamic image rendering tools
+- compatibility with other web frameworks
+- state signing

examples/simple/requirements.txt

@@ -1,4 +1,4 @@
 # requirements.txt
-framelib~=0.0.4
+framelib~=0.0.5
 Flask~=3.0.1
 pydantic

examples/transaction/requirements.txt

@@ -1,4 +1,4 @@
 # requirements.txt
-framelib~=0.0.4
+framelib~=0.0.5
 Flask~=3.0.1
 pydantic

framelib/hub.py

@@ -26,6 +26,8 @@ def get_message(
         auth = (username, password)
 
     res = requests.post(url, headers=headers, auth=auth, data=bytes.fromhex(msg))
+    if res.status_code != 200:
+        raise ValueError(f'hub error [{res.status_code}] {res.text}')
 
     if res.status_code != 200:
         raise ValueError(f'failed to validate message with hub: {res.text}')

framelib/models.py

@@ -108,7 +108,6 @@ class NeynarInteractor(BaseModel):
     follower_count: int
     following_count: int
     verifications: list[str]
-    active_status: str
     viewer_context: Optional[NeynarViewer] = None
 
 

framelib/neynar.py

@@ -28,6 +28,8 @@ def get_frame_message(msg: str, api_key: str) -> NeynarValidatedMessage:
     }
 
     res = requests.post(url, json=body, headers=headers)
+    if res.status_code != 200:
+        raise ValueError(f'neynar error [{res.status_code}] {res.text}')
 
     if res.status_code != 200:
         raise ValueError(f'failed to validate message with neynar: {res.text}')

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name='framelib',
-    version='0.0.4',
+    version='0.0.5',
     author='Devin A. Conley',
     author_email='[email protected]',
     description='lightweight library for building farcaster frames using python and flask',

test/test_validation.py

@@ -3,20 +3,23 @@
 """
 
 # lib
+import os
+from dotenv import load_dotenv
 import pytest
 
 # src
 from framelib import validate_message
 from framelib.neynar import get_frame_message
 from framelib.hub import get_message
 
+load_dotenv()
 
 class TestValidateMessageNeynar(object):
 
     def test_button_1(self):
         # example signed message from fid 8268 clicking button 1
         msg = '0a4e080d10cc4018cbe1a230200182013f0a2068747470733a2f2f707974686f6e2d6672616d652e76657263656c2e6170702f10011a1908cc401214000000000000000000000000000000000000000112140101bf04a2e61cb24c9a66c047ac5ed175e1bed8180122403feee9d0c1392c1e5bc7bca49850f83735c53b4f60c88959ffc271123e333a196e963d15619125e6034acda36076c709182daa5625e4affe6df21866c204830828013220ad4520314a78bc4317c604a3324ebc25bd8215c3ac38342fd790b7905c291bd1'
-        action = get_frame_message(msg, 'NEYNAR_API_DOCS')
+        action = get_frame_message(msg, os.getenv('NEYNAR_KEY'))
         assert action.tapped_button.index == 1
         assert action.interactor.fid == 8268
         assert action.input is None
@@ -36,7 +39,7 @@ def test_button_1(self):
     def test_button_1_neynar(self):
         # example signed message from fid 8268 clicking button 1
         msg = '0a4e080d10cc4018cbe1a230200182013f0a2068747470733a2f2f707974686f6e2d6672616d652e76657263656c2e6170702f10011a1908cc401214000000000000000000000000000000000000000112140101bf04a2e61cb24c9a66c047ac5ed175e1bed8180122403feee9d0c1392c1e5bc7bca49850f83735c53b4f60c88959ffc271123e333a196e963d15619125e6034acda36076c709182daa5625e4affe6df21866c204830828013220ad4520314a78bc4317c604a3324ebc25bd8215c3ac38342fd790b7905c291bd1'
-        action = get_message(msg, 'https://hub-api.neynar.com', api_key='NEYNAR_API_DOCS')
+        action = get_message(msg, 'https://hub-api.neynar.com', api_key=os.getenv('NEYNAR_KEY'))
         assert action.data.frameActionBody.buttonIndex == 1
         assert action.data.fid == 8268
         assert action.data.network == 'FARCASTER_NETWORK_MAINNET'