httpserious 0.13.5.lstoll1

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,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

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

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

@@ -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,90 @@
+@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
+
+  Scenario: Show help information
+    When I run `httparty --help`
+    Then the output should contain "-f, --format [FORMAT]"
+
+  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/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