grape-dsl 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd5210f2f3fc7cdfc0973a9f972e9e19807cff64
-  data.tar.gz: c29cf6e0031d3f02f7b9c5db2cbca350affe0561
+  metadata.gz: 2abeb7871a3e81c5afdf0c7d2fc19fbd431be3f2
+  data.tar.gz: ca8b7280b2bc738d97261b1bbe5d8cd7ee8f7b41
 SHA512:
-  metadata.gz: 8f02b572c822716d842b58a836be1bd76d051d695845635605c77cbe4d07e4f4605bd16fc0cf7799d8abecfab464da20f98aba0575e7ef9d4e2727689e2438df
-  data.tar.gz: 7601cccfdad61d72c31c0fe2f8dca3ee4dc136f9a36956b5747972afecf0ba357f68d0ac42da1c1014ba531de6fc6b4575abade93605215ddfbb5dd94359ddb9
+  metadata.gz: 7f0ed9b649f6e167647e1520204b9934a98e9499fa17ee533161d6928ccc39f9b0562502432a7f04d707ebfd94fc694663480ec54a6a04c73914ef61bb7046d8
+  data.tar.gz: 0cda8d3626257d01525f2cd3f5c88a56a4f9ebd36586a3a080065a12c6827dfa90303c4306d25737bbb4d057b37f1e5575b5a698772fb9fff1f0dc8e6cdf1c65

data/README.md

@@ -141,4 +141,126 @@ here is an example for the use
 
     end
 
-```
+```
+
+### Documentation
+ 
+a simple but useful documentation generation way
+
+```ruby
+
+
+    class HelloApi < Grape::API
+
+        #> api call description
+            description.desc= "simple api call"
+        
+        #> return body for the documentation
+        description.body= {"String"=>"String"}
+    
+        #> or type
+        description.content_type= 'JSON'
+        #> params for the call
+        params do
+          requires :something, type: String, desc: "Some string that required"
+        end
+        #> actual get route generation
+        get 'hello' do
+          {"hello"=>"world"}
+        end
+            
+    end
+    
+    
+    if ARGV.include?('--generate_documentation)
+    
+      Grape.create_wiki_doc path: (File.join(Dir.pwd,"README.md")),
+                            desc_files: Dir.glob(File.join Dir.pwd,"doc","*").select{|p| !File.directory?(p) },
+                            type: :github
+    
+    end
+
+```
+
+This will produce the following content in a README.md file
+-----------------------------------------------------------
+        
+         
+## Request: /hello(.:format) call: get part
+
+### Request description
+* simple api call
+
+### request
+
+* *method:*    GET
+* *path:*      /hello(.:format)
+* *headers:*   
+  * application/json
+  * application/text
+
+
+* _*Parameters*_
+  * _something_
+    * required: true
+    * type: String
+    * desc: Some string that required
+
+
+
+### response
+
+#### *body:*
+```JSON
+{
+ "String":"String"
+}
+```
+
+
+### response in case of failure
+
+* *Internal Server Error:500*
+
+----
+         
+
+or in plain:
+                          
+    ## Request: /hello(.:format) call: get part
+    
+    ### Request description
+    * simple api call
+    
+    ### request
+    
+    * *method:*    GET
+    * *path:*      /hello(.:format)
+    * *headers:*   
+      * application/json
+      * application/text
+    
+    
+    * _*Parameters*_
+      * _something_
+        * required: true
+        * type: String
+        * desc: Some string that required
+    
+    
+    
+    ### response
+    
+    #### *body:*
+    ```JSON
+    {
+     "String":"String"
+    }
+    ```
+    
+    
+    ### response in case of failure
+    
+    * *Internal Server Error:500*
+    
+    ----

data/VERSION

@@ -1 +1 @@
-2.1.0
+2.2.0

data/lib/grape-dsl/doc.rb

@@ -2,10 +2,6 @@ module GrapeDSL
   module Extend
     module Doc
 
-      def syntax_highlight target,wrapper_begin,wrapper_end
-        return "#{wrapper_begin}#{target}#{wrapper_end}"
-      end
-
       # helpers for doc generation
       def wiki_body(route,wrapper_begin,wrapper_end,wrapper_close)
 
@@ -21,12 +17,12 @@ module GrapeDSL
         #  debugger
         #end
 
-        case route.route_description.class.to_s.downcase
+        case true
 
-          when "string"
+          when route.route_description.class <= ::String
             params= route.route_params
 
-          when "hash"
+          when route.route_description.class <= ::Hash
 
             if !route.route_description[:content_type].nil?
               content_type= route.route_description[:content_type]
@@ -40,7 +36,7 @@ module GrapeDSL
               evalue= "value"
             end
 
-          when "nilclass"
+          when route.route_description.class <= ::NilClass
             params= route.route_params
             params ||= "no return"
             content_type= "TXT"
@@ -51,9 +47,9 @@ module GrapeDSL
 
         end
 
-        case params.class.to_s.downcase
+        case true
 
-          when "hash"
+          when params.class <= ::Hash
 
             if params == route.route_params
               tmp_hash= Hash.new
@@ -63,9 +59,9 @@ module GrapeDSL
               params= tmp_hash
             end
 
-            params = params.convert_all_value_to_s
+            params = params.convert_all_value_to_grape_dsl_format
 
-          when "class"
+          when params.class <= ::Class
             begin
               if params.to_s.include? '::'
                 if params.to_s.downcase.include? 'boolean'
@@ -76,7 +72,7 @@ module GrapeDSL
               content_type= "TXT"
             end
 
-          when "string"
+          when params.class <= ::String
             content_type= "TXT"
 
           else
@@ -93,9 +89,7 @@ module GrapeDSL
           when "json"
             begin
 
-
-
-              tmp_array.push syntax_highlight(content_type.to_s,wrapper_begin,wrapper_end)
+              tmp_array.push [wrapper_begin,content_type.to_s,wrapper_end].join
 
               require "json"
 
@@ -327,22 +321,35 @@ module GrapeDSL
                 # create request description
                 begin
                   write_out_array.push("\n"+(uni_tab*1)+"#{mheader}Request description")
-                  case route.route_description.class.to_s.downcase
+                  case true
 
-                    when "string"
+                    when route.route_description.class <= String
                       route.route_description.each_line do |one_line|
                         write_out_array.push((uni_tab*2)+htsym+one_line.chomp)
                       end
 
-                    when "hash"
+                    when route.route_description.class <= Hash
                       begin
-                        sym_to_find= :desc
-                        if route.route_description[sym_to_find].nil?
-                          sym_to_find= :description
+
+                        description_msg = nil
+
+                        [:d,:desc,:description].each do |sym|
+                          description_msg ||= route.route_description[sym]
                         end
-                        route.route_description[sym_to_find].each_line do |one_line|
+
+                        if description_msg.class <= String
+                          description_msg= [*description_msg.split("\n")]
+                        end
+
+                        description_msg ||= "No description available for this path"
+                        description_msg= [*description_msg]
+
+                        puts description_msg.inspect
+
+                        description_msg.each do |one_line|
                           write_out_array.push((uni_tab*2)+htsym+one_line.chomp)
                         end
+
                       end
 
 
@@ -407,6 +414,7 @@ module GrapeDSL
                   write_out_array.push("\n#{mheader}response\n")
                 end
 
+                #> TODO make better implementation for others to use
                 #create route content_type
                 begin
                   if !Grape::Endpoint.config_obj.nil?
@@ -420,7 +428,7 @@ module GrapeDSL
                     write_out_array.push ""
 
                   end
-                end
+                end if Grape::Endpoint.respond_to?(:config_obj) && Grape::Endpoint.respond_to?(:header_config_obj)
 
                 # create response bodies
                 begin

data/lib/grape-dsl/doc_mp.rb

@@ -3,17 +3,17 @@ module GrapeDSL
   module EXT
 
     module ArrayMP
-      def convert_all_value_to_s
+      def convert_all_value_to_grape_dsl_format
 
         self.count.times do |index|
 
-          case self[index].class.to_s.downcase
+          case true
 
-            when "hash"
-              self[index].convert_all_value_to_s
+            when self[index].class <= Hash
+              self[index].convert_all_value_to_grape_dsl_format
 
-            when "array"
-              self[index].convert_all_value_to_s
+            when self[index].class <= Array
+              self[index].convert_all_value_to_grape_dsl_format
 
             else
               self[index]= self[index].to_s
@@ -28,17 +28,17 @@ module GrapeDSL
     end
 
     module HashMP
-      def convert_all_value_to_s
+      def convert_all_value_to_grape_dsl_format
 
         self.each do |key,value|
 
-          case value.class.to_s.downcase
+          case true
 
-            when "hash"
-              value.convert_all_value_to_s
+            when value.class <= Hash
+              value.convert_all_value_to_grape_dsl_format
 
-            when "array"
-              value.convert_all_value_to_s
+            when value.class <= Array
+              value.convert_all_value_to_grape_dsl_format
 
             else
               self[key]= value.to_s

data/lib/grape-dsl/dsl.rb

@@ -4,64 +4,22 @@ module GrapeDSL
 
     module APIMNT
 
-      class Description
-
-        def initialize opts={}
-          raise unless opts.class <= ::Hash
-          opts.each{|k,v| self.__send__("#{k}=",v) }
-        end
-
-        def [] sym
-          self.__send__ sym.to_s
-        end
-
-        def []= sym,value
-          self.__send__ "#{sym.to_s}=",value
-        end
-
-        attr_accessor :description,:body,:content_type
-        alias desc= description=
-        alias desc  description
-        alias type= content_type=
-        alias type  content_type
-
-        def value
-          {description: description,content_type: content_type,body: body}
-        end
-
-      end
-
       # defaults
       # desc -> description for path
       # body -> return body from the call
       # convent_type -> real content type
-      def description(*args)
+      def description(opts={})
 
         @last_description ||= {}
-        unless @last_description[:desc].class == ::GrapeDSL::Extend::APIMNT::Description
-
-          var= ::GrapeDSL::Extend::APIMNT::Description.new(*args)
-
-          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
-
-            var.content_type= content_type_name if var.content_type.nil?
-
-          end
-
-          var.desc= desc.to_s
-          @last_description[:desc]= var
-
+        unless @last_description[:description].class == Hashie::Mash
+          @last_description[:description]= Hashie::Mash.new(opts.merge(desc: @last_description[:desc]))
         end
+        return @last_description[:description]
 
-        return @last_description[:desc]
+      end
 
+      def description= obj
+        self.description.desc= obj
       end
 
       # mount all the rest api classes that is subclass of the Grape::API

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-dsl
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Adam Luzsi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-03 00:00:00.000000000 Z
+date: 2014-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mpatch