jekyll-indico 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9222f10d181e9fc090dede1530321b6d25cf1f25c847ed701b0b27d0dc09aef
-  data.tar.gz: 7ef2fef6b5dfdab7f5e54afda3471180f262e0fda96f86e65cb477ce95bc3875
+  metadata.gz: 4b5280223b8fb9efe76165961a2de236de282fb658813ac140bf5e99f7478889
+  data.tar.gz: 2e38b6c7f139929a2d37a303edd43c5c25c2d3653fed79b45d139850eb2df647
 SHA512:
-  metadata.gz: b8cd5282b1d97250f191825b79d74a9a1e10457dbaa7a959cca6526e3232fc8fa2f209b3c453ef05499232f202be4dc7259066991383a99cf25776f79d78b86f
-  data.tar.gz: e99096baf780ed5ebafd2d63b262bcb526f1caf0b075c0eecc1a8353233c836b361fea73140f93535be7b7757977e84648ef030a5551f6aafd9d5d1553183ee3
+  metadata.gz: 1777d731abaaea07081f4127a0058579092f7914f03fa8c558fa7ffa69510863dd875b7fdeff0efd47ee2f84fd127d12a4865e232cb530ea485195c563c957d1
+  data.tar.gz: ac4b4a99ef43e216a1b91e6607a01cfc399be3e3435bfd51d7f4e2580196e9efaca84b1856b334a37a1552df386c564dc3f85bb693647e248817a475b16eed63

data/.github/workflows/ci.yml

@@ -1,10 +1,11 @@
-name: Ruby
+name: CI
 
 on:
   workflow_dispatch:
   pull_request:
   push:
-    branches: [ $default-branch ]
+    branches:
+      - main
 
 jobs:
   test:

data/CHANGELOG.md

@@ -1,8 +1,13 @@
+# Version 0.2.0
+
+Support for base URLs. The `indico: url:` parameter is *required*.
+
 # Version 0.1.0
 
 First version to be published, pulled from the IRIS-HEP website.
 
 Extra features added during the transition include:
+
 * Config settings for IDs and data path.
 * `jekyll-indico-cache` script has customizable `--config` location.
 * Some basic unit testing

data/Gemfile.lock

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

data/README.md

@@ -1,3 +1,8 @@
+# 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)
+
 This is a tool for importing meeting information from Indico.
 
 #### Setup: config
@@ -6,6 +11,7 @@ Your `_config.yaml` file should contain the categories you want to download:
 
 ```yaml
 indico:
+  url: https://indico.cern.ch # Indico instance to use (REQUIRED)
   data: indico # Optional, folder name in _data to use
   ids:
     topical: 10570
@@ -37,17 +43,26 @@ If you want to cache for local website development, you can run:
 bundle exec jekyll-indico-cache --config _config.yaml
 ```
 
-<!-- Feature not added yet
-Or, if you use rake, you can add the provided task:
+Or, if you use rake, you can add a task like this:
 
 ```ruby
-require 'jekyll-indico/rake_task'
-
-JekyllIndico::RakeTask.new(:cache)
+task: cache do
+  sh 'jekyll-indico-cache'
+end
 ```
 
 Now the "cache" task will cache your Indico reads.
--->
+
+
+#### Internals
+
+This works by calling the Indico API and pulling meeting information, then
+storing it in `site.data[config.indico.data][config.indico.id][number]` (or
+caching it in
+`_data/<config.indico.data>/<config.indico.id.key>/<number>.yml`). This then
+available directly in liquid from this location. You can have as many ids as
+you want (key is a category name that you select, the value is the group ID
+number on Indico).
 
 #### Setting up for development:
 

data/exe/jekyll-indico-cache

@@ -19,8 +19,9 @@ puts "Reading #{options[:config]}"
 
 config = YAML.safe_load(File.read(options[:config]))
 meeting_ids = JekyllIndico::Meetings.meeting_ids(config)
+base_url = JekyllIndico::Meetings.base_url(config)
 data_path = config.dig('indico', 'data') || 'indico'
 
-JekyllIndico.cache(meeting_ids, data_path) do |name, number|
+JekyllIndico.cache(base_url, meeting_ids, data_path) do |name, number|
   puts "Accessing #{number} for #{name}"
 end

data/lib/jekyll-indico/cache.rb

@@ -9,7 +9,7 @@ require 'jekyll-indico/core'
 module JekyllIndico
   # This will cache the hash of meeting IDs given into the data_path in _data
   # in the current directory.
-  def self.cache(meeting_ids, data_path)
+  def self.cache(base_url, meeting_ids, data_path)
     meeting_ids.each do |name, number|
       yield name, number
       indico_dir = Pathname.new('_data') / data_path
@@ -17,7 +17,7 @@ module JekyllIndico
       indico_dir.mkdir unless indico_dir.directory?
       folder.mkdir unless folder.directory?
 
-      iris_meeting = JekyllIndico::Meetings.new number
+      iris_meeting = JekyllIndico::Meetings.new(base_url, number)
       iris_meeting.to_files(folder) { |key| puts "Making #{folder / key}.yml\n" }
     end
   end

data/lib/jekyll-indico/core.rb

@@ -9,15 +9,21 @@ require 'time'
 require 'openssl'
 
 module JekyllIndico
+  class Error < StandardError
+  end
+
+  class MissingURL < Error
+  end
+
   # Look for topical meetings
   class Meetings
     attr_accessor :dict
 
     # ID for IRIS-HEP: 10570
-    def initialize(indico_id, **kargs)
+    def initialize(base_url, indico_id, **kargs)
       @dict = {}
 
-      download_and_iterate(indico_id, **kargs) do |i|
+      download_and_iterate(base_url, indico_id, **kargs) do |i|
         # Trim paragraph tags
         d = i['description']
         d = d[3..-1] if d.start_with? '<p>'
@@ -56,11 +62,19 @@ module JekyllIndico
       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(indico_id, **kargs, &block)
-      url = build_url(indico_id, **kargs)
+    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)
 
@@ -77,7 +91,7 @@ module JekyllIndico
     end
 
     # Automatically signs request if environment has INDICO_API/SECRET_KEY
-    def build_url(indico_id, **kargs)
+    def build_url(base_url, indico_id, **kargs)
       kargs[:pretty] = 'no'
 
       if ENV['INDICO_API_KEY']
@@ -89,7 +103,7 @@ module JekyllIndico
         end
       end
 
-      "https://indico.cern.ch#{join_url(indico_id, kargs)}"
+      "#{base_url}#{join_url(indico_id, kargs)}"
     end
   end
 end

data/lib/jekyll-indico/generator.rb

@@ -15,13 +15,15 @@ module JekyllIndico
 
       meeting_ids = Meetings.meeting_ids(@site.config)
       meeting_ids.each do |name, number|
-        collect_meeting name.to_s, number
+        collect_meeting(name.to_s, number)
       end
     end
 
     private
 
     def collect_meeting(name, number)
+      base_url = Meetings.base_url(@site.config)
+
       data_path = @site.config.dig('indico', 'data') || 'indico'
       @site.data[data_path] = {} unless @site.data.key? data_path
 
@@ -30,7 +32,7 @@ module JekyllIndico
 
       puts "Accessing Indico meeting API for #{name}:#{number} " \
            '- run `bundle exec rake cache` to cache'
-      iris_meeting = Meetings.new(number)
+      iris_meeting = Meetings.new(base_url, number)
       @site.data[data_path][name] = iris_meeting.dict
     end
   end

data/lib/jekyll-indico/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-indico
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Henry Schreiner