jekyll-indico 0.4.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2fd70ce9ff3c9b8e49a90d35d11c785073ddcb46
-  data.tar.gz: 1a45a9c41cb364fe92fc43f198e1be4ef95c9543
+SHA256:
+  metadata.gz: d07e0cc35ca21aab0d8b934a3e4dbc4ce9754f9b381e018a9030ec74c09291db
+  data.tar.gz: ceb2b86e65b6d40da965925abd98ab1b07830e255daf67ef2dce019d9da1e0c6
 SHA512:
-  metadata.gz: 1faa993005ede31ba0eead7c4e4801f8d0d96afd6e76b2089e67d03c73713ecf40e458d449771c10afee1d33b3e17ebc62a4bdc772ed1c7ced9eaeeaa6f3f37c
-  data.tar.gz: a9b7199fb3b6695b69e70b12d9c3ad735e7c01030fd95d9ae7b0772c1286aba3caa8804da6530c383de1347c3726938415cb17636941b4db527b68efe8c0f22d
+  metadata.gz: f0c639bf38480127762ab82011e4953a57b8f11f4e16bb484750690eabeef6ce2fb3f5a109f64336938555c8e1db059eac09d6881ccfdb4810fedd411b565038
+  data.tar.gz: 4fc89a0896dfdf28f3719e5ea7775a1080912fd221361600da28531175ce570885b060c1542ffb979af03ad0360f68807ff643d7fc17634df23baa3f434d03d4

data/.rubocop.yml

@@ -2,10 +2,12 @@ Metrics/MethodLength:
   Max: 25
 Metrics/AbcSize:
   Max: 55
+Metrics/CyclomaticComplexity:
+  Max: 10
 Style/NumericLiterals:
   Enabled: false
 Naming/FileName:
   Enabled: false
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.6

data/.ruby-version

@@ -1 +1 @@
-2.4.10
+2.6.6

data/CHANGELOG.md

@@ -1,6 +1,23 @@
+
+# Version 0.6
+
+Minimum Ruby version is now Ruby 2.6. Optimized `paginate` to reduce the API calls by one.
+
+# Version 0.5
+
+Added a way to paginate. Use `paginate: N` to iterate over pages of results.
+
+# Version 0.4.5
+
+Fix timeout being incorrectly called again.
+
+# Version 0.4.4
+
+Fix timeout being incorrectly called.
+
 # Version 0.4.3
 
-Fix warning message for classic tokens. Add time prinout to help judge need for
+Fix warning message for classic tokens. Add time printout to help judge need for
 timeout setting.
 
 # Version 0.4.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jekyll-indico (0.4.3)
+    jekyll-indico (0.6.0)
       jekyll (>= 3.8, < 5.0)
 
 GEM
@@ -20,33 +20,37 @@ GEM
     ffi (1.15.5)
     forwardable-extended (2.6.0)
     http_parser.rb (0.8.0)
-    i18n (0.9.5)
+    i18n (1.9.1)
       concurrent-ruby (~> 1.0)
-    jekyll (3.9.1)
+    jekyll (4.2.1)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
-      i18n (~> 0.7)
-      jekyll-sass-converter (~> 1.0)
+      i18n (~> 1.0)
+      jekyll-sass-converter (~> 2.0)
       jekyll-watch (~> 2.0)
-      kramdown (>= 1.17, < 3)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
       liquid (~> 4.0)
-      mercenary (~> 0.3.3)
+      mercenary (~> 0.4.0)
       pathutil (~> 0.9)
-      rouge (>= 1.7, < 4)
+      rouge (~> 3.0)
       safe_yaml (~> 1.0)
-    jekyll-sass-converter (1.5.2)
-      sass (~> 3.4)
+      terminal-table (~> 2.0)
+    jekyll-sass-converter (2.1.0)
+      sassc (> 2.0.1, < 3.0)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
     kramdown (2.3.1)
       rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
     liquid (4.0.3)
     listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    mercenary (0.3.6)
-    parallel (1.20.1)
+    mercenary (0.4.0)
+    parallel (1.21.0)
     parser (3.1.0.0)
       ast (~> 2.4.1)
     pathutil (0.16.2)
@@ -54,12 +58,12 @@ GEM
     public_suffix (4.0.6)
     rainbow (3.1.1)
     rake (13.0.6)
-    rb-fsevent (0.11.0)
+    rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     regexp_parser (2.2.0)
     rexml (3.2.5)
-    rouge (3.27.0)
+    rouge (3.28.0)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -73,42 +77,41 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.3)
-    rubocop (1.12.1)
+    rubocop (1.25.1)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
-    rubocop-rake (0.5.1)
-      rubocop
-    rubocop-rspec (2.2.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
+    rubocop-rspec (2.8.0)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     safe_yaml (1.0.5)
-    sass (3.7.4)
-      sass-listen (~> 4.0.0)
-    sass-listen (4.0.0)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-    unicode-display_width (2.1.0)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    terminal-table (2.0.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.8.0)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
-  bundler (~> 2.0)
+  bundler (~> 2.1)
   jekyll-indico!
   rake (~> 13.0)
   rspec (~> 3.0)
-  rubocop (~> 1.9)
-  rubocop-rake (~> 0.5)
+  rubocop (~> 1.25)
+  rubocop-rake (~> 0.6)
   rubocop-rspec (~> 2.2)
 
 BUNDLED WITH
-   2.2.8
+   2.3.6

data/README.md

@@ -14,6 +14,8 @@ indico:
   url: https://indico.cern.ch # Indico instance to use (REQUIRED)
   data: indico # Optional, folder name in _data to use
   cache-command: bundle exec rake cache # Optional, user msg if you support it
+  paginate: 20 # Optional integer number of results per page (auto-iterates over all pages)
+  timeout: 120 # Optional timeout in number of seconds (default: 60)
   ids:
     topical: 10570
     blueprint: 11329

data/jekyll-indico.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
     spec.metadata['changelog_uri'] = 'https://github.com/iris-hep/jekyll-indico/blob/main/CHANGELOG.md'
   else
     raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
+          'public gem pushes.'
   end
 
   # Specify which files should be added to the gem when it is released.
@@ -32,14 +32,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.4.0'
+  spec.required_ruby_version = '>= 2.6.0'
 
   spec.add_dependency 'jekyll', '>= 3.8', '< 5.0'
 
-  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 1.9'
-  spec.add_development_dependency 'rubocop-rake', '~> 0.5'
+  spec.add_development_dependency 'rubocop', '~> 1.25'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6'
   spec.add_development_dependency 'rubocop-rspec', '~> 2.2'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/jekyll-indico/core.rb

@@ -23,13 +23,13 @@ module JekyllIndico
     attr_accessor :dict
 
     # ID for IRIS-HEP: 10570
-    def initialize(base_url, indico_id, **kargs)
+    def initialize(base_url, indico_id, limit: nil, **kargs)
       @dict = {}
 
-      download_and_iterate(base_url, indico_id, **kargs) do |i|
+      download_and_iterate(base_url, indico_id, limit: limit, **kargs) do |i|
         # Trim paragraph tags
         d = i['description']
-        d = d[3..-1] if d.start_with? '<p>'
+        d = d[3..] if d.start_with? '<p>'
         d = d[0..-5] if d.end_with? '</p>'
 
         start_date = Date.parse i['startDate']['date']
@@ -62,9 +62,10 @@ module JekyllIndico
 
     private
 
-    # Run a block over each item in the downloaded results
-    def download_and_iterate(base_url, indico_id, **params, &block)
-      params[:pretty] = 'no'
+    def get_parsed_results(base_url, indico_id, timeout: nil, **params)
+      opts = { use_ssl: true }
+      opts[:read_timeout] = timeout if timeout
+
       uri = URI.join(base_url, "/export/categ/#{indico_id}.json")
       uri.query = URI.encode_www_form(params)
 
@@ -75,12 +76,29 @@ module JekyllIndico
         raise Error, 'Use INDICO_TOKEN with a new-style token'
       end
 
-      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
+      response = Net::HTTP.start(uri.hostname, uri.port, **opts) { |http| http.request(req) }
+
+      parsed = JSON.parse(response.body)
+      parsed['results']
+    end
+
+    # Run a block over each item in the downloaded results
+    def download_and_iterate(base_url, indico_id, limit: nil, **params, &block)
+      limit = nil if limit.zero?
+      params[:limit] = limit if limit
+      params[:pretty] = 'no'
 
-      string = response.body
-      parsed = JSON.parse(string) # returns a hash
+      unless limit
+        results = get_parsed_results(base_url, indico_id, **params)
+        results.each(&block)
+        return
+      end
 
-      parsed['results'].each(&block)
+      0.step.each do |n|
+        results = get_parsed_results(base_url, indico_id, offset: n * limit, **params)
+        results.each(&block)
+        break if results.length < limit
+      end
     end
   end
 end

data/lib/jekyll-indico/generator.rb

@@ -16,9 +16,6 @@ module JekyllIndico
       @site = site
       @cache_msg = @site.config.dig('indico', 'cache-command')
 
-      timeout = @site.config.dig('indico', 'timeout')
-      Net::HTTP.read_timeout = timeout if timeout
-
       meeting_ids = @site.config.dig('indico', 'ids')
       raise MissingIDs, 'indico: ids: MISSING from your config!' unless meeting_ids
       raise MissingIDs, 'indico: ids: must be a hash!' unless meeting_ids.is_a?(Hash)
@@ -37,13 +34,16 @@ module JekyllIndico
       data_path = @site.config.dig('indico', 'data') || 'indico'
       @site.data[data_path] = {} unless @site.data.key? data_path
 
+      timeout = @site.config.dig('indico', 'timeout')
+      limit = @site.config.dig('indico', 'paginate')
+
       # Do nothing if already downloaded
       return if @site.data[data_path].key? name
 
       msg = @cache_msg ? " - run `#{@cache_msg}` to cache" : ''
       print "Accessing Indico meeting API for #{name}:#{number}#{msg}"
       time = Benchmark.realtime do
-        iris_meeting = Meetings.new(base_url, number)
+        iris_meeting = Meetings.new(base_url, number, timeout: timeout, limit: limit)
         @site.data[data_path][name] = iris_meeting.dict
       end
       puts ", took #{time.round(1)} s"

data/lib/jekyll-indico/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllIndico
-  VERSION = '0.4.3'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-indico
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Henry Schreiner
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-01 00:00:00.000000000 Z
+date: 2022-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -78,28 +78,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.25'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.25'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -151,6 +151,7 @@ metadata:
   homepage_uri: https://rubygems.org/gems/jekyll-indico
   source_code_uri: https://github.com/iris-hep/jekyll-indico
   changelog_uri: https://github.com/iris-hep/jekyll-indico/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -159,15 +160,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.14.4
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: Read and/or cache indico meeting lists for Jekyll