dbalatero-httparty 0.4.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (48) hide show
  1. data/History +131 -0
  2. data/MIT-LICENSE +20 -0
  3. data/Manifest +47 -0
  4. data/README.rdoc +54 -0
  5. data/Rakefile +48 -0
  6. data/bin/httparty +98 -0
  7. data/cucumber.yml +1 -0
  8. data/examples/aaws.rb +32 -0
  9. data/examples/basic.rb +11 -0
  10. data/examples/delicious.rb +37 -0
  11. data/examples/google.rb +16 -0
  12. data/examples/rubyurl.rb +14 -0
  13. data/examples/twitter.rb +31 -0
  14. data/examples/whoismyrep.rb +10 -0
  15. data/features/basic_authentication.feature +20 -0
  16. data/features/command_line.feature +7 -0
  17. data/features/deals_with_http_error_codes.feature +26 -0
  18. data/features/handles_multiple_formats.feature +34 -0
  19. data/features/steps/env.rb +15 -0
  20. data/features/steps/httparty_response_steps.rb +26 -0
  21. data/features/steps/httparty_steps.rb +15 -0
  22. data/features/steps/mongrel_helper.rb +55 -0
  23. data/features/steps/remote_service_steps.rb +47 -0
  24. data/features/supports_redirection.feature +22 -0
  25. data/httparty.gemspec +40 -0
  26. data/lib/httparty.rb +242 -0
  27. data/lib/httparty/cookie_hash.rb +9 -0
  28. data/lib/httparty/core_extensions.rb +29 -0
  29. data/lib/httparty/exceptions.rb +7 -0
  30. data/lib/httparty/module_inheritable_attributes.rb +25 -0
  31. data/lib/httparty/request.rb +200 -0
  32. data/lib/httparty/response.rb +18 -0
  33. data/lib/httparty/version.rb +3 -0
  34. data/spec/fixtures/delicious.xml +23 -0
  35. data/spec/fixtures/empty.xml +0 -0
  36. data/spec/fixtures/google.html +3 -0
  37. data/spec/fixtures/twitter.json +1 -0
  38. data/spec/fixtures/twitter.xml +403 -0
  39. data/spec/fixtures/undefined_method_add_node_for_nil.xml +2 -0
  40. data/spec/httparty/cookie_hash_spec.rb +38 -0
  41. data/spec/httparty/request_spec.rb +247 -0
  42. data/spec/httparty/response_spec.rb +62 -0
  43. data/spec/httparty_spec.rb +289 -0
  44. data/spec/spec.opts +3 -0
  45. data/spec/spec_helper.rb +21 -0
  46. data/website/css/common.css +47 -0
  47. data/website/index.html +74 -0
  48. metadata +132 -0
@@ -0,0 +1,37 @@
1
+ dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
2
+ require File.join(dir, 'httparty')
3
+ require 'pp'
4
+ config = YAML::load(File.read(File.join(ENV['HOME'], '.delicious')))
5
+
6
+ class Delicious
7
+ include HTTParty
8
+ base_uri 'https://api.del.icio.us/v1'
9
+
10
+ def initialize(u, p)
11
+ @auth = {:username => u, :password => p}
12
+ end
13
+
14
+ # query params that filter the posts are:
15
+ # tag (optional). Filter by this tag.
16
+ # dt (optional). Filter by this date (CCYY-MM-DDThh:mm:ssZ).
17
+ # url (optional). Filter by this url.
18
+ # ie: posts(:query => {:tag => 'ruby'})
19
+ def posts(options={})
20
+ options.merge!({:basic_auth => @auth})
21
+ self.class.get('/posts/get', options)
22
+ end
23
+
24
+ # query params that filter the posts are:
25
+ # tag (optional). Filter by this tag.
26
+ # count (optional). Number of items to retrieve (Default:15, Maximum:100).
27
+ def recent(options={})
28
+ options.merge!({:basic_auth => @auth})
29
+ self.class.get('/posts/recent', options)
30
+ end
31
+ end
32
+
33
+ delicious = Delicious.new(config['username'], config['password'])
34
+ pp delicious.posts(:query => {:tag => 'ruby'})
35
+ pp delicious.recent
36
+
37
+ delicious.recent['posts']['post'].each { |post| puts post['href'] }
@@ -0,0 +1,16 @@
1
+ dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
2
+ require File.join(dir, 'httparty')
3
+ require 'pp'
4
+
5
+ class Google
6
+ include HTTParty
7
+ format :html
8
+ end
9
+
10
+ # google.com redirects to www.google.com so this is live test for redirection
11
+ pp Google.get('http://google.com')
12
+
13
+ puts '', '*'*70, ''
14
+
15
+ # check that ssl is requesting right
16
+ pp Google.get('https://www.google.com')
@@ -0,0 +1,14 @@
1
+ dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
2
+ require File.join(dir, 'httparty')
3
+ require 'pp'
4
+
5
+ class Rubyurl
6
+ include HTTParty
7
+ base_uri 'rubyurl.com'
8
+
9
+ def self.shorten( website_url )
10
+ post( '/api/links.json', :query => { :link => { :website_url => website_url } } )
11
+ end
12
+ end
13
+
14
+ pp Rubyurl.shorten( 'http://istwitterdown.com/')
@@ -0,0 +1,31 @@
1
+ dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
2
+ require File.join(dir, 'httparty')
3
+ require 'pp'
4
+ config = YAML::load(File.read(File.join(ENV['HOME'], '.twitter')))
5
+
6
+ class Twitter
7
+ include HTTParty
8
+ base_uri 'twitter.com'
9
+
10
+ def initialize(u, p)
11
+ @auth = {:username => u, :password => p}
12
+ end
13
+
14
+ # which can be :friends, :user or :public
15
+ # options[:query] can be things like since, since_id, count, etc.
16
+ def timeline(which=:friends, options={})
17
+ options.merge!({:basic_auth => @auth})
18
+ self.class.get("/statuses/#{which}_timeline.json", options)
19
+ end
20
+
21
+ def post(text)
22
+ options = { :query => {:status => text}, :basic_auth => @auth }
23
+ self.class.post('/statuses/update.json', options)
24
+ end
25
+ end
26
+
27
+ twitter = Twitter.new(config['email'], config['password'])
28
+ pp twitter.timeline
29
+ # pp twitter.timeline(:friends, :query => {:since_id => 868482746})
30
+ # pp twitter.timeline(:friends, :query => 'since_id=868482746')
31
+ # pp twitter.post('this is a test of 0.2.0')
@@ -0,0 +1,10 @@
1
+ dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
2
+ require File.join(dir, 'httparty')
3
+ require 'pp'
4
+
5
+ class Rep
6
+ include HTTParty
7
+ end
8
+
9
+ pp Rep.get('http://whoismyrepresentative.com/whoismyrep.php?zip=46544')
10
+ pp Rep.get('http://whoismyrepresentative.com/whoismyrep.php', :query => {:zip => 46544})
@@ -0,0 +1,20 @@
1
+ Feature: Basic Authentication
2
+
3
+ As a developer
4
+ I want to be able to use a service that requires Basic Authentication
5
+ Because that is not an uncommon requirement
6
+
7
+ Scenario: Passing no credentials to a page requiring Basic Authentication
8
+ Given a restricted page at '/protected.html'
9
+ When I call HTTParty#get with '/protected.html'
10
+ Then it should return a response with a 401 response code
11
+
12
+ Scenario: Passing proper credentials to a page requiring Basic Authentication
13
+ Given a remote service that returns 'Authenticated Page'
14
+ And that service is accessed at the path '/protected.html'
15
+ And that service is protected by Basic Authentication
16
+ And that service requires the username 'jcash' with the password 'maninblack'
17
+ When I call HTTParty#get with '/protected.html' and a basic_auth hash:
18
+ | username | password |
19
+ | jcash | maninblack |
20
+ Then the return value should match 'Authenticated Page'
@@ -0,0 +1,7 @@
1
+ Feature: Command Line
2
+
3
+ As a developer
4
+ I want to be able to harness the power of HTTParty from the command line
5
+ Because that would make quick testing and debugging easy
6
+ And 'easy' is my middle name
7
+ And I'm kidding it's actually 'Danger'!
@@ -0,0 +1,26 @@
1
+ Feature: Deals with HTTP error codes
2
+
3
+ As a developer
4
+ I want to be informed of non-successful responses
5
+ Because sometimes thing explode
6
+ And I should probably know what happened
7
+
8
+ Scenario: A response of '404 - Not Found'
9
+ Given a remote service that returns a 404 status code
10
+ And that service is accessed at the path '/service.html'
11
+ When I call HTTParty#get with '/service.html'
12
+ Then it should return a response with a 404 response code
13
+
14
+ Scenario: A response of '500 - Internal Server Error'
15
+ Given a remote service that returns a 500 status code
16
+ And that service is accessed at the path '/service.html'
17
+ When I call HTTParty#get with '/service.html'
18
+ Then it should return a response with a 500 response code
19
+
20
+ Scenario: A non-successful response where I need the body
21
+ Given a remote service that returns a 400 status code
22
+ And the response from the service has a body of 'Bad response'
23
+ And that service is accessed at the path '/service.html'
24
+ When I call HTTParty#get with '/service.html'
25
+ Then it should return a response with a 400 response code
26
+ And the return value should match 'Bad response'
@@ -0,0 +1,34 @@
1
+ Feature: Handles Multiple Formats
2
+
3
+ As a developer
4
+ I want to be able to consume remote services of many different formats
5
+ And I want those formats to be automatically detected and handled
6
+ Because web services take many forms
7
+ And I don't want to have to do any extra work
8
+
9
+ Scenario: An HTML service
10
+ Given a remote service that returns '<h1>Some HTML</h1>'
11
+ And that service is accessed at the path '/service.html'
12
+ And the response from the service has a Content-Type of 'text/html'
13
+ When I call HTTParty#get with '/service.html'
14
+ Then it should return a String
15
+ And the return value should match '<h1>Some HTML</h1>'
16
+
17
+ Scenario: A JSON service
18
+ Given a remote service that returns '{ "jennings": "waylon", "cash": "johnny" }'
19
+ And that service is accessed at the path '/service.json'
20
+ And the response from the service has a Content-Type of 'application/json'
21
+ When I call HTTParty#get with '/service.json'
22
+ Then it should return a Hash equaling:
23
+ | key | value |
24
+ | jennings | waylon |
25
+ | cash | johnny |
26
+
27
+ Scenario: An XML Service
28
+ Given a remote service that returns '<singer>waylon jennings</singer>'
29
+ And that service is accessed at the path '/service.xml'
30
+ And the response from the service has a Content-Type of 'text/xml'
31
+ When I call HTTParty#get with '/service.xml'
32
+ Then it should return a Hash equaling:
33
+ | key | value |
34
+ | singer | waylon jennings |
@@ -0,0 +1,15 @@
1
+ require 'mongrel'
2
+ require 'activesupport'
3
+ require 'lib/httparty'
4
+ require 'spec/expectations'
5
+
6
+ Before do
7
+ port = ENV["HTTPARTY_PORT"] || 31981
8
+ @host_and_port = "0.0.0.0:#{port}"
9
+ @server = Mongrel::HttpServer.new("0.0.0.0", port)
10
+ @server.run
11
+ end
12
+
13
+ After do
14
+ @server.stop
15
+ end
@@ -0,0 +1,26 @@
1
+ Then /it should return an? (\w+)$/ do |class_string|
2
+ @response_from_httparty.should be_an_instance_of(class_string.constantize)
3
+ end
4
+
5
+ Then /the return value should match '(.*)'/ do |expected_text|
6
+ @response_from_httparty.should eql(expected_text)
7
+ end
8
+
9
+ Then /it should return a Hash equaling:/ do |hash_table|
10
+ @response_from_httparty.should be_an_instance_of(Hash)
11
+ @response_from_httparty.keys.length.should eql(hash_table.rows.length)
12
+ hash_table.hashes.each do |pair|
13
+ key, value = pair["key"], pair["value"]
14
+ @response_from_httparty.keys.should include(key)
15
+ @response_from_httparty[key].should eql(value)
16
+ end
17
+ end
18
+
19
+ Then /it should return a response with a (\d+) response code/ do |code|
20
+ @response_from_httparty.code.should eql(code.to_i)
21
+ end
22
+
23
+ Then /it should raise an HTTParty::RedirectionTooDeep exception/ do
24
+ @exception_from_httparty.should_not be_nil
25
+ @exception_from_httparty.class.should eql(HTTParty::RedirectionTooDeep)
26
+ end
@@ -0,0 +1,15 @@
1
+ When /I call HTTParty#get with '(.*)'$/ do |url|
2
+ begin
3
+ @response_from_httparty = HTTParty.get("http://#{@host_and_port}#{url}")
4
+ rescue HTTParty::RedirectionTooDeep => e
5
+ @exception_from_httparty = e
6
+ end
7
+ end
8
+
9
+ When /I call HTTParty#get with '(.*)' and a basic_auth hash:/ do |url, auth_table|
10
+ h = auth_table.hashes.first
11
+ @response_from_httparty = HTTParty.get(
12
+ "http://#{@host_and_port}#{url}",
13
+ :basic_auth => { :username => h["username"], :password => h["password"] }
14
+ )
15
+ end
@@ -0,0 +1,55 @@
1
+ def basic_mongrel_handler
2
+ Class.new(Mongrel::HttpHandler) do
3
+ attr_writer :content_type, :response_body, :response_code
4
+
5
+ def initialize
6
+ @content_type = "text/html"
7
+ @response_body = ""
8
+ @response_code = 200
9
+ @custom_headers = {}
10
+ end
11
+
12
+ def process(request, response)
13
+ reply_with(response, @response_code, @response_body)
14
+ end
15
+
16
+ def reply_with(response, code, response_body)
17
+ response.start(code) do |head, body|
18
+ head["Content-Type"] = @content_type
19
+ @custom_headers.each { |k,v| head[k] = v }
20
+ body.write(response_body)
21
+ end
22
+ end
23
+ end
24
+ end
25
+
26
+ def new_mongrel_handler
27
+ basic_mongrel_handler.new
28
+ end
29
+
30
+ def add_basic_authentication_to(handler)
31
+ m = Module.new do
32
+ attr_writer :username, :password
33
+
34
+ def self.extended(base)
35
+ base.instance_eval { @custom_headers["WWW-Authenticate"] = 'Basic Realm="Super Secret Page"' }
36
+ base.class_eval { alias_method_chain :process, :basic_authentication }
37
+ end
38
+
39
+ def process_with_basic_authentication(request, response)
40
+ if authorized?(request) then process_without_basic_authentication(request, response)
41
+ else reply_with(response, 401, "Incorrect. You have 20 seconds to comply.")
42
+ end
43
+ end
44
+
45
+ def authorized?(request)
46
+ request.params["HTTP_AUTHORIZATION"] == "Basic " + Base64.encode64("#{@username}:#{@password}").strip
47
+ end
48
+ end
49
+ handler.extend(m)
50
+ end
51
+
52
+ def new_mongrel_redirector(target_url, relative_path = false)
53
+ target_url = "http://#{@host_and_port}#{target_url}" unless relative_path
54
+ Mongrel::RedirectHandler.new(target_url)
55
+ end
@@ -0,0 +1,47 @@
1
+ Given /a remote service that returns '(.*)'/ do |response_body|
2
+ @handler = new_mongrel_handler
3
+ Given "the response from the service has a body of '#{response_body}'"
4
+ end
5
+
6
+ Given /a remote service that returns a (\d+) status code/ do |code|
7
+ @handler = new_mongrel_handler
8
+ @handler.response_code = code
9
+ end
10
+
11
+ Given /that service is accessed at the path '(.*)'/ do |path|
12
+ @server.register(path, @handler)
13
+ end
14
+
15
+ Given /the response from the service has a Content-Type of '(.*)'/ do |content_type|
16
+ @handler.content_type = content_type
17
+ end
18
+
19
+ Given /the response from the service has a body of '(.*)'/ do |response_body|
20
+ @handler.response_body = response_body
21
+ end
22
+
23
+ Given /the url '(.*)' redirects to '(.*)'/ do |redirection_url, target_url|
24
+ @server.register redirection_url, new_mongrel_redirector(target_url)
25
+ end
26
+
27
+ Given /that service is protected by Basic Authentication/ do
28
+ add_basic_authentication_to @handler
29
+ end
30
+
31
+ Given /that service requires the username '(.*)' with the password '(.*)'/ do |username, password|
32
+ @handler.username = username
33
+ @handler.password = password
34
+ end
35
+
36
+ Given /a restricted page at '(.*)'/ do |url|
37
+ Given "a remote service that returns 'A response I will never see'"
38
+ And "that service is accessed at the path '#{url}'"
39
+ And "that service is protected by Basic Authentication"
40
+ And "that service requires the username 'something' with the password 'secret'"
41
+ end
42
+
43
+ # This joins the server thread, and halts cucumber, so you can actually hit the
44
+ # server with a browser. Runs until you kill it with Ctrl-c
45
+ Given /I want to hit this in a browser/ do
46
+ @server.acceptor.join
47
+ end
@@ -0,0 +1,22 @@
1
+ Feature: Supports Redirection
2
+
3
+ As a developer
4
+ I want to work with services that may redirect me
5
+ And I want it to follow a reasonable number of redirects
6
+ Because sometimes web services do that
7
+
8
+ Scenario: A service that redirects once
9
+ Given a remote service that returns 'Service Response'
10
+ And that service is accessed at the path '/service.html'
11
+ And the url '/redirector.html' redirects to '/service.html'
12
+ When I call HTTParty#get with '/redirector.html'
13
+ Then the return value should match 'Service Response'
14
+
15
+ # TODO: Look in to why this actually fails...
16
+ Scenario: A service that redirects to a relative URL
17
+
18
+ Scenario: A service that redirects infinitely
19
+ Given the url '/first.html' redirects to '/second.html'
20
+ And the url '/second.html' redirects to '/first.html'
21
+ When I call HTTParty#get with '/first.html'
22
+ Then it should raise an HTTParty::RedirectionTooDeep exception
data/httparty.gemspec ADDED
@@ -0,0 +1,40 @@
1
+ # -*- encoding: utf-8 -*-
2
+
3
+ Gem::Specification.new do |s|
4
+ s.name = %q{httparty}
5
+ s.version = "0.4.4"
6
+
7
+ s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
8
+ s.authors = ["John Nunemaker"]
9
+ s.date = %q{2009-07-19}
10
+ s.default_executable = %q{httparty}
11
+ s.description = %q{Makes http fun! Also, makes consuming restful web services dead easy.}
12
+ s.email = %q{nunemaker@gmail.com}
13
+ s.executables = ["httparty"]
14
+ s.extra_rdoc_files = ["bin/httparty", "lib/httparty/cookie_hash.rb", "lib/httparty/core_extensions.rb", "lib/httparty/exceptions.rb", "lib/httparty/module_inheritable_attributes.rb", "lib/httparty/request.rb", "lib/httparty/response.rb", "lib/httparty/version.rb", "lib/httparty.rb", "README.rdoc"]
15
+ s.files = ["bin/httparty", "cucumber.yml", "examples/aaws.rb", "examples/basic.rb", "examples/delicious.rb", "examples/google.rb", "examples/rubyurl.rb", "examples/twitter.rb", "examples/whoismyrep.rb", "features/basic_authentication.feature", "features/command_line.feature", "features/deals_with_http_error_codes.feature", "features/handles_multiple_formats.feature", "features/steps/env.rb", "features/steps/httparty_response_steps.rb", "features/steps/httparty_steps.rb", "features/steps/mongrel_helper.rb", "features/steps/remote_service_steps.rb", "features/supports_redirection.feature", "History", "httparty.gemspec", "lib/httparty/cookie_hash.rb", "lib/httparty/core_extensions.rb", "lib/httparty/exceptions.rb", "lib/httparty/module_inheritable_attributes.rb", "lib/httparty/request.rb", "lib/httparty/response.rb", "lib/httparty/version.rb", "lib/httparty.rb", "Manifest", "MIT-LICENSE", "Rakefile", "README.rdoc", "spec/fixtures/delicious.xml", "spec/fixtures/empty.xml", "spec/fixtures/google.html", "spec/fixtures/twitter.json", "spec/fixtures/twitter.xml", "spec/fixtures/undefined_method_add_node_for_nil.xml", "spec/httparty/cookie_hash_spec.rb", "spec/httparty/request_spec.rb", "spec/httparty/response_spec.rb", "spec/httparty_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "website/css/common.css", "website/index.html"]
16
+ s.has_rdoc = true
17
+ s.homepage = %q{http://httparty.rubyforge.org}
18
+ s.post_install_message = %q{When you HTTParty, you must party hard!}
19
+ s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Httparty", "--main", "README.rdoc"]
20
+ s.require_paths = ["lib"]
21
+ s.rubyforge_project = %q{httparty}
22
+ s.rubygems_version = %q{1.3.1}
23
+ s.summary = %q{Makes http fun! Also, makes consuming restful web services dead easy.}
24
+
25
+ if s.respond_to? :specification_version then
26
+ current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
27
+ s.specification_version = 2
28
+
29
+ if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
30
+ s.add_runtime_dependency(%q<crack>, [">= 0.1.1"])
31
+ s.add_development_dependency(%q<echoe>, [">= 0"])
32
+ else
33
+ s.add_dependency(%q<crack>, [">= 0.1.1"])
34
+ s.add_dependency(%q<echoe>, [">= 0"])
35
+ end
36
+ else
37
+ s.add_dependency(%q<crack>, [">= 0.1.1"])
38
+ s.add_dependency(%q<echoe>, [">= 0"])
39
+ end
40
+ end
data/lib/httparty.rb ADDED
@@ -0,0 +1,242 @@
1
+ $:.unshift(File.dirname(__FILE__))
2
+
3
+ require 'net/http'
4
+ require 'net/https'
5
+ require 'httparty/module_inheritable_attributes'
6
+ require 'rubygems'
7
+ gem 'crack'
8
+ require 'crack'
9
+
10
+ gem 'multipart-post'
11
+ require 'net/http/post/multipart'
12
+
13
+ require 'httparty/cookie_hash'
14
+
15
+ module HTTParty
16
+
17
+ AllowedFormats = {
18
+ 'text/xml' => :xml,
19
+ 'application/xml' => :xml,
20
+ 'application/json' => :json,
21
+ 'text/json' => :json,
22
+ 'application/javascript' => :json,
23
+ 'text/javascript' => :json,
24
+ 'text/html' => :html,
25
+ 'application/x-yaml' => :yaml,
26
+ 'text/yaml' => :yaml,
27
+ 'text/plain' => :plain
28
+ } unless defined?(AllowedFormats)
29
+
30
+ def self.included(base)
31
+ base.extend ClassMethods
32
+ base.send :include, HTTParty::ModuleInheritableAttributes
33
+ base.send(:mattr_inheritable, :default_options)
34
+ base.send(:mattr_inheritable, :default_cookies)
35
+ base.instance_variable_set("@default_options", {})
36
+ base.instance_variable_set("@default_cookies", CookieHash.new)
37
+ end
38
+
39
+ module ClassMethods
40
+ # Allows setting http proxy information to be used
41
+ #
42
+ # class Foo
43
+ # include HTTParty
44
+ # http_proxy 'http://foo.com', 80
45
+ # end
46
+ def http_proxy(addr=nil, port = nil)
47
+ default_options[:http_proxyaddr] = addr
48
+ default_options[:http_proxyport] = port
49
+ end
50
+
51
+ # Allows setting a base uri to be used for each request.
52
+ # Will normalize uri to include http, etc.
53
+ #
54
+ # class Foo
55
+ # include HTTParty
56
+ # base_uri 'twitter.com'
57
+ # end
58
+ def base_uri(uri=nil)
59
+ return default_options[:base_uri] unless uri
60
+ default_options[:base_uri] = HTTParty.normalize_base_uri(uri)
61
+ end
62
+
63
+ # Allows setting basic authentication username and password.
64
+ #
65
+ # class Foo
66
+ # include HTTParty
67
+ # basic_auth 'username', 'password'
68
+ # end
69
+ def basic_auth(u, p)
70
+ default_options[:basic_auth] = {:username => u, :password => p}
71
+ end
72
+
73
+ # Allows setting default parameters to be appended to each request.
74
+ # Great for api keys and such.
75
+ #
76
+ # class Foo
77
+ # include HTTParty
78
+ # default_params :api_key => 'secret', :another => 'foo'
79
+ # end
80
+ def default_params(h={})
81
+ raise ArgumentError, 'Default params must be a hash' unless h.is_a?(Hash)
82
+ default_options[:default_params] ||= {}
83
+ default_options[:default_params].merge!(h)
84
+ end
85
+
86
+ # Allows setting a base uri to be used for each request.
87
+ #
88
+ # class Foo
89
+ # include HTTParty
90
+ # headers 'Accept' => 'text/html'
91
+ # end
92
+ def headers(h={})
93
+ raise ArgumentError, 'Headers must be a hash' unless h.is_a?(Hash)
94
+ default_options[:headers] ||= {}
95
+ default_options[:headers].merge!(h)
96
+ end
97
+
98
+ def cookies(h={})
99
+ raise ArgumentError, 'Cookies must be a hash' unless h.is_a?(Hash)
100
+ default_cookies.add_cookies(h)
101
+ end
102
+
103
+ # Allows setting the format with which to parse.
104
+ # Must be one of the allowed formats ie: json, xml
105
+ #
106
+ # class Foo
107
+ # include HTTParty
108
+ # format :json
109
+ # end
110
+ def format(f)
111
+ raise UnsupportedFormat, "Must be one of: #{AllowedFormats.values.map { |v| v.to_s }.uniq.sort.join(', ')}" unless AllowedFormats.value?(f)
112
+ default_options[:format] = f
113
+ end
114
+
115
+ # Allows making a get request to a url.
116
+ #
117
+ # class Foo
118
+ # include HTTParty
119
+ # end
120
+ #
121
+ # # Simple get with full url
122
+ # Foo.get('http://foo.com/resource.json')
123
+ #
124
+ # # Simple get with full url and query parameters
125
+ # # ie: http://foo.com/resource.json?limit=10
126
+ # Foo.get('http://foo.com/resource.json', :query => {:limit => 10})
127
+ def get(path, options={})
128
+ perform_request Net::HTTP::Get, path, options
129
+ end
130
+
131
+ # Allows making a post request to a url.
132
+ #
133
+ # class Foo
134
+ # include HTTParty
135
+ # end
136
+ #
137
+ # # Simple post with full url and setting the body
138
+ # Foo.post('http://foo.com/resources', :body => {:bar => 'baz'})
139
+ #
140
+ # # Simple post with full url using :query option,
141
+ # # which gets set as form data on the request.
142
+ # Foo.post('http://foo.com/resources', :query => {:bar => 'baz'})
143
+ #
144
+ # # Posting a few files as multipart:
145
+ # Foo.post('http://foo.com/resources',
146
+ # :multipart => {
147
+ # 'file' => {
148
+ # :path => '/tmp/foo.txt',
149
+ # :type => 'text/plain'
150
+ # },
151
+ # 'file2' => {
152
+ # :path => '/tmp/foo2.txt',
153
+ # :type => 'text/plain'
154
+ # }
155
+ # }
156
+ # )
157
+ def post(path, options={})
158
+ klass = options[:multipart] ? Net::HTTP::Post::Multipart :
159
+ Net::HTTP::Post
160
+ perform_request klass, path, options
161
+ end
162
+
163
+ # Allows making a put request to a url.
164
+ #
165
+ # Posting a few files as multipart:
166
+ # Foo.put('http://foo.com/resources',
167
+ # :multipart => {
168
+ # 'file' => {
169
+ # :path => '/tmp/foo.txt',
170
+ # :type => 'text/plain'
171
+ # },
172
+ # 'file2' => {
173
+ # :path => '/tmp/foo2.txt',
174
+ # :type => 'text/plain'
175
+ # }
176
+ # }
177
+ # )
178
+ def put(path, options={})
179
+ klass = options[:multipart] ? Net::HTTP::Put::Multipart :
180
+ Net::HTTP::Put
181
+ perform_request klass, path, options
182
+ end
183
+
184
+ def delete(path, options={})
185
+ perform_request Net::HTTP::Delete, path, options
186
+ end
187
+
188
+ def default_options #:nodoc:
189
+ @default_options
190
+ end
191
+
192
+ private
193
+ def perform_request(http_method, path, options) #:nodoc:
194
+ process_cookies(options)
195
+ Request.new(http_method, path, default_options.dup.merge(options)).perform
196
+ end
197
+
198
+ def process_cookies(options) #:nodoc:
199
+ return unless options[:cookies] || default_cookies
200
+ options[:headers] ||= {}
201
+ options[:headers]["cookie"] = cookies.merge(options[:cookies] || {}).to_cookie_string
202
+
203
+ options.delete(:cookies)
204
+ end
205
+ end
206
+
207
+ def self.normalize_base_uri(url) #:nodoc:
208
+ normalized_url = url.dup
209
+ use_ssl = (normalized_url =~ /^https/) || normalized_url.include?(':443')
210
+ ends_with_slash = normalized_url =~ /\/$/
211
+
212
+ normalized_url.chop! if ends_with_slash
213
+ normalized_url.gsub!(/^https?:\/\//i, '')
214
+
215
+ "http#{'s' if use_ssl}://#{normalized_url}"
216
+ end
217
+
218
+ class Basement #:nodoc:
219
+ include HTTParty
220
+ end
221
+
222
+ def self.get(*args)
223
+ Basement.get(*args)
224
+ end
225
+
226
+ def self.post(*args)
227
+ Basement.post(*args)
228
+ end
229
+
230
+ def self.put(*args)
231
+ Basement.put(*args)
232
+ end
233
+
234
+ def self.delete(*args)
235
+ Basement.delete(*args)
236
+ end
237
+ end
238
+
239
+ require 'httparty/core_extensions'
240
+ require 'httparty/exceptions'
241
+ require 'httparty/request'
242
+ require 'httparty/response'