Add Show support

Author: sophiedeziel

lib/rspotify.rb

@@ -13,6 +13,7 @@ module RSpotify
   autoload :Playlist,           'rspotify/playlist'
   autoload :Recommendations,    'rspotify/recommendations'
   autoload :RecommendationSeed, 'rspotify/recommendation_seed'
+  autoload :Show,               'rspotify/show'
   autoload :Track,              'rspotify/track'
   autoload :TrackLink,          'rspotify/track_link'
   autoload :User,               'rspotify/user'

lib/rspotify/episode.rb

@@ -74,6 +74,10 @@ def initialize(options = {})
       @resume_point      = options['resume_point'] || {}
       @uri               = options['uri']
 
+      @show = if options['show']
+        Show.new options['show']
+      end
+
       super(options)
     end
   end

lib/rspotify/show.rb

@@ -0,0 +1,100 @@
+module RSpotify
+
+  # @attr [Array<String>] available_markets   A list of the countries in which the show can be played, identified by their ISO 3166-1 alpha-2 code.
+  # @attr [Array<Hash>]   copyrights          The copyright statements of the show.
+  # @attr [String]        description         A description of the show. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.
+  # @attr [Boolean]       explicit            Whether or not the show has explicit content (true = yes it does; false = no it does not OR unknown).
+  # @attr [String]        html_description    A description of the show. This field may contain HTML tags.
+  # @attr [Array<Hash>]   images              The cover art for the show in various sizes, widest first.
+  # @attr [Boolean]       is_externally_hosted    True if all of the show’s episodes are hosted outside of Spotify’s CDN. This field might be null in some cases.
+  # @attr [Array<String>] languages           A list of the languages used in the show, identified by their ISO 639 code.
+  # @attr [String]        media_type          The media type of the show.
+  # @attr [String]        name                The name of the show.
+  # @attr [String]        publisher           The publisher of the show.
+class Show < Base
+
+    # Returns Show object(s) with id(s) provided
+    #
+    # @param id [String, Array] Maximum: 50 IDs
+    # @param market [String] An {https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ISO 3166-1 alpha-2 country code}.
+    # @return [Show, Array<Show>]
+    #
+    # @example
+    #           show = RSpotify::Show.find('3Z6JdCS2d0eFEpXHKI6WqH')
+    #           show.class #=> RSpotify::Show
+    #           show.name  #=> "Consider This from NPR"
+    def self.find(ids, market: nil )
+      super(ids, 'show', market: market)
+    end
+    
+    # Returns array of Show objects matching the query. It's also possible to find the total number of search results for the query
+    #
+    # @param query  [String]  The search query's keywords. See the q description in {https://developer.spotify.com/web-api/search-item here} for details.
+    # @param limit  [Integer] Maximum number of shows to return. Maximum: 50. Default: 20.
+    # @param offset [Integer] The index of the first show to return. Use with limit to get the next set of shows. Default: 0.
+    # @param market [String] An {https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ISO 3166-1 alpha-2 country code}.
+    # @return [Array<Show>]
+    #
+    # @example
+    #           shows = RSpotify::Show.search('NPR')
+    #           shows = RSpotify::Show.search('NPR', market: 'US', limit: 10)
+    #
+    #           RSpotify::Show.search('NPR').total #=> 357
+    def self.search(query, limit: 20, offset: 0, market: nil)
+      super(query, 'show', limit: limit, offset: offset, market: market)
+    end
+
+    def initialize(options = {})
+      @available_markets = options['available_markets']
+      @copyrights        = options['copyrights']
+      @description       = options['description']
+      @explicit          = options['explicit']
+      @html_description  = options['html_description']
+      @images            = options['images']
+      @is_externally_hosted = options['is_externally_hosted']
+      @languages         = options['languages']
+      @media_type        = options['media_type']
+      @name              = options['name']
+      @publisher         = options['publisher']
+
+      episodes = options['episodes']['items'] if options['episodes']
+
+      @episodes_cache = if episodes
+        episodes.map { |e| Episode.new e }
+      end
+
+      super(options)
+    end
+
+    # Returns array of episodes from the show
+    #
+    # @param limit  [Integer] Maximum number of episodes to return. Maximum: 50. Default: 20.
+    # @param offset [Integer] The index of the first track to return. Use with limit to get the next set of objects. Default: 0.
+    # @param market [String]  An {https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ISO 3166-1 alpha-2 country code}.
+    # @return [Array<Episode>]
+    #
+    # @example
+    #           show = RSpotify::Show.find('3Z6JdCS2d0eFEpXHKI6WqH')
+    #           show.episodes.first.name #=> "Colin Powell's Complicated Legacy"
+    def episodes(limit: 20, offset: 0, market: nil )
+      last_episode = offset + limit - 1
+      if @episodes_cache && last_episode < 20 && !RSpotify.raw_response
+        return @episodes_cache[offset..last_episode]
+      end
+
+      url = "#{@href}/episodes?limit=#{limit}&offset=#{offset}"
+      url << "&market=#{market}" if market
+
+      response = RSpotify.get url
+
+      json = RSpotify.raw_response ? JSON.parse(response) : response
+      episodes = json['items']
+
+      episodes.map! { |e| Episode.new e }
+      @episodes_cache = episodes if limit == 20 && offset == 0
+      return response if RSpotify.raw_response
+      episodes
+    end
+
+  end
+end

spec/lib/rspotify/show_spec.rb

@@ -0,0 +1,138 @@
+describe RSpotify::Show do
+  describe 'Show::find receiving id as a string' do
+
+    before(:each) do
+      @show = VCR.use_cassette('show:find:5CfCWKI5pZ28U0uOzXkDHe') do
+        RSpotify::Show.find('5CfCWKI5pZ28U0uOzXkDHe')
+      end
+    end
+
+    it 'should find show with correct attributes' do
+      expect(@show.available_markets)        .to be_an   Array
+      expect(@show.copyrights)               .to eq []
+      expect(@show.external_urls['spotify']) .to eq      'https://open.spotify.com/show/5CfCWKI5pZ28U0uOzXkDHe'
+      expect(@show.description)              .to eq      'Candid conversations with entrepreneurs, artists, athletes, visionaries of all kinds—about their successes, and their failures, and what they learned from both. Hosted by Alex Blumberg, from Gimlet Media.'
+      expect(@show.explicit)                 .to eq      true
+      expect(@show.html_description)         .to eq      '<p>Candid conversations with entrepreneurs, artists, athletes, visionaries of all kinds—about their successes, and their failures, and what they learned from both. Hosted by Alex Blumberg, from Gimlet Media.</p>'
+      expect(@show.href)                     .to eq      'https://api.spotify.com/v1/shows/5CfCWKI5pZ28U0uOzXkDHe'
+      expect(@show.id)                       .to eq      '5CfCWKI5pZ28U0uOzXkDHe'
+      expect(@show.images)                   .to include ({'height' => 640, 'width' => 640, 'url' => 'https://i.scdn.co/image/ab6765630000ba8a9d827f6e7e311b5947cce059'})
+      expect(@show.is_externally_hosted)     .to eq      false
+      expect(@show.languages)                .to eq      ["en"]
+      expect(@show.media_type)               .to eq      "audio"
+      expect(@show.name)                     .to eq      "Without Fail"
+      expect(@show.publisher)                .to eq      "Gimlet"
+      expect(@show.type)                     .to eq      'show'
+      expect(@show.uri)                      .to eq      'spotify:show:5CfCWKI5pZ28U0uOzXkDHe'
+    end
+
+    it 'should find show with correct episodes' do
+      episodes = @show.episodes
+      expect(episodes)             .to be_an Array
+      expect(episodes.size)        .to eq 20
+      expect(episodes.first)       .to be_an RSpotify::Episode
+      expect(episodes.map(&:name)) .to include("Introducing Michelle Obama and Her Mentees")
+    end
+  end
+
+  describe 'Show::find receiving array of ids' do
+    it 'should find the right shows' do
+      ids = ['5CfCWKI5pZ28U0uOzXkDHe']
+      shows = VCR.use_cassette('show:find_many:5CfCWKI5pZ28U0uOzXkDHe') do
+        RSpotify::Show.find(ids)
+      end
+      expect(shows)             .to be_an Array
+      expect(shows.size)        .to eq 1
+      expect(shows.first)       .to be_an RSpotify::Show
+      expect(shows.map(&:name)) .to include("Without Fail")
+
+      ids << '5as3aKmN2k11yfDDDSrvaZ'
+      shows = VCR.use_cassette('show:find_many:5CfCWKI5pZ28U0uOzXkDHe:5as3aKmN2k11yfDDDSrvaZ') do
+        RSpotify::Show.find(ids)
+      end
+      expect(shows)             .to be_an Array
+      expect(shows.size)        .to eq 2
+      expect(shows.first)       .to be_an RSpotify::Show
+      expect(shows.map(&:name)) .to include("Giant Bombcast")
+    end
+
+    it 'should find shows available in the given market' do
+      ids = ['5CfCWKI5pZ28U0uOzXkDHe', '5as3aKmN2k11yfDDDSrvaZ']
+      shows = VCR.use_cassette('show:find_many:5CfCWKI5pZ28U0uOzXkDHe:5as3aKmN2k11yfDDDSrvaZ:market:CA') do
+        RSpotify::Show.find(ids, market: 'CA')
+      end
+
+      expect(shows)             .to be_an Array
+      expect(shows.map(&:id))   .to include '5CfCWKI5pZ28U0uOzXkDHe'
+    end
+  end
+
+  describe 'Show::search' do
+    it 'should search for the right shows' do
+      shows = VCR.use_cassette('show:search:without fail') do
+        RSpotify::Show.search('Without Fail')
+      end
+      expect(shows)             .to be_an Array
+      expect(shows.size)        .to eq 20
+      expect(shows.total)       .to eq 233
+      expect(shows.first)       .to be_an RSpotify::Show
+      expect(shows.map(&:name)) .to include('Without Fail', 'Teach Without a Burden')
+    end
+
+    it 'should accept additional options' do
+      shows = VCR.use_cassette('show:search:without fail:limit:10') do
+        RSpotify::Show.search('Without Fail', limit: 10)
+      end
+      expect(shows.size)        .to eq 10
+      expect(shows.map(&:name)) .to include('Without Fail', 'Teach Without a Burden')
+
+      shows = VCR.use_cassette('show:search:without fail:offset:10') do
+        RSpotify::Show.search('Without Fail', offset: 10)
+      end
+      expect(shows.size)        .to eq 20
+      expect(shows.map(&:name)) .to include('Weight Loss Mindset', 'Two In The Think Tank')
+
+      shows = VCR.use_cassette('show:search:without fail:offset:10:limit:10') do
+        RSpotify::Show.search('Without Fail', limit: 10, offset: 10)
+      end
+      expect(shows.size)        .to eq 10
+      expect(shows.map(&:name)) .to include('Two In The Think Tank')
+
+      shows = VCR.use_cassette('show:search:without fail:market:ES') do
+        RSpotify::Show.search('Without Fail', market: 'ES')
+      end
+      ES_shows = shows.select { |a| a.available_markets.include?('ES') }
+      expect(ES_shows.length).to eq(shows.length)
+    end
+  end
+
+  describe '#episodes' do
+    it 'should fetch more episodes' do
+      show = VCR.use_cassette('show:find:5CfCWKI5pZ28U0uOzXkDHe') do
+        RSpotify::Show.find('5CfCWKI5pZ28U0uOzXkDHe')
+      end
+
+      episodes = VCR.use_cassette('show:find:5CfCWKI5pZ28U0uOzXkDHe:episodes') do
+        show.episodes(offset: 20, limit: 20)
+      end
+
+      expect(episodes)            .to be_an Array
+      expect(episodes.size)       .to eq 20
+      expect(episodes.first.name) .to eq 'Being an A$$hole: The Final Frontier for Women on the Screen'
+      expect(episodes.first.id)   .to eq '0DD6d3lmUjkIHzC13Z6fbs'
+    end
+
+    it "should find episodes available in the given market" do
+      show = VCR.use_cassette('show:find:5CfCWKI5pZ28U0uOzXkDHe') do
+        RSpotify::Show.find('5CfCWKI5pZ28U0uOzXkDHe')
+      end
+
+      episodes = VCR.use_cassette('show:find:5CfCWKI5pZ28U0uOzXkDHe:episodes:market:ES') do
+        show.episodes(offset: 20, limit: 20, market: 'ES')
+      end
+
+      expect(episodes.first.name) .to eq 'Being an A$$hole: The Final Frontier for Women on the Screen'
+      expect(episodes.first.id)   .to eq '0DD6d3lmUjkIHzC13Z6fbs'
+    end
+  end
+end