= ietfbib

image:https://img.shields.io/gem/v/rfcbib.svg["Gem Version", link="https://rubygems.org/gems/rfcbib"]
image:https://img.shields.io/travis/metanorma/ietfbib/master.svg["Build Status", link="https://travis-ci.org/metanorma/ietfbib"]
image:https://ci.appveyor.com/api/projects/status/eirsba4v3nviejs4?svg=true["Appveyor Build Status", link="https://ci.appveyor.com/project/ribose/ietfbib"]
image:https://codeclimate.com/github/metanorma/ietfbib/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/ietfbib"]

_Formerly known as_ `rfcbib`.

ietfbib is a Ruby gem that search and fetch standards from the https://www.ietf.org[Internet Engineering Task Force (IETF)], including RFCs.

The standards scrape form https://www.rfc-editor.org/search/rfc_search.php

== Installation

Add this line to your application's Gemfile:

[source, ruby]
----
gem 'ietfbib'
----

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install ietfbib

== Usage

=== Search document

[source,ruby]
----
item = IETFBib::RfcBibliography.search 'RFC 8341'
=> #<IsoBibItem::BibliographicItem:0x007fdb0803a0f8>

# Return nil if document doesn't exist.
IETFBib::RfcBibliography.search '1111'
=> nil
----

=== Serialization

[source,ruby]
----
item.to_xml
=>"<bibitem id='RFC8341'>
  <title format='plain' language='en' script='Latn'>Network Configuration Access Control Model</title>
  <link type='src'>https://www.rfc-editor.org/info/rfc8341</link>
  <date type='published'>
    <on>2018</on>
  </date>
  <contributor>
    <role type='author'/>
    <person>
      <name>
        <completename language='en'>A. Bierman</completename>
      </name>
      <affilation>
        <organization>
          <name/>
          <abbreviation>IETF</abbreviation>
        </organization>
      </affilation>
    </person>
  </contributor>
  <contributor>
    <role type='author'/>
    <person>
      <name>
        <completename language='en'>M. Bjorklund</completename>
      </name>
      <affilation>
        <organization>
          <name/>
          <abbreviation>IETF</abbreviation>
        </organization>
      </affilation>
    </person>
  </contributor>
  <language>en</language>
</bibitem>"
----

== Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ietfbib.

== License

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