7digital 0.0.5 → 0.0.6

data/lib/sevendigital/digestion_tract/user_card_digestor.rb

@@ -0,0 +1,24 @@
+module Sevendigital
+
+  #@private
+  class UserCardDigestor < Digestor # :nodoc:
+
+    def default_element_name; :card end
+    def default_list_element_name; :cards end
+    
+    def from_proxy(card_proxy)
+      make_sure_not_eating_nil(card_proxy)
+
+      card = Sevendigital::Card.new(@api_client)
+      card.id = card_proxy.id.to_i
+      card.type = card_proxy.type.value.to_s
+      card.last_4_digits = card_proxy.last4digits.value.to_s
+      card.card_holder_name = card_proxy.card_holder_name.value.to_s if value_present?(card_proxy.card_holder_name)
+      card.expiry_date = card_proxy.expiry_date.value.to_s if value_present?(card_proxy.expiry_date)
+
+      return card
+    end
+
+  end
+
+end

data/lib/sevendigital/digestion_tract/user_digestor.rb

@@ -0,0 +1,21 @@
+module Sevendigital
+
+  #@private
+  class UserDigestor < Digestor # :nodoc:
+
+    def default_element_name; :user end
+    
+    def from_proxy(user_proxy)
+      make_sure_not_eating_nil(user_proxy)
+
+      user = User.new(@api_client)
+      user.id = user_proxy.id.to_s  if !user_proxy.nil?
+      user.type = user_proxy.type.value.to_sym
+      user.email_address = user_proxy.email_address.value.to_s if value_present?(user_proxy.email_address)
+
+      return user
+    end
+
+  end
+
+end

data/lib/sevendigital/management/artist_manager.rb

@@ -1,82 +1,99 @@
-require "peachy"
-
-module Sevendigital
-
-  # provides access to Artist related API methods (artist/*)
-  class ArtistManager < Manager
-
-    # calls *artist/details* API method and returns Artist with populated details
-    #
-    # <tt>artist_id</tt>:: artist ID
-    # <tt>options</tt>:: optional hash of additional API parameters, e.g. {page_size => 50}, etc
-    def get_details(artist_id, options={})
-      api_response = @api_client.make_api_request("artist/details", {:artistId => artist_id}, options)
-      @api_client.artist_digestor.from_xml(api_response.content.artist)
-    end
-
-    # calls *artist/releases* API method and returns Release array
-    #
-    # <tt>artist_id</tt>:: artist ID
-    # <tt>options</tt>:: optional hash of additional API parameters, e.g. {page_size => 50}, etc
-    def get_releases(artist_id, options={})
-      api_response = @api_client.make_api_request("artist/releases", {:artistId => artist_id}, options)
-      @api_client.release_digestor.list_from_xml(api_response.content.releases)
-    end
-      
-    # calls *artist/toptracks* API method and returns Track array
-    #
-    # <tt>artist_id</tt>:: artist ID
-    # <tt>options</tt>:: optional hash of additional API parameters, e.g. {page_size => 50}, etc
-      def get_top_tracks(artist_id, options={})
-      api_response = @api_client.make_api_request("artist/topTracks", {:artistId => artist_id}, options)
-      @api_client.track_digestor.list_from_xml(api_response.content.tracks)
-    end
-
-    # calls *artist/similar* API method and returns Artist array
-    #
-    # <tt>artist_id</tt>:: artist ID
-    # <tt>options</tt>:: optional hash of additional API parameters, e.g. {page_size => 50}, etc
-    def get_similar(artist_id, options={})
-      api_response = @api_client.make_api_request("artist/similar", {:artistId => artist_id}, options)
-      @api_client.artist_digestor.list_from_xml(api_response.content.artists)
-    end
-
-    # calls *artist/byTag/top* API method and returns Artist array
-    #
-    # <tt>tags</tt>:: string containing comma separated list of tags
-    # <tt>options</tt>:: optional hash of additional API parameters, e.g. {page_size => 50}, etc
-    def get_top_by_tag(tags, options={})
-      api_response = @api_client.make_api_request("artist/byTag/top", {:tags => tags}, options)
-      @api_client.artist_digestor.nested_list_from_xml(api_response.content.tagged_results, :tagged_item, :tagged_results)
-    end
-
-    # calls *artist/search* API method and returns Artist array
-    #
-    # <tt>query</tt>:: string containing the search query
-    # <tt>options</tt>:: optional hash of additional API parameters, e.g. {page_size => 50}, etc
-    def search(query, options={})
-     api_response = @api_client.make_api_request("artist/search", {:q => query}, options)
-     @api_client.artist_digestor.nested_list_from_xml(api_response.content.search_results, :search_result, :search_results)
-    end
-
-    # calls *artist/browse* API method and returns Artist array
-    #
-    # <tt>letter</tt>:: string containing the search query
-    # <tt>options</tt>:: optional hash of additional API parameters, e.g. {page_size => 50}, etc
-    def browse(letter, options={})
-     api_response = @api_client.make_api_request("artist/browse", {:letter => letter}, options)
-     @api_client.artist_digestor.list_from_xml(api_response.content.artists)
-    end
-
-    # calls *artist/chart* API method and returns Artist array
-    #
-    # <tt>options</tt>:: optional hash of additional API parameters, e.g. {page_size => 50}, etc
-    def get_chart(options={})
-     api_response = @api_client.make_api_request("artist/chart", {}, options)
-     @api_client.chart_item_digestor.list_from_xml(api_response.content.chart)
-    end
-
-
-  end
-
-end
+require "peachy"
+
+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(api_response.content.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(api_response.content.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(api_response.content.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(api_response.content.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(api_response.content.tagged_results, :tagged_item, :tagged_results)
+    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(api_response.content.search_results, :search_result, :search_results)
+    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(api_response.content.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(api_response.content.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(api_response.content.tags)
+    end
+
+
+  end
+
+end

data/lib/sevendigital/management/basket_manager.rb

@@ -1,29 +1,29 @@
-module Sevendigital
-
-  class BasketManager < Manager
-
-     def get(basket_id, options={})
-        api_response = @api_client.make_api_request("basket", {:basketId => basket_id}, options)
-        @api_client.basket_digestor.from_xml(api_response.content.basket)
-      end
-
-      def create(options={})
-        api_response = @api_client.make_api_request("basket/create", {}, options)
-        @api_client.basket_digestor.from_xml(api_response.content.basket)
-      end
-
-      def add_item(basket_id, release_id, track_id=nil, options={})
-        api_response = @api_client.make_api_request("basket/addItem", {:basketId => basket_id, :releaseId => release_id, :trackId => track_id}, options)
-        @api_client.basket_digestor.from_xml(api_response.content.basket)
-      end
-
-
-      def remove_item(basket_id, item_id, options={})
-        api_response = @api_client.make_api_request("basket/removeItem", {:basketId => basket_id, :itemId => item_id}, options)
-        @api_client.basket_digestor.from_xml(api_response.content.basket)
-      end
-
-
-  end
-
-end
+module Sevendigital
+
+  class BasketManager < Manager
+
+     def get(basket_id, options={})
+        api_response = @api_client.make_api_request(:GET, "basket", {:basketId => basket_id}, options)
+        @api_client.basket_digestor.from_xml(api_response.content.basket)
+      end
+
+      def create(options={})
+        api_response = @api_client.make_api_request(:GET, "basket/create", {}, options)
+        @api_client.basket_digestor.from_xml(api_response.content.basket)
+      end
+
+      def add_item(basket_id, release_id, track_id=nil, options={})
+        api_response = @api_client.make_api_request(:GET, "basket/addItem", {:basketId => basket_id, :releaseId => release_id, :trackId => track_id}, options)
+        @api_client.basket_digestor.from_xml(api_response.content.basket)
+      end
+
+
+      def remove_item(basket_id, item_id, options={})
+        api_response = @api_client.make_api_request(:GET, "basket/removeItem", {:basketId => basket_id, :itemId => item_id}, options)
+        @api_client.basket_digestor.from_xml(api_response.content.basket)
+      end
+
+
+  end
+
+end

data/lib/sevendigital/management/manager.rb

@@ -1,11 +1,12 @@
-module Sevendigital
-
-  class Manager # :nodoc:
-
-    def initialize(api_client)
-      @api_client =  api_client
-    end
-
-  end
-
-end
+module Sevendigital
+
+  #@private
+  class Manager # :nodoc:
+
+    def initialize(api_client)
+      @api_client =  api_client
+    end
+
+  end
+
+end

data/lib/sevendigital/management/oauth_manager.rb

@@ -1,23 +1,23 @@
-module Sevendigital
-
-  class OAuthManager < Manager
-
-    def get_request_token
-      api_response = @api_client.make_signed_api_request("oauth/requestToken", {})
-      @api_client.oauth_request_token_digestor.from_xml(api_response.content.oauth_request_token, :oauth_request_token)
-    end
-
-    def get_access_token(request_token)
-      api_response = @api_client.make_signed_api_request("oauth/accessToken", {}, {}, request_token)
-      @api_client.oauth_access_token_digestor.from_xml(api_response.content.oauth_access_token, :oauth_access_token)
-    end
-
-    def authorise_request_token(username, password, request_token)
-      api_response = @api_client.make_signed_api_request("oauth/requestToken/authorise", \
-        {:username => username, :password => password, :token => request_token.token})
-      api_response.ok?
-    end
-
-  end
-
-end
+module Sevendigital
+
+  class OAuthManager < Manager
+
+    def get_request_token
+      api_response = @api_client.make_signed_api_request(:GET, "oauth/requestToken", {})
+      @api_client.oauth_request_token_digestor.from_xml(api_response.content.oauth_request_token, :oauth_request_token)
+    end
+
+    def get_access_token(request_token)
+      api_response = @api_client.make_signed_api_request(:GET, "oauth/accessToken", {}, {}, request_token)
+      @api_client.oauth_access_token_digestor.from_xml(api_response.content.oauth_access_token, :oauth_access_token)
+    end
+
+    def authorise_request_token(username, password, request_token)
+      api_response = @api_client.make_signed_api_request(:GET, "oauth/requestToken/authorise", \
+        {:username => username, :password => password, :token => request_token.token})
+      api_response.ok?
+    end
+
+  end
+
+end

data/lib/sevendigital/management/release_manager.rb

@@ -1,51 +1,57 @@
-require "peachy"
-
-module Sevendigital
-
-  class ReleaseManager < Manager
-
-    def get_details(release_id, options = {})
-      api_response = @api_client.make_api_request("release/details", {:releaseId => release_id}, options)
-      @api_client.release_digestor.from_xml(api_response.content.release)
-    end
-
-    def get_tracks(release_id, options = {})
-      options[:page_size] ||= 100
-      api_response = @api_client.make_api_request("release/tracks", {:releaseId => release_id}, options)
-      @api_client.track_digestor.list_from_xml(api_response.content.tracks)
-    end
-
-    def get_chart(options={})
-      api_response = @api_client.make_api_request("release/chart", {}, options)
-      @api_client.chart_item_digestor.list_from_xml(api_response.content.chart)
-    end
-
-    def get_by_date(from_date = nil, to_date = nil, options = {})
-      parameters = Hash.new
-      parameters[:fromDate] = from_date.strftime("%Y%m%d") if from_date
-      parameters[:toDate] = to_date.strftime("%Y%m%d") if to_date
-
-      api_response = @api_client.make_api_request("release/byDate", parameters, options)
-      @api_client.release_digestor.list_from_xml(api_response.content.releases)
-    end
-
-    def get_recommendations(release_id, options = {})
-      api_response = @api_client.make_api_request("release/recommend", {:releaseId => release_id}, options)
-      @api_client.release_digestor.nested_list_from_xml(api_response.content.recommendations, :recommended_item, :recommendations)
-    end
-
-
-    def get_top_by_tag(tags, options = {})
-      api_response = @api_client.make_api_request("release/byTag/top", {:tags => tags}, options)
-      @api_client.release_digestor.nested_list_from_xml( \
-      api_response.content.tagged_results, :tagged_item, :tagged_results )
-    end
-
-    def search(query, options={})
-      api_response = @api_client.make_api_request("release/search", {:q => query}, options)
-      @api_client.release_digestor.nested_list_from_xml(api_response.content.search_results, :search_result, :search_results)
-    end
-
-  end
-
+require "peachy"
+
+module Sevendigital
+
+  class ReleaseManager < Manager
+
+    def get_details(release_id, options = {})
+      api_response = @api_client.make_api_request(:GET, "release/details", {:releaseId => release_id}, options)
+      @api_client.release_digestor.from_xml(api_response.content.release)
+    end
+
+    def get_tracks(release_id, options = {})
+      options[:page_size] ||= 100
+      api_response = @api_client.make_api_request(:GET, "release/tracks", {:releaseId => release_id}, options)
+      @api_client.track_digestor.list_from_xml(api_response.content.tracks)
+    end
+
+    def get_chart(options={})
+      api_response = @api_client.make_api_request(:GET, "release/chart", {}, options)
+      @api_client.chart_item_digestor.list_from_xml(api_response.content.chart)
+    end
+
+    def get_by_date(from_date = nil, to_date = nil, options = {})
+      parameters = Hash.new
+      parameters[:fromDate] = from_date.strftime("%Y%m%d") if from_date
+      parameters[:toDate] = to_date.strftime("%Y%m%d") if to_date
+
+      api_response = @api_client.make_api_request(:GET, "release/byDate", parameters, options)
+      @api_client.release_digestor.list_from_xml(api_response.content.releases)
+    end
+
+    def get_recommendations(release_id, options = {})
+      api_response = @api_client.make_api_request(:GET, "release/recommend", {:releaseId => release_id}, options)
+      @api_client.release_digestor.nested_list_from_xml(api_response.content.recommendations, :recommended_item, :recommendations)
+    end
+
+
+    def get_top_by_tag(tags, options = {})
+      api_response = @api_client.make_api_request(:GET, "release/byTag/top", {:tags => tags}, options)
+      @api_client.release_digestor.nested_list_from_xml( \
+      api_response.content.tagged_results, :tagged_item, :tagged_results )
+    end
+
+    def search(query, options={})
+      api_response = @api_client.make_api_request(:GET, "release/search", {:q => query}, options)
+      @api_client.release_digestor.nested_list_from_xml(api_response.content.search_results, :search_result, :search_results)
+    end
+
+
+    def get_tags(release_id, options = {})
+      api_response = @api_client.make_api_request(:GET, "release/tags", {:releaseId => release_id}, options)
+      @api_client.tag_digestor.list_from_xml(api_response.content.tags)
+    end
+
+  end
+
 end