Improve examples (#20)

* Improve examples

* Update user agent

Author: jellejurre

README.md

@@ -44,7 +44,7 @@ configuration = vrchatapi.Configuration(
 # Enter a context with an instance of the API client
 with vrchatapi.ApiClient(configuration) as api_client:
     # Set our User-Agent as per VRChat Usage Policy
-    api_client.user_agent = "MyProject/1.0 my@email.com"
+    api_client.user_agent = "ExampleProgram/0.0.1 my@email.com"
 
     # Instantiate instances of API classes
     auth_api = authentication_api.AuthenticationApi(api_client)

examples/README.md

@@ -21,7 +21,7 @@ configuration = vrchatapi.Configuration(
 # Enter a context with an instance of the API client
 with vrchatapi.ApiClient(configuration) as api_client:
     # Set our User-Agent as per VRChat Usage Policy
-    api_client.user_agent = "MyProject/1.0 my@email.com"
+    api_client.user_agent = "ExampleProgram/0.0.1 my@email.com"
 
     # Instantiate instances of API classes
     auth_api = authentication_api.AuthenticationApi(api_client)
@@ -68,7 +68,7 @@ configuration = vrchatapi.Configuration(
 )
 
 with vrchatapi.ApiClient(configuration) as api_client:
-    api_client.user_agent = "MyProject/1.0 my@email.com"
+    api_client.user_agent = "ExampleProgram/0.0.1 my@email.com"
     auth_api = authentication_api.AuthenticationApi(api_client)
 
     try:
@@ -121,7 +121,7 @@ from vrchatapi.api.worlds_api import WorldsApi
 
 # We don't add a configuration file/set a username and password
 with vrchatapi.ApiClient() as api_client:
-    api_client.user_agent = "MyProject/1.0 my@email.com"
+    api_client.user_agent = "ExampleProgram/0.0.1 my@email.com"
 
     # We don't use the authentication API at all, since we don't need to
     world_api = WorldsApi(api_client)

examples/examples-source/cookies_load.py

@@ -0,0 +1,33 @@
+import vrchatapi
+from http.cookiejar import Cookie
+
+from vrchatapi.api import authentication_api
+
+
+def make_cookie(name, value):
+    return Cookie(0, name, value,
+                  None, False,
+                  "api.vrchat.cloud", True, False,
+                  "/", False,
+                  False,
+                  173106866300,
+                  False,
+                  None,
+                  None, {})
+
+
+configuration = vrchatapi.Configuration(
+    username='username',
+    password='password',
+)
+
+with vrchatapi.ApiClient(configuration) as api_client:
+    api_client.user_agent = "ExampleProgram/0.0.1 my@email.com"
+    api_client.rest_client.cookie_jar.set_cookie(
+        make_cookie("auth", "[AUTH_COOKIE_HERE]"))
+    api_client.rest_client.cookie_jar.set_cookie(
+        make_cookie("twoFactorAuth", "[TWO_FACTOR_AUTH_COOKIE_HERE]"))
+
+    auth_api = authentication_api.AuthenticationApi(api_client)
+    current_user = auth_api.get_current_user()
+    print("Logged in as:", current_user.display_name)

examples/examples-source/use_the_api.py renamed to examples/examples-source/cookies_store.py

@@ -4,16 +4,13 @@
 from vrchatapi.models.two_factor_auth_code import TwoFactorAuthCode
 from vrchatapi.models.two_factor_email_code import TwoFactorEmailCode
 
-# We import the class that corrisponds to the section of the API we want to use
-from vrchatapi.api.worlds_api import WorldsApi
-
 configuration = vrchatapi.Configuration(
-    username = 'username',
-    password = 'password',
+    username='username',
+    password='password',
 )
 
 with vrchatapi.ApiClient(configuration) as api_client:
-    api_client.user_agent = "MyProject/1.0 my@email.com"
+    api_client.user_agent = "ExampleProgram/0.0.1 my@email.com"
     auth_api = authentication_api.AuthenticationApi(api_client)
 
     try:
@@ -30,8 +27,7 @@
     except vrchatapi.ApiException as e:
         print("Exception when calling API: %s\n", e)
 
+    cookie_jar = api_client.rest_client.cookie_jar._cookies["vrchat.com"]["/"]
     print("Logged in as:", current_user.display_name)
-
-    # Now we are logged in, we can init and use the API class :)
-    worlds_api = WorldsApi(api_client) # All API section classes require an ApiClient object to be passed!
-    active_worlds = worlds_api.get_active_worlds()
+    print("auth: " + cookie_jar["auth"].value)
+    print("twoFactorAuth: " + cookie_jar["twoFactorAuth"].value)

examples/examples-source/login.py

@@ -6,8 +6,8 @@
 from vrchatapi.models.two_factor_email_code import TwoFactorEmailCode
 
 configuration = vrchatapi.Configuration(
-    username = 'username',
-    password = 'password',
+    username='username',
+    password='password',
 )
 
 # Step 2. VRChat consists of several API's (WorldsApi, UsersApi, FilesApi, NotificationsApi, FriendsApi, etc...)
@@ -16,7 +16,7 @@
 # Enter a context with an instance of the API client
 with vrchatapi.ApiClient(configuration) as api_client:
     # Set our User-Agent as per VRChat Usage Policy
-    api_client.user_agent = "MyProject/1.0 my@email.com"
+    api_client.user_agent = "ExampleProgram/0.0.1 my@email.com"
 
     # Instantiate instances of API classes
     auth_api = authentication_api.AuthenticationApi(api_client)
@@ -38,4 +38,4 @@
     except vrchatapi.ApiException as e:
         print("Exception when calling API: %s\n", e)
 
-    print("Logged in as:", current_user.display_name)
+    print("Logged in as:", current_user.display_name)

examples/examples-source/noauth.py

@@ -5,7 +5,7 @@
 
 # We don't add a configuration file/set a username and password
 with vrchatapi.ApiClient() as api_client:
-    api_client.user_agent = "MyProject/1.0 my@email.com"
+    api_client.user_agent = "ExampleProgram/0.0.1 my@email.com"
 
     # We don't use the authentication API at all, since we don't need to
     world_api = WorldsApi(api_client)