Module: Skr::Concerns::ExportScope::ClassMethods

Defined in:
lib/skr/concerns/export_scope.rb

Overview

### Mark a scope as “exportable”

An exported scope is safe for querying by external clients over the API. The scope should always:

* Safely escape data *(should __ALWAYS__ do this anyway, but it bears mentioning again)*
* Be relatively simple and complete quickly.
* Provide value to the client that it cannot obtain by using normal query methods

Instance Method Summary collapse

Instance Method Details

#export_scope(name, query, limit: nil) ⇒ Object

Mark scope as query-able by the API. If given, this will be queried by the API to determining if a given user may call the scope

Parameters:

  • name (Symbol, String) —

    Rails will create a class method with this name

  • query (lambda) —

    Arel query. This is passed off to Rail’s for setting up the scope.

  • limit (Symbol referring to a Class method name, lambda) (defaults to: nil)

Returns:

  • nil



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/skr/concerns/export_scope.rb', line 38

def export_scope(name, query, limit: nil)
    include ExportedLimitEvaluator

    self.exported_scopes ||= Hash.new
    self.exported_scopes[name.to_sym] = {
        scope: scope(name, query),
        name: name,
        limit: limit
    }
    nil
end

#has_exported_scope?(name, user) ⇒ Boolean

The api can query this to determine if the scope is safe to be called from the API by [user]

Parameters:

  • name (Symbol, String) —

    name of scope

  • user (User) —

    who is performing the request. This is passed off to the method or lambda that was given as the limit argument in #export_scope

Returns:

  • (Boolean) 


56
57
58
59
60
61
62
 
# File 'lib/skr/concerns/export_scope.rb', line 56

def has_exported_scope?(name, user)
    if self.exported_scopes && ( scope_options = self.exported_scopes[ name.to_sym ] )
        return evaluate_export_limit( user, :scope, name, scope_options[:limit] )
    else
        return false
    end
end

#scope(name, body, options = {}, &block) ⇒ Object 



25
26
27
28
29
30
 
# File 'lib/skr/concerns/export_scope.rb', line 25

def scope(name, body, options = {}, &block)
    super(name, body, &block)
    if (export = options[:export])
        export_scope(name, body, limit: (export == true ? nil : export[:limit]))
    end
end