flexible_api_server 0.0.1

data/lib/flexible_api_server/version.rb

@@ -0,0 +1,5 @@
+module FlexibleApiServer
+
+ VERSION = '0.0.1'
+
+end

data/lib/flexible_api_server.rb

@@ -0,0 +1,219 @@
+require 'bundler/setup'
+require 'active_record'
+require 'sinatra'
+require 'sinatra/respond_to'
+require 'json'
+
+require 'flexible_api'
+
+class ActiveRecord::Base
+  named_scope :limit, lambda { |l| { :limit => l } }
+  named_scope :offset, lambda { |o| { :offset => o } }
+end
+
+module FlexibleApiServer
+
+  class App < Sinatra::Base
+
+    register Sinatra::RespondTo
+    set :assume_xhr_is_js, true
+    set :default_content, :js
+    set :raise_errors, false
+    set :show_exceptions, false
+
+    set :views, File.dirname(__FILE__) + '/../views'
+
+    FILTERED_COLUMNS = [:password, :password_confirmation]
+
+    def assign(k, v)
+      @assign ||= {}
+      @assign[k] = v
+      nil
+    end
+
+    def free_render(code, hash)
+      status code
+      # Filter some things out
+      FILTERED_COLUMNS.each do |column|
+        hash[column] = '[filtered]' if hash.has_key?(column)
+      end if hash.is_a?(Hash)
+      # and respond
+      respond_to do |wants|
+        wants.js { hash.to_json }
+        wants.xml { hash.to_xml }
+      end
+    end
+
+    # TODO too generic
+    error NameError do
+      free_render 404, :message => "No such type: #{params[:model]}"
+    end
+
+    error FlexibleApi::NoSuchRequestLevelError do
+      free_render 400, :message => request.env['sinatra.error'].message
+    end
+
+    # TODO too generic
+    error ActiveRecord::RecordNotFound do
+      free_render 404, :message => request.env['sinatra.error'].message
+    end
+
+    # TODO too generic
+    error NoMethodError do
+      free_render 404, :message => "Unknown method '#{request.env['sinatra.error'].name}' on #{params[:model]}"
+    end
+
+    post '/:model' do
+      model_klass = params[:model].singularize.camelize.constantize
+
+      record = model_klass.new(request.POST)
+      @assign.each { |k, v| record.send(:"#{k}=", v) } unless @assign.nil?
+      if record.save
+        free_render 200, record.to_hash(requested_level)
+      else
+        free_render 422, :message => 'Validation error', :errors => record.errors
+      end
+    end
+
+    get '/:model' do
+      model_param, scope_param = params[:model].split ':', 2
+      query = model_param.singularize.camelize.constantize
+
+      query = add_scopes(query, scope_param)
+
+      if params[:count_only] == 'true'
+        free_render 200, :count => query.count
+      else
+        query = add_limit_and_offset query
+        records = query.find_all_hash(:request_level => requested_level)
+        free_render 200, records
+      end
+    end
+
+    delete '/:model' do
+      free_render 404, :message => 'not implemented'
+    end
+
+    get '/:model/:id' do
+      model_klass = params[:model].singularize.camelize.constantize
+      record = model_klass.find_hash(params[:id], :request_level => requested_level)
+      free_render 200, record
+    end
+
+    put '/:model/:id' do
+      model_klass = params[:model].singularize.camelize.constantize
+      record = model_klass.find(params[:id])
+
+      record.attributes = request.POST
+      @assign.each { |k, v| record.send(:"#{k}=", v) } unless @assign.nil?
+      if record.save
+        free_render 200, record.to_hash(requested_level)
+      else
+        free_render 422, :message => 'Validation error', :errors => record.errors
+      end
+    end
+
+    delete '/:model/:id' do
+      free_render 404, :message => 'not implemented'
+    end
+
+    post '/:model/:id/:relation' do
+
+      model_klass = params[:model].singularize.camelize.constantize
+
+      model_instance = model_klass.find(params[:id])
+      relation = model_instance.send(params[:relation].to_sym)
+
+      record = relation.new(request.POST)
+      @assign.each { |k, v| record.send(:"#{k}=", v) } unless @assign.nil?
+
+      if record.save
+        free_render 200, record.to_hash(requested_level)
+      else
+        free_render 422, :message => 'Validation error', :errors => record.errors
+      end
+    end
+
+    get '/:model/:id/:relation' do
+
+      model_klass = params[:model].singularize.camelize.constantize
+      relation_param, scope_param = params[:relation].split ':', 2
+
+      record = model_klass.find(params[:id]) # TODO only select the thing needed for the join
+      query = record.send(relation_param)
+
+      return free_render 200, nil if query.nil?
+
+      options = { :request_level => requested_level }
+      if query.is_a?(ActiveRecord::Base)
+        free_render 200, query.to_hash(options)
+      else
+        # Scope it
+        query = add_scopes(query, scope_param)
+        # Render the result
+        if params[:count_only] == 'true'
+          free_render 200, :count => query.count
+        else
+          query = add_limit_and_offset(query)
+          free_render 200, query.find_all_hash(options)
+        end
+      end
+    end
+
+    put '/:model/:id/:relation' do
+      free_render 404, :message => 'not implemented'
+    end
+
+    delete '/:model/:id/:relation' do
+      free_render 404, :message => 'not implemented'
+    end
+
+    get '/' do
+      format 'html'
+      respond_to do |wants|
+        wants.html do
+          @model_details = FlexibleApi.flexible_models.sort_by { |m| m.name }
+          path = "./config/locales/#{I18n.locale}/descriptions.yml"
+          @copy = File.exists?(path) ? YAML::load(File.open(path, 'r')) : {}
+          erb :doc_index
+        end
+      end
+    end
+
+    private
+
+    DEFAULT_LIMIT = 50
+
+    def add_scopes(query, scope_param)
+      scopes = []
+      scopes.concat scope_param.split ':' unless scope_param.nil?
+      scopes.concat params[:scopes] if params[:scopes].is_a?(Array)
+      scopes.each do |scope|
+        # TODO remove this ugliness
+        method, arg_string = scope.split '('
+        if !arg_string.nil? && args = arg_string.chop.split(',').map(&:strip)
+          query = query.send method.to_sym, *args
+        else
+          query = query.send method.to_sym
+        end
+      end
+      query
+    end
+
+    def add_limit_and_offset(query)
+      limit = params[:limit].to_i
+      limit = DEFAULT_LIMIT if limit <= 0
+
+      offset = params[:offset].to_i
+      offset = 0 if offset < 0
+
+      query.limit(limit).offset(offset)
+    end
+
+    def requested_level
+      params[:request_level] || params[:level]
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+require 'rack/test'
+
+require 'active_record'
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => 'spec/test.db')
+
+require 'flexible_api'
+require File.dirname(__FILE__) + '/../lib/flexible_api_server'

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification 
+name: flexible_api_server
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- John Crepezzi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-28 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: flexible_api
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 0
+        - 0
+        - 1
+        version: 0.0.1
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: sinatra-respond_to
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id007
+description: Server for exposing Flexible APIs
+email: john.crepezzi@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/flexible_api_server/version.rb
+- lib/flexible_api_server.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/seejohnrun/flexible_api_server
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: flexible_api_server
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Server for exposing Flexible APIs created by FlexibleAPI
+test_files: 
+- spec/spec_helper.rb