Permalink
Browse files

Add custom tag to document whether authentication is required

  • Loading branch information...
sferik committed Jul 23, 2011
1 parent c7f718a commit 1986ba4af528326a2618a4d1d435cd21e4aa52ad
Showing with 18 additions and 0 deletions.
  1. +1 −0 .yardopts
  2. +17 −0 lib/gems/client.rb
View
@@ -1,3 +1,4 @@
+--tag authenticated:"Requires Authentication"
--markup markdown
-
LICENSE.md
View
@@ -18,6 +18,7 @@ def initialize(options={})
# Returns some basic information about the given gem
#
+ # @authenticated false
# @param gem_name [String] The name of a gem.
# @return [Hash]
# @example
@@ -29,6 +30,7 @@ def info(gem_name)
# Returns an array of active gems that match the query
#
+ # @authenticated false
# @param query [String] A term to search for.
# @return [Array<Hash>]
# @example
@@ -40,6 +42,7 @@ def search(query)
# Returns an array of gem version details
#
+ # @authenticated false
# @param gem_name [String] The name of a gem.
# @return [Hash]
# @example
@@ -51,6 +54,7 @@ def versions(gem_name)
# Returns the number of downloads by day for a particular gem version
#
+ # @authenticated false
# @param gem_name [String] The name of a gem.
# @param gem_version [String] The version of a gem.
# @param from [Date] Search start date.
@@ -74,6 +78,7 @@ def downloads(gem_name=nil, gem_version=nil, from=nil, to=Date.today)
# Returns an array of hashes for all versions of given gems
#
+ # @authenticated false
# @param gems [Array] A list of gem names
# @return [Array]
# @example
@@ -85,6 +90,7 @@ def dependencies(*gems)
# Retrieve your API key using HTTP basic auth
#
+ # @authenticated true
# @return [String]
# @example
# Gems.configure do |config|
@@ -98,6 +104,7 @@ def api_key
# List all gems that you own
#
+ # @authenticated true
# @return [Array]
# @example
# Gems.gems
@@ -108,6 +115,7 @@ def gems
# View all owners of a gem that you own
#
+ # @authenticated true
# @param gem_name [String] The name of a gem.
# @return [Array]
# @example
@@ -119,6 +127,7 @@ def owners(gem_name)
# Add an owner to a RubyGem you own, giving that user permission to manage it
#
+ # @authenticated true
# @param gem_name [String] The name of a gem.
# @param owner [String] The email address of the user you want to add.
# @return [String]
@@ -130,6 +139,7 @@ def add_owner(gem_name, owner)
# Remove a user's permission to manage a RubyGem you own
#
+ # @authenticated true
# @param gem_name [String] The name of a gem.
# @param owner [String] The email address of the user you want to remove.
# @return [String]
@@ -141,6 +151,7 @@ def remove_owner(gem_name, owner)
# List the webhooks registered under your account
#
+ # @authenticated true
# @return [Hash]
# @example
# Gems.web_hooks
@@ -151,6 +162,7 @@ def web_hooks
# Create a webhook
#
+ # @authenticated true
# @param gem_name [String] The name of a gem. Specify "*" to add the hook to all your gems.
# @param url [String] The URL of the web hook.
# @return [String]
@@ -162,6 +174,7 @@ def add_web_hook(gem_name, url)
# Remove a webhook
#
+ # @authenticated true
# @param gem_name [String] The name of a gem. Specify "*" to remove the hook from all your gems.
# @param url [String] The URL of the web hook.
# @return [String]
@@ -173,6 +186,7 @@ def remove_web_hook(gem_name, url)
# Test fire a webhook
#
+ # @authenticated true
# @param gem_name [String] The name of a gem. Specify "*" to fire the hook for all your gems.
# @param url [String] The URL of the web hook.
# @return [String]
@@ -184,6 +198,7 @@ def fire_web_hook(gem_name, url)
# Submit a gem to RubyGems.org
#
+ # @authenticated true
# @param gem [File] A built gem.
# @return [String]
# @example
@@ -194,6 +209,7 @@ def push(gem)
# Remove a gem from RubyGems.org's index
#
+ # @authenticated true
# @param gem_name [String] The name of a gem.
# @param gem_version [String] The version of a gem.
# @param options [Hash] A customizable set of options.
@@ -208,6 +224,7 @@ def yank(gem_name, gem_version=nil, options={})
# Update a previously yanked gem back into RubyGems.org's index
#
+ # @authenticated true
# @param gem_name [String] The name of a gem.
# @param gem_version [String] The version of a gem.
# @param options [Hash] A customizable set of options.

0 comments on commit 1986ba4

Please sign in to comment.