jagrosh / jlyrics Goto Github PK

View Code? Open in Web Editor NEW

60.0 6.0 30.0 34 KB

🎼 Expandable lyrics-scraping API for Java

License: Apache License 2.0

Java 100.00%

lyrics music jsoup scraper

jlyrics's Introduction

JLyrics

🎼 Expandable lyrics-scraping API for Java

Example

LyricsClient client = new LyricsClient();
Lyrics lyrics = client.getLyrics("smooth criminal").get();
System.out.println(lyrics.getContent()); // As he came into the window ...

Features

Async or blocking (uses CompletableFuture)
Built-in caching to prevent duplicate scrapes
Highly customizable (see reference.conf and lightbend/config)
Easily expandable to many lyrics sites

Included Lyrics Sites

A-Z Lyrics
Genius
MusixMatch
[your contribution here]

Maven Setup

<repository>
		  <id>jitpack.io</id>
	   <url>https://jitpack.io</url>
</repository>

<dependency>
	   <groupId>com.github.jagrosh</groupId>
	   <artifactId>JLyrics</artifactId>
	   <version>master-SNAPSHOT</version>
</dependency>

jlyrics's People

Contributors

Stargazers

Watchers

jlyrics's Issues

Support for arbitrary number of steps

As things stand right now, most lyrics sources require 2 steps, a 'search' step that attempts to find a URL to a page with the lyrics, and a 'parse' step that fetches the contents at that URL and deciphers the page into usable lyrics. One source currently precedes this with a 'token' step that fetches a token that is used for future lookups.

I have concerns about how maintainable enforcing these steps will be long-term. Additionally, there are some potential lyrics sources that don't require both search and parse steps, such as https://some-random-api.ml/lyrics . I think an ideal setup would be to support an arbitrary number of steps, with the 'result' of each step (be it a token, a URL, etc) be available to all future steps, and the final step always attempting to return valid lyrics.

Gradle?

Hello! I'm a beginner in Java development and I wanted to know if it's possible to use it with gradle, and if so, how? Thanks

Maven dependency couldn't resolve

Maven tells me that master-SNAPSHOT couldn't be found, even though I copied the dependency and repository from your README.

Maven artifact on jitpack.io has checksum mismatch

When building JMusicBot 0.3.6 Maven emits a warning about a failed checksum validation for artifact jagrosh/JLyrics:

Downloading from jitpack.io: https://jitpack.io/com/github/jagrosh/JLyrics/-0f9ac5df83-1/JLyrics--0f9ac5df83-1.jar
[WARNING] Checksum validation failed, expected f4807c97939a3ca3f328bc81f359babcac9f0ff1 but is 21deacfbc2447cb9581229be15e12ec7296ff15e from jitpack.io for https://jitpack.io/com/github/jagrosh/JLyrics/-0f9ac5df83-1/JLyrics--0f9ac5df83-1.jar
[WARNING] Could not validate integrity of download from https://jitpack.io/com/github/jagrosh/JLyrics/-0f9ac5df83-1/JLyrics--0f9ac5df83-1.jar
org.eclipse.aether.transfer.ChecksumFailureException: Checksum validation failed, expected f4807c97939a3ca3f328bc81f359babcac9f0ff1 but is 21deacfbc2447cb9581229be15e12ec7296ff15e
    at org.eclipse.aether.connector.basic.ChecksumValidator.validateExternalChecksums (ChecksumValidator.java:174)
    at org.eclipse.aether.connector.basic.ChecksumValidator.validate (ChecksumValidator.java:103)
    at org.eclipse.aether.connector.basic.BasicRepositoryConnector$GetTaskRunner.runTask (BasicRepositoryConnector.java:460)
    at org.eclipse.aether.connector.basic.BasicRepositoryConnector$TaskRunner.run (BasicRepositoryConnector.java:364)
    at org.eclipse.aether.util.concurrency.RunnableErrorForwarder$1.run (RunnableErrorForwarder.java:75)
    at java.util.concurrent.ThreadPoolExecutor.runWorker (ThreadPoolExecutor.java:1128)
    at java.util.concurrent.ThreadPoolExecutor$Worker.run (ThreadPoolExecutor.java:628)
    at java.lang.Thread.run (Thread.java:829)
[WARNING] Checksum validation failed, expected f4807c97939a3ca3f328bc81f359babcac9f0ff1 but is 21deacfbc2447cb9581229be15e12ec7296ff15e from jitpack.io for https://jitpack.io/com/github/jagrosh/JLyrics/-0f9ac5df83-1/JLyrics--0f9ac5df83-1.jar
Downloaded from jitpack.io: https://jitpack.io/com/github/jagrosh/JLyrics/-0f9ac5df83-1/JLyrics--0f9ac5df83-1.jar (6.8 kB at 6.7 kB/s)

The JMusicBot 0.3.6 release pulls a -SNAPSHOT of JLyrics, I do not know if this error is expected for snapshots on jitpack.io.

<!-- jitpack for now, we need to version this correctly later -->
<dependency>
    <groupId>com.github.jagrosh</groupId>
    <artifactId>JLyrics</artifactId>
    <version>-SNAPSHOT</version>
</dependency>

Problem on retrieve Lyrics

Hi,

On the latest version there's some problem on retrieve Lyrics, I tried to build myself this repository but without success:

Running com.jagrosh.jlyrics.LyricsTest
Tests run: 7, Failures: 3, Errors: 0, Skipped: 0, Time elapsed: 7.987 sec <<< FAILURE!
azlyricsTest(com.jagrosh.jlyrics.LyricsTest)  Time elapsed: 1.177 sec  <<< FAILURE!
java.lang.AssertionError
	at org.junit.Assert.fail(Assert.java:87)
	at org.junit.Assert.assertTrue(Assert.java:42)
	at org.junit.Assert.assertNotNull(Assert.java:713)
	at org.junit.Assert.assertNotNull(Assert.java:723)
	at com.jagrosh.jlyrics.LyricsTest.azlyricsTest(LyricsTest.java:51)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.base/java.lang.reflect.Method.invoke(Method.java:568)
	at org.junit.runners.model.FrameworkMethod$1.runReflectiveCall(FrameworkMethod.java:59)
	at org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:12)
	at org.junit.runners.model.FrameworkMethod.invokeExplosively(FrameworkMethod.java:56)
	at org.junit.internal.runners.statements.InvokeMethod.evaluate(InvokeMethod.java:17)
	at org.junit.runners.ParentRunner$3.evaluate(ParentRunner.java:306)
	at org.junit.runners.BlockJUnit4ClassRunner$1.evaluate(BlockJUnit4ClassRunner.java:100)
	at org.junit.runners.ParentRunner.runLeaf(ParentRunner.java:366)
	at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:103)
	at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:63)
	at org.junit.runners.ParentRunner$4.run(ParentRunner.java:331)
	at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:79)
	at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:329)
	at org.junit.runners.ParentRunner.access$100(ParentRunner.java:66)
	at org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:293)
	at org.junit.runners.ParentRunner$3.evaluate(ParentRunner.java:306)
	at org.junit.runners.ParentRunner.run(ParentRunner.java:413)
	at org.apache.maven.surefire.junit4.JUnit4Provider.execute(JUnit4Provider.java:252)
	at org.apache.maven.surefire.junit4.JUnit4Provider.executeTestSet(JUnit4Provider.java:141)
	at org.apache.maven.surefire.junit4.JUnit4Provider.invoke(JUnit4Provider.java:112)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.base/java.lang.reflect.Method.invoke(Method.java:568)
	at org.apache.maven.surefire.util.ReflectionUtils.invokeMethodWithArray(ReflectionUtils.java:189)
	at org.apache.maven.surefire.booter.ProviderFactory$ProviderProxy.invoke(ProviderFactory.java:165)
	at org.apache.maven.surefire.booter.ProviderFactory.invokeProvider(ProviderFactory.java:85)
	at org.apache.maven.surefire.booter.ForkedBooter.runSuitesInProcess(ForkedBooter.java:115)
	at org.apache.maven.surefire.booter.ForkedBooter.main(ForkedBooter.java:75)
geniusTest(com.jagrosh.jlyrics.LyricsTest)  Time elapsed: 1.303 sec  <<< FAILURE!
java.lang.AssertionError
	at org.junit.Assert.fail(Assert.java:87)
	at org.junit.Assert.assertTrue(Assert.java:42)
	at org.junit.Assert.assertNotNull(Assert.java:713)
	at org.junit.Assert.assertNotNull(Assert.java:723)
	at com.jagrosh.jlyrics.LyricsTest.geniusTest(LyricsTest.java:74)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.base/java.lang.reflect.Method.invoke(Method.java:568)
	at org.junit.runners.model.FrameworkMethod$1.runReflectiveCall(FrameworkMethod.java:59)
	at org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:12)
	at org.junit.runners.model.FrameworkMethod.invokeExplosively(FrameworkMethod.java:56)
	at org.junit.internal.runners.statements.InvokeMethod.evaluate(InvokeMethod.java:17)
	at org.junit.runners.ParentRunner$3.evaluate(ParentRunner.java:306)
	at org.junit.runners.BlockJUnit4ClassRunner$1.evaluate(BlockJUnit4ClassRunner.java:100)
	at org.junit.runners.ParentRunner.runLeaf(ParentRunner.java:366)
	at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:103)
	at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:63)
	at org.junit.runners.ParentRunner$4.run(ParentRunner.java:331)
	at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:79)
	at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:329)
	at org.junit.runners.ParentRunner.access$100(ParentRunner.java:66)
	at org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:293)
	at org.junit.runners.ParentRunner$3.evaluate(ParentRunner.java:306)
	at org.junit.runners.ParentRunner.run(ParentRunner.java:413)
	at org.apache.maven.surefire.junit4.JUnit4Provider.execute(JUnit4Provider.java:252)
	at org.apache.maven.surefire.junit4.JUnit4Provider.executeTestSet(JUnit4Provider.java:141)
	at org.apache.maven.surefire.junit4.JUnit4Provider.invoke(JUnit4Provider.java:112)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.base/java.lang.reflect.Method.invoke(Method.java:568)
	at org.apache.maven.surefire.util.ReflectionUtils.invokeMethodWithArray(ReflectionUtils.java:189)
	at org.apache.maven.surefire.booter.ProviderFactory$ProviderProxy.invoke(ProviderFactory.java:165)
	at org.apache.maven.surefire.booter.ProviderFactory.invokeProvider(ProviderFactory.java:85)
	at org.apache.maven.surefire.booter.ForkedBooter.runSuitesInProcess(ForkedBooter.java:115)
	at org.apache.maven.surefire.booter.ForkedBooter.main(ForkedBooter.java:75)
musixmatchTest(com.jagrosh.jlyrics.LyricsTest)  Time elapsed: 1.36 sec  <<< FAILURE!
java.lang.AssertionError
	at org.junit.Assert.fail(Assert.java:87)
	at org.junit.Assert.assertTrue(Assert.java:42)
	at org.junit.Assert.assertNotNull(Assert.java:713)
	at org.junit.Assert.assertNotNull(Assert.java:723)
	at com.jagrosh.jlyrics.LyricsTest.musixmatchTest(LyricsTest.java:97)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.base/java.lang.reflect.Method.invoke(Method.java:568)
	at org.junit.runners.model.FrameworkMethod$1.runReflectiveCall(FrameworkMethod.java:59)
	at org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:12)
	at org.junit.runners.model.FrameworkMethod.invokeExplosively(FrameworkMethod.java:56)
	at org.junit.internal.runners.statements.InvokeMethod.evaluate(InvokeMethod.java:17)
	at org.junit.runners.ParentRunner$3.evaluate(ParentRunner.java:306)
	at org.junit.runners.BlockJUnit4ClassRunner$1.evaluate(BlockJUnit4ClassRunner.java:100)
	at org.junit.runners.ParentRunner.runLeaf(ParentRunner.java:366)
	at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:103)
	at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:63)
	at org.junit.runners.ParentRunner$4.run(ParentRunner.java:331)
	at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:79)
	at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:329)
	at org.junit.runners.ParentRunner.access$100(ParentRunner.java:66)
	at org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:293)
	at org.junit.runners.ParentRunner$3.evaluate(ParentRunner.java:306)
	at org.junit.runners.ParentRunner.run(ParentRunner.java:413)
	at org.apache.maven.surefire.junit4.JUnit4Provider.execute(JUnit4Provider.java:252)
	at org.apache.maven.surefire.junit4.JUnit4Provider.executeTestSet(JUnit4Provider.java:141)
	at org.apache.maven.surefire.junit4.JUnit4Provider.invoke(JUnit4Provider.java:112)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.base/java.lang.reflect.Method.invoke(Method.java:568)
	at org.apache.maven.surefire.util.ReflectionUtils.invokeMethodWithArray(ReflectionUtils.java:189)
	at org.apache.maven.surefire.booter.ProviderFactory$ProviderProxy.invoke(ProviderFactory.java:165)
	at org.apache.maven.surefire.booter.ProviderFactory.invokeProvider(ProviderFactory.java:85)
	at org.apache.maven.surefire.booter.ForkedBooter.runSuitesInProcess(ForkedBooter.java:115)
	at org.apache.maven.surefire.booter.ForkedBooter.main(ForkedBooter.java:75)
Results :
Failed tests:   azlyricsTest(com.jagrosh.jlyrics.LyricsTest)
  geniusTest(com.jagrosh.jlyrics.LyricsTest)
  musixmatchTest(com.jagrosh.jlyrics.LyricsTest)
Tests run: 7, Failures: 3, Errors: 0, Skipped: 0

Are you planning to fix it?

Thanks.

Exceptions

Right now, when lyrics cannot be successfully retrieved, the client returns null. This happens almost regardless of what went wrong, whether it be an internet connectivity issue, a site issue, a parsing issue, etc. While this was originally set up this way to make using the library easy, some users might want to be able to debug why their lyrics searches are failing. Therefore, I think the client should provide a method to retrieve lyrics that doesn't mask the exceptions behind a 'null' and instead returns meaningful information as to why a search failed.

Unable to find maven dependency

I'm sure I copied correctly and i tried version 0.3 & 0.4 both didnt worked, i also updated project and restarted my IDE (Intellij Idea). The artifact id group id and version is red and it cant find.

Docker

Hi, this project looks interesting. Have you looked into packaging it using Docker, so it could be run without running into dependency issues?

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.