Merge pull request #4 from oxydev/issue1-addtests-and-workflow

fix #1 
fix #2 
fix #3

Author: SaberDoTcodeR

.github/workflows/test.yml

@@ -0,0 +1,33 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Python package
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ 3.7, 3.8, 3.9 ]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install requests
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+      - name: Test with unittest
+        run: python -m unittest

README.md

@@ -1,11 +1,11 @@
 # SubsCrypt Python Package
-
+[![Python Test](https://github.com/oxydev/SubsCrypt-python-package/actions/workflows/test.yml/badge.svg)](https://github.com/oxydev/SubsCrypt-python-package/actions/workflows/test.yml)
 [![PyPI license](https://img.shields.io/pypi/l/subscrypt.svg)](https://pypi.python.org/pypi/subscrypt/)
 [![PyPI version fury.io](https://badge.fury.io/py/subscrypt.svg)](https://pypi.python.org/pypi/subscrypt/)
 
 The python interface for interacting with SubsCrypt Service.
 
-<img src="https://oxydev.github.io/SubsCrypt-docs/images/logo2.png" width="400">
+<img src="https://oxydev.github.io/SubsCrypt-docs/images/logo.jpg" width="400">
 
 # Installation
 

config.json

@@ -0,0 +1,44 @@
+{
+  "nodeAddress": "http://206.189.154.160:3000/",
+  "test": {
+    "userAddress": "5HpG9w8EBLe5XCrbczpwq5TSXvedjrBGCwqxK1iQ7qUsSWFc",
+    "providerAddress": "5GNJqTPyNqANBkUVMN1LPPrxXnFouWXoe2wNSmmEoLctxiZY",
+    "passWord": "password",
+    "username": "user",
+    "providerUsername": "provider",
+    "plansData": [
+      {
+        "duration": "86,400,000",
+        "price": "1,000,000",
+        "max_refund_permille_policy": "100",
+        "disabled": false
+      },
+      {
+        "duration": "864,000,000",
+        "price": "9,000,000",
+        "max_refund_permille_policy": "150",
+        "disabled": false
+      },
+      {
+        "duration": "1,728,000,000",
+        "price": "16,000,000",
+        "max_refund_permille_policy": "200",
+        "disabled": false
+      }
+    ],
+    "plansCharacteristic": [
+      [
+        "plan0"
+      ],
+      [
+        "plan1_0",
+        "plan1_1"
+      ],
+      [
+        "plan2_0",
+        "plan2_1",
+        "plan2_2"
+      ]
+    ]
+  }
+}

subscrypt/client.py

@@ -1,12 +1,15 @@
 from urllib.parse import urljoin
-
+import json
 import requests
 
+with open('config.json', 'r') as f:
+    config = json.load(f)
+
 
 class Subscrypt:
     def __init__(
             self,
-            base_url: str = 'http://206.189.154.160:3000/'
+            base_url: str = config['nodeAddress']
     ):
         self.base_url = base_url
 
@@ -23,100 +26,88 @@ def check_subscription(self, user_address: str, provider_address: str, plan_inde
             providerAddress=provider_address,
             planIndex=plan_index,
         )
-        
+
     def check_subscription_with_username(self, username: str, provider_address: str, plan_index: int):
         return self._get(
             f'/subsCrypt/checkSubscription/{username}/',
             providerAddress=provider_address,
             planIndex=plan_index,
         )
-        
+
     def get_username(self, sender: str):
         return self._get(
             f'/subsCrypt/getUsername/{sender}/',
         )
-        
+
     def retrieve_whole_data_with_username(self, username: str, password: str):
         return self._get(
             '/subsCrypt/retrieveDataWithUsername/',
             username=username,
             phrase=password,
         )
-        
+
     def retrieve_data_with_username(self, user_address: str, provider_address: str, password: str):
         return self._get(
             f'/subsCrypt/retrieveDataWithUsername/{provider_address}/',
             username=user_address,
             phrase=password,
         )
-        
-    def retrieve_data_with_wallet(self, sender: str, provider_address: str):
-        # TODO (there is no api doc in swagger)
-        raise NotImplemented
-
-    def retrieve_whole_data_with_wallet(self, sender: str):
-        # TODO (there is no api doc in swagger)
-        raise NotImplemented
 
     def is_username_available(self, username: str):
         return self._get(
             f'/subsCrypt/isUsernameAvailable/{username}',
         )
-        
+
     def check_auth(self, user_address: str, provider_address: str, password: str):
         return self._get(
             '/subsCrypt/checkAuth/',
             userAddress=user_address,
             providerAddress=provider_address,
             phrase=password,
         )
-        
+
     def check_auth_with_username(self, username: str, provider_address: str, password: str):
         return self._get(
             f'/subsCrypt/checkAuth/{username}/',
             providerAddress=provider_address,
             phrase=password,
         )
-        
+
     def user_check_auth(self, user_address: str, password: str):
         return self._get(
             '/subsCrypt/userCheckAuth/',
             userAddress=user_address,
             phrase=password,
         )
-        
+
     def user_check_auth_with_username(self, username: str, password: str):
         return self._get(
             f'/subsCrypt/userCheckAuth/{username}/',
             phrase=password,
         )
-        
+
     def get_plan_data(self, provider_address: str, plan_index: int):
         return self._get(
             f'/subsCrypt/getPlanData/{provider_address}/{plan_index}/',
         )
-        
+
     def provider_check_auth(self, provider_address: str, password: str):
         return self._get(
             '/subsCrypt/providerCheckAuth/',
             providerAddress=provider_address,
             phrase=password,
         )
-        
+
     def provider_check_auth_with_username(self, provider_username: str, password: str):
         return self._get(
             f'/subsCrypt/providerCheckAuth/{provider_username}/',
             phrase=password,
         )
-        
+
     def get_plan_characteristics(self, provider_address: str, plan_index: int):
         return self._get(
             f'/subsCrypt/getPlanCharacteristics/{provider_address}/{plan_index}/',
         )
-        
-    def get_sha2(self, string: str):
-        # TODO (there is no api doc in swagger)
-        raise NotImplemented
 
     def is_connected(self):
         return self._get(

tests.py

@@ -1,11 +1,81 @@
-from unittest import TestCase
-
+import unittest
 from subscrypt import Subscrypt
+import json
+
+with open('config.json', 'r') as f:
+    config = json.load(f)
 
 
-class TestSubscrypt(TestCase):
+class TestSubscrypt(unittest.TestCase):
     def setUp(self):
         self.client = Subscrypt()
 
     def test_is_connected_returns_true(self):
-        self.assertTrue(self.client.is_connected())
+        self.assertEqual(self.client.is_connected(), True)
+
+    def test_check_subscription_returns_bool(self):
+        self.assertIn(
+            self.client.check_subscription(config['test']['userAddress'], config['test']['providerAddress'], 0),
+            [True, False])
+
+    def test_check_subscription_with_username_returns_bool(self):
+        self.assertIn(
+            self.client.check_subscription(config['test']['username'], config['test']['providerAddress'], 0),
+            [True, False])
+
+    def test_get_username_works(self):
+        self.assertEqual(self.client.get_username(config['test']['userAddress']), config['test']['username'])
+
+    def test_retrieve_whole_data_with_username_works(self):
+        self.assertIsNotNone(self.client.retrieve_whole_data_with_username(
+            config['test']['username'], config['test']['passWord']))
+
+    def test_retrieve_data_with_username_works(self):
+        self.assertIsNotNone(self.client.retrieve_data_with_username(
+            config['test']['username'], config['test']['providerAddress'], config['test']['passWord']))
+
+    def test_is_username_available_returns_false(self):
+        self.assertEqual(self.client.is_username_available(config['test']['username']), False)
+
+    def test_check_auth_true(self):
+        self.assertEqual(self.client.check_auth(config['test']['userAddress'], config['test']['providerAddress'],
+                                                config['test']['passWord']), True)
+
+    def test_check_auth_with_username_true(self):
+        self.assertEqual(
+            self.client.check_auth_with_username(config['test']['username'], config['test']['providerAddress'],
+                                                 config['test']['passWord']), True)
+
+    def test_user_check_auth_with_username_true(self):
+        self.assertEqual(
+            self.client.user_check_auth_with_username(config['test']['username'],
+                                                      config['test']['passWord']), True)
+
+    def test_get_plan_data(self):
+        plans = config['test']['plansData']
+        index = 0
+        for plan in plans:
+            self.assertEqual(
+                self.client.get_plan_data(config['test']['providerAddress'],
+                                          index), plan)
+            index += 1
+
+    def test_provider_check_auth_true(self):
+        self.assertEqual(
+            self.client.provider_check_auth(config['test']['providerAddress'],
+                                            config['test']['passWord']), True)
+
+    def test_provider_check_auth_with_username_true(self):
+        self.assertEqual(
+            self.client.provider_check_auth_with_username(config['test']['providerUsername'],
+                                                          config['test']['passWord']), True)
+
+    def test_get_plan_data(self):
+        for i in range(len(config['test']['plansData'])):
+            self.assertEqual(
+                self.client.get_plan_characteristics(config['test']['providerAddress'],
+                                                     i), config['test']['plansCharacteristic'][i])
+
+
+if __name__ == '__main__':
+    unittest.main()