itunes_api 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b59950a6d1529d61e387ac0ef1306324959bc43d
-  data.tar.gz: d5bb63b84da411992c53a7178224e34023d2f02a
+  metadata.gz: c771828d631c80dd7ef7b555ca9172c79b58baf8
+  data.tar.gz: 60fdc7036173756e07a4f0d64561b8b20b58552f
 SHA512:
-  metadata.gz: 4cabff1c9f4a1d757231f46d1623ed2d5506efee42e289ae92e63aa979bff1a3a6944e8170c885d468d2a0f314715192b5108385609d8a91e50317b0b802ee33
-  data.tar.gz: 63d044a01c39946370f2133a0190a0fad390db937fca70d43ac4b1885134154bff678ddccb489906602144e3dea5b66815b87a39115af2f795c904a9236d9ec6
+  metadata.gz: 3b5989a5a4b21a7073321545974ae04f55df3d3d504598017ec6e0aba56df4f7c5233a2f7cd6886b5d8e610c2cf29b9f374cac5eb74eaf729669ac20c66e4556
+  data.tar.gz: 11b1ae2aa25b1671dc00f9fb200ab0020876e6a926f2ac8a8cae8774178726a0bc12f1b97478d551db0d51717a125d94ea4758d765b6650174ca056a90607a39

data/README.md

@@ -64,6 +64,17 @@ To return only the albums for a specific artist, based on the artist's Apple id
 ItunesApi::Music.albums_for_artist(265766061)
 ```
 
+To return a specific album, based on the album's collection id
+
+```ruby
+ItunesApi::Music.find_by_collection_id(collection_id, store)
+```
+
+Note that each request that returns albums does not automatically return songs.
+They are lazily fetched when calling album.tracklist.
+
+---
+
 An argument holding the country code can be used to look into different stores than the default one
 
 ```ruby
@@ -76,12 +87,14 @@ ItunesApi::Music.albums_for_artist(265766061, :es)
 ## Development
 
 Ruby version:
-```
+
+```text
 2.4.1
 ```
 
 Fork the project, clone the repository and bundle:
-```
+
+```bash
 >> git clone https://github.com/{your_account}/itunes-api.git
 >> cd itunes-api
 ```
@@ -92,7 +105,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/mariodarco/itunes-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at [https://github.com/mariodarco/itunes-api](https://github.com/mariodarco/itunes-api). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/lib/itunes_api/music/album.rb

@@ -3,15 +3,34 @@ module ItunesApi
   module Music
     # Wrapper for album results.
     class Album
-      attr_reader_init :artwork, :collection_id, :genre, :name, :release_on, :store
+      attr_reader_init :artist,
+                       :artwork,
+                       :collection_id,
+                       :explicitness,
+                       :genre,
+                       :link,
+                       :name,
+                       :release_on,
+                       :store,
+                       :track_count
 
       class << self
+        def find_by_collection_id(collection_id, store)
+          result = album(collection_id, store)
+
+          new(*result.attributes) if result
+        end
+
         def for_artist(apple_id, store)
           albums(apple_id, store).map { |album| new(*album.attributes) }
         end
 
         private
 
+        def album(collection_id, store)
+          Requests::Albums.find_by_collection_id(collection_id, store)
+        end
+
         def albums(apple_id, store)
           Requests::Albums.find_by_apple_id(apple_id, store)
         end
@@ -21,14 +40,23 @@ module ItunesApi
         @availability ||= build_availability
       end
 
+      def explicit?
+        explicitness == 'explicit'
+      end
+
       def to_hash
         {
+          artist: artist,
           artwork: artwork,
           availability: availability,
           collection_id: collection_id,
+          explicit: explicit?,
+          genre: genre,
+          link: link,
           name: name,
           release_on: release_on,
-          store: store
+          store: store,
+          track_count: track_count
         }
       end
 

data/lib/itunes_api/music/artist.rb

@@ -2,7 +2,7 @@ module ItunesApi
   module Music
     # Artist or Band from the Apple catalog
     class Artist
-      attr_reader_init :apple_id, :genre, :name, :store
+      attr_reader_init :amg_id, :apple_id, :genre, :link, :name, :store
 
       class << self
         def all_apple_ids(name, store)
@@ -33,7 +33,10 @@ module ItunesApi
 
       def to_hash
         {
+          amg_id: amg_id,
           apple_id: apple_id,
+          genre: genre,
+          link: link,
           name: name,
           store: store
         }

data/lib/itunes_api/music/requests/albums.rb

@@ -4,8 +4,8 @@ module ItunesApi
       # Allows querying the API via lookup for albums.
       class Albums
         include Request
-        attr_reader_init :apple_id, :store
-        selfie :find_by_apple_id
+        attr_reader_init :search_id, :store
+        selfie :find_by_apple_id, :find_by_collection_id
 
         def find_by_apple_id
           unwrapped_results.map do |result|
@@ -13,6 +13,10 @@ module ItunesApi
           end
         end
 
+        def find_by_collection_id
+          find_by_apple_id.first
+        end
+
         private
 
         def action
@@ -21,7 +25,7 @@ module ItunesApi
 
         def query
           {
-            id: apple_id,
+            id: search_id,
             country: store.to_s.upcase,
             entity: :album,
             limit: LIMIT

data/lib/itunes_api/music/results/album.rb

@@ -6,22 +6,45 @@ module ItunesApi
         attr_reader_init :data, :store
         private :data
 
+        def artist
+          @artist ||= data['artistName']
+        end
+
         def artwork
           @artwork ||= data['artworkUrl100']
         end
 
         def attributes
-          [artwork, collection_id, genre, name, release_on, store]
+          [
+            artist,
+            artwork,
+            collection_id,
+            explicitness,
+            genre,
+            link,
+            name,
+            release_on,
+            store,
+            track_count
+          ]
         end
 
         def collection_id
           @collection_id ||= data['collectionId']
         end
 
+        def explicitness
+          @explicitness ||= data['collectionExplicitness']
+        end
+
         def genre
           @genre ||= data['primaryGenreName']
         end
 
+        def link
+          @link ||= data['collectionViewUrl']
+        end
+
         def name
           @name ||= data['collectionName']
         end
@@ -29,6 +52,10 @@ module ItunesApi
         def release_on
           @release_on ||= Date.parse(data['releaseDate'])
         end
+
+        def track_count
+          @track_count ||= data['trackCount']
+        end
       end
     end
   end

data/lib/itunes_api/music/results/artist.rb

@@ -6,18 +6,26 @@ module ItunesApi
         attr_reader_init :data, :store, search_term: nil
         private :data, :search_term
 
+        def amg_id
+          @amg_id ||= data['amgArtistId']
+        end
+
         def apple_id
           @apple_id ||= data['artistId']
         end
 
         def attributes
-          [apple_id, genre, name, store]
+          [amg_id, apple_id, genre, link, name, store]
         end
 
         def genre
           @genre ||= data['primaryGenreName']
         end
 
+        def link
+          @link ||= data['artistLinkUrl']
+        end
+
         def name
           @name ||= data['artistName']
         end

data/lib/itunes_api/music/song.rb

@@ -10,7 +10,7 @@ module ItunesApi
           duration: duration,
           name: name,
           number: number,
-          stremable: streamable?,
+          stremable: streamable?
         }
       end
     end

data/lib/itunes_api/music.rb

@@ -25,6 +25,10 @@ module ItunesApi
         Music::Album.for_artist(apple_id, store)
       end
 
+      def find_by_collection_id(collection_id, store)
+        Music::Album.find_by_collection_id(collection_id, store)
+      end
+
       private
 
       def default_store

data/lib/itunes_api/version.rb

@@ -1,3 +1,3 @@
 module ItunesApi
-  VERSION = '2.0.0'.freeze
+  VERSION = '2.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: itunes_api
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Mario D’Arco
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-04 00:00:00.000000000 Z
+date: 2017-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday