relaton-ietf 1.16.1 → 1.16.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d38fb8a37a82452b362231a9c9c5b0424c736ed9b736590d89a486fad08b56e3
4
- data.tar.gz: 0af04bcb2a9573b6548442a2182a476de630f19ad10c1c6a492a9271fe905251
3
+ metadata.gz: f991e579da3f0e467e20d1af8eb3215fc4f7c03f8dca773359da7262b4557a71
4
+ data.tar.gz: a8993337405ef4de678ce8b40670b93478dda1cf43c4e44bb33f1a0b13a960a0
5
5
  SHA512:
6
- metadata.gz: 28592296140fadf98b245fd0efdb62bf9e1c808a4487cd18e8025dcc1daf303cc90466ca0bf21b2c433652b4543265f866d0b83246a1764089be80e48dabb4e6
7
- data.tar.gz: cae243d8e3af11d86d7de6969442fbbcf5e9c08cdaa0839237ec8a2dd6222da58a57132e3cfa8060daa1385fe0668767aae4223c2b6f0000ba77365ddbfd841f
6
+ metadata.gz: 98d758c3fbaaf0c76e8c4c144e1a7fc5d3e55ccf4f922dd242f11882c7e6d2c759f027dc9f06b344ad6d3486c84d35f237ca878e3e6c9befcfaace406c1b698c
7
+ data.tar.gz: d5d739811a64be1aa4417a2958ffc9a91ca159c9a94c2655a50e6a0d6ea2d9c73684cc639edcc23939672aeae9d238f6c430216f79787ab29aae589ef6a1888a
data/README.adoc CHANGED
@@ -33,31 +33,42 @@ Or install it yourself as:
33
33
 
34
34
  == Usage
35
35
 
36
- === Fetching documents
36
+ === Configuration
37
+
38
+ Configuration is optional. The available option is `logger` which is a `Logger` instance. By default, the logger is `Logger.new($stderr)` with `Logger::WARN` level. To change the logger level, use `RelatonIetf.configure` block.
37
39
 
38
40
  [source,ruby]
39
41
  ----
40
42
  require 'relaton_ietf'
41
43
  => true
42
44
 
45
+ RelatonIetf.configure do |config|
46
+ config.logger.level = Logger::DEBUG
47
+ end
48
+ ----
49
+
50
+ === Fetching documents
51
+
52
+ [source,ruby]
53
+ ----
43
54
  # Fetch RFC document
44
55
  item = RelatonIetf::IetfBibliography.get 'IETF RFC 8341'
45
- [relaton-ietf] ("IETF RFC 8341") fetching...
46
- [relaton-ietf] ("IETF RFC 8341") found RFC 8341
56
+ [relaton-ietf] (IETF RFC 8341) Fetching from Relaton repository ...
57
+ [relaton-ietf] (IETF RFC 8341) Found: `RFC 8341`
47
58
  => #<RelatonIetf::IetfBibliographicItem:0x007fd1875e7f58
48
59
  ...
49
60
 
50
61
  # Fetch Internet-Draft document
51
62
  RelatonIetf::IetfBibliography.get 'IETF I-D.draft-abarth-cake-01'
52
- [relaton-ietf] ("IETF I-D.draft-abarth-cake-01") fetching...
53
- [relaton-ietf] ("IETF I-D.draft-abarth-cake-01") found draft-abarth-cake-01
63
+ [relaton-ietf] (IETF I-D.draft-abarth-cake-01) Fetching from Relaton repository ...
64
+ [relaton-ietf] (IETF I-D.draft-abarth-cake-01) Found: `draft-abarth-cake-01`
54
65
  => #<RelatonIetf::IetfBibliographicItem:0x00007fdd129bbeb8
55
66
  ...
56
67
 
57
68
  # Return nil if a document doesn't exist.
58
69
  RelatonIetf::IetfBibliography.get 'IETF 1111'
59
- [relaton-ietf] ("IETF 1111") fetching...
60
- [relaton-ietf] ("IETF 1111") not found
70
+ [relaton-ietf] (IETF 1111) Fetching from Relaton repository ...
71
+ [relaton-ietf] (IETF 1111) Not found.
61
72
  => nil
62
73
  ----
63
74
 
@@ -13,7 +13,7 @@ module RelatonIetf
13
13
  # @param stream [String, nil]
14
14
  def initialize(**args)
15
15
  if args[:doctype] && !DOCTYPES.include?(args[:doctype])
16
- Util.warn "WARNING: invalid doctype `#{args[:doctype]}`"
16
+ Util.warn "WARNING: Invalid doctype: `#{args[:doctype]}`"
17
17
  end
18
18
  @stream = args.delete(:stream)
19
19
  super
@@ -18,13 +18,13 @@ module RelatonIetf
18
18
  # reference is required
19
19
  # @return [RelatonIetf::IetfBibliographicItem] Relaton of reference
20
20
  def get(code, _year = nil, _opts = {})
21
- Util.warn "(#{code}) fetching..."
21
+ Util.warn "(#{code}) Fetching from Relaton repository ..."
22
22
  result = search code
23
23
  if result
24
24
  docid = result.docidentifier.detect(&:primary) || result.docidentifier.first
25
- Util.warn "(#{code}) found `#{docid.id}`"
25
+ Util.warn "(#{code}) Found: `#{docid.id}`"
26
26
  else
27
- Util.warn "(#{code}) not found"
27
+ Util.warn "(#{code}) Not found."
28
28
  end
29
29
  result
30
30
  end
@@ -1,3 +1,3 @@
1
1
  module RelatonIetf
2
- VERSION = "1.16.1".freeze
2
+ VERSION = "1.16.2".freeze
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: relaton-ietf
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.16.1
4
+ version: 1.16.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Ribose Inc.
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2023-09-21 00:00:00.000000000 Z
11
+ date: 2023-10-14 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: relaton-bib