= RelatonIeee RelatonIeee is a Ruby gem that implements the https://github.com/relaton/relaton-model-ieee#ieee-bibliographic-item-model[IeeeBibliographicItem model]. You can use it to retrieve metadata of IEEE Standards from standards.ieee.org, and access such metadata through the `IeeeBibliographicItem` object. == Installation Add this line to your application's Gemfile: [source,ruby] ---- gem 'relaton-ieee' ---- And then execute: $ bundle install Or install it yourself as: $ gem install relaton-ieee == Usage === Search for a standard using keywords [source,ruby] ---- require 'relaton_ieee' => true hits = RelatonIeee::IeeeBibliography.search("IEEE 528-2019") => item = hits[0].fetch => # " 2020-06-01 IEEE 528-2019 - IEEE Standard for Inertial Sensor Terminology https://standards.ieee.org/content/ieee-standards/en/standard/528-2019.html IEEE 528-2019 2019 2019 Ashley Moran en Terms and definitions relating to inertial sensors are presented in this standard. Usage as understood by the inertial sensor community is given preference over general technical usage of the terms herein. The criterion for inclusion of a term and its definition in this standard is usefulness as related to inertial sensor technology. Active " ---- With argument `bibdata: true` it ouputs XML wrapped by `bibdata` element and adds flavour `ext` element. [source,ruby] ---- item.to_xml bibdata: true => " 2020-06-01 IEEE 528-2019 - IEEE Standard for Inertial Sensor Terminology https://standards.ieee.org/content/ieee-standards/en/standard/528-2019.html IEEE 528-2019 2019 2019 Ashley Moran en Terms and definitions relating to inertial sensors are presented in this standard. Usage as understood by the inertial sensor community is given preference over general technical usage of the terms herein. The criterion for inclusion of a term and its definition in this standard is usefulness as related to inertial sensor technology. Active AES/GA - Gyro Accelerometer Panel SENSR_WG - Sensors Working Group Harry Davis IEEE Aerospace and Electronic Systems Society " ---- === Get document by reference [source,ruby] ---- RelatonIeee::IeeeBibliography.get("IEEE 528-2019") [relaton-ieee] ("IEEE 528-2019") fetching... [relaton-ieee] ("IEEE 528-2019") found 528-2019 => # # # # {"id"=>"528-2019", "title"=>{ ... RelatonIeee::IeeeBibliographicItem.from_hash hash => # nil ---- == 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/relaton/relaton_ieee. == License The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).