rest_area 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0274aeb1e1e15d33636be9f1feb5126170e4d46f
-  data.tar.gz: e0717d08f0861bbfb70fb3fe21eb4da6fb2ba267
+  metadata.gz: 7f6547726c4969be02a1a29abb2e4f09738e2575
+  data.tar.gz: 2853fad441916762135dff21d82c449f64c96863
 SHA512:
-  metadata.gz: ddbb98f4f8ada3c7548e3b8d56a7862f50fb320fe2921dd9673049391b32c1664e3e3d40f3b9fa60be7ea7f2c9772462c089447dccbb64761575dc0961503562
-  data.tar.gz: d54160d2367c66ea6b852a49216ec90def9ab1aa6316318adb8e73b323e0fc5b0691f2b848e430e8f0ccf47d7662d1a3751c9523d4f7d515b9c208ddc501bebf
+  metadata.gz: abbc2c88bfabd44811fb13cb42f5767cb191296525f4fae5000e3e3af4fc4368baa30c30f940d45f39632152424fa53c8df32f56ae38b50b4248e6e423a5cb00
+  data.tar.gz: 73e42b278c59a87980d637e56beebee6201facf739fad4ed56cec4c95531ea0a0d2d2776864d02695cb29649c62702b2db74841bd775b3ae653a11a3c56850db

data/README.md

@@ -32,6 +32,10 @@ If you are using Rails 4.1.x you should use the master branch and/or versions/ta
           resources :cereal, :thing do
             action :index, :show, :create, :update, :delete
             key :name
+            headers({
+              'Cache-Control' => 'public, max-age=86400'
+              'Expires' => ->{Date.today + 1}
+            })
           end
 
           resource :supermarket do
@@ -65,6 +69,8 @@ With in the `resource` / `resources` block,
 + 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

data/app/controllers/concerns/gets_klass.rb

@@ -8,7 +8,8 @@ module GetsKlass
   def get_klass
     rescue_uninitialized_constant do
       klass = params[:klass].classify.constantize
-      @klass = RestArea.resources[klass.name.underscore.to_sym]
+      @resource = RestArea.resources[klass.name.underscore.to_sym]
+      @klass = @resource.klass
     end
     test_class(@klass)
 

data/app/controllers/rest_area/message_controller.rb

@@ -5,11 +5,11 @@ module RestArea
 
     def get
       if @message_serializer
-        render json: @klass.find(params[:id]).send(@message).all, each_serializer: @message_serializer, root:@message
+        render json: @resource.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)
+        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

data/app/controllers/rest_area/rest_controller.rb

@@ -6,6 +6,7 @@ module RestArea
     include GetsKlass
     before_filter :test_action
     before_filter :set_class_serializer
+    before_filter :add_headers
     before_filter :add_query_params, :only => [:index]
 
     # GET
@@ -18,7 +19,7 @@ module RestArea
     end
 
     def show
-      render json: @klass.find(params[:id]), root: @root
+      render json: @resource.find(params[:id]), root: @root
     end
     alias_method :edit, :show
 
@@ -34,7 +35,7 @@ module RestArea
 
     # PUT
     def update
-      object = @klass.find(params[:id])
+      object = @resource.find(params[:id])
       if object.update_attributes(klass_params)
         render json: object, root:@root
       else
@@ -44,7 +45,7 @@ module RestArea
 
     # DELETE
     def delete
-      object = @klass.find(params[:id])
+      object = @resource.find(params[:id])
       if object.destroy
         render json: object, root:@root
       else
@@ -59,7 +60,7 @@ module RestArea
     end
 
     def test_action
-      unless @klass.can_do?(params[:action].to_sym)
+      unless @resource.can_do?(params[:action].to_sym)
         raise ActionController::RoutingError.new("Resource Does Not Exist")
       end
     end
@@ -68,6 +69,10 @@ module RestArea
       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?

data/lib/rest_area/configuration.rb

@@ -1,14 +1,22 @@
 ##
 # Used for configuring rest_area
 #
+# Example:
+#
 # RestArea.config 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
 #

data/lib/rest_area/resource.rb

@@ -1,12 +1,11 @@
 module RestArea
-  class Resource < SimpleDelegator
+  class Resource
 
-    attr_reader :actions
+    attr_reader :actions, :klass
 
-    def initialize(klass)
+    def initialize(klss)
       @actions = []
-      @klass = klass.to_s.classify.constantize
-      super @klass
+      @klass = klss.to_s.classify.constantize
     end
 
     def action(*args)
@@ -26,14 +25,27 @@ module RestArea
 
     def message(msg)
       @messages ||= []
-      if @klass.method_defined? msg
+      if klass.method_defined? msg
         @messages << msg
         @messages.uniq!
       else
-        raise NoMethodError.new("#{@klass} will not respond to #{msg}")
+        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
@@ -53,9 +65,9 @@ module RestArea
     # Wrapped Methods
     def find(*args)
       if key == :id
-        super *args
+        klass.find(*args)
       else
-        @klass.where(key => args[0]).first!
+        klass.where(key => args[0]).first!
       end
     end
 

data/lib/rest_area/version.rb

@@ -1,3 +1,3 @@
 module RestArea
-  VERSION = "2.3.0"
+  VERSION = "2.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_area
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Benjamin Guest
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-17 00:00:00.000000000 Z
+date: 2015-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
 description: RestArea adds a restfull controller and api to any Rails Application,
   simply add the gem and whitelist of available models
 email:
@@ -167,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Adds a restfull controller and api to a Rails Application