virginia 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03c11488de9354f94fb4fddaafc9eea6edb2ea2a
-  data.tar.gz: ef033861cbc75a27ab882d791609966120516376
+  metadata.gz: 07e0d2abf4237b76b1f56162e819f4fd997d811b
+  data.tar.gz: ebd38ebbd3ffb59194c3d5c89ba60be8f66b5241
 SHA512:
-  metadata.gz: 45abb469c15e4dff5e26d2ea886ebe0c147ed404292db70de9466cc4f7fa656d2d4227712e518cde954f8417c924862d7acfa5e689ebd8bdf7133d8eed81d54f
-  data.tar.gz: fa7668f83f4194cf48c618337a17201866bb060580efb4ab4113c0882859a6fffe83d7e0c703d324e85f705a0e5c1688c2c85e43085411b5d0508c89e3c3cec9
+  metadata.gz: 2edaea0ae04deae86d67912d3169c3d502b6dc9c1cb85b436065c39eb6d06d9ae105d18b6d5eecd1ee0b9c2236d5a262cec16e171dcf0a33b80259396611e0b9
+  data.tar.gz: b2f943bda56a7a176448eb6c9e64e66ef2d027bcc97a8baf80736629a96e49eb37bd17cc1d62e66274d5951c38b8479103e426cac1506838e6186b2fc34c0b89

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby
+  - rbx-2.1.1
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: rbx-2.1.1
+    - rvm: ruby-head

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# Version 0.4.0
+  * Add document cache
+
 # Version 0.3.0
   * Switch to Rackup-style app management
 

data/README.md

@@ -51,6 +51,36 @@ run Sinatra::Application
 
 Start Adhearsion.  You should be able to visit `http://localhost:8080/` in your browser and see "Hello world!"
 
+## Using the built-in document cache
+
+Assuming you are using Sinatra like in the above examples, put this in your `lib/sinatra_app.rb`:
+
+```Ruby
+require 'sinatra'
+require 'virginia/document_cache'
+
+get '/documents/:id' do
+  begin
+    grammar = Virginia::DocumentCache.fetch params[:id]
+  rescue Virginia::DocumentCache::NotFound
+    raise Sinatra::NotFound
+  end
+
+  grammar.to_s
+end
+```
+
+Then, to store a document in the cache, do this in your CallController:
+
+```Ruby
+cache_id = Virginia::DocumentCache.store 'Hello World!'
+virginia_config = Adhearsion.config.virginia
+logger.info "Document has been cached to http://#{virginia_config.host}:#{virginia_config.port}/documents/#{cache_id}"
+```
+
+You should be able to retrieve the document at the logged URL.
+
+
 ### Contributors
 
 Original author: [Luca Pradovera](https://github.com/polysics)

data/lib/virginia/document_cache.rb

@@ -0,0 +1,93 @@
+# encoding: utf-8
+require 'singleton'
+
+module Virginia
+  class DocumentCache
+    include Singleton
+
+    NotFound = Class.new StandardError
+
+    attr_reader :mutex
+
+    class << self
+      def method_missing(m, *args, &block)
+        instance.mutex.synchronize do
+          instance.send m, *args, &block
+        end
+      end
+    end
+
+    def initialize
+      @mutex = Mutex.new
+      @documents = {}
+
+      supervisor = Housekeeping.supervise_as :document_cache_housekeeping
+      Adhearsion::Events.register_callback :shutdown do
+        supervisor.terminate
+      end
+    end
+
+    # Registers a new document with the cache
+    # @param [Object] document The document to be stored in the cache
+    # @param [Fixnum, Nil] lifetime The amount of time in seconds the document should be kept. If nil, document will be kept indefinitely.
+    # @param [String, Nil] id The ID to use to store the document. If nil, one will be generated.
+    # @return [String] ID of the stored document
+    def store(document, lifetime = 10, id = nil)
+      id ||= generate_id
+      @documents[id] = {
+        document: document,
+        expires: lifetime ? Time.now + lifetime : nil
+      }
+      id
+    end
+
+    # Deletes a document from the cache
+    # @param [Object] id ID of the document to be removed from the cache
+    # @return [Object, Nil] document Returns the document if found in the cache, nil otherwise
+    def delete(id)
+      data = @documents.delete id
+      data[:document]
+    end
+
+    # Retrieves a document from the cache
+    # @param [String] id ID of the document to be retrieved from the cache
+    # @param [Fixnum, Nil] lifetime The amount of time in seconds the document should be kept. If nil, document will be kept indefinitely.
+    # @yield If given, will be used to generate the document, store it, and then return.
+    # @return [Object] document Returns the document if found in the cache
+    # @raises [NotFound] If the document is not found in the cache
+    def fetch(id, lifetime = 10)
+      unless @documents.has_key? id
+        if block_given?
+          store yield, lifetime, id
+        else
+          raise NotFound
+        end
+      end
+      
+      @documents[id][:document]
+    end
+
+    def reap_expired!
+      @documents.each_pair do |id, data|
+        @documents.delete(id) if data[:expires] < Time.now
+      end
+    end
+
+    class Housekeeping
+      include Celluloid
+
+      def initialize
+        every(1.minute) do
+          logger.debug "Reaping expired cached document"
+          DocumentCache.reap_expired!
+        end
+      end
+    end
+
+  private
+
+    def generate_id
+      SecureRandom.hex(16)
+    end
+  end
+end

data/lib/virginia/version.rb

@@ -1,3 +1,3 @@
 module Virginia
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: virginia
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Luca Pradovera
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-31 00:00:00.000000000 Z
+date: 2015-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: adhearsion
@@ -131,6 +131,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -138,6 +139,7 @@ files:
 - README.md
 - Rakefile
 - lib/virginia.rb
+- lib/virginia/document_cache.rb
 - lib/virginia/plugin.rb
 - lib/virginia/service.rb
 - lib/virginia/version.rb
@@ -166,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: virginia
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A Reel interface to Adhearsion