Source

django-fluidproxy / fluidproxy / django_fluidproxy.py

# The MIT License
#
# Copyright (c) 2010 John Chandler
# 
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
# 
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
# 
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.

import hashlib

from django.core.cache import cache
from fom.session       import Fluid

CACHE_TIMEOUT = 60*60


def generate_cache_key( path ):
    """ Returns a key suitable for calls to cache """
    h = hashlib.sha1()
    h.update( path )
    
    return "fluidproxy:%s" % h.hexdigest()
    

class FluidAPIProxy( object ):
    """ A FluidDB API proxy class for use with Django.
        Uses Django's caching framework to cache FluidDB GET requests to:
        - Reduce network usage
        - Improve performance
        - Make it easier to test FluidDB calls without hitting the network
    """
    def __init__( self, fluid ):
        """ fluid: FluidDB session object """
        if not isinstance( fluid, Fluid ):
            raise TypeError( "Argument fluid requires Fluid session object" )  # FIXME: sucky for anyone using a Mock FluidDB session
        self.fluid = fluid

    def get( self, path ):
        """ Make a proxied FluidDB API call """
        key   = generate_cache_key(path)
        value = cache.get( key )
        if not value:
            value = self.fluid.db( "GET", path ).value
            cache.set( key, value, CACHE_TIMEOUT )
        return value

    def preload( self, path, urlargs=None, value=None ):
        """ Preload proxy cache
            path  = FluidDB path e.g. /path/to/tag
            value = value of path
        """        
        cache.set( generate_cache_key(path), value )

    def unload( self, path, urlargs=None ):
        """ Unload proxy cache
            path = FluidDB path e.g. /path/to/tag
        """
        cache.delete( generate_cache_key(path) )
    
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.