amos 0.0.2 → 0.0.3

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2011 YOURNAME
+Copyright 2011 Geoff Drake drakeg at mandes dot com
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -16,20 +16,24 @@ E.g. If the incoming request is /recipe it executes the index action which does
   :put => "/users/1" + form data. Updates user record 1.  Returns success => true / false
   :post => "/users" + form data.  Returns details of new record on success, or errors array on failure
 
-*Currently only available via github*. I will be releasing the amos gem once I have done some more testing
+*Amos gem is now available on rubygems.org*
 
 Distributed under the MIT License, all rights reserved 2011 Geoff Drake
 
+== Source
+The source is available on GitHub https://github.com/geoffd123/amos
+
 == Installation
 Create a rails application as normal using:
 
-	rails create MyApp
+  rails create MyApp
 	
 Add the following line to your Gemfile
 
   gem 'amos'
 
 Run
+
   bundle install
 	
 Amos uses cancan[https://github.com/ryanb/cancan] for its security checking so you need to add the following class in *app/models/ability.rb*
@@ -42,8 +46,8 @@ Amos uses cancan[https://github.com/ryanb/cancan] for its security checking so y
     end
   end
 	
-Replace the code inside the initialize with your requirements.  There is a skeleton class in lib/app/models/ability.rb, so 
-if you are getting authorisation errors you have not overridden that version. 
+Replace the code inside the initialize with your requirements.  There is a skeleton class in lib/app/models/ability.rb that 
+disallows any access, so if you are getting authorisation errors you have not overridden that version correctly. 
 
 Cancan also needs access to a method called current_user in the controllers.  If you are using devise or similar 
 this should automatically be available.
@@ -75,3 +79,16 @@ the data and what is returned.
 == Thing to to
 * More tests against a javascriptMVC application
 * Add code to support rails dynamic finders.
+
+== Change list
+=== 0.0.3
+Fixed problem with incomplete file list in gemspec.
+Fixed problem with cancan methods not being found when using gem in a rails app.
+
+=== 0.0.2
+Implemented fields filters, associations.
+Changed js errors to return correct status codes
+Implemented pluggable security using CanCan
+
+=== 0.0.1
+Basic skeleton and minimal functionality

data/Rakefile

@@ -10,8 +10,17 @@ require 'rake'
 require 'rake/rdoctask'
 
 require 'rake/testtask'
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
 
-Rake::TestTask.new(:test) do |t|
+
+desc 'Run specs and cukes'
+task :test => [:spec, :cuke] do
+end
+ 
+desc 'Run unit tests'
+   
+Rake::TestTask.new(:unittest) do |t|
   t.libs << 'lib'
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
@@ -27,3 +36,18 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  t.verbose = false
+  # Put spec opts in a file named .rspec in root
+end
+
+desc "Run cucumber features in the test/dummy directory"
+task :cuke do
+  sh 'cd test/dummy; cucumber features'
+end
+
+
+

data/app/controllers/amos_controller.rb

@@ -0,0 +1,139 @@
+ require 'cancan'
+ 
+  class AmosController < ApplicationController
+
+    unloadable
+
+    before_filter :set_model
+    before_filter :set_current_record, :only => [:show, :update, :destroy]
+    
+    def index
+      @the_fields = process_field_names([], params[:fields])
+      records = self.instance_eval("#{@model}.all")
+      result_records = []
+      records.each{|rec|
+        if @the_fields.count == 0
+          result = filter_record rec
+        else
+          result = select_fields rec, @the_fields
+        end
+        result_records << result
+      } unless records.nil?
+      render :json => result_records 
+    end
+
+    def show
+      @the_fields = process_field_names([], params[:fields])
+      if @the_fields.count == 0
+        result = filter_record @record
+      else
+        result = select_fields @record, @the_fields
+      end
+      
+      @the_associations = process_association_names([], params[:association])
+      if @the_associations.count > 0
+        @the_associations.each{|name|
+          assoc_records = self.instance_eval("@record.#{name}")
+          data = []
+          assoc_records.each{|ar|
+            data << filter_record(ar, ["#{@model.downcase}_id"])
+          }
+          result[name] = data
+        }
+      end
+      render :json => result
+     end
+     
+   def destroy
+     if can? :delete, @record
+       @record.destroy
+       render :json => {:success => "true"}
+     else
+       render_authorized
+     end
+    end
+    
+    def create
+      if can? :create, eval("#{@model}")
+        p = remove_attributes_from ['id', 'model', 'controller', 'action'], params.clone 
+        record = self.instance_eval("#{@model}.new(p)")
+
+        if record.save
+            result = filter_record record
+            render :json => result
+        else
+            render :json => record.errors, :status => 400
+        end
+      else
+        render_authorized
+      end
+    end
+    
+    def update
+      if can? :update, eval("#{@model}")
+        attributes = remove_attributes_from ['id', 'model', 'controller', 'action'], params.clone 
+        if @record.update_attributes(attributes)
+          render :json => attributes
+        else
+          render :json => @record.errors, :status => 400
+        end
+      else
+        render_authorized
+      end
+    end
+
+  protected
+  
+    def set_model
+      m = params[:model]
+      m.chop! if m.end_with? 's'
+      @model = m.camelize
+      if cannot? :read, eval("#{@model}")
+        render_authorized
+      end
+    end
+  
+    def set_current_record
+      begin
+        @record = self.instance_eval("#{@model}.find(#{params[:id]})")
+      rescue ActiveRecord::RecordNotFound => e
+        render :json => {:error => "Record #{params[:id]} not found"}, :status => 400
+      end
+     end
+    
+    def filter_record record, extras = nil
+      data = remove_attributes_from ['created_at', 'updated_at'], record.attributes.clone 
+      data = remove_attributes_from extras , data unless extras.nil?
+      data
+    end
+    
+    def remove_attributes_from attribute_names, collection
+      attribute_names.each{|key| collection.delete(key)}     
+      collection
+    end
+    
+    def process_association_names assocs, names
+      return [] if names.nil?
+      names.split(',').each{|n| assocs << n}
+    end
+    
+    def process_field_names fields, names
+      return [] if names.nil?
+      names.split(',').each{|n| fields << n}
+    end
+    
+    def select_fields record, fields
+      selected_fields = {}
+      record.attributes.each_pair{|key, value|
+        if fields.include?(key) 
+          selected_fields[key] = value
+        end
+      }
+      selected_fields
+    end
+    
+    def render_authorized
+      render :json => {:error => "You are not authorized to access this data"}, :status => 401
+    end
+  end
+

data/app/models/ability.rb

@@ -0,0 +1,13 @@
+class Ability
+  include CanCan::Ability
+
+  def initialize(user)
+    can :manage, :all
+  end
+end
+
+class ApplicationController < ActionController::Base
+  def current_user
+    nil
+  end
+end

data/config/routes.rb

@@ -0,0 +1,8 @@
+ Rails.application.routes.draw do
+   # match 'with_id/:model/:id' => 'amos/amos#with_id'
+   match ":model/:id" => "amos#show", :constraints => { :model => /.*/ }, :via => :get
+   match ":model/:id" => "amos#destroy", :constraints => { :model => /.*/ }, :via => :delete
+   match ":model/:id" => "amos#update", :constraints => { :model => /.*/ }, :via => :put
+   match ":model" => "amos#create", :constraints => { :model => /.*/ }, :via => :post
+   match ":model" => "amos#index", :constraints => { :model => /.*/ }
+end

data/lib/amos/engine.rb

@@ -4,5 +4,6 @@ require "rails"
 
 module Amos
   class Engine < Rails::Engine
+    paths.app.controllers << "lib/controllers"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: amos
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Geoff Drake
@@ -24,16 +24,171 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
+        hash: 7
         segments: 
         - 3
         - 0
-        - 4
-        version: 3.0.4
+        version: "3.0"
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: cancan
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 6
+        - 6
+        version: 1.6.6
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: database_cleaner
+  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: sqlite3-ruby
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: launchy
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: syntax
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: factory_girl_rails
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: cucumber-rails
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id011
+- !ruby/object:Gem::Dependency 
+  name: pickle
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id012
 description: A simple server that determines the model and action data based upon the incoming url.
 email: drakeg@mandes.com
 executables: []
@@ -48,6 +203,9 @@ files:
 - MIT-LICENSE
 - Rakefile
 - README.rdoc
+- app/controllers/amos_controller.rb
+- app/models/ability.rb
+- config/routes.rb
 has_rdoc: true
 homepage: http://rubygems.org/gems/amos
 licenses: []