jekyll-indico 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f3a7088e3b7081c49c46f538daeda9508eebdf9
-  data.tar.gz: 1a7c3de25e8ec40d3cc872133dbdf53bb3e96cf0
+  metadata.gz: 42dd6e02ca0145cbd0ab2678b896340909141d15
+  data.tar.gz: 91e3c5ae03e1508c8fb515281ca2ade408c1d453
 SHA512:
-  metadata.gz: fe2cc076a05b4648d61b63fa768c2a94ce6531188a82fa678b8bf0f0a918d24726183051ea1e11fbc000e25581fb00469f207181c427cd76f581bece516aee50
-  data.tar.gz: 7a4d272f85799ee69771612522b889a304ee951199a0147da8c839ad37116ad6c28047da4fe13953ae0d31b600f1b39363d8ac916967658b93b70b7f4e97ae71
+  metadata.gz: 63de08c462ef249ee2e0502aefd8c8104861b3c14f209df3df876875b61f8d6f5632a3ea8c1ae7cb21433c00b2f337cca7bf30163aca07ae5503d3d5ef8c8527
+  data.tar.gz: c3cec693a86e94decf78b38af462ef7632ba567242171297feeba47af30f49d640f9c75da3d082ce575f045d2a979eeec680db49932c37afafe6dee845a5cb9b

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,9 @@
+# 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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jekyll-indico (0.3.0)
+    jekyll-indico (0.4.0)
       jekyll (>= 3.8, < 5.0)
 
 GEM

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`. If you use the deprecated API, this plugin will automatically
+sign your requests if your environment contains `INDICO_API` and
+`INDICO_SECRET_KEY`.
 
 #### 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,26 +60,18 @@ 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)
+      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']
+
+      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
@@ -84,17 +79,11 @@ module JekyllIndico
       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)
+    def build_params(**kargs)
       kargs[:pretty] = 'no'
 
-      if ENV['INDICO_API_KEY']
+      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
@@ -103,7 +92,7 @@ module JekyllIndico
         end
       end
 
-      "#{base_url}#{join_url(indico_id, kargs)}"
+      kargs
     end
   end
 end

data/lib/jekyll-indico/generator.rb

@@ -6,6 +6,8 @@ require 'jekyll'
 
 require 'jekyll-indico/core'
 
+require 'net/http'
+
 module JekyllIndico
   # This is a Jekyll Generator
   class GetIndico < Jekyll::Generator
@@ -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 list!') unless meeting_ids.is_a?(Array)
+
       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 url
 
       data_path = @site.config.dig('indico', 'data') || 'indico'
       @site.data[data_path] = {} unless @site.data.key? data_path

data/lib/jekyll-indico/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllIndico
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 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.0
 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