itunes-affiliate 0.0.2 → 0.0.3

data/README.md

@@ -47,6 +47,9 @@ rake install
 rake release
 ## Release Notes
 
+### 0.0.3
+* Documentation added
+
 ### 0.0.2
 * Added affiliate_link to ItunesAffiliate as class method.
 

data/lib/itunes-affiliate.rb

@@ -2,15 +2,35 @@ require "itunes_affiliate/version"
 require "itunes_affiliate/configuration"
 require "itunes_affiliate/itunes_link"
 
+# @author Martin Wawrusch
+#
+# A simple gem that helps with the creation of itunes links, especially when dealing with EPF data.
+#
+# @example Configuring the keys (in config/initializers/itunes_affiliate.rb)
+#   ItunesAffiliate.configure do |config|
+#    config.linkshare_key = '<LINKSHARE_KEY>'
+#    config.linkshare_japan_key = '<LINKSHARE_JAPAN_KEY>'
+#    config.tradedoubler_key = '<TRADEDOUBLE_KEY>'
+#    config.dgm_key = '<DGM_KEY>'
+#   end
+#
+# 
+# @example Add affiliate information to a link and ignore invalid links
+#   link = ItunesAffiliate.affiliate_link("http://itunes.apple.com/app/swine-flu-detector/id295517288",:linkshare)
+# 
 module ItunesAffiliate
 
   class << self
     attr_accessor :config
 
+    # Invoked with blog to configure this gem. 
+    # Pass a block with |config| and set the keys
     def configure()
       yield(config)
     end
 
+    # Access the configuration object
+    # @return [Configuration] the configuration object singleton.
     def config
       unless @config
         @config = Configuration.new
@@ -19,6 +39,10 @@ module ItunesAffiliate
       @config 
     end
 
+    # Return an affiliate link for a given clean itunes url 
+    # @param [String] link the link to which to add the affiliate information.
+    # @param [Symbol] partner the partner, as determined by the store. Valid values are :linkshare,:linkshare_japan,:tradedoubler,:dgm
+    # @return [String] a modified link containing the affiliate information, or the original link if the link is not an itunes clean link.
     def affiliate_link(link,partner)
       return link unless ItunesAffiliate::ItunesLink.is_valid_link?(link)
       

data/lib/itunes_affiliate/itunes_link.rb

@@ -3,13 +3,22 @@ require 'uri'
 module ItunesAffiliate
   class ItunesLink
 
+    # The list of possible affiliate parters, as determined by the store.
     Partners =  [:linkshare,:linkshare_japan,:tradedoubler,:dgm].freeze
      
+    # Initializes a new instance of the ItunesLink class
+    # @param [String] source_link the source link, which should be a valid clean itunes link
+    # @return [ItunesLink] an initialized ItunesLink object.
+    # @raise [ArgumentException] raised when source_link is nil   
     def initialize(source_link)
-      raise ArgumentException "You need to provide a source link" if source_link == nil
+      raise ArgumentException "You need to provide a source link" unless source_link 
       @source_link = source_link
     end
 
+    # Returns an affiliate link
+    # @param [Symbol] partner the partner, as determined by the store. Valid values are :linkshare,:linkshare_japan,:tradedoubler,:dgm
+    # @return [String] a modified link containing the affiliate information, or the original link if the link is not an itunes clean link.
+    # @raise [ArgumentException] raised when the partner is not a valid symbol 
     def affiliate_link(partner)
       case partner
         when :linkshare
@@ -25,6 +34,9 @@ module ItunesAffiliate
       end
     end
     
+    # Determines if the link is a valid itunes clean url.
+    # @param [String] link the link that should be checked.
+    # @return [Boolean] true if the link is not nil and has the host itunes.apple.com, otherwise false
     def self.is_valid_link?(link)
       uri = URI.parse(link) rescue nil
       

data/lib/itunes_affiliate/version.rb

@@ -1,3 +1,3 @@
 module ItunesAffiliate
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -2,7 +2,7 @@
 name: itunes-affiliate
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Martin Wawrusch