Making some improvements

Author: plribeiro3000

.gitignore

@@ -20,3 +20,4 @@ tmp
 *.o
 *.a
 mkmf.log
+gemfiles/*.lock

.rubocop.yml

@@ -0,0 +1,20 @@
+Metrics/LineLength:
+  Enabled: false
+
+Style/EachWithObject:
+  Enabled: false
+
+Style/Encoding:
+  EnforcedStyle: when_needed
+
+Style/FormatString:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

.travis.yml

@@ -0,0 +1,21 @@
+matrix:
+  include:
+    - rvm: 1.8.7
+      gemfile: gemfiles/Gemfile.1.8.7
+    - rvm: 1.9.2
+      gemfile: gemfiles/Gemfile.1.9.2+
+      env: COVERAGE=true
+    - rvm: 1.9.3
+      gemfile: gemfiles/Gemfile.1.9.2+
+      env: COVERAGE=true
+    - rvm: 2.0.0
+      gemfile: gemfiles/Gemfile.1.9.2+
+      env: COVERAGE=true
+    - rvm: 2.1.1
+      gemfile: gemfiles/Gemfile.1.9.2+
+      env: COVERAGE=true
+    - rvm: ree
+      gemfile: gemfiles/Gemfile.1.8.7
+    - rvm: jruby
+      gemfile: gemfiles/Gemfile.1.9.2+
+      env: COVERAGE=true

CONTRIBUTING.md

@@ -5,14 +5,14 @@ New contributors are always welcome, when it doubt please ask questions. We stri
 ### Coding
 
 * Pick a task:
-  * Offer feedback on open [pull requests](https://github.com/zertico/fog-xml/pulls).
-  * Review open [issues](https://github.com/zertico/fog-xml/issues) for things to help on.
-  * [Create an issue](https://github.com/zertico/fog-xml/issues/new) to start a discussion on additions or features.
+  * Offer feedback on open [pull requests](https://github.com/fog/fog-xml/pulls).
+  * Review open [issues](https://github.com/fog/fog-xml/issues) for things to help on.
+  * [Create an issue](https://github.com/fog/fog-xml/issues/new) to start a discussion on additions or features.
 * Fork the project, add your changes and tests to cover them in a topic branch.
-* Commit your changes and rebase against `zertico/fog-xml` to ensure everything is up to date.
-* [Submit a pull request](https://github.com/zertico/fog-xml/compare/)
+* Commit your changes and rebase against `fog/fog-xml` to ensure everything is up to date.
+* [Submit a pull request](https://github.com/fog/fog-xml/compare/)
 
 ### Non-Coding
 
-* Offer feedback on open [issues](https://github.com/zertico/fog-xml/issues).
+* Offer feedback on open [issues](https://github.com/fog/fog-xml/issues).
 * Organize or volunteer at events.

CONTRIBUTORS.md

@@ -1 +1,4 @@
-* Paulo Henrique Lopes Ribeiro <[email protected]>
+* Michael Hale <[email protected]>
+* Paul Thornthwaite <[email protected]>
+* Paulo Henrique Lopes Ribeiro <[email protected]>
+* Wesley Beary <[email protected]>

Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in fog-xml.gemspec
 gemspec

Rakefile

@@ -1,2 +1,11 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
 
+Rake::TestTask.new do |t|
+  t.libs.push %w(spec)
+  t.test_files = FileList["spec/**/*_spec.rb"]
+  t.verbose = true
+end
+
+desc "Default Task"
+task :default => [:test]

fog-xml.gemspec

@@ -1,26 +1,30 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'fog/xml/version'
+require "fog/xml/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "fog-xml"
   spec.version       = Fog::Xml::VERSION
-  spec.authors       = %q(Paulo Henrique Lopes Ribeiro)
-  spec.email         = %q(plribeiro3000@gmail.com)
-  spec.summary       = %q{XML parsing for fog providers}
-  spec.description   = %q{Extraction of the XML parsing tools shared between a
-                          number of providers in the 'fog' gem}
-  spec.homepage      = 'https://github.com/zertico/fog-xml'
-  spec.license       = 'MIT'
+  spec.authors       = ["Wesley Beary (geemus)", "Paul Thornthwaite (tokengeek)", "The fog team"]
+  spec.email         = ["geemus@gmail.com", "[email protected]"]
+  spec.summary       = "XML parsing for fog providers"
+  spec.description   = "Extraction of the XML parsing tools shared between a
+                          number of providers in the 'fog' gem"
+  spec.homepage      = "https://github.com/fog/fog-xml"
+  spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
   spec.require_paths = %w(lib)
 
-  spec.add_dependency 'fog-core'
-  spec.add_dependency 'nokogiri', '~> 1.5', '>= 1.5.11'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
+  spec.add_dependency "fog-core"
+  spec.add_dependency "nokogiri", "~> 1.5", ">= 1.5.11"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "turn"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "coveralls" if RUBY_VERSION.to_f >= 1.9
 end

gemfiles/Gemfile.1.8.7

@@ -0,0 +1,8 @@
+source :rubygems
+
+gem 'mime-types', '< 2.0'
+gem 'nokogiri', '< 1.6'
+gem 'rest-client', '~> 1.6.8'
+gem 'fog-core', :github => 'fog/fog-core'
+
+gemspec :path => '../'

gemfiles/Gemfile.1.9.2+

@@ -0,0 +1,7 @@
+source :rubygems
+
+gem 'activesupport', '>= 3.0', '< 4'
+gem 'mime-types', '< 2.0'
+gem 'fog-core', :github => 'fog/fog-core'
+
+gemspec :path => '../'

lib/fog/to_hash_document.rb

@@ -0,0 +1,64 @@
+module Fog
+  class ToHashDocument < Nokogiri::XML::SAX::Document
+    def initialize
+      @stack = []
+    end
+
+    def characters(string)
+      @value ||= ""
+      @value << string.strip
+    end
+
+    def end_element(name)
+      last = @stack.pop
+      if last.empty? && @value.empty?
+        @stack.last[name.to_sym] = ""
+      elsif last == { :i_nil => "true" }
+        @stack.last[name.to_sym] = nil
+      elsif !@value.empty?
+        @stack.last[name.to_sym] = @value
+      end
+      @value = ""
+    end
+
+    def body
+      @stack.first
+    end
+
+    def response
+      body
+    end
+
+    def start_element(name, attributes = [])
+      @value = ""
+      parsed_attributes = {}
+      until attributes.empty?
+        if attributes.first.is_a?(Array)
+          key, value = attributes.shift
+        else
+          key, value = attributes.shift, attributes.shift
+        end
+        parsed_attributes[key.gsub(":", "_").to_sym] = value
+      end
+      if @stack.last.is_a?(Array)
+        @stack.last << { name.to_sym => parsed_attributes }
+      else
+        data = if @stack.empty?
+                 @stack.push(parsed_attributes)
+                 parsed_attributes
+               elsif @stack.last[name.to_sym]
+                 unless @stack.last[name.to_sym].is_a?(Array)
+                   @stack.last[name.to_sym] = [@stack.last[name.to_sym]]
+                 end
+                 @stack.last[name.to_sym] << parsed_attributes
+                 @stack.last[name.to_sym].last
+               else
+                 @stack.last[name.to_sym] = {}
+                 @stack.last[name.to_sym].merge!(parsed_attributes)
+                 @stack.last[name.to_sym]
+               end
+        @stack.push(data)
+      end
+    end
+  end
+end

lib/fog/xml.rb

@@ -1,9 +1,11 @@
-require 'fog/xml/version'
-require 'nokogiri'
+require "fog/xml/version"
+require "nokogiri"
 
 module Fog
-  module Xml
-    autoload :SAXParserConnection, 'fog/xml/sax_parser_connection'
-    autoload :Connection, 'fog/xml/connection'
+  autoload :ToHashDocument, "fog/to_hash_document"
+
+  module XML
+    autoload :SAXParserConnection, "fog/xml/sax_parser_connection"
+    autoload :Connection, "fog/xml/connection"
   end
 end

lib/fog/xml/connection.rb

@@ -1,13 +1,14 @@
 module Fog
-  module Xml
+  module XML
     class Connection < SAXParserConnection
-      def request(params, &block)
-        if (parser = params.delete(:parser))
+      def request(params, &_block)
+        parser = params.delete(:parser)
+        if parser
           super(parser, params)
         else
           original_request(params)
         end
       end
     end
   end
-end
+end

lib/fog/xml/sax_parser_connection.rb

@@ -1,18 +1,18 @@
-require 'fog/core/connection'
+require "fog/core/connection"
 
 module Fog
-  module Xml
+  module XML
     class SAXParserConnection < ::Fog::Core::Connection
       # Makes a request using the connection using Excon
       #
       # @param [Hash] params
       # @option params [String] :body text to be sent over a socket
       # @option params [Hash<Symbol, String>] :headers The default headers to supply in a request
-      # @option params [String] :host The destination host's reachable DNS name or IP, in the form of a String
-      # @option params [String] :path appears after 'scheme://host:port/'
+      # @option params [String] :host The destination host"s reachable DNS name or IP, in the form of a String
+      # @option params [String] :path appears after "scheme://host:port/"
       # @option params [Fixnum] :port The port on which to connect, to the destination host
-      # @option params [Hash]   :query appended to the 'scheme://host:port/path/' in the form of '?key=value'
-      # @option params [String] :scheme The protocol; 'https' causes OpenSSL to be used
+      # @option params [Hash]   :query appended to the "scheme://host:port/path/" in the form of "?key=value"
+      # @option params [String] :scheme The protocol; "https" causes OpenSSL to be used
       # @option params [Proc] :response_block
       # @option params [Nokogiri::XML::SAX::Document] :parser
       #
@@ -28,14 +28,14 @@ def request(parser, params)
         # Prepare the SAX parser
         data_stream = Nokogiri::XML::SAX::PushParser.new(parser)
         response_string = ""
-        params[:response_block] = lambda do |chunk, remaining, total|
-          response_string << chunk if ENV['DEBUG_RESPONSE']
+        params[:response_block] = lambda do |chunk, _remaining, _total|
+          response_string << chunk if ENV["DEBUG_RESPONSE"]
           data_stream << chunk
         end
 
         # Make request which read chunks into parser
         response = @excon.request(params)
-        Fog::Logger.debug "\n#{response_string}" if ENV['DEBUG_RESPONSE']
+        Fog::Logger.debug "\n#{response_string}" if ENV["DEBUG_RESPONSE"]
 
         # Cease parsing and override response.body with parsed data
         data_stream.finish
@@ -44,4 +44,4 @@ def request(parser, params)
       end
     end
   end
-end
+end

spec/fog/xml/connection_spec.rb

@@ -0,0 +1,32 @@
+require "minitest_helper"
+
+describe Fog::XML::Connection do
+  before do
+    @connection = Fog::XML::Connection.new("http://localhost")
+  end
+
+  after do
+    Excon.stubs.clear
+  end
+
+  it "responds to #request" do
+    assert_respond_to @connection, :request
+  end
+
+  describe "when request is passed a parser" do
+    it "returns the body after parsing" do
+      @parser = Fog::ToHashDocument.new
+      Excon.stub({}, { :status => 200, :body => "<xml></xml>" })
+      response = @connection.request(:parser => @parser, :mock => true)
+      assert_equal({ :xml => "" }, response.body)
+    end
+  end
+
+  describe "when request excludes a parser" do
+    it "returns the response body without change" do
+      Excon.stub({}, { :status => 200, :body => "<xml></xml>" })
+      response = @connection.request(:mock => true)
+      assert_equal("<xml></xml>", response.body)
+    end
+  end
+end

spec/minitest_helper.rb

@@ -0,0 +1,33 @@
+require "minitest/spec"
+require "minitest/autorun"
+require "turn"
+require "excon"
+require "fog/core"
+
+Turn.config do |c|
+  # use one of output formats:
+  # :outline  - turn's original case/test outline mode [default]
+  # :progress - indicates progress with progress bar
+  # :dotted   - test/unit's traditional dot-progress mode
+  # :pretty   - new pretty reporter
+  # :marshal  - dump output as YAML (normal run mode only)
+  # :cue      - interactive testing
+  # c.format  = :outline
+  # turn on invoke/execute tracing, enable full backtrace
+  c.trace   = 20
+  # use humanized test names (works only with :outline format)
+  c.natural = true
+end
+
+if ENV["COVERAGE"]
+  require "coveralls"
+  require "simplecov"
+
+  SimpleCov.start do
+    add_filter "/spec/"
+  end
+end
+
+require File.join(File.dirname(__FILE__), "../lib/fog/xml")
+
+Coveralls.wear! if ENV["COVERAGE"]