Disable caching by default

Author: laurentpellegrino

CHANGELOG.md

@@ -7,8 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [1.1.0] - 2020-07-05
+## [2.0.0] - 2020-07-05
 ### Changed
+- Disable caching by default since people are often confused by this default setting. You can enable caching by following what is explained in the README.
 - Increase maximum timeout to 15s from 3s.
 
 ## [1.1.0] - 2019-10-27
@@ -22,6 +23,7 @@ https://github.com/ipregistry/ipregistry-python#caching
 ## [1.0.0] - 2019-07-28
 - First public release.
 
-[Unreleased]: https://github.com/ipregistry/ipregistry-javascript/compare/1.1.0...HEAD
+[Unreleased]: https://github.com/ipregistry/ipregistry-javascript/compare/2.0.0...HEAD
+[2.0.0]: https://github.com/ipregistry/ipregistry-javascript/releases/tag/1.1.0...2.0.0
 [1.1.0]: https://github.com/ipregistry/ipregistry-javascript/releases/tag/1.0.0...1.1.0
 [1.0.0]: https://github.com/ipregistry/ipregistry-javascript/releases/tag/1.0.0

README.md

@@ -57,16 +57,23 @@ folder.
 
 ### Caching
 
-The Ipregistry client has built-in support for in-memory caching. The default cache strategy is to memoize up to 
+This Ipregistry client library has built-in support for in-memory caching. By default caching is disabled. 
+Below are examples to enable and configure a caching strategy. Once enabled, default cache strategy is to memoize up to 
 2048 lookups for at most 10min. You can change preferences as follows:
 
+#### Enabling caching
+
+Enable caching by passing an instance of `DefaultCache`:
+
 ```python
 from ipregistry import DefaultCache, IpregistryClient
 
 client = IpregistryClient("YOUR_API_KEY", cache=DefaultCache(maxsize=2048, ttl=600))
 ```
 
-or disable caching by passing an instance of `NoCache`:
+#### Disabling caching
+
+Disable caching by passing an instance of `NoCache`:
 
 ```python
 from ipregistry import IpregistryClient, NoCache

ipregistry/core.py

@@ -16,14 +16,14 @@
 
 import json
 
-from .cache import DefaultCache, IpregistryCache
+from .cache import IpregistryCache, NoCache
 from .model import LookupError
 from .request import DefaultRequestHandler, IpregistryRequestHandler
 
 class IpregistryClient:
     def __init__(self, keyOrConfig, **kwargs):
         self._config = keyOrConfig if isinstance(keyOrConfig, IpregistryConfig) else IpregistryConfig(keyOrConfig)
-        self._cache = kwargs["cache"] if "cache" in kwargs else DefaultCache()
+        self._cache = kwargs["cache"] if "cache" in kwargs else NoCache()
         self._requestHandler = kwargs["requestHandler"] if "requestHandler" in kwargs else DefaultRequestHandler(self._config)
 
         if not isinstance(self._cache, IpregistryCache):

tests/test_client.py

@@ -0,0 +1,31 @@
+"""
+    Copyright 2019 Ipregistry (https://ipregistry.co).
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+       https://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+"""
+
+import unittest
+
+from ipregistry.cache import NoCache
+from ipregistry.core import IpregistryClient
+
+class TestIpregistryClient(unittest.TestCase):
+    def test_defaultclient_cache(self):
+        """
+        Test that default cache is an instance of NoCache
+        """
+        client = IpregistryClient("")
+        self.assertEqual(True, isinstance(client._cache, NoCache))
+
+if __name__ == '__main__':
+    unittest.main()