rest_area 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6a548c1e51dfdccb2023fd1f17059ecfcbc5129
-  data.tar.gz: 21f9801586316937ea1ed6e11983907064da50e4
+  metadata.gz: 5c8f8f0f8e9b81b6b69d66a82d61d091c454bfcb
+  data.tar.gz: 7c4da3d6e130d702badcf918bf13435b466e9d86
 SHA512:
-  metadata.gz: 728c7c0bf7cf45e5177044688cecd04775e75c03fa52ba828b37d6d3bb2db7a94546c037e5ff00247af51c604d6d8d91b06aad114eba7d8a94700e755db70f03
-  data.tar.gz: dcdf88ce4f36d871be43dba65bf284fb4ab19f8b29d1a68c1aa04de3d337604545ad5c232059ea67665ce62adc906c78b239d760cc277f892b66590c299cdada
+  metadata.gz: 6bbb1278401a35464d7272ac8be4d087c4213bcdf8b6fdda65bb4bef98055f7989542afda9bb979502bb930eb03ab4a69478e88d6f70fef1c5123309587c92ea
+  data.tar.gz: 3827ad996b8a7495d41a84d45b009acede693ac6d80d5ece6bb1d26a3b7ca06a267460178899a7399fb9579c8d6f93fac87f6e07781d4250a7b7e95cb6616292

data/README.md

@@ -1,18 +1,74 @@
+[![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 off bare bones rest api to a rails application. Simply
-create the initilizers file with the classes that you want to be in the
+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
 rest api and you will get the get basic rest routes for that class
 This project rocks and uses MIT-LICENSE.
 
 ## Initilization
 
-1. Create a file called rest_area.rb in your initilizers file
-2. Add something the following in that file.
+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
+
+    gem 'rest_area', '~>1.0'
+
+### Rails 4.1.x
+If you are using Rails 4.1.x you should use the master branch and/or versions/tags 2.x.x, ie
+
+    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.config do
+          resources :thing_one, :thing_two     # Defaults to all actions
+
+          resources :cereal, :thing do
+            action :index, :show, :create, :update, :delete
+            key :name
+          end
+
+          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.
 
         RestArea.class_whitelist = [YourModel, ThatYouWant, ToBeInYour, RestApi]
 
-3. Add something like the following to your routes file.
+
+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`
+
+# 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/concerns/gets_klass.rb

@@ -7,7 +7,8 @@ module GetsKlass
 
   def get_klass
     rescue_uninitialized_constant do
-      @klass = params[:klass].classify.constantize
+      klass = params[:klass].classify.constantize
+      @klass = RestArea.resources[klass.name.underscore.to_sym]
     end
     test_class(@klass)
 
@@ -16,7 +17,7 @@ module GetsKlass
   end
 
   def test_class(klass)
-    if klass.nil? || !RestArea.class_whitelist.include?(klass)
+    if klass.nil? || !RestArea.resources.include?(klass.name.underscore.to_sym)
       raise ActionController::RoutingError.new("Resource Does Not Exist")
     end
   end

data/app/controllers/rest_area/message_controller.rb

@@ -8,8 +8,10 @@ module RestArea
         render json: @klass.find(params[:id]).send(@message).all, each_serializer: @message_serializer, root:@message
       elsif @message_class
         render json: { @message => @klass.find(params[:id]).send(@message).all }.to_json(root:false)
+      elsif @klass.can_send?(@message)
+        render json: @klass.find(params[:id]).send(@message).to_json(root:false)
       else
-        raise NotImplementedError
+        raise ActionController::RoutingError.new("Resource Does Not Exist")
       end
     end
 

data/app/controllers/rest_area/rest_controller.rb

@@ -4,6 +4,7 @@ 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_query_params, :only => [:index]
 
@@ -57,6 +58,16 @@ module RestArea
       render json: {errors: object.errors}, :status => :unprocessable_entity
     end
 
+    def test_action
+      unless @klass.can_do?(params[:action].to_sym)
+        raise ActionController::RoutingError.new("Resource Does Not Exist")
+      end
+    end
+
+    def klass_params
+      params.require(@root.to_sym).permit!
+    end
+
     def add_query_params
       where_params = params.slice(*@klass.column_names)
       if where_params.any?

data/lib/rest_area/configuration.rb

@@ -0,0 +1,37 @@
+##
+# Used for configuring rest_area
+#
+# RestArea.config do
+#   resources :cereal, :thing do
+#     action :index, :show, :create, :update, :delete
+#   end
+#
+#   resource :supermarket do
+#     read_only!
+#     key :name
+#   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 = Resource.new(klass)
+      resource.instance_eval(&block) if block_given?
+      @resources[klass] = resource
+    end
+  end
+
+end

data/lib/rest_area/resource.rb

@@ -0,0 +1,63 @@
+module RestArea
+  class Resource < SimpleDelegator
+
+    attr_reader :actions
+
+    def initialize(klass)
+      @actions = []
+      @klass = klass.to_s.classify.constantize
+      super @klass
+    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 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
+        super *args
+      else
+        @klass.where(key => args[0]).first!
+      end
+    end
+
+  end
+end

data/lib/rest_area/version.rb

@@ -1,3 +1,3 @@
 module RestArea
-  VERSION = "1.2.1"
+  VERSION = "1.3.0"
 end

data/lib/rest_area.rb

@@ -1,6 +1,30 @@
 require "rest_area/engine"
+require 'rest_area/resource'
+require 'rest_area/configuration'
 
 
 module RestArea
-  mattr_accessor :class_whitelist
+  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
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_area
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Benjamin Guest
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-09 00:00:00.000000000 Z
+date: 2014-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -94,6 +94,34 @@ dependencies:
     - - "~>"
       - !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'
 description: RestArea adds a restfull controller and api to any Rails Application,
   simply add the gem and whitelist of available models
 email:
@@ -115,7 +143,9 @@ files:
 - 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