7digital 0.0.5 → 0.0.6

data/lib/sevendigital/management/tag_manager.rb

@@ -1,11 +1,11 @@
-module Sevendigital
-
-  class TagManager < Manager
-
-    def get_tag_list(options={})
-      api_response = @api_client.make_api_request("tag", {}, options)
-      @api_client.tag_digestor.list_from_xml(api_response.content.tags)
-    end
-
-  end
+module Sevendigital
+
+  class TagManager < Manager
+
+    def get_tag_list(options={})
+      api_response = @api_client.make_api_request(:GET, "tag", {}, options)
+      @api_client.tag_digestor.list_from_xml(api_response.content.tags)
+    end
+
+  end
 end

data/lib/sevendigital/management/track_manager.rb

@@ -1,29 +1,29 @@
-module Sevendigital
-
-  class TrackManager < Manager
-
-    def get_details(id, options={})
-      api_response = @api_client.make_api_request("track/details", {:trackId => id}, options)
-      @api_client.track_digestor.from_xml(api_response.content.track)
-    end
-
-    def get_details_from_release(track_id, release_id, options={})
-      @api_client.release.get_tracks(release_id, options).find {|track| track.id = track_id}
-    end
-
-    def get_chart(options={})
-      api_response = @api_client.make_api_request("track/chart", {}, options)
-      @api_client.chart_item_digestor.list_from_xml(api_response.content.chart)
-    end
-
-    def build_preview_url(id, options={})
-      api_request = @api_client.create_api_request("track/preview", {:trackId => id}, options)
-      @api_client.operator.create_request_uri(api_request)
-    end
-
-    def search(query, options={})
-      api_response = @api_client.make_api_request("track/search", {:q => query}, options)
-      @api_client.track_digestor.nested_list_from_xml(api_response.content.search_results, :search_result, :search_results)
-    end
-  end
+module Sevendigital
+
+  class TrackManager < Manager
+
+    def get_details(id, options={})
+      api_response = @api_client.make_api_request(:GET, "track/details", {:trackId => id}, options)
+      @api_client.track_digestor.from_xml(api_response.content.track)
+    end
+
+    def get_details_from_release(track_id, release_id, options={})
+      @api_client.release.get_tracks(release_id, options).find {|track| track.id == track_id}
+    end
+
+    def get_chart(options={})
+      api_response = @api_client.make_api_request(:GET, "track/chart", {}, options)
+      @api_client.chart_item_digestor.list_from_xml(api_response.content.chart)
+    end
+
+    def build_preview_url(id, options={})
+      api_request = @api_client.create_api_request(:GET, "track/preview", {:trackId => id}, options)
+      @api_client.operator.get_request_uri(api_request)
+    end
+
+    def search(query, options={})
+      api_response = @api_client.make_api_request(:GET, "track/search", {:q => query}, options)
+      @api_client.track_digestor.nested_list_from_xml(api_response.content.search_results, :search_result, :search_results)
+    end
+  end
 end

data/lib/sevendigital/management/user_card_manager.rb

@@ -0,0 +1,27 @@
+module Sevendigital
+
+  class UserCardManager < Manager
+
+    def get_card_list(token, options={})
+      api_response = @api_client.make_signed_api_request(:GET, "user/payment/card", {}, options, token)
+      @api_client.user_card_digestor.list_from_xml(api_response.content.cards)
+    end
+
+    def add_card(card_number, card_type, card_holder_name, card_start_date, card_expiry_date, card_issue_number,
+            card_verification_code, card_post_code, card_country, token, options={})
+      api_response = @api_client.make_signed_api_request(:POST, "user/payment/card/add", {
+          :cardNumber => card_number, :cardType => card_type, :cardHolderName => card_holder_name,
+          :cardStartDate => card_start_date, :cardExpiryDate => card_expiry_date, :cardIssueNumber => card_issue_number,
+          :cardVerificationCode => card_verification_code, :cardPostCode => card_post_code, :cardCountry => card_country
+        }, options, token)
+      @api_client.user_card_digestor.from_xml(api_response.content.card)
+    end
+
+    def select_card(card_id, token, options={})
+      api_response = @api_client.make_signed_api_request(
+              :POST, "user/payment/card/select", {:cardId => card_id}, options, token)
+      api_response.ok?
+    end
+
+  end
+end

data/lib/sevendigital/management/user_manager.rb

@@ -1,51 +1,71 @@
-module Sevendigital
-
-  class UserManager < Manager
-
-    def login(access_token)
-      raise Sevendigital::SevendigitalError if !access_token.kind_of? OAuth::AccessToken
-      user = Sevendigital::User.new(@api_client)
-      user.oauth_access_token = access_token
-      user
-    end
-
-    def authenticate(email, password)
-      request_token = @api_client.oauth.get_request_token
-      return nil unless @api_client.oauth.authorise_request_token(email, password, request_token)
-      user = Sevendigital::User.new(@api_client)
-      user.oauth_access_token = @api_client.oauth.get_access_token(request_token)
-      user
-    end
-
-    def get_locker(token, options={})
-      api_response = @api_client.make_signed_api_request("user/locker", {}, {}, token)
-      @locker = @api_client.locker_digestor.from_xml(api_response.content.locker)
-    end
-
-    def purchase(release_id, track_id, price, token, options={})
-      api_response = @api_client.make_signed_api_request("user/purchase/item", \
-        {:releaseId => release_id, :trackId => track_id, :price => price}, options, token)
-      @api_client.locker_digestor.from_xml(api_response.content.purchase)
-    end
-
-    def get_stream_track_url(release_id, track_id, token, options={})
-        api_request = @api_client.create_api_request("user/streamtrack", {:releaseId => release_id, :trackId => track_id}, options)
-        api_request.api_service = :media
-        api_request.require_signature
-        api_request.token = token
-        @api_client.operator.get_request_uri(api_request)
-    end
-
-    def get_add_card_url(return_url, token, options={})
-        api_request = @api_client.create_api_request("payment/addcard", {:returnUrl => return_url}, options)
-        api_request.api_service = :account
-        api_request.require_signature
-        api_request.require_secure_connection
-        api_request.token = token
-        @api_client.operator.get_request_uri(api_request)
-    end
-
-
-  end
-
-end
+module Sevendigital
+
+  class UserManager < Manager
+
+    def login(access_token)
+      raise Sevendigital::SevendigitalError if !access_token.kind_of? OAuth::AccessToken
+      user = Sevendigital::User.new(@api_client)
+      user.oauth_access_token = access_token
+      user
+    end
+
+    def authenticate(email, password)
+      request_token = @api_client.oauth.get_request_token
+      return nil unless @api_client.oauth.authorise_request_token(email, password, request_token)
+      user = Sevendigital::User.new(@api_client)
+      user.oauth_access_token = @api_client.oauth.get_access_token(request_token)
+      user
+    end
+
+    def sign_up(email, password, options={})
+      api_response = @api_client.make_signed_api_request(:POST, "user/signUp", \
+        {:emailAddress => email, :password=> password}, options)
+      user = @api_client.user_digestor.from_xml(api_response.content.user)
+      user.oauth_access_token = authenticate(email, password).oauth_access_token
+      user
+    end
+
+    def get_locker(token, options={})
+      api_response = @api_client.make_signed_api_request(:GET, "user/locker", {}, options, token)
+      @locker = @api_client.locker_digestor.from_xml(api_response.content.locker)
+    end
+
+    # <b>DEPRECATED:</b> Please use <tt>purchase_item</tt> instead.
+    def purchase(release_id, track_id, price, token, options={})
+      warn "[DEPRECATION] 'purchase' is deprecated.  Please use 'purchase_item' instead."
+      purchase_item(release_id, track_id, price, token, options)
+    end
+      
+    def purchase_item(release_id, track_id, price, token, options={})
+      api_response = @api_client.make_signed_api_request(:GET, "user/purchase/item", \
+        {:releaseId => release_id, :trackId => track_id, :price => price}, options, token)
+      @api_client.locker_digestor.from_xml(api_response.content.purchase)
+    end
+
+    def purchase_basket(basket_id, token, options={})
+      api_response = @api_client.make_signed_api_request(:GET, "user/purchase/basket", \
+        {:basketId => basket_id}, options, token)
+      @api_client.locker_digestor.from_xml(api_response.content.purchase)
+    end
+
+    def get_stream_track_url(release_id, track_id, token, options={})
+        api_request = @api_client.create_api_request(:GET, "user/streamtrack", {:releaseId => release_id, :trackId => track_id}, options)
+        api_request.api_service = :media
+        api_request.require_signature
+        api_request.token = token
+        @api_client.operator.get_request_uri(api_request)
+    end
+
+    def get_add_card_url(return_url, token, options={})
+        api_request = @api_client.create_api_request(:GET, "payment/addcard", {:returnUrl => return_url}, options)
+        api_request.api_service = :account
+        api_request.require_signature
+        api_request.require_secure_connection
+        api_request.token = token
+        @api_client.operator.get_request_uri(api_request)
+    end
+
+
+  end
+
+end

data/lib/sevendigital/model/api_response.rb

@@ -1,41 +1,26 @@
-module Sevendigital
-
-  #Holds the complete API response
-  class ApiResponse
-
-    attr_accessor :error_code, :error_message, :content, :headers
-
-    #True if no API error has been returned
-    def ok?
-      return (@error_code == 0 && !@content.nil?)
-    end
-
-    def _dump(depth)
-      Marshal.dump([@error_code, @error_message, @headers, @content.to_s])
-    end
-    
-    def self._load(properties)
-      response = ApiResponse.new
-      response.error_code, response.error_message, response.headers, content_xml = Marshal.load(properties)
-      response.content = Peachy::Proxy.new(content_xml).response
-      response
-    end
-
-    #Returns true if the response has been retrieved from cache but has since expired
-    def out_of_date?(current_time=nil)
-      return true if @headers.nil? || @headers["Date"].nil? || @headers["cache-control"].nil?
-      return true if  !(@headers["cache-control"] =~ /max-age=([0-9]+)/)
-      current_time ||= Time.now.utc
-      response_time = Time.parse(@headers["Date"])
-      max_age = /max-age=([0-9]+)/.match(@headers["cache-control"])[1].to_i
-      response_time + max_age < current_time
-    end
-
-
-  def response_cacheable?
-    return true
-  end
-
-  end
-
+module Sevendigital
+
+  #Holds the complete API response
+  class ApiResponse
+
+    attr_accessor :error_code, :error_message, :content, :headers
+
+    #True if no API error has been returned
+    def ok?
+      return (@error_code == 0 && !@content.nil?)
+    end
+
+    def _dump(depth)
+      Marshal.dump([@error_code, @error_message, @headers, @content.to_s])
+    end
+    
+    def self._load(properties)
+      response = ApiResponse.new
+      response.error_code, response.error_message, response.headers, content_xml = Marshal.load(properties)
+      response.content = Peachy::Proxy.new(content_xml).response
+      response
+    end
+
+  end
+
 end

data/lib/sevendigital/model/artist.rb

@@ -1,65 +1,95 @@
-module Sevendigital
-
-  #==Basic properties
-  #<tt>*id*</tt>:: \Artist ID
-  #<tt>*name*</tt>:: \Artist\'s name
-  #<tt>*appears_as*</tt>:: \Artist\'s name as it appears on the release or track (only available when artist is linked from release or track)
-  #
-  #==Optional properties
-  #with lazy loading enabled these will be automatically populated by calling get_details
-  #<tt>*sort_name*</tt>:: \Artist name used for sorting, e.g. Beatles, The
-  #<tt>*image*</tt>:: \Artist image URL
-  #<tt>*url*</tt>:: \Artist buy link URL
-  #
-  #==Extended properties
-  #with lazy loading enabled these will be automatically populated by calling the method in brackets
-  #<tt>*releases*</tt>:: array of artist\'s releases (retrieved using get_releases)
-  #<tt>*top_tracks*</tt>:: array of artist\'s top tracks (get_top_tracks)
-  #<tt>*similar*</tt>:: array of artists similar to this artist (get_similar)
-  #additional options can be passed in when accessing lazy loaded properties, e.g.
-  #   artist.releases({:page_size => 5, :image_size =>250})
-
-  class Artist < SevendigitalObject
-
-    attr_accessor :id, :name, :appears_as #:nodoc:
-
-    sevendigital_basic_property :sort_name, :image, :url
-
-    #Retrieves artist\'s details by calling *artist/details* API method
-    def get_details(options={})
-      artist_with_details = @api_client.artist.get_details(@id, options)
-      copy_basic_properties_from(artist_with_details)
-    end
-
-    sevendigital_extended_property :releases
-    sevendigital_extended_property :top_tracks
-    sevendigital_extended_property :similar
-
-    #Retrieves releases by this artist by calling *artist/releases* API method
-    def get_releases(options={})
-    @api_client.artist.get_releases(@id, options)
-    end
-
-    #Retrieves top tracks by this artist by calling *artist/topTracks* API method
-    def get_top_tracks(options={})
-    @api_client.artist.get_top_tracks(@id, options)
-    end
-
-    #Retrieves artists similar to this artist by calling *artist/similar* API method
-    def get_similar(options={})
-      @similar = @api_client.artist.get_similar(@id, options)
-    end
-
-    #True if this artist represents various artists
-    def various?
-      joined_names = "#{name} #{appears_as}".downcase
-
-      various_variations = ["vario", "v???????????????rio", "v.a", "vaious", "varios" "vaious", "varoius", "variuos", \
-                            "soundtrack", "karaoke", "original cast", "diverse artist"]
-      various_variations.each{|various_variation| return true if joined_names.include?(various_variation)}
-      return false
-    end
-
-        
-  end
+module Sevendigital
+
+#with lazy loading enabled these will be automatically populated by calling get_details
+  #==Extended properties
+  #with lazy loading enabled these will be automatically populated by calling the method in brackets
+  #additional options can be passed in when accessing lazy loaded properties, e.g.
+  #   artist.releases({:page_size => 5, :image_size =>250})
+
+class Artist < SevendigitalObject
+
+  #7digital artist ID
+  #@return [Integer]
+  attr_accessor :id
+
+  #artist's name
+  #@return [String]
+  attr_accessor :name
+
+  #Artist's name as it appears on the release or track (only available when artist is linked from release or track)
+  #@return [String]
+  attr_accessor :appears_as
+
+  #Artist name used for sorting, e.g. Beatles, The (optional lazy-loaded property)
+  #@return [String]
+  sevendigital_basic_property :sort_name
+
+  #Artist image URL (optional lazy-loaded property)
+  #@return [String]
+  sevendigital_basic_property :image
+
+  #Artist buy link URL (optional lazy-loaded property)
+  #@return [String]
+  sevendigital_basic_property :url
+
+  #artist's releases (lazy loaded using get_releases)
+  #@return [Array<Release>] 
+  sevendigital_extended_property :releases
+
+  #artist's top tracks (lazy loaded using get_top_tracks)
+  #@return [Array<Track>] 
+  sevendigital_extended_property :top_tracks
+
+  #list of artists similar to this artist (lazy loaded using {#get_similar})
+  #@return [Array<Artist>] similar
+  sevendigital_extended_property :similar
+
+  #list of tags associated with the artist (lazy loaded using #get_tags)
+  #@return [Array<Artist>] similar
+  sevendigital_extended_property :tags
+
+    #populates all available details on artist by calling *artist/details* API method
+    #@return [Artist] 
+    def get_details(options={})
+      artist_with_details = @api_client.artist.get_details(@id, options)
+      copy_basic_properties_from(artist_with_details)
+    end
+
+    #releases by this artist retrieved by calling *artist/releases* API method
+    #@return [Array<Release>]
+    def get_releases(options={})
+      @api_client.artist.get_releases(@id, options)
+    end
+
+    #top tracks by this artist retrieved by calling *artist/topTracks* API method
+    #@return [Array<Track>] 
+    def get_top_tracks(options={})
+      @api_client.artist.get_top_tracks(@id, options)
+    end
+
+    #artists similar to this artist retrieved by calling *artist/similar* API method
+    #@return [Array<Track>]
+    def get_similar(options={})
+      @similar = @api_client.artist.get_similar(@id, options)
+    end
+
+    #tags associated with this artist retrieved by calling *artist/tags* API method
+    #@return [Array<Tag>]
+    def get_tags(options={})
+      @api_client.artist.get_tags(@id, options)
+    end
+
+    #does this artist represents various artists?
+    #@return [Boolean]
+    def various?
+      joined_names = "#{name} #{appears_as}".downcase
+
+      various_variations = ["vario", "v???????????????rio", "v.a", "vaious", "varios" "vaious", "varoius", "variuos", \
+                            "soundtrack", "karaoke", "original cast", "diverse artist"]
+      various_variations.each{|various_variation| return true if joined_names.include?(various_variation)}
+      return false
+    end
+
+        
+  end
 end