fog-xml 0.1.0 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ce8f9b8d09cf440bc8510dbf67d2cc23d4fcec4b
-  data.tar.gz: 529565cb7aa30250af6877f4fdaec10d6e9f043e
+SHA256:
+  metadata.gz: f20443f996f68c6657e65d1997355153ff80094d68fbe227a52e43298f6b216a
+  data.tar.gz: 0f1234f7218d87805b644e4c8797b0f11209217c048e61669d838057c0b64b9e
 SHA512:
-  metadata.gz: 4343f03be19f667da0a02a475976974f4ce0670908c45beb95dfd69a15a5df0dc12999e17e05e0ac1ab0552dd68c53a4776efb27921b877e4aabb696b6685660
-  data.tar.gz: 963c88b5c7326f967f9df6b8280ef8ad9d5e89e46b0ffd269a23a2518aa563c79e2b512a99b8e8cc3532721915ec33a65733e4d3bd590aeef8b0d2a9fb175909
+  metadata.gz: c3965c992d6845bd68a637c825fd3133fb80eb23b7956bbd4b81ecb56f24343f62815c0ca13ce5b4168e40e102a636df1bd80374e32e413e950694e423e57b61
+  data.tar.gz: 5f6e0f9b03ffeb84212d085148d5b776c1fe7613d61f44dc99129f4707b74c3eb46dc4baaf5476f35d4d7cd941a56b0425f103d119a21750b9ec6765cf8c85a5

data/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/ruby.yml

@@ -0,0 +1,34 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.5', '2.6', '2.7', '3.0', 'head']
+
+    steps:
+    - uses: actions/checkout@v2.3.4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/.github/workflows/stale.yml

@@ -0,0 +1,23 @@
+name: Mark stale issues and pull requests
+
+on:
+  schedule:
+  - cron: "30 1 * * *"
+
+jobs:
+  stale:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/stale@v4
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        days-before-stale: 60
+        days-before-close: 7
+        exempt-issue-labels: 'pinned,security'
+        exempt-pr-labels: 'pinned,security'
+        stale-issue-message: 'This issue has been marked inactive and will be closed if no further activity occurs.'
+        stale-pr-message: 'This pr has been marked inactive and will be closed if no further activity occurs.'
+        stale-issue-label: 'no-issue-activity'
+        stale-pr-label: 'no-pr-activity'

data/CONTRIBUTORS.md

@@ -1,4 +1,5 @@
 * Michael Hale <mike@hales.ws>
 * Paul Thornthwaite <tokengeek@gmail.com>
 * Paulo Henrique Lopes Ribeiro <plribeiro3000@gmail.com>
-* Wesley Beary <geemus@gmail.com>
+* Wesley Beary <geemus@gmail.com>
+* Tomer Brisker <tbrisker@gmail.com>

data/README.md

@@ -1,6 +1,8 @@
 # Fog::Xml
 
-TODO: Write a gem description
+Shared XML related functionality for fog
+
+![Gem Version](https://badge.fury.io/rb/fog-xml.svg) [![Build Status](https://travis-ci.org/fog/fog-xml.svg?branch=master)](https://travis-ci.org/fog/fog-xml) [![Dependency Status](https://gemnasium.com/fog/fog-xml.svg)](https://gemnasium.com/fog/fog-xml) [![Coverage Status](https://img.shields.io/coveralls/fog/fog-xml.svg)](https://coveralls.io/r/fog/fog-xml?branch=master) [![Code Climate](https://codeclimate.com/github/fog/fog-xml/badges/gpa.svg)](https://codeclimate.com/github/fog/fog-xml)
 
 ## Installation
 
@@ -22,7 +24,7 @@ TODO: Write usage instructions here
 
 ## Contributing
 
-1. Fork it ( https://github.com/zertico/fog-xml/fork )
+1. Fork it ( https://github.com/fog/fog-xml/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/fog-xml.gemspec

@@ -14,17 +14,21 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/fog/fog-xml"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
+  files              = `git ls-files -z`.split("\x0")
+  files.delete(".hound.yml")
+  spec.files = files
+
   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.required_ruby_version = '>= 2.0.0'
+
   spec.add_dependency "fog-core"
-  spec.add_dependency "nokogiri", "~> 1.5", ">= 1.5.11"
+  spec.add_dependency "nokogiri", ">= 1.5.11", "< 2.0.0" #pinned for 2.0 support
   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
+  spec.add_development_dependency "coveralls"
 end

data/gemfiles/Gemfile.1.9.3+

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

data/lib/fog/parsers/base.rb

@@ -0,0 +1,48 @@
+require "nokogiri"
+
+module Fog
+  module Parsers
+    class Base < Nokogiri::XML::SAX::Document
+      attr_reader :response
+
+      def initialize
+        reset
+      end
+
+      def attr_value(name, attrs)
+        (entry = attrs.find {|a| a.localname == name }) && entry.value
+      end
+
+      def reset
+        @response = {}
+      end
+
+      def characters(string)
+        @value ||= ''
+        @value << string
+      end
+
+      # ###############################################################################
+      # This is a workaround. Original implementation from Nokogiri is overwritten with
+      # one that does not join namespace prefix with local name.
+      def start_element_namespace name, attrs = [], prefix = nil, uri = nil, ns = []
+        start_element name, attrs
+      end
+
+      def end_element_namespace name, prefix = nil, uri = nil
+        end_element name
+      end
+
+      # ###############################################################################
+
+      def start_element(name, attrs = [])
+        @value = nil
+      end
+
+      def value
+        @value && @value.dup
+      end
+    end
+  end
+end
+

data/lib/fog/xml/response.rb

@@ -0,0 +1,26 @@
+module Fog
+  module XML
+    class Response
+      def initialize(parser)
+        @parser = parser
+        @data_stream = Nokogiri::XML::SAX::PushParser.new(parser)
+        @response_string = ""
+      end
+
+      def call(chunk, _remaining, _total)
+        @response_string << chunk if ENV["DEBUG_RESPONSE"]
+        @data_stream << chunk
+      end
+
+      def rewind
+        @parser.reset
+        @response_string = ""
+      end
+
+      def finish
+        Fog::Logger.debug "\n#{@response_string}" if ENV["DEBUG_RESPONSE"]
+        @data_stream.finish
+      end
+    end
+  end
+end

data/lib/fog/xml/sax_parser_connection.rb

@@ -1,5 +1,3 @@
-require "fog/core/connection"
-
 module Fog
   module XML
     class SAXParserConnection < ::Fog::Core::Connection
@@ -25,20 +23,13 @@ module Fog
       def request(parser, params)
         reset unless @persistent
 
-        # 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"]
-          data_stream << chunk
-        end
+        params[:response_block] = ::Fog::XML::Response.new(parser)
 
         # Make request which read chunks into parser
         response = @excon.request(params)
-        Fog::Logger.debug "\n#{response_string}" if ENV["DEBUG_RESPONSE"]
 
         # Cease parsing and override response.body with parsed data
-        data_stream.finish
+        params[:response_block].finish
         response.body = parser.response
         response
       end

data/lib/fog/xml/version.rb

@@ -1,5 +1,5 @@
 module Fog
   module Xml
-    VERSION = "0.1.0"
+    VERSION = "0.1.4"
   end
 end

data/lib/fog/xml.rb

@@ -1,11 +1,17 @@
-require "fog/xml/version"
+require "fog/core"
 require "nokogiri"
+require File.expand_path("../xml/version", __FILE__)
 
 module Fog
-  autoload :ToHashDocument, "fog/to_hash_document"
+  autoload :ToHashDocument, File.expand_path("../to_hash_document", __FILE__)
 
   module XML
-    autoload :SAXParserConnection, "fog/xml/sax_parser_connection"
-    autoload :Connection, "fog/xml/connection"
+    autoload :SAXParserConnection, File.expand_path("../xml/sax_parser_connection", __FILE__)
+    autoload :Connection, File.expand_path("../xml/connection", __FILE__)
+    autoload :Response, File.expand_path("../xml/response", __FILE__)
+  end
+
+  module Parsers
+    autoload :Base, File.expand_path("../parsers/base", __FILE__)
   end
 end

data/spec/fog/parsers/base_spec.rb

@@ -0,0 +1,73 @@
+require "minitest_helper"
+
+describe Fog::Parsers::Base do
+  
+  def parse(input, parser_class)
+    document = parser_class.new
+    parser = Nokogiri::XML::SAX::Parser.new(document)
+    parser.parse input
+    document.response
+  end
+
+  describe 'value' do
+    class ValueTest < Fog::Parsers::Base
+
+      def start_element(name, attrs)
+        @stack.push({})
+        super
+      end
+
+      def reset
+        super
+        @stack = [@response]
+      end
+
+      def end_element name
+        top = @stack.pop
+        if top.empty?
+          @stack.last[name] = value
+        else
+          @stack.last[name] = top if @stack.any?
+        end
+      end
+
+    end
+
+    it 'extracts the characters for the current element' do
+      doc = <<-XML
+      <Test>
+        <Foo>FooValue</Foo>
+        <Bar>BarValue</Bar>
+      </Test>
+      XML
+      assert_equal({'Test'=> {'Foo' => 'FooValue', 'Bar' => 'BarValue'}}, parse(doc, ValueTest))
+    end
+  end
+
+  describe 'attr_value' do
+    class AttrParser < Fog::Parsers::Base
+      def start_element(name, attrs=[])
+        super
+        @response[name] = {'foo' => attr_value('foo', attrs)}
+      end
+    end
+
+    describe 'the attribute exists' do
+      it 'returns the value' do
+        doc = <<-XML
+        <Test foo="bar" />
+        XML
+        assert_equal({'Test'=> {'foo' => 'bar'}}, parse(doc, AttrParser))
+      end
+    end
+
+    describe 'the attribute does not exist' do
+      it 'returns nil' do
+        doc = <<-XML
+        <Test notfoo="bar" />
+        XML
+        assert_equal({'Test'=> {'foo' => nil}}, parse(doc, AttrParser))
+      end
+    end
+  end
+end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: fog-xml
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.4
 platform: ruby
 authors:
 - Wesley Beary (geemus)
 - Paul Thornthwaite (tokengeek)
 - The fog team
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-09-26 00:00:00.000000000 Z
+date: 2021-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-core
@@ -30,22 +30,22 @@ dependencies:
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.11
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.11
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -102,20 +102,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -140,11 +126,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ruby.yml"
+- ".github/workflows/stale.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-gemset"
-- ".ruby-version"
-- ".travis.yml"
 - CONTRIBUTING.md
 - CONTRIBUTORS.md
 - Gemfile
@@ -152,20 +139,22 @@ files:
 - README.md
 - Rakefile
 - fog-xml.gemspec
-- gemfiles/Gemfile.1.8.7
-- gemfiles/Gemfile.1.9.2+
+- gemfiles/Gemfile.1.9.3+
+- lib/fog/parsers/base.rb
 - lib/fog/to_hash_document.rb
 - lib/fog/xml.rb
 - lib/fog/xml/connection.rb
+- lib/fog/xml/response.rb
 - lib/fog/xml/sax_parser_connection.rb
 - lib/fog/xml/version.rb
+- spec/fog/parsers/base_spec.rb
 - spec/fog/xml/connection_spec.rb
 - spec/minitest_helper.rb
 homepage: https://github.com/fog/fog-xml
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -173,18 +162,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: XML parsing for fog providers
 test_files:
+- spec/fog/parsers/base_spec.rb
 - spec/fog/xml/connection_spec.rb
 - spec/minitest_helper.rb

data/.ruby-version

@@ -1 +0,0 @@
-2.1.2

data/.travis.yml

@@ -1,21 +0,0 @@
-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

data/gemfiles/Gemfile.1.8.7

@@ -1,8 +0,0 @@
-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 => '../'

data/gemfiles/Gemfile.1.9.2+

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