cuba-api 0.1.0

data/lib/cuba_api/guard.rb~

@@ -0,0 +1,176 @@
+# -*- Coding: utf-8 -*-
+require "cuba"
+require 'ixtlan/babel/factory'
+
+module CubaApi
+  module WriteAspect
+
+    module ClassMethods
+      def append_aspect( arg )
+        aspects << arg
+        warn "[CubaAPI] Appended aspect #{arg}"
+      end
+
+      def prepend_aspect( arg )
+        aspects.insert( 0, arg )
+        warn "[CubaAPI] Prepended aspect #{arg}"
+      end
+
+      def aspects
+        self[ :aspects ] ||= []
+      end
+    end
+
+    def head( status )
+      res.status = status
+      res.write ''
+    end
+
+    def write( obj, args = {} )
+      self.res.status = args[:status] || 200
+      # make sure we inherit aspects and repsect the order
+      aspects = self.class == CubaAPI ? [] : self.class.superclass[ :aspects ]
+      (aspects + self.class[ :aspects ]).uniq.each do |w|
+        obj = send( w, obj, args ) if obj
+      end
+      res.write obj.to_s
+    end
+  end
+
+  module Serializer
+
+    def serializer_factory
+      @_factory ||= Ixtlan::Babel::Factory.new
+    end
+    private :serializer_factory
+
+    def serializer( obj, args = {})
+      if args[:serializer] == false || obj.is_a?( String )
+        obj
+      else
+        s = serializer_factory.new( obj )
+        s.use( args[ :use ] ) if args[ :use ]
+        s
+      end
+    end
+
+    def self.included( base )
+      base.append_aspect :serializer
+    end
+  end
+
+  module CurrentUser
+
+    module ClassMethods
+
+      def sessions
+        self[ :sessions ]
+      end
+
+    end
+
+    def current_user( user = nil )
+      if user
+        session['user'] =  self.class.sessions.to_session( user )
+        @_current_user = user
+      else
+        @_current_user ||= self.class.sessions.from_session( session['user'] )
+      end
+    end
+
+    def reset_current_user
+      session[ 'user' ] = nil
+    end
+
+    def authenticated?
+      session[ 'user' ] != nil
+    end
+
+    def current_user_name
+      authenticated? ? current_user.login : "???"
+    end
+  end
+
+  module Guard
+    def allowed?( *group_names )
+      authenticated? && ( allowed_groups( *group_names ).size > 0 )
+    end
+
+    def allowed_groups( *group_names )
+      current_groups.select { |g| group_names.member?( g.name ) }
+    end
+
+    def current_groups
+      current_user.groups
+    end
+  end
+
+  module AcceptContent
+
+    module ClassMethods
+
+      MIMES = { :yaml => ['application/x-yaml', 'text/yaml'],
+        :json => ['application/json'],
+        :xml => ['application/xml'] }
+
+      def accept( *args )
+        args.each do |arg|
+          (MIMES[ arg ] || []).each do |mime|
+            mimes[ mime ] = "to_#{arg}".to_sym
+          end
+        end
+        warn "[CubaAPI] Accept: #{mimes.keys.join(', ')}"
+      end
+
+      def mimes
+        self[ :mimes ] ||= {}
+      end
+    end
+
+    def accept_content( obj, options = {} )
+      script = env[ 'SCRIPT_NAME' ]
+      if script =~ /\./
+        extension = script.sub( /^.*\./, '' )
+        mime = ClassMethods::MIMES[ extension.to_sym ] || []
+        accept( obj, mime.first )
+      else
+        accept( obj, env[ 'HTTP_ACCEPT' ] )
+      end
+    end
+
+    def accept( obj, mime )
+      if self.class[ :mimes ].key?( mime )
+        res[ "Content-Type" ] = mime + "; charset=utf-8"
+        obj.send self.class[ :mimes ][ mime ]
+      else
+        head 404
+        nil
+      end
+    end
+    private :accept
+
+    def self.included( base )
+      base.append_aspect :accept_content
+    end
+  end
+end
+
+class CubaAPI < Cuba
+  def self.map
+    @map ||= {}
+  end
+
+  def self.[]( key )
+    map[ key ] || settings[ key ] || (superclass == Cuba ? Cuba.settings[ key ] : superclass[ key ])
+  end
+
+  def self.[]=( key, value )
+    map[ key ] = value
+  end
+
+  plugin Ixtlan::Write
+  plugin Ixtlan::Serializer
+  plugin Ixtlan::AcceptContent
+  plugin Ixtlan::CurrentUser
+  plugin Ixtlan::Guard
+end

data/lib/cuba_api/serializer.rb

@@ -0,0 +1,47 @@
+#
+# Copyright (C) 2012 Christian Meier
+#
+# 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.
+#
+# -*- Coding: utf-8 -*-
+require 'ixtlan/babel/factory'
+
+module CubaApi
+  module Serializer
+
+    module ClassMethods
+      def serializer_factory
+        @_factory ||= Ixtlan::Babel::Factory.new
+      end
+    end
+
+    def serializer( obj, options = {})
+      if options[:serializer] == false || obj.is_a?( String )
+        obj
+      else
+        s = self.class.serializer_factory.new( obj )
+        s.use( options[ :use ] ) if options[ :use ]
+        s
+      end
+    end
+
+    def self.included( base )
+      base.append_aspect :serializer
+    end
+  end
+end

data/lib/cuba_api/serializer.rb~

@@ -0,0 +1,176 @@
+# -*- Coding: utf-8 -*-
+require "cuba"
+require 'ixtlan/babel/factory'
+
+module CubaApi
+  module WriteAspect
+
+    module ClassMethods
+      def append_aspect( arg )
+        aspects << arg
+        warn "[CubaAPI] Appended aspect #{arg}"
+      end
+
+      def prepend_aspect( arg )
+        aspects.insert( 0, arg )
+        warn "[CubaAPI] Prepended aspect #{arg}"
+      end
+
+      def aspects
+        self[ :aspects ] ||= []
+      end
+    end
+
+    def head( status )
+      res.status = status
+      res.write ''
+    end
+
+    def write( obj, args = {} )
+      self.res.status = args[:status] || 200
+      # make sure we inherit aspects and repsect the order
+      aspects = self.class == CubaAPI ? [] : self.class.superclass[ :aspects ]
+      (aspects + self.class[ :aspects ]).uniq.each do |w|
+        obj = send( w, obj, args ) if obj
+      end
+      res.write obj.to_s
+    end
+  end
+
+  module Serializer
+
+    def serializer_factory
+      @_factory ||= Ixtlan::Babel::Factory.new
+    end
+    private :serializer_factory
+
+    def serializer( obj, args = {})
+      if args[:serializer] == false || obj.is_a?( String )
+        obj
+      else
+        s = serializer_factory.new( obj )
+        s.use( args[ :use ] ) if args[ :use ]
+        s
+      end
+    end
+
+    def self.included( base )
+      base.append_aspect :serializer
+    end
+  end
+
+  module CurrentUser
+
+    module ClassMethods
+
+      def sessions
+        self[ :sessions ]
+      end
+
+    end
+
+    def current_user( user = nil )
+      if user
+        session['user'] =  self.class.sessions.to_session( user )
+        @_current_user = user
+      else
+        @_current_user ||= self.class.sessions.from_session( session['user'] )
+      end
+    end
+
+    def reset_current_user
+      session[ 'user' ] = nil
+    end
+
+    def authenticated?
+      session[ 'user' ] != nil
+    end
+
+    def current_user_name
+      authenticated? ? current_user.login : "???"
+    end
+  end
+
+  module Guard
+    def allowed?( *group_names )
+      authenticated? && ( allowed_groups( *group_names ).size > 0 )
+    end
+
+    def allowed_groups( *group_names )
+      current_groups.select { |g| group_names.member?( g.name ) }
+    end
+
+    def current_groups
+      current_user.groups
+    end
+  end
+
+  module AcceptContent
+
+    module ClassMethods
+
+      MIMES = { :yaml => ['application/x-yaml', 'text/yaml'],
+        :json => ['application/json'],
+        :xml => ['application/xml'] }
+
+      def accept( *args )
+        args.each do |arg|
+          (MIMES[ arg ] || []).each do |mime|
+            mimes[ mime ] = "to_#{arg}".to_sym
+          end
+        end
+        warn "[CubaAPI] Accept: #{mimes.keys.join(', ')}"
+      end
+
+      def mimes
+        self[ :mimes ] ||= {}
+      end
+    end
+
+    def accept_content( obj, options = {} )
+      script = env[ 'SCRIPT_NAME' ]
+      if script =~ /\./
+        extension = script.sub( /^.*\./, '' )
+        mime = ClassMethods::MIMES[ extension.to_sym ] || []
+        accept( obj, mime.first )
+      else
+        accept( obj, env[ 'HTTP_ACCEPT' ] )
+      end
+    end
+
+    def accept( obj, mime )
+      if self.class[ :mimes ].key?( mime )
+        res[ "Content-Type" ] = mime + "; charset=utf-8"
+        obj.send self.class[ :mimes ][ mime ]
+      else
+        head 404
+        nil
+      end
+    end
+    private :accept
+
+    def self.included( base )
+      base.append_aspect :accept_content
+    end
+  end
+end
+
+class CubaAPI < Cuba
+  def self.map
+    @map ||= {}
+  end
+
+  def self.[]( key )
+    map[ key ] || settings[ key ] || (superclass == Cuba ? Cuba.settings[ key ] : superclass[ key ])
+  end
+
+  def self.[]=( key, value )
+    map[ key ] = value
+  end
+
+  plugin Ixtlan::Write
+  plugin Ixtlan::Serializer
+  plugin Ixtlan::AcceptContent
+  plugin Ixtlan::CurrentUser
+  plugin Ixtlan::Guard
+end

data/lib/cuba_api/write_aspect.rb

@@ -0,0 +1,57 @@
+#
+# Copyright (C) 2012 Christian Meier
+#
+# 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.
+#
+# -*- Coding: utf-8 -*-
+
+module CubaApi
+  module WriteAspect
+
+    module ClassMethods
+      def append_aspect( arg )
+        aspects << arg
+        warn "[CubaAPI] Appended aspect #{arg}"
+      end
+
+      def prepend_aspect( arg )
+        aspects.insert( 0, arg )
+        warn "[CubaAPI] Prepended aspect #{arg}"
+      end
+
+      def aspects
+        self[ :aspects ] ||= []
+      end
+    end
+
+    def head( status )
+      res.status = status
+      res.write ''
+    end
+
+    def write( obj, options = {} )
+      self.res.status = options[:status] || 200
+      # make sure we inherit aspects and repsect the order
+      aspects = self.class[ :aspects ] # == CubaAPI ? [] : self.class.superclass[ :aspects ]
+      (aspects + self.class[ :aspects ]).uniq.each do |w|
+        obj = send( w, obj, options ) if obj
+      end
+      res.write obj.to_s
+    end
+  end
+end

data/lib/cuba_api/write_aspect.rb~

@@ -0,0 +1,39 @@
+# -*- Coding: utf-8 -*-
+require "cuba"
+require 'ixtlan/babel/factory'
+
+module CubaApi
+  module WriteAspects
+
+    module ClassMethods
+      def append_aspect( arg )
+        aspects << arg
+        warn "[CubaAPI] Appended aspect #{arg}"
+      end
+
+      def prepend_aspect( arg )
+        aspects.insert( 0, arg )
+        warn "[CubaAPI] Prepended aspect #{arg}"
+      end
+
+      def aspects
+        self[ :aspects ] ||= []
+      end
+    end
+
+    def head( status )
+      res.status = status
+      res.write ''
+    end
+
+    def write( obj, args = {} )
+      self.res.status = args[:status] || 200
+      # make sure we inherit aspects and repsect the order
+      aspects = self.class == CubaAPI ? [] : self.class.superclass[ :aspects ]
+      (aspects + self.class[ :aspects ]).uniq.each do |w|
+        obj = send( w, obj, args ) if obj
+      end
+      res.write obj.to_s
+    end
+  end
+end

data/lib/cuba_api/write_aspects.rb~

@@ -0,0 +1,176 @@
+# -*- Coding: utf-8 -*-
+require "cuba"
+require 'ixtlan/babel/factory'
+
+module CubaApi
+  module WriteAspect
+
+    module ClassMethods
+      def append_aspect( arg )
+        aspects << arg
+        warn "[CubaAPI] Appended aspect #{arg}"
+      end
+
+      def prepend_aspect( arg )
+        aspects.insert( 0, arg )
+        warn "[CubaAPI] Prepended aspect #{arg}"
+      end
+
+      def aspects
+        self[ :aspects ] ||= []
+      end
+    end
+
+    def head( status )
+      res.status = status
+      res.write ''
+    end
+
+    def write( obj, args = {} )
+      self.res.status = args[:status] || 200
+      # make sure we inherit aspects and repsect the order
+      aspects = self.class == CubaAPI ? [] : self.class.superclass[ :aspects ]
+      (aspects + self.class[ :aspects ]).uniq.each do |w|
+        obj = send( w, obj, args ) if obj
+      end
+      res.write obj.to_s
+    end
+  end
+
+  module Serializer
+
+    def serializer_factory
+      @_factory ||= Ixtlan::Babel::Factory.new
+    end
+    private :serializer_factory
+
+    def serializer( obj, args = {})
+      if args[:serializer] == false || obj.is_a?( String )
+        obj
+      else
+        s = serializer_factory.new( obj )
+        s.use( args[ :use ] ) if args[ :use ]
+        s
+      end
+    end
+
+    def self.included( base )
+      base.append_aspect :serializer
+    end
+  end
+
+  module CurrentUser
+
+    module ClassMethods
+
+      def sessions
+        self[ :sessions ]
+      end
+
+    end
+
+    def current_user( user = nil )
+      if user
+        session['user'] =  self.class.sessions.to_session( user )
+        @_current_user = user
+      else
+        @_current_user ||= self.class.sessions.from_session( session['user'] )
+      end
+    end
+
+    def reset_current_user
+      session[ 'user' ] = nil
+    end
+
+    def authenticated?
+      session[ 'user' ] != nil
+    end
+
+    def current_user_name
+      authenticated? ? current_user.login : "???"
+    end
+  end
+
+  module Guard
+    def allowed?( *group_names )
+      authenticated? && ( allowed_groups( *group_names ).size > 0 )
+    end
+
+    def allowed_groups( *group_names )
+      current_groups.select { |g| group_names.member?( g.name ) }
+    end
+
+    def current_groups
+      current_user.groups
+    end
+  end
+
+  module AcceptContent
+
+    module ClassMethods
+
+      MIMES = { :yaml => ['application/x-yaml', 'text/yaml'],
+        :json => ['application/json'],
+        :xml => ['application/xml'] }
+
+      def accept( *args )
+        args.each do |arg|
+          (MIMES[ arg ] || []).each do |mime|
+            mimes[ mime ] = "to_#{arg}".to_sym
+          end
+        end
+        warn "[CubaAPI] Accept: #{mimes.keys.join(', ')}"
+      end
+
+      def mimes
+        self[ :mimes ] ||= {}
+      end
+    end
+
+    def accept_content( obj, options = {} )
+      script = env[ 'SCRIPT_NAME' ]
+      if script =~ /\./
+        extension = script.sub( /^.*\./, '' )
+        mime = ClassMethods::MIMES[ extension.to_sym ] || []
+        accept( obj, mime.first )
+      else
+        accept( obj, env[ 'HTTP_ACCEPT' ] )
+      end
+    end
+
+    def accept( obj, mime )
+      if self.class[ :mimes ].key?( mime )
+        res[ "Content-Type" ] = mime + "; charset=utf-8"
+        obj.send self.class[ :mimes ][ mime ]
+      else
+        head 404
+        nil
+      end
+    end
+    private :accept
+
+    def self.included( base )
+      base.append_aspect :accept_content
+    end
+  end
+end
+
+class CubaAPI < Cuba
+  def self.map
+    @map ||= {}
+  end
+
+  def self.[]( key )
+    map[ key ] || settings[ key ] || (superclass == Cuba ? Cuba.settings[ key ] : superclass[ key ])
+  end
+
+  def self.[]=( key, value )
+    map[ key ] = value
+  end
+
+  plugin Ixtlan::Write
+  plugin Ixtlan::Serializer
+  plugin Ixtlan::AcceptContent
+  plugin Ixtlan::CurrentUser
+  plugin Ixtlan::Guard
+end

data/lib/cuba_api.rb

@@ -0,0 +1,40 @@
+#
+# Copyright (C) 2012 Christian Meier
+#
+# 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.
+#
+# -*- Coding: utf-8 -*-
+require "cuba"
+
+require 'cuba_api/write_aspect'
+require 'cuba_api/serializer'
+require 'cuba_api/current_user'
+require 'cuba_api/guard'
+require 'cuba_api/accept_content'
+require 'cuba_api/config'
+
+class CubaAPI < Cuba
+
+  plugin CubaApi::Config
+  plugin CubaApi::WriteAspect
+  plugin CubaApi::Serializer
+  plugin CubaApi::AcceptContent
+  plugin CubaApi::CurrentUser
+  plugin CubaApi::Guard
+
+end