estated 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e16673bb64d863d6b2c5c1cd3b23957d7fa5c47565b817e7741bfa44542987fd
-  data.tar.gz: 97e6855b5c3cafe0981640560e59274e092fdc71f8ea4d1e0abbcd07cbea1436
+  metadata.gz: 2bda40363bc8b3099785ae4cbae1c0f63b430e2d8356139b665719c1e71fb72d
+  data.tar.gz: cff05669b537733cf977ad1a7851ef97c7137f37654e331f421a95ea1c1475df
 SHA512:
-  metadata.gz: 8f0bfc2e476b50a0addb93ad91a5b3b07cb19709ddaedd800bc352b6753567775012dd02c8be50e7245762f74954451a694381382e5681aaab14cb1f472a0b3c
-  data.tar.gz: 86fb6dc380bd2c084b4b72cb57623c790f007d88b68e7d58cdc95e7cf1923d6aec8be1c2b09efedf06a329e11b728cae4ffec84d51e594d1af0b1e0818d29037
+  metadata.gz: de9bb73bb6f5c6b73ab1ac32688723f78e789c8fa8160a7dbda8ae1f530db1e768f8becd4375029062c01cc1df6d65bbd76aad9b605305ee18a8ba9f75e5017c
+  data.tar.gz: fe0fe3715744ff12df6ae1723306041ecec07c6a1bb9ce7dec1189c171fb8cf17c9282433734b8d7575c0c9d448e9d6b6346b24939956405fd88e2a3a63266a6

data/.env.sample

@@ -0,0 +1 @@
+ESTATED_API_KEY=

data/.gitignore

@@ -10,6 +10,9 @@
 # Byebug
 .byebug_history
 
+# Dotenv
+.env
+
 # rspec failure tracking
 .rspec_status
 

data/Gemfile.lock

@@ -3,16 +3,19 @@ PATH
   specs:
     estated (0.2.0)
       httparty
+      mongo
 
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
+    bson (4.4.2)
     byebug (11.0.1)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
+    dotenv (2.7.2)
     hashdiff (0.4.0)
     httparty (0.17.0)
       mime-types (~> 3.0)
@@ -20,6 +23,8 @@ GEM
     mime-types (3.2.2)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2019.0331)
+    mongo (2.8.0)
+      bson (>= 4.4.2, < 5.0.0)
     multi_xml (0.6.0)
     public_suffix (4.0.1)
     rake (12.3.3)
@@ -48,6 +53,7 @@ PLATFORMS
 
 DEPENDENCIES
   byebug
+  dotenv
   estated!
   rake (~> 12.0)
   rspec (~> 3.0)

data/README.md

@@ -22,6 +22,8 @@ Or install it yourself as:
 
 ### Configuration
 
+#### API key
+
 ```ruby
 Estated.configure do |config|
   config.api_key = 'YOUR_API_KEY'
@@ -32,6 +34,19 @@ The API key can also be set through the `ESTATED_API_KEY` environment variable.
 
 In case the API key is set in the environment variable _and_ in the configuration block, the configuration will take precedence.
 
+#### Request cache
+
+<!-- TODO -->
+```ruby
+Estated.configure do |config|
+  config.mongo_client = ...
+  config.mongo_collection = ...
+  config.cache_ttl = ... # in seconds
+end
+
+Estated::RequestCache.setup
+```
+
 ### Usage
 
 For documentation on parameters, please check the [Estated API docs](https://estated.com/developers/docs/v4/property/overview) on how to retrieve properties.

data/estated.gemspec

@@ -27,8 +27,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "httparty"
+  spec.add_dependency "mongo"
 
   spec.add_development_dependency "byebug"
+  spec.add_development_dependency "dotenv"
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"
 end

data/lib/estated.rb

@@ -1,5 +1,6 @@
 require 'estated/client'
 require 'estated/config'
+require 'estated/request_cache'
 require 'estated/version'
 
 module Estated
@@ -14,4 +15,8 @@ module Estated
   def self.configure
     yield(config)
   end
+
+  def self.root
+    File.expand_path('../..', __FILE__)
+  end
 end

data/lib/estated/client.rb

@@ -6,9 +6,35 @@ module Estated
 
     base_uri 'https://apis.estated.com/v4'
 
-    def self.get_property(params)
-      query = params.merge(token: Estated.config.api_key)
-      self.get('/property', query: query).parsed_response
+    def self.get_property(params, skip_cache: false)
+      with_cache('/property', params, skip_cache: skip_cache) do
+        query = params.merge(token: Estated.config.api_key)
+        response = self.get('/property', query: query)
+
+        if response.parsed_response.is_a?(Hash)
+          json = response.parsed_response
+
+          # Don't cache if there's no data
+          [json, !!json['data']]
+        else
+          [{ 'response' => response }, false]
+        end
+      end
+    end
+
+    def self.with_cache(path, params, skip_cache:)
+      if !skip_cache && Estated.config.cache_enabled?
+        json = RequestCache.read(path, params)
+        return json if json
+      end
+
+      result, result_is_cacheable = yield
+
+      if Estated.config.cache_enabled? && result_is_cacheable
+        RequestCache.write(path, params, result)
+      end
+
+      result
     end
   end
 end

data/lib/estated/config.rb

@@ -1,9 +1,18 @@
 module Estated
   class Config
-    attr_writer :api_key
+    attr_writer :api_key, :cache_ttl
+    attr_accessor :mongo_client, :mongo_collection
+
+    def cache_ttl
+      @cache_ttl ||= 30 * 24 * 3600 # 30 days
+    end
 
     def api_key
       @api_key ||= ENV['ESTATED_API_KEY']
     end
+
+    def cache_enabled?
+      !!mongo_client
+    end
   end
 end

data/lib/estated/request_cache.rb

@@ -0,0 +1,53 @@
+require 'mongo'
+
+module Estated
+  class RequestCache
+    class << self
+      def read(path, params)
+        document = cache_store.
+          find(cache_key: cache_key(path, params)).
+          limit(1).
+          first
+
+        document['payload'] if document
+      end
+
+      def write(path, params, payload)
+        cache_store.update_one(
+          {
+            cache_key: cache_key(path, params)
+          },
+          {
+            cache_key: cache_key(path, params),
+            payload: payload,
+            created_at: Time.now
+          },
+          upsert: true
+        )
+        true
+      end
+
+      def setup
+        cache_store.indexes.create_one({ cache_key: 1 }, unique: true)
+        cache_store.indexes.create_one(
+          { created_at: 1 },
+          expire_after_seconds: Estated.config.cache_ttl)
+      end
+
+      private
+
+      def cache_store
+        Estated.config.mongo_client[Estated.config.mongo_collection]
+      end
+
+      def cache_key(path, params)
+        query = params.
+          sort_by { |k, _| k }.
+          map {|k, v| "#{k}=#{v}"}.
+          join('|')
+
+        "path=#{path}|" + query
+      end
+    end
+  end
+end

data/lib/estated/version.rb

@@ -1,3 +1,3 @@
 module Estated
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: estated
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Alex VKO
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2020-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -26,6 +26,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -40,6 +54,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +103,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.sample"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -89,6 +118,7 @@ files:
 - lib/estated.rb
 - lib/estated/client.rb
 - lib/estated/config.rb
+- lib/estated/request_cache.rb
 - lib/estated/version.rb
 homepage: https://github.com/navut/estated-ruby-client
 licenses: