itunes_api 0.2.0 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0cefe7c03674f77de95c0ad26c37f7bcf1846228
-  data.tar.gz: d0ae1fa1c14205710238e2c49ec8d61f6c4fb332
+  metadata.gz: 0c1598295d32c9506679762afd2abca9f790ba68
+  data.tar.gz: 9a3afea483d0203ed586d925480e5cb2e83a6031
 SHA512:
-  metadata.gz: 602db34f182e67fae632a47a5e3a955c964ed5c27c36e36ea6a910ffbaef40d04f2969250f613e0f4f9f184ab42813be6aa96d076e186b84375d93cb14a5d556
-  data.tar.gz: ae5429fdef3d026b6c881d275d296781323d769db55b9f49d1474f736c2422b6835fbf2f5582b084423a1fef1b4cbec71fb481fdd1422d024207c91c4913d1e3
+  metadata.gz: c2ff9e9ef1bf7be358865930aae4d308e0819ce6537bdad89081a596117444744e6f921c5df4e956da11d716ee44f0436fa2d3e310fed1645e1420b0d1646bb8
+  data.tar.gz: '09e2991f926527d5558d3772c697d5e2aaa24aab87f4e6394981d7f22fe8fe1bdb41f172f0a22c248b8fd82041e152a367e3f611cd15c10f5907ba75a88a2fbb'

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
+ruby '2.3.3'
 
 # Specify your gem's dependencies in itunes_api.gemspec
 gemspec

data/README.md

@@ -1,3 +1,6 @@
+[![CircleCI](https://circleci.com/gh/mariodarco/itunes-api/tree/master.svg?style=shield)](https://circleci.com/gh/mariodarco/itunes-api/tree/master)
+
+
 # ItunesApi
 
 A simple interface for the Itunes Api.
@@ -12,18 +15,41 @@ gem 'itunes_api'
 
 And then execute:
 
-    $ bundle
+```ruby
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install itunes_api
+```ruby
+$ gem install itunes_api
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+To return all the AMG ids associated with a search term.
+```ruby
+ItunesApi.artist_ids('Pink Floyd')
+```
+
+To return structured information abut artists and albums associated with a search term.
+```ruby
+ItunesApi.artist_ids('Pink Floyd')
+```
 
 ## Development
 
+Ruby version:
+```
+2.3.3
+```
+
+Fork the project, clone the repository and bundle:
+```
+>> git clone https://github.com/{your_account}/itunes-api.git
+>> cd itunes-api
+```
+
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
@@ -32,8 +58,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 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.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/itunes_api.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'itunes_api/version'
@@ -30,10 +31,10 @@ Gem::Specification.new do |spec|
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
-  spec.add_dependency 'addressable', '~> 2.5'
+  spec.add_dependency 'addressable'
 
-  spec.add_development_dependency 'bundler', '~> 1.13'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
 end

data/lib/itunes_api/music/album.rb

@@ -1,44 +1,17 @@
 module ItunesApi
   module Music
-    # Retrieves album tracks info.
+    # Wrapper for album results.
     class Album
-      attr_accessor :name, :artwork, :track_count, :release_date
-      include Request
+      attr_reader :name, :artwork, :released
 
-      def initialize(info)
-        @name = info['collectionName']
-        @album_id = info['collectionId']
-        @artwork = info['artworkUrl100']
-        @track_count = info['trackCount']
-        @release_date = Date.parse(info['releaseDate'])
+      def initialize(data)
+        @name = data['collectionName']
+        @artwork = data['artworkUrl100']
+        @released = Date.parse(data['releaseDate'])
       end
 
-      def apple_music?
-        streamable_tracks.any?
-      end
-
-      def streamable_tracks
-        tracks.select { |track| track['isStreamable'] }
-      end
-
-      def tracks
-        @tracks ||= filtered_results.sort_by { |track| track['trackNumber'] }
-      end
-
-      private
-
-      def filtered_results
-        @filtered_results ||= results.find_all do |result|
-          result['collectionId'] == @album_id
-        end
-      end
-
-      def query_values
-        {
-          attribute: 'albumTerm',
-          entity: 'musicTrack',
-          term: name
-        }.merge(super)
+      def self.build(albums_data)
+        albums_data.map { |data| new(data) }
       end
     end
   end

data/lib/itunes_api/music/artist.rb

@@ -1,54 +1,13 @@
-require 'addressable/uri'
-
 module ItunesApi
   module Music
-    # Retrieve apple ids and albums of artists.
+    # Artist or Band from the Apple catalog
     class Artist
-      include Request
-
-      def initialize(artist_name, apple_id = nil)
-        @artist_name = artist_name
-        @apple_id = normalize(apple_id.to_i)
-      end
-
-      def albums(limit = 3)
-        @albums ||= filtered_results
-                    .sort_by { |result| result['releaseDate'] }
-                    .reverse
-                    .first(limit)
-                    .map { |info| Album.new(info) }
-      end
-
-      def normalize(apple_id)
-        apple_id.zero? ? nil : apple_id
-      end
-
-      def apple_ids
-        return [@apple_id] if @apple_id
-
-        @apple_ids ||= filtered_albums.collect do |album|
-          album['artistId']
-        end.compact.uniq.sort
-      end
-
-      private
-
-      def filtered_albums
-        results.find_all { |result| result['collectionType'] == 'Album' }
-      end
-
-      def filtered_results
-        filtered_albums.find_all do |album|
-          (!@apple_id || album['artistId'] == @apple_id)
-        end
-      end
+      attr_reader :name, :artist_id, :albums
 
-      def query_values
-        {
-          attribute: 'artistTerm',
-          entity: 'album',
-          term: @artist_name
-        }.merge(super)
+      def initialize(data)
+        @name = data['artistName']
+        @artist_id = data['amgArtistId']
+        @albums = Album.build(data[:albums])
       end
     end
   end

data/lib/itunes_api/music/artist_search.rb

@@ -0,0 +1,30 @@
+module ItunesApi
+  module Music
+    # Artists or Bands resulting from a search
+    class ArtistSearch
+      def initialize(name)
+        @name = name
+      end
+
+      def self.artists(name)
+        new(name).artists
+      end
+
+      def artists
+        @artists ||= artist_ids.map { |id| build_artist(id) }
+      end
+
+      private
+
+      def artist_ids
+        @search ||= ItunesApi.artist_ids(@name)
+      end
+
+      def build_artist(id)
+        Artist.new(
+          Requests::Lookup.artist_with_albums(id)
+        )
+      end
+    end
+  end
+end

data/lib/itunes_api/requests/base.rb

@@ -0,0 +1,39 @@
+require 'open-uri'
+require 'json'
+module ItunesApi
+  module Requests
+    # Allow requests to the iTunes API.
+    module Base
+      def results
+        response.fetch('results') { [] }
+      end
+
+      private
+
+      def query
+        Addressable::URI.new(
+          query_values: query_values
+        ).query
+      end
+
+      def request
+        open(url).read
+      end
+
+      def response
+        @response ||= JSON.parse(request)
+      end
+
+      def symbolize_keys(hash)
+        hash.each_with_object({}) do |(key, value), new_hash|
+          new_hash[key.to_sym] = value
+          new_hash
+        end
+      end
+
+      def url
+        "#{BASE_URL}/#{action}?#{query}"
+      end
+    end
+  end
+end

data/lib/itunes_api/requests/lookup.rb

@@ -0,0 +1,65 @@
+module ItunesApi
+  module Requests
+    # Allows querying the API via lookup.
+    class Lookup
+      include Base
+
+      def initialize(artist_id)
+        @artist_id = artist_id
+      end
+
+      def self.artist_with_albums(id)
+        new(id).artist_with_albums
+      end
+
+      def artist_with_albums
+        artist.merge(albums: albums)
+      end
+
+      private
+
+      def action
+        'lookup'
+      end
+
+      def albums
+        albums_data.map do |album|
+          symbolize_keys(unwrapped(album))
+        end
+      end
+
+      def albums_data
+        results.find_all { |wrappers| wrappers['wrapperType'] == 'collection' }
+      end
+
+      def artist
+        symbolize_keys(unwrapped(artist_data))
+      end
+
+      def artist_data
+        symbolize_keys(
+          unwrapped(
+            results.find do |wrappers|
+              wrappers['wrapperType'] == 'artist'
+            end
+          )
+        )
+      end
+
+      def query_values
+        {
+          entity: 'album',
+          amgArtistId: @artist_id,
+          country: COUNTRY_CODE,
+          limit: LIMIT,
+          sort: 'recent'
+        }
+      end
+
+      def unwrapped(hash)
+        hash.delete('wrapperType')
+        hash
+      end
+    end
+  end
+end

data/lib/itunes_api/requests/search.rb

@@ -0,0 +1,41 @@
+require 'addressable/uri'
+module ItunesApi
+  module Requests
+    # Fetch all the artist ids corresponding to a search term
+    class Search
+      include Base
+
+      def initialize(artist_name)
+        @artist_name = artist_name
+      end
+
+      def self.artist_ids(artist_name)
+        new(artist_name).artist_ids
+      end
+
+      def artist_ids
+        results.collect do |result|
+          result['amgArtistId']
+        end.compact.uniq.sort
+      end
+
+      private
+
+      def action
+        'search'
+      end
+
+      def query_values
+        {
+          attribute: 'artistTerm',
+          entity: 'album',
+          term: @artist_name,
+          country: COUNTRY_CODE,
+          limit: LIMIT,
+          media: 'music',
+          sort: 'recent'
+        }
+      end
+    end
+  end
+end

data/lib/itunes_api/version.rb

@@ -1,3 +1,3 @@
 module ItunesApi
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3'.freeze
 end

data/lib/itunes_api.rb

@@ -1,8 +1,21 @@
-require 'itunes_api/all'
+require 'itunes_api/requests/base'
+require 'itunes_api/requests/lookup'
+require 'itunes_api/requests/search'
+require 'itunes_api/music/album'
+require 'itunes_api/music/artist'
+require 'itunes_api/music/artist_search'
 
 # Interface to the Itunes Api
 module ItunesApi
   BASE_URL = 'https://itunes.apple.com'.freeze
   COUNTRY_CODE = 'GB'.freeze
   LIMIT = 200
+
+  def self.artist_ids(name)
+    Requests::Search.artist_ids(name)
+  end
+
+  def self.artist_search(name)
+    Music::ArtistSearch.artists(name)
+  end
 end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: itunes_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: '0.3'
 platform: ruby
 authors:
 - Mario D’Arco
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-08 00:00:00.000000000 Z
+date: 2017-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -89,8 +89,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".ruby-version"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -100,11 +98,12 @@ files:
 - bin/setup
 - itunes_api.gemspec
 - lib/itunes_api.rb
-- lib/itunes_api/all.rb
 - lib/itunes_api/music/album.rb
-- lib/itunes_api/music/all.rb
 - lib/itunes_api/music/artist.rb
-- lib/itunes_api/request.rb
+- lib/itunes_api/music/artist_search.rb
+- lib/itunes_api/requests/base.rb
+- lib/itunes_api/requests/lookup.rb
+- lib/itunes_api/requests/search.rb
 - lib/itunes_api/version.rb
 homepage: https://github.com/mariodarco/itunes-api
 licenses:
@@ -127,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: iTunes Api

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.4

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.1
-before_install: gem install bundler -v 1.13.6

data/lib/itunes_api/all.rb

@@ -1,2 +0,0 @@
-require_relative 'request'
-require_relative 'music/all'

data/lib/itunes_api/music/all.rb

@@ -1,2 +0,0 @@
-require_relative 'album'
-require_relative 'artist'

data/lib/itunes_api/request.rb

@@ -1,40 +0,0 @@
-require 'open-uri'
-require 'json'
-
-module ItunesApi
-  # Allow requests to the iTunes API.
-  module Request
-
-    def response
-      JSON.parse(request)
-    end
-
-    private
-
-    def request
-      @request ||= open(url).read
-    end
-
-    def query
-      Addressable::URI.new(
-        query_values: query_values
-      ).query
-    end
-
-    def query_values
-      {
-        country: COUNTRY_CODE,
-        limit: LIMIT,
-        media: 'music'
-      }
-    end
-
-    def results
-      response.fetch('results', [])
-    end
-
-    def url
-      "#{BASE_URL}/search?#{query}"
-    end
-  end
-end