lib/gems/client.rb in gems-0.8.3 vs lib/gems/client.rb in gems-1.0.0
- old
+ new
@@ -1,16 +1,16 @@
require 'date'
require 'gems/configuration'
require 'gems/request'
-require 'yaml'
+require 'json'
module Gems
class Client
include Gems::Request
- attr_accessor *Configuration::VALID_OPTIONS_KEYS
+ attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
- def initialize(options={})
+ def initialize(options = {})
options = Gems.options.merge(options)
Configuration::VALID_OPTIONS_KEYS.each do |key|
send("#{key}=", options[key])
end
end
@@ -21,52 +21,48 @@
# @param gem_name [String] The name of a gem.
# @return [Hash]
# @example
# Gems.info 'rails'
def info(gem_name)
- response = get("/api/v1/gems/#{gem_name}.yaml")
- YAML.load(response)
+ response = get("/api/v1/gems/#{gem_name}.json")
+ JSON.parse(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'
def search(query)
- response = get("/api/v1/search.yaml", {:query => query})
- YAML.load(response)
+ response = get('/api/v1/search.json', :query => query)
+ JSON.parse(response)
end
# List all gems that you own
#
# @authenticated true
# @param user_handle [String] The handle of a user.
# @return [Array]
# @example
# Gems.gems
- 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)
+ def gems(user_handle = nil)
+ response = user_handle ? get("/api/v1/owners/#{user_handle}/gems.json") : get('/api/v1/gems.json')
+ JSON.parse(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'
- def push(gem, host=Configuration::DEFAULT_HOST)
- post("/api/v1/gems", gem.read, 'application/octet-stream', host)
+ def push(gem, host = Configuration::DEFAULT_HOST)
+ post('/api/v1/gems', gem.read, 'application/octet-stream', host)
end
# Remove a gem from RubyGems.org's index
#
# @authenticated true
@@ -75,13 +71,13 @@
# @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"}
- def yank(gem_name, gem_version=nil, options={})
+ 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))
+ delete('/api/v1/gems/yank', options.merge(:gem_name => gem_name, :version => gem_version))
end
# Update a previously yanked gem back into RubyGems.org's index
#
# @authenticated true
@@ -90,65 +86,60 @@
# @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"}
- def unyank(gem_name, gem_version=nil, options={})
+ 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))
+ 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'
def versions(gem_name)
- response = get("/api/v1/versions/#{gem_name}.yaml")
- YAML.load(response)
+ response = get("/api/v1/versions/#{gem_name}.json")
+ JSON.parse(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'
- 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)
+ def total_downloads(gem_name = nil, gem_version = nil)
+ response = gem_name ? get("/api/v1/downloads/#{gem_name}-#{gem_version || info(gem_name)['version']}.json") : get('/api/v1/downloads.json')
+ JSON.parse(response, :symbolize_names => true)
end
# Returns an array containing the top 50 downloaded gem versions for today
#
# @authenticated false
# @return [Array]
# @example
# Gems.most_downloaded_today
def most_downloaded_today
- response = get("/api/v1/downloads/top.yaml")
- YAML.load(response)[:gems]
+ response = get('/api/v1/downloads/top.json')
+ JSON.parse(response)['gems']
end
# Returns an array containing the top 50 downloaded gem versions of all time
#
# @authenticated false
# @return [Array]
# @example
# Gems.most_downloaded
def most_downloaded
- response = get("/api/v1/downloads/all.yaml")
- YAML.load(response)[:gems]
+ response = get('/api/v1/downloads/all.json')
+ JSON.parse(response)['gems']
end
# Returns the number of downloads by day for a particular gem version
#
# @authenticated false
@@ -157,30 +148,26 @@
# @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
- def downloads(gem_name, gem_version=nil, from=nil, to=Date.today)
+ 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)
+ response = from ? get("/api/v1/versions/#{gem_name}-#{gem_version}/downloads/search.json", :from => from.to_s, :to => to.to_s) : get("/api/v1/versions/#{gem_name}-#{gem_version}/downloads.json")
+ JSON.parse(response)
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'
def owners(gem_name)
- response = get("/api/v1/gems/#{gem_name}/owners.yaml")
- YAML.load(response)
+ response = get("/api/v1/gems/#{gem_name}/owners.json")
+ JSON.parse(response)
end
# Add an owner to a RubyGem you own, giving that user permission to manage it
#
# @authenticated true
@@ -188,11 +175,11 @@
# @param owner [String] The email address of the user you want to add.
# @return [String]
# @example
# Gems.add_owner 'gemcutter', 'josh@technicalpickles.com'
def add_owner(gem_name, owner)
- post("/api/v1/gems/#{gem_name}/owners", {:email => owner})
+ post("/api/v1/gems/#{gem_name}/owners", :email => owner)
end
# Remove a user's permission to manage a RubyGem you own
#
# @authenticated true
@@ -200,22 +187,22 @@
# @param owner [String] The email address of the user you want to remove.
# @return [String]
# @example
# Gems.remove_owner 'gemcutter', 'josh@technicalpickles.com'
def remove_owner(gem_name, owner)
- delete("/api/v1/gems/#{gem_name}/owners", {:email => owner})
+ delete("/api/v1/gems/#{gem_name}/owners", :email => owner)
end
# List the webhooks registered under your account
#
# @authenticated true
# @return [Hash]
# @example
# Gems.web_hooks
def web_hooks
- response = get("/api/v1/web_hooks.yaml")
- YAML.load(response)
+ response = get('/api/v1/web_hooks.json')
+ JSON.parse(response)
end
# Create a webhook
#
# @authenticated true
@@ -223,11 +210,11 @@
# @param url [String] The URL of the web hook.
# @return [String]
# @example
# Gems.add_web_hook 'rails', 'http://example.com'
def add_web_hook(gem_name, url)
- post("/api/v1/web_hooks", {:gem_name => gem_name, :url => url})
+ post('/api/v1/web_hooks', :gem_name => gem_name, :url => url)
end
# Remove a webhook
#
# @authenticated true
@@ -235,11 +222,11 @@
# @param url [String] The URL of the web hook.
# @return [String]
# @example
# Gems.remove_web_hook 'rails', 'http://example.com'
def remove_web_hook(gem_name, url)
- delete("/api/v1/web_hooks/remove", {:gem_name => gem_name, :url => url})
+ delete('/api/v1/web_hooks/remove', :gem_name => gem_name, :url => url)
end
# Test fire a webhook
#
# @authenticated true
@@ -247,35 +234,35 @@
# @param url [String] The URL of the web hook.
# @return [String]
# @example
# Gems.fire_web_hook 'rails', 'http://example.com'
def fire_web_hook(gem_name, url)
- post("/api/v1/web_hooks/fire", {:gem_name => gem_name, :url => url})
+ post('/api/v1/web_hooks/fire', :gem_name => gem_name, :url => url)
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
- def latest(options={})
- response = get("/api/v1/activity/latest.yaml", options)
- YAML.load(response)
+ def latest(options = {})
+ response = get('/api/v1/activity/latest.json', options)
+ JSON.parse(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
- def just_updated(options={})
- response = get("/api/v1/activity/just_updated.yaml", options)
- YAML.load(response)
+ def just_updated(options = {})
+ response = get('/api/v1/activity/just_updated.json', options)
+ JSON.parse(response)
end
# Retrieve your API key using HTTP basic auth
#
# @authenticated true
@@ -296,11 +283,11 @@
# @param gems [Array] A list of gem names
# @return [Array]
# @example
# Gems.dependencies 'rails', 'thor'
def dependencies(*gems)
- response = get('/api/v1/dependencies', {:gems => gems.join(',')})
+ response = get('/api/v1/dependencies', :gems => gems.join(','))
Marshal.load(response)
end
# Returns an array of all the reverse dependencies to the given gem.
#
@@ -308,11 +295,11 @@
# @param gem_name [String] The name of a gem
# @param options [Hash] A customizable set of options.
# @return [Array]
# @example
# Gems.reverse_dependencies 'money'
- def reverse_dependencies(gem_name, options={})
- response = get("/api/v1/gems/#{gem_name}/reverse_dependencies.yaml", options)
- YAML.load(response)
+ def reverse_dependencies(gem_name, options = {})
+ response = get("/api/v1/gems/#{gem_name}/reverse_dependencies.json", options)
+ JSON.parse(response)
end
end
end