jekyll-indico 0.4.0 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42dd6e02ca0145cbd0ab2678b896340909141d15
-  data.tar.gz: 91e3c5ae03e1508c8fb515281ca2ade408c1d453
+  metadata.gz: 5c14daf72a602a2600ce825c5298012ab6be48c8
+  data.tar.gz: dd1509e11a7b0f2a969a6d2ed442e5103daecc60
 SHA512:
-  metadata.gz: 63de08c462ef249ee2e0502aefd8c8104861b3c14f209df3df876875b61f8d6f5632a3ea8c1ae7cb21433c00b2f337cca7bf30163aca07ae5503d3d5ef8c8527
-  data.tar.gz: c3cec693a86e94decf78b38af462ef7632ba567242171297feeba47af30f49d640f9c75da3d082ce575f045d2a979eeec680db49932c37afafe6dee845a5cb9b
+  metadata.gz: bc20db3a1b0ab7b9d4e200bd0be98873a7ba21fdf576277d6960d7567dbce04bd1bd706864cbbe20fd80f374785035c2a010cc9420b16b1b13501a7fbee78a52
+  data.tar.gz: e6d791bfb92c05281dcbf9ec2d3ab56cc05692b5a4980f6f724e02bc9f646a23bc697bca963fdefc5ddb62085b7208dbd3d7015a5742cca42d109ce71003f67c

data/CHANGELOG.md

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

data/Gemfile.lock

@@ -1,28 +1,28 @@
 PATH
   remote: .
   specs:
-    jekyll-indico (0.4.0)
+    jekyll-indico (0.4.4)
       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

@@ -20,9 +20,9 @@ indico:
 ```
 
 This plugin will automatically use an API token if your environment contains
-`INDICO_TOKEN`. If you use the deprecated API, this plugin will automatically
-sign your requests if your environment contains `INDICO_API` and
-`INDICO_SECRET_KEY`.
+`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
 

data/lib/jekyll-indico/core.rb

@@ -63,13 +63,18 @@ module JekyllIndico
     private
 
     # Run a block over each item in the downloaded results
-    def download_and_iterate(base_url, indico_id, **kargs, &block)
+    def download_and_iterate(base_url, indico_id, timeout: nil, **params, &block)
+      params[:pretty] = 'no'
       uri = URI.join(base_url, "/export/categ/#{indico_id}.json")
-      params = build_params(**kargs)
       uri.query = URI.encode_www_form(params)
 
       req = Net::HTTP::Get.new(uri)
-      req['Authorization'] = "Bearer #{ENV['INDICO_TOKEN']}" if ENV['INDICO_TOKEN']
+      req.read_timeout = timeout if timeout
+      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) }
 
@@ -78,21 +83,5 @@ module JekyllIndico
 
       parsed['results'].each(&block)
     end
-
-    # Automatically signs request if environment has INDICO_API/SECRET_KEY
-    def build_params(**kargs)
-      kargs[:pretty] = 'no'
-
-      if ENV['INDICO_API_KEY'] && !ENV['INDICO_TOKEN']
-        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
-
-      kargs
-    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,12 +16,9 @@ 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 list!') unless meeting_ids.is_a?(Array)
+      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)
@@ -32,18 +29,23 @@ module JekyllIndico
 
     def collect_meeting(name, number)
       base_url = @site.config.dig('indico', 'url')
-      raise MissingURL('indico: url: MISSING from your config!') unless 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
 
+      timeout = @site.config.dig('indico', 'timeout')
+
       # 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)
+        @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.0'
+  VERSION = '0.4.4'
 end

metadata

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