http_wrapper 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2fa8e4065e61bf929e24793f65c42273fa98884
-  data.tar.gz: 4e0efea520c0a5cca574430e3d8cef060004cd60
+  metadata.gz: fa85c2016386aa01baeab80596dc32c5fe9a8487
+  data.tar.gz: fd6379cb93042cc78a5cfc4efbea1042a7377fbe
 SHA512:
-  metadata.gz: 380fa0e02f48cb4affca5d9c74fe54352965bbd6b4630909f509ffddced19f49af661595fce73aa6387e811989ea769d0f93a5ceb31855a60600b0f15b4b7180
-  data.tar.gz: 833ada0ed80bd08c7d6313f6e2c07bdc4c9cdb3ee976aac359d8f44420756cbdb45bb2216e09ce8e128351fbbf687ddd625d29315f759fb561803253b3933f27
+  metadata.gz: 8209c18ab5f5934bfe4eb8792346d9407706345e0a091a23cedc90dde41e4ef761f3c5f59d41168e5e4470d4fbc224d305ddcf4d09e9583f7dea74044088138c
+  data.tar.gz: b4dd32e4c65b49634447e29773332ea37628099e247cf2cb454d3059c7c1ea207be6f449baded1681b8fb678437a5363daf0817a3f2ef4a69f1296a24a5c7c90

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## v2.1.1
+
+* code refactoring
+* fixed `post_and_get_cookie` method (warning: HTTPResponse#response is obsolete)
+* `UnknownParameterError` renamed to `UnknownKeyError`
+* removed options and parameters validation code duplication
+
 ## v2.1.0
 
 * added ability to perform custom `Net::HTTP` requests

data/README.md

@@ -3,10 +3,10 @@
 Simple wrapper around standard Net::HTTP library
 
 [![Gem Version](https://badge.fury.io/rb/http_wrapper.png)](http://badge.fury.io/rb/http_wrapper)
-[![Build Status](https://travis-ci.org/Svyatov/http_wrapper.png)](https://travis-ci.org/Svyatov/http_wrapper)
-[![Dependency Status](https://gemnasium.com/Svyatov/http_wrapper.png)](https://gemnasium.com/Svyatov/http_wrapper)
-[![Code Climate](https://codeclimate.com/github/Svyatov/http_wrapper.png)](https://codeclimate.com/github/Svyatov/http_wrapper)
-[![Coverage Status](https://coveralls.io/repos/Svyatov/http_wrapper/badge.png)](https://coveralls.io/r/Svyatov/http_wrapper)
+[![Build Status](https://travis-ci.org/svyatov/http_wrapper.png)](https://travis-ci.org/svyatov/http_wrapper)
+[![Dependency Status](https://gemnasium.com/svyatov/http_wrapper.png)](https://gemnasium.com/svyatov/http_wrapper)
+[![Code Climate](https://codeclimate.com/github/svyatov/http_wrapper.png)](https://codeclimate.com/github/svyatov/http_wrapper)
+[![Coverage Status](https://coveralls.io/repos/svyatov/http_wrapper/badge.png)](https://coveralls.io/r/svyatov/http_wrapper)
 
 ---
 
@@ -15,7 +15,7 @@ Simple wrapper around standard Net::HTTP library
 Add this line to your Gemfile:
 
 ```ruby
-gem 'http_wrapper', '~> 2.1.0'
+gem 'http_wrapper', '~> 2.1.1'
 ```
 
 And then execute:
@@ -312,7 +312,7 @@ http.execute request, uri
 ```
 
 Don't worry if you mistype root parameters key. `http_wrapper` checks root parameters keys and instantiation options keys.
-If any unknown options or parameters found, it raises the `UnknownParameterError` exception.
+If any unknown options or parameters found, it raises the `UnknownKeyError` exception.
 
 ## Contributing
 

data/lib/http_wrapper/constants.rb

@@ -1,9 +1,9 @@
 class HTTPWrapper
   module HEADER
-    CONTENT_TYPE = 'Content-Type'.freeze
-    USER_AGENT   = 'User-Agent'.freeze
-    COOKIE       = 'Cookie'.freeze
-    AJAX         = 'X-Requested-With'.freeze
+    CONTENT_TYPE = 'content-type'.freeze
+    USER_AGENT   = 'user-agent'.freeze
+    COOKIE       = 'cookie'.freeze
+    AJAX         = 'x-requested-with'.freeze
   end
 
   module CONTENT_TYPE

data/lib/http_wrapper/errors.rb

@@ -1,5 +1,5 @@
 class HTTPWrapper
   HTTPWrapperError      = Class.new StandardError
   TooManyRedirectsError = Class.new HTTPWrapperError
-  UnknownParameterError = Class.new HTTPWrapperError
+  UnknownKeyError       = Class.new HTTPWrapperError
 end

data/lib/http_wrapper/http_wrapper.rb

@@ -6,7 +6,7 @@ class HTTPWrapper
   attr_accessor :timeout, :verify_cert, :logger, :max_redirects, :user_agent
 
   def initialize(options = {})
-    validate_options options
+    Utils.validate_hash_keys options, KNOWN_OPTIONS_KEYS
 
     @timeout       = options.fetch(:timeout) { 10 }
     @verify_cert   = options.fetch(:verify_cert) { true }
@@ -15,26 +15,27 @@ class HTTPWrapper
     @user_agent    = options.fetch(:user_agent) { USER_AGENT }
   end
 
-  [:get, :post, :put, :delete].each do |method|
-    define_method method do |url, params = {}|
+  [:get, :post, :put, :delete].each do |method_as_symbol|
+    define_method method_as_symbol do |url, params = {}|
       params[:user_agent] ||= @user_agent
-      get_response Request.new(url, method, params)
+      get_response Request.new(url, method_as_symbol, params)
     end
 
-    %w(ajax json ajax_json).each do |header|
-      define_method "#{method.to_s}_#{header}" do |url, params = {}|
-        params[:headers] ||= {}
-        params[:headers].merge! HTTPWrapper.const_get("#{header}_HEADER".upcase)
-        __send__ method, url, params
+    method_as_string = method_as_symbol.to_s
+
+    %w(ajax json ajax_json).each do |request_type|
+      define_method "#{method_as_string}_#{request_type}" do |url, params = {}|
+        (params[:headers] ||= {}).merge!(headers_specific_for request_type)
+        public_send method_as_symbol, url, params
       end
     end
 
-    alias_method "#{method.to_s}_json_ajax", "#{method.to_s}_ajax_json"
+    alias_method "#{method_as_string}_json_ajax", "#{method_as_string}_ajax_json"
   end
 
   def post_and_get_cookie(url, params = {})
     response = post url, params
-    response.response['set-cookie']
+    response['set-cookie']
   end
 
   def execute(request, uri)
@@ -44,14 +45,6 @@ class HTTPWrapper
 
   private
 
-  def validate_options(options)
-    unknown_options = options.keys - KNOWN_OPTIONS_KEYS
-
-    if unknown_options.length > 0
-      raise UnknownParameterError.new "Unknown options: #{unknown_options.join(', ')}"
-    end
-  end
-
   def get_response(request, redirects_limit = @max_redirects)
     raise TooManyRedirectsError.new 'Too many redirects!' if redirects_limit == 0
 
@@ -65,6 +58,10 @@ class HTTPWrapper
     response
   end
 
+  def headers_specific_for(request_type)
+    self.class.const_get "#{request_type.upcase}_HEADER"
+  end
+
   def create_connection(uri)
     connection = Net::HTTP.new uri.host, uri.port
     connection.read_timeout = @timeout

data/lib/http_wrapper/request.rb

@@ -5,24 +5,24 @@ class HTTPWrapper
     KNOWN_PARAMS_KEYS = [:headers, :query, :cookie, :auth, :body, :user_agent, :content_type, :multipart].freeze
 
     def initialize(url, method, params = {})
-      validate_parameters params
+      Utils.validate_hash_keys params, KNOWN_PARAMS_KEYS
 
-      self.uri  = url
+      self.uri = url
 
-      @headers  = params[:headers] || {}
-      @query    = params[:query]   || {}
-      @cookie   = params[:cookie]  || @headers[HEADER::COOKIE]
-      @login    = params[:auth] && params[:auth].fetch(:login)
-      @password = params[:auth] && params[:auth].fetch(:password)
+      @query   = params[:query] || {}
+      @headers = normalize_headers params[:headers]
+      @method  = http_method_class_for method
+      @cookie  = params[:cookie]
 
-      @method       = method
-      @method_class = Net::HTTP.const_get(method.to_s.capitalize)
+      @body_data      = params[:body]
+      @multipart_data = params[:multipart]
+      @user_agent     = params[:user_agent]
+      @content_type   = params[:content_type] || default_content_type_for(method)
 
-      @body         = params[:body]
-      @user_agent   = params[:user_agent]
-      @content_type = params[:content_type]
-
-      @multipart_data = params[:multipart] || []
+      if params[:auth]
+        @login    = params[:auth].fetch(:login)
+        @password = params[:auth].fetch(:password)
+      end
 
       initialize_headers
     end
@@ -30,56 +30,60 @@ class HTTPWrapper
     attr_reader :uri
 
     def uri=(url)
-      if url.is_a? URI
-        @uri = url
-      else
-        url = "http://#{url}" unless url =~ /\Ahttps?:\/\//
-        @uri = URI.parse url
-      end
+      url = "http://#{url}" unless url =~ /\Ahttps?:\/\//
+      @uri = URI.parse url
     end
 
     def create
-      rebuild_uri_query_params
-      convert_symbol_headers_to_string
-      create_http_request
+      merge_uri_query
+      create_method_specific_request
     end
 
     private
 
-    def validate_parameters(params)
-      unknown_params = params.keys - KNOWN_PARAMS_KEYS
-
-      if unknown_params.length > 0
-        raise UnknownParameterError.new "Unknown parameters: #{unknown_params.join(', ')}"
+    def normalize_headers(headers)
+      normal_headers = {}
+      if headers
+        headers.each do |header, value|
+          normal_headers[normalize_header header] = value
+        end
       end
+      normal_headers
     end
 
-    def initialize_headers
-      @headers[HEADER::USER_AGENT] ||= @user_agent
-      case @method
-        when :post, :put then @headers[HEADER::CONTENT_TYPE] ||= (@content_type || CONTENT_TYPE::POST)
-        else @headers[HEADER::CONTENT_TYPE] ||= (@content_type || CONTENT_TYPE::DEFAULT)
-      end
+    def normalize_header(header)
+      header = header.to_s.gsub(/_/, '-') if header.is_a? Symbol
+      header.downcase
     end
 
-    def rebuild_uri_query_params
-      return unless @query.size > 0
-      query = @uri.query ? query_to_hash(@uri.query).merge(@query) : @query
-      @uri.query = URI.encode_www_form query
+    def http_method_class_for(method)
+      Net::HTTP.const_get method.to_s.capitalize
     end
 
-    def convert_symbol_headers_to_string
-      @headers.keys.select{|key| key.is_a? Symbol}.each do |key|
-        str_key = key.to_s.gsub(/_/, '-').capitalize
-        @headers[str_key] = @headers.delete key
+    def default_content_type_for(method)
+      case method
+        when :post, :put then CONTENT_TYPE::POST
+        else CONTENT_TYPE::DEFAULT
       end
     end
 
-    def create_http_request
+    def initialize_headers
+      @headers[HEADER::USER_AGENT]   ||= @user_agent
+      @headers[HEADER::CONTENT_TYPE] ||= @content_type
+      @headers[HEADER::COOKIE]       ||= @cookie if @cookie
+    end
+
+    def merge_uri_query
+      return unless @query.size > 0
+      original_query = @uri.query ? Utils.query_to_hash(@uri.query) : {}
+      merged_query = original_query.merge @query
+      @uri.query = Utils.hash_to_query merged_query
+    end
+
+    def create_method_specific_request
       # Ruby v1.9.3 doesn't understand full URI object, it needs just path :(
       uri = RUBY_VERSION =~ /\A2/ ? @uri : @uri.request_uri
-      @request = @method_class.new uri, @headers
-      set_cookies
+      @request = @method.new uri, @headers
       set_body
       set_basic_auth
       @request
@@ -87,35 +91,31 @@ class HTTPWrapper
 
     def set_body
       return unless @request.request_body_permitted?
-      if @multipart_data.length > 0
-        convert_body_to_multipart_data if @body
-        @request.set_form @multipart_data, CONTENT_TYPE::MULTIPART
-      elsif @body
-        @request.body = @body.is_a?(Hash) ? hash_to_query(@body) : @body
+      if @multipart_data
+        set_body_from_multipart_data
+      else
+        set_body_from_body_data
       end
     end
 
-    def set_basic_auth
-      return unless @login
-      @request.basic_auth @login, @password
+    def set_body_from_multipart_data
+      convert_body_data_to_multipart_data if @body_data
+      @request.set_form @multipart_data, CONTENT_TYPE::MULTIPART
     end
 
-    def set_cookies
-      return unless @cookie
-      @request['Cookie'] = @cookie
+    def convert_body_data_to_multipart_data
+      @body_data = Utils.query_to_hash(@body_data) unless @body_data.kind_of? Hash
+      @body_data.each{|key, value| @multipart_data << [key.to_s, value.to_s]}
     end
 
-    def convert_body_to_multipart_data
-      @body = query_to_hash(@body) unless @body.kind_of? Hash
-      @body.each{|key, value| @multipart_data << [key.to_s, value.to_s]}
+    def set_body_from_body_data
+      return unless @body_data
+      @request.body = @body_data.is_a?(Hash) ? Utils.hash_to_query(@body_data) : @body_data
     end
 
-    def query_to_hash(query)
-      Hash[URI.decode_www_form query]
-    end
-
-    def hash_to_query(hash)
-      URI.encode_www_form hash
+    def set_basic_auth
+      return unless @login
+      @request.basic_auth @login, @password
     end
   end
 end

data/lib/http_wrapper/utils.rb

@@ -0,0 +1,18 @@
+class HTTPWrapper
+  module Utils
+    def self.validate_hash_keys(hash_to_check, known_keys_array)
+      unknown_keys = hash_to_check.keys - known_keys_array
+      if unknown_keys.length > 0
+        raise UnknownKeyError.new "Unknown keys: #{unknown_keys.join(', ')}"
+      end
+    end
+
+    def self.query_to_hash(query)
+      Hash[URI.decode_www_form query]
+    end
+
+    def self.hash_to_query(hash)
+      URI.encode_www_form hash
+    end
+  end
+end

data/lib/http_wrapper/version.rb

@@ -1,3 +1,3 @@
 class HTTPWrapper
-  VERSION = '2.1.0'.freeze
+  VERSION = '2.1.1'.freeze
 end

data/lib/http_wrapper.rb

@@ -1,5 +1,6 @@
 require 'http_wrapper/version'
 require 'http_wrapper/constants'
 require 'http_wrapper/errors'
+require 'http_wrapper/utils'
 require 'http_wrapper/request'
 require 'http_wrapper/http_wrapper'

data/spec/http_wrapper_spec.rb

@@ -24,13 +24,13 @@ describe HTTPWrapper do
       it 'should raise UnknownParameterError if initial options key is unknown' do
         expect do
           HTTPWrapper.new unknown_option: 'test', maybe_this_known: '?'
-        end.to raise_error HTTPWrapper::UnknownParameterError, 'Unknown options: unknown_option, maybe_this_known'
+        end.to raise_error HTTPWrapper::UnknownKeyError, 'Unknown keys: unknown_option, maybe_this_known'
       end
 
       it 'should raise UnknownParameterError if params key is unknown' do
         expect do
           subject.get sample_url, unknown_param_key: 'test', another_param_key: 'wow'
-        end.to raise_error HTTPWrapper::UnknownParameterError, 'Unknown parameters: unknown_param_key, another_param_key'
+        end.to raise_error HTTPWrapper::UnknownKeyError, 'Unknown keys: unknown_param_key, another_param_key'
       end
 
       it 'should follow redirects no more then 10 times by default' do
@@ -159,6 +159,12 @@ describe HTTPWrapper do
         subject.get sample_url, params
       end
 
+      it 'should use headers cookie if both (headers and parameters) cookies provided' do
+        params = { headers: {'Cookie' => 'Custom cookie'} }
+        stub_get sample_url, params
+        subject.get sample_url, params.merge({cookie: 'should not use this one'})
+      end
+
       it 'should hit provided url with basic auth' do
         stub_get sample_url_with_basic_auth
         subject.get sample_url, auth: {login: basic_auth_login, password: basic_auth_password}
@@ -170,8 +176,9 @@ describe HTTPWrapper do
       end
 
       it 'should equally treat header as string and header as symbol' do
-        stub_get sample_url, { headers: {'Content-Type' => 'Some Content Type'} }
-        subject.get sample_url, { headers: {content_type: 'Some Content Type'} }
+        custom_content_type = 'Some Content Type'
+        stub_get sample_url, { headers: {'Content-Type' => custom_content_type} }
+        subject.get sample_url, { headers: {content_type: custom_content_type} }
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http_wrapper
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Leonid Svyatov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-18 00:00:00.000000000 Z
+date: 2013-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,11 +83,12 @@ files:
 - lib/http_wrapper/errors.rb
 - lib/http_wrapper/http_wrapper.rb
 - lib/http_wrapper/request.rb
+- lib/http_wrapper/utils.rb
 - lib/http_wrapper/version.rb
 - lib/http_wrapper.rb
 - spec/http_wrapper_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/Svyatov/http_wrapper
+homepage: http://github.com/svyatov/http_wrapper
 licenses:
 - MIT
 metadata: {}