httpserious 0.13.5.lstoll1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 John Nunemaker
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# httparty
+
+Makes http fun again!
+
+## Install
+
+```
+gem install httparty
+```
+
+## Requirements
+
+* Ruby 1.9.3 or higher
+* multi_xml
+* You like to party!
+
+## Examples
+
+```ruby
+# Use the class methods to get down to business quickly
+response = HTTParty.get('https://api.stackexchange.com/2.2/questions?site=stackoverflow')
+
+puts response.body, response.code, response.message, response.headers.inspect
+
+# Or wrap things up in your own class
+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)
+puts stack_exchange.questions
+puts stack_exchange.users
+```
+
+See the [examples directory](http://github.com/jnunemaker/httparty/tree/master/examples) for even more goodies.
+
+## Command Line Interface
+
+httparty also includes the executable `httparty` which can be
+used to query web services and examine the resulting output. By default
+it will output the response as a pretty-printed Ruby object (useful for
+grokking the structure of output). This can also be overridden to output
+formatted XML or JSON. Execute `httparty --help` for all the
+options. Below is an example of how easy it is.
+
+```
+httparty "https://api.stackexchange.com/2.2/questions?site=stackoverflow"
+```
+
+## Help and Docs
+
+* https://groups.google.com/forum/#!forum/httparty-gem
+* http://rdoc.info/projects/jnunemaker/httparty
+* http://stackoverflow.com/questions/tagged/httparty
+
+## Contributing
+
+* Fork the project.
+* Run `bundle`
+* Run `bundle exec rake`
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Run `bundle exec rake` (No, REALLY :))
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself in another branch so I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.

data/Rakefile

@@ -0,0 +1,10 @@
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features)
+
+task default: [:spec, :features]

data/bin/httparty

@@ -0,0 +1,116 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "pp"
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "/../lib"))
+require "httparty"
+
+opts = {
+  action: :get,
+  headers: {},
+  verbose: false
+}
+
+OptionParser.new do |o|
+  o.banner = "USAGE: #{$PROGRAM_NAME} [options] [url]"
+
+  o.on("-f",
+       "--format [FORMAT]",
+       "Output format to use instead of pretty-print ruby: " \
+       "plain, csv, json or xml") do |f|
+    opts[:output_format] = f.downcase.to_sym
+  end
+
+  o.on("-a",
+       "--action [ACTION]",
+       "HTTP action: get (default), post, put, delete, head, or options") do |a|
+    opts[:action] = a.downcase.to_sym
+  end
+
+  o.on("-d",
+       "--data [BODY]",
+       "Data to put in request body (prefix with '@' for file)") do |d|
+    if d =~ /^@/
+      opts[:body] = open(d[1..-1]).read
+    else
+      opts[:body] = d
+    end
+  end
+
+  o.on("-H", "--header [NAME:VALUE]", "Additional HTTP headers in NAME:VALUE form") do |h|
+    abort "Invalid header specification, should be Name:Value" unless h =~ /.+:.+/
+    name, value = h.split(':')
+    opts[:headers][name.strip] = value.strip
+  end
+
+  o.on("-v", "--verbose", "If set, print verbose output") do |v|
+    opts[:verbose] = true
+  end
+
+  o.on("-u", "--user [CREDS]", "Use basic authentication. Value should be user:password") do |u|
+    abort "Invalid credentials format. Must be user:password" unless u =~ /.*:.+/
+    user, password = u.split(':')
+    opts[:basic_auth] = { username: user, password: password }
+  end
+
+  o.on("-r", "--response-code", "Command fails if response code >= 400") do
+    opts[:response_code] = true
+  end
+
+  o.on("-h", "--help", "Show help documentation") do |h|
+    puts o
+    exit
+  end
+end.parse!
+
+if ARGV.empty?
+  STDERR.puts "You need to provide a URL"
+  STDERR.puts "USAGE: #{$PROGRAM_NAME} [options] [url]"
+end
+
+def dump_headers(response)
+  resp_type = Net::HTTPResponse::CODE_TO_OBJ[response.code.to_s]
+  puts "#{response.code} #{resp_type.to_s.sub(/^Net::HTTP/, '')}"
+  response.headers.each do |n, v|
+    puts "#{n}: #{v}"
+  end
+  puts
+end
+
+if opts[:verbose]
+  puts "#{opts[:action].to_s.upcase} #{ARGV.first}"
+  opts[:headers].each do |n, v|
+    puts "#{n}: #{v}"
+  end
+  puts
+end
+
+response = HTTParty.send(opts[:action], ARGV.first, opts)
+if opts[:output_format].nil?
+  dump_headers(response) if opts[:verbose]
+  pp response
+else
+  print_format = opts[:output_format]
+  dump_headers(response) if opts[:verbose]
+
+  case opts[:output_format]
+    when :json
+      begin
+        require 'json'
+        puts JSON.pretty_generate(response)
+      rescue LoadError
+        puts YAML.dump(response)
+      end
+    when :xml
+      require 'rexml/document'
+      REXML::Document.new(response.body).write(STDOUT, 2)
+      puts
+    when :csv
+      require 'csv'
+      puts CSV.parse(response.body).map(&:to_s)
+    else
+      puts response
+  end
+end
+exit false if opts[:response_code] && response.code >= 400

data/cucumber.yml

@@ -0,0 +1 @@
+default: features --format progress

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

@@ -0,0 +1,32 @@
+require 'rubygems'
+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')))
+
+module AAWS
+  class Book
+    include HTTParty
+    base_uri 'http://ecs.amazonaws.com'
+    default_params Service: 'AWSECommerceService', Operation: 'ItemSearch', SearchIndex: 'Books'
+
+    def initialize(key)
+      self.class.default_params AWSAccessKeyId: key
+    end
+
+    def search(options = {})
+      raise ArgumentError, 'You must search for something' if options[:query].blank?
+
+      # amazon uses nasty camelized query params
+      options[:query] = options[:query].inject({}) { |h, q| h[q[0].to_s.camelize] = q[1]; h }
+
+      # make a request and return the items (NOTE: this doesn't handle errors at this point)
+      self.class.get('/onca/xml', options)['ItemSearchResponse']['Items']
+    end
+  end
+end
+
+aaws = AAWS::Book.new(config[:access_key])
+pp aaws.search(query: {title: 'Ruby On Rails'})

data/examples/basic.rb

@@ -0,0 +1,28 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+require 'pp'
+
+# You can also use post, put, delete, head, options in the same fashion
+response = HTTParty.get('https://api.stackexchange.com/2.2/questions?site=stackoverflow')
+puts response.body, response.code, response.message, response.headers.inspect
+
+# 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
+
+class Partay
+  include HTTParty
+  base_uri 'http://localhost:3000'
+end
+
+options = {
+  body: {
+    pear: { # your resource
+      foo: '123', # your columns/data
+      bar: 'second',
+      baz: 'last thing'
+    }
+  }
+}
+
+pp Partay.post('/pears.xml', options)

data/examples/crack.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'crack'
+
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+require 'pp'
+
+class Rep
+  include HTTParty
+
+  parser(
+    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})

data/examples/custom_parsers.rb

@@ -0,0 +1,64 @@
+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 do |body, format|
+      case format
+      when :json
+        body.to_json
+      when :xml
+        body.to_xml
+      else
+        body
+      end
+    end
+  )
+end