httparty 0.13.0 → 0.14.0

data/docs/README.md

@@ -0,0 +1,100 @@
+# httparty
+
+Makes http fun again!
+
+## Table of contents
+- [Working with SSL](#working-with-ssl)
+
+## Working with SSL
+
+You can use this guide to work with SSL certificates.
+
+#### Using `pem` option
+
+```ruby
+# Use this example if you are using a pem file
+
+class Client
+	include HTTParty
+	
+	base_uri "https://example.com"
+	pem File.read("#{File.expand_path('.')}/path/to/certs/cert.pem"), "123456"
+
+end
+```
+
+#### Using `pkcs12` option
+
+```ruby
+# Use this example if you are using a pkcs12 file
+
+class Client
+	include HTTParty
+	
+	base_uri "https://example.com"
+	pkcs12 File.read("#{File.expand_path('.')}/path/to/certs/cert.p12"), "123456"
+
+end
+```
+
+#### Using `ssl_ca_file` option
+
+```ruby
+# Use this example if you are using a pkcs12 file
+
+class Client
+	include HTTParty
+	
+	base_uri "https://example.com"
+	ssl_ca_file "#{File.expand_path('.')}/path/to/certs/cert.pem"
+
+end
+```
+
+#### Using `ssl_ca_path` option
+
+```ruby
+# Use this example if you are using a pkcs12 file
+
+class Client
+	include HTTParty
+	
+	base_uri "https://example.com"
+ 	ssl_ca_path '/path/to/certs'
+end
+```
+
+You can also include this options with the call:
+
+```ruby
+class Client
+	include HTTParty
+	
+	base_uri "https://example.com"
+	
+	def	self.fetch
+		get("/resources", pem: (File.read("#{File.expand_path('.')}/path/to/certs/cert.pem"), "123456")
+	end
+end
+```
+
+### Avoid SSL verification
+
+In some cases you may want to skip SSL verification, because the entity that issue the certificate is not a valid one, but you still want to work with it. You can achieve this through:
+
+```ruby
+#Skips SSL certificate verification
+
+class Client
+	include HTTParty
+
+	base_uri "https://example.com"
+	pem File.read("#{File.expand_path('.')}/path/to/certs/cert.pem"), "123456"
+	
+	def	self.fetch
+		get("/resources", verify: false)
+		# You can also use something like:
+		# get("resources", verify_peer: false)
+	end
+end
+```

data/examples/README.md

@@ -0,0 +1,67 @@
+## Examples
+
+* [Amazon Book Search](aaws.rb)
+    * Httparty included into poro class
+    * Uses `get` requests
+    * Transforms query params to uppercased params
+
+* [Google Search](google.rb)
+  * Httparty included into poro class
+  * Uses `get` requests
+
+* [Crack Custom Parser](crack.rb)
+    * Creates a custom parser for XML using crack gem
+    * Uses `get` request
+
+* [Create HTML Nokogiri parser](nokogiri_html_parser.rb)   
+    * Adds Html as a format
+    * passed the body of request to Nokogiri
+    
+* [More Custom Parsers](custom_parsers.rb)
+  * Create an additional parser for atom or make it the ONLY parser
+  
+* [Basic Auth, Delicious](delicious.rb)
+  * Basic Auth, shows how to merge those into options
+  * Uses `get` requests
+  
+* [Passing Headers, User Agent](headers_and_user_agents.rb)
+  * Use the class method of Httparty
+  * Pass the User-Agent in the headers
+  * Uses `get` requests
+  
+* [Basic Post Request](basic.rb)
+    * Httparty included into poro class
+    * Uses `post` requests
+
+* [Access Rubyurl Shortener](rubyurl.rb)
+  * Httparty included into poro class
+  * Uses `post` requests
+  
+* [Add a custom log file](logging.rb)
+  * create a log file and have httparty log requests
+
+* [Accessing StackExchange](stackexchange.rb)
+  * Httparty included into poro class
+  * Creates methods for different endpoints
+  * Uses `get` requests
+  
+* [Accessing Tripit](tripit_sign_in.rb)
+  * Httparty included into poro class
+  * Example of using `debug_output` to see headers/urls passed
+  * Getting and using Cookies
+  * Uses `get` requests
+  
+* [Accessing Twitter](twitter.rb)
+  * Httparty included into poro class
+  * Basic Auth
+  * Loads settings from a config file 
+  * Uses `get` requests
+  * Uses `post` requests
+  
+* [Accessing WhoIsMyRep](whoismyrep.rb)
+  * Httparty included into poro class
+  * Uses `get` requests     
+  * Two ways to pass params to get, inline on the url or in query hash
+
+* [Rescue Json Error](rescue_json.rb)
+  * Rescue errors due to parsing response

data/examples/aaws.rb

@@ -4,19 +4,19 @@ require 'active_support'
 dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
 require File.join(dir, 'httparty')
 require 'pp'
-config = YAML::load(File.read(File.join(ENV['HOME'], '.aaws')))
+config = YAML.load(File.read(File.join(ENV['HOME'], '.aaws')))
 
 module AAWS
   class Book
     include HTTParty
     base_uri 'http://ecs.amazonaws.com'
-    default_params :Service => 'AWSECommerceService', :Operation => 'ItemSearch', :SearchIndex => 'Books'
+    default_params Service: 'AWSECommerceService', Operation: 'ItemSearch', SearchIndex: 'Books'
 
     def initialize(key)
-      self.class.default_params :AWSAccessKeyId => key
+      self.class.default_params AWSAccessKeyId: key
     end
 
-    def search(options={})
+    def search(options = {})
       raise ArgumentError, 'You must search for something' if options[:query].blank?
 
       # amazon uses nasty camelized query params
@@ -29,4 +29,4 @@ module AAWS
 end
 
 aaws = AAWS::Book.new(config[:access_key])
-pp aaws.search(:query => {:title => 'Ruby On Rails'})
+pp aaws.search(query: {title: 'Ruby On Rails'})

data/examples/basic.rb

@@ -3,13 +3,9 @@ require File.join(dir, 'httparty')
 require 'pp'
 
 # You can also use post, put, delete, head, options in the same fashion
-response = HTTParty.get('http://twitter.com/statuses/public_timeline.json')
+response = HTTParty.get('https://api.stackexchange.com/2.2/questions?site=stackoverflow')
 puts response.body, response.code, response.message, response.headers.inspect
 
-response.each do |item|
-  puts item['user']['screen_name']
-end
-
 # An example post to a minimal rails app in the development environment
 # Note that "skip_before_filter :verify_authenticity_token" must be set in the
 # "pears" controller for this example
@@ -20,11 +16,11 @@ class Partay
 end
 
 options = {
-  :body => {
-    :pear => { # your resource
-      :foo => '123', # your columns/data
-      :bar => 'second',
-      :baz => 'last thing'
+  body: {
+    pear: { # your resource
+      foo: '123', # your columns/data
+      bar: 'second',
+      baz: 'last thing'
     }
   }
 }

data/examples/crack.rb

@@ -9,11 +9,11 @@ class Rep
   include HTTParty
 
   parser(
-    Proc.new do |body, format|
+    proc do |body, format|
       Crack::XML.parse(body)
     end
   )
 end
 
 pp Rep.get('http://whoismyrepresentative.com/getall_mems.php?zip=46544')
-pp Rep.get('http://whoismyrepresentative.com/getall_mems.php', :query => {:zip => 46544})
+pp Rep.get('http://whoismyrepresentative.com/getall_mems.php', query: {zip: 46544})

data/examples/custom_parsers.rb

@@ -16,7 +16,6 @@ class ParseAtom
   parser Parser::Atom
 end
 
-
 class OnlyParseAtom
   include HTTParty
 
@@ -35,7 +34,6 @@ class OnlyParseAtom
   parser Parser::OnlyAtom
 end
 
-
 class SkipParsing
   include HTTParty
 
@@ -49,11 +47,10 @@ class SkipParsing
   parser Parser::Simple
 end
 
-
 class AdHocParsing
   include HTTParty
   parser(
-    Proc.new do |body, format|
+    proc do |body, format|
       case format
       when :json
         body.to_json

data/examples/delicious.rb

@@ -1,37 +1,37 @@
 dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
 require File.join(dir, 'httparty')
 require 'pp'
-config = YAML::load(File.read(File.join(ENV['HOME'], '.delicious')))
+config = YAML.load(File.read(File.join(ENV['HOME'], '.delicious')))
 
 class Delicious
   include HTTParty
   base_uri 'https://api.del.icio.us/v1'
 
   def initialize(u, p)
-    @auth = {:username => u, :password => p}
+    @auth = {username: u, password: p}
   end
 
   # query params that filter the posts are:
   #   tag (optional). Filter by this tag.
   #   dt (optional). Filter by this date (CCYY-MM-DDThh:mm:ssZ).
   #   url (optional). Filter by this url.
-  #   ie: posts(:query => {:tag => 'ruby'})
-  def posts(options={})
-    options.merge!({:basic_auth => @auth})
+  #   ie: posts(query: {tag: 'ruby'})
+  def posts(options = {})
+    options.merge!({basic_auth: @auth})
     self.class.get('/posts/get', options)
   end
 
   # query params that filter the posts are:
   #   tag (optional). Filter by this tag.
   #   count (optional). Number of items to retrieve (Default:15, Maximum:100).
-  def recent(options={})
-    options.merge!({:basic_auth => @auth})
+  def recent(options = {})
+    options.merge!({basic_auth: @auth})
     self.class.get('/posts/recent', options)
   end
 end
 
 delicious = Delicious.new(config['username'], config['password'])
-pp delicious.posts(:query => {:tag => 'ruby'})
+pp delicious.posts(query: {tag: 'ruby'})
 pp delicious.recent
 
 delicious.recent['posts']['post'].each { |post| puts post['href'] }

data/examples/google.rb

@@ -10,7 +10,7 @@ end
 # google.com redirects to www.google.com so this is live test for redirection
 pp Google.get('http://google.com')
 
-puts '', '*'*70, ''
+puts '', '*' * 70, ''
 
 # check that ssl is requesting right
-pp Google.get('https://www.google.com')
+pp Google.get('https://www.google.com')

data/examples/headers_and_user_agents.rb

@@ -3,4 +3,4 @@
 require 'httparty'
 
 APPLICATION_NAME = "Httparty"
-response = HTTParty.get('http://example.com', :headers => {"User-Agent" => APPLICATION_NAME})
+response = HTTParty.get('http://example.com', headers: {"User-Agent" => APPLICATION_NAME})

data/examples/logging.rb

@@ -0,0 +1,36 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+require 'logger'
+require 'pp'
+
+my_logger = Logger.new "httparty.log"
+
+my_logger.info "Logging can be used on the main HTTParty class. It logs redirects too."
+HTTParty.get "http://google.com", logger: my_logger
+
+my_logger.info '*' * 70
+
+my_logger.info "It can be used also on a custom class."
+
+class Google
+  include HTTParty
+  logger ::Logger.new "httparty.log"
+end
+
+Google.get "http://google.com"
+
+my_logger.info '*' * 70
+
+my_logger.info "The default formatter is :apache. The :curl formatter can also be used."
+my_logger.info "You can tell wich method to call on the logger too. It is info by default."
+HTTParty.get "http://google.com", logger: my_logger, log_level: :debug, log_format: :curl
+
+my_logger.info '*' * 70
+
+my_logger.info "These configs are also available on custom classes."
+class Google
+  include HTTParty
+  logger ::Logger.new("httparty.log"), :debug, :curl
+end
+
+Google.get "http://google.com"

data/examples/nokogiri_html_parser.rb

@@ -1,14 +1,11 @@
 require 'rubygems'
 require 'nokogiri'
 
-
 dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
 require File.join(dir, 'httparty')
 require 'pp'
 
 class HtmlParserIncluded < HTTParty::Parser
-  SupportedFormats.merge!('text/html' => :html)
-
   def html
     Nokogiri::HTML(body)
   end

data/examples/rescue_json.rb

@@ -0,0 +1,17 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+
+# Take note of the "; 1" at the end of the following line. It's required only if
+# running this in IRB, because IRB will try to inspect the variable named
+# "request", triggering the exception.
+request = HTTParty.get 'https://rubygems.org/api/v1/versions/doesnotexist.json' ; 1
+
+# Check an exception due to parsing the response
+# because HTTParty evaluate the response lazily
+begin
+  request.inspect
+  # This would also suffice by forcing the request to be parsed:
+  # request.parsed_response
+rescue => e
+  puts "Rescued #{e.inspect}"
+end

data/examples/rubyurl.rb

@@ -6,9 +6,9 @@ class Rubyurl
   include HTTParty
   base_uri 'rubyurl.com'
 
-  def self.shorten( website_url )
-    post( '/api/links.json', :query => { :link => { :website_url => website_url } } )
+  def self.shorten(website_url)
+    post('/api/links.json', query: { link: { website_url: website_url } })
   end
 end
 
-pp Rubyurl.shorten( 'http://istwitterdown.com/')
+pp Rubyurl.shorten('http://istwitterdown.com/')

data/examples/stackexchange.rb

@@ -0,0 +1,24 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+require 'pp'
+
+class StackExchange
+  include HTTParty
+  base_uri 'api.stackexchange.com'
+
+  def initialize(service, page)
+    @options = { query: {site: service, page: page} }
+  end
+
+  def questions
+    self.class.get("/2.2/questions", @options)
+  end
+
+  def users
+    self.class.get("/2.2/users", @options)
+  end
+end
+
+stack_exchange = StackExchange.new("stackoverflow", 1)
+pp stack_exchange.questions
+pp stack_exchange.users

data/examples/tripit_sign_in.rb

@@ -3,30 +3,41 @@ require File.join(dir, 'httparty')
 
 class TripIt
   include HTTParty
-  base_uri 'http://www.tripit.com'
+  base_uri 'https://www.tripit.com'
   debug_output
 
   def initialize(email, password)
     @email = email
-    response = self.class.get('/account/login')
-    response = self.class.post(
+    get_response = self.class.get('/account/login')
+    get_response_cookie = parse_cookie(get_response.headers['Set-Cookie'])
+
+    post_response = self.class.post(
       '/account/login',
-      :body => {
-        :login_email_address => email,
-        :login_password => password
+      body: {
+        login_email_address: email,
+        login_password: password
       },
-      :headers => {'Cookie' => response.headers['Set-Cookie']}
+      headers: {'Cookie' => get_response_cookie.to_cookie_string }
     )
-    @cookie = response.request.options[:headers]['Cookie']
+
+    @cookie = parse_cookie(post_response.headers['Set-Cookie'])
   end
 
   def account_settings
-    self.class.get('/account/edit', :headers => {'Cookie' => @cookie})
+    self.class.get('/account/edit', headers: {'Cookie' => @cookie.to_cookie_string})
   end
 
   def logged_in?
     account_settings.include? "You're logged in as #{@email}"
   end
+
+  private
+
+  def parse_cookie(resp)
+    cookie_hash = CookieHash.new
+    resp.get_fields('Set-Cookie').each { |c| cookie_hash.add_cookies(c) }
+    cookie_hash
+  end
 end
 
 tripit = TripIt.new('email', 'password')

data/examples/twitter.rb

@@ -1,31 +1,31 @@
 dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
 require File.join(dir, 'httparty')
 require 'pp'
-config = YAML::load(File.read(File.join(ENV['HOME'], '.twitter')))
+config = YAML.load(File.read(File.join(ENV['HOME'], '.twitter')))
 
 class Twitter
   include HTTParty
   base_uri 'twitter.com'
 
   def initialize(u, p)
-    @auth = {:username => u, :password => p}
+    @auth = {username: u, password: p}
   end
 
   # which can be :friends, :user or :public
   # options[:query] can be things like since, since_id, count, etc.
-  def timeline(which=:friends, options={})
-    options.merge!({:basic_auth => @auth})
+  def timeline(which = :friends, options = {})
+    options.merge!({basic_auth: @auth})
     self.class.get("/statuses/#{which}_timeline.json", options)
   end
 
   def post(text)
-    options = { :query => {:status => text}, :basic_auth => @auth }
+    options = { query: {status: text}, basic_auth: @auth }
     self.class.post('/statuses/update.json', options)
   end
 end
 
 twitter = Twitter.new(config['email'], config['password'])
 pp twitter.timeline
-# pp twitter.timeline(:friends, :query => {:since_id => 868482746})
-# pp twitter.timeline(:friends, :query => 'since_id=868482746')
+# pp twitter.timeline(:friends, query: {since_id: 868482746})
+# pp twitter.timeline(:friends, query: 'since_id=868482746')
 # pp twitter.post('this is a test of 0.2.0')

data/examples/whoismyrep.rb

@@ -7,4 +7,4 @@ class Rep
 end
 
 pp Rep.get('http://whoismyrepresentative.com/getall_mems.php?zip=46544')
-pp Rep.get('http://whoismyrepresentative.com/getall_mems.php', :query => {:zip => 46544})
+pp Rep.get('http://whoismyrepresentative.com/getall_mems.php', query: {zip: 46544})

data/features/command_line.feature

@@ -1,7 +1,95 @@
+@command_line
 Feature: Command Line
 
   As a developer
   I want to be able to harness the power of HTTParty from the command line
   Because that would make quick testing and debugging easy
-  And 'easy' is my middle name
-  And I'm kidding it's actually 'Danger'!
+
+  Scenario: Show help information
+    When I run `httparty --help`
+    Then the output should contain "-f, --format [FORMAT]"
+
+  Scenario: Show current version
+    When I run `httparty --version`
+    Then the output should contain "Version:"
+    And the output should not contain "You need to provide a URL"
+
+  Scenario: Make a get request
+    Given a remote deflate service on port '4001'
+    And the response from the service has a body of 'GET request'
+    And that service is accessed at the path '/fun'
+    When I run `httparty http://0.0.0.0:4001/fun`
+    Then the output should contain "GET request"
+
+  Scenario: Make a post request
+    Given a remote deflate service on port '4002'
+    And the response from the service has a body of 'POST request'
+    And that service is accessed at the path '/fun'
+    When I run `httparty http://0.0.0.0:4002/fun --action post --data "a=1&b=2"`
+    Then the output should contain "POST request"
+
+  Scenario: Make a put request
+    Given a remote deflate service on port '4003'
+    And the response from the service has a body of 'PUT request'
+    And that service is accessed at the path '/fun'
+    When I run `httparty http://0.0.0.0:4003/fun --action put --data "a=1&b=2"`
+    Then the output should contain "PUT request"
+
+  Scenario: Make a delete request
+    Given a remote deflate service on port '4004'
+    And the response from the service has a body of 'DELETE request'
+    And that service is accessed at the path '/fun'
+    When I run `httparty http://0.0.0.0:4004/fun --action delete`
+    Then the output should contain "DELETE request"
+
+  Scenario: Set a verbose mode
+    Given a remote deflate service on port '4005'
+    And the response from the service has a body of 'Some request'
+    And that service is accessed at the path '/fun'
+    When I run `httparty http://0.0.0.0:4005/fun --verbose`
+    Then the output should contain "content-length"
+
+  Scenario: Use service with basic authentication
+    Given a remote deflate service on port '4006'
+    And the response from the service has a body of 'Successfull authentication'
+    And that service is accessed at the path '/fun'
+    And that service is protected by Basic Authentication
+    And that service requires the username 'user' with the password 'pass'
+    When I run `httparty http://0.0.0.0:4006/fun --user 'user:pass'`
+    Then the output should contain "Successfull authentication"
+
+  Scenario: Get response in plain format
+    Given a remote deflate service on port '4007'
+    And the response from the service has a body of 'Some request'
+    And that service is accessed at the path '/fun'
+    When I run `httparty http://0.0.0.0:4007/fun --format plain`
+    Then the output should contain "Some request"
+
+  Scenario: Get response in json format
+    Given a remote deflate service on port '4008'
+    Given a remote service that returns '{ "jennings": "waylon", "cash": "johnny" }'
+    And that service is accessed at the path '/service.json'
+    And the response from the service has a Content-Type of 'application/json'
+    When I run `httparty http://0.0.0.0:4008/service.json --format json`
+    Then the output should contain '"jennings": "waylon"'
+
+  Scenario: Get response in xml format
+    Given a remote deflate service on port '4009'
+    Given a remote service that returns '<singer>waylon jennings</singer>'
+    And that service is accessed at the path '/service.xml'
+    And the response from the service has a Content-Type of 'text/xml'
+    When I run `httparty http://0.0.0.0:4009/service.xml --format xml`
+    Then the output should contain "<singer>"
+
+  Scenario: Get response in csv format
+    Given a remote deflate service on port '4010'
+    Given a remote service that returns:
+      """
+      "Last Name","Name"
+      "jennings","waylon"
+      "cash","johnny"
+      """
+    And that service is accessed at the path '/service.csv'
+    And the response from the service has a Content-Type of 'application/csv'
+    When I run `httparty http://0.0.0.0:4010/service.csv --format csv`
+    Then the output should contain '["Last Name", "Name"]'

data/features/digest_authentication.feature

@@ -18,3 +18,13 @@ Feature:  Digest Authentication
        | username | password   |
        | jcash    | maninblack |
     Then the return value should match 'Digest Authenticated Page'
+
+  Scenario: Passing proper credentials to a page requiring Digest Authentication using md5-sess algorithm
+    Given a remote service that returns 'Digest Authenticated Page Using MD5-sess'
+    And that service is accessed at the path '/digest_auth.html'
+    And that service is protected by MD5-sess Digest Authentication
+    And that service requires the username 'jcash' with the password 'maninblack'
+    When I call HTTParty#get with '/digest_auth.html' and a digest_auth hash:
+       | username | password   |
+       | jcash    | maninblack |
+    Then the return value should match 'Digest Authenticated Page Using MD5-sess'