overscribe 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8e54eb7a38556634f996f36dd60437f16feb17b5018d6dfd2f8ea6c1d9dde36d
+  data.tar.gz: 722d73797fd50d6c2228ae7ff2ab001bc116863c0f7ab5af146c1163cc66c3e1
+SHA512:
+  metadata.gz: 98670c1878fad2a80c43da47301d009f921f15c2e9fa086e4e5ff8ae4f4635fc305177fd4b6649c95e56223590af155a66081f469813a33a9b3845e2f833109e
+  data.tar.gz: d2c27343dbc1c722b73d819841cd7c39b53d22febea8253be469e610879816e41d9a6d46ebb0506d899656c9b60fe2d47830d5a767f7e4b32ab3c24fdf227a98

data/.github/workflows/ci.yaml

@@ -0,0 +1,15 @@
+name: Continuous integration
+
+on: 
+ - push
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.7'
+          bundler-cache: true
+      - run: bundle exec rubocop

data/.gitignore

@@ -0,0 +1,11 @@
+.rspec_status
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,14 @@
+---
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in overscribe.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Romuald Conty
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,95 @@
+# Overscribe
+
+## Usage
+
+### Fetch all collections
+
+```shell
+overscribe collections fetch
+```
+
+### Fetch specific collection(s)
+
+```shell
+overscribe collections fetch "The collections name starts with this"
+```
+
+### List configured collections
+
+```shell
+overscribe collections list
+```
+
+### Fetch medias behind one URL
+
+#### Basic
+
+```shell
+overscribe oneshot \
+  --profile "video hd" \
+  https://example.com/video
+```
+
+`overscribe` will fetch medias pointed by _URL_ using options specified in the `profile`, including the target directory, defined in config file.
+
+#### With collection
+
+If you want to fetch one URL as a collection:
+
+```shell
+overscribe oneshot \
+  --profile audio:album \
+  --collection "Worakls/Sur le front des animaux menacés" \
+  https://www.youtube.com/playlist?list=OLAK5uy_mrpr_HvIdIey7xvzt82EPKRHsuorKOMM4
+```
+
+This `--collection` option will:
+ * append the collection name to the target directory
+ * generate a `overscribe.yaml` config file into target directory
+
+### More
+
+```shell
+overscribe help
+```
+
+## Setup
+
+Create a configuration file in `~/.overscribe.yaml` like:
+
+```
+profiles:
+  audio:
+    directory: '~/Music'
+    youtubedl_args: ['--format', 'bestaudio', '--extract-audio']
+  audio:album:
+    directory: '~/Music'
+    youtubedl_args: ['--format', 'bestaudio', '--extract-audio']
+    filename_pattern: '%(playlist_index)s. %(title)s.%(ext)s'
+  video hd:
+    directory: '~/Videos'
+    youtubedl_args: ['--format' 'bestvideo+bestaudio']
+  video:interview:
+    directory: '~/Videos'
+    youtubedl_args: ['--format', 'bestvideo[height<800]+bestaudio']
+    filename_pattern: '%(upload_date)s - %(title)s.%(ext)s'
+
+collections:
+  "Thinkerview/Sciences":
+    url: https://www.youtube.com/playlist?list=PLnRz6CkWwLlKnn_ggkzcvaBzmZjOoefJP
+    profile: video:interview
+```
+
+### YoutubeDL
+
+_Overscribe_ relies on [youtube-dl](https://youtube-dl.org/).
+
+In configuration file, `youtubedl_args` and `filename_pattern` options should be set according to [youtube-dl documentation](https://github.com/ytdl-org/youtube-dl/blob/master/README.md)
+
+## Contributing
+
+Pull requests are welcome on GitHub at https://github.com/neomilium/overscribe.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'overscribe'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/overscribe

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+require 'overscribe/cli'
+
+begin
+  Overscribe::CLI.start ARGV
+rescue Overscribe::Error => e
+  warn e.message
+  exit 1
+end

data/lib/overscribe/cli.rb

@@ -0,0 +1,54 @@
+require 'overscribe'
+
+require 'thor'
+
+module Overscribe
+  class CLI < Thor
+    class Collections < Thor
+      class_option :simulate,
+                   desc: 'Do not download',
+                   aliases: '-s',
+                   type: :boolean,
+                   default: false
+      desc 'fetch [PATTERN]', 'Fetch collections that start with PATTERN'
+      option :limit,
+             desc: 'Limit downloads per collection',
+             type: :numeric,
+             default: 1
+      def fetch(pattern = nil)
+        Overscribe.fetch_collections(options.merge(pattern: pattern))
+      end
+
+      desc 'list [PATTERN]', 'Fetch collections that start with PATTERN'
+      def list(pattern = nil)
+        puts Overscribe.list_collections(options.merge(pattern: pattern)).keys.join "\n"
+      end
+    end
+
+    desc 'oneshot URL', 'Fetch medias from URL'
+    option :profile,
+           desc: <<~DESC,
+             Use the specified profile to download medias
+             #{' ' * 37}#   Profiles: #{Overscribe.profiles.map { |key, _| key }}
+           DESC
+           aliases: '-p',
+           required: true
+    option :collection,
+           desc: 'Generate a named collection',
+           type: :string
+    option :extra_args,
+           desc: 'Add extra arguments to youtube-dl',
+           aliases: '-x',
+           type: :string
+    def oneshot(url)
+      Overscribe.fetch_oneshot(url, options)
+    end
+
+    desc 'collections', 'Play with collections'
+    subcommand 'collections', CLI::Collections
+
+    def self.exit_on_failure?
+      true
+    end
+  end
+end

data/lib/overscribe/version.rb

@@ -0,0 +1,3 @@
+module Overscribe
+  VERSION = '0.3.1'.freeze
+end

data/lib/overscribe/youtube_dl.rb

@@ -0,0 +1,25 @@
+module Overscribe
+  module YoutubeDL
+    def self.download(url:, args:, options:)
+      command = %w[youtube-dl --add-metadata]
+      command += %w[--yes-playlist]
+      command += %w[--ignore-errors --no-call-home]
+      command += %w[--download-archive .youtube-dl.archive]
+
+      command += %w[--get-filename] if options['simulate'] == true
+      command += %W[--max-downloads #{options['limit']}] unless options['limit'].nil? || options['limit'].zero?
+      command += %W[--output #{options['filename_pattern']}] unless options['filename_pattern'].nil?
+      command += args
+
+      command += [url]
+      run command
+    end
+
+    def self.run(command)
+      puts "Running '#{command}'"
+      system(*command)
+      status = $CHILD_STATUS
+      puts status
+    end
+  end
+end

data/lib/overscribe.rb

@@ -0,0 +1,95 @@
+require 'overscribe/version'
+require 'overscribe/youtube_dl'
+
+require 'active_support'
+require 'active_support/core_ext/hash/deep_merge' # Hash#deep_merge
+
+require 'yaml'
+require 'English'
+
+require 'byebug'
+
+module Overscribe
+  class Error < StandardError; end
+
+  def self.fetch_collections(cli_options)
+    collections = collections(pattern: cli_options['pattern'])
+
+    collections.each do |collection, options|
+      puts ">>> #{collection}"
+      options = profile(name: options['profile']).deep_merge(options).deep_merge(cli_options)
+
+      directory = File.expand_path collection, options['directory']
+      FileUtils.mkdir_p directory
+      FileUtils.chdir(directory) do
+        YoutubeDL.download url: options['url'], args: options['youtubedl_args'], options: options
+      end
+    end
+  end
+
+  def self.list_collections(cli_options)
+    collections(pattern: cli_options['pattern'])
+  end
+
+  def self.fetch_oneshot(url, cli_options)
+    profile = profile(name: cli_options['profile'])
+    options = profile.deep_merge cli_options
+
+    directory = File.expand_path cli_options['collection'].to_s, options['directory']
+    FileUtils.mkdir_p directory
+    FileUtils.chdir(directory) do
+      YoutubeDL.download url: url, args: profile['youtubedl_args'], options: options
+      generate_collection_config_file(url: url, options: options) unless options['collection'].nil?
+    end
+  end
+
+  def self.generate_collection_config_file(url:, options:) # rubocop:disable Metrics/MethodLength
+    config = {
+      'profiles' => {
+        options['profile'] => profile(name: options['profile']),
+      },
+      'collections' => {
+        options['collection'] => {
+          'url' => url,
+          'profile' => options['profile'],
+        },
+      },
+    }
+    File.write 'overscribe.yaml', config.to_yaml
+  end
+
+  def self.config
+    filename = File.expand_path '~/.overscribe.yaml'
+    YAML.safe_load(File.read(filename))
+  end
+
+  def self.collections(pattern:)
+    collections = config['collections']
+
+    collections.select! do |collection, options|
+      if pattern.nil?
+        # Remove manually synced
+        !options['manual']
+      else
+        # Select by pattern
+        collection.start_with? pattern
+      end
+    end
+  end
+
+  DEFAULT_PROFILES = {
+    'audio' => {
+      'youtubedl_args' => %w[--format bestaudio --extract-audio],
+    },
+    'video' => {
+      'youtubedl_args' => %w[--format bestvideo+bestaudio],
+    },
+  }.freeze
+  def self.profiles
+    DEFAULT_PROFILES.deep_merge config['profiles']
+  end
+
+  def self.profile(name:)
+    profiles[name]
+  end
+end

data/overscribe.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/overscribe/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'overscribe'
+  spec.version       = Overscribe::VERSION
+  spec.authors       = ['Romuald Conty']
+  spec.email         = ['romuald@opus-codium.fr']
+
+  spec.summary       = 'Keep your favorites media synced'
+  spec.description   = 'A tool to download online media like youtube playlists'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'thor'
+
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rubocop'
+
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: overscribe
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- Romuald Conty
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A tool to download online media like youtube playlists
+email:
+- romuald@opus-codium.fr
+executables:
+- overscribe
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yaml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/overscribe
+- lib/overscribe.rb
+- lib/overscribe/cli.rb
+- lib/overscribe/version.rb
+- lib/overscribe/youtube_dl.rb
+- overscribe.gemspec
+homepage: 
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Keep your favorites media synced
+test_files: []