conversocial 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3186bb8dceef834f750a92652082fa931e8051ae
-  data.tar.gz: 75328ce6fa7ee90cb4537957cab4028a2a442c34
+  metadata.gz: 6c42f9330f82bab1e667f6bea9c1ba0b5e362ef1
+  data.tar.gz: bba02656ef441ecf363e587f4d49e97ceed80bc9
 SHA512:
-  metadata.gz: 53442840ec73fbdd6bba59c41922871ecef49053946a4cbd9ba85be73061cd78af50098eb6cf6860f9fa2318799bac8ab859a8ae19c3b41c4fba6c8ae4886815
-  data.tar.gz: 0f4f8fe97978cdb488680092ce9d2598d6ecb9bcce03e99f6fb50df37867d035cdafdfd15ff818587f695e98537c335d741ce5a40b89c9f36d4a72beaf3668d2
+  metadata.gz: c114cd299740b29b8743bf5fb208a3d17fd776a82f3241ab3957154001c667a0ff06d3f3a7a90da3073aad14dd34e4edd1d4320f8c01c8b49fe3c075dca0c58a
+  data.tar.gz: 52cad5373410c2757c0047013f903d208ee56ab001ab8b42f556dd483f43b1cd7d6dfd5ac170610d2932ad4a0b67b2c7d6e5a81c4a3878202aaf3f9a9c657946

data/README.md

@@ -26,6 +26,9 @@ You can optionally pass a logger to log api requests made by the client.
 
     client = Conversocial::Client.new :key => '...', :secret => '...', :logger => Logger.new(STDOUT)
 
+Yet another option is the cache_expiry option. If set (by default it is not), the client will cache api requests. This is useful if you are getting rate limited.
+
+    client = Conversocial::Client.new :key => '...', :secret => '...', :cache_expiry => 1.hour
 
 ## Resources
 

data/lib/conversocial/client.rb

@@ -1,12 +1,13 @@
 module Conversocial
   class Client
-    attr_reader :version, :key, :secret, :logger
+    attr_reader :version, :key, :secret, :logger, :cache_expiry
 
     def initialize options={}
       @key = options[:key]
       @secret = options[:secret]
       @version = options[:version]
       @logger = options[:logger]
+      @cache_expiry = options[:cache_expiry]
     end
 
     def accounts

data/lib/conversocial/resources/query_engines/base.rb

@@ -12,6 +12,7 @@ module Conversocial
 
         def initialize client
           @client = client
+          @cache  = Conversocial::Resources::QueryEngines::Cache.new client.cache_expiry
           clear
         end
 
@@ -52,10 +53,10 @@ module Conversocial
         end
 
         def where options
-          options = options.map do |k,v|
-            v =  v.utc.strftime '%Y-%m-%dT%H:%M:%S' if v.kind_of? Time
+          options = options.map do |k, v|
+            v = v.utc.strftime '%Y-%m-%dT%H:%M:%S' if v.kind_of? Time
             v = v.to_s if v.kind_of? Date
-            [k,v]
+            [k, v]
           end.to_h
 
           @query_params.merge! options
@@ -63,19 +64,22 @@ module Conversocial
         end
 
         def find find_id
-          @query_params[:fields] ||= model_klass.fields.join(',')
 
-          json = get_json add_query_params("/#{find_id}", default_find_query_params.merge(@query_params))
-          clear
-          if json
-            item = new json[resource_name]
-            attach_content_to_items( [item], json['content']).first
-          end
+            @query_params[:fields] ||= model_klass.fields.join(',')
+
+            json = get_json add_query_params("/#{find_id}", default_find_query_params.merge(@query_params))
+            clear
+            if json
+              item = new json[resource_name]
+              attach_content_to_items([item], json['content']).first
+            end
+
         end
 
         def size
           fetch.size
         end
+
         alias :count :size
 
         def last
@@ -92,6 +96,7 @@ module Conversocial
           field = field.join ',' if field.kind_of? Array
           where :sort => field
         end
+
         alias :sort_by :sort
         alias :order :sort
         alias :order_by :sort
@@ -157,7 +162,7 @@ module Conversocial
           if content_json_array.present?
             items.each do |item|
               item.content_ids.each do |content_id|
-                content_json = content_json_array.find{ |ct| ct['id'] == content_id }
+                content_json = content_json_array.find { |ct| ct['id'] == content_id }
                 if content_json
                   item.send :append_content, new_instance_of_klass(Conversocial::Resources::Models::Content, content_json)
                 end
@@ -189,9 +194,11 @@ module Conversocial
 
         def get_json path
           full_path = absolute_path path
-          client.send :log, self, full_path
 
-          response = https_basic_auth_get client.key, client.secret, full_path
+          response =  @cache.get_or_set full_path do
+            client.send :log, self, full_path
+            https_basic_auth_get client.key, client.secret, full_path
+          end
 
           if 429 == response.code.to_i
             raise Conversocial::Resources::Exceptions::RateLimitExceeded.new response.code, nil, response.body

data/lib/conversocial/resources/query_engines/cache.rb

@@ -0,0 +1,42 @@
+module Conversocial
+  module Resources
+    module QueryEngines
+      class Cache
+        attr_reader :expiry
+
+        def initialize expiry=60*60
+          @cache = {}
+          @expiry = expiry.to_i
+        end
+
+        def get_or_set key
+          result = get key
+          if result.nil?
+            result = yield
+            set key, result
+          end
+          result
+        end
+
+        def set key, value
+          @cache[key.to_s] = {:value => value, :timestamp => Time.now}
+        end
+
+        def delete key
+          @cache.delete key.to_s
+        end
+        
+        def get key
+          if @cache[key.to_s]
+            if (Time.now - @cache[key.to_s][:timestamp]) < expiry
+              @cache[key.to_s][:value]
+            else
+              delete key
+              nil
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/conversocial/version.rb

@@ -1,3 +1,3 @@
 module Conversocial
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/lib/conversocial.rb

@@ -3,6 +3,7 @@ require "conversocial/version"
 #require utils
 require 'conversocial/utils/http'
 require 'conversocial/utils/strings'
+require 'conversocial/resources/query_engines/cache'
 
 #require client
 require 'conversocial/client'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: conversocial
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Misha Conway
@@ -71,6 +71,7 @@ files:
 - lib/conversocial/resources/query_engines/account.rb
 - lib/conversocial/resources/query_engines/author.rb
 - lib/conversocial/resources/query_engines/base.rb
+- lib/conversocial/resources/query_engines/cache.rb
 - lib/conversocial/resources/query_engines/channel.rb
 - lib/conversocial/resources/query_engines/conversation.rb
 - lib/conversocial/resources/query_engines/keyvalue.rb