cuba-api 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Kristian 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.

data/README.md

@@ -0,0 +1,82 @@
+cuba-api
+========
+
+* [![Build Status](https://secure.travis-ci.org/mkristian/cuba-api.png)](http://travis-ci.org/mkristian/cuba-api)
+* [![Dependency Status](https://gemnasium.com/mkristian/cuba-api.png)](https://gemnasium.com/mkristian/cuba-api)
+* [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/mkristian/cuba-api)
+
+these are just a handful for [cuba](https://github.com/soveran/cuba) to use cuba as API server.
+
+cuba\_-api/config.rb
+------------------
+
+this plugin adds configuration to cuba which inherits from its superclass. this is very similar to `Cuba.settings`.
+
+the short comng of `Cuba.settings`are
+
+* data needs to be marshalable, i.e. needs Marshal.load(Marshal.dump(obj)) to work
+
+* inheritence takes place on class parsing. when you first require all your **cubas** and then set your settings in the root **cuba** then the children will not see this settings. set the data like this
+
+    CubaAPI[ :mykey ] = "mydata"
+    puts CubaAPI[ :mykey ]
+
+cuba\_api/write_aspect.rb 
+-------------------------
+
+first you write out response data with `write( data, options )` instead of using the response object from cuba. then a plugin can register an aspect which is basically a method which has the same arguments as write. now write will call each of the aspects using the result of the aspect as new data object, i.e. chaining those aspects.
+
+cuba\_api/serializer.rb 
+-------------------------
+
+aspect which wraps the data object into a serializer which has `to_json`, `to_yaml` and `to_xml` as configured. see also [ixtlan-babel](https://github.com/mkristian/ixtlan-babel). to configure these methods just **require 'json'** or **require 'yaml'** or any xml lbrary which offers a `to_xml` method on the `Hash` class. dito use an json library which does offer `to_json` on `Hash`.
+
+cuba\_api/accept_content.rb 
+----------------------------
+
+this aspect looks first at the file extension of the path part of the uri and the on request header **Accept** to determine the content type the response shall deliver. it will set the respective content-type as well calls `to_json`, '`to_yaml` or `to_xml` respectively. this aspect plays well with a preceeding serializer aspect ;)
+
+
+cuba\_api/current_user.rb 
+--------------------------
+
+some helper methods to manage a current_user n the session. needs a session-manager in `CubaAPI[ :sessions ]` which respond to `to_session( user_object )` and `from_session( session_data )`. could be something like
+
+    class SessionManager
+	  def to_session( user_object ) user_object.id; end
+	  def from_session( session_data ) User.find_by_id( hash_data ); end
+	end
+
+
+cuba\_api/guard.rb 
+--------------------------
+
+simple authorization which assumes a user belongs to many groups and group has a name attribute. now the cuba "routing" can use this
+
+    on allowed?( :root, :admin ), get, 'configuration' do 
+	   # retrieve configuration allowed by root and admin
+    end
+
+    on allowed?( :root ), put, 'configuration' do 
+	   # update configuration only allowed by root
+    end
+
+Pending
+-------
+
+request payload needs to parse from json, yaml or xml into a hash.
+
+Contributing
+------------
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+meta-fu
+-------
+
+enjoy :) 
+

data/lib/cuba_api/accept_content.rb

@@ -0,0 +1,71 @@
+#
+# 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 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

data/lib/cuba_api/accept_content.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/config.rb

@@ -0,0 +1,41 @@
+#
+# 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"
+
+module CubaApi
+  module Config
+    module ClassMethods
+
+      def config
+        @config ||= {}
+      end
+
+      def []( key )
+        config[ key ] || settings[ key ] || (superclass.respond_to?( :[] ) ? superclass[ key ] : (superclass == Cuba ? Cuba.settings[ key ] : nil ) )
+      end
+
+      def []=( key, value )
+        config[ key ] = value
+      end
+    end
+  end
+end

data/lib/cuba_api/config.rb~

@@ -0,0 +1,28 @@
+# -*- 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'
+
+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 CubaApi::WriteAspect
+  plugin CubaApi::Serializer
+  plugin CubaApi::AcceptContent
+  plugin CubaApi::CurrentUser
+  plugin CubaApi::Guard
+end

data/lib/cuba_api/current_user.rb

@@ -0,0 +1,55 @@
+#
+# 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 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?
+      current_user != nil
+    end
+
+    def current_user_name
+      authenticated? ? current_user.login : "???"
+    end
+  end
+end

data/lib/cuba_api/current_user.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/guard.rb

@@ -0,0 +1,37 @@
+#
+# 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 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
+end