Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Stremio/addon-helloworld-ruby
Ruby addon example for stremio
https://github.com/Stremio/addon-helloworld-ruby
Last synced: about 2 months ago
JSON representation
Ruby addon example for stremio
- Host: GitHub
- URL: https://github.com/Stremio/addon-helloworld-ruby
- Owner: Stremio
- Created: 2019-02-13T11:02:40.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-02-15T15:12:53.000Z (almost 6 years ago)
- Last Synced: 2024-07-31T15:02:55.707Z (5 months ago)
- Language: Ruby
- Size: 7.81 KB
- Stars: 3
- Watchers: 6
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-stremio - Ruby Addon Example & Tutorial
README
# Hello world add-on for Stremio in Ruby
## Adds a few public domain movies to Stremio
This example shows how to make a Stremio Add-on in Ruby with Rack.
## Quick Start
Clone or download this repo and run the following commands in the repo's root directory:
```sh
bundle install
bundle exec rackup -p 9292 config.ru
```
If you don't have `bundler` installed, you can do that easily with:
```sh
gem install bundler
```
## Basic tutorial on how to re-create this add-on step by step
## Step 1: init a project
### Pre-requisites: git, ruby, rubygems
> NOTE: On some operation systems rubygems are included in the ruby package
This is the first, boilerplate step of creating an add-on for Stremio.
```sh
mkdir stremio-hello-world
cd stremio-hello-world
bundle init
echo "gem 'rack'" >> Gemfile
bundle install
git init
git add *
git commit -a -m "initial commit"
```
## Step 2: Create `stremio-addon.rb` and `config.ru`
Let's start with our add-on basic functionality. Create `stremio-addon.rb` with the following contents:
```ruby
require 'json'
require 'uri'
MANIFEST = {
id: "org.stremio.helloruby",
version: "1.0.0",
name: "Hello Ruby Add-on",
description: "Sample addon made with Rack providing a few public domain movies",
types: [ :movie, :series ],
catalogs: [],
resources: []
}
class NotFound
def call(env)
[404, {"Content-Type" => "text/plain"}, ["404 Not Found"]]
end
end
# Base class with some common behaviour
class Resource
@@headers = {
"Access-Control-Allow-Origin" => "*",
"Access-Control-Allow-Headers" => "*",
"Content-Type" => "application/json"
}
def initialize(app)
@app = app
end
def parse_request(env)
segments = env["PATH_INFO"][1..-1] # Remove the leading slash
.sub(/\.\w+$/, '') # Remove extension if any
.split("/")
.map { |seg| URI.decode(seg) }
{ type: segments[0], id: segments[1], extraArgs: segments[2..-1] }
end
end
class Manifest < Resource
def call(env)
return @app.call(env) unless env["PATH_INFO"].empty?
[200, @@headers, [ MANIFEST.to_json ]]
end
end
```
The `NotFound` class will be used by our app to serve any request that we don't handle explicitly.
`Resource` is a helper class that provides a common functionality for all other classes.
The manifest is the most important part of our add-on. It tells Stremio what are the add-on's capabilities. We define an `MANIFEST` object in the beginning of our scrip and the `Manifest` class serves it statically. The full specification of the add-on manifest is described [here](https://github.com/Stremio/stremio-addon-sdk/blob/master/docs/api/responses/manifest.md).
We need a basic `rack` app, so we will use `Rack::Builder` in our `config.ru` for a quick start:
```ruby
require './stremio-addon.rb'
app = Rack::Builder.new do
use Rack::Reloader
use Rack::ContentLength
map "/manifest.json" do
use Manifest
end
run NotFound.new
end.to_app
run app
```
Now we can test that everything is working by running:
```shell
bundle exec rackup -p 9292 config.ru
```
Now go to [http://localhost:9292/manifest.json](http://localhost:9292/manifest.json) and check if the add-on manifest is served correctly.
You can stop the add-on by pressing Ctrl+C.
## Step 3: Basic streaming
First let's update our manifest, so Stremio will know that our add-on support streams. Change the `resources` section of the manifest from:
```ruby
resources: []
```
to this:
```ruby
resources: [
{ name: "stream", types: [ "movie", "series" ], idPrefixes: [ "tt", "hrb" ] }
]
```
To implement basic streaming, we will define a hash with a few public domain movies, just after the manifest definition.
```ruby
STREAMS = {
"movie" => {
"tt0032138" => [
{ title: "Torrent", infoHash: "24c8802e2624e17d46cd555f364debd949f2c81e", fileIdx: 0 }
],
"tt0017136" => [
{ title: "Torrent", infoHash: "dca926c0328bb54d209d82dc8a2f391617b47d7a", fileIdx: 1 }
],
"tt0051744" => [
{ title: "Torrent", infoHash: "9f86563ce2ed86bbfedd5d3e9f4e55aedd660960" }
],
"tt1254207" => [
{ title: "HTTP URL", url: "http://clips.vorwaerts-gmbh.de/big_buck_bunny.mp4" }
],
"tt0031051" => [
{ title: "YouTube", ytId: "m3BKVSpP80s" }
],
"tt0137523" => [
{ title: "External URL", externalUrl: "https://www.netflix.com/watch/26004747" }
]
},
"series" => {
"tt1748166:1:1" => [
{ title: "Torrent", infoHash: "07a9de9750158471c3302e4e95edb1107f980fa6" }
],
"hrbtt0147753:1:1" => [
{ title: "YouTube", ytId: "5EQw5NYlbyE" }
],
"hrbtt0147753:1:2" => [
{ title: "YouTube", ytId: "ZzdBKcVzx9Y" }
],
}
}
```
And then implement the `/stream/` path.
First add the class that will handle the response inside `stremio-addon.rb`:
```ruby
class Stream < Resource
def call(env)
args = parse_request(env)
return @app.call(env) unless STREAMS.key?(args[:type])
streams = {
streams: STREAMS[args[:type]][args[:id]] || []
}
[200, @@headers, [streams.to_json]]
end
end
```
Now let `rack` know that our `Stream` class handles that path by appending one more mapping after `Manifest`:
```ruby
map "/stream" do
use Stream
end
```
So your `config.ru` should look like this:
```ruby
require './stremio-addon.rb'
app = Rack::Builder.new do
use Rack::Reloader
use Rack::ContentLength
map "/manifest.json" do
use Manifest
end
map "/stream" do
use Stream
end
run NotFound.new
end.to_app
run app
```
**As you can see, this is an add-on that allows Stremio to stream 6 public domain movies and 3 series episode - in very few lines of code.**
Depending on your source, you can implement streaming (/stream/) or catalogs (/catalog/) of movie, series, channel or tv content types.
To load that add-on in the desktop Stremio, start the add-on, as described above, then click the add-on button (puzzle piece icon) on the top right, and write [http://127.0.0.1:9292/manifest.json](http://127.0.0.1:9292/manifest.json) in the "Addo-n Repository Url" field on the top left.
## Step 4: Implement catalog
We have 2 types of resources serving meta:
/catalog/ serves basic metadata (id, type, name, poster) and handles loading of both the catalog feed and searching;
/meta/ serves advanced metadata for individual items, for imdb ids though (what we're using in this example add-on), we usualy do not need to handle this method at all as it is handled automatically by Stremio's Cinemeta
**For now, we have the simple goal of loading the movies we provide on the top of Discover.**
Lets's tell Stremio that we will handle catalog.
We will update our manifest to reflect that.
```ruby
catalogs: [
{ type: :movie, id: "Hello, Ruby" },
{ type: :series, id: "Hello, Ruby" }
],
resources: [
"catalog",
{ name: "stream", types: [ "movie", "series" ], idPrefixes: [ "tt", "hrb" ] }
]
```
As you can see we define two catalogs - one for movies and one for series. In the `resources` section we state that the `catalog` resource is also supported by our add-on.
Now we can append our catalog data into the `stremio-addon.rb` file:
```ruby
CATALOG = {
"movie" => [
{ id: "tt0032138", name: "The Wizard of Oz", genres: [ :Adventure, :Family, :Fantasy, :Musical ] },
{ id: "tt0017136", name: "Metropolis", genres: [:Drama, :"Sci-Fi"] },
{ id: "tt0051744", name: "House on Haunted Hill", genres: [:Horror, :Mystery] },
{ id: "tt1254207", name: "Big Buck Bunny", genres: [:Animation, :Short, :Comedy], },
{ id: "tt0031051", name: "The Arizona Kid", genres: [:Music, :War, :Western] },
{ id: "tt0137523", name: "Fight Club", genres: [:Drama] }
],
"series" => [
{
id: "tt1748166",
name: "Pioneer One",
genres: [:Drama],
videos: [
{ season: 1, episode: 1, id: "tt1748166:1:1", title: "Earthfall", released: "2010-06-16" }
]
},
{
id: "hrbtt0147753",
name: "Captain Z-Ro",
description: "From his secret laboratory, Captain Z-Ro and his associates use their time machine, the ZX-99, to learn from the past and plan for the future.",
releaseInfo: "1955-1956",
logo: "https://fanart.tv/fanart/tv/70358/hdtvlogo/captain-z-ro-530995d5e979d.png",
imdbRating: 6.9,
genres: [:"Sci-Fi"],
videos: [
{ season: 1, episode: 1, id: "hrbtt0147753:1:1", title: "Christopher Columbus", released: "1955-12-18" },
{ season: 1, episode: 2, id: "hrbtt0147753:1:2", title: "Daniel Boone", released: "1955-12-25" }
]
}
]
}
```
Then let's handle the catalog route.
```ruby
class Catalog < Resource
def call(env)
args = parse_request(env)
return @app.call(env) unless CATALOG.key?(args[:type])
metaPreviews = CATALOG[args[:type]].map do |item|
{
id: item[:id],
type: args[:type],
name: item[:name],
genres: item[:genres],
poster: METAHUB_URL % item[:id]
}
end
catalog = { metas: metaPreviews }
[200, @@headers, [catalog.to_json]]
end
end
```
Don't forget to update the `config.ru` with the new route:
```ruby
map "/catalog" do
use Catalog
end
```
If you run and install your add-on right now you'll notice that the new catalogs appear in the Stremio's Board and also you have this catalogs in the left pane of the discover. You can also play the videos from the sources we provide.
However, for the sake of completeness, we'll handle one more case, where Cinemeta is unable to find information about the content.
## Step 5: Implement meta
Maybe you have noticed that in the catalog that we defined in **Step 4**, there is more data than the one we provide on catalog request. There is also an item with `id` prefixed with `hrb` instead of `tt`.
Cinemeta looks up the media by IMDB ID so it can't find data for our `hrb` prefixed entry. This is the case where our add-on must provide that data.
We already have all the information needed, so let's expose it.
First we will again update our add-on's manifest.
```ruby
resources: [
"catalog",
# The meta call will be invoked only for series with ID starting with hrb
{ name: "meta", types: [ "series" ], idPrefixes: [ "hrb" ] },
{ name: "stream", types: [ "movie", "series" ], idPrefixes: [ "tt", "hrb" ] }
]
```
The `idPrefixes` defines a list of prefixes that we can handle. Stremio will not ask our add-on for data on `ID` that doesn't start with some of the predefined prefixes. If we omit this parameter, Stremio will ask our add-on for any item it encounters.
With the updated manifest, we are ready to handle the `/meta/` request.
```ruby
OPTIONAL_META = [:posterShape, :background, :logo, :videos, :description, :releaseInfo, :imdbRating, :director, :cast, :dvdRelease, :released, :inTheaters, :certification, :runtime, :language, :country, :awards, :website, :isPeered]
class Meta < Resource
def call(env)
args = parse_request(env)
return @app.call(env) unless CATALOG.key?(args[:type])
item = CATALOG[args[:type]].detect { |item| item[:id] == args[:id] }
meta = { meta: nil }
unless item.nil? then
# Build the meta info
meta[:meta] = {
id: item[:id],
type: args[:type],
name: item[:name],
genres: item[:genres],
poster: METAHUB_URL % item[:id]
}
# Populate optional values
OPTIONAL_META.each { |tag| meta[:meta][tag] = item[tag] if item.key?(tag) }
end
[200, @@headers, [meta.to_json]]
end
end
```
The last thing we have to do is to update our `config.ru` with the `/meta/` route.
```ruby
map "/meta" do
use Meta
end
```
That's it. We are ready with our add-on. You can now load it into Stremio and start steaming.