loquor 0.5.3 → 0.5.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZGMyMzdhMjI3OThmN2I0NThmZTBiZjNhZmU0ODJjODFlOWU0ZmJjZg==
+    OWM1ZjMxMmJhNjYyM2IwNWMyMzllNWNiOWIzNzk5Mjc0MjU1ZTUyZg==
   data.tar.gz: !binary |-
-    OTJkMTFhNDBlNzI0NzU1ZjA4OTVmOTRkODEyMWViOWFkNjhlODY2Yw==
+    YmNkNzIzMTEzNmY0MmE4YTg5NWVhYjdhZDU4YTAwNGFiNjRiZDZjZQ==
 SHA512:
   metadata.gz: !binary |-
-    MTY0MWVjYjNkZGNhMWYyM2I1M2NhNjM5MDA5MDRiNTBiOGEyM2E0NGFhZjA2
-    MjFkNTc4ZTE5YzM5ZWYwZTJjNjY1MmZjODI3MGEyYmVjNGU3OGFlZjM1NjBm
-    MmUyYzBkMTEwZWViNDU5ZTM1M2ZkMzgzYzE1NWQ5YTJiOGMzMzY=
+    ZGYxZmZlNzlhZGM4NjViNGNhOTViM2I5Y2E0NzE2MzBjNGYyYTAzZDE2ZDcz
+    MzRmNGJjNDYzMTllNmJiNWVhZTk1ZGJiY2U0MTI1MWMwODI5NjMwNTc5NDc4
+    NzU0YmMyYjlkZDJlMjcwZjE1MGVlYTE0ZTI3MWFmMWQ0MWUzMWM=
   data.tar.gz: !binary |-
-    MTU2NTY5MDNmMzdlMTEyZTFiMzg2N2I5MDE0YzRhZjE0NDNkM2M1NGNkODZi
-    Nzg0ZjdmNzI5MDg4NzQwMDEwODA1Mzg3MGUyOTQ1OTVhMzdkNjJjNGQxZjM5
-    M2E0NzZkN2E0MDVlNzE5ZjJhOGYzNjEyZGUzMGIzOTNlMzk4MTY=
+    NzJjMWM1ODcwNGI1ZjEyNDc1ZTExYTRlZTI1NDQ4YWFmZmFiNzQ3MTZjOGNl
+    MzlhNjQwMWMwNTkwMGI3NjhiMDUwMzk4N2E5MGI4OWYyZTkzOGEzMDNiZjI2
+    YmVkYTUyNWVlMzA0NzcyMGI5NGVjNWZhMWQ0MmEwODcyYWMyMDQ=

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.5.4 / 2013-12-13
+* [FEATURE] Add support for basic resource caching
+
 # 0.5.3 / 2013-12-11
 * [FEATURE] Add support for overridding stubbed responses
 

data/lib/loquor.rb

@@ -22,8 +22,8 @@ module Loquor
     end
   end
 
-  def self.get(url)
-    loquor.get(url)
+  def self.get(url, *args)
+    loquor.get(url, *args)
   end
 
   def self.put(url, payload)

data/lib/loquor/api_calls/show.rb

@@ -7,7 +7,11 @@ module Loquor
     end
 
     def execute
-      obj = Loquor.get("#{klass.path}/#{@id}")
+      obj = if (klass.cache)
+        Loquor.get("#{klass.path}/#{@id}", cache=klass.cache)
+      else
+        Loquor.get("#{klass.path}/#{@id}")
+      end
       @klass.new(obj)
     end
   end

data/lib/loquor/client.rb

@@ -6,8 +6,9 @@ module Loquor
       @config = Configuration.new
     end
 
-    def get(url)
+    def get(url, cache=nil)
       deps = {config: @config}
+      deps[:should_cache] = cache if cache
       HttpAction::Get.get(url, deps)
     end
 

data/lib/loquor/configuration.rb

@@ -11,6 +11,7 @@ module Loquor
     ]
 
     attr_writer *SETTINGS
+    attr_accessor :cache
 
     def initialize
       Filum.config do |config|

data/lib/loquor/http_action.rb

@@ -3,12 +3,30 @@ module Loquor
     def initialize(url, deps)
       @url = url
       @config = deps[:config]
+      @should_cache = deps[:should_cache]
     end
 
     def signed_request
       @config.logger.info "Signing request."
       ApiAuth.sign!(request, @config.access_id, @config.secret_key)
     end
+    
+    def execute
+      @config.logger.info "Making HTTP request to: #{full_url}"
+      signed_request.execute
+    rescue RestClient::ResourceNotFound => e
+      @config.logger.error("HTTP 404 when accessing #{full_url}")
+      raise
+    rescue => e
+      @config.logger.error("Exception while executing request: #{e.message} <#{e.class}>")
+      raise
+    end
+    
+    private
+    
+    def full_url
+      "#{@config.endpoint}#{@url}"
+    end
   end
 end
 

data/lib/loquor/http_actions/get.rb

@@ -9,19 +9,29 @@ module Loquor
     end
 
     def get
-      @config.logger.info "Making GET request to: #{full_url}"
-      response = JSON.parse(signed_request.execute)
-      @config.logger.info "Signed request executed. Response: #{response}"
+      @config.logger.info "GET: #{full_url}"
+      response = @should_cache ? JSON.parse(execute_against_cache) : JSON.parse(execute)
+      @config.logger.info "Response: #{response}"
       response
     end
+      
+    def execute_against_cache
+      cache = @config.cache
+      if cache
+        val = cache.get(request.url)
+        unless val
+          val = execute
+          cache.set(request.url, val)
+        end
+        val
+      else
+        execute
+      end 
+    end
 
     private
     def request
       RestClient::Request.new(url: full_url, method: :get)
     end
-
-    def full_url
-      "#{@config.endpoint}#{@url}"
-    end
   end
 end

data/lib/loquor/resource.rb

@@ -17,6 +17,14 @@ module Loquor
       @path
     end
 
+    def self.cache=(value)
+      @value = value
+    end
+
+    def self.cache
+      @value
+    end
+
     def self.find(id)
       ApiCall::Show.new(self, id).execute
     end

data/lib/loquor/version.rb

@@ -1,3 +1,3 @@
 module Loquor
-  VERSION = "0.5.3"
+  VERSION = "0.5.4"
 end

data/test/api_calls/show_test.rb

@@ -3,6 +3,27 @@ require File.expand_path('../../test_helper', __FILE__)
 module Loquor
   class ApiCall::ShowTest < Minitest::Test
 
+    class NormalResource < Resource
+      self.path = '/normal'
+    end
+
+    class CachedResource < Resource
+      self.path = '/cached'
+      self.cache = true      
+    end
+
+    def test_request_correct_path
+      show = ApiCall::Show.new(NormalResource, 42)
+      Loquor.expects(:get).with('/normal/42').returns({}.to_json)
+      show.execute
+    end
+    
+    def test_request_correct_path_for_cachable_resources
+      show = ApiCall::Show.new(CachedResource, 42)
+      Loquor.expects(:get).with('/cached/42', cache=true).returns({}.to_json)
+      show.execute
+    end
+
     def test_response_is_a_representation
       show = ApiCall::Show.new(Resource, 1)
       Loquor.stubs(get: {foo: 'bar'}.to_json)

data/test/client_test.rb

@@ -35,5 +35,15 @@ module Loquor
       HttpAction::Post.expects(:post).with(url, payload, deps)
       client.post(url, payload)
     end
+    
+
+    def test_get_calls_gets_with_cache_flag
+      url = "foobar"
+
+      client = Client.new
+      deps = {config: client.config, should_cache: true}
+      HttpAction::Get.expects(:get).with(url, deps)
+      client.get(url, cache=true)
+    end
   end
 end

data/test/http_action_test.rb

@@ -1,10 +1,11 @@
 module Loquor
- class HttpAction::Test < Minitest::Test
+  class HttpAction::Test < Minitest::Test
     def setup 
       super 
       @access_id = "123"
       @secret_key = "Foobar132"
       @endpoint = "http://www.thefoobar.com"
+      @cache = mock()
     end
 
     def deps
@@ -16,7 +17,15 @@ module Loquor
       config.stubs(access_id: @access_id)
       config.stubs(secret_key: @secret_key)
       config.stubs(endpoint: @endpoint)
+      config.stubs(cache: @cache)
       {config: config}
     end
- end
+    
+    def test_execute_signs_and_executes
+      json = "{}"
+      action = HttpAction.new("", deps)
+      action.expects(signed_request: mock(execute: json))
+      assert_equal json, action.send(:execute)
+    end
+  end
 end

data/test/http_actions/get_test.rb

@@ -39,5 +39,44 @@ module Loquor
       gets.send(:signed_request)
     end
 
+    def test_get_cached_resource
+      output = {'foo' => 'bar'}
+      json = output.to_json
+
+      gets = HttpAction::Get.new("", deps.merge({should_cache: true}))
+      gets.expects(execute_against_cache: json)
+      assert_equal output, gets.get
+    end
+    
+    def test_cache_hit
+      url = "/resource"
+      full_url = "#{@endpoint}#{url}"
+      cached_value = "{}"
+      @cache.expects(:get).with(full_url).returns(cached_value)
+      gets = HttpAction::Get.new(url, deps.merge({should_cache: true}))
+      assert_equal cached_value, gets.send(:execute_against_cache)
+    end
+
+    def test_execute_http_call_on_cache_miss
+      url = "/resource" 
+      full_url = "#{@endpoint}#{url}"
+      json_response = "{}"
+      
+      @cache.expects(:get).with(full_url).returns(nil)
+      @cache.expects(:set).with(full_url, json_response)
+
+      gets = HttpAction::Get.new(url, deps.merge({should_cache: true}))
+      gets.expects(execute: json_response)
+      assert_equal json_response, gets.send(:execute_against_cache)
+    end
+
+    def test_does_not_cache_when_no_cache_configured
+      json_response = "{}"
+      
+      @cache = nil
+      gets = HttpAction::Get.new("", deps.merge({should_cache: true}))
+      gets.expects(execute: json_response)
+      gets.send(:execute_against_cache)
+    end
   end
 end

data/test/loquor_test.rb

@@ -7,6 +7,12 @@ module Loquor
       Client.any_instance.expects(:get).with(url)
       Loquor.get(url)
     end
+    
+    def test_get_calls_get_passing_on_args
+      url = "foo"
+      Client.any_instance.expects(:get).with(url, cached=true)
+      Loquor.get(url, cached=true)
+    end
 
     def test_put_calls_put
       url = "foo"

data/test/resource_test.rb

@@ -43,5 +43,13 @@ module Loquor
       Loquor.expects(:put).with("/foobar/#{id}", payload: payload)
       Foobar.update(id, payload)
     end
+   
+    def test_can_read_path
+      assert_equal "/foobar", Foobar.path
+    end
+    
+    def test_cache_flag_false_by_default
+      refute Foobar.cache
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loquor
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors:
 - Jeremy Walker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-11 00:00:00.000000000 Z
+date: 2013-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: filum