api_yard_parser 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzRkZmIwNjZkOWI3MWYzYTM4MjgyYjVhNTFmNjFlYzcwZTE0MDdmZQ==
+    NWMwNDkzNDQ5ZWI2MDEwOTIxYjYxZTQyZWQ1ZGNjMGI5ZTAzZDJjNw==
   data.tar.gz: !binary |-
-    YzcxNTI5NDFhZDczZTI5YTRkZjdhNWRiMTY4N2Q4NjI3OGE4N2QyOQ==
+    ZWNhZTA3ZTM4ZGFiZWQ4NTdhZTQzMTM2OWQ0ZjhhMjA0ZDFlYjhkYQ==
 SHA512:
   metadata.gz: !binary |-
-    YzA2OGYwMGI0YTc5MjhjMzgwNWVhMDk2YjM3ZWMxY2IyMTUyYjQ3ZDQxN2M3
-    ODA0ZDIxMzNiM2M5NDEzZjBmNzkyZjQ1MzVmNmI0M2JjZGQxOWViM2M5MzM2
-    NWQyZTQzOGQ1NGVjMWQwMDA2ZjBlMDdkYjlkMDZmYzk1MTU4Nzg=
+    ZjA2OTM4MjZiYzE1ZmYwZDU0YTQwODI2YzljNjQ2MTMwMzZlYmQ2YjczNjcx
+    NjI3MDhkZjIwOTc0Yjc3NWY1ZDI1ZDAzNmQzZWE0OTEyZmQ3ODI3ODA2NDU5
+    NGI4M2ZhNDY5NGIzZTY1YTU2NDc0ZjFhY2ZlODY5YmQ3MWFjOTk=
   data.tar.gz: !binary |-
-    Y2Q1MmEwZjA1OTUwMWRiYzI2ZmE2MWI3ZmM4YmY1MTI2YWZhZDMyNjYyNTM0
-    MGIwN2JhZTczZmY5M2RhNTU4MTJjMWJlMWY5ZmQ2ZGE2MjZhMmIwNjEyYWUy
-    YTA5MjkwYWEzNjk1NGNkZjE5OTEwZDhiYTc2ODA2MjUwYmRhZDI=
+    NDgzZGViZmNlOTBmZDNlYThhNWIxMTllNDZmN2ViZmM4Yzg1OWE4N2FkMjIz
+    NWMzMTczZTc4ZjY4OTMzYzNiMDI0YmI4ODBkMWEwM2MyMzFiMmExZDliNzAw
+    YmZkZWE4MzVjYjhhNDgxZjYyNzNmYjc4Zjc4ZjI3MTQzYTNiZWY=

data/README.rdoc

@@ -2,13 +2,78 @@
 
 This project rocks and uses MIT-LICENSE.
 
-1. REQUIREMENTS
-===============
+Developed in Locaweb by Thiago Coutinho.
+www.locaweb.com.br
+
+=== 1. REQUIREMENTS
+
 
 Ruby/ApiYardParser requires Ruby version 1.9.1 or newer and Rails ~> 3.2.16.
 
-2. INSTALLATION
-===============
+=== 2. INSTALLATION
+
+Add to Gemfile:
+
+  gem 'api_yard_parser'
+
+After... in prompt...
+
+  bundle install
+
+Try....
+
+http://localhost:XXXX/docs
+
+=== 3. Examples
+
+For your controller add the yard doc:
+
+
+  class ApiController < ApplicationController
+
+    # Infos of domain
+    # @note 
+    #   [ Receive parameters from GET]
+    #     https://{APP_URL}/api/:domain
+    #
+    # @param [String] :domain => Domain name
+    # @return [JSON] Response HTTP 412 - Precondition Failed -> Parameters not valid  
+    # @return [JSON] Response HTTP 500 - Internal error 
+    # @return [JSON] Response HTTP 200 - Show -> Info of domain
+    #
+    #      {
+    #          "domain": "something.com",
+    #      }
+    def infos
+    ...
+    end
+
+  end
+
+
+or......
+
+
+  class ApiController < ApplicationController
 
-gem install api_yard_parser
+    # Toggle status of alias from domain
+    # @type PUT
+    # @url https://:APP_URL/domains/:domain/toggle
+    #
+    # @param [String] domain       -> Name of domain. Parameter in url
+    #
+    # @return [JSON] Response HTTP 201 - Ok -> Updated
+    #
+    #    {
+    #        "domain": "msf.com",
+    #        "status": "enabled"
+    #    }
+    #
+    # @return [JSON] Response HTTP 404 - Not Found -> Domain doesn't exists
+    # @return [JSON] Response HTTP 404 - Not Found -> Alias doesn't exists
+    # @return [JSON] Response HTTP 500 - Internal server error
+    def toggle_status
+    ...
+    end
 
+  end

data/app/controllers/api_yard_parser/api_docs_controller.rb

@@ -1,9 +1,9 @@
 module ApiYardParser
-  class ApiDocsController < ::ApplicationController
+  class ApiDocsController < ::ActionController::Base
 
     def index
-      if Rails.env == "production" && ApiYardParser.force_no_docs_production
-        render :text => "dont have docs in production"
+      if Rails.env == "production" && ApiYardParser.no_docs_in_production
+        render :text => "no docs in production"
         return true
       end
       @list_apis = ApiDocs.get_all

data/lib/api_yard_parser/api_comment.rb

@@ -72,6 +72,7 @@ module ApiYardParser
         @type = res[0]
         @url = res[1]
       end
+      @notes = lines
     end
 
     def parse_auto_example

data/lib/api_yard_parser/version.rb

@@ -1,3 +1,3 @@
 module ApiYardParser
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/api_yard_parser.rb

@@ -2,6 +2,8 @@
 require "active_support/dependencies"
 
 module ApiYardParser
+
+	attr_accessor :no_docs_in_production
 	# %w(api_comment api_controllers ap_docs).each do |entity|
  #    require_relative "api_yard_parser/#{entity}"
  #  end
@@ -9,8 +11,8 @@ module ApiYardParser
  require_relative "api_yard_parser/api_controllers"
  require_relative "api_yard_parser/api_docs"
 
-  def force_no_docs_production
-  	true || @production
+  def no_docs_in_production
+  	@no_docs_in_production || true
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_yard_parser
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Thiago Coutinho
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-17 00:00:00.000000000 Z
+date: 2014-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails