praxis 0.10.1 → 0.11pre

data/spec/spec_app/config/praxis_mapper.yml

@@ -0,0 +1,6 @@
+log_stats: skip
+repositories:
+  default:    
+    #type: sequel # -- default type
+    adapter: sqlite
+    database: ':memory:'

data/spec/spec_app/config/sequel_model.yml

@@ -0,0 +1,2 @@
+adapter: sqlite
+database: db/development.sqlite3

data/spec/spec_app/config/stats.yml

@@ -0,0 +1,8 @@
+collector:
+  :type: Harness::FakeCollector
+  #:args:
+  #  :host: localhost
+  #  :postfix: somepostfix
+  #  :prefix: someprefix
+queue:
+  :type: Harness::AsyncQueue

data/spec/spec_app/config/stats.yml.dis

@@ -0,0 +1,8 @@
+namespace: my-app
+collector:
+  type: Harness::FakeCollector
+  args:
+    - example.com
+    - 8000
+queue:
+  type: Harness::AsyncQueue

data/spec/spec_app/design/resources/instances.rb

@@ -5,19 +5,24 @@ module ApiResources
     media_type Instance
     version '1.0'
 
-    #response_groups :premium
     #responses :instance_limit_reached
     #responses :pay_us_money
     #response :create, location: /instances/
 
-    use :authenticated
+    
 
     routing do
       prefix '/clouds/:cloud_id/instances'
     end
 
-    params do
-      attribute :cloud_id, Integer, required: true
+    action_defaults do
+      use :authenticated
+
+      requires_ability :read
+
+      params do
+        attribute :cloud_id, Integer, required: true
+      end
     end
 
     action :index do
@@ -45,6 +50,7 @@ module ApiResources
       end
 
       response :ok
+      response :unauthorized
 
       params do
         attribute :id
@@ -58,7 +64,6 @@ module ApiResources
       end
     end
 
-
     action :bulk_create do
       routing do
         post ''
@@ -68,18 +73,18 @@ module ApiResources
 
       # Using a hash param for parts
       response :bulk_response ,
-                parts: {
-                  like: :created,
-                  location: /\/instances\//
-                }
+      parts: {
+        like: :created,
+        location: /\/instances\//
+      }
 
-# Using a block for parts to defin a sub-request
-#     sub_request = proc do
-#                     status 201
-#                     media_type Instance
-#                     headers ['X-Foo','X-Bar']
-#                   end
-#     response :bulk_response, parts: sub_request
+      # Using a block for parts to defin a sub-request
+      #     sub_request = proc do
+      #                     status 201
+      #                     media_type Instance
+      #                     headers ['X-Foo','X-Bar']
+      #                   end
+      #     response :bulk_response, parts: sub_request
 
 
       # multi 200, H1
@@ -120,8 +125,40 @@ module ApiResources
       end
 
       response :ok, media_type: 'application/json'
+      response :validation_error # TODO: include this by default, or rethink.
     end
 
+    action :terminate do
+      routing do
+        post '/:id/terminate'
+      end
+      
+      requires_ability :terminate
+
+      params do
+        attribute :id
+      end
+
+      payload do 
+        attribute :when, DateTime
+      end
+
+      response :ok, media_type: 'application/json'
+    end
+
+    action :stop do
+      routing do
+        post '/:id/stop'
+      end
+      requires_ability :stop
+
+      params do
+        attribute :id
+      end
+
+
+      response :ok, media_type: 'application/json'
+    end
 
     # OTHER USAGES:
     #   note: these are all hypothetical, pending, brainstorming usages.

data/spec/spec_app/design/resources/volumes.rb

@@ -3,9 +3,19 @@ module ApiResources
     include Praxis::ResourceDefinition
 
     media_type Volume
-    version '1.0'
+    version '1.0', using: :path
 
-    use :authenticated
+    action_defaults do
+      use :authenticated
+    end
+
+    action :index do
+      routing do
+        get ''
+      end
+      response :ok
+      response :unauthorized
+    end
 
     action :show do
       routing do
@@ -13,6 +23,7 @@ module ApiResources
       end
 
       response :ok
+      response :unauthorized
 
       params do
         attribute :id

data/spec/spec_helper.rb

@@ -28,6 +28,9 @@ RSpec.configure do |config|
   config.before(:suite) do
     Praxis::Blueprint.caching_enabled = true
     Praxis::Application.instance.setup(root:'spec/spec_app')
+
+    # create the table
+    setup_database!
   end
 
   config.before(:each) do
@@ -37,3 +40,14 @@ RSpec.configure do |config|
   end
 
 end
+
+# create the test db schema
+def setup_database!
+  mapper = Praxis::Application.instance.plugins[:praxis_mapper]
+  Sequel.connect(mapper.config.repositories["default"]['connection_settings'].dump) do |db|
+    db.create_table! :people do
+      primary_key :id
+      string :name
+    end
+  end
+end

data/spec/support/spec_authentication_plugin.rb

@@ -0,0 +1,126 @@
+require 'singleton'
+
+class Authenticator
+  include Attributor::Type
+
+  def self.native_type
+    Class
+  end
+
+  def self.load(value,context=Attributor::DEFAULT_ROOT_CONTEXT, **options)
+    case value
+    when Hash
+      type = value.delete(:type) || value.delete('type')
+      Object.const_get(type).new(**value)
+    when self
+      value
+    else
+      raise "#{self.naem} can not load values of type #{value.class}"
+    end
+  end
+
+  def self.validate(*args)
+  end
+
+  def self.describe
+  end
+
+  def initialize(**options)
+  end
+
+  def authenticate(request)
+    raise "sublcass must implement authenticate"
+  end
+
+end
+
+
+class GlobalSessionAuthenticator < Authenticator
+
+  def self.load(value,context=Attributor::DEFAULT_ROOT_CONTEXT, **options)
+    self.new(**value)
+  end
+
+  def self.describe
+  end
+
+  def initialize(**options)
+  end
+
+  def authenticate(request)
+    body = {name: 'Unauthorized'}
+
+    if (session = request.env['global_session'])
+      return true if session.valid?
+      body[:message] = 'Invalid session.'
+    else
+      body[:message] = 'Missing session.'
+    end
+
+    Praxis::Responses::Unauthorized.new(body: body)
+  end
+
+end
+
+
+module AuthenticationPlugin
+  include Praxis::PluginConcern
+
+  class Plugin < Praxis::Plugin
+    include Singleton
+
+    def initialize
+      @options = {config_file: 'config/authentication.yml'}
+    end
+
+    def config_key
+      :authentication
+    end
+
+    def prepare_config!(node)
+      self.config_attribute = Attributor::Attribute.new(Authenticator, required: true)
+    end
+
+    def self.authenticate(request)
+      instance.config.authenticate(request)
+    end
+
+  end
+
+
+  module Request
+  end
+
+  module Controller
+    extend ActiveSupport::Concern
+
+    included do
+      before :action do |controller|
+        if controller.request.action.authentication_required
+          Plugin.authenticate(controller.request)
+        end
+      end
+    end
+
+  end
+
+
+  module ActionDefinition
+    extend ActiveSupport::Concern
+
+    included do
+      decorate_docs do |action, docs|
+        docs[:authentication_required] = action.authentication_required
+      end
+    end
+
+    def requires_authentication(value)
+      @authentication_required = value
+    end
+
+    def authentication_required
+      @authentication_required ||= false
+    end
+
+  end
+end

data/spec/support/spec_authorization_plugin.rb

@@ -0,0 +1,95 @@
+require 'singleton'
+
+module AuthorizationPlugin
+  include Praxis::PluginConcern
+
+  class Plugin < Praxis::Plugin
+    include Singleton
+
+    def config_key
+      :authorization
+    end
+
+    def initialize
+      @options = {config_file: 'config/authorization.yml'}
+    end
+
+    def prepare_config!(node)
+      node.attributes do
+        attribute :default_abilities, Attributor::Collection
+      end
+    end
+
+    def default_abilities
+      config.default_abilities
+    end
+
+    def authorized?(request)
+      abilities = default_abilities.clone
+      abilities |= request.user_abilities
+
+      (request.action.required_abilities - abilities).empty?
+    end
+
+  end
+
+  module Request
+    def user_abilities
+      []
+    end
+  end
+
+  module Controller
+    extend ActiveSupport::Concern
+
+    included do
+
+      before :action do |controller|
+        verify_abilities(controller.request)
+      end
+
+    end
+
+
+    module ClassMethods
+      def verify_abilities(request)
+        return true unless request.action.required_abilities
+
+        authorized = AuthorizationPlugin::Plugin.instance.authorized?(request)
+
+        unless authorized
+          return Praxis::Responses::Forbidden.new
+        end
+      end
+    end
+
+    def subject
+      #p [self, :subject]
+    end
+  end
+
+  module ResourceDefinition
+
+  end
+
+  module ActionDefinition
+    extend ActiveSupport::Concern
+
+    included do
+      attr_accessor :required_abilities
+      decorate_docs do |action, docs|
+        docs[:required_abilities] = action.required_abilities
+      end
+    end
+
+    def requires_ability(ability)
+      @required_abilities ||= []
+      @required_abilities << ability
+
+      response :forbidden
+      requires_authentication true
+    end
+  end
+
+
+end

data/spec/support/spec_praxis_mapper_plugin.rb

@@ -0,0 +1,157 @@
+require 'praxis-mapper'
+require 'singleton'
+
+require 'terminal-table'
+
+module PraxisMapperPlugin
+  include Praxis::PluginConcern
+
+  class RepositoryConfig < Attributor::Hash
+    self.key_type = String
+
+    keys allow_extra: true do
+      key 'type', String, default: 'sequel'
+      extra 'connection_settings'
+    end
+
+  end
+
+
+  class Plugin < Praxis::Plugin
+    include Singleton
+
+    def initialize
+      @options = {config_file: 'config/praxis_mapper.yml'}
+    end
+
+    def config_key
+      :praxis_mapper
+    end
+
+    def prepare_config!(node)
+      node.attributes do
+        attribute :log_stats, String, values: ['detailed', 'short', 'skip'], default: 'detailed'
+        attribute :repositories, Attributor::Hash.of(key: String, value: RepositoryConfig)
+      end
+    end
+
+    def setup!
+      self.config.repositories.each do |repository_name, repository_config|
+        type = repository_config['type']
+        connection_settings = repository_config['connection_settings']
+
+        case type
+        when 'sequel'
+          self.setup_sequel_repository(repository_name, connection_settings)
+        else
+          raise "unsupported repository type: #{type}"
+        end
+
+      end
+
+      Praxis::Notifications.subscribe 'praxis.request.all' do |name, *junk, payload|
+        if (identity_map = payload[:request].identity_map)
+          PraxisMapperPlugin::Statistics.log(identity_map)
+        end
+      end
+
+    end
+
+    def setup_sequel_repository(name, settings)
+      db = Sequel.connect(settings.dump.symbolize_keys)
+
+      Praxis::Mapper::ConnectionManager.setup do
+        repository(name.to_sym) { db }
+      end
+    end
+
+  end
+
+  module Request
+    def identity_map
+      @identity_map
+    end
+
+    def identity_map=(map)
+      @identity_map = map
+    end
+  end
+
+  module Controller
+    extend ActiveSupport::Concern
+
+    included do
+      before :action do |controller|
+        controller.request.identity_map ||= Praxis::Mapper::IdentityMap.new
+      end
+
+      after :action do |controller|
+      end
+    end
+
+  end
+
+  module Statistics
+
+    def self.log(identity_map)
+      return if identity_map.nil?
+      case PraxisMapperPlugin::Plugin.instance.config.log_stats
+      when 'detailed'
+        self.detailed(identity_map)
+      when 'short'
+        self.short(identity_map)
+      when 'skip'
+      end
+    end
+
+    def self.detailed(identity_map)
+      stats_by_model = identity_map.query_statistics.sum_totals_by_model
+      stats_total = identity_map.query_statistics.sum_totals
+      fields = [ :query_count, :records_loaded, :datastore_interactions, :datastore_interaction_time]
+      rows = []
+
+      total_models_loaded = 0
+      # stats per model
+      stats_by_model.each do |model, totals|
+        total_values = totals.values_at(*fields)
+        self.round_fields_at( total_values , [fields.index(:datastore_interaction_time)])
+        row = [ model ] + total_values
+        models_loaded = identity_map.all(model).size
+        total_models_loaded += models_loaded
+        row << models_loaded
+        rows << row
+      end
+
+      rows << :separator
+
+      # totals for all models
+      stats_total_values = stats_total.values_at(*fields)
+      self.round_fields_at(stats_total_values , [fields.index(:datastore_interaction_time)])
+      rows << [ "All Models" ] + stats_total_values + [total_models_loaded]
+
+      table = Terminal::Table.new \
+        :rows => rows,
+        :title => "Praxis::Mapper Statistics",
+        :headings => [ "Model", "# Queries", "Records Loaded", "Interactions", "Time(sec)", "Models Loaded" ]
+
+      table.align_column(1, :right)
+      table.align_column(2, :right)
+      table.align_column(3, :right)
+      table.align_column(4, :right)
+      table.align_column(5, :right)
+      Praxis::Application.instance.logger.info "Praxis::Mapper Statistics:\n#{table.to_s}"
+    end
+
+    def self.round_fields_at(values, indices)
+      indices.each do |idx|
+        values[idx] = "%.3f" % values[idx]
+      end
+    end
+
+    def self.short(identity_map)
+      Praxis::Application.instance.logger.info "Praxis::Mapper Statistics: #{identity_map.query_statistics.sum_totals.to_s}"
+    end
+
+  end
+
+end