Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Add custom tag to document whether authentication is required

  • Loading branch information...
commit 1986ba4af528326a2618a4d1d435cd21e4aa52ad 1 parent c7f718a
Erik Michaels-Ober authored July 23, 2011
1  .yardopts
... ...
@@ -1,3 +1,4 @@
  1
+--tag authenticated:"Requires Authentication"
1 2
 --markup markdown
2 3
 -
3 4
 LICENSE.md
17  lib/gems/client.rb
@@ -18,6 +18,7 @@ def initialize(options={})
18 18
 
19 19
     # Returns some basic information about the given gem
20 20
     #
  21
+    # @authenticated false
21 22
     # @param gem_name [String] The name of a gem.
22 23
     # @return [Hash]
23 24
     # @example
@@ -29,6 +30,7 @@ def info(gem_name)
29 30
 
30 31
     # Returns an array of active gems that match the query
31 32
     #
  33
+    # @authenticated false
32 34
     # @param query [String] A term to search for.
33 35
     # @return [Array<Hash>]
34 36
     # @example
@@ -40,6 +42,7 @@ def search(query)
40 42
 
41 43
     # Returns an array of gem version details
42 44
     #
  45
+    # @authenticated false
43 46
     # @param gem_name [String] The name of a gem.
44 47
     # @return [Hash]
45 48
     # @example
@@ -51,6 +54,7 @@ def versions(gem_name)
51 54
 
52 55
     # Returns the number of downloads by day for a particular gem version
53 56
     #
  57
+    # @authenticated false
54 58
     # @param gem_name [String] The name of a gem.
55 59
     # @param gem_version [String] The version of a gem.
56 60
     # @param from [Date] Search start date.
@@ -74,6 +78,7 @@ def downloads(gem_name=nil, gem_version=nil, from=nil, to=Date.today)
74 78
 
75 79
     # Returns an array of hashes for all versions of given gems
76 80
     #
  81
+    # @authenticated false
77 82
     # @param gems [Array] A list of gem names
78 83
     # @return [Array]
79 84
     # @example
@@ -85,6 +90,7 @@ def dependencies(*gems)
85 90
 
86 91
     # Retrieve your API key using HTTP basic auth
87 92
     #
  93
+    # @authenticated true
88 94
     # @return [String]
89 95
     # @example
90 96
     #   Gems.configure do |config|
@@ -98,6 +104,7 @@ def api_key
98 104
 
99 105
     # List all gems that you own
100 106
     #
  107
+    # @authenticated true
101 108
     # @return [Array]
102 109
     # @example
103 110
     #   Gems.gems
@@ -108,6 +115,7 @@ def gems
108 115
 
109 116
     # View all owners of a gem that you own
110 117
     #
  118
+    # @authenticated true
111 119
     # @param gem_name [String] The name of a gem.
112 120
     # @return [Array]
113 121
     # @example
@@ -119,6 +127,7 @@ def owners(gem_name)
119 127
 
120 128
     # Add an owner to a RubyGem you own, giving that user permission to manage it
121 129
     #
  130
+    # @authenticated true
122 131
     # @param gem_name [String] The name of a gem.
123 132
     # @param owner [String] The email address of the user you want to add.
124 133
     # @return [String]
@@ -130,6 +139,7 @@ def add_owner(gem_name, owner)
130 139
 
131 140
     # Remove a user's permission to manage a RubyGem you own
132 141
     #
  142
+    # @authenticated true
133 143
     # @param gem_name [String] The name of a gem.
134 144
     # @param owner [String] The email address of the user you want to remove.
135 145
     # @return [String]
@@ -141,6 +151,7 @@ def remove_owner(gem_name, owner)
141 151
 
142 152
     # List the webhooks registered under your account
143 153
     #
  154
+    # @authenticated true
144 155
     # @return [Hash]
145 156
     # @example
146 157
     #   Gems.web_hooks
@@ -151,6 +162,7 @@ def web_hooks
151 162
 
152 163
     # Create a webhook
153 164
     #
  165
+    # @authenticated true
154 166
     # @param gem_name [String] The name of a gem. Specify "*" to add the hook to all your gems.
155 167
     # @param url [String] The URL of the web hook.
156 168
     # @return [String]
@@ -162,6 +174,7 @@ def add_web_hook(gem_name, url)
162 174
 
163 175
     # Remove a webhook
164 176
     #
  177
+    # @authenticated true
165 178
     # @param gem_name [String] The name of a gem. Specify "*" to remove the hook from all your gems.
166 179
     # @param url [String] The URL of the web hook.
167 180
     # @return [String]
@@ -173,6 +186,7 @@ def remove_web_hook(gem_name, url)
173 186
 
174 187
     # Test fire a webhook
175 188
     #
  189
+    # @authenticated true
176 190
     # @param gem_name [String] The name of a gem. Specify "*" to fire the hook for all your gems.
177 191
     # @param url [String] The URL of the web hook.
178 192
     # @return [String]
@@ -184,6 +198,7 @@ def fire_web_hook(gem_name, url)
184 198
 
185 199
     # Submit a gem to RubyGems.org
186 200
     #
  201
+    # @authenticated true
187 202
     # @param gem [File] A built gem.
188 203
     # @return [String]
189 204
     # @example
@@ -194,6 +209,7 @@ def push(gem)
194 209
 
195 210
     # Remove a gem from RubyGems.org's index
196 211
     #
  212
+    # @authenticated true
197 213
     # @param gem_name [String] The name of a gem.
198 214
     # @param gem_version [String] The version of a gem.
199 215
     # @param options [Hash] A customizable set of options.
@@ -208,6 +224,7 @@ def yank(gem_name, gem_version=nil, options={})
208 224
 
209 225
     # Update a previously yanked gem back into RubyGems.org's index
210 226
     #
  227
+    # @authenticated true
211 228
     # @param gem_name [String] The name of a gem.
212 229
     # @param gem_version [String] The version of a gem.
213 230
     # @param options [Hash] A customizable set of options.

0 notes on commit 1986ba4

Please sign in to comment.
Something went wrong with that request. Please try again.