httparty-responsibly 0.17.0.r1

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/body_stream.rb

@@ -0,0 +1,14 @@
+# To upload file to a server use :body_stream
+
+HTTParty.put(
+  'http://localhost:3000/train',
+  body_stream: File.open('sample_configs/config_train_server_md.yml', 'r')
+)
+
+
+# Actually, it works with any IO object
+
+HTTParty.put(
+  'http://localhost:3000/train',
+  body_stream: StringIO.new('foo')
+)

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,68 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+require 'pp'
+
+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

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,10 @@
+# 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.
+
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+require 'pp'
+
+response = HTTParty.get('http://example.com', {
+  headers: {"User-Agent" => "Httparty"},
+  debug_output: STDOUT, # To show that User-Agent is Httparty
+})

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 STDOUT
+
+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 STDOUT
+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 which 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(STDOUT), :debug, :curl
+end
+
+Google.get "http://google.com"

data/examples/microsoft_graph.rb

@@ -0,0 +1,52 @@
+require 'httparty'
+
+class MicrosoftGraph
+  MS_BASE_URL = "https://login.microsoftonline.com".freeze
+  TOKEN_REQUEST_PATH = "oauth2/v2.0/token".freeze
+
+  def initialize(tenant_id)
+    @tenant_id = tenant_id
+  end
+
+  # Make a request to the Microsoft Graph API, for instance https://graph.microsoft.com/v1.0/users
+  def request(url)
+    return false unless (token = bearer_token)
+
+    response = HTTParty.get(
+      url,
+      headers: {
+        Authorization: "Bearer #{token}"
+      }
+    )
+
+    return false unless response.code == 200
+
+    return JSON.parse(response.body)
+  end
+
+  private
+
+  # A post to the Microsoft Graph to get a bearer token for the specified tenant.  In this example
+  # our Rails application has already been given permission to request these tokens by the admin of
+  # the specified tenant_id.
+  #
+  # See here for more information https://developer.microsoft.com/en-us/graph/docs/concepts/auth_v2_service
+  #
+  # This request also makes use of the multipart/form-data post body.
+  def bearer_token
+    response = HTTParty.post(
+      "#{MS_BASE_URL}/#{@tenant_id}/#{TOKEN_REQUEST_PATH}",
+      multipart: true,
+      body: {
+        client_id: Rails.application.credentials[Rails.env.to_sym][:microsoft_client_id],
+        client_secret: Rails.application.credentials[Rails.env.to_sym][:microsoft_client_secret],
+        scope: 'https://graph.microsoft.com/.default',
+        grant_type: 'client_credentials'
+      }
+    )
+
+    return false unless response.code == 200
+
+    JSON.parse(response.body)['access_token']
+  end
+end

data/examples/multipart.rb

@@ -0,0 +1,22 @@
+# If you are uploading file in params, multipart will used as content-type automatically
+
+HTTParty.post(
+  'http://localhost:3000/user',
+  body: {
+    name: 'Foo Bar',
+    email: 'example@email.com',
+    avatar: File.open('/full/path/to/avatar.jpg')
+  }
+)
+
+
+# However, you can force it yourself
+
+HTTParty.post(
+  'http://localhost:3000/user',
+  multipart: true,
+  body: {
+    name: 'Foo Bar',
+    email: 'example@email.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/peer_cert.rb

@@ -0,0 +1,9 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+
+peer_cert = nil
+HTTParty.get("https://www.example.com") do |fragment|
+  peer_cert ||= fragment.connection.peer_cert
+end
+
+puts "The server's certificate expires #{peer_cert.not_after}"

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/stream_download.rb

@@ -0,0 +1,26 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+require 'pp'
+
+# download file linux-4.6.4.tar.xz without using the memory
+response = nil
+filename = "linux-4.6.4.tar.xz"
+url = "https://cdn.kernel.org/pub/linux/kernel/v4.x/#{filename}"
+
+File.open(filename, "w") do |file|
+  response = HTTParty.get(url, stream_body: true) do |fragment|
+    if [301, 302].include?(fragment.code)
+      print "skip writing for redirect"
+    elsif fragment.code == 200
+      print "."
+      file.write(fragment)
+    else
+      raise StandardError, "Non-success status code while streaming #{fragment.code}"
+    end
+  end
+end
+puts
+
+pp "Success: #{response.success?}"
+pp File.stat(filename).inspect
+File.unlink(filename)