jekyll-indico 0.4.1 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0dcfd6b6c484e7b1733fa6ac09b3b1835c64127f
-  data.tar.gz: 71a26d70ac96e8a8c0b1d6110af6c9b24373680d
+  metadata.gz: 91bed0b6b864fa3f7a1b8dee140c9f9eb791823b
+  data.tar.gz: 6519f4dd2b0681d3961ce636733701342eed4a7d
 SHA512:
-  metadata.gz: 22be7365dca3c8491af78d56164cc4b5eeffa4e969d2436792cd30ae3b2a2b79ed474198d00b9636b9fa2b9fa9bbf37b3e989b96b5026dc11faaeed010508b89
-  data.tar.gz: eaa61758e36bf45ffd78ed807bd1acdd4e1d678a41d4c88765f057bf622391ec7bc4b90e41f5c2c72fc97637cba2581749304b59da78c76f6840b4715d0d80ea
+  metadata.gz: 1f5064ba79a8af25de947a654f5718e70b48a19533f05afa1cb6739ffd07a9c6c25d4296def57d50b00a5f34e57467629ad048b5d6ed6858d6fbb8811dca7d79
+  data.tar.gz: 260ecb6e6b9b1801928d0f6eeb204e71217db6f3e6d5fd77128fe750128b976d5401725556054c939cad347f2aebb7071540b35ac4dd08931584d121f35831c1

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+# 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.
+
 # Version 0.4.1
 
 Fix a few issues in Jekyll generator.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jekyll-indico (0.4.1)
+    jekyll-indico (0.4.5)
       jekyll (>= 3.8, < 5.0)
 
 GEM

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,36 +63,27 @@ 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']
+      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
+
+      opts = { use_ssl: true }
+      opts[:read_timeout] = timeout if timeout
 
-      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['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,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,18 @@ 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')
+
       # 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.1'
+  VERSION = '0.4.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-indico
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.5
 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