Merge branch 'development' into 'master'

Development

See merge request open-platform/sdk/python!7

Author: evgeny-krylov

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [2.0.0] - 2018-08-02
+### Changed
+- Renamed module to open_py
+- Renamed class to OpenPy
+
+
 ## [1.0.1] - 2018-08-01
 ### Changed
 - Update the README to match the new way of importing the package
@@ -27,5 +33,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Get all transactions API
 - Tests
 
+[2.0.0]: https://github.com/OpenFuturePlatform/open-api-python-sdk/compare/v2.0.0...v1.0.1
+[1.0.1]: https://github.com/OpenFuturePlatform/open-api-python-sdk/compare/v1.0.1...v1.0.0
 [1.0.1]: https://github.com/OpenFuturePlatform/open-api-python-sdk/compare/v1.0.1...v1.0.0
 [1.0.0]: https://github.com/OpenFuturePlatform/open-api-python-sdk/compare/e8d583f41e071d56dbc6dcf924bcc3a35c85b302...v1.0.0

README.md

@@ -29,10 +29,10 @@ To access the library import an OpenPlatform class and call an instance with the
 
 
 ```python
-from openplatform import OpenPlatform
+from openp_py import OpenPy
 
 # Access API via instance of OpenPlatform class
-op = OpenPlatform(open_key)
+op = OpenPy(open_key)
 ```
 `open_key` - your open key. 
 
@@ -100,7 +100,7 @@ transactionIndex|BigInteger                                           | Transact
 tokenBalance    |BigInteger                                           | Scaffold token balance
 enabled         |Boolean                                              | Scaffold enabled
 currency        |String                                               | Fiat amount currency
-shareHolders    |[ShareHolder](#share-holder-attributes)              | Scaffold share holders
+shareHolders    |[ShareHolder](#shareholder-attributes)               | Scaffold shareholders
 
 ##### get_summary(address)
 
@@ -192,7 +192,7 @@ quota = op.scaffold.get_quota()
 ```
 #### Shareholder
 
-##### Share holder attributes
+##### Shareholder attributes
 
 Attribute       | Type                                                | Description
 ----------------|-----------------------------------------------------|-----------

open_py/__init__.py

@@ -0,0 +1,3 @@
+from open_py.open_py import OpenPy
+
+__all__ = [OpenPy]

open_py/config.py

@@ -0,0 +1,5 @@
+api_prefix = 'api/'
+remote_api = ''
+
+# base_url = 'https://api.open-platform.zensoft.io'
+base_url = 'https://api.openfuture.io'

openplatform/open_api.py renamed to open_py/open_py.py

@@ -1,7 +1,7 @@
-from openplatform.senders import Scaffold, Shareholder
+from open_py.senders import Scaffold, Shareholder
 
 
-class OpenPlatform(object):
+class OpenPy(object):
     def __init__(self, open_key=''):
         if open_key == '':
             raise AttributeError('open_key can not be empty')

openplatform/senders.py renamed to open_py/senders.py

@@ -1,7 +1,7 @@
 import requests
 
-from openplatform.urls import base
-from openplatform.utils import validate_address, merge_headers, CONTENT_JSON
+from open_py.urls import base
+from open_py.utils import validate_address, merge_headers, CONTENT_JSON
 
 
 class Scaffold:

openplatform/urls.py renamed to open_py/urls.py

@@ -1,5 +1,5 @@
-from openplatform import config
-from openplatform.config import base_url
+from open_py import config
+from open_py.config import base_url
 import urllib.parse
 
 

openplatform/utils.py renamed to open_py/utils.py

@@ -79,8 +79,6 @@
 
 test_key = 'op_pk_50g48642-1af1-5dfg-54sz-f868s5v8796c'
 
-test_base_url = 'https://api.open-platform.zensoft.io'
-
 scaffold = {
     'version': 'V2',
     'conversionAmount': '0.021833823',
@@ -123,7 +121,7 @@
         'event': {
             'userAddress': developer_address,
             'partnerShare': 30,
-            'type': 'ADDED_SHARE_HOLDER'},
+            'type': 'ADDED_SHAREHOLDER'},
         'scaffold': scaffold}]}
 
 scaffold_data = {

openplatform/__init__.py

@@ -4,13 +4,14 @@
 
 import requests
 
-from openplatform.open_api import OpenPlatform
-from openplatform.utils import validate_address, merge_headers
+from open_py.config import base_url
+from open_py.open_py import OpenPy
+from open_py.utils import validate_address, merge_headers
 from tests.const import *
 
 
 def base_url_mock(rest):
-    predefined_url = urllib.parse.urljoin(test_base_url, 'api/')
+    predefined_url = urllib.parse.urljoin(base_url, 'api/')
     return urllib.parse.urljoin(predefined_url, rest)
 
 
@@ -20,7 +21,7 @@ class TestScaffoldGetters(TestCase):
 
     @classmethod
     def setUp(cls):
-        cls.mock_requests_patcher = patch('openplatform.senders.requests.get')
+        cls.mock_requests_patcher = patch('open_py.senders.requests.get')
         cls.requests_mock = cls.mock_requests_patcher.start()
 
     @classmethod
@@ -32,15 +33,15 @@ def test_getting_list(self):
         self.requests_mock.return_value.json.return_value = list_of_scaffolds
 
         # Send a request to the API server and store the response.
-        op = OpenPlatform(test_key)
+        op = OpenPy(test_key)
         response = op.scaffold.get_all()
 
         # Confirm that the request-response cycle completed successfully.
         self.assertEqual(response, list_of_scaffolds)
         self.requests_mock.assert_called_with(base_url_mock('scaffolds'), headers=authorization_header)
 
     def test_getting_single_successfully(self):
-        op = OpenPlatform(test_key)
+        op = OpenPy(test_key)
         self.requests_mock.return_value.json.return_value = scaffold
         response = op.scaffold.get_single(valid_address)
         self.assertEqual(response, scaffold)
@@ -55,7 +56,7 @@ def test_getting_single_with_wrong_token(self):
         invalid_key = 'some_invalid_open_key'
         self.requests_mock.return_value.json.return_value = {'status': 401,
                                                              'message': 'Open token is invalid or disabled'}
-        op = OpenPlatform(invalid_key)
+        op = OpenPy(invalid_key)
         with self.assertRaises(requests.HTTPError) as error:
             op.scaffold.get_single(valid_address)
         self.assertEqual(str(error.exception), 'Open token is invalid or disabled')
@@ -64,7 +65,7 @@ def test_getting_single_with_wrong_token(self):
 
     def test_getting_single_without_token(self):
         with self.assertRaises(AttributeError) as error:
-            OpenPlatform()
+            OpenPy()
         self.assertEqual(str(error.exception), 'open_key can not be empty')
 
     def test_getting_single_with_wrong_address(self):
@@ -78,38 +79,38 @@ def test_getting_single_with_wrong_address(self):
             'error': 'Not Found',
             'message': 'Not Found',
             'path': '/api/scaffolds/0x0000000000000000000000000000000000000000'}
-        op = OpenPlatform(test_key)
+        op = OpenPy(test_key)
         with self.assertRaises(requests.exceptions.HTTPError) as error:
             op.scaffold.get_single(valid_address)
         self.requests_mock.assert_called_with(base_url_mock('scaffolds/' + valid_address), headers=authorization_header)
         self.assertTrue(mock_response.raise_for_status.called)
         self.assertEqual('Not Found', str(error.exception))
 
     def test_getting_all_successfully(self):
-        op = OpenPlatform(test_key)
+        op = OpenPy(test_key)
         self.requests_mock.return_value.json.return_value = list_of_scaffolds
         response = op.scaffold.get_all()
         self.assertEqual(response, list_of_scaffolds)
         self.requests_mock.assert_called_with(base_url_mock('scaffolds'), headers=authorization_header)
 
     def test_getting_summary_successfully(self):
-        op = OpenPlatform(test_key)
+        op = OpenPy(test_key)
         self.requests_mock.return_value.json.return_value = summary
         response = op.scaffold.get_summary(valid_address)
         self.assertEqual(response, summary)
         self.requests_mock.assert_called_with(base_url_mock('scaffolds/' + valid_address + '/summary'),
                                               headers=authorization_header)
 
     def test_getting_transactions_successfully(self):
-        op = OpenPlatform(test_key)
+        op = OpenPy(test_key)
         self.requests_mock.return_value.json.return_value = transactions
         response = op.scaffold.get_transactions(valid_address)
         self.assertEqual(response, transactions)
         self.requests_mock.assert_called_with(base_url_mock('scaffolds/' + valid_address + '/transactions'),
                                               headers=authorization_header)
 
     def test_getting_quota_successfully(self):
-        op = OpenPlatform(test_key)
+        op = OpenPy(test_key)
         result_qouta = {'limitCount': 10, 'currentCount': 4}
         self.requests_mock.return_value.json.return_value = result_qouta
         response = op.scaffold.get_quota()
@@ -120,11 +121,11 @@ def test_getting_quota_successfully(self):
 
 class TestScaffoldPosters(TestCase):
 
-    @patch('openplatform.senders.requests.post')
+    @patch('open_py.senders.requests.post')
     def test_deploying(self, post_mock):
         post_mock.return_value.json.return_value = scaffold
 
-        op = OpenPlatform(test_key)
+        op = OpenPy(test_key)
         response = op.scaffold.deploy(scaffold_data)
 
         self.assertEqual(response, scaffold)
@@ -134,11 +135,11 @@ def test_deploying(self, post_mock):
 
 class TestScaffoldDeleters(TestCase):
 
-    @patch('openplatform.senders.requests.delete')
+    @patch('open_py.senders.requests.delete')
     def test_deactivating(self, post_mock):
         post_mock.return_value.json.return_value = scaffold
 
-        op = OpenPlatform(test_key)
+        op = OpenPy(test_key)
         response = op.scaffold.deactivate(valid_address)
 
         self.assertEqual(response, scaffold)
@@ -147,11 +148,11 @@ def test_deactivating(self, post_mock):
 
 class TestScaffoldPatchers(TestCase):
 
-    @patch('openplatform.senders.requests.patch')
+    @patch('open_py.senders.requests.patch')
     def test_setting_web_hook(self, post_mock):
         post_mock.return_value.json.return_value = scaffold
         web_hook = {'webHook': 'https://zensoft.io'}
-        op = OpenPlatform(test_key)
+        op = OpenPy(test_key)
         response = op.scaffold.set_webhook(valid_address, web_hook)
 
         self.assertEqual(response, scaffold)
@@ -161,32 +162,32 @@ def test_setting_web_hook(self, post_mock):
 
 class TestShareholders(TestCase):
 
-    @patch('openplatform.senders.requests.post')
+    @patch('open_py.senders.requests.post')
     def test_creation(self, post_mock):
         post_mock.return_value.json.return_value = new_shareholders
-        op = OpenPlatform(test_key)
+        op = OpenPy(test_key)
         response = op.shareholder.create(valid_address, shareholder_to_be_added)
 
         self.assertEqual(response, new_shareholders)
         post_mock.assert_called_with(base_url_mock('scaffolds/' + valid_address + '/holders'),
                                      json=shareholder_to_be_added,
                                      headers=request_headers)
 
-    @patch('openplatform.senders.requests.put')
+    @patch('open_py.senders.requests.put')
     def test_updating(self, post_mock):
         post_mock.return_value.json.return_value = scaffold
-        op = OpenPlatform(test_key)
+        op = OpenPy(test_key)
         response = op.shareholder.update(valid_address, developer_address, shareholder_to_be_updated)
 
         self.assertEqual(response, scaffold)
         post_mock.assert_called_with(base_url_mock('scaffolds/' + valid_address + '/holders/' + developer_address),
                                      json=shareholder_to_be_updated,
                                      headers=request_headers)
 
-    @patch('openplatform.senders.requests.delete')
+    @patch('open_py.senders.requests.delete')
     def test_removing(self, post_mock):
         post_mock.return_value.json.return_value = removing_shareholder
-        op = OpenPlatform(test_key)
+        op = OpenPy(test_key)
         response = op.shareholder.remove(valid_address, developer_address)
 
         self.assertEqual(response, removing_shareholder)