itunes_api 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c771828d631c80dd7ef7b555ca9172c79b58baf8
-  data.tar.gz: 60fdc7036173756e07a4f0d64561b8b20b58552f
+  metadata.gz: f0119772a5f3282816339b02adb15ed086292f73
+  data.tar.gz: dfcbbf5230c641efba8adf69ecbb6f6405329ca9
 SHA512:
-  metadata.gz: 3b5989a5a4b21a7073321545974ae04f55df3d3d504598017ec6e0aba56df4f7c5233a2f7cd6886b5d8e610c2cf29b9f374cac5eb74eaf729669ac20c66e4556
-  data.tar.gz: 11b1ae2aa25b1671dc00f9fb200ab0020876e6a926f2ac8a8cae8774178726a0bc12f1b97478d551db0d51717a125d94ea4758d765b6650174ca056a90607a39
+  metadata.gz: 78a8a929d19ce114f8821f9dac825ee5bdb05164ca1b435886768d3d976e2912595ffd4421f090b2656568c3d1704ebb7f12c8f8251166732d2e30604e47df74
+  data.tar.gz: e08ab36a8e01cc425fc05cdfaaf195b31f1566ccbcfd280a505c5d8ea2ceb85f3d2cff3ef686d086dc3405cc7ce6503b6efa33f61bc5096ed2e03d663cc8df8b

data/README.md

@@ -37,16 +37,10 @@ end
 
 ## Usage
 
-To return all the Apple ids associated with the search for a Artist name
-
-```ruby
-ItunesApi::Music.all_apple_ids('Pink Floyd')
-```
-
 To get all artists returning from a search term
 
 ```ruby
-ItunesApi::Music.all_artists_by_name('Led Zeppelin')
+ItunesApi::Music.find_by_name('Led Zeppelin')
 ```
 
 To return a specific artist, based on the artist's Apple id
@@ -61,27 +55,38 @@ They are lazily fetched when calling artist.albums.
 To return only the albums for a specific artist, based on the artist's Apple id
 
 ```ruby
-ItunesApi::Music.albums_for_artist(265766061)
+ItunesApi::Music.find_albums_by_apple_id(265766061)
 ```
 
 To return a specific album, based on the album's collection id
 
 ```ruby
-ItunesApi::Music.find_by_collection_id(collection_id, store)
+ItunesApi::Music.find_by_collection_id(286930912)
 ```
 
 Note that each request that returns albums does not automatically return songs.
 They are lazily fetched when calling album.tracklist.
 
+To return only the songs for a specific album, based on the album's collection id
+
+```ruby
+ItunesApi::Music.find_songs_by_collection_id(286930912)
+```
+
+To return a specific track, based on its track id
+
+```ruby
+ItunesApi::Music.find_by_track_id(286931522)
+```
+
 ---
 
 An argument holding the country code can be used to look into different stores than the default one
 
 ```ruby
-ItunesApi::Music.all_apple_ids('Pink Floyd', :it)
-ItunesApi::Music.all_artists_by_name('Led Zeppelin', :fr)
+ItunesApi::Music.find_by_name('Led Zeppelin', :fr)
 ItunesApi::Music.find_by_apple_id(265766061, :us)
-ItunesApi::Music.albums_for_artist(265766061, :es)
+ItunesApi::Music.find_albums_by_apple_id(265766061, :es)
 ```
 
 ## Development

data/lib/itunes_api/music/album.rb

@@ -16,23 +16,19 @@ module ItunesApi
 
       class << self
         def find_by_collection_id(collection_id, store)
-          result = album(collection_id, store)
+          result = albums(collection_id, store).first
 
           new(*result.attributes) if result
         end
 
-        def for_artist(apple_id, store)
+        def find_by_apple_id(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)
+        def albums(id, store)
+          Requests::Albums.find_by_id(id, store)
         end
       end
 
@@ -61,7 +57,7 @@ module ItunesApi
       end
 
       def tracklist
-        @tracklist ||= songs.map { |song| Song.new(*song.attributes) }
+        @tracklist ||= Song.find_by_collection_id(collection_id, store)
       end
 
       private
@@ -79,10 +75,6 @@ module ItunesApi
       def pre_release?
         release_on > Date.today
       end
-
-      def songs
-        @songs ||= Requests::Songs.find_by_collection_id(collection_id, store)
-      end
     end
   end
 end

data/lib/itunes_api/music/artist.rb

@@ -5,30 +5,27 @@ module ItunesApi
       attr_reader_init :amg_id, :apple_id, :genre, :link, :name, :store
 
       class << self
-        def all_apple_ids(name, store)
-          find_all_by_name(name, store).map(&:apple_id)
-        end
-
-        def find_all_by_name(name, store)
+        def find_by_name(name, store)
           Requests::Search.artists(name, store).map do |result|
             new(*result.attributes)
           end
         end
 
         def find_by_apple_id(apple_id, store)
-          artist = artist(apple_id, store)
-          artist ? new(*artist.attributes) : nil
+          result = artists(apple_id, store).first
+
+          new(*result.attributes) if result
         end
 
         private
 
-        def artist(apple_id, store)
-          Requests::Artist.find_by_apple_id(apple_id, store)
+        def artists(id, store)
+          Requests::Artist.find_by_id(id, store)
         end
       end
 
       def albums
-        @albums ||= Album.for_artist(apple_id, store)
+        @albums ||= Album.find_by_apple_id(apple_id, store)
       end
 
       def to_hash

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

@@ -5,18 +5,14 @@ module ItunesApi
       class Albums
         include Request
         attr_reader_init :search_id, :store
-        selfie :find_by_apple_id, :find_by_collection_id
+        selfie :find_by_id
 
-        def find_by_apple_id
-          unwrapped_results.map do |result|
+        def find_by_id
+          unwrapped_results(:collection).map do |result|
             Results::Album.new(result, store)
           end
         end
 
-        def find_by_collection_id
-          find_by_apple_id.first
-        end
-
         private
 
         def action
@@ -25,20 +21,12 @@ module ItunesApi
 
         def query
           {
-            id: search_id,
             country: store.to_s.upcase,
             entity: :album,
+            id: search_id,
             limit: LIMIT
           }
         end
-
-        def unwrapped_results
-          return [] unless results.any?
-
-          results.find_all do |wrappers|
-            wrappers['wrapperType'] == 'collection'
-          end
-        end
       end
     end
   end

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

@@ -4,13 +4,13 @@ module ItunesApi
       # Allows querying the API via lookup for artists.
       class Artist
         include Request
-        attr_reader_init :apple_id, :store
-        selfie :find_by_apple_id
+        attr_reader_init :search_id, :store
+        selfie :find_by_id
 
-        def find_by_apple_id
-          return nil unless results.any?
-
-          Results::Artist.new(results.first, store)
+        def find_by_id
+          unwrapped_results(:artist).map do |result|
+            Results::Artist.new(result, store)
+          end
         end
 
         private
@@ -21,7 +21,7 @@ module ItunesApi
 
         def query
           {
-            id: apple_id,
+            id: search_id,
             country: store.to_s.upcase,
             limit: LIMIT
           }

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

@@ -4,12 +4,12 @@ module ItunesApi
       # Allows querying the API via lookup for album songs.
       class Songs
         include Request
-        attr_reader_init :collection_id, :store
-        selfie :find_by_collection_id
+        attr_reader_init :search_id, :store
+        selfie :find_by_id
 
-        def find_by_collection_id
-          unwrapped_results.map do |result|
-            Results::Song.new(result)
+        def find_by_id
+          unwrapped_results(:track).map do |result|
+            Results::Song.new(result, store)
           end
         end
 
@@ -21,21 +21,13 @@ module ItunesApi
 
         def query
           {
-            entity: 'song',
-            id: collection_id,
             country: store.to_s.upcase,
+            entity: 'song',
+            id: search_id,
             limit: LIMIT,
             sort: 'trackNumber'
           }
         end
-
-        def unwrapped_results
-          return [] unless results.any?
-
-          results.find_all do |wrappers|
-            wrappers['wrapperType'] == 'track'
-          end
-        end
       end
     end
   end

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

@@ -3,15 +3,48 @@ module ItunesApi
     module Results
       # Wrapper for song search results.
       class Song
-        attr_reader_init :data
+        attr_reader_init :data, :store
         private :data
 
+        def album
+          @album ||= data['collectionName']
+        end
+
+        def artist
+          @artist ||= data['artistName']
+        end
+
+        def attributes
+          [
+            album,
+            artist,
+            duration,
+            explicitness,
+            genre,
+            link,
+            name,
+            number,
+            preview,
+            store,
+            streamable,
+            track_id
+          ]
+        end
+
         def duration
           @duration ||= track_lenght(data['trackTimeMillis'])
         end
 
-        def attributes
-          [duration, name, number, streamable]
+        def explicitness
+          @explicitness ||= data['trackExplicitness']
+        end
+
+        def genre
+          @genre ||= data['primaryGenreName']
+        end
+
+        def link
+          @link ||= data['trackViewUrl']
         end
 
         def name
@@ -22,10 +55,18 @@ module ItunesApi
           @number ||= data['trackNumber']
         end
 
+        def preview
+          @preview ||= data['previewUrl']
+        end
+
         def streamable
           @streamable ||= data['isStreamable']
         end
 
+        def track_id
+          @track_id ||= data['trackId']
+        end
+
         private
 
         def track_lenght(milliseconds)

data/lib/itunes_api/music/song.rb

@@ -2,15 +2,57 @@ module ItunesApi
   module Music
     # Wrapper for song results.
     class Song
-      attr_reader_init :duration, :name, :number, :streamable
+      attr_reader_init :album,
+                       :artist,
+                       :duration,
+                       :explicitness,
+                       :genre,
+                       :link,
+                       :name,
+                       :number,
+                       :preview,
+                       :store,
+                       :streamable,
+                       :track_id
+
       alias streamable? streamable
 
+      class << self
+        def find_by_collection_id(collection_id, store)
+          songs(collection_id, store).map { |song| new(*song.attributes) }
+        end
+
+        def find_by_track_id(track_id, store)
+          result = songs(track_id, store).first
+
+          new(*result.attributes) if result
+        end
+
+        private
+
+        def songs(id, store)
+          Requests::Songs.find_by_id(id, store)
+        end
+      end
+
+      def explicit?
+        explicitness == 'explicit'
+      end
+
       def to_hash
         {
+          album: album,
+          artist: artist,
           duration: duration,
+          explicit: explicit?,
+          genre: genre,
+          link: link,
           name: name,
           number: number,
-          stremable: streamable?
+          preview: preview,
+          store: store,
+          streamable: streamable,
+          track_id: track_id
         }
       end
     end

data/lib/itunes_api/music.rb

@@ -9,26 +9,30 @@ module ItunesApi
   # Public interface for the Music Api
   module Music
     class << self
-      def all_apple_ids(name, store = default_store)
-        Artist.all_apple_ids(name, store)
-      end
-
-      def all_artists_by_name(name, store = default_store)
-        Artist.find_all_by_name(name, store)
+      def find_by_name(name, store = default_store)
+        Artist.find_by_name(name, store)
       end
 
       def find_by_apple_id(apple_id, store = default_store)
         Music::Artist.find_by_apple_id(apple_id, store)
       end
 
-      def albums_for_artist(apple_id, store = default_store)
-        Music::Album.for_artist(apple_id, store)
+      def find_albums_by_apple_id(apple_id, store = default_store)
+        Music::Album.find_by_apple_id(apple_id, store)
       end
 
-      def find_by_collection_id(collection_id, store)
+      def find_by_collection_id(collection_id, store = default_store)
         Music::Album.find_by_collection_id(collection_id, store)
       end
 
+      def find_songs_by_collection_id(collection_id, store = default_store)
+        Music::Song.find_by_collection_id(collection_id, store)
+      end
+
+      def find_by_track_id(track_id, store = default_store)
+        Music::Song.find_by_track_id(track_id, store)
+      end
+
       private
 
       def default_store

data/lib/itunes_api/request.rb

@@ -9,16 +9,24 @@ module ItunesApi
 
     private
 
-    def parsed_response
-      JSON.parse(response.body)
-    end
-
     def connection
       Faraday.new(url: BASE_URL)
     end
 
+    def parsed_response
+      JSON.parse(response.body)
+    end
+
     def response
       connection.get(action, query)
     end
+
+    def unwrapped_results(type)
+      return [] unless results.any?
+
+      results.find_all do |wrappers|
+        wrappers['wrapperType'] == type.to_s
+      end
+    end
   end
 end

data/lib/itunes_api/version.rb

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

metadata

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