class Gems::Client
Public Class Methods
# File lib/gems/client.rb, line 11 def initialize(options={}) options = Gems.options.merge(options) Configuration::VALID_OPTIONS_KEYS.each do |key| send("#{key}=", options[key]) end end
Public Instance Methods
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] @example
Gems.add_owner 'gemcutter', 'josh@technicalpickles.com'
# File lib/gems/client.rb, line 192 def add_owner(gem_name, owner) post("/api/v1/gems/#{gem_name}/owners", {:email => owner}) end
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] @example
Gems.add_web_hook 'rails', 'http://example.com'
# 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
Retrieve your API key using HTTP basic auth
@authenticated true @return [String] @example
Gems.configure do |config| config.username = 'nick@gemcutter.org' config.password = 'schwwwwing' end Gems.api_key
# File lib/gems/client.rb, line 289 def api_key get('/api/v1/api_key') end
Returns an array of hashes for all versions of given gems
@authenticated false @param gems [Array] A list of gem names @return [Array] @example
Gems.dependencies 'rails', 'thor'
# File lib/gems/client.rb, line 300 def dependencies(*gems) response = get('/api/v1/dependencies', {:gems => gems.join(',')}) Marshal.load(response) end
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. @param to [Date] Search end date. @return [Hash] @example
Gems.downloads 'coulda', '0.6.3', Date.today - 30, Date.today
# 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
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] @example
Gems.fire_web_hook 'rails', 'http://example.com'
# 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
List all gems that you own
@authenticated true @param user_handle [String] The handle of a user. @return [Array] @example
Gems.gems
# 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
Returns some basic information about the given gem
@authenticated false @param gem_name [String] The name of a gem. @return [Hash] @example
Gems.info 'rails'
# File lib/gems/client.rb, line 25 def info(gem_name) response = get("/api/v1/gems/#{gem_name}.yaml") YAML.load(response) end
Returns the 50 most recently updated gems
@authenticated false @param options [Hash] A customizable set of options. @return [Array] @example
Gem.just_updated
# File lib/gems/client.rb, line 274 def just_updated(options={}) response = get("/api/v1/activity/just_updated.yaml", options) YAML.load(response) end
Returns the 50 gems most recently added to RubyGems.org (for the first time)
@authenticated false @param options [Hash] A customizable set of options. @return [Array] @example
Gem.latest
# File lib/gems/client.rb, line 262 def latest(options={}) response = get("/api/v1/activity/latest.yaml", options) YAML.load(response) end
Returns an array containing the top 50 downloaded gem versions of all time
@authenticated false @return [Array] @example
Gems.most_downloaded
# File lib/gems/client.rb, line 147 def most_downloaded response = get("/api/v1/downloads/all.yaml") YAML.load(response)[:gems] end
Returns an array containing the top 50 downloaded gem versions for today
@authenticated false @return [Array] @example
Gems.most_downloaded_today
# File lib/gems/client.rb, line 136 def most_downloaded_today response = get("/api/v1/downloads/top.yaml") YAML.load(response)[:gems] end
View all owners of a gem that you own
@authenticated true @param gem_name [String] The name of a gem. @return [Array] @example
Gems.owners 'gemcutter'
# File lib/gems/client.rb, line 179 def owners(gem_name) response = get("/api/v1/gems/#{gem_name}/owners.yaml") YAML.load(response) end
Submit a gem to RubyGems.org or another host
@authenticated true @param gem [File] A built gem. @param host [String] A RubyGems compatible host to use. @return [String] @example
Gems.push File.new 'pkg/gemcutter-0.2.1.gem'
# 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 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] @example
Gems.remove_owner 'gemcutter', 'josh@technicalpickles.com'
# File lib/gems/client.rb, line 204 def remove_owner(gem_name, owner) delete("/api/v1/gems/#{gem_name}/owners", {:email => owner}) end
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] @example
Gems.remove_web_hook 'rails', 'http://example.com'
# 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
Returns an array of all the reverse dependencies to the given gem.
@authenticated false @param gem_name [String] The name of a gem @param options [Hash] A customizable set of options. @return [Array] @example
Gems.reverse_dependencies 'money'
# File lib/gems/client.rb, line 313 def reverse_dependencies(gem_name, options={}) response = get("/api/v1/gems/#{gem_name}/reverse_dependencies.yaml", options) YAML.load(response) end
Returns an array of active gems that match the query
@authenticated false @param query [String] A term to search for. @return [Array<Hash>] @example
Gems.search 'cucumber'
# File lib/gems/client.rb, line 37 def search(query) response = get("/api/v1/search.yaml", {:query => query}) YAML.load(response) end
Returns the total number of downloads for a particular gem
@authenticated false @param gem_name [String] The name of a gem. @param gem_version [String] The version of a gem. @return [Hash] @example
Gems.total_downloads 'rails_admin', '0.0.1'
# 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
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. @option options [String] :platform @return [String] @example
Gems.unyank "gemcutter", "0.2.1", {:platform => "x86-darwin-10"}
# File lib/gems/client.rb, line 95 def unyank(gem_name, gem_version=nil, options={}) gem_version ||= info(gem_name)['version'] put("/api/v1/gems/unyank", options.merge(:gem_name => gem_name, :version => gem_version)) end
Returns an array of gem version details
@authenticated false @param gem_name [String] The name of a gem. @return [Hash] @example
Gems.versions 'coulda'
# File lib/gems/client.rb, line 107 def versions(gem_name) response = get("/api/v1/versions/#{gem_name}.yaml") YAML.load(response) end
List the webhooks registered under your account
@authenticated true @return [Hash] @example
Gems.web_hooks
# File lib/gems/client.rb, line 214 def web_hooks response = get("/api/v1/web_hooks.yaml") YAML.load(response) end
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. @option options [String] :platform @return [String] @example
Gems.yank "gemcutter", "0.2.1", {:platform => "x86-darwin-10"}
# File lib/gems/client.rb, line 80 def yank(gem_name, gem_version=nil, options={}) gem_version ||= info(gem_name)['version'] delete("/api/v1/gems/yank", options.merge(:gem_name => gem_name, :version => gem_version)) end