jekyll-indico 0.3.0 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f3a7088e3b7081c49c46f538daeda9508eebdf9
-  data.tar.gz: 1a7c3de25e8ec40d3cc872133dbdf53bb3e96cf0
+  metadata.gz: 2fd70ce9ff3c9b8e49a90d35d11c785073ddcb46
+  data.tar.gz: 1a45a9c41cb364fe92fc43f198e1be4ef95c9543
 SHA512:
-  metadata.gz: fe2cc076a05b4648d61b63fa768c2a94ce6531188a82fa678b8bf0f0a918d24726183051ea1e11fbc000e25581fb00469f207181c427cd76f581bece516aee50
-  data.tar.gz: 7a4d272f85799ee69771612522b889a304ee951199a0147da8c839ad37116ad6c28047da4fe13953ae0d31b600f1b39363d8ac916967658b93b70b7f4e97ae71
+  metadata.gz: 1faa993005ede31ba0eead7c4e4801f8d0d96afd6e76b2089e67d03c73713ecf40e458d449771c10afee1d33b3e17ebc62a4bdc772ed1c7ced9eaeeaa6f3f37c
+  data.tar.gz: a9b7199fb3b6695b69e70b12d9c3ad735e7c01030fd95d9ae7b0772c1286aba3caa8804da6530c383de1347c3726938415cb17636941b4db527b68efe8c0f22d

data/.github/workflows/ci.yml

@@ -13,8 +13,13 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
+
     - uses: ruby/setup-ruby@v1
       with:
         bundler-cache: true
+
+    - name: Style checking
+      run: bundle exec rake rubocop
+
     - name: Run tests
-      run: bundle exec rake
+      run: bundle exec rake spec

data/.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v3.4.0
+  rev: v4.1.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.9
+  rev: v1.1.11
   hooks:
   - id: remove-crlf
   - id: forbid-tabs

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+# Version 0.4.3
+
+Fix warning message for classic tokens. Add time prinout to help judge need for
+timeout setting.
+
+# Version 0.4.2
+
+Remove broken support for classic tokens. Modern `INDICO_TOKEN` required.
+
+# Version 0.4.1
+
+Fix a few issues in Jekyll generator.
+
+# Version 0.4.0
+
+Support `INDICO_TOKEN`, replaces the [deprecated indico URL
+authentication](https://docs.getindico.io/en/stable/http-api/access/). Also
+support `indico.timeout` setting in config.
+
 # Version 0.3.0
 
 Support setting or avoiding the cache command message.

data/Gemfile.lock

@@ -1,28 +1,28 @@
 PATH
   remote: .
   specs:
-    jekyll-indico (0.3.0)
+    jekyll-indico (0.4.3)
       jekyll (>= 3.8, < 5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
     colorator (1.1.0)
-    concurrent-ruby (1.1.8)
-    diff-lcs (1.4.4)
-    em-websocket (0.5.2)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.5.0)
+    em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
-      http_parser.rb (~> 0.6.0)
+      http_parser.rb (~> 0)
     eventmachine (1.2.7)
-    ffi (1.15.0)
+    ffi (1.15.5)
     forwardable-extended (2.6.0)
-    http_parser.rb (0.6.0)
+    http_parser.rb (0.8.0)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
-    jekyll (3.9.0)
+    jekyll (3.9.1)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
@@ -42,38 +42,38 @@ GEM
     kramdown (2.3.1)
       rexml
     liquid (4.0.3)
-    listen (3.4.1)
+    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.0.0.0)
+    parser (3.1.0.0)
       ast (~> 2.4.1)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
     public_suffix (4.0.6)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    rb-fsevent (0.10.4)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    regexp_parser (2.0.3)
-    rexml (3.2.4)
-    rouge (3.26.0)
+    regexp_parser (2.2.0)
+    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.1)
+    rspec-core (3.10.2)
       rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec-expectations (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+    rspec-mocks (3.10.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.9.1)
+    rspec-support (3.10.3)
+    rubocop (1.12.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -96,7 +96,7 @@ GEM
     sass-listen (4.0.0)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
-    unicode-display_width (2.0.0)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -19,9 +19,10 @@ indico:
     blueprint: 11329
 ```
 
-
-This plugin will automatically sign your requests if your environment contains
-`INDICO_API` and `INDICO_SECRET_KEY`.
+This plugin will automatically use an API token if your environment contains
+`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.
 
 #### Usage: installing
 
@@ -70,14 +71,20 @@ number on Indico).
 
 ```bash
 # Install a local bundle
-bundle install --path vendor/bundle
+bundle config set --local path 'vendor/bundle'
 
 # Test style and unit tests
 bundle exec rake
 ```
 
+If you need to automatically correct unit paths:
+
+```bash
+bundle exec rake rubocop:auto_correct
+```
+
 To release, make sure the version in `lib/jekyll-indico/version.rb` is new and
-you have updated your lock file with `bundle instal` then:
+you have updated your lock file with `bundle install` then:
 
 ```bash
 bundle exec rake release

data/lib/jekyll-indico/core.rb

@@ -15,6 +15,9 @@ module JekyllIndico
   class MissingURL < Error
   end
 
+  class MissingIDs < Error
+  end
+
   # Look for topical meetings
   class Meetings
     attr_accessor :dict
@@ -57,53 +60,27 @@ module JekyllIndico
       end
     end
 
-    # Get meeting ids from a config
-    def self.meeting_ids(config = {})
-      config.dig('indico', 'ids')
-    end
-
-    # Get base URL from a config
-    def self.base_url(config = {})
-      url = config.dig('indico', 'url')
-      raise MissingURL('indico: url: MISSING from your config!') unless url
-
-      url
-    end
-
     private
 
     # Run a block over each item in the downloaded results
-    def download_and_iterate(base_url, indico_id, **kargs, &block)
-      url = build_url(base_url, indico_id, **kargs)
-      uri = URI.parse(url)
-      response = Net::HTTP.get_response(uri)
+    def download_and_iterate(base_url, indico_id, **params, &block)
+      params[:pretty] = 'no'
+      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']
+        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) }
 
       string = response.body
       parsed = JSON.parse(string) # returns a hash
 
       parsed['results'].each(&block)
     end
-
-    # Put together a dict and an indico ID
-    def join_url(indico_id, options)
-      apicall = options.sort.to_h.map { |k, v| "#{k}=#{v}" }.join('&')
-      "/export/categ/#{indico_id}.json?#{apicall}"
-    end
-
-    # Automatically signs request if environment has INDICO_API/SECRET_KEY
-    def build_url(base_url, indico_id, **kargs)
-      kargs[:pretty] = 'no'
-
-      if ENV['INDICO_API_KEY']
-        kargs[:ak] = ENV['INDICO_API_KEY']
-        if ENV['INDICO_SECRET_KEY']
-          kargs[:timestamp] = Time.new.to_i.to_s
-          requeststr = join_url(indico_id, kargs)
-          kargs[:signature] = OpenSSL::HMAC.hexdigest('SHA1', ENV['INDICO_SECRET_KEY'], requeststr)
-        end
-      end
-
-      "#{base_url}#{join_url(indico_id, kargs)}"
-    end
   end
 end

data/lib/jekyll-indico/generator.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'benchmark'
+require 'net/http'
 require 'yaml'
 
 require 'jekyll'
@@ -14,7 +16,13 @@ module JekyllIndico
       @site = site
       @cache_msg = @site.config.dig('indico', 'cache-command')
 
-      meeting_ids = Meetings.meeting_ids(@site.config)
+      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)
+
       meeting_ids.each do |name, number|
         collect_meeting(name.to_s, number)
       end
@@ -23,7 +31,8 @@ module JekyllIndico
     private
 
     def collect_meeting(name, number)
-      base_url = Meetings.base_url(@site.config)
+      base_url = @site.config.dig('indico', 'url')
+      raise MissingURL, 'indico: url: MISSING from your config!' unless base_url
 
       data_path = @site.config.dig('indico', 'data') || 'indico'
       @site.data[data_path] = {} unless @site.data.key? data_path
@@ -32,9 +41,12 @@ module JekyllIndico
       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)
+        @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.3.0'
+  VERSION = '0.4.3'
 end

metadata

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