├── .gitignore ├── LICENSE ├── api-base ├── README.md ├── build.sbt └── src │ └── main │ └── scala │ └── com │ └── gu │ └── arts │ └── music │ └── net │ └── ConfiguredHttp.scala ├── build.sbt ├── demo ├── build.sbt ├── readme.md └── src │ └── main │ └── scala │ └── com │ └── gu │ └── arts │ └── music │ └── demo │ └── Demo.scala ├── lastfm-api ├── build.sbt ├── readme.md └── src │ └── main │ └── scala │ └── com │ └── gu │ └── arts │ └── music │ └── net │ └── lastfm │ ├── ArtistApi.scala │ ├── Lastfm.scala │ └── UserApi.scala ├── musicmetric ├── README.md ├── build.sbt └── src │ └── main │ └── scala │ └── com │ └── gu │ └── arts │ └── music │ └── net │ └── musicmetric │ └── MusicMetric.scala ├── project └── MusicBuild.scala ├── readme.md ├── sbt-launch-0.10.0.jar └── sbt010 /.gitignore: -------------------------------------------------------------------------------- 1 | *~ 2 | logs/ 3 | 4 | # stuff to ignore from sbt 5 | project/boot/ 6 | project/plugins/project/ 7 | target/ 8 | lib_managed/ 9 | src_managed/ 10 | project/boot/ 11 | 12 | # don't commit the intellij stuff, run "sbt idea" to generate 13 | *.ipr 14 | *.iml 15 | *.iws 16 | .idea/ 17 | out/ -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /api-base/README.md: -------------------------------------------------------------------------------- 1 | #Scala Music API Client 2 | 3 | This project contains base classes for all music API projects. 4 | 5 | ##Dependencies 6 | 7 | ###SBT (0.7.x) 8 | 9 | val guardianSnapshot = "Guardian GitHub Snapshot" at "http://guardian.github.com/maven/repo-snapshots" 10 | val musicApiBase = "com.gu.arts" %% "music-api-base_2.8.1" % "0.1.X-SNAPSHOT" 11 | -------------------------------------------------------------------------------- /api-base/build.sbt: -------------------------------------------------------------------------------- 1 | import java.util.jar._ 2 | 3 | name := "music-api-base" 4 | 5 | organization := "com.gu.arts" 6 | 7 | libraryDependencies += "joda-time" % "joda-time" % "1.6.2" 8 | 9 | libraryDependencies += "org.slf4j" % "slf4j-api" % "1.6.0" 10 | 11 | libraryDependencies += "net.liftweb" %% "lift-json" % "2.2" 12 | 13 | libraryDependencies += "net.databinder" %% "dispatch-http" % "0.8.1" 14 | 15 | packageOptions <+= (version, name) map { (v, n) => 16 | Package.ManifestAttributes( 17 | Attributes.Name.IMPLEMENTATION_VERSION -> v, 18 | Attributes.Name.IMPLEMENTATION_TITLE -> n, 19 | Attributes.Name.IMPLEMENTATION_VENDOR -> "guardian.co.uk" 20 | ) 21 | } 22 | 23 | publishTo <<= (version) { version: String => 24 | val publishType = if (version.endsWith("SNAPSHOT")) "snapshots" else "releases" 25 | Some( 26 | Resolver.file( 27 | "guardian github " + publishType, 28 | file(System.getProperty("user.home") + "/guardian.github.com/maven/repo-" + publishType) 29 | ) 30 | ) 31 | } 32 | -------------------------------------------------------------------------------- /api-base/src/main/scala/com/gu/arts/music/net/ConfiguredHttp.scala: -------------------------------------------------------------------------------- 1 | package com.gu.arts.music.net 2 | 3 | import dispatch._ 4 | import dispatch.thread.ThreadSafeHttpClient 5 | import org.apache.http.params.HttpParams 6 | import org.apache.http.conn.params.ConnRouteParams 7 | import org.apache.http.HttpHost 8 | import org.slf4j.LoggerFactory 9 | 10 | object ConfiguredHttp extends Http { 11 | val logger = LoggerFactory getLogger getClass 12 | override def make_client = new ThreadSafeHttpClient(new Http.CurrentCredentials(None), maxConnections = 50, maxConnectionsPerRoute = 50) { 13 | override protected def configureProxy(params: HttpParams) = { 14 | val httpProxyPort = System.getProperty("http.proxyPort", "") 15 | val httpProxyHost = System.getProperty("http.proxyHost", "") 16 | 17 | if (httpProxyHost != "" && httpProxyPort != ""){ 18 | logger.info("Using proxy settings for HTTP request %s:%s".format(httpProxyHost, httpProxyPort)) 19 | ConnRouteParams.setDefaultProxy(params, new HttpHost(httpProxyHost, httpProxyPort.toInt)) 20 | } 21 | 22 | params 23 | } 24 | } 25 | } -------------------------------------------------------------------------------- /build.sbt: -------------------------------------------------------------------------------- 1 | 2 | name := "music" 3 | 4 | organization := "com.gu.arts" 5 | 6 | version in ThisBuild := "0.1.11" 7 | 8 | publishTo <<= (version) { version: String => 9 | val publishType = if (version.endsWith("SNAPSHOT")) "snapshots" else "releases" 10 | Some( 11 | Resolver.file( 12 | "guardian github " + publishType, 13 | file(System.getProperty("user.home") + "/guardian.github.com/maven/repo-" + publishType) 14 | ) 15 | ) 16 | } 17 | -------------------------------------------------------------------------------- /demo/build.sbt: -------------------------------------------------------------------------------- 1 | 2 | publishArtifact := false 3 | -------------------------------------------------------------------------------- /demo/readme.md: -------------------------------------------------------------------------------- 1 | #Demo 2 | 3 | This is a small demo to show how to call the music APIs. 4 | 5 | #Running 6 | 7 | In demo.scala, change the API key to something you've got from Last.FM and add a MusicBrainz id then run: 8 | 9 | $ sbt 10 | > project demo 11 | > run 12 | 13 | -------------------------------------------------------------------------------- /demo/src/main/scala/com/gu/arts/music/demo/Demo.scala: -------------------------------------------------------------------------------- 1 | package com.gu.arts.music.demo 2 | 3 | import com.gu.arts.music.net.lastfm.{LastfmApiKey, ArtistProfile} 4 | import com.gu.arts.music.net.musicmetric.{MusicMetricApiKey, MusicMetricSummary} 5 | 6 | object Demo extends Application { 7 | 8 | implicit val lastfmApiKey = LastfmApiKey("bar") 9 | implicit val musicMetricApiKey = MusicMetricApiKey("bar") 10 | val artistProfile = ArtistProfile("foo") 11 | val summary = MusicMetricSummary("foo") 12 | println(artistProfile) 13 | println(summary) 14 | } -------------------------------------------------------------------------------- /lastfm-api/build.sbt: -------------------------------------------------------------------------------- 1 | import java.util.jar._ 2 | 3 | name := "lastfm-api" 4 | 5 | organization := "com.gu.arts" 6 | 7 | libraryDependencies += "joda-time" % "joda-time" % "1.6.2" 8 | 9 | libraryDependencies += "org.slf4j" % "slf4j-api" % "1.6.0" 10 | 11 | libraryDependencies += "net.liftweb" %% "lift-json" % "2.2" 12 | 13 | libraryDependencies += "net.databinder" %% "dispatch-http" % "0.8.1" 14 | 15 | packageOptions <+= (version, name) map { (v, n) => 16 | Package.ManifestAttributes( 17 | Attributes.Name.IMPLEMENTATION_VERSION -> v, 18 | Attributes.Name.IMPLEMENTATION_TITLE -> n, 19 | Attributes.Name.IMPLEMENTATION_VENDOR -> "guardian.co.uk" 20 | ) 21 | } 22 | 23 | publishTo <<= (version) { version: String => 24 | val publishType = if (version.endsWith("SNAPSHOT")) "snapshots" else "releases" 25 | Some( 26 | Resolver.file( 27 | "guardian github " + publishType, 28 | file(System.getProperty("user.home") + "/guardian.github.com/maven/repo-" + publishType) 29 | ) 30 | ) 31 | } 32 | -------------------------------------------------------------------------------- /lastfm-api/readme.md: -------------------------------------------------------------------------------- 1 | #Scala LastFM API Client 2 | 3 | This project is a Scala wrapper around the Last.FM APIs. 4 | 5 | ##Dependencies 6 | 7 | ###SBT (0.7.x) 8 | 9 | val guardianSnapshot = "Guardian GitHub Snapshot" at "http://guardian.github.com/maven/repo-snapshots" 10 | val lastFmApis = "com.gu.arts" %% "lastfm-api_2.8.1" % "0.1.X-SNAPSHOT" 11 | 12 | -------------------------------------------------------------------------------- /lastfm-api/src/main/scala/com/gu/arts/music/net/lastfm/ArtistApi.scala: -------------------------------------------------------------------------------- 1 | package com.gu.arts.music.net.lastfm 2 | 3 | import net.liftweb.json.JsonParser.parse 4 | import java.net.URLEncoder 5 | import net.liftweb.json.JsonAST.JValue 6 | 7 | case class Tracks(track: List[Track]) 8 | case class RankAttr(rank: String) 9 | case class Track(name: String, attr: RankAttr) { 10 | lazy val rank = attr.rank 11 | } 12 | 13 | case class ArtistProfile(name: String, url: String, bio: ArtistBiography, tags: ArtistTags, stats: ArtistStats, image: List[ArtistImage]) { 14 | def getImage(imageSize: String, default: String) = { 15 | val flattened = image flatMap { artistImage => 16 | if (imageSize == artistImage.size) Some(artistImage) 17 | else None 18 | } 19 | val artistImage = flattened.headOption getOrElse ArtistImage(default, "") 20 | artistImage.text 21 | } 22 | } 23 | case class ArtistProfileSimple(name: String, url: String, mbid: Option[String], image: List[ArtistImage]) { 24 | lazy val trimmedMbid = mbid map { _.trim } filter { !_.isEmpty } 25 | lazy val trimmedName = Trimmer.trimName(name, 12) 26 | lazy val trimmedNameWide = Trimmer.trimName(name, 16) 27 | lazy val encodedName = URLEncoder.encode(name, "UTF-8") 28 | 29 | def similarArtists()(implicit lastfmApiKey: LastfmApiKey): List[ArtistProfileSimple] = { 30 | val similarArtistsOption: Option[SimilarArtists] = mbid flatMap { mbid => SimilarArtists(mbid) } 31 | val similarArtistsList = similarArtistsOption getOrElse SimilarArtists(artist = List()) 32 | similarArtistsList.artists 33 | } 34 | } 35 | case class ArtistTags(tag: List[ArtistTag]) 36 | case class ArtistTag(name: String, url: String) 37 | case class ArtistBiography(summary: String, content: String) 38 | case class ArtistStats(listeners: String, playcount: String) 39 | case class ArtistImage(text: String, size: String) { lazy val uri = text } 40 | case class ArtistAlbums(album: List[ArtistAlbum]) 41 | case class ArtistAlbum(name: String, mbid: Option[String], url: String, image: List[ArtistImage]) { 42 | lazy val trimmedName = Trimmer.trimName(name, 12) 43 | lazy val encodedName = URLEncoder.encode(name, "UTF-8") 44 | } 45 | case class ArtistTracks(track: List[ArtistTrack]) 46 | case class ArtistTrack(name: String, url: String) 47 | case class SimilarArtists(artist: List[ArtistProfileSimple]){ 48 | lazy val artists = artist 49 | } 50 | case class TopLevelAlbum(album: LastFmAlbum) 51 | 52 | case class Wiki(summary: String, content: String) 53 | 54 | case class LastFmAlbum(name: String, image: List[ArtistImage], wiki: Option[Wiki]){ 55 | def getImage(imageSize: String, default: String) = { 56 | val flattened = image flatMap { artistImage => 57 | if (imageSize == artistImage.size) Some(artistImage) 58 | else None 59 | } 60 | val artistImage = flattened.headOption getOrElse ArtistImage(default, "") 61 | artistImage.text 62 | } 63 | } 64 | 65 | abstract class ArtistApi extends LastfmApi { 66 | override val searchToken = "mbid" 67 | } 68 | 69 | object ArtistProfileByName extends ArtistApi { 70 | override val method = "artist.getinfo" 71 | override val searchToken = "artist" 72 | def apply(name: String)(implicit lastfmApiKey: LastfmApiKey) = (parse(retrieve(URLEncoder.encode(name, "utf-8"), lastfmApiKey)) \ "artist").extractOpt[ArtistProfile] 73 | } 74 | 75 | 76 | object LastFmAlbum extends ArtistApi { 77 | override val method = "album.getinfo" 78 | override val searchToken = "artist" 79 | override val searchToken2 = "album" 80 | 81 | def apply(name: String, albumName: String)(implicit lastfmApiKey: LastfmApiKey) = 82 | parse(retrieveWithMoreTokens(name, albumName, lastfmApiKey)).extractOpt[TopLevelAlbum] map (a => a.album) 83 | } 84 | 85 | object LastFmAlbumTracks extends ArtistApi { 86 | override val method = "album.getinfo" 87 | override val searchToken = "artist" 88 | override val searchToken2 = "album" 89 | 90 | def apply(artistName: String, albumName: String)(implicit lastfmApiKey: LastfmApiKey): Option[Tracks] = { 91 | val albumJson = retrieveWithMoreTokens(artistName, albumName, lastfmApiKey).replaceAll("@attr","attr") 92 | (parse(albumJson) \ "album" \ "tracks").extractOpt[Tracks] 93 | } 94 | } 95 | 96 | object ArtistProfile extends ArtistApi { 97 | override val method = "artist.getinfo" 98 | def apply(mbid: String)(implicit lastfmApiKey: LastfmApiKey) = (parse(retrieve(mbid, lastfmApiKey)) \ "artist").extractOpt[ArtistProfile] 99 | } 100 | 101 | object ArtistTracks extends ArtistApi { 102 | override val method = "artist.getTopTracks" 103 | def apply(mbid: String)(implicit lastfmApiKey: LastfmApiKey) = (parse(retrieve(mbid, lastfmApiKey)) \ "toptracks").extractOpt[ArtistTracks] 104 | } 105 | 106 | object SimilarArtists extends ArtistApi { 107 | override val method = "artist.getSimilar" 108 | def apply(mbid: String)(implicit lastfmApiKey: LastfmApiKey) = (parse(retrieve(mbid, lastfmApiKey)) \ "similarartists").extractOpt[SimilarArtists] 109 | } 110 | 111 | object ArtistLastFmApiError extends ArtistApi { 112 | override val method = "artist.getinfo" 113 | def apply(mbid: String)(implicit lastfmApiKey: LastfmApiKey) = (parse(retrieve(mbid, lastfmApiKey))).extractOpt[LastFmApiError] 114 | } 115 | 116 | object ArtistAlbums extends ArtistApi { 117 | 118 | override val method = "artist.getTopAlbums" 119 | 120 | def apply(mbid: String)(implicit lastfmApiKey: LastfmApiKey): Option[ArtistAlbums] = { 121 | val result = retrieve(mbid, lastfmApiKey) 122 | val json = (parse(result) \ "topalbums").extractOpt[ArtistAlbums] 123 | json match { 124 | case Some(j) => json 125 | case None => { 126 | val album = (parse(result) \ "topalbums" \ "album").extractOpt[ArtistAlbum] 127 | album match { 128 | case None => None 129 | case Some(album) => Some(ArtistAlbums(List(album))) 130 | } 131 | } 132 | } 133 | } 134 | 135 | } 136 | -------------------------------------------------------------------------------- /lastfm-api/src/main/scala/com/gu/arts/music/net/lastfm/Lastfm.scala: -------------------------------------------------------------------------------- 1 | package com.gu.arts.music.net.lastfm 2 | 3 | import dispatch._ 4 | import org.slf4j.LoggerFactory 5 | import com.gu.arts.music.net.ConfiguredHttp 6 | 7 | case class LastfmApiKey(apiKey: String) 8 | case class LastFmApiError(error: Int, message: String) 9 | class LastFmApiException(msg: String, errorCode: Int) extends RuntimeException(msg) 10 | 11 | trait ApiConfiguration { 12 | 13 | lazy val maxCacheAge = System.getProperty("http.cache.max-age", "") 14 | lazy val cacheControlValue = "max-age=%s".format(maxCacheAge) 15 | 16 | val headers = { 17 | if (maxCacheAge != "") Map("Cache-Control" -> cacheControlValue) 18 | else Map[String, String]() 19 | } 20 | } 21 | 22 | abstract class LastfmApi extends ApiConfiguration { 23 | implicit val formats = net.liftweb.json.DefaultFormats 24 | val log = LoggerFactory getLogger getClass 25 | val searchToken: String 26 | val searchToken2: String = "" 27 | val method: String 28 | val host = "ws.audioscrobbler.com/2.0" 29 | 30 | def retrieve(token: String, apiKey: LastfmApiKey) = { 31 | val query = Map("method" -> method, "api_key" -> apiKey.apiKey, searchToken -> token, "format" -> "json") 32 | val request = :/(host) <:< headers < method, "api_key" -> apiKey.apiKey, searchToken -> token1, searchToken2 -> token2, "format" -> "json") 39 | val request = :/(host) <:< headers < 49 | if (word.length > length) word.substring(0, length) + "... " 50 | else word + " ") mkString 51 | } 52 | 53 | } 54 | -------------------------------------------------------------------------------- /lastfm-api/src/main/scala/com/gu/arts/music/net/lastfm/UserApi.scala: -------------------------------------------------------------------------------- 1 | package com.gu.arts.music.net.lastfm 2 | 3 | import net.liftweb.json.JsonParser.parse 4 | 5 | case class UserTopArtists(artist: List[ArtistProfileSimple]) 6 | 7 | abstract class UserApi extends LastfmApi { 8 | override val searchToken = "user" 9 | } 10 | 11 | object UserTopArtists extends UserApi { 12 | override val method = "user.gettopartists" 13 | def apply(username: String)(implicit lastfmApiKey: LastfmApiKey) = (parse(retrieve(username, lastfmApiKey)) \ "topartists").extractOpt[UserTopArtists] 14 | } -------------------------------------------------------------------------------- /musicmetric/README.md: -------------------------------------------------------------------------------- 1 | #Scala MusicMetric API Client 2 | 3 | This project is a Scala wrapper around the MusicMetric APIs. 4 | 5 | ##Dependencies 6 | 7 | ###SBT (0.7.x) 8 | 9 | val guardianSnapshot = "Guardian GitHub Snapshot" at "http://guardian.github.com/maven/repo-snapshots" 10 | val musicMetricApis = "com.gu.arts" %% "musicmetric-api_2.8.1" % "0.1.X-SNAPSHOT" 11 | 12 | -------------------------------------------------------------------------------- /musicmetric/build.sbt: -------------------------------------------------------------------------------- 1 | import java.util.jar._ 2 | 3 | name := "musicmetric-api" 4 | 5 | organization := "com.gu.arts" 6 | 7 | libraryDependencies += "joda-time" % "joda-time" % "1.6.2" 8 | 9 | libraryDependencies += "org.slf4j" % "slf4j-api" % "1.6.0" 10 | 11 | libraryDependencies += "net.liftweb" %% "lift-json" % "2.2" 12 | 13 | libraryDependencies += "net.databinder" %% "dispatch-http" % "0.8.1" 14 | 15 | packageOptions <+= (version, name) map { (v, n) => 16 | Package.ManifestAttributes( 17 | Attributes.Name.IMPLEMENTATION_VERSION -> v, 18 | Attributes.Name.IMPLEMENTATION_TITLE -> n, 19 | Attributes.Name.IMPLEMENTATION_VENDOR -> "guardian.co.uk" 20 | ) 21 | } 22 | 23 | publishTo <<= (version) { version: String => 24 | val publishType = if (version.endsWith("SNAPSHOT")) "snapshots" else "releases" 25 | Some( 26 | Resolver.file( 27 | "guardian github " + publishType, 28 | file(System.getProperty("user.home") + "/guardian.github.com/maven/repo-" + publishType) 29 | ) 30 | ) 31 | } 32 | -------------------------------------------------------------------------------- /musicmetric/src/main/scala/com/gu/arts/music/net/musicmetric/MusicMetric.scala: -------------------------------------------------------------------------------- 1 | package com.gu.arts.music.net.musicmetric 2 | 3 | import com.gu.arts.music.net.ConfiguredHttp 4 | import dispatch.url 5 | import dispatch.HandlerVerbs._ 6 | import net.liftweb.json.JsonParser.parse 7 | import org.slf4j.LoggerFactory 8 | 9 | case class Score(current: Int, total: Int, previous: Int) 10 | case class Fans(twitter: Score, myspace: Score, youtube: Score, facebook: Score, lastfm: Score, total: Score) 11 | case class Plays(lastfm: Score, total: Score, myspace: Score, youtube: Score, radio: Score) 12 | case class Comments(total: Score) 13 | case class Views(total: Score) 14 | case class MusicMetricSummary(fans: Fans, plays: Plays, comments: Comments, views: Views) 15 | 16 | case class ChartData(value: Option[Int], rank: Option[Int]) 17 | case class ArtistChart(musicbrainz: Option[String], name: String, ordering: ChartData) 18 | case class FestivalChart(entities: List[ArtistChart], id: String, name: String) 19 | 20 | case class MusicMetricApiKey(key: String) 21 | 22 | abstract class MusicMetricApi { 23 | val log = LoggerFactory getLogger getClass 24 | implicit val formats = net.liftweb.json.DefaultFormats 25 | val baseUri = "http://apib2.semetric.com" 26 | 27 | def retrieve(partialUri: String, apiKey: MusicMetricApiKey) = { 28 | val uri = "%s%s?token=%s".format(baseUri, partialUri, apiKey.key) 29 | log.info("Retriving web resource %s" format uri) 30 | (parse(ConfiguredHttp(url(uri) as_str)) \ "response") 31 | } 32 | } 33 | 34 | object MusicMetricSummary extends MusicMetricApi { 35 | val summaryApi = "/artist/musicbrainz:%s/kpi" 36 | def apply(mbid: String)(implicit musicMetricApiKey: MusicMetricApiKey) = retrieve(summaryApi format mbid, musicMetricApiKey).extractOpt[MusicMetricSummary] 37 | } 38 | 39 | object FestivalChart extends MusicMetricApi { 40 | val festivalChartApi = "/chart/%s" 41 | def apply(festivalId: String)(implicit musicMetricApiKey: MusicMetricApiKey): Option[FestivalChart] = 42 | retrieve(festivalChartApi format festivalId, musicMetricApiKey).extractOpt[FestivalChart] 43 | 44 | } 45 | -------------------------------------------------------------------------------- /project/MusicBuild.scala: -------------------------------------------------------------------------------- 1 | import sbt._ 2 | 3 | object MusicBuild extends Build { 4 | 5 | lazy val root = Project("music", file(".")) aggregate(apiBase, lastfm, musicMetric, demo) dependsOn(lastfm, musicMetric) 6 | lazy val apiBase = Project("music-api-base", file("api-base")) 7 | lazy val lastfm = Project("lastfm-api", file("lastfm-api")) dependsOn(apiBase) 8 | lazy val musicMetric = Project("musicmetric-api", file("musicmetric")) dependsOn(apiBase) 9 | lazy val demo = Project("demo", file("demo")) dependsOn (lastfm, musicMetric) 10 | 11 | } -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | #Scala Music API Client 2 | 3 | This project is a Scala wrapper around several public music web APIs. 4 | 5 | ##Dependencies 6 | 7 | ###SBT (0.7.x) 8 | 9 | val guardianSnapshot = "Guardian GitHub Snapshot" at "http://guardian.github.com/maven/repo-snapshots" 10 | val musicApis = "com.gu.arts" %% "music_2.8.1" % "0.1.X-SNAPSHOT" // will get all music API projects 11 | val lastFmApis = "com.gu.arts" %% "lastfm-api_2.8.1" % "0.1.X-SNAPSHOT" 12 | val musicMetricApis = "com.gu.arts" %% "musicmetric-api_2.8.1" % "0.1.X-SNAPSHOT" 13 | 14 | ##Example 15 | 16 | Checkout the project, demo, to see how to call the companion objects for the case class wrappers. 17 | 18 | #Publishing 19 | 20 | To publish to your local Maven/IVY repository, when in sbt (using ./sbt10) run the command 21 | reload 22 | clean 23 | compile 24 | 25 | publish-local 26 | 27 | The newly created package will be available. Update your dependent projects accordingly. 28 | 29 | To publish to the Guardian Github repository, ensure you have cloned the [Github repository](https://github.com/guardian/guardian.github.com) into your home directory like so: 30 | 31 | cd ~ && git clone git@github.com:guardian/guardian.github.com.git 32 | 33 | Then once again in sbt (using ./sbt10) run the command 34 | 35 | publish 36 | 37 | This will copy the packages to the directory 38 | 39 | ~/guardian.github.com 40 | 41 | Then change directories to here and add/commit accordingly. You will receive an email from Github when the pages have been launched. You will then be able to reference from your dependent projects. -------------------------------------------------------------------------------- /sbt-launch-0.10.0.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guardian/music-api-scala-client/3359a1c000435f8ee7116ca12f7b3bc5d25337ee/sbt-launch-0.10.0.jar -------------------------------------------------------------------------------- /sbt010: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | java -Xmx512M -XX:MaxPermSize=250m -Dhttp.proxyHost=devscreen.gudev.gnl -Dhttp.proxyPort=3128 -jar `dirname $0`/sbt-launch-*.jar "$@" 4 | #java -Xmx512M -XX:MaxPermSize=250m -jar `dirname $0`/sbt-launch-*.jar "$@" 5 | --------------------------------------------------------------------------------