DistelliServiceFrameworkSinatra 1.0

data/lib/distelli/serviceframeworksinatra.rb

@@ -0,0 +1,215 @@
+#!/usr/bin/env ruby
+
+require 'sinatra/base'
+require 'logging'
+require 'distelli/serviceinterface'
+require 'distelli/servicemarshallers'
+
+module Rack
+  class CommonLogger
+    def call(env)
+      # do nothing
+      @app.call(env)
+    end
+  end
+end
+
+module Distelli
+  class ServiceBase < Sinatra::Base
+
+    my_layout = Logging::Layouts::Pattern.new(:pattern => "%d:[%l]:[%t]:[%c]:%m\n")
+    rf_appender = Logging::Appenders::RollingFile.new('TestRubyService', :filename => './logs/TestRubyService.log', :layout => my_layout, :roll_by => 'date', :age => '3600')
+    disable :raise_errors
+    disable :show_exceptions
+    disable :dump_errors
+    
+    # Parse the json config file and get the application name and
+    # version to set the log file name
+
+    LOGGER = Logging.logger[:root]
+    LOGGER.add_appenders(rf_appender)
+    LOGGER.level = :debug
+    LOGGER.debug("TestRubyService initialized!")
+
+    def initialize()
+      super()
+      @xml_marshaller = Distelli::XmlMarshaller.new
+      @json_marshaller = Distelli::JsonMarshaller.new
+    end
+
+    def add_object(obj)
+      LOGGER.debug("Adding Model object: "+obj.inspect.to_s)
+      @xml_marshaller.add_object(obj)
+      @json_marshaller.add_object(obj)
+    end
+
+    def register_model(obj_list)
+      obj_list.each do |obj|
+        add_object(obj)
+      end
+    end
+
+    def unmarshall_request()
+      content_type = request[ServiceConstants::CONTENT_TYPE_HEADER]
+      if content_type == ServiceConstants::CONTENT_TYPE_JSON
+        return @json_marshaller.unmarshall(request.body)
+      elsif content_type == ServiceConstants::CONTENT_TYPE_XML
+        return @xml_marshaller.unmarshall(request.body)
+      else
+        return request.body
+      end
+    end
+
+    def marshall_response(response, extra_headers=nil, http_code=nil)
+      response_type = get_response_type(request)
+      if http_code != nil
+        status http_code
+      end
+      
+      headers_hash = Hash.new
+      headers_hash[ServiceConstants::SERVER_HEADER] = "DistelliWS"
+      headers_hash[ServiceConstants::REQUEST_ID_HEADER] = get_request_id()
+
+      if extra_headers != nil
+        headers_hash.update(extra_headers)
+      end
+
+      if response_type == ServiceConstants::RESPONSE_TYPE_JSON
+        headers_hash[ServiceConstants::CONTENT_TYPE_HEADER] = ServiceConstants::CONTENT_TYPE_JSON
+        headers(headers_hash)
+        return @json_marshaller.marshall(response)
+      elsif response_type == ServiceConstants::RESPONSE_TYPE_XML
+        headers_hash[ServiceConstants::CONTENT_TYPE_HEADER] = ServiceConstants::CONTENT_TYPE_XML
+        headers(headers_hash)
+        return @xml_marshaller.marshall(response)
+      else
+        raise StandardError.new("Invalid Response type: "+response_type)
+      end
+    end
+
+    def marshall_error(error)
+      response_type = get_response_type(request)
+      if error.is_a?(Distelli::BaseException)
+        status error.http_code
+      else
+        error = Distelli::ServerError.new("Cannot marshall error of type "+error.class.name+" Defaulting to ServerError")
+        status error.http_code
+      end
+      
+      headers_hash = Hash.new
+      headers_hash[ServiceConstants::SERVER_HEADER] = "DistelliWS"
+      headers_hash[ServiceConstants::REQUEST_ID_HEADER] = get_request_id()
+
+      if response_type == ServiceConstants::RESPONSE_TYPE_JSON
+        headers_hash[ServiceConstants::CONTENT_TYPE_HEADER] = ServiceConstants::CONTENT_TYPE_JSON
+        headers(headers_hash)
+        return @json_marshaller.marshall_error(error)
+      elsif response_type == ServiceConstants::RESPONSE_TYPE_XML
+        headers_hash[ServiceConstants::CONTENT_TYPE_HEADER] = ServiceConstants::CONTENT_TYPE_JSON
+        headers(headers_hash)
+        return @xml_marshaller.marshall_error(error)
+      else
+        LOGGER.error("Invalid Response Type: "+response_type)
+        error = ServerError.new("Invalid response type: "+response_type)
+        status error.http_code
+        headers_hash[ServiceConstants::CONTENT_TYPE_HEADER] = ServiceConstants::CONTENT_TYPE_JSON
+        headers(headers_hash)
+        return @json_marshaller.marshall_error(error)
+      end
+    end
+
+    private
+    def validate_response_type(response_type)
+      if response_type == nil
+        return ServiceConstants::RESPONSE_TYPE_JSON
+      end
+      if response_type == ServiceConstants::RESPONSE_TYPE_JSON
+        return response_type
+      elsif response_type == ServiceConstants::RESPONSE_TYPE_XML
+        return response_type
+      else
+        LOGGER.error("Invalid response type: "+response_type+" Defaulting to "+ServiceConstants::RESPONSE_TYPE_JSON)
+        return ServiceConstants::RESPONSE_TYPE_JSON
+      end
+    end
+    
+    def get_request_id()
+      request_id = request[ServiceConstants::REQUEST_ID_HEADER]
+      if request_id != nil
+        return request_id
+      end
+      params = request.params()
+      request_id = params[ServiceConstants::REQUEST_ID_PARAM]
+      if request_id != nil
+        return request_id
+      end
+
+      # Create a new request id
+      request_id = SecureRandom.uuid
+      request[ServiceConstants::REQUEST_ID_HEADER] = request_id
+      return request_id
+    end
+
+    def get_response_type(request)
+      response_type = request[ServiceConstants::RESPONSE_TYPE_HEADER]
+      if response_type != nil
+        return validate_response_type(response_type)
+      end
+      
+      response_type = nil
+      params = request.params()
+      if params != nil
+        response_type = params[ServiceConstants::RESPONSE_TYPE_PARAM]
+      end
+      return validate_response_type(response_type)
+    end
+
+    def get_operation(request)
+      # First check to see if there is the operation header.
+      # If there is then thats the operation
+      # If not then check to see if there is the operation query param
+      # If it is then thats the operation
+      # else the operation is null
+      op_name = request[ServiceConstants::OPERATION_HEADER]
+      if op_name != nil
+        return op_name
+      end
+
+      params = request.params()
+      if params == nil
+        return nil
+      end
+      return params[ServiceConstants::OPERATION_PARAM]
+    end
+
+    ######################################
+    # Error Handlers
+    ######################################
+    error do
+      # Marshall the error as a server error 
+      ex = env['sinatra.error']
+      LOGGER.error('Unhandled Exception: '+ex.inspect+ex.backtrace.join("\n"))
+      return marshall_error(ex)
+    end
+
+    error Distelli::ClientError do
+      # Marshall the Client Error Exception and set the response code
+      ce = env['sinatra.error']
+      marshall_error(ce)
+    end
+
+    error Distelli::ServerError do
+      # Marshall the Server Error Exception and set the response code    
+      se = env['sinatra.error']
+      return marshall_error(se)
+    end
+
+    not_found do
+      # Marshall a Client Error Exception and set the 400 response code
+      op_name = get_operation(request)
+
+      error = MalformedRequest.new(request.request_method+" not supported on resource: "+request.path)
+      return marshall_error(error)
+    end
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: DistelliServiceFrameworkSinatra
+version: !ruby/object:Gem::Version
+  version: '1.0'
+  prerelease: 
+platform: ruby
+authors:
+- Rahul Singh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: DistelliServiceInterface
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Distelli Service Framework for Ruby Sinatra based servers
+email: rsingh@distelli.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/distelli/serviceframeworksinatra.rb
+homepage: http://www.distelli.com/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Distelli Service Framework classes for Sinatra
+test_files: []