wrest 3.0.0 → 4.0.0

data/lib/wrest/native/session.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2009 Sidu Ponnappa
 
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -7,51 +9,58 @@
 # is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and limitations under the License.
 
-module Wrest::Native
-  # This class is a wrapper for a keep-alive HTTP connection. It simply passes the
-  # same connection instance as an option to all Wrest::Native::Request instances created using it.
-  #
-  # If at any point the server closes an existing connection during a Session by returning a
-  # Connection: Close header the current connection is destroyed and a fresh one created for the next
-  # request.
-  #
-  # The Session constructor can accept either a String URI or a Wrest::Uri as a parameter. If you
-  # need HTTP authentication, you should use a Wrest::Uri.
-  class Session
-    attr_reader :uri
-    def initialize(uri)
-      @uri = Wrest::Uri.new(uri)
-      @default_headers = { Wrest::Native::StandardHeaders::Connection => Wrest::Native::StandardTokens::KeepAlive }
-
-      yield(self) if block_given?
-    end
+module Wrest
+  module Native
+    # This class is a wrapper for a keep-alive HTTP connection. It simply passes the
+    # same connection instance as an option to all Wrest::Native::Request instances created using it.
+    #
+    # If at any point the server closes an existing connection during a Session by returning a
+    # Connection: Close header the current connection is destroyed and a fresh one created for the next
+    # request.
+    #
+    # The Session constructor can accept either a String URI or a Wrest::Uri as a parameter. If you
+    # need HTTP authentication, you should use a Wrest::Uri.
+    class Session
+      attr_reader :uri
 
-    def connection
-      @connection ||= @uri.create_connection
-    end
+      def initialize(uri)
+        @uri = Wrest::Uri.new(uri)
+        @default_headers = { Wrest::Native::StandardHeaders::Connection => Wrest::Native::StandardTokens::KeepAlive }
 
-    def get(path = '', parameters = {}, headers = {})
-      maybe_destroy_connection @uri[path, {:connection => self.connection}].get(parameters, headers.merge(@default_headers))
-    end
+        yield(self) if block_given?
+      end
 
-    def post(path = '', body = '', headers = {}, params = {})
-      maybe_destroy_connection @uri[path, {:connection => self.connection}].post(body, headers.merge(@default_headers), params)
-    end
-    
-    def put(path = '', body = '', headers = {}, params = {})
-      maybe_destroy_connection @uri[path, {:connection => self.connection}].put(body, headers.merge(@default_headers), params)
-    end
+      def connection
+        @connection ||= @uri.create_connection
+      end
 
-    def delete(path = '', parameters = {}, headers = {})
-      maybe_destroy_connection @uri[path, {:connection => self.connection}].delete(parameters, headers.merge(@default_headers))
-    end
-    
-    def maybe_destroy_connection(response)
-      if response.connection_closed?
-        Wrest.logger.warn "Connection #{@connection.hash} has been closed by the server"
-        @connection = nil 
+      def get(path = '', parameters = {}, headers = {})
+        maybe_destroy_connection @uri[path, { connection: connection }].get(parameters,
+                                                                            headers.merge(@default_headers))
+      end
+
+      def post(path = '', body = '', headers = {}, params = {})
+        maybe_destroy_connection @uri[path, { connection: connection }].post(body, headers.merge(@default_headers),
+                                                                             params)
+      end
+
+      def put(path = '', body = '', headers = {}, params = {})
+        maybe_destroy_connection @uri[path, { connection: connection }].put(body, headers.merge(@default_headers),
+                                                                            params)
+      end
+
+      def delete(path = '', parameters = {}, headers = {})
+        maybe_destroy_connection @uri[path, { connection: connection }].delete(parameters,
+                                                                               headers.merge(@default_headers))
+      end
+
+      def maybe_destroy_connection(response)
+        if response.connection_closed?
+          Wrest.logger.warn "Connection #{@connection.hash} has been closed by the server"
+          @connection = nil
+        end
+        response
       end
-      response
     end
   end
 end

data/lib/wrest/native.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2009 Sidu Ponnappa
 
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,17 +20,17 @@ module Wrest
   end
 end
 
-require "wrest/native/connection_factory"
-require "wrest/native/response"
-require "wrest/native/redirection"
-require "wrest/native/request"
-require "wrest/native/get"
-require "wrest/native/put"
-require "wrest/native/patch"
-require "wrest/native/post"
-require "wrest/native/delete"
-require "wrest/native/options"
-require "wrest/native/session"
+require 'wrest/native/connection_factory'
+require 'wrest/native/response'
+require 'wrest/native/redirection'
+require 'wrest/native/request'
+require 'wrest/native/get'
+require 'wrest/native/put'
+require 'wrest/native/patch'
+require 'wrest/native/post'
+require 'wrest/native/delete'
+require 'wrest/native/options'
+require 'wrest/native/session'
 
 # default to using Native libs
-Wrest::Http = Wrest::Native
+Wrest::Http = Wrest::Native

data/lib/wrest/test/request_patches.rb

@@ -1,5 +1,12 @@
-class Wrest::Native::Request
-  def invoke
-    raise Wrest::Exceptions::RealRequestMadeInTestEnvironmet, 'A real HTTP request was made while running tests. Please avoid using live HTTP connections while testing and replace them with mocks.'
+# frozen_string_literal: true
+
+module Wrest
+  module Native
+    class Request
+      def invoke
+        raise Wrest::Exceptions::RealRequestMadeInTestEnvironmet,
+              'A real HTTP request was made while running tests. Please avoid using live HTTP connections while testing and replace them with mocks.'
+      end
+    end
   end
 end

data/lib/wrest/test.rb

@@ -1 +1,3 @@
-require "wrest/test/request_patches"
+# frozen_string_literal: true
+
+require 'wrest/test/request_patches'

data/lib/wrest/uri/builders.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Wrest
   class Uri
     # Contains methods that depend on Uri#clone to build
@@ -5,42 +7,42 @@ module Wrest
     module Builders
       # Returns a Uri object that uses threads to perform asynchronous requests.
       def using_threads
-        clone(:asynchronous_backend => Wrest::AsyncRequest::ThreadBackend.new)
+        clone(asynchronous_backend: Wrest::AsyncRequest::ThreadBackend.new)
       end
 
       # Returns a Uri object that uses eventmachine to perform asynchronous requests.
-      # Remember to do Wrest::AsyncRequest.enable_em first so that 
+      # Remember to do Wrest::AsyncRequest.enable_em first so that
       # EventMachine is available for use.
       def using_em
-        clone(:asynchronous_backend => Wrest::AsyncRequest::EventMachineBackend.new)
+        clone(asynchronous_backend: Wrest::AsyncRequest::EventMachineBackend.new)
       end
 
       # Returns a Uri object that uses hash for caching responses.
       def using_hash
-        clone(:cache_store => {})
+        clone(cache_store: {})
       end
 
       # Returns a Uri object that uses memcached for caching responses.
-      # Remember to do Wrest::AsyncRequest.enable_memcached first so that 
+      # Remember to do Wrest::AsyncRequest.enable_memcached first so that
       # memcached is available for use.
       def using_memcached
-        clone(:cache_store => Wrest::Caching::Memcached.new)
+        clone(cache_store: Wrest::Caching::Memcached.new)
       end
 
       def using_redis
-        clone(:cache_store => Wrest::Caching::Redis.new)
+        clone(cache_store: Wrest::Caching::Redis.new)
       end
 
-      # Disables using the globally configured cache for GET requests 
+      # Disables using the globally configured cache for GET requests
       # made using the Uri returned by this method.
       def disable_cache
-        clone(:disable_cache => true)
+        clone(disable_cache: true)
       end
-      
+
       # Sets the specified string as the cookie for the Uri
       def using_cookie(cookie_string)
-        clone(:default_headers => {Wrest::H::Cookie => cookie_string})
+        clone(default_headers: { Wrest::H::Cookie => cookie_string })
       end
     end
   end
-end
+end

data/lib/wrest/uri.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2009 Sidu Ponnappa
 
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -7,7 +9,7 @@
 # is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and limitations under the License.
 
-module Wrest #:nodoc:
+module Wrest # :nodoc:
   # Wrest::Uri provides a simple api for
   # REST calls. String#to_uri is a convenience
   # method to build a Wrest::Uri from a string url.
@@ -17,13 +19,13 @@ module Wrest #:nodoc:
   # Example:
   #  "http://kaiwren:fupuppies@coathangers.com/portal/1".to_uri
   #  "http://coathangers.com/portal/1".to_uri(:username => 'kaiwren', :password => 'fupuppies')
-  # 
+  #
   # The second form is preferred as it can handle passwords with special characters like ^ and @
   #
   # You can find examples that use real APIs (like delicious) under the wrest/examples directory.
   class Uri
     attr_reader :uri, :username, :password, :uri_string, :uri_path, :query, :default_headers
-    
+
     # Valid tuples for the options are:
     #   :asynchronous_backend => Can currently be set to either Wrest::AsyncRequest::EventMachineBackend.new
     #                            or Wrest::AsyncRequest::ThreadBackend.new. Easier to do using Uri#using_em and
@@ -40,26 +42,17 @@ module Wrest #:nodoc:
     # See Wrest::Native::Request for other available options and their default values.
     def initialize(uri_string, options = {})
       @options = options.clone
-      @uri_string = uri_string.to_s
-      @uri = URI.parse(@uri_string)
-      uri_scheme = URI.split(@uri_string)
-      @uri_path = uri_scheme[-4].split('?').first || ''
-      @uri_path = (@uri_path.empty? ? '/' : @uri_path) 
-      @query = uri_scheme[-2] || ''
-      @username = (@options[:username] ||= @uri.user)
-      @password = (@options[:password] ||= @uri.password)
-      @asynchronous_backend = @options[:asynchronous_backend] || Wrest::AsyncRequest.default_backend
-      @options[:callback] = Callback.new(@options[:callback]) if @options[:callback]
-      @default_headers = @options[:default_headers] || {}
-    end 
-    
-    # Builds a Wrest::UriTemplate by extending the current URI 
+      setup_uri_state!(uri_string)
+      setup_request_config!
+    end
+
+    # Builds a Wrest::UriTemplate by extending the current URI
     # with the pattern passed to it.
     def to_template(pattern)
-      template_pattern = URI.join(uri_string,pattern).to_s
+      template_pattern = URI.join(uri_string, pattern).to_s
       UriTemplate.new(template_pattern, @options)
     end
-        
+
     # Build a new Wrest::Uri by appending _path_ to
     # the current uri. If the original Wrest::Uri
     # has a username and password, that will be
@@ -78,11 +71,11 @@ module Wrest #:nodoc:
     def [](path, options = nil)
       Uri.new(uri + File.join(uri_path, path), options || @options)
     end
-    
+
     # Clones a Uri, building a new instance with exactly the same uri string.
     # You can however change the Uri options or add new ones.
     def clone(opts = {})
-      merged_options =  @options.merge(opts)
+      merged_options = @options.merge(opts)
       merged_options[:default_headers] = opts[:default_headers] ? @default_headers.merge(opts[:default_headers]) : {}
       Uri.new(@uri_string, merged_options)
     end
@@ -90,55 +83,61 @@ module Wrest #:nodoc:
     def eql?(other)
       self == other
     end
-    
+
     def ==(other)
       return false if other.class != self.class
-      return other.uri == self.uri && self.username == other.username && self.password == other.password
+
+      other.uri == uri && username == other.username && password == other.password
     end
-    
+
     def hash
-      @uri.hash + @username.hash + @password.hash + 20090423
+      [@uri, @username, @password].hash
     end
-    
+
     # This produces exactly the same string as the Wrest::Uri was constructed with.
     # If the orignial URI contained a HTTP username and password, that too will
     # show up, so be careful if using this for logging.
     def to_s
       uri_string
     end
-    
-    #:nodoc:
+
+    # :nodoc:
     def build_get(parameters = {}, headers = {}, &block)
-      Http::Get.new(self, parameters, default_headers.merge(headers), block ? @options.merge(:callback_block => block) : @options)
+      Http::Get.new(self, parameters, default_headers.merge(headers),
+                    block ? @options.merge(callback_block: block) : @options)
     end
-    
-    #:nodoc:
+
+    # :nodoc:
     def build_put(body = '', headers = {}, parameters = {}, &block)
-      Http::Put.new(self, body.to_s, default_headers.merge(headers), parameters, block ? @options.merge(:callback_block => block) : @options)
+      Http::Put.new(self, body.to_s, default_headers.merge(headers), parameters,
+                    block ? @options.merge(callback_block: block) : @options)
     end
 
-    #:nodoc:
+    # :nodoc:
     def build_patch(body = '', headers = {}, parameters = {}, &block)
-      Http::Patch.new(self, body.to_s, default_headers.merge(headers), parameters, block ? @options.merge(:callback_block => block) : @options)
+      Http::Patch.new(self, body.to_s, default_headers.merge(headers), parameters,
+                      block ? @options.merge(callback_block: block) : @options)
     end
-    
-    #:nodoc:
+
+    # :nodoc:
     def build_post(body = '', headers = {}, parameters = {}, &block)
-      Http::Post.new(self, body.to_s, default_headers.merge(headers), parameters, block ? @options.merge(:callback_block => block) : @options)
+      Http::Post.new(self, body.to_s, default_headers.merge(headers), parameters,
+                     block ? @options.merge(callback_block: block) : @options)
     end
 
-    #:nodoc:
-    def build_post_form(parameters ={}, headers = {}, &block)
+    # :nodoc:
+    def build_post_form(parameters = {}, headers = {}, &block)
       headers = default_headers.merge(headers).merge(Wrest::H::ContentType => Wrest::T::FormEncoded)
-      body = parameters.to_query
-      Http::Post.new(self, body, headers, {}, block ? @options.merge(:callback_block => block) : @options)
+      body = Utils.hash_to_param(parameters)
+      Http::Post.new(self, body, headers, {}, block ? @options.merge(callback_block: block) : @options)
     end
 
-    #:nodoc:
+    # :nodoc:
     def build_delete(parameters = {}, headers = {}, &block)
-      Http::Delete.new(self, parameters, default_headers.merge(headers), block ? @options.merge(:callback_block => block) : @options)
+      Http::Delete.new(self, parameters, default_headers.merge(headers),
+                       block ? @options.merge(callback_block: block) : @options)
     end
-    
+
     # Make a GET request to this URI. This is a convenience API
     # that creates a Wrest::Native::Get, executes it and returns a Wrest::Native::Response.
     #
@@ -149,7 +148,7 @@ module Wrest #:nodoc:
 
     # Make a GET request to this URI. This is a convenience API
     # that creates a Wrest::Native::Get.
-    # 
+    #
     # Remember to escape all parameter strings if necessary, using URI.escape
     #
     # Note: get_async does not return a response and the response should be accessed through callbacks.
@@ -212,9 +211,9 @@ module Wrest #:nodoc:
     def post_async(body = '', headers = {}, parameters = {}, &block)
       @asynchronous_backend.execute(build_post(body, headers, parameters, &block))
     end
-    
+
     # Makes a POST request to this URI. This is a convenience API
-    # that mimics a form being posted; some allegly RESTful APIs like FCBK require 
+    # that mimics a form being posted; some allegly RESTful APIs like FCBK require
     # this.
     #
     # Form encoding involves munging the parameters into a string and placing them
@@ -225,7 +224,7 @@ module Wrest #:nodoc:
     end
 
     # Makes a POST request to this URI. This is a convenience API
-    # that mimics a form being posted; some allegly RESTful APIs like FCBK require 
+    # that mimics a form being posted; some allegly RESTful APIs like FCBK require
     # this.
     #
     # Form encoding involves munging the parameters into a string and placing them
@@ -263,7 +262,7 @@ module Wrest #:nodoc:
       Http::Options.new(self, @options).invoke
     end
 
-    def https? 
+    def https?
       @uri.is_a?(URI::HTTPS)
     end
 
@@ -279,16 +278,35 @@ module Wrest #:nodoc:
     def protocol
       uri.scheme
     end
-    
+
     def host
       uri.host
     end
-    
+
     def port
       uri.port
     end
-    
+
     include Http::ConnectionFactory
     include Uri::Builders
+
+    private
+
+    def setup_request_config!
+      @username = (@options[:username] ||= @uri.user)
+      @password = (@options[:password] ||= @uri.password)
+      @asynchronous_backend = @options[:asynchronous_backend] || Wrest::AsyncRequest.default_backend
+      @options[:callback] = Callback.new(@options[:callback]) if @options[:callback]
+      @default_headers = @options[:default_headers] || {}
+    end
+
+    def setup_uri_state!(uri_string)
+      @uri_string = uri_string.to_s
+      @uri = URI.parse(@uri_string)
+      uri_scheme = URI.split(@uri_string)
+      @uri_path = uri_scheme[-4].split('?').first || ''
+      @uri_path = (@uri_path.empty? ? '/' : @uri_path)
+      @query = uri_scheme[-2] || ''
+    end
   end
 end

data/lib/wrest/uri_template.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2009 Sidu Ponnappa
 
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -10,12 +12,13 @@
 module Wrest
   class UriTemplate
     attr_reader :uri_pattern
+
     def initialize(uri_pattern, options = {})
       @uri_pattern = uri_pattern.clone
       @options = options.clone
     end
-    
-    # Builds a new Wrest::Uri from this uri template 
+
+    # Builds a new Wrest::Uri from this uri template
     # by replacing the keys in the options that match with
     # the corressponding values.
     #
@@ -40,11 +43,11 @@ module Wrest
     # )
     #  => #<Wrest::Uri:0x18e0bec @uri=#<URI::HTTP:0x18e09a8 URL:http://kaiwren:fupuppies@coathangers.com/portal/1>>
     def to_uri(options = {})
-     merged_options = @options.merge(options) 
-      Wrest::Uri.new(merged_options.inject(uri_pattern.clone) do |uri_string, tuple| 
+      merged_options = @options.merge(options)
+      Wrest::Uri.new(merged_options.inject(uri_pattern.clone) do |uri_string, tuple|
         key, value = tuple
-        uri_string.gsub(":#{key.to_s}", value.to_s)
-      end , @options)
+        uri_string.gsub(":#{key}", value.to_s)
+      end, @options)
     end
 
     def [](path)
@@ -53,7 +56,8 @@ module Wrest
 
     def ==(other)
       return false if other.class != self.class
-      return other.uri_pattern == self.uri_pattern 
+
+      other.uri_pattern == uri_pattern
     end
   end
 end

data/lib/wrest/utils.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module Wrest
+  module Utils
+    module_function
+
+    # https://github.com/rails/rails/commit/2a371368c91789a4d689d6a84eb20b238c37678a
+    # A string is blank if it's empty or contains whitespaces only:
+    #
+    #   "".blank?                 # => true
+    #   "   ".blank?              # => true
+    #   "　".blank?               # => true
+    #   " something here ".blank? # => false
+    #
+    def string_blank?(string)
+      string !~ /[^[:space:]]/
+    end
+
+    # https://github.com/rails/rails/commit/69b550fc88f0e155ab997476e576142a2dbec324
+    # Tries to find a constant with the name specified in the argument string.
+    #
+    #   constantize('Module')   # => Module
+    #   constantize('Foo::Bar') # => Foo::Bar
+    #
+    # The name is assumed to be the one of a top-level constant, no matter
+    # whether it starts with "::" or not. No lexical context is taken into
+    # account:
+    #
+    #   C = 'outside'
+    #   module M
+    #     C = 'inside'
+    #     C                # => 'inside'
+    #     constantize('C') # => 'outside', same as ::C
+    #   end
+    #
+    # NameError is raised when the name is not in CamelCase or the constant is
+    # unknown.
+    def string_constantize(camel_cased_word)
+      Object.const_get(camel_cased_word)
+    end
+
+    # https://github.com/rails/rails/commit/69b550fc88f0e155ab997476e576142a2dbec324
+    # Removes the module part from the expression in the string.
+    #
+    #   demodulize('ActiveSupport::Inflector::Inflections') # => "Inflections"
+    #   demodulize('Inflections')                           # => "Inflections"
+    #   demodulize('::Inflections')                         # => "Inflections"
+    #   demodulize('')                                      # => ""
+    #
+    def string_demodulize(path)
+      path = path.to_s
+      if (i = path.rindex('::'))
+        path[(i + 2)..]
+      else
+        path
+      end
+    end
+
+    # https://github.com/rails/rails/commit/69b550fc88f0e155ab997476e576142a2dbec324
+    # Makes an underscored, lowercase form from the expression in the string.
+    #
+    # Changes '::' to '/' to convert namespaces to paths.
+    #
+    #   underscore('ActiveModel')         # => "active_model"
+    #   underscore('ActiveModel::Errors') # => "active_model/errors"
+    #
+    # As a rule of thumb you can think of +underscore+ as the inverse of
+    # #camelize, though there are cases where that does not hold:
+    #
+    #   camelize(underscore('SSLError'))  # => "SslError"
+    def string_underscore(camel_cased_word)
+      return camel_cased_word.to_s unless /[A-Z-]|::/.match?(camel_cased_word)
+
+      word = camel_cased_word.to_s.gsub('::', '/')
+      word.gsub!(/([A-Z]+)(?=[A-Z][a-z])|([a-z\d])(?=[A-Z])/) { (Regexp.last_match(1) || Regexp.last_match(2)) << '_' }
+      word.tr!('-', '_')
+      word.downcase!
+      word
+    end
+
+    # https://github.com/rails/rails/commit/a0d7247d1509762283c61182ad82c2eed8d54757
+    # Returns a string representation of the receiver suitable for use as a URL
+    # query string:
+    #
+    #   {:name => 'David', :nationality => 'Danish'}.to_param
+    #   # => "name=David&nationality=Danish"
+    #
+    # The string pairs "key=value" that conform the query string
+    # are sorted lexicographically in ascending order.
+    #
+    def hash_to_param(hash)
+      hash.collect do |key, value|
+        object_to_query(key, value)
+      end.sort * '&'
+    end
+
+    # https://github.com/rails/rails/commit/52b71c01fd3c8a87152f55129a8cb3234190734a
+    #
+    # Converts an object into a string suitable for use as a URL query string, using the given <tt>key</tt> as the
+    # param name.
+    def object_to_query(key, object)
+      "#{CGI.escape(key.to_s)}=#{CGI.escape(object.to_s)}"
+    end
+
+    # https://github.com/rails/rails/commit/18707ab17fa492eb25ad2e8f9818a320dc20b823
+    # An object is blank if it's false, empty, or a whitespace string.
+    # For example, +nil+, '', '   ', [], {}, and +false+ are all blank.
+    #
+    # This simplifies
+    #
+    #   !address || address.empty?
+    #
+    # to
+    #
+    #   address.blank?
+    #
+    # @return [true, false]
+    def object_blank?(object)
+      object.respond_to?(:empty?) ? !!object.empty? : !object
+    end
+
+    # https://github.com/rails/rails/commit/6372d23616b13c62c7a12efa89f958b334dd66ae
+    # Converts self to an integer number of seconds since the Unix epoch.
+    def datetime_to_i(datetime)
+      seconds_per_day = 86_400
+      ((datetime - ::DateTime.civil(1970)) * seconds_per_day).to_i
+    end
+  end
+end

data/lib/wrest/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2009-2011 Sidu Ponnappa
 
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -8,5 +10,5 @@
 # See the License for the specific language governing permissions and limitations under the License.
 
 module Wrest
-  VERSION = "3.0.0"
+  VERSION = '4.0.0'
 end