rest_area 1.4.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05a4ad520c52faac53b2cb80c941cf26a8f41c17
-  data.tar.gz: 2ea2dbcecefc1b523c97a6b2784581dc9ff75b00
+  metadata.gz: 8e8eafe9476bbb11ea8d35670e7c04fa4d00fe1a
+  data.tar.gz: 189aca44997b83a548bacff763d2b766fe953852
 SHA512:
-  metadata.gz: 15fd36e0dca85de276bf32575d309435f0d6546ebec91aee02d88d02a81b3305600d550120615a91028303676965d66b65b88743d7ee3e32febaafb2e617f208
-  data.tar.gz: 69bdd5b56b66961747a8c4e0ef2844adaea89faec2c8ba9587a09959128b90e221d950e9263294e5c085eae1f534cccef673040a51227a450decd6bc43637f64
+  metadata.gz: a386cbaabf1f1c0afd3649372b5e1ecea5ee83774cdb7d43deb84de0e6375da643140a6cdca2eed193d7e844c291e433ea2382695847ed5c94130d9e560dc7b9
+  data.tar.gz: 6665be2ee5be3c856ec171e480f05435a5f67bc5c46e0e162e0df4281c86aaa651a1c89d84e1202c37af3d0cbf0591cc6456c643bd5b01c768e8d973b6b3419e

data/README.md

@@ -1,18 +1,16 @@
-[![Code Climate](https://codeclimate.com/github/bguest/rest_area.png)](https://codeclimate.com/github/bguest/rest_area) [![Build Status](https://travis-ci.org/bguest/rest_area.png?branch=master)](https://travis-ci.org/bguest/rest_area) [![Coverage Status](https://coveralls.io/repos/bguest/rest_area/badge.png)](https://coveralls.io/r/bguest/rest_area) [![Gem Version](https://badge.fury.io/rb/rest_area.png)](http://badge.fury.io/rb/rest_area) [![Dependency Status](https://gemnasium.com/bguest/rest_area.png)](https://gemnasium.com/bguest/rest_area)
-
 # RestArea
 
-This gem adds a bare bones rest api to a rails application. Simply
-create the initilizer file with the classes that you want to be in the
+This gem adds a off bare bones rest api to a rails application. Simply
+create the initilizers file with the classes that you want to be in the
 rest api and you will get the get basic rest routes for that class
 This project rocks and uses MIT-LICENSE.
 
-## Initilization
+## Versions
 
 This library supports both Rails 3.2.x and Rails 4.1.x.
 
 ### Rails 3.2.x
-If you are using Rails 3.2.x you should use the `rails-3_2` branch and/or version/tags 1.x.x, ie
+If you are useing Rails 3.2.x you should use the `rails-3_2` branch and/or version/tags 1.x.x, ie
 
     gem 'rest_area', '~>1.0'
 
@@ -21,60 +19,14 @@ If you are using Rails 4.1.x you should use the master branch and/or versions/ta
 
     gem 'rest_area', '~>2.0'
 
-## Initialization / Setup
-
-1. Create a file called `rest_area.rb` in your initializers file
-2. Add configuration like the following in that file.
-
-        RestArea.configure do
-          resources :thing_one, :thing_two     # Defaults to all actions
-
-          resources :cereal, :thing do
-            action :index, :show, :create, :update, :delete
-            key :name
-            headers({
-              'Cache-Control' => 'public, max-age=86400'
-              'Expires' => ->{Date.today + 1}
-            })
-          end
+## Initilization / Setup
 
-          resource :supermarket do
-            read_only!
-            messages :say_hello, :ring_it_up
-          end
-        end
-
-  Alternatively you can still just pass in a class whitelist, but this is being deprecated.
+1. Create a file called `rest_area.rb` in your initilizers file
+2. Add something the following in that file.
 
         RestArea.class_whitelist = [YourModel, ThatYouWant, ToBeInYour, RestApi]
 
-
 3. Add something like the following to your `config/routes.rb` file.
 
         mount RestArea::Engine => "/your_base_route"
 
-### Config Settings
-
-Within the RestArea.config block, use `resource` to specify a single resource and `resources` to specify mulitiple resources
-
-With in the `resource` / `resources` block,
-+ Use `action` to specify what actions that resource will respond to, the available actions are
-  `:index`, `:show`, `:create`, `:create`, `:update`, and `:delete`, the default is to use all actions
-
-+ Use `read_only!` to specify that the resource will only respond to the `index` and `show` actions
-
-+ Use `key` to specify what column rest_area will use to look up a resource. This is the column name
-  that is used for the `:key` in `/:resource/:key` part of the restful path. This defaults to `:id`
-
-+ Use `message` or `messages` to whitelist methods for a class. Methods much be defined at
-  launch. Methods must respond with an object that responds to `.to_json`
-
-+ Use `headers` to specify the response headers hash, this will be merged with existing headers
-
-# Serializers
-
-But what if I want to customize the JSON that comes back? Simple this
-gem supports [active_model_serializer][1]. Go there, ignore the stuff
-about controllers.
-
-[1]:https://github.com/rails-api/active_model_serializers

data/app/controllers/rest_area/application_controller.rb

@@ -1,15 +1,4 @@
 module RestArea
-  class ApplicationController < ::ApplicationController 
-
-    private
-
-    def rescue_uninitialized_constant
-      yield
-    rescue NameError => e
-      unless e.message =~ /uninitialized constant/
-        throw e
-      end
-    end
+  class ApplicationController < ActionController::Base
   end
-
 end

data/app/controllers/rest_area/rest_controller.rb

@@ -1,13 +1,7 @@
-require 'saneitized'
-
 module RestArea
   class RestController < ApplicationController
     skip_before_filter :verify_authenticity_token
-    include GetsKlass
-    before_filter :test_action
-    before_filter :set_class_serializer
-    before_filter :add_headers
-    before_filter :add_query_params, :only => [:index]
+    before_filter :get_class, :set_class_serializer
 
     # GET
     def index
@@ -19,13 +13,13 @@ module RestArea
     end
 
     def show
-      render json: @resource.find(params[:id]), root: @root
+      render json: @klass.find(params[:id]), root: @root
     end
     alias_method :edit, :show
 
     # POST
     def create
-      object = @klass.new(params[@root.to_sym])
+      object = @klass.new(klass_params)
       if object.save
         render json: object, root:@root
       else
@@ -35,8 +29,8 @@ module RestArea
 
     # PUT
     def update
-      object = @resource.find(params[:id])
-      if object.update_attributes(params[@root.to_sym])
+      object = @klass.find(params[:id])
+      if object.update_attributes(klass_params)
         render json: object, root:@root
       else
         render_errors(object)
@@ -45,7 +39,7 @@ module RestArea
 
     # DELETE
     def delete
-      object = @resource.find(params[:id])
+      object = @klass.find(params[:id])
       if object.destroy
         render json: object, root:@root
       else
@@ -59,34 +53,33 @@ module RestArea
       render json: {errors: object.errors}, :status => :unprocessable_entity
     end
 
-    def test_action
-      unless @resource.can_do?(params[:action].to_sym)
-        raise ActionController::RoutingError.new("Resource Does Not Exist")
-      end
+    def query_params
+      params.slice('limit','order').symbolize_keys
     end
 
     def klass_params
-      params.require(@root.to_sym).permit!
-    end
-
-    def add_headers
-      response.headers.merge! @resource.headers
-    end
-
-    def add_query_params
-      where_params = params.slice(*@klass.column_names)
-      if where_params.any?
-        @klass = @klass.where(Saneitized.convert(where_params).to_h)
-      end
+      params.require(@root.to_sym).permit(@klass.column_names.map(&:to_sym))
     end
 
     def set_class_serializer
       @serializer = ( '::' + @klass.to_s + "Serializer" ).constantize
     rescue NameError => e
-      unless e.message =~ /uninitialized constant/
+      if e.message =~ /uninitialized constant/
+        @serializer = false
+      else
         throw e
       end
     end
 
+    def get_class
+      @klass = params[:klass].singularize.camelize.constantize
+      unless RestArea.class_whitelist.include? @klass
+        raise ActionController::RoutingError.new("Resource Does Not Exist")
+      end
+
+      @roots = ActionController::Base.helpers.sanitize(params[:klass])
+      @root = @roots.singularize
+    end
+
   end
 end

data/config/routes.rb

@@ -1,7 +1,6 @@
 RestArea::Engine.routes.draw do
   get '/:klass', :to => "rest#index"
   get '/:klass/:id', :to => "rest#show"
-  get '/:klass/:id/:message', :to => 'message#get'
   post '/:klass', :to => "rest#create"
   put '/:klass/:id', :to => "rest#update"
   delete '/:klass/:id', :to => "rest#delete"

data/lib/rest_area/version.rb

@@ -1,3 +1,3 @@
 module RestArea
-  VERSION = "1.4.3"
+  VERSION = "2.0.0"
 end

data/lib/rest_area.rb

@@ -1,30 +1,5 @@
 require "rest_area/engine"
-require 'rest_area/resource'
-require 'rest_area/configuration'
-
 
 module RestArea
-  mattr_reader :class_whitelist
-
-  class << self
-
-    def config
-      @config ||= RestArea::Configuration.new
-    end
-
-    def configure(&block)
-      self.config.instance_eval(&block) if block_given?
-    end
-
-    def resources
-      self.config.resources
-    end
-
-    def class_whitelist=(array)
-      resources.clear
-      array.each do |klass|
-        self.config.resource klass.name.underscore.to_sym
-      end
-    end
-  end
+  mattr_accessor :class_whitelist
 end

metadata

@@ -1,141 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: rest_area
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Benjamin Guest
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-31 00:00:00.000000000 Z
+date: 2014-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.17
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.17
-- !ruby/object:Gem::Dependency
-  name: saneitized
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.0.0.beta
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.0.0.beta
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: combustion
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.1
 - !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.7'
-- !ruby/object:Gem::Dependency
-  name: timecop
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: '1.3'
 description: RestArea adds a restfull controller and api to any Rails Application,
   simply add the gem and whitelist of available models
 email:
@@ -149,17 +93,13 @@ files:
 - Rakefile
 - app/assets/javascripts/rest_area/application.js
 - app/assets/stylesheets/rest_area/application.css
-- app/controllers/concerns/gets_klass.rb
 - app/controllers/rest_area/application_controller.rb
-- app/controllers/rest_area/message_controller.rb
 - app/controllers/rest_area/rest_controller.rb
 - app/helpers/rest_area/application_helper.rb
 - app/views/layouts/rest_area/application.html.erb
 - config/routes.rb
 - lib/rest_area.rb
-- lib/rest_area/configuration.rb
 - lib/rest_area/engine.rb
-- lib/rest_area/resource.rb
 - lib/rest_area/version.rb
 - lib/tasks/rest_area_tasks.rake
 homepage: https://github.com/bguest/rest_area
@@ -171,17 +111,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Adds a restfull controller and api to a Rails Application

data/app/controllers/concerns/gets_klass.rb

@@ -1,26 +0,0 @@
-module GetsKlass
-  extend ActiveSupport::Concern
-
-  included do
-    before_filter :get_klass
-  end
-
-  def get_klass
-    rescue_uninitialized_constant do
-      klass = params[:klass].classify.constantize
-      @resource = RestArea.resources[klass.name.underscore.to_sym]
-      @klass = @resource.klass
-    end
-    test_class(@klass)
-
-    @roots = ActionController::Base.helpers.sanitize(params[:klass]).pluralize
-    @root = @roots.singularize
-  end
-
-  def test_class(klass)
-    if klass.nil? || !RestArea.resources.include?(klass.name.underscore.to_sym)
-      raise ActionController::RoutingError.new("Resource Does Not Exist")
-    end
-  end
-
-end

data/app/controllers/rest_area/message_controller.rb

@@ -1,38 +0,0 @@
-module RestArea
-  class MessageController < ApplicationController
-    include GetsKlass
-    before_filter :get_message, :set_message_class, :set_message_serializer
-
-    def get
-      if @message_serializer
-        render json: @resource.find(params[:id]).send(@message).all, each_serializer: @message_serializer, root:@message
-      elsif @message_class
-        render json: { @message => @resource.find(params[:id]).send(@message).all }.to_json(root:false)
-      elsif @resource.can_send?(@message)
-        render json: @resource.find(params[:id]).send(@message).to_json(root:false)
-      else
-        raise ActionController::RoutingError.new("Resource Does Not Exist")
-      end
-    end
-
-    private
-
-    def get_message
-      @message = params[:message]
-    end
-
-    def set_message_class
-      rescue_uninitialized_constant do
-        @message_class = @message.classify.constantize
-      end
-      test_class(@message_class) if @message_class
-    end
-
-    def set_message_serializer
-      return unless @message_class
-      rescue_uninitialized_constant do
-        @message_serializer = ( '::' + @message.classify + "Serializer" ).constantize
-      end
-    end
-  end
-end

data/lib/rest_area/configuration.rb

@@ -1,45 +0,0 @@
-##
-# Used for configuring rest_area
-#
-# Example:
-#
-# RestArea.configure do
-#   resources :cereal, :thing do
-#     action :index, :show, :create, :update, :delete
-#     messages :say_hello, :say_goodbye
-#     headers ({
-#       'Cache-Control' => 'public, max-age=86400'
-#       'Expires' => ->{Date.today + 1}
-#     })
-#   end
-#
-#   resource :supermarket do
-#     read_only!
-#     key :name
-#     message :ring_it_up
-#   end
-# end
-#
-module RestArea
-  class Configuration
-
-    def initialize()
-      @resources = {}
-    end
-
-    def resources(*args, &block)
-      if args.any?
-        args.each do |klass| resource(klass, &block) end
-      else
-        @resources
-      end
-    end
-
-    def resource(klass, &block)
-      resource = @resources[klass] || Resource.new(klass)
-      resource.instance_eval(&block) if block_given?
-      @resources[klass] = resource
-    end
-  end
-
-end

data/lib/rest_area/resource.rb

@@ -1,75 +0,0 @@
-module RestArea
-  class Resource
-
-    attr_reader :actions, :klass
-
-    def initialize(klss)
-      @actions = []
-      @klass = klss.to_s.classify.constantize
-    end
-
-    def action(*args)
-      @actions ||= []
-      @actions += args
-      @actions.uniq!
-    end
-
-    def messages(*args)
-      @messages ||= []
-      if args.any?
-        args.each do |m| message(m) end
-      else
-        @messages
-      end
-    end
-
-    def message(msg)
-      @messages ||= []
-      if klass.method_defined? msg
-        @messages << msg
-        @messages.uniq!
-      else
-        raise NoMethodError.new("#{klass} will not respond to #{msg}")
-      end
-    end
-
-    def headers(hdrs = nil)
-      @headers ||= {}
-      if hdrs
-        @headers.merge! hdrs
-      else
-        @headers.inject({}){ |hash, (key, value)|
-          value = value.call if value.kind_of? Proc
-          hash.merge(key => value)
-        }
-      end
-    end
-    alias_method :headers=, :headers
-
-    def read_only!
-      @actions = [:index, :show]
-    end
-
-    def can_do?(act)
-      self.actions.empty? || self.actions.include?(act)
-    end
-
-    def can_send?(msg)
-      self.messages.include?(msg.to_sym)
-    end
-
-    def key(key = nil)
-      key ? @key = key : (@key || :id)
-    end
-
-    # Wrapped Methods
-    def find(*args)
-      if key == :id
-        klass.find(*args)
-      else
-        klass.where(key => args[0]).first!
-      end
-    end
-
-  end
-end