https://github.com/cored/xml_matchers

Validate your XML API responses
https://github.com/cored/xml_matchers

matchers rspec rspec-matchers xml

Last synced: 11 days ago
JSON representation

Validate your XML API responses

• Host: GitHub
• URL: https://github.com/cored/xml_matchers
• Owner: cored
• License: mit
• Created: 2018-07-15T21:49:43.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-07-17T23:32:02.000Z (over 6 years ago)
• Last Synced: 2025-01-07T19:24:54.847Z (26 days ago)
• Topics: matchers, rspec, rspec-matchers, xml
• Language: Ruby
• Size: 16.6 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# XmlMatchers

Validates XML against XSD (XML schemas)

## Installation

Add this line to your application's Gemfile:

```ruby

group :test do

  gem "xml_matchers"

end

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install xml_matchers

## Usage

Inspired by [json_matchers](https://github.com/thoughtbot/json_matchers)

First configure it in your test suite's helper file:

### Rspec

`spec/spec_helper`

```ruby

require "xml_matchers/rspec"

```

## Declare

Declare your XML Schema wherever you see fit for your project structure:

eg.  `spec/support/xml/schemas/locations.xsd`

## Validate

Validate an XML response or an String against an XML schema with

`match_xml_schema`:

```ruby

describe "GET /locations" do

  let(:locations_xml_schema) do

    File.read("#{File.pwd}/spec/support/xml/schemas/locations.xsd")

  end

  it "returns locations" do

    get locations_path, format: :xml

    expect(response.status).to eq 200

    expect(response.body).to match_xml_schema(locations_xml_schema)

  end

end

```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/xml_matchers. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the XmlMatchers project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/xml_matchers/blob/master/CODE_OF_CONDUCT.md).