jekyll-indico 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ba6c0b97ed60402adc30d9f4d0c0077b7c7293b
-  data.tar.gz: '0322806b14154b9d0da3441ed64ff0931276736e'
+  metadata.gz: 4e2a1ea8813f626061be2c5da553cafe9453aaac
+  data.tar.gz: '06758dd8b0908b58f065a13a5fc8f8990ff1ab0d'
 SHA512:
-  metadata.gz: 60013b3c444d121db0b865797eb9353b47220f2b6b186f5d949aa27b7426976ad3d7914624b9cb4578a5c397a08847907b0637dd531fc47a121ef005f279061e
-  data.tar.gz: 82c1b136bec61c8fe09011e3a62376c39981e1195febcd70e5ae4f30e9bbc7dcaf6f77626129e2782e0f0831707231b68d6a4c84063439a21b1a0a8f0a17305d
+  metadata.gz: 7f909dd6bffbd0f595c03daa73d2da3fc234a3ff9f72ccca3e35e532a962dada79dc5be4f978b3aa4e4c92edbb6248807d03be92e08658fb7d45c679576a4dc1
+  data.tar.gz: 246baf00d16729890482b79743ef9c625e6976c52bf8c336c91b66bfd039c6a6c3f1333f6984e393e8de366b391ce6be2b499b1ddd257a7b50161b42550967ad

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+# 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 printout to help judge need for
+timeout setting.
+
 # Version 0.4.2
 
 Remove broken support for classic tokens. Modern `INDICO_TOKEN` required.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jekyll-indico (0.4.2)
+    jekyll-indico (0.5.0)
       jekyll (>= 3.8, < 5.0)
 
 GEM
@@ -54,12 +54,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)

data/README.md

@@ -14,13 +14,15 @@ 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
 ```
 
 This plugin will automatically use an API token if your environment contains
-`INDICO_TOKEN`. You should generate this and replace `INDICO_API` and
+`INDICO_TOKEN`. You should generate this and replace `INDICO_API_KEY` and
 `INDICO_SECRET_KEY` with it. You'll want the "Classic API" read permissions set
 on it.
 

data/lib/jekyll-indico/core.rb

@@ -23,10 +23,10 @@ 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>'
@@ -62,25 +62,43 @@ 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)
 
       req = Net::HTTP::Get.new(uri)
       if ENV['INDICO_TOKEN']
         req['Authorization'] = "Bearer #{ENV['INDICO_TOKEN']}"
-      elsif ENV['INDICO_SECRET_KEY'] || ENV['INDICO_API']
+      elsif ENV['INDICO_SECRET_KEY'] || ENV['INDICO_API_KEY']
         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) }
 
-      string = response.body
-      parsed = JSON.parse(string) # returns a hash
+      parsed = JSON.parse(response.body)
+      parsed['results']
+    end
 
-      parsed['results'].each(&block)
+    # Run a block over each item in the downloaded results
+    def download_and_iterate(base_url, indico_id, limit: nil, **params, &block)
+      params[:limit] = limit if limit
+      params[:pretty] = 'no'
+
+      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)
+        break if results.empty?
+
+        results.each(&block)
+      end
     end
   end
 end

data/lib/jekyll-indico/generator.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
+require 'benchmark'
+require 'net/http'
 require 'yaml'
 
 require 'jekyll'
 
 require 'jekyll-indico/core'
 
-require 'net/http'
-
 module JekyllIndico
   # This is a Jekyll Generator
   class GetIndico < Jekyll::Generator
@@ -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,19 @@ 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" : ''
-      puts "Accessing Indico meeting API for #{name}:#{number}#{msg}"
-      iris_meeting = Meetings.new(base_url, number)
-      @site.data[data_path][name] = iris_meeting.dict
+      print "Accessing Indico meeting API for #{name}:#{number}#{msg}"
+      time = Benchmark.realtime do
+        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"
     end
   end
 end

data/lib/jekyll-indico/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-indico
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Henry Schreiner
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-01 00:00:00.000000000 Z
+date: 2022-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll