jekyll-twitch 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e8a9ab0203d9deaa19ce8d026ee33a63c013650961798c3ef9ca85ef27033ef
-  data.tar.gz: 2a82b63af6524ed3a23869f58452885609a9b5a26a97f90ea2976a4ca3c4b992
+  metadata.gz: a55749b9d60817241db98a15db62ca1c715c81cc00430253123244fc4280795f
+  data.tar.gz: 1ed87896070266cb77c96ac8da604e1c80445f87c8a93d5e7e47875c90db8387
 SHA512:
-  metadata.gz: ab5f9314d65a9538344b7df4cbf18a4edf6743f9b6589e80448c5f36cd9a3e595d118b37b97ec307516733046b77972c61a8fbd81ff93278597b62ec1b3ad01a
-  data.tar.gz: bd09c881bbb44701752de5b2b6f0044426234a48620a052bee37c7abf24fbf76fbb95f517ff213d8f384652423a4947ae19834f60426ec3761b1b9059cc24bfe
+  metadata.gz: 05c153844c2a5295362172f491d33b5d1d0e1b2c1f267b4fd6d6f56d1e63c3f6c3d5d5813d7066b582e2f8e68378b1a956008f2b8d2af2eda488cd3c11114131
+  data.tar.gz: 2924ab54374abccfda4f49fc06b44309e213b7b505b36d67451a6b52e7a16cf047d1bd0ef4ec0696e8bbd42526bb155e8d21fdfc769c1a13611dedbc3bced8a1

data/CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/ChaelCodes/jekyll-twitch. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ChaelCodes/jekyll-twitch/blob/main/CODE_OF_CONDUCT.md).
+
+## Gem Development
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Demo Site Development
+Jekyll-Twitch has a demo site for testing and demonstrating its capabilities. It is located in [docs](/docs) and deployed via [GitHub Actions](.github/workflows/deploy-demo.yml) to GitHub Pages. It uses the copy of jekyll-twitch available on main, but can be customized to look at a specific branch in the [Gemfile](docs/Gemfile).
+
+### Run it locally
+
+1. navigate to the docs directory `cd docs`
+1. `bundle install` Installs all gems and dependencies according to Gemfile.lock
+1. `bundle update jekyll-twitch` Updates Jekyll-twitch to the newest version from main
+1. `bundle exec jekyll serve --host localhost --port 4000` Run the server - we need the port and host for Twitch's embeds
+
+Website should be up and running at [http://localhost:4000/jekyll-twitch/](http://localhost:4000/jekyll-twitch/)
+
+You will need to rerun steps 3 and 4 whenever there are changes on main or pushed to your branch that you want to test on the site.
+
+## Release a new Version
+- Ensure all desired changes are merged to the `main` branch
+- checkout a branch with the version number eg. `git checkout -b 1.0.1`
+- Update the version number in [version.rb](lib/jekyll-twitch/version.rb)
+   - We use [semantic versioning](https://semver.org/)
+- Add a new post to the demo site describing the changes, and linking to the PRs that changed them
+- `bundle update jekyll-twitch` on the docs site to get the newest changes from `main`
+- Test `main` on the demo site
+- Run `bundle exec rake release`
+   - This will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/Gemfile.lock

@@ -1,29 +1,29 @@
 PATH
   remote: .
   specs:
-    jekyll-twitch (1.0.0)
+    jekyll-twitch (1.0.1)
       jekyll
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     coderay (1.1.3)
     colorator (1.1.0)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.4.4)
-    em-websocket (0.5.2)
+    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)
-    i18n (1.8.9)
+    http_parser.rb (0.8.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    jekyll (4.2.0)
+    jekyll (4.2.2)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
@@ -38,16 +38,16 @@ GEM
       rouge (~> 3.0)
       safe_yaml (~> 1.0)
       terminal-table (~> 2.0)
-    jekyll-sass-converter (2.1.0)
+    jekyll-sass-converter (2.2.0)
       sassc (> 2.0.1, < 3.0)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
-    kramdown (2.3.1)
+    kramdown (2.4.0)
       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)
@@ -60,15 +60,15 @@ GEM
     pry (0.14.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (4.0.6)
+    public_suffix (5.0.0)
     rainbow (3.0.0)
     rake (12.3.3)
-    rb-fsevent (0.10.4)
+    rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     regexp_parser (2.1.1)
-    rexml (3.2.4)
-    rouge (3.26.0)
+    rexml (3.2.5)
+    rouge (3.30.0)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)

data/README.md

@@ -1,9 +1,12 @@
 # Jekyll::Twitch
 
-This gem allows you to embed twitch clips in your Jekyll websites. It adds and registers a new twitch liquid tag that accepts a twitch clip url.
+This gem allows you to embed twitch channels, clips, collections, and videos in your Jekyll websites. It adds and registers a new twitch liquid tag that accepts a twitch clip, channel, broadcast, or highlight url. It's based on the [Twitch video embeds](https://dev.twitch.tv/docs/embed/video-and-clips).
 
 `{% twitch https://www.twitch.tv/chaelcodes/clip/SpoopySlipperyGrasshopperPogChamp %}`
 
+## [See the DEMO site](https://www.chael.codes/jekyll-twitch/)
+Check out the [demo site](https://www.chael.codes/jekyll-twitch/) for install instructions and to review different embed examples.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -28,22 +31,49 @@ plugins:
 
 ## Usage
 
+This is a Jekyll liquid tag, so just put `{% twitch  https://www.twitch.tv/chaelcodes/clip/SpoopySlipperyGrasshopperPogChamp %}` to embed your clip, channel, or broadcast.
+
 When building your site, Jekyll no longer substitutes `site.url` for localhost, which means Twitch embeds will not render. You need to supply host and localhost to view clips in development. `jekyll serve --host localhost --port 4000`
 
-This is a Jekyll liquid tag, so just put `{% twitch  https://www.twitch.tv/chaelcodes/clip/SpoopySlipperyGrasshopperPogChamp %}` to embed your clip.
+All of the below examples are on the demo site with actual embeds. I strongly recommend using that.
+
+### Channel
+This channel embed will show the broadcast while the streamer is live, and the channel offline art when they are not.
 
-We intend to support broadcasts and videos soon.
+```
+<div style="width:720px;height:480px">
+  {% twitch https://twitch.tv/ChaelCodes %}
+</div>
+```
+### Collection
+This embed is used to add a collection of videos to your page or post.
 
-## Development
+```
+<div style="width:720px;height:480px">
+  {% twitch https://www.twitch.tv/collections/x5bG2TGTeBYIRg %}
+</div>
+```
+### Clips
+This embed is used to add one Twitch clip to your page or post.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```
+<div style="width:720px;height:480px">
+  {% twitch https://www.twitch.tv/chaelcodes/clip/DeterminedSweetRedpandaDoritosChip-pQiRlDz6rQ9uvuuq %}
+</div>
+```
+### Videos
+Whether you call them videos, vods, or higlights, this will embed them in your page or psot.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```
+<div style="width:720px;height:480px">
+  {% twitch https://www.twitch.tv/videos/716698136 %}
+</div>
+```
 
 ## Contributing
-
 Bug reports and pull requests are welcome on GitHub at https://github.com/ChaelCodes/jekyll-twitch. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ChaelCodes/jekyll-twitch/blob/main/CODE_OF_CONDUCT.md).
 
+For more details on setting up the local environment, demo site, and releasing a new version, see our [CONTRIBUTING.md](/CONTRIBUTING.md).
 
 ## License
 

data/docs/Gemfile

@@ -11,6 +11,8 @@ source 'https://rubygems.org'
 # Happy Jekylling!
 gem 'jekyll', '~> 4.2.0'
 
+gem 'webrick' # See https://github.com/jekyll/jekyll/issues/8523 this is a Ruby 3/Jekyll thing
+
 # there were issues with rubygems - remove these later
 gem 'i18n', github: 'ruby-i18n/i18n'
 gem 'rexml', github: 'ruby/rexml'

data/docs/Gemfile.lock

@@ -1,6 +1,6 @@
 GIT
   remote: https://github.com/ChaelCodes/jekyll-twitch.git
-  revision: 88757581284a7e8432ebf26d5fdbe325a02a2698
+  revision: d9233863077a04bc105710d4f1b2767ddbf3473e
   branch: main
   specs:
     jekyll-twitch (1.0.0)
@@ -8,22 +8,22 @@ GIT
 
 GIT
   remote: https://github.com/guard/listen.git
-  revision: 96c9476af3ab383c150e7f533718a2b37d1ede66
+  revision: ded2016a72d05f20d254c8ff25dd272a36c14d08
   specs:
-    listen (3.5.1)
+    listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
 
 GIT
   remote: https://github.com/jekyll/jekyll-feed.git
-  revision: 6d4913fe5017c685d2437f328ab4a9138cea07a8
+  revision: a58064c68f49e63b0741d368cd95bb35ac2c7c5d
   specs:
-    jekyll-feed (0.15.1)
+    jekyll-feed (0.17.0)
       jekyll (>= 3.7, < 5.0)
 
 GIT
   remote: https://github.com/jekyll/minima.git
-  revision: 3cdd14dff1216f561c68329e0b7420c2dc9b796a
+  revision: 41b97699af658128fa9983e5312ca5516641f335
   specs:
     minima (2.5.1)
       jekyll (>= 3.5, < 5.0)
@@ -32,32 +32,32 @@ GIT
 
 GIT
   remote: https://github.com/ruby-i18n/i18n.git
-  revision: f19ee0de1320671856dbc4375ab3f2716d13f03a
+  revision: c5ccd28f8413f44baf6e32aeeb80854471650533
   specs:
-    i18n (1.8.10)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
 
 GIT
   remote: https://github.com/ruby/rexml.git
-  revision: e941ff17ed3dad428d946b15524bb3529e684266
+  revision: afafbacd8a8c1947b63eb0b46d698da76c831d98
   specs:
     rexml (3.2.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     colorator (1.1.0)
-    concurrent-ruby (1.1.8)
-    em-websocket (0.5.2)
+    concurrent-ruby (1.1.10)
+    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)
-    jekyll (4.2.0)
+    http_parser.rb (0.8.0)
+    jekyll (4.2.2)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
@@ -72,13 +72,13 @@ GEM
       rouge (~> 3.0)
       safe_yaml (~> 1.0)
       terminal-table (~> 2.0)
-    jekyll-sass-converter (2.1.0)
+    jekyll-sass-converter (2.2.0)
       sassc (> 2.0.1, < 3.0)
-    jekyll-seo-tag (2.7.1)
+    jekyll-seo-tag (2.8.0)
       jekyll (>= 3.8, < 5.0)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
-    kramdown (2.3.1)
+    kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
@@ -86,20 +86,21 @@ GEM
     mercenary (0.4.0)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    public_suffix (4.0.6)
-    rb-fsevent (0.10.4)
+    public_suffix (5.0.0)
+    rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rouge (3.26.0)
+    rouge (3.30.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)
+    unicode-display_width (1.8.0)
+    webrick (1.7.0)
 
 PLATFORMS
-  ruby
+  x86_64-linux
 
 DEPENDENCIES
   i18n!
@@ -112,6 +113,7 @@ DEPENDENCIES
   tzinfo (~> 1.2)
   tzinfo-data
   wdm (~> 0.1.1)
+  webrick
 
 BUNDLED WITH
-   2.1.4
+   2.3.23

data/docs/_posts/2022-10-17-Version-1.0.1-Released.md

@@ -0,0 +1,9 @@
+---
+layout: post
+date: 2021-04-23
+---
+It's been a while since the last release. Jekyll-Twitch is feature complete in my eyes, unless folks start asking for the interactive embeds or custom sizes in the embed. This release just includes security fixes from the last year.
+
+# Changes
+- [#16](https://github.com/ChaelCodes/jekyll-twitch/pull/16) Bump rexml from 3.2.4 to 3.2.5
+- [#17](https://github.com/ChaelCodes/jekyll-twitch/pull/17) Bump addressable from 2.7.0 to 2.8.1

data/docs/index.markdown

@@ -29,3 +29,7 @@ plugins:
 ### Testing in Development
 
 When building your site in development, Jekyll no longer substitutes `site.url` for localhost, which means Twitch embeds will not render. You need to supply host and localhost to view clips in development. `jekyll serve --host localhost --port 4000` This is not an issue in production.
+
+### Deploying using GitHub Pages
+
+If you have custom gems and you're using GitHub pages for your deploys, they will prevent your gems from executing. You need to modify your deploy to use GitHub actions. (This is also the only way to deploy Jekyll 4). You're welcome to use our [deploy setup](.github/workflows/deploy-demo.yml) as an example.

data/jekyll-twitch.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/ChaelCodes/jekyll-twitch'
-  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  spec.metadata["changelog_uri"] = "https://www.chael.codes/jekyll-twitch/"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/jekyll-twitch/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Twitch
-    VERSION = '1.0.0'
+    VERSION = '1.0.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-twitch
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Rachael Wright-Munn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-24 00:00:00.000000000 Z
+date: 2022-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -42,6 +42,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -55,6 +56,7 @@ files:
 - docs/Gemfile.lock
 - docs/_config.yml
 - docs/_posts/2021-04-23-Version-1-Released.md
+- docs/_posts/2022-10-17-Version-1.0.1-Released.md
 - docs/channel.md
 - docs/clips.md
 - docs/collection.md
@@ -70,6 +72,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/ChaelCodes/jekyll-twitch
   source_code_uri: https://github.com/ChaelCodes/jekyll-twitch
+  changelog_uri: https://www.chael.codes/jekyll-twitch/
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -85,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Embed Twitch clips, VODs, and broadcasts in your Jekyll sites.