aitch 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23b168b3e1919c4678e936b498d68f03d76d633e
-  data.tar.gz: a389c8c536ca656791eb7eae62f2f74b15a62983
+  metadata.gz: daca7104634e48ff40f0d33174c701884d0cbab4
+  data.tar.gz: 7d96817bec549c8764561efc84553859b6b6e29b
 SHA512:
-  metadata.gz: 355b7f2f6bb8cabf5defde1bfe2bf8dbeb0ca7d545d3f70c6e92ccfa1b08193d295bb859774306e76641a9b6f2854b08b75bd483f78453f1bd6eefb9748b3b65
-  data.tar.gz: d3dfa452ba5bb4c8483315372b966d45765e7d480f7a52cced117c58e131c15fa4f8a6c9e133f56090b2fbfcc48f8b62cf93e61fee890b1a3a2498c1998d0b17
+  metadata.gz: a2c8b42241ec8b9af83c2452c0b2f7fe5c92be1254d91b1324afa39eb7643283ecb3c0f8125834baedbf13e04ad4ffd8a4adadccd235a59318a35c273ee511d0
+  data.tar.gz: 7e7d759d48479efe4fb335a8a7ff1fd05434b34cb247f3b725bd6067391d8f05969fc8efd1b2fad976f1f1aeb385a74b37c943f4af167f3fa0987b76624d92ad

data/.travis.yml

@@ -1,23 +1,21 @@
 language: ruby
-script: "bundle exec rspec"
+script: "bundle exec rake"
 before_install: gem install bundler
 cache: bundler
 sudo: false
 
 rvm:
+  - "2.3.0"
   - "2.2"
   - "2.1"
   - "2.0"
-  - "1.9"
-  - jruby-19mode
   - jruby-head
 
 gemfile:
   - Gemfile
 
 notifications:
-  email:
-    - fnando.vieira@gmail.com
+  email: false
 
 addons:
   code_climate:

data/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+* **1.0.0**
+    * Use frozen string magic comments
+    * 307 redirections will honor the HTTP request method
+    * Fix issue with redirection; it was including the target url for one level redirection.
+    * Methods `Aitch::Response#html`, `Aitch::Response#json`, `Aitch::Response#xml` were removed; use `Aitch::Response#data` instead.
+    * Add support to response parsers
+* **0.5.0** - May 24, 2015
+    * Remove hard dependency on ActiveSupport
+    * Add response validation
+* **0.4.1** - December 20, 2014
+    * Consider default headers when returning content type (fixes issue with body's JSON encoding)
+* **0.4.0** - December 18, 2014
+    * Add accessor method for setting request's content type
+    * Automatically encodes body as JSON when content type matches `json`
+    * JSON encoding now uses a parser
+* **0.3.0** - April 28, 2014
+    * Make list of redirections available
+    * Make the request URL available on responses
+* **0.2.1** - July 30, 2013
+    * Add alias for `response.success?` (`response.ok?`)
+* **0.2.0** - July 28, 2013
+    * Add DSL support
+    * Create aliases for `response.data` (`response.xml` and `response.json`)
+* **0.1.5** - June 26, 2013
+    * Fix issue with jRuby and `to_h` protocol
+* **0.1.4** - June 13, 2013
+    * Accept headers as callable objects
+    * Fix XML encoding, always converting values to UTF-8
+* **0.1.3** - May 12, 2013
+    * Add response HTML parsing into Nokogiri object
+* **0.1.2** - May 10, 2013
+    * Add response error code helpers, like `response.bad_request?` and `response.not_found?`
+* **0.1.1** - April 30, 2013
+    * Add support for namespaces
+* **0.1.0** - April 29, 2013
+    * Initial release

data/README.md

@@ -54,15 +54,6 @@ Aitch.configure do |config|
 
   # Set the logger.
   config.logger = nil
-
-  # Set the JSON parser.
-  config.json_parser = JSON
-
-  # Set the XML parser.
-  config.xml_parser = Aitch::XMLParser
-
-  # Set the HTML parser.
-  config.html_parser = Aitch::HTMLParser
 end
 ```
 
@@ -108,10 +99,7 @@ response.redirect?        # status 3xx
 response.error?           # status 4xx or 5xx
 response.error            # response error
 response.body             # returned body
-response.data             # HTML, JSON or XML payload
-response.xml              # An alias to the Aitch::Response#data method
-response.html             # An alias to the Aitch::Response#data method
-response.json             # An alias to the Aitch::Response#data method
+response.data             # Parsed response body
 ```
 
 #### Parsing JSON, XML and HTML with Nokogiri
@@ -208,7 +196,7 @@ Request.get("http://example.org")
 
 ### Validating responses
 
-When you know of kind of response you're expecting, you can validate the response with a list of accepted response statuses.
+When you know the kind of response you're expecting, you can validate it by specifying the `expect` option.
 
 ```ruby
 Aitch.get do
@@ -225,6 +213,54 @@ Expect(200 OK) <=> Actual(404 Not Found)
 
 You can also provide a list of accepted statuses, like `expect: [200, 201]`.
 
+### Response Parsers
+
+You can register new response parsers by using `Aitch::ResponseParser.register(name, parser)`, where parser must implement the methods `match?(content_type)` and `load(response_body)`. This is how you could load CSV values.
+
+```ruby
+require "csv"
+
+module CSVParser
+  def self.type
+    :csv
+  end
+
+  def self.match?(content_type)
+    content_type.to_s =~ /csv/
+  end
+
+  def self.load(source)
+    CSV.parse(source.to_s)
+  end
+end
+
+Aitch::ResponseParser.prepend(:csv, CSVParser)
+```
+
+The default behavior is returning the response body. You can replace it as the following:
+
+```ruby
+module DefaultParser
+  def self.type
+    :default
+  end
+
+  def self.match?(content_type)
+    true
+  end
+
+  def self.load(source)
+    source.to_s
+  end
+end
+
+# You should use append here, to ensure
+# that is that last parser on the list.
+Aitch::ResponseParser.append(:default, DefaultParser)
+```
+
+Aitch comes with response parsers for HTML, XML and JSON.
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1 +1,11 @@
+# frozen_string_literal: true
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = false
+end
+
+task default: :test

data/aitch.gemspec

@@ -15,12 +15,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.0"
+
   spec.add_dependency "nokogiri", ">= 1.6.0"
 
   spec.add_development_dependency "codeclimate-test-reporter"
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "test_notifier"
+  spec.add_development_dependency "minitest-utils"
+  spec.add_development_dependency "mocha"
   spec.add_development_dependency "webmock"
 end

data/lib/aitch.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "net/https"
 require "forwardable"
 require "json"
@@ -24,8 +25,11 @@ require "aitch/response/errors"
 require "aitch/response"
 require "aitch/response/body"
 require "aitch/response/description"
-require "aitch/xml_parser"
-require "aitch/html_parser"
+require "aitch/response_parser/default_parser"
+require "aitch/response_parser/html_parser"
+require "aitch/response_parser/json_parser"
+require "aitch/response_parser/xml_parser"
+require "aitch/response_parser"
 require "aitch/version"
 
 module Aitch
@@ -47,6 +51,7 @@ module Aitch
   end
 
   private
+
   def self.namespace
     @namespace ||= Namespace.new
   end

data/lib/aitch/configuration.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Aitch
   class Configuration
     # Set proxy.
@@ -21,24 +22,12 @@ module Aitch
     # Set the logger.
     attr_accessor :logger
 
-    # Set the JSON parser.
-    attr_accessor :json_parser
-
-    # Set the XML parser.
-    attr_accessor :xml_parser
-
-    # Set the HTML parser.
-    attr_accessor :html_parser
-
     def initialize
       @timeout = 10
       @redirect_limit = 5
       @follow_redirect = true
       @user_agent = "Aitch/#{Aitch::VERSION} (http://rubygems.org/gems/aitch)"
       @default_headers = {}
-      @json_parser = JSON
-      @xml_parser = XMLParser
-      @html_parser = HTMLParser
     end
 
     def to_h

data/lib/aitch/dsl.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Aitch
   class DSL
     %w[url options headers data].each do |name|

data/lib/aitch/errors.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Aitch
   InvalidURIError        = Class.new(StandardError)
   InvalidHTTPMethodError = Class.new(StandardError)

data/lib/aitch/ext/to_query.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "cgi"
 
 class Object

data/lib/aitch/location.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Aitch
   class Location
     attr_reader :redirect_stack, :current_url
@@ -11,10 +12,10 @@ module Aitch
       return current_url unless current_url.match(%r[\A/])
 
       uri = find_uri_with_host
-      url = "#{uri.scheme}://#{uri.hostname}"
+      url = ["#{uri.scheme}://#{uri.hostname}"]
       url << ":#{uri.port}" unless [80, 443].include?(uri.port)
       url << current_url
-      url
+      url.join
     end
 
     def find_uri_with_host

data/lib/aitch/namespace.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Aitch
   class Namespace
     def configure(&block)

data/lib/aitch/redirect.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
 module Aitch
   class Redirect
+    attr_reader :tries
+
     def initialize(options)
       @tries = 1
       @options = options
-      @max_tries = @options[:redirect_limit]
     end
 
     def followed!
@@ -11,7 +13,11 @@ module Aitch
     end
 
     def follow?(response)
-      enabled? && response.redirect? && @tries < @max_tries
+      enabled? && response.redirect? && tries < max_tries
+    end
+
+    def max_tries
+      @options[:redirect_limit]
     end
 
     def enabled?

data/lib/aitch/request.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Aitch
   class Request
     attr_accessor :request_method
@@ -5,10 +6,14 @@ module Aitch
     attr_accessor :data
     attr_accessor :headers
     attr_accessor :options
+    attr_accessor :redirects
 
     def initialize(options)
-      self.headers ||= {}
-      self.options ||= {}
+      self.headers = {}
+      self.options = {}
+      self.redirects = []
+
+      @_original_options = options.dup.freeze
 
       options.each do |name, value|
         public_send("#{name}=", value)
@@ -26,11 +31,11 @@ module Aitch
     end
 
     def content_type=(content_type)
-      headers['Content-Type'] = content_type
+      headers["Content-Type"] = content_type
     end
 
     def content_type
-      headers['Content-Type'] || options.fetch(:default_headers, {})['Content-Type']
+      headers["Content-Type"] || options.fetch(:default_headers, {})["Content-Type"]
     end
 
     def request
@@ -114,14 +119,22 @@ module Aitch
       defined?(Net::ReadTimeout) ? Net::ReadTimeout : Timeout::Error
     end
 
-    def follow_redirect(response)
+    def follow_redirect(response, redirected_from = [])
+      return response unless response.redirect?
+
       redirect = Redirect.new(options)
+      redirected_from = [url]
 
       while redirect.follow?(response)
-        redirected_from ||= [url]
-        redirected_from << Location.new(redirected_from, response.location).location
+        location = Location.new(redirected_from, response.location).location
         redirect.followed!
-        response = Aitch.get(redirected_from.last)
+        follow_request_method = response.code == 307 ? request_method : :get
+        follow_request_options = @_original_options.merge(
+          request_method: follow_request_method,
+          url: location
+        )
+        response = self.class.new(follow_request_options).perform
+        redirected_from += response.redirected_from
       end
 
       raise TooManyRedirectsError if redirect.enabled? && response.redirect?
@@ -138,7 +151,7 @@ module Aitch
 
       descriptions = expected
                       .map {|code| Response.description_for_code(code) }
-                      .join(', ')
+                      .join(", ")
 
       raise StatusCodeError,
         "Expected(#{descriptions}) <=> Actual(#{response.description})"

data/lib/aitch/response.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Aitch
   class Response
     extend Forwardable
@@ -6,12 +7,13 @@ module Aitch
     attr_accessor :redirected_from, :url
 
     def self.description_for_code(code)
-      [code, DESCRIPTION[code]].compact.join(' ')
+      [code, DESCRIPTION[code]].compact.join(" ")
     end
 
     def initialize(options, http_response)
       @options = options
       @http_response = http_response
+      @redirected_from = options.fetch(:redirected_from, [])
     end
 
     ERRORS.each do |status_code, exception|
@@ -60,19 +62,8 @@ module Aitch
     end
 
     def data
-      if json?
-        @options[:json_parser].load(body)
-      elsif xml?
-        @options[:xml_parser].load(body)
-      elsif html?
-        @options[:html_parser].load(body)
-      else
-        body
-      end
+      Aitch::ResponseParser.find(content_type).load(body)
     end
-    alias_method :xml, :data
-    alias_method :html, :data
-    alias_method :json, :data
 
     def headers
       @headers ||= {}.tap do |headers|

data/lib/aitch/response/body.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Aitch
   class Response
     class Body

data/lib/aitch/response/description.rb

@@ -1,61 +1,62 @@
+# frozen_string_literal: true
 module Aitch
   class Response
     DESCRIPTION = {
-      100 => 'Continue',
-      101 => 'Switch Protocol',
+      100 => "Continue",
+      101 => "Switch Protocol",
 
-      200 => 'OK',
-      201 => 'Created',
-      202 => 'Accepted',
-      203 => 'Non Authoritative Information',
-      204 => 'No Content',
-      205 => 'Reset Content',
-      206 => 'Partial Content',
-      207 => 'Multi Status',
-      226 => 'IM Used',
+      200 => "OK",
+      201 => "Created",
+      202 => "Accepted",
+      203 => "Non Authoritative Information",
+      204 => "No Content",
+      205 => "Reset Content",
+      206 => "Partial Content",
+      207 => "Multi Status",
+      226 => "IM Used",
 
-      300 => 'Multiple Choices',
-      301 => 'Moved Permanently',
-      302 => 'Found',
-      303 => 'See Other',
-      304 => 'Not Modified',
-      305 => 'Use Proxy',
-      307 => 'Temporary Redirect',
+      300 => "Multiple Choices",
+      301 => "Moved Permanently",
+      302 => "Found",
+      303 => "See Other",
+      304 => "Not Modified",
+      305 => "Use Proxy",
+      307 => "Temporary Redirect",
 
-      400 => 'Bad Request',
-      401 => 'Unauthorized',
-      402 => 'Payment Required',
-      403 => 'Forbidden',
-      404 => 'Not Found',
-      405 => 'Method Not Allowed',
-      406 => 'Not Acceptable',
-      407 => 'Proxy Authentication Required',
-      408 => 'Request Time Out',
-      409 => 'Conflict',
-      410 => 'Gone',
-      411 => 'Length Required',
-      412 => 'Precondition Failed',
-      413 => 'Request Entity Too Large',
-      414 => 'Request URIToo Long',
-      415 => 'Unsupported Media Type',
-      416 => 'Requested Range Not Satisfiable',
-      417 => 'Expectation Failed',
-      422 => 'Unprocessable Entity',
-      423 => 'Locked',
-      424 => 'Failed Dependency',
-      426 => 'Upgrade Required',
-      428 => 'Precondition Required',
-      429 => 'Too Many Requests',
-      431 => 'Request Header Fields Too Large',
+      400 => "Bad Request",
+      401 => "Unauthorized",
+      402 => "Payment Required",
+      403 => "Forbidden",
+      404 => "Not Found",
+      405 => "Method Not Allowed",
+      406 => "Not Acceptable",
+      407 => "Proxy Authentication Required",
+      408 => "Request Time Out",
+      409 => "Conflict",
+      410 => "Gone",
+      411 => "Length Required",
+      412 => "Precondition Failed",
+      413 => "Request Entity Too Large",
+      414 => "Request URIToo Long",
+      415 => "Unsupported Media Type",
+      416 => "Requested Range Not Satisfiable",
+      417 => "Expectation Failed",
+      422 => "Unprocessable Entity",
+      423 => "Locked",
+      424 => "Failed Dependency",
+      426 => "Upgrade Required",
+      428 => "Precondition Required",
+      429 => "Too Many Requests",
+      431 => "Request Header Fields Too Large",
 
-      500 => 'Internal Server Error',
-      501 => 'Not Implemented',
-      502 => 'Bad Gateway',
-      503 => 'Service Unavailable',
-      504 => 'Gateway Time Out',
-      505 => 'Version Not Supported',
-      507 => 'Insufficient Storage',
-      511 => 'Network Authentication Required',
+      500 => "Internal Server Error",
+      501 => "Not Implemented",
+      502 => "Bad Gateway",
+      503 => "Service Unavailable",
+      504 => "Gateway Time Out",
+      505 => "Version Not Supported",
+      507 => "Insufficient Storage",
+      511 => "Network Authentication Required",
     }
   end
 end