7digital 0.0.5 → 0.0.6

data/lib/sevendigital/client_digestors.rb

@@ -1,79 +1,107 @@
-module Sevendigital
-
-  class Client
-
-    def api_response_digestor
-      @api_response_digestor ||= ApiResponseDigestor.new(self)
-    end
-
-    def artist_digestor
-      @artist_digestor ||= ArtistDigestor.new(self)
-    end
-
-    def basket_digestor
-      @basket_digestor ||= BasketDigestor.new(self)
-    end
-
-    def basket_item_digestor
-      @basket_item_digestor ||= BasketItemDigestor.new(self)
-    end
-
-    def chart_item_digestor
-      @chart_item_digestor ||= ChartItemDigestor.new(self)
-    end
-
-    def download_url_digestor
-      @download_url_digestor ||= DownloadUrlDigestor.new(self)
-    end
-
-    def format_digestor
-      @format_digestor ||= FormatDigestor.new(self)
-    end
-
-    def label_digestor
-      @label_digestor ||= LabelDigestor.new(self)
-    end
-
-    def locker_digestor
-      @locker_digestor ||= LockerDigestor.new(self)
-    end
-
-    def locker_release_digestor
-      @locker_release_digestor ||= LockerReleaseDigestor.new(self)
-    end
-
-    def locker_track_digestor
-      @locker_track_digestor ||= LockerTrackDigestor.new(self)
-    end
-
-    def oauth_request_token_digestor
-      @oauth_request_token_digestor ||= OAuthRequestTokenDigestor.new(self)
-    end
-
-    def oauth_access_token_digestor
-      @oauth_access_token_digestor ||= OAuthAccessTokenDigestor.new(self)
-    end
-
-    def pager_digestor
-      @pager_digestor ||= PagerDigestor.new(self)
-    end
-
-    def price_digestor
-      @price_digestor ||= PriceDigestor.new(self)
-    end
-
-    def release_digestor
-      @release_digestor ||= ReleaseDigestor.new(self)
-    end
-
-    def track_digestor
-      @track_digestor ||= TrackDigestor.new(self)
-    end
-
-    def tag_digestor
-      @tag_digestor ||= TagDigestor.new(self)
-    end
-
-  end
-
-end
+module Sevendigital
+
+  class Client #:nodoc:
+
+    #@private
+    def api_response_digestor
+      @api_response_digestor ||= ApiResponseDigestor.new(self)
+    end
+
+    #@private
+    def artist_digestor
+      @artist_digestor ||= ArtistDigestor.new(self)
+    end
+
+    #@private
+    def basket_digestor
+      @basket_digestor ||= BasketDigestor.new(self)
+    end
+
+    #@private
+    def basket_item_digestor
+      @basket_item_digestor ||= BasketItemDigestor.new(self)
+    end
+
+    #@private
+    def chart_item_digestor
+      @chart_item_digestor ||= ChartItemDigestor.new(self)
+    end
+
+    #@private
+    def download_url_digestor
+      @download_url_digestor ||= DownloadUrlDigestor.new(self)
+    end
+
+    #@private
+    def format_digestor
+      @format_digestor ||= FormatDigestor.new(self)
+    end
+
+    #@private
+    def label_digestor
+      @label_digestor ||= LabelDigestor.new(self)
+    end
+
+    #@private
+    def locker_digestor
+      @locker_digestor ||= LockerDigestor.new(self)
+    end
+
+    #@private
+    def locker_release_digestor
+      @locker_release_digestor ||= LockerReleaseDigestor.new(self)
+    end
+
+    #@private
+    def locker_track_digestor
+      @locker_track_digestor ||= LockerTrackDigestor.new(self)
+    end
+
+    #@private
+    def oauth_request_token_digestor
+      @oauth_request_token_digestor ||= OAuthRequestTokenDigestor.new(self)
+    end
+
+    #@private
+    def oauth_access_token_digestor
+      @oauth_access_token_digestor ||= OAuthAccessTokenDigestor.new(self)
+    end
+
+    #@private
+    def pager_digestor
+      @pager_digestor ||= PagerDigestor.new(self)
+    end
+
+    #@private
+    def price_digestor
+      @price_digestor ||= PriceDigestor.new(self)
+    end
+
+    #@private
+    def release_digestor
+      @release_digestor ||= ReleaseDigestor.new(self)
+    end
+
+    #@private
+    def track_digestor
+      @track_digestor ||= TrackDigestor.new(self)
+    end
+
+    #@private
+    def tag_digestor
+      @tag_digestor ||= TagDigestor.new(self)
+    end
+
+    #@private
+    def user_card_digestor
+      @user_card_digestor ||= UserCardDigestor.new(self)
+    end
+
+    #@private
+    def user_digestor
+      @user_digestor ||= UserDigestor.new(self)
+    end
+
+  end
+
+end

data/lib/sevendigital/client_managers.rb

@@ -1,34 +1,47 @@
-module Sevendigital
-
-  class Client
-
-    def artist
-      @artist_manager ||= ArtistManager.new(self) 
-    end
-
-    def basket
-      @basket_manager ||= BasketManager.new(self)
-    end
-    def release
-      @release_manager ||= ReleaseManager.new(self)
-    end
-
-    def tag
-      @tag_manager ||= TagManager.new(self)
-    end
-    
-    def track
-      @track_manager ||= TrackManager.new(self)
-    end
-
-    def user
-      @user_manager ||= UserManager.new(self)
-    end
-
-    def oauth
-      @oauth_manager ||= OAuthManager.new(self)
-    end
-
-  end
-
-end
+module Sevendigital
+
+  class Client
+
+    #@return [ArtistManager]
+    def artist
+      @artist_manager ||= ArtistManager.new(self) 
+    end
+
+    #@return [BasketManager]
+    def basket
+      @basket_manager ||= BasketManager.new(self)
+    end
+
+    #@return [ReleaseManager]
+    def release
+      @release_manager ||= ReleaseManager.new(self)
+    end
+
+    #@return [TagManager]
+    def tag
+      @tag_manager ||= TagManager.new(self)
+    end
+    
+    #@return [TrackManager]
+    def track
+      @track_manager ||= TrackManager.new(self)
+    end
+
+    #@return [UserManager]
+    def user
+      @user_manager ||= UserManager.new(self)
+    end
+
+    #@return [UserManager]
+    def user_payment_card
+      @user_card_manager ||= UserCardManager.new(self)
+    end
+
+    #@return [OAuthManager]
+    def oauth
+      @oauth_manager ||= OAuthManager.new(self)
+    end
+
+  end
+
+end

data/lib/sevendigital/digestion_tract/api_response_digestor.rb

@@ -1,57 +1,58 @@
-module Sevendigital
-
-  class ApiResponseDigestor < Digestor # :nodoc:
-
-    def from_xml(xml_or_proxy, element_name = :response)
-      return from_proxy(ProxyPolice.ensure_is_proxy(xml_or_proxy, element_name))
-    end
-
-    def from_proxy(proxy)
-      if proxy && proxy.status then
-        return from_ok_response(proxy)  if proxy.status == 'ok'
-        return from_error_response(proxy.error) if proxy.status == 'error' && proxy.error
-      end
-      return from_invalid_xml
-    end
-
-    def from_invalid_xml
-      response = ApiResponse.new
-      response.error_code = 10000
-      response.error_message = 'Invalid 7digital API response'
-      return response
-    end
-
-    def from_error_response(error)
-      response = ApiResponse.new
-      response.error_code = error.code.to_i
-      response.error_message = error.error_message.value.to_s
-      return response
-    end
-
-    def from_ok_response(response_content)
-      response = ApiResponse.new
-      response.error_code = 0
-      response.content = response_content
-      return response
-    end
-
-    def from_http_response(http_response)
-      if http_response.is_a?(Net::HTTPSuccess) then
-        response = from_xml(http_response.body.to_s)
-      else
-        response = from_invalid_http_response(http_response)
-      end
-      response.headers = http_response.header
-      response
-    end
-
-    def from_invalid_http_response(http_response)
-      response = ApiResponse.new
-      response.error_code = Integer(http_response.code)
-      response.error_message= http_response.body.to_s
-      return response
-    end
-  
-  end
-
-end
+module Sevendigital
+
+  #@private
+  class ApiResponseDigestor < Digestor # :nodoc:
+
+    def from_xml(xml_or_proxy, element_name = :response)
+      return from_proxy(ProxyPolice.ensure_is_proxy(xml_or_proxy, element_name))
+    end
+
+    def from_proxy(proxy)
+      if proxy && proxy.status then
+        return from_ok_response(proxy)  if proxy.status == 'ok'
+        return from_error_response(proxy.error) if proxy.status == 'error' && proxy.error
+      end
+      return from_invalid_xml
+    end
+
+    def from_invalid_xml
+      response = ApiResponse.new
+      response.error_code = 10000
+      response.error_message = 'Invalid 7digital API response'
+      return response
+    end
+
+    def from_error_response(error)
+      response = ApiResponse.new
+      response.error_code = error.code.to_i
+      response.error_message = error.error_message.value.to_s
+      return response
+    end
+
+    def from_ok_response(response_content)
+      response = ApiResponse.new
+      response.error_code = 0
+      response.content = response_content
+      return response
+    end
+
+    def from_http_response(http_response)
+      if http_response.is_a?(Net::HTTPSuccess) then
+        response = from_xml(http_response.body.to_s)
+      else
+        response = from_invalid_http_response(http_response)
+      end
+      response.headers = http_response.header
+      response
+    end
+
+    def from_invalid_http_response(http_response)
+      response = ApiResponse.new
+      response.error_code = Integer(http_response.code)
+      response.error_message= http_response.body.to_s
+      return response
+    end
+  
+  end
+
+end

data/lib/sevendigital/digestion_tract/artist_digestor.rb

@@ -1,31 +1,32 @@
-module Sevendigital
-
-  class ArtistDigestor < Digestor # :nodoc:
-
-    def default_element_name; :artist end
-    def default_list_element_name; :artists end
-
-    def from_proxy(artist_proxy)
-      make_sure_not_eating_nil(artist_proxy)
-      artist = Artist.new(@api_client)
-      populate_required_properties(artist, artist_proxy)
-      populate_optional_properties(artist, artist_proxy)
-      return artist
-    end
-
-    private
-    
-    def populate_required_properties(artist, artist_proxy)
-      artist.id = artist_proxy.id.to_i
-      artist.name = artist_proxy.name.value.to_s
-    end
-
-    def populate_optional_properties(artist, artist_proxy)
-      artist.sort_name = artist_proxy.sort_name.value.to_s if artist_proxy.sort_name
-      artist.appears_as = artist_proxy.appears_as.value.to_s if artist_proxy.appears_as
-      artist.image = artist_proxy.image.value.to_s if artist_proxy.image
-      artist.url = artist_proxy.url.value.to_s if artist_proxy.url
-    end
-
-  end
-end
+module Sevendigital
+
+  #@private
+  class ArtistDigestor < Digestor # :nodoc:
+
+    def default_element_name; :artist end
+    def default_list_element_name; :artists end
+
+    def from_proxy(artist_proxy)
+      make_sure_not_eating_nil(artist_proxy)
+      artist = Artist.new(@api_client)
+      populate_required_properties(artist, artist_proxy)
+      populate_optional_properties(artist, artist_proxy)
+      return artist
+    end
+
+    private
+    
+    def populate_required_properties(artist, artist_proxy)
+      artist.id = artist_proxy.id.to_i
+      artist.name = artist_proxy.name.value.to_s
+    end
+
+    def populate_optional_properties(artist, artist_proxy)
+      artist.sort_name = artist_proxy.sort_name.value.to_s if artist_proxy.sort_name
+      artist.appears_as = artist_proxy.appears_as.value.to_s if artist_proxy.appears_as
+      artist.image = artist_proxy.image.value.to_s if artist_proxy.image
+      artist.url = artist_proxy.url.value.to_s if artist_proxy.url
+    end
+
+  end
+end