Class: Gems::Client
Instance Method Summary collapse
-
#add_owner(gem_name, owner) ⇒ String
Add an owner to a RubyGem you own, giving that user permission to manage it.
-
#add_web_hook(gem_name, url) ⇒ String
Create a webhook.
-
#api_key ⇒ String
Retrieve your API key using HTTP basic auth.
-
#dependencies(*gems) ⇒ Array
Returns an array of hashes for all versions of given gems.
-
#downloads(gem_name, gem_version = nil, from = nil, to = Date.today) ⇒ Hash
Returns the number of downloads by day for a particular gem version.
-
#fire_web_hook(gem_name, url) ⇒ String
Test fire a webhook.
-
#gems(user_handle = nil) ⇒ Array
List all gems that you own.
-
#info(gem_name) ⇒ Hash
Returns some basic information about the given gem.
-
#initialize(options = {}) ⇒ Client
constructor
A new instance of Client.
-
#just_updated(options = {}) ⇒ Array
Returns the 50 most recently updated gems.
-
#latest(options = {}) ⇒ Array
Returns the 50 gems most recently added to RubyGems.org (for the first time).
-
#most_downloaded ⇒ Array
Returns an array containing the top 50 downloaded gem versions of all time.
-
#most_downloaded_today ⇒ Array
Returns an array containing the top 50 downloaded gem versions for today.
-
#owners(gem_name) ⇒ Array
View all owners of a gem that you own.
-
#push(gem, host = Configuration::DEFAULT_HOST) ⇒ String
Submit a gem to RubyGems.org or another host.
-
#remove_owner(gem_name, owner) ⇒ String
Remove a user's permission to manage a RubyGem you own.
-
#remove_web_hook(gem_name, url) ⇒ String
Remove a webhook.
-
#reverse_dependencies(gem_name, options = {}) ⇒ Array
Returns an array of all the reverse dependencies to the given gem.
-
#search(query) ⇒ Array<Hash>
Returns an array of active gems that match the query.
-
#total_downloads(gem_name = nil, gem_version = nil) ⇒ Hash
Returns the total number of downloads for a particular gem.
-
#unyank(gem_name, gem_version = nil, options = {}) ⇒ String
Update a previously yanked gem back into RubyGems.org's index.
-
#versions(gem_name) ⇒ Hash
Returns an array of gem version details.
-
#web_hooks ⇒ Hash
List the webhooks registered under your account.
-
#yank(gem_name, gem_version = nil, options = {}) ⇒ String
Remove a gem from RubyGems.org's index.
Methods included from Request
Constructor Details
#initialize(options = {}) ⇒ Client
Returns a new instance of Client.
11 12 13 14 15 16 |
# File 'lib/gems/client.rb', line 11 def initialize(={}) = Gems..merge() Configuration::VALID_OPTIONS_KEYS.each do |key| send("#{key}=", [key]) end end |
Instance Method Details
#add_owner(gem_name, owner) ⇒ String
Add an owner to a RubyGem you own, giving that user permission to manage it
192 193 194 |
# File 'lib/gems/client.rb', line 192 def add_owner(gem_name, owner) post("/api/v1/gems/#{gem_name}/owners", {:email => owner}) end |
#add_web_hook(gem_name, url) ⇒ String
Create a webhook
227 228 229 |
# File 'lib/gems/client.rb', line 227 def add_web_hook(gem_name, url) post("/api/v1/web_hooks", {:gem_name => gem_name, :url => url}) end |
#api_key ⇒ String
Retrieve your API key using HTTP basic auth
289 290 291 |
# File 'lib/gems/client.rb', line 289 def api_key get('/api/v1/api_key') end |
#dependencies(*gems) ⇒ Array
Returns an array of hashes for all versions of given gems
300 301 302 303 |
# File 'lib/gems/client.rb', line 300 def dependencies(*gems) response = get('/api/v1/dependencies', {:gems => gems.join(',')}) Marshal.load(response) end |
#downloads(gem_name, gem_version = nil, from = nil, to = Date.today) ⇒ Hash
Returns the number of downloads by day for a particular gem version
162 163 164 165 166 167 168 169 170 |
# File 'lib/gems/client.rb', line 162 def downloads(gem_name, gem_version=nil, from=nil, to=Date.today) gem_version ||= info(gem_name)['version'] response = if from get("/api/v1/versions/#{gem_name}-#{gem_version}/downloads/search.yaml", {:from => from.to_s, :to => to.to_s}) else get("/api/v1/versions/#{gem_name}-#{gem_version}/downloads.yaml") end YAML.load(response) end |
#fire_web_hook(gem_name, url) ⇒ String
Test fire a webhook
251 252 253 |
# File 'lib/gems/client.rb', line 251 def fire_web_hook(gem_name, url) post("/api/v1/web_hooks/fire", {:gem_name => gem_name, :url => url}) end |
#gems(user_handle = nil) ⇒ Array
List all gems that you own
49 50 51 52 53 54 55 56 |
# File 'lib/gems/client.rb', line 49 def gems(user_handle=nil) response = if user_handle get("/api/v1/owners/#{user_handle}/gems.yaml") else get("/api/v1/gems.yaml") end YAML.load(response) end |
#info(gem_name) ⇒ Hash
Returns some basic information about the given gem
25 26 27 28 |
# File 'lib/gems/client.rb', line 25 def info(gem_name) response = get("/api/v1/gems/#{gem_name}.yaml") YAML.load(response) end |
#just_updated(options = {}) ⇒ Array
Returns the 50 most recently updated gems
274 275 276 277 |
# File 'lib/gems/client.rb', line 274 def just_updated(={}) response = get("/api/v1/activity/just_updated.yaml", ) YAML.load(response) end |
#latest(options = {}) ⇒ Array
Returns the 50 gems most recently added to RubyGems.org (for the first time)
262 263 264 265 |
# File 'lib/gems/client.rb', line 262 def latest(={}) response = get("/api/v1/activity/latest.yaml", ) YAML.load(response) end |
#most_downloaded ⇒ Array
Returns an array containing the top 50 downloaded gem versions of all time
147 148 149 150 |
# File 'lib/gems/client.rb', line 147 def most_downloaded response = get("/api/v1/downloads/all.yaml") YAML.load(response)[:gems] end |
#most_downloaded_today ⇒ Array
Returns an array containing the top 50 downloaded gem versions for today
136 137 138 139 |
# File 'lib/gems/client.rb', line 136 def most_downloaded_today response = get("/api/v1/downloads/top.yaml") YAML.load(response)[:gems] end |
#owners(gem_name) ⇒ Array
View all owners of a gem that you own
179 180 181 182 |
# File 'lib/gems/client.rb', line 179 def owners(gem_name) response = get("/api/v1/gems/#{gem_name}/owners.yaml") YAML.load(response) end |
#push(gem, host = Configuration::DEFAULT_HOST) ⇒ String
Submit a gem to RubyGems.org or another host
66 67 68 |
# File 'lib/gems/client.rb', line 66 def push(gem, host=Configuration::DEFAULT_HOST) post("/api/v1/gems", gem.read, 'application/octet-stream', host) end |
#remove_owner(gem_name, owner) ⇒ String
Remove a user's permission to manage a RubyGem you own
204 205 206 |
# File 'lib/gems/client.rb', line 204 def remove_owner(gem_name, owner) delete("/api/v1/gems/#{gem_name}/owners", {:email => owner}) end |
#remove_web_hook(gem_name, url) ⇒ String
Remove a webhook
239 240 241 |
# File 'lib/gems/client.rb', line 239 def remove_web_hook(gem_name, url) delete("/api/v1/web_hooks/remove", {:gem_name => gem_name, :url => url}) end |
#reverse_dependencies(gem_name, options = {}) ⇒ Array
Returns an array of all the reverse dependencies to the given gem.
313 314 315 316 |
# File 'lib/gems/client.rb', line 313 def reverse_dependencies(gem_name, ={}) response = get("/api/v1/gems/#{gem_name}/reverse_dependencies.yaml", ) YAML.load(response) end |
#search(query) ⇒ Array<Hash>
Returns an array of active gems that match the query
37 38 39 40 |
# File 'lib/gems/client.rb', line 37 def search(query) response = get("/api/v1/search.yaml", {:query => query}) YAML.load(response) end |
#total_downloads(gem_name = nil, gem_version = nil) ⇒ Hash
Returns the total number of downloads for a particular gem
120 121 122 123 124 125 126 127 128 |
# File 'lib/gems/client.rb', line 120 def total_downloads(gem_name=nil, gem_version=nil) response = if gem_name gem_version ||= info(gem_name)['version'] get("/api/v1/downloads/#{gem_name}-#{gem_version}.yaml") else get("/api/v1/downloads.yaml") end YAML.load(response) end |
#unyank(gem_name, gem_version = nil, options = {}) ⇒ String
Update a previously yanked gem back into RubyGems.org's index
95 96 97 98 |
# File 'lib/gems/client.rb', line 95 def unyank(gem_name, gem_version=nil, ={}) gem_version ||= info(gem_name)['version'] put("/api/v1/gems/unyank", .merge(:gem_name => gem_name, :version => gem_version)) end |
#versions(gem_name) ⇒ Hash
Returns an array of gem version details
107 108 109 110 |
# File 'lib/gems/client.rb', line 107 def versions(gem_name) response = get("/api/v1/versions/#{gem_name}.yaml") YAML.load(response) end |
#web_hooks ⇒ Hash
List the webhooks registered under your account
214 215 216 217 |
# File 'lib/gems/client.rb', line 214 def web_hooks response = get("/api/v1/web_hooks.yaml") YAML.load(response) end |
#yank(gem_name, gem_version = nil, options = {}) ⇒ String
Remove a gem from RubyGems.org's index
80 81 82 83 |
# File 'lib/gems/client.rb', line 80 def yank(gem_name, gem_version=nil, ={}) gem_version ||= info(gem_name)['version'] delete("/api/v1/gems/yank", .merge(:gem_name => gem_name, :version => gem_version)) end |