jekyll-indico 0.2.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 4b5280223b8fb9efe76165961a2de236de282fb658813ac140bf5e99f7478889
-  data.tar.gz: 2e38b6c7f139929a2d37a303edd43c5c25c2d3653fed79b45d139850eb2df647
+SHA1:
+  metadata.gz: 0dcfd6b6c484e7b1733fa6ac09b3b1835c64127f
+  data.tar.gz: 71a26d70ac96e8a8c0b1d6110af6c9b24373680d
 SHA512:
-  metadata.gz: 1777d731abaaea07081f4127a0058579092f7914f03fa8c558fa7ffa69510863dd875b7fdeff0efd47ee2f84fd127d12a4865e232cb530ea485195c563c957d1
-  data.tar.gz: ac4b4a99ef43e216a1b91e6607a01cfc399be3e3435bfd51d7f4e2580196e9efaca84b1856b334a37a1552df386c564dc3f85bb693647e248817a475b16eed63
+  metadata.gz: 22be7365dca3c8491af78d56164cc4b5eeffa4e969d2436792cd30ae3b2a2b79ed474198d00b9636b9fa2b9fa9bbf37b3e989b96b5026dc11faaeed010508b89
+  data.tar.gz: eaa61758e36bf45ffd78ed807bd1acdd4e1d678a41d4c88765f057bf622391ec7bc4b90e41f5c2c72fc97637cba2581749304b59da78c76f6840b4715d0d80ea

data/.github/workflows/ci.yml

@@ -13,11 +13,13 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
+
+    - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.4
-    - name: Install dependencies
-      run: bundle install
+        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

@@ -0,0 +1,18 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.1.0
+  hooks:
+  - id: check-added-large-files
+  - id: mixed-line-ending
+  - id: trailing-whitespace
+  - id: check-merge-conflict
+  - id: check-case-conflict
+  - id: check-symlinks
+  - id: check-yaml
+
+- repo: https://github.com/Lucas-C/pre-commit-hooks
+  rev: v1.1.11
+  hooks:
+  - id: remove-crlf
+  - id: forbid-tabs
+    exclude_types: [svg]

data/.ruby-version

@@ -0,0 +1 @@
+2.4.10

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+# 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.
+
+# Version 0.2.1
+
+Fix manual caching.
+
 # Version 0.2.0
 
 Support for base URLs. The `indico: url:` parameter is *required*.

data/Gemfile.lock

@@ -1,83 +1,79 @@
 PATH
   remote: .
   specs:
-    jekyll-indico (0.2.0)
+    jekyll-indico (0.4.1)
       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.14.2)
+    ffi (1.15.5)
     forwardable-extended (2.6.0)
-    http_parser.rb (0.6.0)
-    i18n (1.8.8)
+    http_parser.rb (0.8.0)
+    i18n (0.9.5)
       concurrent-ruby (~> 1.0)
-    jekyll (4.2.0)
+    jekyll (3.9.1)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
-      i18n (~> 1.0)
-      jekyll-sass-converter (~> 2.0)
+      i18n (~> 0.7)
+      jekyll-sass-converter (~> 1.0)
       jekyll-watch (~> 2.0)
-      kramdown (~> 2.3)
-      kramdown-parser-gfm (~> 1.0)
+      kramdown (>= 1.17, < 3)
       liquid (~> 4.0)
-      mercenary (~> 0.4.0)
+      mercenary (~> 0.3.3)
       pathutil (~> 0.9)
-      rouge (~> 3.0)
+      rouge (>= 1.7, < 4)
       safe_yaml (~> 1.0)
-      terminal-table (~> 2.0)
-    jekyll-sass-converter (2.1.0)
-      sassc (> 2.0.1, < 3.0)
+    jekyll-sass-converter (1.5.2)
+      sass (~> 3.4)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
-    kramdown (2.3.0)
+    kramdown (2.3.1)
       rexml
-    kramdown-parser-gfm (1.1.0)
-      kramdown (~> 2.0)
     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.4.0)
+    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)
@@ -95,17 +91,18 @@ GEM
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.11.0)
     safe_yaml (1.0.5)
-    sassc (2.4.0)
-      ffi (~> 1.9)
-    terminal-table (2.0.0)
-      unicode-display_width (~> 1.1, >= 1.1.1)
-    unicode-display_width (1.7.0)
+    sass (3.7.4)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler (~> 2.0)
   jekyll-indico!
   rake (~> 13.0)
   rspec (~> 3.0)
@@ -114,4 +111,4 @@ DEPENDENCIES
   rubocop-rspec (~> 2.2)
 
 BUNDLED WITH
-   1.17.3
+   2.2.8

data/README.md

@@ -1,7 +1,7 @@
 # Jekyll-Indico
 
 [![Gem Version](https://badge.fury.io/rb/jekyll-indico.svg)](https://badge.fury.io/rb/jekyll-indico)
-![CI](https://github.com/iris-hep/jekyll-indico/workflows/CI/badge.svg)
+[![CI](https://github.com/iris-hep/jekyll-indico/workflows/CI/badge.svg)](https://github.com/iris-hep/jekyll-indico/actions?query=workflow%3ACI)
 
 This is a tool for importing meeting information from Indico.
 
@@ -13,14 +13,16 @@ Your `_config.yaml` file should contain the categories you want to download:
 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
   ids:
     topical: 10570
     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
 
@@ -69,16 +71,23 @@ 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
 ```
 
-To release, make sure the version is new then:
+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 install` then:
 
 ```bash
-bundle exec rake publish
+bundle exec rake release
 ```
 
 This tags, pushes the tag, and publishes.

data/jekyll-indico.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'jekyll', '>= 3.8', '< 5.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 1.9'

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
@@ -53,30 +56,22 @@ module JekyllIndico
     def to_files(folder)
       @dict.each do |key, dict|
         yield key if block_given?
-        file.write(folder / "#{key}.yml", dict.to_yaml)
+        File.write(folder / "#{key}.yml", dict.to_yaml)
       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,14 +6,23 @@ require 'jekyll'
 
 require 'jekyll-indico/core'
 
+require 'net/http'
+
 module JekyllIndico
   # This is a Jekyll Generator
   class GetIndico < Jekyll::Generator
     # Main entry point for Jekyll
     def generate(site)
       @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)
 
-      meeting_ids = Meetings.meeting_ids(@site.config)
       meeting_ids.each do |name, number|
         collect_meeting(name.to_s, number)
       end
@@ -22,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
@@ -30,8 +40,8 @@ module JekyllIndico
       # Do nothing if already downloaded
       return if @site.data[data_path].key? name
 
-      puts "Accessing Indico meeting API for #{name}:#{number} " \
-           '- run `bundle exec rake cache` to cache'
+      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
     end

data/lib/jekyll-indico/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-indico
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Henry Schreiner
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-04 00:00:00.000000000 Z
+date: 2022-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +114,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
-description: 
+description:
 email:
 - henryschreineriii@gmail.com
 executables:
@@ -124,8 +124,10 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
 - ".gitignore"
+- ".pre-commit-config.yaml"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -149,7 +151,7 @@ metadata:
   homepage_uri: https://rubygems.org/gems/jekyll-indico
   source_code_uri: https://github.com/iris-hep/jekyll-indico
   changelog_uri: https://github.com/iris-hep/jekyll-indico/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -164,8 +166,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.6.14.4
+signing_key:
 specification_version: 4
 summary: Read and/or cache indico meeting lists for Jekyll
 test_files: []