grape-dsl 1.2.2 → 1.3.0

data/lib/grape-dsl/dsl.rb

@@ -1,46 +1,80 @@
 #encoding: UTF-8
-module Grape
-  # The API class is the primary entry point for
-  # creating Grape APIs.Users should subclass this
-  # class in order to build an API.
-  class API
-    class << self
-
-      # mount all the rest api classes that is subclass of the Grape::API
-      # make easy to manage
-      def mount_subclasses(*exception)
-
-        # mark self as exception
-        begin
-          exception.push(self)
-        end
 
-        # mount components
-        begin
-          Grape::API.subclasses.each do |component|
-            unless exception.include?(component)
-              mount(component)
+module GrapeDSL
+  module Extend
+
+    module API
+
+        # defaults
+        # desc -> description for path
+        # body -> return body from the call
+        # convent_type -> real content type
+        def description
+
+          if desc.class <= String
+            tmp_string= desc
+            desc ::Hashie::Mash.new
+            desc[:desc]= tmp_string
+          end
+
+          unless desc.class <= Hash
+            desc ::Hashie::Mash.new
+          end
+
+          unless self.content_types.keys.empty?
+
+            content_type_name= nil
+            [:json,:xml,:txt].each do |element|
+              if self.content_types.keys.include? element
+                content_type_name ||= element.to_s.upcase
+              end
             end
+            desc[:convent_type] ||= content_type_name
+
           end
+
+          return desc
+
         end
 
-        return nil
+        # mount all the rest api classes that is subclass of the Grape::API
+        # make easy to manage
+        def mount_subclasses(*exception)
+
+          # mark self as exception
+          begin
+            exception.push(self)
+          end
 
-      end
+          # mount components
+          begin
+            Grape::API.subclasses.each do |component|
+              unless exception.include?(component)
+                mount(component)
+              end
+            end
+          end
 
-      # write out to the console the class routes
-      def console_write_out_routes
+          return nil
 
-        $stdout.puts "\n\nREST::API ROUTES:"
-        self.routes.map do |route|
-          $stdout.puts "\t#{route.route_method}","#{route.route_path}"
         end
 
-        return nil
-      end
+        # write out to the console the class routes
+        def console_write_out_routes
+
+          $stdout.puts "\n\nREST::API ROUTES:"
+          self.routes.map do |route|
+            $stdout.puts "\t#{route.route_method}","#{route.route_path}"
+          end
+
+          return nil
+        end
 
 
     end
+
   end
+
 end
 
+Grape::API.__send__ :extend, ::GrapeDSL::Extend::API

data/lib/grape-dsl/endpoint.rb

@@ -1,15 +1,13 @@
-module Grape
-  # An Endpoint is the proxy scope in which all routing
-  # blocks are executed. In other words, any methods
-  # on the instance level of this class may be called
-  # from inside a `get`, `post`, etc.
-  class Endpoint
-    class << self
-      attr_accessor :header_config_obj
+module GrapeDSL
+  module Extend
+    module Endpoint
 
+      attr_accessor :header_config_obj
       alias :config_obj  :header_config_obj
       alias :config_obj= :header_config_obj=
 
     end
   end
-end
+end
+
+Grape::Endpoint.__send__ :extend, ::GrapeDSL::Extend::Endpoint

data/lib/grape-dsl/headers.rb

@@ -1,76 +1,78 @@
-# this is super if you want CORS with Grape
-module Grape
-  class << self
-
-    # example in yaml format
-    # "header_name":
-    #  - "header values"
-    #  - "header value 2"
-    #
-    #
-    # real  example for cors
-    # "Access-Control-Allow-Headers":
-    #    - "X-Idp-Id"
-    #    - "X-Token"
-    #    - "Content-Type"
-    # "Access-Control-Allow-Origin":
-    #    - "*"
-    # "Access-Control-Allow-Methods":
-    #    - HEAD
-    #    - OPTIONS
-    #    - GET
-    #    - POST
-    #    - PUT
-    #    - DELETE
-    #
-    #
-    # This will give headers to all call request response made after this
-    # make sure to load BEFORE every route call going to be made
-    def response_headers_to_new_calls(config_obj=nil)
-
-      Grape::Endpoint.config_obj= config_obj unless config_obj.nil?
-      Grape::API.inject_singleton_method :inherited, add: "after" do |subclass|
-
-        subclass.class_eval do
-
-          before do
-            Grape::Endpoint.header_config_obj.each do |header_key,header_value|
-              header header_key, header_value.join(', ')
+
+module GrapeDSL
+  module Extend
+    module Headers
+
+      # example in yaml format
+      # "header_name":
+      #  - "header values"
+      #  - "header value 2"
+      #
+      #
+      # real  example for cors
+      # "Access-Control-Allow-Headers":
+      #    - "X-Idp-Id"
+      #    - "X-Token"
+      #    - "Content-Type"
+      # "Access-Control-Allow-Origin":
+      #    - "*"
+      # "Access-Control-Allow-Methods":
+      #    - HEAD
+      #    - OPTIONS
+      #    - GET
+      #    - POST
+      #    - PUT
+      #    - DELETE
+      #
+      #
+      # This will give headers to all call request response made after this
+      # make sure to load BEFORE every route call going to be made
+      def response_headers_to_new_calls(config_obj=nil)
+
+        Grape::Endpoint.config_obj= config_obj unless config_obj.nil?
+        Grape::API.inject_singleton_method :inherited, add: "after" do |subclass|
+
+          subclass.class_eval do
+
+            before do
+              Grape::Endpoint.header_config_obj.each do |header_key,header_value|
+                header header_key, header_value.join(', ')
+              end
             end
+
           end
 
         end
 
+        return nil
       end
 
-      return nil
-    end
-
-
-    # same config obj format like to "response_headers_to_new_calls"
-    # this will create headers for the options call to ALL already made route
-    # make sure to load after every route has been made
-    def response_headers_to_routes_options_request(config_obj=nil)
+      # same config obj format like to "response_headers_to_new_calls"
+      # this will create headers for the options call to ALL already made route
+      # make sure to load after every route has been made
+      def response_headers_to_routes_options_request(config_obj=nil)
 
-      Grape::Endpoint.header_config_obj= config_obj unless config_obj.nil?
-      Grape::API.subclasses.each do |rest_api_model|
-        rest_api_model.routes.map { |route| route.route_path.split('(.:format)')[0] }.uniq.each do |path|
-          rest_api_model.class_eval do
+        Grape::Endpoint.header_config_obj= config_obj unless config_obj.nil?
+        Grape::API.subclasses.each do |rest_api_model|
+          rest_api_model.routes.map { |route| route.route_path.split('(.:format)')[0] }.uniq.each do |path|
+            rest_api_model.class_eval do
 
-            options path do
-              Grape::Endpoint.header_config_obj.each do |header_key,header_value|
-                header header_key, header_value.join(', ')
+              options path do
+                Grape::Endpoint.header_config_obj.each do |header_key,header_value|
+                  header header_key, header_value.join(', ')
+                end
               end
-            end
 
+            end
           end
+
         end
 
+        return nil
       end
 
-      return nil
     end
-
-
   end
-end
+end
+
+Grape.__send__ :extend, ::GrapeDSL::Extend::Headers

data/lib/grape-dsl/mounter.rb

@@ -1,21 +1,15 @@
 # this is super if you want CORS with Grape
 # This is a plugin for Mongoid
 # models rest layer generate
-module Grape
-  # The API class is the primary entry point for
-  # creating Grape APIs.Users should subclass this
-  # class in order to build an API.
-
-  class API
-
-    class << self
-
+module GrapeDSL
+  module Extend
+    module Mounter
 
       # Args will be seperated by they class type
       # string = path part, will be joined with "/"
-      # hash   = options element
+      # hash   = grape options element
       # Class  = target class
-      # Symbol = method name
+      # Symbol = method name / REST METHOD NAME
       # Proc   = These procs will be called with the binding of GrapeEndpoint,
       #          so params and headers Hash::Mash will be allowed to use
       #          they will run BEFORE the method been called, so ideal for auth stuffs
@@ -27,8 +21,14 @@ module Grape
       #
       # ---------------
       #
-      # looks like this:
-      #   mount_method TestClass, :test_method, "funny_path",:GET
+      # looks like this with FULL POWER:
+      #   mount_method :GET,
+      #                TestClass,
+      #                :test_method,
+      #                "funny_path_first_part",
+      #                "funny_path_second_part",
+      #                [:arg_hello,:json],
+      #                Proc{ authorize_instance_method_from_grape_endpoint }
       #
       # you can give hash options just like to any other get,post put delete etc methods, it will work
       #
@@ -93,7 +93,6 @@ module Grape
 
         end
 
-
         __send__(rest_method,path_name,options) do
 
 
@@ -124,6 +123,9 @@ module Grape
 
       end
 
+
     end
   end
-end
+end
+
+Grape::API.__send__ :extend, ::GrapeDSL::Extend::Mounter

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: grape-dsl
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Adam Luzsi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-25 00:00:00.000000000 Z
+date: 2014-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: loader
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: grape
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bindless
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: DSL for Grape module that let you use some basic function much easier.
@@ -69,7 +69,6 @@ files:
 - files.rb
 - grape-dsl.gemspec
 - lib/grape-dsl.rb
-- lib/grape-dsl/config.rb
 - lib/grape-dsl/doc.rb
 - lib/grape-dsl/dsl.rb
 - lib/grape-dsl/endpoint.rb
@@ -85,19 +84,18 @@ 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.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Simple Grape DSL for easer use cases
 test_files: []
-has_rdoc: 

data/lib/grape-dsl/config.rb

@@ -1,9 +0,0 @@
-module Grape
-
-  # for security on/off functions
-  class << self
-    attr_accessor :security
-  end
-  self.security= true
-
-end