rfcbib 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7efca45eeb81da661be8978f11a8c042cada52ad1afcf7f83778c61ff42cb95c
+  data.tar.gz: d62cbf6337e4888925de63b0074144b971370e967ad3440ee67d9236548d4277
+SHA512:
+  metadata.gz: 53d845481efaf30667074e82c9808385d346ac9907701b1869f634e2118f8d4f4cf0bee37daa84ef4063cf256f535449e78b00a49c5eba01215f60119dd00459
+  data.tar.gz: 76610c06062009a941b6bb8d31ae75ed9e11ad617ef0374ca809e5ea1a661d29bf43e55272b29276eb9a9d747ac79cbe3e080fd8036abd796ed151050e3cfc41

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.vscode/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,4 @@
+AllCops:
+  TargetRubyVersion: 2.4.0
+Metrics/BlockLength:
+  ExcludedMethods: ['describe', 'context']

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,9 @@
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rfcbib.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    rfcbib (0.1.0)
+      iso-bib-item (~> 0.1.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (10.0.2)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    duplicate (1.1.1)
+    equivalent-xml (0.6.0)
+      nokogiri (>= 1.4.3)
+    iso-bib-item (0.1.10)
+      duplicate
+      isoics (~> 0.1.6)
+      nokogiri
+    isoics (0.1.6)
+    json (2.1.0)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.3)
+      mini_portile2 (~> 2.3.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  equivalent-xml (~> 0.6)
+  pry-byebug
+  rake (~> 10.0)
+  rfcbib!
+  rspec (~> 3.0)
+  simplecov
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Andrei Kislichenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.adoc

@@ -0,0 +1,86 @@
+= Rfcbib
+
+RFCBib is a Ruby gem that search and fetch RFC standards.
+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 'rfcbib'
+----
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rfcbib
+
+== Usage
+
+=== Search document
+
+[source,ruby]
+----
+item = RfcBib::RfcBibliography.search 'RFC 8341'
+=> #<IsoBibItem::BibliographicItem:0x007fdb0803a0f8>
+
+# Return nil if document doesn't exist.
+RfcBib::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]/rfcbib.
+
+== License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rfcbib"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rfcbib/rfc_bibliography.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal:true
+
+require 'rfcbib/scrapper'
+
+module RfcBib
+  # RFC bibliography module
+  module RfcBibliography
+    class << self
+      def search(text)
+        Scrapper.scrape_page text
+      end
+    end
+  end
+end

data/lib/rfcbib/scrapper.rb

@@ -0,0 +1,204 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'nokogiri'
+require 'iso_bib_item'
+
+module RfcBib
+  # rubocop:disable Metrics/ModuleLength
+
+  # Scrapper module
+  module Scrapper
+    class << self
+      # @param text [String]
+      # @return [IsoBibItem::BibliographicItem]
+      def scrape_page(text)
+        ref = text.sub(' ', '.') + '.xml'
+        uri = URI("https://www.rfc-editor.org/refs/bibxml/reference.#{ref}")
+        doc = Nokogiri::HTML Net::HTTP.get(uri)
+        @reference = doc.at('//reference')
+        return unless @reference
+        bib_item
+      end
+
+      private
+
+      # rubocop:disable Metrics/MethodLength
+
+      # @return [IsoBibItem::BibliographicItem]
+      def bib_item
+        IsoBibItem::BibliographicItem.new(
+          id: @reference[:anchor],
+          docid: docids,
+          status: status,
+          language: [language],
+          link: [{ type: 'src', content: @reference[:target] }],
+          titles: titles,
+          contributors: contributors,
+          dates: dates,
+          series: series
+        )
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      # @return [String]
+      def language
+        @reference[:lang] || 'en'
+      end
+
+      # @return [Array<Hash>]
+      def titles
+        title = @reference.at('//front/title')
+        [{ content: title.text, language: language, script: 'Latn' }]
+      end
+
+      # @return [Array<Hash>]
+      def contributors
+        persons + organizations
+      end
+
+      # @return [Array<Hash{Symbol=>IsoBibItem::Person,Symbol=>Array<String>}>]
+      def persons
+        @reference.xpath('//front/author').map do |author|
+          entity = IsoBibItem::Person.new(
+            name: full_name(author),
+            affilation: [affilation(author)],
+            contacts: contacts(author.at('//address'))
+          )
+          { entity: entity, roles: [contributor_role(author)] }
+        end
+      end
+
+      # @return [Array<Hash{Symbol=>IsoBibItem::Organization,Symbol=>Array<String>}>]
+      def organizations
+        @reference.xpath('//seriesinfo').map do |si|
+          next unless si[:stream]
+          entity = IsoBibItem::Organization.new name: si[:stream]
+          { entity: entity, roles: ['author'] }
+        end.compact
+      end
+
+      # @param author [Nokogiri::XML::Document]
+      # @return [IsoBibItem::FullName]
+      def full_name(author)
+        IsoBibItem::FullName.new(
+          completename: localized_string(author[:fullname]),
+          initials: [localized_string(author[:initials])],
+          surname: [localized_string(author[:surname])]
+        )
+      end
+
+      # @param content [String]
+      # @return [IsoBibItem::LocalizedString]
+      def localized_string(content)
+        IsoBibItem::LocalizedString.new(content, language)
+      end
+
+      # @param postal [Nokogiri::XML::Document]
+      # @return [Array<IsoBibItem::Address, IsoBibItem::Phone>]
+      def contacts(addr)
+        contacts = []
+        return contacts unless addr
+        postal = addr.at('//postal')
+        contacts << address(postal) if postal
+        add_contact(contacts, 'phone', addr.at('//phone'))
+        add_contact(contacts, 'email', addr.at('//email'))
+        add_contact(contacts, 'uri', addr.at('//uri'))
+        contacts
+      end
+
+      # @param postal [Nokogiri::XML::Document]
+      # @rerurn [IsoBibItem::Address]
+      def address(postal)
+        IsoBibItem::Address.new(
+          street: [(postal.at('//postalLine') || postal.at('//street')).text],
+          city: postal.at('//city').text,
+          postcode: postal.at('//code').text,
+          country: postal.at('//country').text,
+          state: postal.at('//region').text
+        )
+      end
+
+      # @param type [String] allowed "phone", "email" or "uri"
+      # @param value [String]
+      def add_contact(contacts, type, value)
+        return unless value
+        contacts << IsoBibItem::Contact.new(type: type, value: value.text)
+      end
+
+      # @param author [Nokogiri::XML::Document]
+      # @return [IsoBibItem::Affilation]
+      def affilation(author)
+        organization = author.at('//organization')
+        IsoBibItem::Affilation.new IsoBibItem::Organization.new(
+          name: organization.text.empty? ? 'IETF' : organization.text,
+          abbreviation: organization[:abbrev] || 'IETF'
+        )
+      end
+
+      # @param author [Nokogiri::XML::Document]
+      # @return [String]
+      def contributor_role(author)
+        author[:role] || 'author'
+      end
+
+      #
+      # Extract date from reference.
+      #
+      # @return [Array<IsoBibItem::BibliographicDate>] published data.
+      #
+      def dates
+        return unless (date = @reference.at '//front/date')
+        d = [date[:year], date[:month], date[:day]].compact.join '-'
+        date = Time.parse(d).strftime '%Y-%m-%d'
+        [IsoBibItem::BibliographicDate.new(type: 'published', on: date)]
+      end
+
+      #
+      # Extract document identifiers from reference
+      #
+      # @return [Array<IsoBibItem::DocumentIdentifier>]
+      #
+      def docids
+        @reference.xpath('//seriesinfo').map do |si|
+          next unless si[:name] == 'DOI'
+          IsoBibItem::DocumentIdentifier.new(
+            id: si[:value],
+            type: si[:name]
+          )
+        end.compact
+      end
+
+      #
+      # Extract series form reference
+      #
+      # @return [Array<IsoBibItem::FormattedString>]
+      #
+      def series
+        @reference.xpath('//seriesinfo').map do |si|
+          next if si[:name] == 'DOI' || si[:stream] || si[:status]
+          IsoBibItem::Series.new(
+            title: IsoBibItem::FormattedString.new(
+              content: si[:name], language: language, script: 'Latn'
+            ),
+            number: si[:value]
+          )
+        end.compact
+      end
+
+      #
+      # extract status
+      #
+      # @return [IsoBibItem::DocumentStatus]
+      #
+      def status
+        st = @reference.at('//seriesinfo[@status]')
+        return unless st
+        IsoBibItem::DocumentStatus.new(
+          IsoBibItem::LocalizedString.new(st[:status])
+        )
+      end
+    end
+  end
+  # rubocop:enable Metrics/ModuleLength
+end

data/lib/rfcbib/version.rb

@@ -0,0 +1,3 @@
+module Rfcbib
+  VERSION = "0.1.1"
+end

data/lib/rfcbib.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'rfcbib/version'
+require 'rfcbib/rfc_bibliography'

data/rfcbib.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rfcbib/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rfcbib'
+  spec.version       = Rfcbib::VERSION
+  spec.authors       = ['Ribose Inc.']
+  spec.email         = ['open.source@ribose.com']
+
+  spec.summary       = 'RfcBib: retrieve RFC Standards for bibliographic use '\
+                       'using the BibliographicItem model'
+  spec.description   = 'RfcBib: retrieve RFC Standards for bibliographic use '\
+                       'using the BibliographicItem model'
+  spec.homepage      = 'https://github.com/riboseinc/rfcbib'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency "equivalent-xml", "~> 0.6"
+
+  spec.add_dependency 'iso-bib-item', '~> 0.1.10'
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: rfcbib
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: equivalent-xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: iso-bib-item
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.10
+description: 'RfcBib: retrieve RFC Standards for bibliographic use using the BibliographicItem
+  model'
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.adoc
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rfcbib.rb
+- lib/rfcbib/rfc_bibliography.rb
+- lib/rfcbib/scrapper.rb
+- lib/rfcbib/version.rb
+- rfcbib.gemspec
+homepage: https://github.com/riboseinc/rfcbib
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: 'RfcBib: retrieve RFC Standards for bibliographic use using the BibliographicItem
+  model'
+test_files: []