wrest 3.0.0 → 4.0.0

data/lib/wrest/components/translators/json.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2009 Sidu Ponnappa
 
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -7,26 +9,27 @@
 # 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
   module Components
-    module Translators::Json
-      extend self
+    module Translators
+      module Json
+        module_function
 
-      def deserialise(response, options = {})
-        ActiveSupport::JSON.decode(response.body)
-      end
+        def deserialise(response, _options = {})
+          JSON.parse(response.body)
+        end
 
-      def deserialize(response, options = {})
-        deserialise(response, options)
-      end
-      
-      def serialise(hash, options = {})
-        hash.to_json(options)
-      end
-      
-      def serialize(hash, options = {})
-        serialise(hash, options)
+        def deserialize(response, options = {})
+          deserialise(response, options)
+        end
+
+        def serialise(hash, options = {})
+          hash.to_json(options)
+        end
+
+        def serialize(hash, options = {})
+          serialise(hash, options)
+        end
       end
     end
   end

data/lib/wrest/components/translators/txt.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2009 Sidu Ponnappa
 
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -7,24 +9,26 @@
 # 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
-  module Components::Translators
-    module Txt
-      extend self
+  module Components
+    module Translators
+      module Txt
+        module_function
 
-      def deserialise(response,options={})
-        response.body
-      end
+        def deserialise(response, _options = {})
+          response.body
+        end
 
-      def deserialize(response, options = {})
-        deserialise(response, options)
-      end
+        def deserialize(response, options = {})
+          deserialise(response, options)
+        end
 
-      def serialise(hash, options = {})
-        hash.inspect
-      end
-      
-      def serialize(hash, options = {})
-        serialise(hash, options)
+        def serialise(hash, _options = {})
+          hash.inspect
+        end
+
+        def serialize(hash, options = {})
+          serialise(hash, options)
+        end
       end
     end
   end

data/lib/wrest/components/translators/xml/conversions.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Wrest
+  module Components
+    module Translators
+      module Xml
+        module Conversions # :nodoc:
+          module Document # :nodoc:
+            def to_hash
+              root.to_hash
+            end
+          end
+
+          module Node # :nodoc:
+            CONTENT_ROOT = '__content__'
+
+            # Convert XML document to hash.
+            #
+            # hash::
+            #   Hash to merge the converted element into.
+            def to_hash(hash = {})
+              node_hash = {}
+
+              # Insert node hash into parent hash correctly.
+              case hash[name]
+              when Array then hash[name] << node_hash
+              when Hash then hash[name] = [hash[name], node_hash]
+              when nil then hash[name] = node_hash
+              end
+
+              # Handle child elements
+              children.each do |c|
+                if c.element?
+                  c.to_hash(node_hash)
+                elsif c.text? || c.cdata?
+                  node_hash[CONTENT_ROOT] ||= +''
+                  node_hash[CONTENT_ROOT] << c.content
+                end
+              end
+
+              # Remove content node if it is blank and there are child tags
+              node_hash.delete(CONTENT_ROOT) if node_hash.length > 1 && Utils.object_blank?(node_hash[CONTENT_ROOT])
+
+              # Handle attributes
+              attribute_nodes.each { |a| node_hash[a.node_name] = a.value }
+
+              hash
+            end
+          end
+        end
+        Nokogiri::XML::Document.include(Conversions::Document)
+        Nokogiri::XML::Node.include(Conversions::Node)
+      end
+    end
+  end
+end

data/lib/wrest/components/translators/xml.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2009 Sidu Ponnappa
 
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -6,29 +8,69 @@
 # 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.
+
+require_relative 'xml/conversions'
+
 module Wrest
-  module Components::Translators
-    module Xml
-      extend self
+  module Components
+    module Translators
+      module Xml
+        module_function
 
-      def deserialise(response,options={})
-        if(!options[:xpath].nil?)
-          ActiveSupport::XmlMini.filter(response.body,options[:xpath])
-        else
-          Hash.from_xml(response.body)
+        def deserialise(response, options = {})
+          data = response.body
+          data = StringIO.new(data || '') unless data.respond_to?(:read)
+          return {} if data.eof?
+
+          if options[:xpath].nil?
+            parse(data)
+          else
+            search(data, options[:xpath])
+          end
         end
-      end
 
-      def deserialize(response, options = {})
-        deserialise(response, options)
-      end
+        def deserialize(response, options = {})
+          deserialise(response, options)
+        end
 
-      def serialise(hash, options = {})
-        hash.to_xml(options)
-      end
-      
-      def serialize(hash, options = {})
-        serialise(hash, options)
+        def serialise(hash, _options = {})
+          to_xml(hash)
+        end
+
+        def serialize(hash, options = {})
+          serialise(hash, options)
+        end
+
+        def to_xml(hash, builder = nil)
+          builder ||= Nokogiri::XML::Builder.new
+          hash.each_with_object(builder) do |(key, value), inner_builder|
+            if value.is_a?(Hash)
+              inner_builder.send(key.to_s) do |child_builder|
+                to_xml(value, child_builder)
+              end
+            else
+              inner_builder.send(key.to_s, value.to_s)
+            end
+          end.to_xml
+        end
+
+        # Parse an XML Document string or IO into a simple hash using libxml / nokogiri.
+        # data::
+        #   XML Document string or IO to parse
+        def parse(data)
+          build_nokogiri_doc(data).to_hash
+        end
+
+        def search(data, xpath)
+          build_nokogiri_doc(data).xpath(xpath)
+        end
+
+        def build_nokogiri_doc(data)
+          doc = Nokogiri::XML(data)
+          raise doc.errors.join("\n") if doc.errors.length.positive?
+
+          doc
+        end
       end
     end
   end

data/lib/wrest/components/translators.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,6 @@
 # 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
   module Components
     # Contains strategies/lambdas which know how to deserialise
@@ -17,13 +18,13 @@ module Wrest
       # the content type
       def self.lookup(content_type)
         translator = CONTENT_TYPES[content_type]
-        translator || (raise Wrest::Exceptions::UnsupportedContentType.new("Unsupported content type #{content_type}"))
+        translator || (raise Wrest::Exceptions::UnsupportedContentType, "Unsupported content type #{content_type}")
       end
     end
   end
 end
 
-require "wrest/components/translators/txt"
-require "wrest/components/translators/xml"
-require "wrest/components/translators/json"
-require "wrest/components/translators/content_types"
+require 'wrest/components/translators/txt'
+require 'wrest/components/translators/xml'
+require 'wrest/components/translators/json'
+require 'wrest/components/translators/content_types'

data/lib/wrest/components.rb

@@ -1,11 +1,13 @@
+# 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. 
-# 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. 
+# 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.
 
 module Wrest
   # A component is a building block that can
@@ -15,5 +17,6 @@ module Wrest
   end
 end
 
-require "wrest/components/container"
-require "wrest/components/translators"
+require 'wrest/components/container'
+require 'wrest/components/mutators'
+require 'wrest/components/translators'

data/lib/wrest/core_ext/hash/conversions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2009 Sidu Ponnappa
 
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -8,37 +10,35 @@
 # See the License for the specific language governing permissions and limitations under the License.
 
 module Wrest
-  module CoreExt #:nodoc:
-    module Hash #:nodoc:
+  module CoreExt # :nodoc:
+    module Hash # :nodoc:
       # Makes it easier to build other objects from a Hash
       module Conversions
-
         # This method accepts a hash mutator (found in Wrest::Compononents)
         # to build a new hash map by making changes to an existing one.
         #
-        # No, this method does not mutate the state of the hash it is invoked on, 
+        # No, this method does not mutate the state of the hash it is invoked on,
         # but rather builds a new one.
         #
-        # Yes, the name is misleading in that respect. However, one 
+        # Yes, the name is misleading in that respect. However, one
         # hopes the absence of an exclamation mark will increase clarity.
         #
         # Uses include mutating the hash produced by deserialising xml
         # by using the meta data in the hash to type cast values.
-        # 
+        #
         # Example:
         # "http://search.yahooapis.com/NewsSearchService/V1/newsSearch".to_uri.get(
-        #                           :appid  => 'YahooDemo', 
+        #                           :appid  => 'YahooDemo',
         #                           :output => 'xml',
         #                           :query  => 'India',
         #                           :results=> '3',
         #                           :start  => '1'
-        #                         ).deserialise.mutate_using(XmlSimpleTypeCaster.new)
+        #                         ).deserialise.mutate_using(XmlTypeCaster.new)
         def mutate_using(mutator)
           mutated_hash = {}
-            self.each{|tuple| mutated_hash.store(*mutator.mutate(tuple))}
+          each { |tuple| mutated_hash.store(*mutator.mutate(tuple)) }
           mutated_hash
         end
-
       end
     end
   end

data/lib/wrest/core_ext/hash.rb

@@ -1,5 +1,7 @@
-require "wrest/core_ext/hash/conversions"
+# frozen_string_literal: true
 
-class Hash #:nodoc:
+require 'wrest/core_ext/hash/conversions'
+
+class Hash # :nodoc:
   include Wrest::CoreExt::Hash::Conversions
 end

data/lib/wrest/core_ext/string/conversions.rb

@@ -1,19 +1,21 @@
+# 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. 
-# 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. 
+# 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.
 
 module Wrest
-  module CoreExt #:nodoc:
-    module String #:nodoc:
+  module CoreExt # :nodoc:
+    module String # :nodoc:
       # Makes it easier to build other objects from a String
       # This module is opt-out - if you don't want the to_uri
-      # and to_uri_template convenience method on String, set 
-      # the NoStringExtensions constant on the Wrest module 
+      # and to_uri_template convenience method on String, set
+      # the NoStringExtensions constant on the Wrest module
       # before requiring wrest.
       #
       #   module Wrest
@@ -21,15 +23,14 @@ module Wrest
       #   end
       #   require 'wrest'
       module Conversions
-
         # A convenience method equivalent to Wrest::Uri.new(string)
         def to_uri(options = {})
-          Wrest::Uri.new(self.strip, options)
+          Wrest::Uri.new(strip, options)
         end
 
         # A convenience method equivalent to Wrest:UriTemplate.new(uri_pattern)
         def to_uri_template(options = {})
-          Wrest::UriTemplate.new(self.strip, options)
+          Wrest::UriTemplate.new(strip, options)
         end
       end
     end

data/lib/wrest/core_ext/string.rb

@@ -1,5 +1,7 @@
-require "wrest/core_ext/string/conversions"
+# frozen_string_literal: true
 
-class String #:nodoc:
+require 'wrest/core_ext/string/conversions'
+
+class String # :nodoc:
   include Wrest::CoreExt::String::Conversions unless Wrest.const_defined?('NoStringExtensions')
-end
+end

data/lib/wrest/exceptions.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Wrest
-  module Exceptions #:nodoc:
+  module Exceptions # :nodoc:
     # Raised when a base method that should be overriden
     # is invoked on a subclass that has not implemented it.
     class MethodNotOverridden < StandardError
@@ -26,7 +28,7 @@ module Wrest
     # Raised when a request times out
     class Timeout < StandardError
     end
-    
+
     class UnsupportedHttpVerb < StandardError
     end
 

data/lib/wrest/hash_with_case_insensitive_access.rb

@@ -1,5 +1,6 @@
-module Wrest
+# frozen_string_literal: true
 
+module Wrest
   # A hash with case-insensitive key access.
   #
   #   hash = Wrest::HashWithCaseInsensitiveAccess.new 'Abcd' => 1, 'xyz' => 2
@@ -7,14 +8,14 @@ module Wrest
   #   hash['abcd']  #=> 1
   #   hash['aBCd'] #=> 1
   #
-  class HashWithCaseInsensitiveAccess < ::Hash #:nodoc:
-
-    def initialize(hash={})
+  class HashWithCaseInsensitiveAccess < ::Hash # :nodoc:
+    def initialize(hash = {})
       super()
       hash.each do |key, value|
         self[convert_key(key)] = value
       end
     end
+
     def [](key)
       super(convert_key(key))
     end
@@ -44,9 +45,8 @@ module Wrest
 
     protected
 
-      def convert_key(key)
-        key.is_a?(String) ? key.downcase : key
-      end
-
+    def convert_key(key)
+      key.is_a?(String) ? key.downcase : key
+    end
   end
 end