itunes_api 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b7a79e554749a6e18d54f28f00105456d35fa9b
-  data.tar.gz: f4c3493a4838318d654a8fe6fb5cd13c5ff51ad5
+  metadata.gz: 1810ef10c9524ed9723f646906484b6a30e9e0b8
+  data.tar.gz: 6506854bfadcf78976c134e745b87412645c052d
 SHA512:
-  metadata.gz: 442270dae2b4da5febc278f62cf3a69ef9b9c2fab310faeecba5efd71080be2925059d3a82c495060fed926e490f45038212497183874153c62679394b0d0ee2
-  data.tar.gz: 7feeadb252a1849aa7f760f2c9920aa12e11a0482269b321b032dc7968e42fff57415c420a7667632401ba719b275075d70d0a6a5a1886b4f9fd5f8084c38a09
+  metadata.gz: b2cb36e5ada9e4a679d8e0da83bf0dc25c185785c64ad620b6c3c2997d8787e0627fcadeafab29774928bd1d35bcab0ff3a082363030183c7fa7523bab24880a
+  data.tar.gz: 695d0dc2e55ee694e6eddd94b5d1da1308131cde7603cd16a1f70a3b82af70ad8ea0924532d8c87f0788e3d4acf079088cc50708270d5dbd41dfb6f6a18b4e50

data/README.md

@@ -1,7 +1,5 @@
-[![Gem Version](https://badge.fury.io/rb/itunes_api.svg)](https://badge.fury.io/rb/itunes_api) [![Dependency Status](https://gemnasium.com/badges/github.com/mariodarco/itunes-api.svg)](https://gemnasium.com/github.com/mariodarco/itunes-api) [![CircleCI](https://circleci.com/gh/mariodarco/itunes-api/tree/master.svg?style=shield)](https://circleci.com/gh/mariodarco/itunes-api/tree/master)
-
-
 # ItunesApi
+[![Gem Version](https://badge.fury.io/rb/itunes_api.svg)](https://badge.fury.io/rb/itunes_api) [![Dependency Status](https://gemnasium.com/badges/github.com/mariodarco/itunes-api.svg)](https://gemnasium.com/github.com/mariodarco/itunes-api) [![CircleCI](https://circleci.com/gh/mariodarco/itunes-api/tree/master.svg?style=shield)](https://circleci.com/gh/mariodarco/itunes-api/tree/master) [![Coverage Status](https://coveralls.io/repos/github/mariodarco/itunes-api/badge.svg?branch=master)](https://coveralls.io/github/mariodarco/itunes-api?branch=master)
 
 A simple interface for the Itunes Api.
 
@@ -42,22 +40,28 @@ To return all the Apple ids associated with a search term.
 ItunesApi.artist_ids('Pink Floyd')
 ```
 
+To get all artists returning from a search term, and their albums.
+```ruby
+ItunesApi.artist_search('Led Zeppelin')
+```
+
 To return a specific artist with albums, based on the Apple id.
 ```ruby
-ItunesApi.artist_lookup(12345)
+ItunesApi.artist_lookup(265766061)
 ```
 
-To get all artists returning from a search term, and their albums.
+To return the tracklist for a specific albums, based on the Apple collection id.
 ```ruby
-ItunesApi.artist_search('Pink Floyd')
+ItunesApi.album_lookup(286930912)
 ```
 
 An argument holding the country code can be used to look into different stores than the default one.
 
 ```ruby
 ItunesApi.artist_ids('Pink Floyd', :it)
-ItunesApi.artist_lookup(12345, :us)
-ItunesApi.artist_search('Pink Floyd', :fr)
+ItunesApi.artist_search('Led Zeppelin', :fr)
+ItunesApi.artist_lookup(265766061, :us)
+ItunesApi.album_lookup(286930912, :gb)
 ```
 
 ## Development

data/itunes_api.gemspec

@@ -27,8 +27,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'selfies'
 
   spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'vcr'
 end

data/lib/itunes_api/music/album.rb

@@ -1,12 +1,13 @@
+require 'date'
 module ItunesApi
   module Music
     # Wrapper for album results.
     class Album
-      attr_reader_init :data
+      attr_reader_init :data, :store
       private :data
 
-      def self.build(albums_data)
-        albums_data.map { |data| new(data) }
+      def self.build(albums_data, store)
+        albums_data.map { |data| new(data, store) }
                    .sort_by(&:released)
                    .reverse
       end
@@ -15,6 +16,10 @@ module ItunesApi
         @artwork ||= data[:artworkUrl100]
       end
 
+      def apple_music?
+        tracklist.any?(&:streamable?)
+      end
+
       def collection_id
         @collection_id ||= data[:collectionId]
       end
@@ -33,8 +38,15 @@ module ItunesApi
           collection_id: collection_id,
           name: name,
           released: released,
+          apple_music: apple_music?
         }
       end
+
+      private
+
+      def tracklist
+        @tracklist ||= AlbumLookup.tracklist(collection_id, store)
+      end
     end
   end
 end

data/lib/itunes_api/music/album_lookup.rb

@@ -0,0 +1,21 @@
+module ItunesApi
+  module Music
+    # Album Tracklist resulting from a specific lookup
+    class AlbumLookup
+      attr_reader_init :album_id, :store
+      selfie :tracklist
+
+      def tracklist
+        return [] unless songs_data
+
+        Track.build(songs_data)
+      end
+
+      private
+
+      def songs_data
+        @songs_data ||= Requests::AlbumTracklist.songs(album_id, store)
+      end
+    end
+  end
+end

data/lib/itunes_api/music/all.rb

@@ -1,4 +1,6 @@
 require_relative 'album'
 require_relative 'artist'
+require_relative 'album_lookup'
 require_relative 'artist_lookup'
 require_relative 'artist_search'
+require_relative 'track'

data/lib/itunes_api/music/artist.rb

@@ -2,11 +2,11 @@ module ItunesApi
   module Music
     # Artist or Band from the Apple catalog
     class Artist
-      attr_reader_init :data
+      attr_reader_init :data, :store
       private :data
 
       def albums
-        @albums ||= Album.build(data[:albums])
+        @albums ||= Album.build(data[:albums], store)
       end
 
       def apple_id

data/lib/itunes_api/music/artist_lookup.rb

@@ -14,7 +14,7 @@ module ItunesApi
       def build_artist
         return lookup unless lookup
 
-        Artist.new(lookup)
+        Artist.new(lookup, store)
       end
 
       def lookup

data/lib/itunes_api/music/artist_search.rb

@@ -17,7 +17,7 @@ module ItunesApi
 
       def build_artist(id)
         if (lookup = lookup(id))
-          Artist.new(lookup)
+          Artist.new(lookup, store)
         end
       end
 

data/lib/itunes_api/music/track.rb

@@ -0,0 +1,46 @@
+module ItunesApi
+  module Music
+    # Wrapper for song results.
+    class Track
+      attr_reader_init :data
+      private :data
+
+      def self.build(songs_data)
+        songs_data.map { |data| new(data) }
+      end
+
+      def duration
+        @duration ||= track_lenght(data[:trackTimeMillis])
+      end
+
+      def name
+        @name ||= data[:trackName]
+      end
+
+      def number
+        data[:trackNumber]
+      end
+
+      def streamable?
+        data[:isStreamable]
+      end
+
+      def to_hash
+        {
+          duration: duration,
+          name: name,
+          number: number,
+          stremable: stremable?,
+        }
+      end
+
+      private
+
+      def track_lenght(milliseconds)
+        minutes, milliseconds = milliseconds.divmod(1000 * 60)
+        seconds = milliseconds / 1000
+        "#{minutes}:#{seconds}"
+      end
+    end
+  end
+end

data/lib/itunes_api/requests/album_tracklist.rb

@@ -0,0 +1,36 @@
+module ItunesApi
+  module Requests
+    # Allows querying the API via lookup for album songs.
+    class AlbumTracklist
+      include Base
+      attr_reader_init :album_id, :store
+      selfie :songs
+
+      def songs
+        songs_data.map do |song|
+          symbolize_keys(unwrapped(song))
+        end
+      end
+
+      private
+
+      def action
+        'lookup'
+      end
+
+      def songs_data
+        results.find_all { |wrappers| wrappers['wrapperType'] == 'track' }
+      end
+
+      def query
+        {
+          entity: 'song',
+          id: album_id,
+          country: store.to_s.upcase,
+          limit: LIMIT,
+          sort: 'trackNumber'
+        }
+      end
+    end
+  end
+end

data/lib/itunes_api/requests/all.rb

@@ -1,3 +1,4 @@
 require_relative 'base'
+require_relative 'album_tracklist'
 require_relative 'lookup'
 require_relative 'search'

data/lib/itunes_api/requests/base.rb

@@ -28,6 +28,10 @@ module ItunesApi
           new_hash
         end
       end
+
+      def unwrapped(data_hash)
+        data_hash.tap { |hash| hash.delete('wrapperType') }
+      end
     end
   end
 end

data/lib/itunes_api/requests/lookup.rb

@@ -43,16 +43,12 @@ module ItunesApi
       def query
         {
           entity: 'album',
-          id: @artist_id,
+          id: artist_id,
           country: store.to_s.upcase,
           limit: LIMIT,
           sort: 'recent'
         }
       end
-
-      def unwrapped(data_hash)
-        data_hash.tap { |hash| hash.delete('wrapperType') }
-      end
     end
   end
 end

data/lib/itunes_api/version.rb

@@ -1,3 +1,3 @@
 module ItunesApi
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/lib/itunes_api.rb

@@ -12,6 +12,10 @@ module ItunesApi
     Requests::Search.artist_ids(name, store)
   end
 
+  def self.album_lookup(album_id, store = default_store)
+    Music::AlbumLookup.tracklist(album_id, store)
+  end
+
   def self.artist_lookup(artist_id, store = default_store)
     Music::ArtistLookup.artist(artist_id, store)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: itunes_api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Mario D’Arco
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -128,10 +156,13 @@ files:
 - lib/itunes_api.rb
 - lib/itunes_api/configuration.rb
 - lib/itunes_api/music/album.rb
+- lib/itunes_api/music/album_lookup.rb
 - lib/itunes_api/music/all.rb
 - lib/itunes_api/music/artist.rb
 - lib/itunes_api/music/artist_lookup.rb
 - lib/itunes_api/music/artist_search.rb
+- lib/itunes_api/music/track.rb
+- lib/itunes_api/requests/album_tracklist.rb
 - lib/itunes_api/requests/all.rb
 - lib/itunes_api/requests/base.rb
 - lib/itunes_api/requests/lookup.rb