7digital 0.1.2 → 0.1.5

data/lib/sevendigital/digestion_tract/pager_digestor.rb

@@ -1,28 +1,28 @@
-module Sevendigital
-
-  #@private
-  class PagerDigestor < Digestor # :nodoc:
-
-    def default_element_name; :results end
-    def default_list_element_name; nil end
-
-    def from_xml_doc(xml_node)
-      make_sure_eating_nokogiri_node(xml_node)
-
-      return nil unless paging_info_available?(xml_node)
-
-      pager = Pager.new
-
-      pager.page = get_required_value(xml_node,"page").to_i
-      pager.page_size = get_required_value(xml_node,"pageSize").to_i
-      pager.total_items = get_required_value(xml_node,"totalItems").to_i
-
-      pager
-    end
-
-    def paging_info_available?(xml_doc)
-      xml_doc.at_xpath("./page") && xml_doc.at_xpath("./pageSize") && xml_doc.at_xpath("./totalItems")
-    end
-
-  end
-end
+module Sevendigital
+
+  #@private
+  class PagerDigestor < Digestor # :nodoc:
+
+    def default_element_name; :results end
+    def default_list_element_name; nil end
+
+    def from_xml_doc(xml_node)
+      make_sure_eating_nokogiri_node(xml_node)
+
+      return nil unless paging_info_available?(xml_node)
+
+      pager = Pager.new
+
+      pager.page = get_required_value(xml_node,"page").to_i
+      pager.page_size = get_required_value(xml_node,"pageSize").to_i
+      pager.total_items = get_required_value(xml_node,"totalItems").to_i
+
+      pager
+    end
+
+    def paging_info_available?(xml_doc)
+      xml_doc.at_xpath("./page") && xml_doc.at_xpath("./pageSize") && xml_doc.at_xpath("./totalItems")
+    end
+
+  end
+end

data/lib/sevendigital/digestion_tract/price_digestor.rb

@@ -1,29 +1,29 @@
-require 'rational'
-module Sevendigital
-
-  #@private
-  class PriceDigestor < Digestor # :nodoc:
-
-    def default_element_name; :price end
-    def default_list_element_name; nil end
-  
-    def from_xml_doc(xml_node)
-      make_sure_eating_nokogiri_node(xml_node)
-      price = Sevendigital::Price.new()
-      get_required_node(xml_node, "currency") do |c|
-        price.currency_code = get_required_attribute(c, "code") {|v| v.upcase.to_sym}
-      end
-      price.currency_symbol = get_required_value(xml_node, "currency")
-      price.value = get_required_value(xml_node,"value") {|v| v.to_d unless v.empty?}
-      price.formatted_price = get_required_value(xml_node,"formattedPrice")
-      price.rrp = get_optional_value(xml_node,"rrp") {|v| v.to_d unless v.empty?}
-      price.formatted_rrp = get_optional_value(xml_node,"formattedRrp")
-      price.on_sale = get_optional_value(xml_node,"onSale") {|v| v.downcase == "true"}
-
-      price
-    end
-
-
-    end
-
+require 'rational'
+module Sevendigital
+
+  #@private
+  class PriceDigestor < Digestor # :nodoc:
+
+    def default_element_name; :price end
+    def default_list_element_name; nil end
+  
+    def from_xml_doc(xml_node)
+      make_sure_eating_nokogiri_node(xml_node)
+      price = Sevendigital::Price.new()
+      get_required_node(xml_node, "currency") do |c|
+        price.currency_code = get_required_attribute(c, "code") {|v| v.upcase.to_sym}
+      end
+      price.currency_symbol = get_required_value(xml_node, "currency")
+      price.value = get_required_value(xml_node,"value") {|v| v.to_d unless v.empty?}
+      price.formatted_price = get_required_value(xml_node,"formattedPrice")
+      price.rrp = get_optional_value(xml_node,"rrp") {|v| v.to_d unless v.empty?}
+      price.formatted_rrp = get_optional_value(xml_node,"formattedRrp")
+      price.on_sale = get_optional_value(xml_node,"onSale") {|v| v.downcase == "true"}
+
+      price
+    end
+
+
+    end
+
 end

data/lib/sevendigital/digestion_tract/release_digestor.rb

@@ -1,45 +1,45 @@
-module Sevendigital
-
-  require 'date'
-
-  #@private
-  class ReleaseDigestor < Digestor # :nodoc:
-    
-    def default_element_name; :release end
-    def default_list_element_name; :releases end
-
-    def from_xml_doc(xml_node)
-      make_sure_eating_nokogiri_node(xml_node)
-
-      release = Release.new(@api_client)
-
-      populate_required_properties(release, xml_node)
-      populate_optional_properties(release, xml_node)
-
-      release
-    end
-
-    def populate_required_properties(release, xml_node)
-      release.id = get_required_attribute(xml_node, "id").to_i
-      release.title = get_required_value(xml_node, "title")
-      release.artist = get_required_node(xml_node, "artist") {|v| @api_client.artist_digestor.from_xml_doc(v) }
-    end
-
-    def populate_optional_properties(release, xml_node)
-      release.version = get_optional_value(xml_node, "version")
-      release.type = get_optional_value(xml_node, "type") {|v| v.to_s.downcase.to_sym}
-      release.barcode = get_optional_value(xml_node, "barcode")
-      release.year = get_optional_value(xml_node, "year") {|v| v.to_i}
-      release.explicit_content = get_optional_value(xml_node, "explicitContent") {|v| v.to_s.downcase == "true"}
-      release.release_date = get_optional_value(xml_node, "releaseDate") {|v| DateTime.parse(v)}
-      release.added_date = get_optional_value(xml_node, "addedDate") {|v| DateTime.parse(v)}
-      release.label = get_optional_node(xml_node, "label") {|v| @api_client.label_digestor.from_xml_doc(v)}
-      release.image = get_optional_value(xml_node, "image")
-      release.url = get_optional_value(xml_node, "url")
-      release.price = get_optional_node(xml_node, "price") {|v| @api_client.price_digestor.from_xml_doc(v)}
-      release.formats = get_optional_node(xml_node, "formats") {|v| @api_client.format_digestor.list_from_xml_doc(v)}
-    end
-
-  end
-
-end
+module Sevendigital
+
+  require 'date'
+
+  #@private
+  class ReleaseDigestor < Digestor # :nodoc:
+    
+    def default_element_name; :release end
+    def default_list_element_name; :releases end
+
+    def from_xml_doc(xml_node)
+      make_sure_eating_nokogiri_node(xml_node)
+
+      release = Release.new(@api_client)
+
+      populate_required_properties(release, xml_node)
+      populate_optional_properties(release, xml_node)
+
+      release
+    end
+
+    def populate_required_properties(release, xml_node)
+      release.id = get_required_attribute(xml_node, "id").to_i
+      release.title = get_required_value(xml_node, "title")
+      release.artist = get_required_node(xml_node, "artist") {|v| @api_client.artist_digestor.from_xml_doc(v) }
+    end
+
+    def populate_optional_properties(release, xml_node)
+      release.version = get_optional_value(xml_node, "version")
+      release.type = get_optional_value(xml_node, "type") {|v| v.to_s.downcase.to_sym}
+      release.barcode = get_optional_value(xml_node, "barcode")
+      release.year = get_optional_value(xml_node, "year") {|v| v.to_i}
+      release.explicit_content = get_optional_value(xml_node, "explicitContent") {|v| v.to_s.downcase == "true"}
+      release.release_date = get_optional_value(xml_node, "releaseDate") {|v| DateTime.parse(v)}
+      release.added_date = get_optional_value(xml_node, "addedDate") {|v| DateTime.parse(v)}
+      release.label = get_optional_node(xml_node, "label") {|v| @api_client.label_digestor.from_xml_doc(v)}
+      release.image = get_optional_value(xml_node, "image")
+      release.url = get_optional_value(xml_node, "url")
+      release.price = get_optional_node(xml_node, "price") {|v| @api_client.price_digestor.from_xml_doc(v)}
+      release.formats = get_optional_node(xml_node, "formats") {|v| @api_client.format_digestor.list_from_xml_doc(v)}
+    end
+
+  end
+
+end

data/lib/sevendigital/digestion_tract/tag_digestor.rb

@@ -1,24 +1,24 @@
-module Sevendigital
-
-  #@private
-  class TagDigestor < Digestor # :nodoc:
-
-    def default_element_name; :tag end
-    def default_list_element_name; :tags end
-    
-    def from_xml_doc(xml_node)
-      make_sure_eating_nokogiri_node(xml_node)
-
-      tag = Tag.new()
-
-      tag.id = get_required_attribute(xml_node, "id")
-      tag.text = get_required_value(xml_node, "text")
-      tag.url = get_optional_value(xml_node, "url")
-      tag.count = get_optional_value(xml_node, "count") {|v| v.to_i}
-
-      tag
-    end
-
-  end
-
+module Sevendigital
+
+  #@private
+  class TagDigestor < Digestor # :nodoc:
+
+    def default_element_name; :tag end
+    def default_list_element_name; :tags end
+    
+    def from_xml_doc(xml_node)
+      make_sure_eating_nokogiri_node(xml_node)
+
+      tag = Tag.new()
+
+      tag.id = get_required_attribute(xml_node, "id")
+      tag.text = get_required_value(xml_node, "text")
+      tag.url = get_optional_value(xml_node, "url")
+      tag.count = get_optional_value(xml_node, "count") {|v| v.to_i}
+
+      tag
+    end
+
+  end
+
 end

data/lib/sevendigital/digestion_tract/track_digestor.rb

@@ -1,37 +1,38 @@
-module Sevendigital
-
-  #@private
-  class TrackDigestor < Digestor # :nodoc:
-
-    def default_element_name; :track end
-    def default_list_element_name; :tracks end
-
-    def from_xml_doc(xml_node)
-         make_sure_eating_nokogiri_node(xml_node)
-
-         track = Track.new(@api_client)
-
-         populate_required_properties(track, xml_node)
-         populate_optional_properties(track, xml_node)
-
-         track
-       end
-
-       def populate_required_properties(track, xml_node)
-         track.id = get_required_attribute(xml_node, "id").to_i
-         track.title = get_required_value(xml_node, "title")
-         track.artist = get_required_node(xml_node, "artist") {|v| @api_client.artist_digestor.from_xml_doc(v) }
-       end
-
-       def populate_optional_properties(track, xml_node)
-         track.version = get_optional_value(xml_node, "version")
-         track.track_number = get_optional_value(xml_node, "trackNumber") {|v| v.to_i}
-         track.duration = get_optional_value(xml_node, "duration") {|v| v.to_i}
-         track.release = get_optional_node(xml_node, "release") {|v |@api_client.release_digestor.from_xml_doc(v)}
-         track.explicit_content = get_optional_value(xml_node, "explicitContent") {|v| v.downcase == "true"}
-         track.isrc = get_optional_value(xml_node, "isrc")
-         track.url = get_optional_value(xml_node, "url")
-         track.price =  get_optional_node(xml_node, "price") {|v| @api_client.price_digestor.from_xml_doc(v)}
-       end
-  end
-end
+module Sevendigital
+
+  #@private
+  class TrackDigestor < Digestor # :nodoc:
+
+    def default_element_name; :track end
+    def default_list_element_name; :tracks end
+
+    def from_xml_doc(xml_node)
+         make_sure_eating_nokogiri_node(xml_node)
+
+         track = Track.new(@api_client)
+
+         populate_required_properties(track, xml_node)
+         populate_optional_properties(track, xml_node)
+
+         track
+       end
+
+       def populate_required_properties(track, xml_node)
+         track.id = get_required_attribute(xml_node, "id").to_i
+         track.title = get_required_value(xml_node, "title")
+         track.artist = get_required_node(xml_node, "artist") {|v| @api_client.artist_digestor.from_xml_doc(v) }
+       end
+
+       def populate_optional_properties(track, xml_node)
+         track.version = get_optional_value(xml_node, "version")
+         track.track_number = get_optional_value(xml_node, "trackNumber") {|v| v.to_i}
+         track.duration = get_optional_value(xml_node, "duration") {|v| v.to_i}
+         track.release = get_optional_node(xml_node, "release") {|v |@api_client.release_digestor.from_xml_doc(v)}
+         track.explicit_content = get_optional_value(xml_node, "explicitContent") {|v| v.downcase == "true"}
+         track.isrc = get_optional_value(xml_node, "isrc")
+         track.url = get_optional_value(xml_node, "url")
+         track.price =  get_optional_node(xml_node, "price") {|v| @api_client.price_digestor.from_xml_doc(v)}
+         track.type = get_optional_value(xml_node, "type") {|v| v.to_s.downcase.to_sym}
+       end
+  end
+end

data/lib/sevendigital/digestion_tract/user_card_digestor.rb

@@ -1,25 +1,25 @@
-module Sevendigital
-
-  #@private
-  class UserCardDigestor < Digestor # :nodoc:
-
-    def default_element_name; :card end
-    def default_list_element_name; :cards end
-    
-    def from_xml_doc(xml_node)
-      make_sure_eating_nokogiri_node(xml_node)
-
-      card = Sevendigital::Card.new(@api_client)
-
-      card.id = get_optional_attribute(xml_node,"id").to_i
-      card.type = get_required_value(xml_node, "type")
-      card.last_4_digits = get_required_value(xml_node, "last4digits")
-      card.card_holder_name = get_optional_value(xml_node, "cardHolderName")
-      card.expiry_date = get_optional_value(xml_node, "expiryDate")
-
-      card
-    end
-
-  end
-
+module Sevendigital
+
+  #@private
+  class UserCardDigestor < Digestor # :nodoc:
+
+    def default_element_name; :card end
+    def default_list_element_name; :cards end
+    
+    def from_xml_doc(xml_node)
+      make_sure_eating_nokogiri_node(xml_node)
+
+      card = Sevendigital::Card.new(@api_client)
+
+      card.id = get_optional_attribute(xml_node,"id").to_i
+      card.type = get_required_value(xml_node, "type")
+      card.last_4_digits = get_required_value(xml_node, "last4digits")
+      card.card_holder_name = get_optional_value(xml_node, "cardHolderName")
+      card.expiry_date = get_optional_value(xml_node, "expiryDate")
+
+      card
+    end
+
+  end
+
 end

data/lib/sevendigital/digestion_tract/user_digestor.rb

@@ -1,22 +1,22 @@
-module Sevendigital
-
-  #@private
-  class UserDigestor < Digestor # :nodoc:
-
-    def default_element_name; :user end
-
-    def from_xml_doc(xml_node)
-      make_sure_eating_nokogiri_node(xml_node)
-
-      user = User.new(@api_client)
-
-      user.id = get_optional_attribute(xml_node, "id")
-      user.type = get_optional_value(xml_node, "type") {|v| v.to_sym}
-      user.email_address = get_optional_value(xml_node, "emailAddress")
-
-      user
-    end
-
-  end
-
+module Sevendigital
+
+  #@private
+  class UserDigestor < Digestor # :nodoc:
+
+    def default_element_name; :user end
+
+    def from_xml_doc(xml_node)
+      make_sure_eating_nokogiri_node(xml_node)
+
+      user = User.new(@api_client)
+
+      user.id = get_optional_attribute(xml_node, "id")
+      user.type = get_optional_value(xml_node, "type") {|v| v.to_sym}
+      user.email_address = get_optional_value(xml_node, "emailAddress")
+
+      user
+    end
+
+  end
+
 end

data/lib/sevendigital/management/artist_manager.rb

@@ -1,97 +1,97 @@
-module Sevendigital
-
-  # provides access to Artist related API methods (artist/*)
-  class ArtistManager < Manager
-
-    # calls *artist/details* API method and returns Artist with populated details
-    #
-    # @param [Integer] artist_id
-    # @param [Hash] options optional hash of additional API parameters, e.g. page_size => 50, etc
-    # @return [Artist]
-    def get_details(artist_id, options={})
-      api_response = @api_client.make_api_request(:GET, "artist/details", {:artistId => artist_id}, options)
-      @api_client.artist_digestor.from_xml_doc(api_response.item_xml("artist"))
-    end
-
-    # calls *artist/releases* API method and returns Release array
-    #
-    # @param [Integer] artist_id
-    # @param [Hash] options optional hash of additional API parameters, e.g. page_size => 50, etc
-    # @return [[Artist]]
-    def get_releases(artist_id, options={})
-      api_response = @api_client.make_api_request(:GET, "artist/releases", {:artistId => artist_id}, options)
-      @api_client.release_digestor.list_from_xml_doc(api_response.item_xml("releases"))
-    end
-      
-    # calls *artist/toptracks* API method and returns Track array
-    #
-    # @param [Integer] artist_id
-    # @param [Hash] options optional hash of additional API parameters, e.g. page_size => 50, etc
-    # @return [Array<Track>]
-      def get_top_tracks(artist_id, options={})
-      api_response = @api_client.make_api_request(:GET, "artist/topTracks", {:artistId => artist_id}, options)
-      @api_client.track_digestor.list_from_xml_doc(api_response.item_xml("tracks"))
-    end
-
-    # calls *artist/similar* API method and returns Artist array
-    #
-    # @param [Integer] artist_id
-    # @param [Hash] options optional hash of additional API parameters, e.g. page_size => 50, etc
-    # @return [Array<Artist>]
-    def get_similar(artist_id, options={})
-      api_response = @api_client.make_api_request(:GET, "artist/similar", {:artistId => artist_id}, options)
-      @api_client.artist_digestor.list_from_xml_doc(api_response.item_xml("artists"))
-    end
-
-    # calls *artist/byTag/top* API method and returns Artist array
-    #
-    # @param [String] tags tag or comma separated list of tags
-    # @param [Hash] options optional hash of additional API parameters, e.g. page_size => 50, etc
-    # @return [Array<Artist>]
-    def get_top_by_tag(tags, options={})
-      api_response = @api_client.make_api_request(:GET, "artist/byTag/top", {:tags => tags}, options)
-      @api_client.artist_digestor.nested_list_from_xml_doc(api_response.item_xml("taggedResults"), :taggedItem, :artist)
-    end
-
-    # calls *artist/search* API method and returns Artist array
-    #
-    # @param [String] query search query
-    # @param [Hash] options optional hash of additional API parameters, e.g. page_size => 50, etc
-    # @return [Array<Artist>]
-    def search(query, options={})
-     api_response = @api_client.make_api_request(:GET, "artist/search", {:q => query}, options)
-     @api_client.artist_digestor.nested_list_from_xml_doc(api_response.item_xml("searchResults"), :searchResult, :artist)
-    end
-
-    # calls *artist/browse* API method and returns Artist array
-    #
-    # @param [String] letter the letter(s) returned artist names should artists
-    # @param [Hash] options optional hash of additional API parameters, e.g. page_size => 50, etc
-    # @return [Array<Artist>]
-    def browse(letter, options={})
-     api_response = @api_client.make_api_request(:GET, "artist/browse", {:letter => letter}, options)
-     @api_client.artist_digestor.list_from_xml_doc(api_response.item_xml("artists"))
-    end
-
-    # calls *artist/chart* API method and returns Artist array
-    #
-    # @param [Hash] options optional hash of additional API parameters, e.g. page_size => 50, etc
-    def get_chart(options={})
-     api_response = @api_client.make_api_request(:GET, "artist/chart", {}, options)
-     @api_client.chart_item_digestor.list_from_xml_doc(api_response.item_xml("chart"))
-    end
-
-    # calls *artist/tags* API method and returns Tag array
-    #
-    # @param [Integer] artist_id
-    # @param [Hash] options optional hash of additional API parameters, e.g. page_size => 50, etc
-    # @return [Array<Tag>]
-    def get_tags(artist_id, options={})
-      api_response = @api_client.make_api_request(:GET, "artist/tags", {:artistId => artist_id}, options)
-      @api_client.tag_digestor.list_from_xml_doc(api_response.item_xml("tags"))
-    end
-
-
-  end
-
-end
+module Sevendigital
+
+  # provides access to Artist related API methods (artist/*)
+  class ArtistManager < Manager
+
+    # calls *artist/details* API method and returns Artist with populated details
+    #
+    # @param [Integer] artist_id
+    # @param [Hash] options optional hash of additional API parameters, e.g. page_size => 50, etc
+    # @return [Artist]
+    def get_details(artist_id, options={})
+      api_response = @api_client.make_api_request(:GET, "artist/details", {:artistId => artist_id}, options)
+      @api_client.artist_digestor.from_xml_doc(api_response.item_xml("artist"))
+    end
+
+    # calls *artist/releases* API method and returns Release array
+    #
+    # @param [Integer] artist_id
+    # @param [Hash] options optional hash of additional API parameters, e.g. page_size => 50, etc
+    # @return [[Artist]]
+    def get_releases(artist_id, options={})
+      api_response = @api_client.make_api_request(:GET, "artist/releases", {:artistId => artist_id}, options)
+      @api_client.release_digestor.list_from_xml_doc(api_response.item_xml("releases"))
+    end
+      
+    # calls *artist/toptracks* API method and returns Track array
+    #
+    # @param [Integer] artist_id
+    # @param [Hash] options optional hash of additional API parameters, e.g. page_size => 50, etc
+    # @return [Array<Track>]
+      def get_top_tracks(artist_id, options={})
+      api_response = @api_client.make_api_request(:GET, "artist/topTracks", {:artistId => artist_id}, options)
+      @api_client.track_digestor.list_from_xml_doc(api_response.item_xml("tracks"))
+    end
+
+    # calls *artist/similar* API method and returns Artist array
+    #
+    # @param [Integer] artist_id
+    # @param [Hash] options optional hash of additional API parameters, e.g. page_size => 50, etc
+    # @return [Array<Artist>]
+    def get_similar(artist_id, options={})
+      api_response = @api_client.make_api_request(:GET, "artist/similar", {:artistId => artist_id}, options)
+      @api_client.artist_digestor.list_from_xml_doc(api_response.item_xml("artists"))
+    end
+
+    # calls *artist/byTag/top* API method and returns Artist array
+    #
+    # @param [String] tags tag or comma separated list of tags
+    # @param [Hash] options optional hash of additional API parameters, e.g. page_size => 50, etc
+    # @return [Array<Artist>]
+    def get_top_by_tag(tags, options={})
+      api_response = @api_client.make_api_request(:GET, "artist/byTag/top", {:tags => tags}, options)
+      @api_client.artist_digestor.nested_list_from_xml_doc(api_response.item_xml("taggedResults"), :taggedItem, :artist)
+    end
+
+    # calls *artist/search* API method and returns Artist array
+    #
+    # @param [String] query search query
+    # @param [Hash] options optional hash of additional API parameters, e.g. page_size => 50, etc
+    # @return [Array<Artist>]
+    def search(query, options={})
+     api_response = @api_client.make_api_request(:GET, "artist/search", {:q => query}, options)
+     @api_client.artist_digestor.nested_list_from_xml_doc(api_response.item_xml("searchResults"), :searchResult, :artist)
+    end
+
+    # calls *artist/browse* API method and returns Artist array
+    #
+    # @param [String] letter the letter(s) returned artist names should artists
+    # @param [Hash] options optional hash of additional API parameters, e.g. page_size => 50, etc
+    # @return [Array<Artist>]
+    def browse(letter, options={})
+     api_response = @api_client.make_api_request(:GET, "artist/browse", {:letter => letter}, options)
+     @api_client.artist_digestor.list_from_xml_doc(api_response.item_xml("artists"))
+    end
+
+    # calls *artist/chart* API method and returns Artist array
+    #
+    # @param [Hash] options optional hash of additional API parameters, e.g. page_size => 50, etc
+    def get_chart(options={})
+     api_response = @api_client.make_api_request(:GET, "artist/chart", {}, options)
+     @api_client.chart_item_digestor.list_from_xml_doc(api_response.item_xml("chart"))
+    end
+
+    # calls *artist/tags* API method and returns Tag array
+    #
+    # @param [Integer] artist_id
+    # @param [Hash] options optional hash of additional API parameters, e.g. page_size => 50, etc
+    # @return [Array<Tag>]
+    def get_tags(artist_id, options={})
+      api_response = @api_client.make_api_request(:GET, "artist/tags", {:artistId => artist_id}, options)
+      @api_client.tag_digestor.list_from_xml_doc(api_response.item_xml("tags"))
+    end
+
+
+  end
+
+end