jekyll-indico 0.4.5 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 91bed0b6b864fa3f7a1b8dee140c9f9eb791823b
-  data.tar.gz: 6519f4dd2b0681d3961ce636733701342eed4a7d
+SHA256:
+  metadata.gz: 772fa536fed11533f53b2d2e643a4ffd3c9443d93bf6a546185aa9c5d70a0f5a
+  data.tar.gz: f4558987c3f3d9a2c62c13bec9617088318b63ec3667ab8b3aa24a085a7ca429
 SHA512:
-  metadata.gz: 1f5064ba79a8af25de947a654f5718e70b48a19533f05afa1cb6739ffd07a9c6c25d4296def57d50b00a5f34e57467629ad048b5d6ed6858d6fbb8811dca7d79
-  data.tar.gz: 260ecb6e6b9b1801928d0f6eeb204e71217db6f3e6d5fd77128fe750128b976d5401725556054c939cad347f2aebb7071540b35ac4dd08931584d121f35831c1
+  metadata.gz: 3973f9788e6afc35aaf231fec4c3b813d6f37f010e20ade8fa0c739f02b3caa7658ba5bc1bcda2856e5376bbe404c03b9ae1c6695b3978e0ac1950905eefcdf6
+  data.tar.gz: '042863f213053df58b317bea185d459493d3a9ae56553cd61ccf8bdcb78b1530af50af4f752df5ff4752f2dc551a3c7a7ad97ced47aecdadf86918a228eb85d3'

data/.github/workflows/ci.yml

@@ -7,15 +7,24 @@ on:
     branches:
       - main
 
+concurrency:
+  group: test-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   test:
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.6, 3.1]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     - uses: ruby/setup-ruby@v1
       with:
+        ruby-version: ${{ matrix.ruby }}
         bundler-cache: true
 
     - name: Style checking

data/.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.1.0
+  rev: v4.2.0
   hooks:
   - id: check-added-large-files
   - id: mixed-line-ending
@@ -11,7 +11,7 @@ repos:
   - id: check-yaml
 
 - repo: https://github.com/Lucas-C/pre-commit-hooks
-  rev: v1.1.11
+  rev: v1.1.13
   hooks:
   - id: remove-crlf
   - id: forbid-tabs

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.10

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+
+# 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.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jekyll-indico (0.4.5)
+    jekyll-indico (0.6.1)
       jekyll (>= 3.8, < 5.0)
 
 GEM
@@ -11,7 +11,7 @@ GEM
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
     colorator (1.1.0)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
     em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
@@ -20,95 +20,98 @@ GEM
     ffi (1.15.5)
     forwardable-extended (2.6.0)
     http_parser.rb (0.8.0)
-    i18n (0.9.5)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    jekyll (3.9.1)
+    jekyll (4.2.2)
       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.2.0)
+      sassc (> 2.0.1, < 3.0)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
-    kramdown (2.3.1)
+    kramdown (2.4.0)
       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)
-    parser (3.1.0.0)
+    mercenary (0.4.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    public_suffix (4.0.6)
+    public_suffix (4.0.7)
     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)
+    regexp_parser (2.3.1)
     rexml (3.2.5)
-    rouge (3.27.0)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.2)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.2)
+    rouge (3.28.0)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.3)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    rubocop (1.12.1)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.28.2)
       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.17.0, < 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.17.0)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
+    rubocop-rspec (2.10.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-21
+  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.13

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/exe/jekyll-indico-cache

@@ -18,10 +18,14 @@ end.parse!
 puts "Reading #{options[:config]}"
 
 config = YAML.safe_load(File.read(options[:config]))
-meeting_ids = JekyllIndico::Meetings.meeting_ids(config)
-base_url = JekyllIndico::Meetings.base_url(config)
+meeting_ids = config.dig('indico', 'ids')
+base_url = config.dig('indico', 'url')
 data_path = config.dig('indico', 'data') || 'indico'
 
+raise MissingURL, 'indico: url: MISSING from your config!' unless base_url
+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)
+
 JekyllIndico.cache(base_url, meeting_ids, data_path) do |name, number|
   puts "Accessing #{number} for #{name}"
 end

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,28 +62,43 @@ module JekyllIndico
 
     private
 
-    # Run a block over each item in the downloaded results
-    def download_and_iterate(base_url, indico_id, timeout: nil, **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)
 
       req = Net::HTTP::Get.new(uri)
       if ENV['INDICO_TOKEN']
-        req['Authorization'] = "Bearer #{ENV['INDICO_TOKEN']}"
-      elsif ENV['INDICO_SECRET_KEY'] || ENV['INDICO_API_KEY']
+        req['Authorization'] = "Bearer #{ENV.fetch('INDICO_TOKEN', nil)}"
+      elsif ENV.fetch('INDICO_SECRET_KEY', nil) || ENV.fetch('INDICO_API_KEY', nil)
         raise Error, 'Use INDICO_TOKEN with a new-style token'
       end
 
-      opts = { use_ssl: true }
-      opts[:read_timeout] = timeout if timeout
-
       response = Net::HTTP.start(uri.hostname, uri.port, **opts) { |http| http.request(req) }
 
-      string = response.body
-      parsed = JSON.parse(string) # returns a hash
+      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'
 
-      parsed['results'].each(&block)
+      unless limit
+        results = get_parsed_results(base_url, indico_id, **params)
+        results.each(&block)
+        return
+      end
+
+      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

@@ -35,6 +35,7 @@ module JekyllIndico
       @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
@@ -42,7 +43,7 @@ module JekyllIndico
       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, timeout: timeout)
+        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.5'
+  VERSION = '0.6.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-indico
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.6.1
 platform: ruby
 authors:
 - Henry Schreiner
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-02 00:00:00.000000000 Z
+date: 2022-05-06 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.1
 signing_key:
 specification_version: 4
 summary: Read and/or cache indico meeting lists for Jekyll