odata_server 0.0.1

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+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

@@ -0,0 +1,14 @@
+OData Server
+===========
+
+This is a rails plugin/engine to embue your application with OData features (so its data can be readily consumed by 
+an OData client).
+
+It was forked Mark Borkum's work at from http://rubyforge.org/scm/?group_id=9605 with only a few small additions
+to support postgresql and declarative authorization and released as a gem.
+
+
+
+The software iterates over your models exposing each as an OData source automatically.
+
+Beware - this code is not heavily tested, it does work in my limited tests usint Tableau public to consume data.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "odata_server"
+  gem.homepage = "http://github.com/bwlang/odata_server"
+  gem.license = "MIT"
+  gem.summary = %Q{OData server for Rails}
+  gem.description = %Q{This is a gem to enable OData consumers to pull data from your Rails application.}
+  gem.email = "langhorst@neb.com"
+  gem.authors = ["Mark Borkum", "Brad Langhorst"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "odata_server #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/app/controllers/o_data_controller.rb

@@ -0,0 +1,145 @@
+class ODataController < ApplicationController
+  cattr_reader :path_param
+  @@path_param = :__path__.freeze
+  
+  cattr_reader :schema
+  @@schema = OData::ActiveRecordSchema::Base.new.freeze
+  
+  cattr_reader :parser
+  @@parser = OData::AbstractQuery::Parser.new(@@schema).freeze
+  
+  rescue_from OData::ODataException, :with => :handle_exception
+  rescue_from ActiveRecord::RecordNotFound, :with => :handle_exception
+  
+  before_filter :extract_resource_path_and_query_string, :only => [:resource]
+  before_filter :parse_resource_path_and_query_string!,  :only => [:resource]
+  before_filter :set_request_format!,                    :only => [:resource]
+  
+  %w{service metadata resource}.each do |method_name|
+    define_method(:"redirect_to_#{method_name}") do
+      # redirect_to(send(:"o_data_#{method_name}_url"))
+      redirect_to(params.merge(:action => method_name.to_s))
+    end
+  end
+  
+  def service
+    respond_to do |format|
+      format.xml  # service.xml.builder
+      format.json { render :json => @@schema.to_json }
+    end
+  end
+  
+  def metadata
+    respond_to do |format|
+      format.xml  # metadata.xml.builder
+    end
+  end
+  
+  def resource
+    @last_segment = @query.segments.last
+    
+    @results = @query.execute!
+    
+    case @last_segment.class.segment_name
+    when OData::AbstractQuery::Segments::CountSegment.segment_name
+      render :text => @results.to_i
+    when OData::AbstractQuery::Segments::LinksSegment.segment_name
+      request.format = :xml unless request.format == :json
+      
+      respond_to do |format|
+        format.xml  { render :inline => "xml.instruct!; @results.empty? ? xml.links('xmlns' => 'http://schemas.microsoft.com/ado/2007/08/dataservices') : xml.links('xmlns' => 'http://schemas.microsoft.com/ado/2007/08/dataservices') { @results.each { |r| xml.uri(o_data_resource_url(r[1])) } }", :type => :builder }
+        format.json { render :json => { "links" => @results.collect { |r| { "uri" => r } } }.to_json }
+      end
+    when OData::AbstractQuery::Segments::ValueSegment.segment_name
+      render :text => @results.to_s
+    when OData::AbstractQuery::Segments::PropertySegment.segment_name
+      request.format = :xml unless request.format == :json
+      
+      respond_to do |format|
+        format.xml  { render :inline => "xml.instruct!; value.blank? ? xml.tag!(key.to_sym, 'm:null' => true, 'xmlns' => 'http://schemas.microsoft.com/ado/2007/08/dataservices', 'xmlns:m' => 'http://schemas.microsoft.com/ado/2007/08/dataservices') : xml.tag!(key.to_sym, value, 'edm:Type' => type, 'xmlns' => 'http://schemas.microsoft.com/ado/2007/08/dataservices', 'xmlns:edm' => 'http://schemas.microsoft.com/ado/2007/05/edm')", :locals => { :key => @results.keys.first.name, :type => @results.keys.first.return_type, :value => @results.values.first }, :type => :builder }
+        format.json { render :json => { @results.keys.first.name => @results.values.first }.to_json }
+      end
+    when OData::AbstractQuery::Segments::NavigationPropertySegment.segment_name
+      @countable = @last_segment.countable?
+      
+      @navigation_property = @last_segment.navigation_property
+      @polymorphic = @navigation_property.to_end.polymorphic?
+      
+      if @polymorphic
+        @entity_type = nil
+        @entity_type_name = @navigation_property.to_end.name.singularize
+      else
+        @entity_type = @navigation_property.to_end.entity_type
+        @entity_type_name = @entity_type.name
+      end
+      
+      @collection_name = @entity_type_name.pluralize
+      
+      @expand_navigation_property_paths = {}
+      if expand_option = @query.options.find { |o| o.option_name == OData::AbstractQuery::Options::ExpandOption.option_name }
+        @expand_navigation_property_paths = expand_option.navigation_property_paths
+      end
+      
+      respond_to do |format|
+        format.atom # resource.atom.builder
+        format.json # resource.json.erb
+      end
+    when OData::AbstractQuery::Segments::CollectionSegment.segment_name
+      @countable = @last_segment.countable?
+      
+      @navigation_property = nil
+      @polymorphic = true
+      
+      @entity_type = @last_segment.entity_type
+      
+      @expand_navigation_property_paths = {}
+      if expand_option = @query.options.find { |o| o.option_name == OData::AbstractQuery::Options::ExpandOption.option_name }
+        @expand_navigation_property_paths = expand_option.navigation_property_paths
+      end
+      
+      respond_to do |format|
+        format.atom # resource.atom.builder
+        format.json # resource.json.erb
+      end
+    else
+      # in theory, this branch is unreachable because the <tt>parse_resource_path_and_query_string!</tt>
+      # method will throw an exception if the <tt>OData::AbstractQuery::Parser</tt> fails to match any
+      # segment of the resource path.
+      raise OData::AbstractQuery::Errors::AbstractQueryException.new(@query)
+    end
+  end
+  
+  private
+  
+  def extract_resource_path_and_query_string
+    @resource_path = params[@@path_param].join('/')
+    
+    @query_string = params.inject({}) { |acc, pair|
+      key, value = pair
+      acc[key.to_sym] = value unless [@@path_param, :controller, :action].include?(key.to_sym)
+      acc
+    }.collect { |key, value|
+      key.to_s + '=' + value.to_s
+    }.join('&')
+  end
+  
+  def parse_resource_path_and_query_string!
+    @query = @@parser.parse!([@resource_path, @query_string].compact.join('?'))
+  end
+  
+  def set_request_format!
+    if format_option = @query.options.find { |o| o.option_name == OData::AbstractQuery::Options::FormatOption.option_name }
+      if format_value = format_option.value
+        request.format = format_value.to_sym
+      end
+    end
+  end
+  
+  def handle_exception(ex)
+    request.format = :xml
+    
+    respond_to do |format|
+      format.xml { render :inline => "xml.instruct!; xml.error('xmlns' => 'http://schemas.microsoft.com/ado/2007/08/dataservices/metadata') { xml.code(code.to_s); xml.message(message); xml.uri(uri) }", :type => :builder, :locals => { :code => nil, :message => ex.message, :uri => request.url } }
+    end
+  end
+end

data/app/helpers/o_data_helper.rb

@@ -0,0 +1,203 @@
+module ODataHelper
+  @@o_data_atom_xmlns = { 
+    "xmlns"   => "http://www.w3.org/2005/Atom",
+    "xmlns:d" => "http://schemas.microsoft.com/ado/2007/08/dataservices", 
+    "xmlns:m" => "http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" 
+  }.freeze
+  
+  def o_data_atom_feed(xml, query, results, options = {})
+    results_href, results_url = begin
+      if base_href = options.delete(:href)
+        [base_href.to_s, o_data_resource_url(base_href.to_s)]
+      else
+        [query.resource_path, o_data_resource_url(query.to_uri)]
+      end
+    end
+    
+    results_title = options.delete(:title) || results_href
+    
+    xml.tag!(:feed, { "xml:base" => o_data_service_url }.merge(options[:hide_xmlns] ? {} : @@o_data_atom_xmlns)) do
+      xml.tag!(:title, results_title)
+      xml.tag!(:id, results_url)
+      xml.tag!(:link, :rel => "self", :title => results_title, :href => results_href)
+
+      unless results.empty?
+        if last_result = results.last
+          if atom_updated_at = query.schema.atom_updated_at_for(last_result)
+            xml.tag!(:updated, atom_updated_at.iso8601)
+          end
+        end
+        
+        results.each do |result|
+          o_data_atom_entry(xml, query, result, options.merge(:hide_xmlns => true, :href => results_href))
+        end
+      end
+      
+      if inlinecount_option = query.options.find { |o| o.option_name == OData::AbstractQuery::Options::InlinecountOption.option_name }
+        if inlinecount_option.value == 'allpages'
+          xml.m(:count, results.length)
+        end
+      end
+    end
+  end
+  
+  def o_data_atom_entry(xml, query, result, options = {})
+    entity_type = options[:entity_type] || query.schema.find_entity_type(:active_record => result.class)
+    raise OData::AbstractQuery::Errors::EntityTypeNotFound.new(query, result.class.name) if entity_type.blank?
+    
+    result_href = entity_type.href_for(result)
+    result_url = o_data_resource_url(result_href)
+    
+    result_title = entity_type.atom_title_for(result)
+    result_summary = entity_type.atom_summary_for(result)
+    result_updated_at = entity_type.atom_updated_at_for(result)
+    
+    xml.tag!(:entry, {}.merge(options[:hide_xmlns] ? {} : @@o_data_atom_xmlns)) do
+      xml.tag!(:id, result_url) unless result_href.blank?     
+      xml.tag!(:title, result_title, :type => "text") unless result_title.blank?
+      xml.tag!(:summary, result_summary, :type => "text") unless result_summary.blank?
+      xml.tag!(:updated, result_updated_at.iso8601) unless result_updated_at.blank?
+      
+      xml.tag!(:author) do
+        xml.tag!(:name)
+      end
+      
+      xml.tag!(:link, :rel => "edit", :title => result_title, :href => result_href) unless result_title.blank? || result_href.blank?
+      
+      unless entity_type.navigation_properties.empty?
+        entity_type.navigation_properties.sort_by(&:name).each do |navigation_property|
+          navigation_property_href = result_href + '/' + navigation_property.name
+          
+          navigation_property_attrs = { :rel => "http://schemas.microsoft.com/ado/2007/08/dataservices/related/" + navigation_property.name, :type => "application/atom+xml;type=#{navigation_property.to_end.multiple? ? 'feed' : 'entry'}", :title => navigation_property.name, :href => navigation_property_href }
+          
+          if (options[:expand] || {}).keys.include?(navigation_property)
+            xml.tag!(:link, navigation_property_attrs) do
+              xml.m(:inline, :type => navigation_property_attrs[:type]) do
+                if navigation_property.to_end.multiple?
+                  o_data_atom_feed(xml, query, navigation_property.find_all(result), options.merge(:entity_type => navigation_property.to_end.entity_type, :expand => options[:expand][navigation_property]))
+                else
+                  o_data_atom_entry(xml, query, navigation_property.find_one(result), options.merge(:entity_type => navigation_property.to_end.entity_type, :expand => options[:expand][navigation_property]))
+                end
+              end
+            end
+          else
+            xml.tag!(:link, navigation_property_attrs)
+          end
+        end
+      end
+      
+      xml.tag!(:category, :term => entity_type.qualified_name, :scheme => "http://schemas.microsoft.com/ado/2007/08/dataservices/scheme")
+      
+      unless (properties = get_selected_properties_for(query, entity_type)).empty?
+        xml.tag!(:content, :type => "application/xml") do
+          xml.m(:properties) do
+            properties.each do |property|
+              property_attrs = { "m:type" => property.return_type }
+              
+              unless (value = property.value_for(result)).blank?
+                xml.d(property.name.to_sym, value, property_attrs)
+              else
+                xml.d(property.name.to_sym, property_attrs.merge("m:null" => true))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
+  def o_data_json_feed(query, results, options = {})
+    results_json = results.collect { |result| o_data_json_entry(query, result, options.merge(:d => false, :deferred => false)) }
+    
+    if inlinecount_option = query.options.find { |o| o.option_name == OData::AbstractQuery::Options::InlinecountOption.option_name }
+      if inlinecount_option.value == 'allpages'
+        _json = {
+          "results" => results_json,
+          "__count" => results.length
+        }
+        
+        return options[:d] ? { "d" => _json } : _json
+      end
+    end
+    
+    options[:d] ? { "d" => results_json } : results_json
+  end
+  
+  def o_data_json_entry(query, result, options = {})
+    entity_type = options[:entity_type] || query.schema.find_entity_type(:active_record => result.class)
+    raise OData::AbstractQuery::Errors::EntityTypeNotFound.new(query, result.class.name) if entity_type.blank?
+    
+    resource_uri = o_data_resource_url(entity_type.href_for(result))
+    resource_type = entity_type.qualified_name
+    
+    json = begin
+      if options[:deferred]
+        {
+          "__deferred" => { 
+            "uri" => resource_uri 
+          } 
+        }
+      else
+        _json = { 
+          "__metadata" => {
+            "uri" => resource_uri,
+            "type" => resource_type
+          } 
+        }
+        
+        get_selected_properties_for(query, entity_type).each do |property|
+          unless %w{__deferred __metadata}.include?(property.name.to_s)
+            _json[property.name.to_s] = property.value_for(result)
+          else
+            # TODO: raise JSONException (property with reserved name)
+          end
+        end
+
+        entity_type.navigation_properties.sort_by(&:name).each do |navigation_property|
+          unless %w{__deferred __metadata}.include?(navigation_property.name.to_s)
+            navigation_property_uri = resource_uri + '/' + navigation_property.name.to_s
+            
+            _json[navigation_property.name.to_s] = begin
+              if (options[:expand] || {}).keys.include?(navigation_property)
+                if navigation_property.to_end.multiple?
+                  o_data_json_feed(query, navigation_property.find_all(result), options.merge(:entity_type => navigation_property.to_end.entity_type, :expand => options[:expand][navigation_property], :d => false))
+                else
+                  o_data_json_entry(query, navigation_property.find_one(result), options.merge(:entity_type => navigation_property.to_end.entity_type, :expand => options[:expand][navigation_property], :d => false))
+                end
+              else
+                {
+                  "__deferred" => {
+                    "uri" => navigation_property_uri
+                  }
+                }
+              end
+            end
+          else
+            # TODO: raise JSONException (navigation property with reserved name)
+          end
+        end
+        
+        _json
+      end
+    end
+    
+    options[:d] ? { "d" => json } : json
+  end
+  
+  protected
+  
+  def get_selected_properties_for(query, entity_type)
+    if select_option = query.options.find { |o| o.option_name == OData::AbstractQuery::Options::SelectOption.option_name }
+      if select_option.entity_type == entity_type
+        # entity_type is the $select'ed collection/navigation property
+        return select_option.properties
+      else
+        # entity_type is an $expand'ed navigation property
+        return []
+      end
+    end
+    
+    # $select option not supplied
+    entity_type.properties
+  end
+end