nistbib 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ef1ae9dcd37608cd47b565f151b291adcf85cca5
-  data.tar.gz: 953dce58fd24be8d0e39a3ec9622a3a5508bbb2c
+SHA256:
+  metadata.gz: d4ef478920734e534e1826dbe3f4797f0d7efb6ec0be12d20d2524a51ce4e8eb
+  data.tar.gz: 2f22189c970b05874d390af4f95f322e9b7412ad65568c56740af2985359d4f5
 SHA512:
-  metadata.gz: 25007561f152223a16046b5b05811312d4bda2feb5cb2663a351a61da64fe3cd2edee5ce104aeb21918203a1f44529ae4f5ace9f8c8c1f3299eed91966b3b4c7
-  data.tar.gz: 1e98dca81f2a883899b4f0ae7f3a8fc057293b208adce21b4e36186db813667e669e534bf8071685ee872d70ccca039918c1f145476c1e6890abe9eb9fe34faa
+  metadata.gz: 28f16fbd808e2e59a341201dd61e26960c1243d9650ef5862c16b8205b7e459b943645780cbf841d3d329f42fc743fee33718253e401b20cb388bec57fa429bf
+  data.tar.gz: ffdb848ef8d9c949dc246f197487eaa80e5364c1827f6207cdbab062a89ff93d7352c87b781ee0854fb4dab8280a5a18ffebab345b441996e434d2576a3f4b9b

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+.vscode/
 
 # rspec failure tracking
 .rspec_status

data/Gemfile

@@ -1,3 +1,6 @@
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in nistbib.gemspec

data/Gemfile.lock

@@ -9,10 +9,13 @@ GEM
   specs:
     addressable (2.6.0)
       public_suffix (>= 2.0.2, < 4.0)
-    byebug (10.0.2)
+    byebug (11.0.1)
     coderay (1.1.2)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
+    debase (0.2.2)
+      debase-ruby_core_source (>= 0.10.2)
+    debase-ruby_core_source (0.10.4)
     diff-lcs (1.3)
     docile (1.3.1)
     equivalent-xml (0.6.0)
@@ -23,7 +26,7 @@ GEM
       nokogiri (~> 1.8.4)
       ruby_deep_clone (~> 0.8.0)
     isoics (0.1.7)
-    json (2.1.0)
+    json (2.2.0)
     method_source (0.9.2)
     mini_portile2 (2.3.0)
     nokogiri (1.8.5)
@@ -31,8 +34,8 @@ GEM
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    pry-byebug (3.6.0)
-      byebug (~> 10.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
       pry (~> 0.10)
     public_suffix (3.0.3)
     rake (10.5.0)
@@ -49,8 +52,10 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    ruby-debug-ide (0.6.1)
+      rake (>= 0.8.1)
     ruby_deep_clone (0.8.0)
-    safe_yaml (1.0.4)
+    safe_yaml (1.0.5)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
@@ -68,11 +73,13 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.0)
   byebug
+  debase
   equivalent-xml (~> 0.6)
   nistbib!
   pry-byebug
   rake (~> 10.0)
   rspec (~> 3.0)
+  ruby-debug-ide
   simplecov
   vcr
   webmock

data/README.adoc

@@ -0,0 +1,81 @@
+= NistBib: retrieve NIST Standards for bibliographic use using the BibliographicItem model
+
+image:https://img.shields.io/gem/v/nistbib.svg["Gem Version", link="https://rubygems.org/gems/nistbib"]
+image:https://img.shields.io/travis/metanorma/nistbib/master.svg["Build Status", link="https://travis-ci.com/metanorma/nistbib"]
+image:https://ci.appveyor.com/api/projects/status/vk85u3df4f3kertr?svg=true["Appveyor Build Status", link="https://ci.appveyor.com/project/ribose/nistbib"]
+image:https://codeclimate.com/github/metanorma/nistbib/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/nistbib"]
+
+
+NistBib is a Ruby gem that implements the https://github.com/metanorma/metanorma-model-iso#iso-bibliographic-item[IsoBibliographicItem model].
+
+You can use it to retrieve metadata of NIST Standards from https://csrc.nist.gov, and access such metadata through the `IsoBibliographicItem` object.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'nistbib'
+----
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nistbib
+
+== Usage
+
+=== Search for a standard using keywords
+
+[source,ruby]
+----
+require 'nistbib'
+
+hit_collection = NistBib::NistBibliography.search("8200")
+=> [<NistBib::Hit:0x007f82b9b2b298 @text="8200" @fetched="false" @fullIdentifier="" @title="8200">,
+ <NistBib::Hit:0x007f82b9b2a1e0 @text="8200" @fetched="false" @fullIdentifier="" @title="8200">]
+
+ item = hit_collection[1].fetch
+ => #<IsoBibItem::IsoBibliographicItem:0x007f82b986e668
+ ...
+----
+
+=== XML serialization
+[source,ruby]
+----
+item.to_xml
+=> "<bibitem type="" id="NISTIR8200(DRAFT)">
+      <fetched>2019-02-11</fetched>
+      <title format="text/plain" language="en" script="Latn">
+        Interagency Report on Status of International Cybersecurity Standardization for the Internet of Things (IoT)
+      </title>
+      ...
+    </bibitem>"
+----
+
+=== Get code, and year
+[source,ruby]
+----
+NistBib::NistBibliography.get("8200", "2018", {})
+fetching 8200...
+=> #<IsoBibItem::IsoBibliographicItem:0x007f82bb3370a8
+...
+----
+
+== 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/metanorma/nistbib.
+
+== License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/appveyor.yml

@@ -0,0 +1,30 @@
+version: '{build}'
+
+environment:
+  matrix:
+    - RUBY_VERSION: 25
+    - RUBY_VERSION: 24
+    - RUBY_VERSION: 23
+    - RUBY_VERSION: _trunk
+
+matrix:
+  allow_failures:
+    - RUBY_VERSION: _trunk
+
+install:
+  - ps: . { iwr -useb https://raw.githubusercontent.com/metanorma/metanorma-build-scripts/master/appveyor.ps1 } | iex
+  - refreshenv
+
+build_script:
+  - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
+  - bundle update
+  - bundle install
+
+before_test:
+  - ruby -v
+  - gem -v
+  - bundle -v
+
+test_script:
+  - bundle exec rake
+

data/lib/nistbib.rb

@@ -1,6 +1,11 @@
 require "nistbib/version"
 require 'nistbib/nist_bibliography'
 
+if defined? Relaton
+  require_relative 'relaton/processor'
+  Relaton::Registry.instance.register(Relaton::NistBib::Processor)
+end
+
 module NistBib
   class Error < StandardError; end
   # Your code goes here...

data/lib/nistbib/nist_bibliography.rb

@@ -17,7 +17,15 @@ module NistBib
       # @param year [String] the year the standard was published (optional)
       # @param opts [Hash] options; restricted to :all_parts if all-parts reference is required
       # @return [String] Relaton XML serialisation of reference
-      def get(code, year, opts)
+      def get(code, year = nil, opts = {})
+        if year.nil?
+          /^(?<code1>[^:]+):(?<year1>[^:]+)$/ =~ code
+          unless code1.nil?
+            code = code1
+            year = year1
+          end
+        end
+
         code += '-1' if opts[:all_parts]
         ret = nistbib_get1(code, year, opts)
         return nil if ret.nil?

data/lib/nistbib/version.rb

@@ -1,3 +1,3 @@
 module NistBib
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/relaton/processor.rb

@@ -1,7 +1,7 @@
 require "relaton/processor"
 
 module Relaton
-  module Isobib
+  module NistBib
     class Processor < Relaton::Processor
 
       def initialize

data/nistbib.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{NistBib: retrive NIST standards.}
   spec.description   = %q{NistBib: retrive NIST standards.}
-  spec.homepage      = "https://github.com/riboseinc/nistbib"
+  spec.homepage      = "https://github.com/metanorma/nistbib"
   spec.license       = "MIT"
 
   # Specify which files should be added to the gem when it is released.
@@ -32,6 +32,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'ruby-debug-ide'
+  spec.add_development_dependency 'debase'
 
   spec.add_dependency 'iso-bib-item', '~> 0.4.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nistbib
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-07 00:00:00.000000000 Z
+date: 2019-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,6 +136,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-debug-ide
+  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: debase
+  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: iso-bib-item
   requirement: !ruby/object:Gem::Requirement
@@ -163,8 +191,9 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.md
+- README.adoc
 - Rakefile
+- appveyor.yml
 - bin/console
 - bin/setup
 - lib/nistbib.rb
@@ -176,7 +205,7 @@ files:
 - lib/nistbib/workers_pool.rb
 - lib/relaton/processor.rb
 - nistbib.gemspec
-homepage: https://github.com/riboseinc/nistbib
+homepage: https://github.com/metanorma/nistbib
 licenses:
 - MIT
 metadata: {}
@@ -196,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: 'NistBib: retrive NIST standards.'

data/README.md

@@ -1,39 +0,0 @@
-# Nistbib
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/nistbib`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'nistbib'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install nistbib
-
-## Usage
-
-TODO: Write usage instructions here
-
-## 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]/nistbib.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).