wrest 3.0.0 → 4.0.0

data/lib/wrest/native/connection_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2009 Sidu Ponnappa
 
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -7,18 +9,20 @@
 # 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
-  module ConnectionFactory
-    def create_connection(options = {:timeout => 60, :verify_mode => OpenSSL::SSL::VERIFY_NONE})
-      options[:timeout] ||= 60
-      connection = Net::HTTP.new(self.host, self.port)
-      connection.read_timeout = options[:timeout]
-      if self.https?
-        connection.use_ssl     = true
-        connection.verify_mode = options[:verify_mode] ? options[:verify_mode] : OpenSSL::SSL::VERIFY_PEER 
-        connection.ca_path = options[:ca_path] if options[:ca_path]
+module Wrest
+  module Native
+    module ConnectionFactory
+      def create_connection(options = { timeout: 60, verify_mode: OpenSSL::SSL::VERIFY_NONE })
+        options[:timeout] ||= 60
+        connection = Net::HTTP.new(host, port)
+        connection.read_timeout = options[:timeout]
+        if https?
+          connection.use_ssl     = true
+          connection.verify_mode = options[:verify_mode] || OpenSSL::SSL::VERIFY_PEER
+          connection.ca_path = options[:ca_path] if options[:ca_path]
+        end
+        connection
       end
-      connection
     end
   end
 end

data/lib/wrest/native/delete.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2009 Sidu Ponnappa
 
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -7,17 +9,19 @@
 # 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
-  class Delete < Request
-    def initialize(wrest_uri, parameters = {}, headers = {}, options = {})
-      super(
-            wrest_uri, 
-            Net::HTTP::Delete, 
-            parameters,
-            nil,
-            headers,
-            options
-          )
+module Wrest
+  module Native
+    class Delete < Request
+      def initialize(wrest_uri, parameters = {}, headers = {}, options = {})
+        super(
+              wrest_uri,
+              Net::HTTP::Delete,
+              parameters,
+              nil,
+              headers,
+              options
+            )
+      end
     end
   end
 end

data/lib/wrest/native/get.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2009 Sidu Ponnappa
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -6,74 +8,76 @@
 # 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
-  class Get < Request
-    QUERY_PARAMS_SEPERATOR = '?'
-    EMPTY_QUERY_PARAMS = ''
+module Wrest
+  module Native
+    class Get < Request
+      QUERY_PARAMS_SEPERATOR = '?'
+      EMPTY_QUERY_PARAMS = ''
 
-    attr_reader :cache_proxy
+      attr_reader :cache_proxy
 
-    def initialize(wrest_uri, parameters = {}, headers = {}, options = {})
-      follow_redirects = options[:follow_redirects]
-      options[:follow_redirects] = (follow_redirects == nil ? true : follow_redirects)
+      def initialize(wrest_uri, parameters = {}, headers = {}, options = {})
+        follow_redirects = options[:follow_redirects]
+        options[:follow_redirects] = (follow_redirects.nil? ? true : follow_redirects)
 
-      cache_store = (options[:cache_store] || Wrest::Caching.default_store) unless options[:disable_cache]
-      @cache_proxy = Wrest::CacheProxy::new(self, cache_store)
+        cache_store = (options[:cache_store] || Wrest::Caching.default_store) unless options[:disable_cache]
+        @cache_proxy = Wrest::CacheProxy.new(self, cache_store)
 
-      super(
-            wrest_uri,
-            Net::HTTP::Get,
-            parameters,
-            nil,
-            headers,
-            options
-          )
-    end
+        super(wrest_uri, Net::HTTP::Get, parameters, nil, headers, options)
+      end
 
-    # Checks equality between two Wrest::Native::Get objects.
-    # Comparing two Wrest::Native::Get objects with identical values for the following properties would return True.
-    #   uri, parameters, username, password and ssh verify_mode.
-    def ==(other)
-      return true if self.equal?(other)
-      return false unless other.class == self.class
-      return true if self.uri == other.uri and
-        self.parameters == other.parameters and
-        self.username == other.username and
-        self.password == other.password and
-        self.verify_mode == other.verify_mode
-      false
-    end
+      # Checks equality between two Wrest::Native::Get objects.
+      # Comparing two Wrest::Native::Get objects with identical values for the following properties would return True.
+      #   uri, parameters, username, password and ssh verify_mode.
+      def ==(other)
+        return true if equal?(other)
+        return false unless other.class == self.class
+        return true if these_fields_are_equal(other)
 
-    # Returns a hash value for this Wrest::Native::Get object.
-    # Objects that returns true when compared using the == operator would return the same hash value also.
-    def hash
-      self.uri.hash + self.parameters.hash + self.username.hash + self.password.hash + self.verify_mode.hash + 20110106
-    end
+        false
+      end
 
-    #:nodoc:
-    def invoke_with_cache_check
-      cache_proxy.get
-    end
+      # Returns a hash value for this Wrest::Native::Get object.
+      # Objects that returns true when compared using the == operator would return the same hash value also.
+      def hash
+        [uri, parameters, username, password, verify_mode].hash
+      end
 
-    alias_method :invoke_without_cache_check, :invoke
-    alias_method :invoke, :invoke_with_cache_check
+      # :nodoc:
+      def invoke_with_cache_check
+        cache_proxy.get
+      end
 
-    def build_request_without_cache_store(cache_validation_headers)
-      new_headers = headers.clone.merge cache_validation_headers
-      new_options = options.clone.tap { |opts| opts.delete :cache_store; opts[:disable_cache] = true } # do not run this through the caching mechanism.
+      alias invoke_without_cache_check invoke
+      alias invoke invoke_with_cache_check
 
-      new_request = Wrest::Native::Get.new(uri, parameters, new_headers, new_options)
-      new_request
-    end
+      def build_request_without_cache_store(cache_validation_headers)
+        new_headers = headers.clone.merge cache_validation_headers
+        new_options = # do not run this through the caching mechanism.
+          options.clone.tap do |opts|
+            opts.delete :cache_store
+            opts[:disable_cache] = true
+          end
+        Wrest::Native::Get.new(uri, parameters, new_headers, new_options)
+      end
 
-    def full_uri_string
-      @uri.to_s + query_params_string
-    end
+      def full_uri_string
+        @uri.to_s + query_params_string
+      end
 
-    private
-    def query_params_string
-      (@parameters.any?) ? QUERY_PARAMS_SEPERATOR + @parameters.to_query : EMPTY_QUERY_PARAMS
-    end
+      private
 
+      def these_fields_are_equal(other)
+        (uri == other.uri) &&
+          (parameters == other.parameters) &&
+          (username == other.username) &&
+          (password == other.password) &&
+          (verify_mode == other.verify_mode)
+      end
+
+      def query_params_string
+        @parameters.any? ? QUERY_PARAMS_SEPERATOR + Utils.hash_to_param(@parameters) : EMPTY_QUERY_PARAMS
+      end
+    end
   end
 end

data/lib/wrest/native/options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2009 Sidu Ponnappa
 
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -7,17 +9,19 @@
 # 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
-  class Options < Request
-    def initialize(wrest_uri, options = {})
-      super(
-            wrest_uri, 
-            Net::HTTP::Options, 
-            {},
-            nil,
-            {},
-            options
-          )
+module Wrest
+  module Native
+    class Options < Request
+      def initialize(wrest_uri, options = {})
+        super(
+              wrest_uri,
+              Net::HTTP::Options,
+              {},
+              nil,
+              {},
+              options
+            )
+      end
     end
   end
 end

data/lib/wrest/native/patch.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2009 Sidu Ponnappa
 
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -7,17 +9,19 @@
 # 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
-  class Patch < Request
-    def initialize(wrest_uri, body = '', headers = {}, parameters = {}, options = {})
-      super(
-        wrest_uri,
-        Net::HTTP::Patch,
-        parameters,
-        body,
-        headers,
-        options
-      )
+module Wrest
+  module Native
+    class Patch < Request
+      def initialize(wrest_uri, body = '', headers = {}, parameters = {}, options = {})
+        super(
+          wrest_uri,
+          Net::HTTP::Patch,
+          parameters,
+          body,
+          headers,
+          options
+        )
+      end
     end
   end
-end
+end

data/lib/wrest/native/post.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2009 Sidu Ponnappa
 
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -7,17 +9,19 @@
 # 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
-  class Post < Request
-    def initialize(wrest_uri, body = '', headers = {}, parameters = {}, options = {})
-      super(
-        wrest_uri,
-        Net::HTTP::Post,
-        parameters,
-        body,
-        headers,
-        options
-      )
+module Wrest
+  module Native
+    class Post < Request
+      def initialize(wrest_uri, body = '', headers = {}, parameters = {}, options = {})
+        super(
+          wrest_uri,
+          Net::HTTP::Post,
+          parameters,
+          body,
+          headers,
+          options
+        )
+      end
     end
   end
 end

data/lib/wrest/native/post_multipart.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2009 - 2010 Sidu Ponnappa
 
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -8,25 +10,27 @@
 # See the License for the specific language governing permissions and limitations under the License.
 require 'net/http/post/multipart'
 
-module Wrest::Native
-  class PostMultipart < Request
-    def initialize(wrest_uri, parameters = {}, headers = {}, options = {})
-      super(
-        wrest_uri,
-        Net::HTTP::Post::Multipart,
-        parameters,
-        nil,
-        headers,
-        options
-      )
-    end
-    
-    def build_request(request_klass, uri, parameters, headers)
-      request_klass.new(uri.full_path, parameters, headers)
-    end
+module Wrest
+  module Native
+    class PostMultipart < Request
+      def initialize(wrest_uri, parameters = {}, headers = {}, options = {})
+        super(
+          wrest_uri,
+          Net::HTTP::Post::Multipart,
+          parameters,
+          nil,
+          headers,
+          options
+        )
+      end
+
+      def build_request(request_klass, uri, parameters, headers)
+        request_klass.new(uri.full_path, parameters, headers)
+      end
 
-    def do_request
-      @connection.request(@http_request)
+      def do_request
+        @connection.request(@http_request)
+      end
     end
   end
 end

data/lib/wrest/native/put.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2009 Sidu Ponnappa
 
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -7,17 +9,19 @@
 # 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
-  class Put < Request
-    def initialize(wrest_uri, body = '', headers = {}, parameters = {}, options = {})
-      super(
-        wrest_uri,
-        Net::HTTP::Put,
-        parameters,
-        body,
-        headers,
-        options
-      )
+module Wrest
+  module Native
+    class Put < Request
+      def initialize(wrest_uri, body = '', headers = {}, parameters = {}, options = {})
+        super(
+          wrest_uri,
+          Net::HTTP::Put,
+          parameters,
+          body,
+          headers,
+          options
+        )
+      end
     end
   end
-end
+end

data/lib/wrest/native/put_multipart.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2009 - 2010 Sidu Ponnappa
 
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -8,25 +10,27 @@
 # See the License for the specific language governing permissions and limitations under the License.
 require 'net/http/post/multipart'
 
-module Wrest::Native
-  class PutMultipart < Request
-    def initialize(wrest_uri, parameters = {}, headers = {}, options = {})
-      super(
-        wrest_uri,
-        Net::HTTP::Put::Multipart,
-        parameters,
-        nil,
-        headers,
-        options
-      )
-    end
-    
-    def build_request(request_klass, uri, parameters, headers)
-      request_klass.new(uri.full_path, parameters, headers)
-    end
+module Wrest
+  module Native
+    class PutMultipart < Request
+      def initialize(wrest_uri, parameters = {}, headers = {}, options = {})
+        super(
+          wrest_uri,
+          Net::HTTP::Put::Multipart,
+          parameters,
+          nil,
+          headers,
+          options
+        )
+      end
+
+      def build_request(request_klass, uri, parameters, headers)
+        request_klass.new(uri.full_path, parameters, headers)
+      end
 
-    def do_request
-      @connection.request(@http_request)
+      def do_request
+        @connection.request(@http_request)
+      end
     end
   end
 end

data/lib/wrest/native/redirection.rb

@@ -1,25 +1,26 @@
+# frozen_string_literal: true
+
 # Copyright 2009 Sidu Ponnappa
 
-# Licensed under the Apache License, Version 2.0 (the "License"); 
-# you may not use this file except in compliance with the License. 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at Http://www.apache.org/licenses/LICENSE-2.0
-# Unless required by applicable law or agreed to in writing, software distributed under the License 
-# 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. 
+# Unless required by applicable law or agreed to in writing, software distributed under the License
+# 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 Native #:nodoc:
-    # Constructed by Wrest::Response.new if the HTTP response code is 3xx 
+module Wrest # :nodoc:
+  module Native # :nodoc:
+    # Constructed by Wrest::Response.new if the HTTP response code is 3xx
     # (http://en.wikipedia.org/wiki/300_Multiple_Choices#3xx_Redirection)
-    # 
+    #
     # This class is necessary because Net::HTTP doesn't seem to support
     # redirection natively.
     class Redirection < Response
-      
       # A get is invoked on the url stored in the response headers
       # under the key 'location' and the new Response is returned.
       #
-      # The follow_redirects_count and follow_redirects_limit options 
+      # The follow_redirects_count and follow_redirects_limit options
       # should be present. follow_redirects_count will be incremented by 1.
       #
       # This method will raise a Wrest::Exceptions::AutoRedirectLimitExceeded
@@ -35,4 +36,4 @@ module Wrest #:nodoc:
       end
     end
   end
-end
+end