dioxide_rails 0.1.0

data/README.rdoc

@@ -0,0 +1,42 @@
+= Dioxide RPC Engine for Ruby on Rails
+
+This is a server-side library designed for use with mobile applications built with Dioxide-Mobile ( https://github.com/developertown/dioxide-mobile ).
+It provides a framework for RPC services that follow the Dioxide RPC protocol (Protocol documentation coming soon).
+
+== Installation
+
+1. Include the dioxide_rails gem in your Gemfile:
+
+    gem 'dioxide_rails', '~> 0.1'
+
+2. Update the bundler managed gems:
+
+    $ bundle install 
+
+3. Generate the necessary initializer:
+
+    $ rails g dioxide_rails
+        create  config/initializers/dioxide_rails.rb
+
+4. Configure Dioxide via the initializer.  Configuration documentation is specified within config/initializers/dioxide_rails.rb
+
+== Service Implementation
+
+Handlers are simply methods that take a Dioxide::RPCRequest object as a parameter, and return an instance of Dioxide::RPCResponse.
+Dioxide::RPCResponse instances are automatically created by calling #new_response on an Dioxide::RPCRequest instance.
+The simplest implementation would look like:
+
+    class MyHandler
+      def ping(req)
+        res = req.new_response
+        return res
+      end
+    end
+
+Dixoide::RPCResponses default to a status_code of 200 and message of "OK", so this simple handler, in effect, implements a
+ping service.
+
+== License
+
+Copyright 2011 Developer Town
+Released under the Apache 2.0 License

data/app/controllers/dioxide/api_controller.rb

@@ -0,0 +1,53 @@
+# Copyright 2011 Developer Town
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Dioxide
+  # require 'dioxide_rails'
+  class ApiController < ApplicationController
+
+    unloadable
+  
+    def call
+      puts "Here's mount_at?  #{Dioxide::Engine::config.mount_at}"
+      
+      req = RPCRequest.new(request.body)
+    
+      begin
+        #Locate the handler class
+        handlerClass = Dioxide::Engine::config.handlers[req.uri]
+        logger.debug("Loaded handler class #{handlerClass} for uri #{req.uri}")
+      
+        handler = handlerClass.new
+      
+        method = handler.method(req.method.to_sym)
+      
+        res = method.call req
+      
+        render :json => res
+      
+      rescue Exception => e
+        logger.error("Error processing RPCRequest:\n#{req}")
+        logger.error e.backtrace.join("\n")
+      
+        res = req.new_response
+        res.status_code = 500
+        res.message = "Server Error"
+      
+        render :json => res
+        return
+      end
+    end
+  
+  end
+end

data/config/routes.rb

@@ -0,0 +1,21 @@
+# Copyright 2011 Developer Town
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+Rails.application.routes.draw do |map|
+
+  mount_at = Dioxide::Engine.config.mount_at
+
+  match mount_at => 'dioxide/api#call', :via => [:post], :format => :json
+
+end

data/lib/dioxide_rails/handlers/dioxide_handler.rb

@@ -0,0 +1,27 @@
+# Copyright 2011 Developer Town
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Dioxide
+  
+  # A simple handler class to server as a demonstration handler,
+  # and to fulfill a sometimes useful ping functionality, if desired.
+  class DioxideHandler
+    
+    # This simple creates a new response and returns it
+    # (new responses default to status_code 200 and message 'OK')
+    def ping(req)
+      req.new_response
+    end
+  end
+end

data/lib/dioxide_rails/handlers.rb

@@ -0,0 +1,15 @@
+# Copyright 2011 Developer Town
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require File.dirname(__FILE__) + '/handlers/dioxide_handler'

data/lib/dioxide_rails/rpc_request.rb

@@ -0,0 +1,56 @@
+# Copyright 2011 Developer Town
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'dioxide_rails/rpc_response'
+
+module Dioxide
+  # This class wraps up an RPC Request of the following form (represented here as a hash):
+  #
+  # {
+  #   :request_id => 0,
+  #   :uri => "/users",
+  #   :method => "create",
+  #   :device_id => "235234-2342-234-234-2342",
+  #   :session_id => "asdf980808as0df090a9d",
+  #   :payload => {foo: 'bar'}
+  # }
+
+  class RPCRequest
+    attr_reader :request_id, :uri, :method, :device_id, :session_id, :payload
+  
+    def initialize(req)    
+      if (req.class != Hash)
+        req = ActiveSupport::JSON.decode(req)
+      end
+
+      raise Exception.new("RPC Request is missing required parameter: uri") unless req.has_key?("uri")
+      raise Exception.new("RPC Request is missing required parameter: method") unless req.has_key?("method")
+    
+      @request_id = req["request_id"]
+      @uri = req["uri"]
+      @method = req["method"]
+      @device_id = req["device_id"]
+      @session_id = req["session_id"]
+      @payload = req["payload"]
+    end
+  
+    def to_s
+      to_json
+    end
+  
+    def new_response
+      RPCResponse.new(@request_id)
+    end
+  end
+end

data/lib/dioxide_rails/rpc_response.rb

@@ -0,0 +1,36 @@
+# Copyright 2011 Developer Town
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Dioxide
+  # This class wraps up an RPC Response of the following form (represented here as a hash):
+  #
+  # {
+  #   :request_id => 0,
+  #   :status_code => 200,
+  #   :message => "OK",
+  #   :payload => {foo: 'bar'}
+  # }
+
+  class RPCResponse
+  
+    attr_accessor :request_id, :status_code, :message, :payload
+  
+    def initialize(request_id)
+      @request_id = request_id
+      @status_code = 200
+      @message = "OK"
+      @payload = {}
+    end
+  end
+end

data/lib/dioxide_rails.rb

@@ -0,0 +1,21 @@
+# Copyright 2011 Developer Town
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Dioxide
+  require 'engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+  require 'dioxide_rails/rpc_request'
+  require 'dioxide_rails/rpc_response'
+  require 'dioxide_rails/handlers'
+end
+

data/lib/engine.rb

@@ -0,0 +1,37 @@
+# Copyright 2011 Developer Town
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'dioxide_rails'
+require 'rails'
+require 'action_controller'
+
+module Dioxide
+  class Engine < Rails::Engine
+
+    # Config defaults
+    config.mount_at = '/api'
+    
+    # Load rake tasks
+    rake_tasks do
+      load File.join(File.dirname(__FILE__), 'rails/railties/tasks.rake')
+    end
+    
+    # Check the gem config
+    initializer "check config" do |app|
+
+      # make sure mount_at ends with trailing slash
+      config.mount_at += '/'  unless config.mount_at.last == '/'
+    end
+  end
+end

data/lib/rails/generators/dioxide_rails/dioxide_rails_generator.rb

@@ -0,0 +1,27 @@
+# Copyright 2011 Developer Town
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class DioxideRailsGenerator < Rails::Generators::Base
+
+  def self.source_root
+    File.join(File.dirname(__FILE__), 'templates')
+  end
+
+  def copy_initializer_file
+    copy_file 'initializer.rb', 'config/initializers/dioxide_rails.rb'
+  end
+end

data/lib/rails/generators/dioxide_rails/templates/initializer.rb

@@ -0,0 +1,23 @@
+module Dioxide
+  class Engine < Rails::Engine
+    
+    # Step 1:
+    # Configure the mount point for the RPC API handler
+    config.mount_at = '/api'
+    
+    
+    # Step 2:
+    # Add any necessary require statements here to include your handler classes
+    # e.g., for a handler class in RAILS_ROOT/lib/users_handler.rb:
+    
+    # require 'users_handler'
+
+    # Step 3:
+    # Map URIs to handlers
+    config.handlers = {
+      "/dioxide" => Dioxide::DioxideHandler,
+      #"/users" => ::UsersHandler
+    }
+
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: dioxide_rails
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jason Vasquez
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-10 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: 
+email: admin@developertown.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- app/controllers/dioxide/api_controller.rb
+- config/routes.rb
+- lib/dioxide_rails.rb
+- lib/dioxide_rails/handlers.rb
+- lib/dioxide_rails/handlers/dioxide_handler.rb
+- lib/dioxide_rails/rpc_request.rb
+- lib/dioxide_rails/rpc_response.rb
+- lib/engine.rb
+- lib/rails/generators/dioxide_rails/dioxide_rails_generator.rb
+- lib/rails/generators/dioxide_rails/templates/initializer.rb
+- README.rdoc
+has_rdoc: true
+homepage: 
+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.5.0
+signing_key: 
+specification_version: 3
+summary: Ruby On Rails implementation of the Dioxide RPC framework
+test_files: []
+