Merge pull request #9 from jordanh/make-static

Makes get_local_current_sample static

CHANGELOG.md

@@ -2,6 +2,10 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.3.1]
+### Changes
+- Made `get_local_current_sample()` method static.
+
 ## [0.3.0]
 ### Added
 - Added method get_local_current_sample for querying sensor on local network
@@ -72,6 +76,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 - Initial release
 
+[0.3.1]: https://github.com/jordanh/neurio-python/compare/0.3.0...0.3.1
+[0.3.0]: https://github.com/jordanh/neurio-python/compare/0.2.10...0.3.0
 [0.3.0]: https://github.com/jordanh/neurio-python/compare/0.2.10...0.3.0
 [0.2.10]: https://github.com/jordanh/neurio-python/compare/0.2.9...0.2.10
 [0.2.9]: https://github.com/jordanh/neurio-python/compare/0.2.8...0.2.9

neurio/__init__.py

@@ -28,7 +28,7 @@
 except ImportError:
   from urllib.parse import urlparse, parse_qsl, urlunparse
 
-__version__ = "0.3.0"
+__version__ = "0.3.1"
 
 class TokenProvider(object):
   __key = None
@@ -88,6 +88,11 @@ def __init__(self, token_provider):
     Args:
       token_provider (TokenProvider): object providing authentication services
     """
+    if token_provider is None:
+      raise ValueError("token_provider is required")
+    if not isinstance(token_provider, TokenProvider):
+      raise ValueError("token_provider must be instance of TokenProvider")
+
     self.__token = token_provider.get_token()
 
   def __gen_headers(self):
@@ -381,9 +386,12 @@ def get_appliance_stats_by_location(self, location_id, start, end, granularity=N
     r = requests.get(url, headers=headers)
     return r.json()
 
-  def get_local_current_sample(self, ip):
+  @staticmethod
+  def get_local_current_sample(ip):
     """Gets current sample from *local* Neurio device IP address.
 
+    This is a static method. It doesn't require a token to authenticate.
+
     Note, call get_user_information to determine local Neurio IP addresses.
 
     Args:

setup.py

@@ -9,7 +9,7 @@
 setup(
   name = 'neurio',
   packages = ['neurio'],
-  version = "0.3.0",
+  version = "0.3.1",
   description = 'Neurio energy sensor and appliance automation API library',
   author = 'Jordan Husney',
   author_email = '[email protected]',

tests/auth_test.py

@@ -42,6 +42,14 @@ def test_token_provider_invalid_credentials(self):
         with self.assertRaises(Exception):
             tp.get_token()
 
+    def test_token_provider_none(self):
+        with self.assertRaises(ValueError):
+            neurio.Client(token_provider=None)
+
+    def test_token_provider_type(self):
+        with self.assertRaises(ValueError):
+            neurio.Client(token_provider=object())
+
 
 if __name__ == '__main__':
     unittest.main()

tests/local_test.py

@@ -42,16 +42,17 @@ def test_local_current_sample(self):
           for sensor in sublist if sensor['sensorType'] == 'neurio'
         ]
         self.assertGreater(len(ips), 0)
-        sample = self.nc.get_local_current_sample(ips[0])
+        # test static method:
+        sample = neurio.Client.get_local_current_sample(ips[0])
         self.assertGreater(len(sample['timestamp']), 0)
 
     def test_local_current_sample_ip_arg(self):
       bad_ip1 = "hostname.domain"
       with self.assertRaises(ValueError):
-        self.nc.get_local_current_sample(bad_ip1)
+        neurio.Client.get_local_current_sample(bad_ip1)
       bad_ip2 = "255.256.257.258"
       with self.assertRaises(ValueError):
-        self.nc.get_local_current_sample(bad_ip2)
+        neurio.Client.get_local_current_sample(bad_ip2)
 
 
 if __name__ == '__main__':