httsoiree 0.13.1

data/examples/custom_parsers.rb

@@ -0,0 +1,67 @@
+class ParseAtom
+  include HTTParty
+
+  # Support Atom along with the default parsers: xml, json, etc.
+  class Parser::Atom < HTTParty::Parser
+    SupportedFormats.merge!({"application/atom+xml" => :atom})
+
+    protected
+
+    # perform atom parsing on body
+    def atom
+      body.to_atom
+    end
+  end
+
+  parser Parser::Atom
+end
+
+
+class OnlyParseAtom
+  include HTTParty
+
+  # Only support Atom
+  class Parser::OnlyAtom < HTTParty::Parser
+    SupportedFormats = {"application/atom+xml" => :atom}
+
+    protected
+
+    # perform atom parsing on body
+    def atom
+      body.to_atom
+    end
+  end
+
+  parser Parser::OnlyAtom
+end
+
+
+class SkipParsing
+  include HTTParty
+
+  # Parse the response body however you like
+  class Parser::Simple < HTTParty::Parser
+    def parse
+      body
+    end
+  end
+
+  parser Parser::Simple
+end
+
+
+class AdHocParsing
+  include HTTParty
+  parser(
+    Proc.new do |body, format|
+      case format
+      when :json
+        body.to_json
+      when :xml
+        body.to_xml
+      else
+        body
+      end
+    end
+  )
+end

data/examples/delicious.rb

@@ -0,0 +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')))
+
+class Delicious
+  include HTTParty
+  base_uri 'https://api.del.icio.us/v1'
+
+  def initialize(u, 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})
+    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})
+    self.class.get('/posts/recent', options)
+  end
+end
+
+delicious = Delicious.new(config['username'], config['password'])
+pp delicious.posts(query: {tag: 'ruby'})
+pp delicious.recent
+
+delicious.recent['posts']['post'].each { |post| puts post['href'] }

data/examples/google.rb

@@ -0,0 +1,16 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+require 'pp'
+
+class Google
+  include HTTParty
+  format :html
+end
+
+# google.com redirects to www.google.com so this is live test for redirection
+pp Google.get('http://google.com')
+
+puts '', '*'*70, ''
+
+# check that ssl is requesting right
+pp Google.get('https://www.google.com')

data/examples/headers_and_user_agents.rb

@@ -0,0 +1,6 @@
+# To send custom user agents to identify your application to a web service (or mask as a specific browser for testing), send "User-Agent" as a hash to headers as shown below.
+
+require 'httparty'
+
+APPLICATION_NAME = "Httparty"
+response = HTTParty.get('http://example.com', headers: {"User-Agent" => APPLICATION_NAME})

data/examples/logging.rb

@@ -0,0 +1,38 @@
+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

@@ -0,0 +1,22 @@
+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
+end
+
+class Page
+  include HTTParty
+  parser HtmlParserIncluded
+end
+
+pp Page.get('http://www.google.com')

data/examples/rubyurl.rb

@@ -0,0 +1,14 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+require 'pp'
+
+class Rubyurl
+  include HTTParty
+  base_uri 'rubyurl.com'
+
+  def self.shorten( website_url )
+    post( '/api/links.json', query: { link: { website_url: website_url } } )
+  end
+end
+
+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

@@ -0,0 +1,33 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+
+class TripIt
+  include HTTParty
+  base_uri 'http://www.tripit.com'
+  debug_output
+
+  def initialize(email, password)
+    @email = email
+    response = self.class.get('/account/login')
+    response = self.class.post(
+      '/account/login',
+      body: {
+        login_email_address: email,
+        login_password: password
+      },
+      headers: {'Cookie' => response.headers['Set-Cookie']}
+    )
+    @cookie = response.request.options[:headers]['Cookie']
+  end
+
+  def account_settings
+    self.class.get('/account/edit', headers: {'Cookie' => @cookie})
+  end
+
+  def logged_in?
+    account_settings.include? "You're logged in as #{@email}"
+  end
+end
+
+tripit = TripIt.new('email', 'password')
+puts "Logged in: #{tripit.logged_in?}"

data/examples/twitter.rb

@@ -0,0 +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')))
+
+class Twitter
+  include HTTParty
+  base_uri 'twitter.com'
+
+  def initialize(u, 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})
+    self.class.get("/statuses/#{which}_timeline.json", options)
+  end
+
+  def post(text)
+    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.post('this is a test of 0.2.0')

data/examples/whoismyrep.rb

@@ -0,0 +1,10 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+require 'pp'
+
+class Rep
+  include HTTParty
+end
+
+pp Rep.get('http://whoismyrepresentative.com/getall_mems.php?zip=46544')
+pp Rep.get('http://whoismyrepresentative.com/getall_mems.php', query: {zip: 46544})

data/features/basic_authentication.feature

@@ -0,0 +1,20 @@
+Feature:  Basic Authentication
+
+  As a developer
+  I want to be able to use a service that requires Basic Authentication
+  Because that is not an uncommon requirement
+
+  Scenario: Passing no credentials to a page requiring Basic Authentication
+    Given a restricted page at '/basic_auth.html'
+    When I call HTTParty#get with '/basic_auth.html'
+    Then it should return a response with a 401 response code
+
+  Scenario: Passing proper credentials to a page requiring Basic Authentication
+    Given a remote service that returns 'Authenticated Page'
+    And that service is accessed at the path '/basic_auth.html'
+    And that service is protected by Basic Authentication
+    And that service requires the username 'jcash' with the password 'maninblack'
+    When I call HTTParty#get with '/basic_auth.html' and a basic_auth hash:
+       | username | password   |
+       | jcash    | maninblack |
+    Then the return value should match 'Authenticated Page'

data/features/command_line.feature

@@ -0,0 +1,7 @@
+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'!

data/features/deals_with_http_error_codes.feature

@@ -0,0 +1,26 @@
+Feature: Deals with HTTP error codes
+
+  As a developer
+  I want to be informed of non-successful responses
+  Because sometimes thing explode
+  And I should probably know what happened
+
+  Scenario: A response of '404 - Not Found'
+    Given a remote service that returns a 404 status code
+    And that service is accessed at the path '/404_service.html'
+    When I call HTTParty#get with '/404_service.html'
+    Then it should return a response with a 404 response code
+
+  Scenario: A response of '500 - Internal Server Error'
+    Given a remote service that returns a 500 status code
+    And that service is accessed at the path '/500_service.html'
+    When I call HTTParty#get with '/500_service.html'
+    Then it should return a response with a 500 response code
+
+  Scenario: A non-successful response where I need the body
+    Given a remote service that returns a 400 status code
+    And the response from the service has a body of 'Bad response'
+    And that service is accessed at the path '/400_service.html'
+    When I call HTTParty#get with '/400_service.html'
+    Then it should return a response with a 400 response code
+    And the return value should match 'Bad response'

data/features/digest_authentication.feature

@@ -0,0 +1,20 @@
+Feature:  Digest Authentication
+
+  As a developer
+  I want to be able to use a service that requires Digest Authentication
+  Because that is not an uncommon requirement
+
+  Scenario: Passing no credentials to a page requiring Digest Authentication
+    Given a restricted page at '/digest_auth.html'
+    When I call HTTParty#get with '/digest_auth.html'
+    Then it should return a response with a 401 response code
+
+  Scenario: Passing proper credentials to a page requiring Digest Authentication
+    Given a remote service that returns 'Digest Authenticated Page'
+    And that service is accessed at the path '/digest_auth.html'
+    And that service is protected by 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'

data/features/handles_compressed_responses.feature

@@ -0,0 +1,27 @@
+Feature: Handles Compressed Responses
+
+  In order to save bandwidth
+  As a developer
+  I want to uncompress compressed responses
+
+  Scenario: Supports deflate encoding
+    Given a remote deflate service
+    And the response from the service has a body of '<h1>Some HTML</h1>'
+    And that service is accessed at the path '/deflate_service.html'
+    When I call HTTParty#get with '/deflate_service.html'
+    Then the return value should match '<h1>Some HTML</h1>'
+
+  Scenario: Supports gzip encoding
+    Given a remote gzip service
+    And the response from the service has a body of '<h1>Some HTML</h1>'
+    And that service is accessed at the path '/gzip_service.html'
+    When I call HTTParty#get with '/gzip_service.html'
+    Then the return value should match '<h1>Some HTML</h1>'
+
+  Scenario: Supports HEAD request with gzip encoding
+    Given a remote gzip service
+    And that service is accessed at the path '/gzip_head.gz.js'
+    When I call HTTParty#head with '/gzip_head.gz.js'
+    Then it should return a response with a 200 response code
+    Then it should return a response with a gzip content-encoding
+    Then it should return a response with a blank body

data/features/handles_multiple_formats.feature

@@ -0,0 +1,57 @@
+Feature: Handles Multiple Formats
+
+  As a developer
+  I want to be able to consume remote services of many different formats
+  And I want those formats to be automatically detected and handled
+  Because web services take many forms
+  And I don't want to have to do any extra work
+
+  Scenario: An HTML service
+    Given a remote service that returns '<h1>Some HTML</h1>'
+    And that service is accessed at the path '/html_service.html'
+    And the response from the service has a Content-Type of 'text/html'
+    When I call HTTParty#get with '/html_service.html'
+    Then it should return a String
+    And the return value should match '<h1>Some HTML</h1>'
+
+  Scenario: A CSV service
+    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 call HTTParty#get with '/service.csv'
+    Then it should return an Array equaling:
+      | Last Name | Name   |
+      | jennings  | waylon |
+      | cash      | johnny |
+
+  Scenario: A JSON service
+    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 call HTTParty#get with '/service.json'
+    Then it should return a Hash equaling:
+       | key      | value  |
+       | jennings | waylon |
+       | cash     | johnny |
+
+  Scenario: An XML Service
+    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 call HTTParty#get with '/service.xml'
+    Then it should return a Hash equaling:
+       | key    | value           |
+       | singer | waylon jennings |
+
+  Scenario: A Javascript remote file
+    Given a remote service that returns '$(function() { alert("hi"); });'
+    And that service is accessed at the path '/service.js'
+    And the response from the service has a Content-Type of 'application/javascript'
+    When I call HTTParty#get with '/service.js'
+    Then it should return a String
+    And the return value should match '$(function() { alert("hi"); });'

data/features/steps/env.rb

@@ -0,0 +1,22 @@
+require 'mongrel'
+require './lib/httparty'
+require 'spec/expectations'
+
+Before do
+  def new_port
+    server = TCPServer.new('0.0.0.0', nil)
+    port = server.addr[1]
+  ensure
+    server.close
+  end
+
+  port = ENV["HTTPARTY_PORT"] || new_port
+  @host_and_port = "0.0.0.0:#{port}"
+  @server = Mongrel::HttpServer.new("0.0.0.0", port)
+  @server.run
+  @request_options = {}
+end
+
+After do
+  @server.stop
+end

data/features/steps/httparty_response_steps.rb

@@ -0,0 +1,52 @@
+# Not needed anymore in ruby 2.0, but needed to resolve constants
+# in nested namespaces. This is taken from rails :)
+def constantize(camel_cased_word)
+  names = camel_cased_word.split('::')
+  names.shift if names.empty? || names.first.empty?
+
+  constant = Object
+  names.each do |name|
+    constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+  end
+  constant
+end
+
+Then /it should return an? (\w+)$/ do |class_string|
+  @response_from_httparty.should be_an_instance_of(class_string.class)
+end
+
+Then /the return value should match '(.*)'/ do |expected_text|
+  @response_from_httparty.should eql(expected_text)
+end
+
+Then /it should return a Hash equaling:/ do |hash_table|
+  @response_from_httparty.should be_an_instance_of(Hash)
+  @response_from_httparty.keys.length.should eql(hash_table.rows.length)
+  hash_table.hashes.each do |pair|
+    key, value = pair["key"], pair["value"]
+    @response_from_httparty.keys.should include(key)
+    @response_from_httparty[key].should eql(value)
+  end
+end
+
+Then /it should return an Array equaling:/ do |array|
+  @response_from_httparty.should be_an_instance_of(Array)
+  @response_from_httparty.should eql array.raw
+end
+
+Then /it should return a response with a (\d+) response code/ do |code|
+  @response_from_httparty.code.should eql(code.to_i)
+end
+
+Then /it should return a response with a (.*) content\-encoding$/ do |content_type|
+  @response_from_httparty.headers['content-encoding'].should eql('gzip')
+end
+
+Then /it should return a response with a blank body$/ do
+  @response_from_httparty.body.should be(nil)
+end
+
+Then /it should raise (?:an|a) ([\w:]+) exception/ do |exception|
+  @exception_from_httparty.should_not be_nil
+  @exception_from_httparty.should be_a constantize(exception)
+end

data/features/steps/httparty_steps.rb

@@ -0,0 +1,43 @@
+When /^I set my HTTParty timeout option to (\d+)$/ do |timeout|
+  @request_options[:timeout] = timeout.to_i
+end
+
+When /^I set my HTTParty open_timeout option to (\d+)$/ do |timeout|
+  @request_options[:open_timeout] = timeout.to_i
+end
+
+When /^I set my HTTParty read_timeout option to (\d+)$/ do |timeout|
+  @request_options[:read_timeout] = timeout.to_i
+end
+
+When /I call HTTParty#get with '(.*)'$/ do |url|
+  begin
+    @response_from_httparty = HTTParty.get("http://#{@host_and_port}#{url}", @request_options)
+  rescue HTTParty::RedirectionTooDeep, Timeout::Error => e
+    @exception_from_httparty = e
+  end
+end
+
+When /^I call HTTParty#head with '(.*)'$/ do |url|
+  begin
+    @response_from_httparty = HTTParty.head("http://#{@host_and_port}#{url}", @request_options)
+  rescue HTTParty::RedirectionTooDeep, Timeout::Error => e
+    @exception_from_httparty = e
+  end
+end
+
+When /I call HTTParty#get with '(.*)' and a basic_auth hash:/ do |url, auth_table|
+  h = auth_table.hashes.first
+  @response_from_httparty = HTTParty.get(
+    "http://#{@host_and_port}#{url}",
+    basic_auth: { username: h["username"], password: h["password"] }
+  )
+end
+
+When /I call HTTParty#get with '(.*)' and a digest_auth hash:/ do |url, auth_table|
+  h = auth_table.hashes.first
+  @response_from_httparty = HTTParty.get(
+    "http://#{@host_and_port}#{url}",
+    digest_auth: { username: h["username"], password: h["password"] }
+  )
+end