sapher · Feb 6, 2021 · Feb 6, 2021 · Feb 6, 2021 · Feb 6, 2021 · Feb 7, 2021
diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml
@@ -0,0 +1,46 @@
+name: 'gradle-workflow'
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up JDK 1.8
+        uses: actions/setup-java@v1
+        with:
+          java-version: 1.8
+
+      - name: Build gradle project
+        run: |
+          gradle clean shadowJar
+      - name: Setup project version
+        run: |
+          export PROJECT_VERSION=$(gradle properties --no-daemon --console=plain -q | grep "^version:" | awk '{printf $2}')
+          echo "Debug gradle version ${PROJECT_VERSION}"
+          echo "PROJECT_VERSION=${PROJECT_VERSION}" >> $GITHUB_ENV
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ env.PROJECT_VERSION }}
+          release_name: "${{ format('{0} [Release #{1}]', github.event.head_commit.message, github.run_id) }}"
+          body: |
+            open in [jitpack.io][jitpack-url]
+
+            [jitpack-url]: https://jitpack.io/#${{ github.repository }}/${{ env.PROJECT_VERSION }}
+          draft: false
+          prerelease: false
+
+      - name: Uploud release assets
+        uses: AButler/upload-release-assets@v2.0
+        with:
+          files: 'build/*.jar'
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          release-tag: ${{ env.PROJECT_VERSION }}
diff --git a/.gitignore b/.gitignore
@@ -1,22 +1,137 @@
+# Created by https://www.toptal.com/developers/gitignore/api/gradle,intellij+all,java
+# Edit at https://www.toptal.com/developers/gitignore?templates=gradle,intellij+all,java
+
+### Intellij+all ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### Intellij+all Patch ###
+# Ignores the whole .idea folder and all .iml files
+# See https://github.com/joeblau/gitignore.io/issues/186 and https://github.com/joeblau/gitignore.io/issues/360
+
+.idea/
+
+# Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023
+
+*.iml
+modules.xml
+.idea/misc.xml
+*.ipr
+
+# Sonarlint plugin
+.idea/sonarlint
+
+### Java ###
+# Compiled class file
 *.class
 
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
 # Mobile Tools for Java (J2ME)
 .mtj.tmp/
 
 # Package Files #
 *.jar
 *.war
+*.nar
 *.ear
+*.zip
+*.tar.gz
+*.rar
 
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
 
-.idea
-*.iml
+### Gradle ###
+.gradle
+build/
 
-# No target build for github
-target/
+# Ignore Gradle GUI config
+gradle-app.setting
 
-# Gradle
-.gradle
-gradle
+# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
+!gradle-wrapper.jar
+
+# Cache of project
+.gradletasknamecache
+
+# # Work around https://youtrack.jetbrains.com/issue/IDEA-116898
+# gradle/wrapper/gradle-wrapper.properties
+
+### Gradle Patch ###
+**/build/
+
+# End of https://www.toptal.com/developers/gitignore/api/gradle,intellij+all,java
diff --git a/.travis.yml b/.travis.yml
diff --git a/LICENSE b/LICENSE
@@ -1,13 +1,21 @@
-            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-                    Version 2, December 2004
+MIT License
 
- Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+Copyright (c) 2021 ykingboos
 
- Everyone is permitted to copy and distribute verbatim or modified
- copies of this license document, and changing it is allowed as long
- as the name is changed.
+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:
 
-            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-  0. You just DO WHAT THE FUCK YOU WANT TO.
+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.
diff --git a/README.md b/README.md
@@ -1,26 +1,19 @@
-# youtubedl-java [![Build Status](https://travis-ci.org/sapher/youtubedl-java.svg?branch=master)](https://travis-ci.org/sapher/youtubedl-java)
+# youtubedl-java [![](https://jitpack.io/v/zkingboos/youtubedl-java.svg)](https://jitpack.io/#zkingboos/youtubedl-java)
 
-A simple java wrapper for [youtube-dl](https://github.com/rg3/youtube-dl) executable
+An sapher/youtubedl-java's fork with support for playlists, video search and bug fixes.
 
-There's a lot of thing left to do. Parsing output is one of them. Too bad, youtube-dl doesn't output formatted data.
-
-# Prerequisite
-
-:warning: Youtube-dl should be installed and available in your `$PATH.
+## Pre requisites
+You must have `youtube-dl` installed and available in your $PATH environment variable. You can also add your path dynamically.
 
 [How to properly install YoutubeDL executable](https://rg3.github.io/youtube-dl/download.html)
 
-Otherwise you will get this error :
-
-`Cannot run program "youtube-dl" (in directory "/Users/my/beautiful/path"): error=2, No such file or directory`
-
-# Usage
+Otherwise you'll get this error :
 
-## Installation
+`Cannot run program "youtube-dl" (in directory "computer's path"): error=2, No such file or directory`
 
-You can use jitpack.io to add the library to your project.
+### Installation
 
-[youtube-dl](https://jitpack.io/#sapher/youtubedl-java)
+You can use [youtube-dl](https://jitpack.io/#zkingboos/youtubedl-java) jitpack.io repository to add the library to your project.
 
 ### Gradle
 
@@ -38,42 +31,59 @@ allprojects {
 
 ```
 dependencies {
-    compile 'com.github.sapher:youtubedl-java:1.+'
+    implementation 'com.github.zkingboos:youtubedl-java:VERSION'
 }
 ```
 
-## Make request
+## Example
 
 ```java
+// Change environment variables
+YoutubeDL.setEnvironmentConsumer(environment -> {
+  //TODO: manage your environment variables here
+});
+
+// Change default youtube-dl command
+YoutubeDL.setExecutablePath("cmd.exe", "/c", "youtube-dl"); //example with windows  
+
 // Video url to download
-String videoUrl = "https://www.youtube.com/watch?v=dQw4w9WgXcQ";
+String videoUrl = "https://www.youtube.com/watch?v=dQw4w9WgXcQ"; //to download youtube video url
 
+//or
+String videoUrl = "ytsearch1:fantastic music song"; //to search by a video and download it
+
 // Destination directory
 String directory = System.getProperty("user.home");
 
-// Build request
-YoutubeDLRequest request = new YoutubeDLRequest(videoUrl, directory);
-request.setOption("ignore-errors");		// --ignore-errors
-request.setOption("output", "%(id)s");	// --output "%(id)s"
-request.setOption("retries", 10);		// --retries 10
+// Build request with video url
+YoutubeRequest request = YoutubeDL
+  .from(videoUrl, directory)
+  .ignoreErrors() // --ignore-errors
+  .output("%(id)s") // --output "%(id)s"
+  .retries(10); // --retries 10
+
+//or build request with search video
+YoutubeRequest request = YoutubeDL
+  .search(videoUrl, directory)
+  .ignoreErrors() // --ignore-errors
+  .output("%(id)s") // --output "%(id)s"
+  .retries(10); // --retries 10
 
 // Make request and return response
-YoutubeDLResponse response = YoutubeDL.execute(request);
+final YoutubeResponse response = request.build();
 
 // Response
-String stdOut = response.getOut(); // Executable output
+final String out = response.getOut(); // Executable output
 ```
+> You can also see [youtube-dl options][youtube-dl-options] for more options.
 
 You may also specify a callback to get notified about the progress of the download:
 
 ```
-...
-YoutubeDLResponse response = YoutubeDL.execute(request, new DownloadProgressCallback() {
-          @Override
-          public void onProgressUpdate(float progress, long etaInSeconds) {
-              System.out.println(String.valueOf(progress) + "%");
-          }
-      });
+YoutubeDLResponse response = YoutubeDL.execute(request, (progress, eta) -> {
+    System.out.println(progress + "%");
+ });
 ```
-# Links
-* [Youtube-dl documentation](https://github.com/sapher/youtubedl-java)
+> `DownloadProgressCallback` will be no longer supported by this project.
+
+[youtube-dl-options]: https://github.com/ytdl-org/youtube-dl#OPTIONS
diff --git a/build.gradle b/build.gradle
@@ -0,0 +1,29 @@
+plugins {
+    id 'com.github.johnrengelman.shadow' version '5.2.0'
+    id 'java'
+    id 'maven'
+}
+
+repositories {
+    mavenLocal()
+    maven { url 'https://repo.maven.apache.org/maven2/' }
+}
+
+group = 'com.github.zkingboos'
+version = '1.1.3'
+sourceCompatibility = 1.8
+
+dependencies {
+    compileOnly 'org.projectlombok:lombok:1.18.16'
+    annotationProcessor 'org.projectlombok:lombok:1.18.16'
+    implementation 'com.fasterxml.jackson.core:jackson-annotations:2.7.4'
+    implementation 'com.fasterxml.jackson.core:jackson-databind:2.7.4'
+}
+
+tasks.withType(JavaCompile) {
+    options.encoding = 'UTF-8'
+}
+
+tasks.withType(Jar) {
+    destinationDirectory.set(file("$rootDir/build/"))
+}