thebigdb 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 208086548323d779597adb12e40c415503bb4dc8
-  data.tar.gz: 3b2ed441b52ac2c9c386f8652f8cb16c7ca5fc45
+  metadata.gz: 497657ac10b1d270d7a6827074c8f24bc00bc31c
+  data.tar.gz: d21318628a21382b4d99dc28e84ee50dbcccf539
 SHA512:
-  metadata.gz: 84e73081cd80956a93279d9582d88c8e5fe96697563f93734c123510ec289c1446a45c99300f317af0b5698eedbdc6b417f032578c5fc20af132933b9501c6f0
-  data.tar.gz: 786aaa6c59bb08c373a8b896397738f99408944111d5a5bc05ece4fde65a607230f8f21b5d91a0c0a46d43c16d06b5f067de6545e97af332b974508e5ab02bbe
+  metadata.gz: 02ab00730de9b280d70d3fe8c3bfee5806ee363d574df346c843b41b77a2fc0c3f26346627859fd186d062802002d05e062c53983f124cd556ecb78c7227da89
+  data.tar.gz: cc76d9296128d5b537d4e6fdba61bf2f27eeed2f27710462e617c614b1e719a09bbf68c1b591ee7e06f8dbe7f384894c99e08cecb878a40e90a9a38c76934417

data/README.md

@@ -72,15 +72,35 @@ You can modify the TheBigDB module with several configuration options:
       # your code here
     end
 
+### Caching
+
+If you want to cache the http requests made, you can change the option ``http_request_executor``:
+
+    TheBigDB.http_request_executor # default: Proc.new {|http, http_request| http.request(http_request) }
+    
+If you're using Rails caching system, you may want to do something like this:
+    
+    TheBigDB.http_request_executor = Proc.new do |http, http_request|
+      cache_key = "thebigdb-request-" + Digest::SHA1.hexdigest(Marshal.dump(http_request))
+      
+      marshalled_response = Rails.cache.fetch(cache_key) do
+        Marshal.dump(http.request(http_request))
+      end
+      
+      Marshal.load(marshalled_response)
+    end
+    
+Please remember that all the callbacks (``before_request_execution`` and ``after_request_execution``) will still be executed: ``http_request_executor`` only surrounds the actual execution of the http request by the ``http`` object.
 
 ## Contributing
 
 Don't hesitate to send a pull request !
 
 ## Testing
-  
-    rspec spec/
+    
+    $ bundle install
+    $ bundle exec rspec spec/
 
 ## License
 
-This software is distributed under the MIT License. Copyright (c) 2013, Christophe Maximin <christophe@thebigdb.com>
+This software is distributed under the MIT License. Copyright (c) 2013-2014, Christophe Maximin <christophe@thebigdb.com>

data/lib/thebigdb.rb

@@ -25,7 +25,8 @@ module TheBigDB
     "verify_ssl_certificates" => false,
     "before_request_execution" => Proc.new{},
     "after_request_execution" => Proc.new{},
-    "raise_on_api_status_error" => false
+    "raise_on_api_status_error" => false,
+    "http_request_executor" => Proc.new {|http, http_request| http.request(http_request) }
   }
 
   DEFAULT_CONFIGURATION.each_key do |configuration_key|

data/lib/thebigdb/request.rb

@@ -88,7 +88,7 @@ module TheBigDB
       TheBigDB.before_request_execution.call(self)
 
       # Here is where the request is actually executed
-      @http_response = @http.request(@http_request)
+      @http_response = TheBigDB.http_request_executor.call(@http, @http_request)
 
       # Setting @response
       begin

data/lib/thebigdb/version.rb

@@ -1,7 +1,7 @@
 module TheBigDB
   module VERSION
     MAJOR = 1
-    MINOR = 3
+    MINOR = 4
     TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].compact.join('.')

data/thebigdb.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new do |s|
   s.authors = ["Christophe Maximin"]
   s.email = "christophe@thebigdb.com"
   s.homepage = "http://thebigdb.com"
+  s.licenses = ['MIT']
 
   s.platform = Gem::Platform::RUBY
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thebigdb
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Christophe Maximin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-03 00:00:00.000000000 Z
+date: 2014-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -154,7 +154,8 @@ files:
 - spec/thebigdb_spec.rb
 - thebigdb.gemspec
 homepage: http://thebigdb.com
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []