itunes-affiliate 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+doc/*
+.yardoc

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.9.2
+  - 1.9.3

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+--markup markdown
+-
+LICENSE

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in itunes-affiliate.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Martin Wawrusch
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+## itunes-affiliate
+A simple gem that helps with the creation of itunes links, especially when dealing with EPF data. This is a work in progress, first version is really just to have the minimal use case working. 
+
+Feature requests are welcome.
+
+If you use it please test against your affiliate id and provide feedback. Use at your own risk.
+
+[![Build Status](http://travis-ci.org/freshfugu/itunes-affiliate.png)](http://travis-ci.org/freshfugu/itunes-affiliate)
+
+## Install
+
+Include this in your gemfile
+
+gem 'itunes-affiliate'
+
+## Configure
+Create an initializer if you use rails in config/initializers named itunes_affiliate.rb and add the following code snippet with your keys. If a key is not present it will be ignored.
+
+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
+
+## Use
+A more detailed description can be found at <http://rubydoc.info/gems/itunes-affiliate>.
+
+###Some Sample Code
+		link = ItunesLink.new("http://itunes.apple.com/app/swine-flu-detector/id295517288?uo=5")
+		
+		puts link.affiliate_link(:linkshare)
+
+
+## Dependencies
+
+## Acknowledgments
+
+## Trivia
+
+This gem was created to the tunes of Nicki Minaj and Jennifer Lopez.
+
+## Build
+
+rake build
+rake install
+rake release
+## Release Notes
+
+### 0.0.1
+* First version
+
+## Contributing to itunes-affiliate
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Martin Wawrusch. See LICENSE for
+further details.
+

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+desc 'Run the specs'
+RSpec::Core::RakeTask.new do |r|
+  r.verbose = false
+end
+
+task :default => :spec

data/itunes-affiliate.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "itunes_affiliate/version"
+
+
+Gem::Specification.new do |s|
+  s.name        = "itunes-affiliate"
+  s.version     = ItunesAffiliate::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Martin Wawrusch"]
+  s.email       = ["martin@wawrusch.com"]
+  s.homepage    = "http://github.com/freshfugu/itunes-affiliate"
+  s.summary     = %q{Easily add affiliate information to your itunes links.}
+  s.description = %q{This gem provides you with an ItunesLink class that simplifies adding affiliate information to itunes links.}
+  s.extra_rdoc_files   = ["LICENSE","README.md"]
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.rubyforge_project = "itunes-affiliate"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+#  s.add_runtime_dependency "httparty"  
+  s.add_development_dependency "rspec", "~> 2.1"
+  s.add_development_dependency "rake", "~> 0.8"
+  s.add_development_dependency "bundler","~> 1.0.0"
+  s.post_install_message=<<eos
+**********************************************************************************
+  Thank you for using this gem.
+  
+  Follow @martin_sunset on Twitter for announcements, updates and news
+  https://twitter.com/martin_sunset
+
+  To get the source go to http://github.com/freshfugu/itunes-affiliate
+
+**********************************************************************************    
+eos
+  
+  
+end

data/lib/itunes-affiliate.rb

@@ -0,0 +1,23 @@
+require "itunes_affiliate/version"
+require "itunes_affiliate/configuration"
+require "itunes_affiliate/itunes_link"
+
+module ItunesAffiliate
+
+  class << self
+    attr_accessor :config
+
+    def configure()
+      yield(config)
+    end
+
+    def config
+      unless @config
+        @config = Configuration.new
+        @config.reset
+      end
+      @config 
+    end
+
+  end  
+end

data/lib/itunes_affiliate/configuration.rb

@@ -0,0 +1,61 @@
+
+module ItunesAffiliate
+  class Configuration
+      
+      # An array of valid keys in the options hash when configuring
+      VALID_OPTIONS_KEYS =[
+        :linkshare_key,
+        :linkshare_japan_key,
+        :tradedoubler_key,
+        :dgm_key,
+        :linkshare_partner_id,
+        :linkshare_japan_partner_id,
+        :tradedoubler_partner_id,
+        :dgm_partner_id].freeze
+      
+      DEFAULT_LINKSHARE_KEY = ''
+      DEFAULT_LINKSHARE_JAPAN_KEY = ''
+      DEFAULT_TRADEDOUBLER_KEY = ''
+      DEFAULT_DGM_KEY = ''
+      
+      LINKSHARE_PARTNER_ID  = 30
+      LINKSHARE_JAPAN_PARTNER_ID = 30
+      TRADEDOUBLER_PARTNER_ID = 2003
+      DGM_PARTNER_ID =  1002
+      
+            
+      attr_accessor *VALID_OPTIONS_KEYS
+       
+      # When this module is extended, set all configuration options to their default values
+      def self.extended(base)
+        base.reset
+      end
+      
+      # Convenience method to allow configuration options to be set in a block.
+      def configure
+        yield self
+      end
+      
+      # Create a hash of options and their values.
+      def options 
+        options = {}
+        VALID_OPTIONS_KEYS.each {|k| options[k] = send(k)}
+        options
+      end
+      
+      # Reset all configuration options to defaults
+      def reset
+        self.linkshare_key =DEFAULT_LINKSHARE_KEY
+        self.linkshare_japan_key =DEFAULT_LINKSHARE_JAPAN_KEY
+        self.tradedoubler_key =DEFAULT_TRADEDOUBLER_KEY
+        self.dgm_key =DEFAULT_DGM_KEY
+        
+        
+        self.linkshare_partner_id = LINKSHARE_PARTNER_ID
+        self.linkshare_japan_partner_id =LINKSHARE_JAPAN_PARTNER_ID
+        self.tradedoubler_partner_id =TRADEDOUBLER_PARTNER_ID
+        self.dgm_partner_id = DGM_PARTNER_ID
+        
+      end
+    end
+end

data/lib/itunes_affiliate/itunes_link.rb

@@ -0,0 +1,41 @@
+require 'uri'
+
+module ItunesAffiliate
+  class ItunesLink
+
+    Partners =  [:linkshare,:linkshare_japan,:tradedoubler,:dgm].freeze
+     
+    def initialize(source_link)
+      raise ArgumentException "You need to provide a source link" if source_link == nil
+      @source_link = source_link
+    end
+
+    def affiliate_link(partner)
+      case partner
+        when :linkshare
+          append_to_link @source_link, "&partnerId=#{ItunesAffiliate.config.linkshare_partner_id}&siteID=#{ItunesAffiliate.config.linkshare_key}"
+        when :linkshare_japan
+          append_to_link @source_link, "&partnerId=#{ItunesAffiliate.config.linkshare_japan_partner_id}&siteID=#{ItunesAffiliate.config.linkshare_japan_key}"
+        when :tradedoubler
+          append_to_link @source_link, "&partnerId=#{ItunesAffiliate.config.tradedoubler_partner_id}&tduid=#{ItunesAffiliate.config.tradedoubler_key}"
+        when :dgm
+          append_to_link @source_link, "&partnerId=#{ItunesAffiliate.config.dgm_partner_id}&affToken=#{ItunesAffiliate.config.dgm_key}"
+        else
+          raise ArgumentException "Unrecognized partner #{partner} must be one of #{Partners}"
+      end
+    end
+    
+    
+    private 
+    
+    # A total hack, this is a good example of really bad code.
+    def append_to_link(link, append_me)
+      unless URI.parse(link).query 
+        append_me[0] = "?"
+      end 
+      
+      "#{link}#{append_me}"
+        
+    end
+  end
+end

data/lib/itunes_affiliate/version.rb

@@ -0,0 +1,3 @@
+module ItunesAffiliate
+  VERSION = "0.0.1"
+end

data/spec/itunes_link_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+require 'itunes-affiliate'
+
+describe ItunesAffiliate::ItunesLink do
+  include TestHelpers
+  
+  RawLinkWithoutQuestionMark = "http://itunes.apple.com/app/swine-flu-detector/id295517288"
+  RawLinkWithQuestionMark = "http://itunes.apple.com/app/swine-flu-detector/id295517288?uo=5"
+
+  LinkShareAffiliateCode= "Zi7WWVQYf4o"
+  LinkShareJapanAffiliateCode = "5635445dsf"
+  TradeDoublerAffiliateCode = 'fdsewr3sd'
+  DGMAffiliateCode = 'ewfsdd'
+  
+  before(:all) do
+    ItunesAffiliate.configure do  |config|
+      config.linkshare_key = LinkShareAffiliateCode
+      config.linkshare_japan_key =LinkShareJapanAffiliateCode
+      config.tradedoubler_key =TradeDoublerAffiliateCode
+      config.dgm_key =DGMAffiliateCode
+    end
+  end
+  
+  
+  context "when using an itunes link with parameter" do
+    before(:each) do
+      @link = ItunesAffiliate::ItunesLink.new  RawLinkWithQuestionMark
+    end
+
+    it "should create a valid linkshare link" do
+      params = link_to_hash  @link.affiliate_link(:linkshare)
+            
+      params['siteID'].should == LinkShareAffiliateCode
+      params['partnerId'].should == '30'
+      params['uo'].should == '5'
+    end
+
+    it "should create a valid linkshare japan link" do
+      params = link_to_hash  @link.affiliate_link(:linkshare_japan)
+            
+      params['siteID'].should == LinkShareJapanAffiliateCode
+      params['partnerId'].should == '30'
+      params['uo'].should == '5'
+    end
+    
+    it "should create a valid tradedoubler link" do
+      params = link_to_hash  @link.affiliate_link(:tradedoubler)
+            
+      params['tduid'].should == TradeDoublerAffiliateCode
+      params['partnerId'].should == '2003'
+      params['uo'].should == '5'
+    end
+
+    it "should create a valid dgm link" do
+      params = link_to_hash  @link.affiliate_link(:dgm)
+            
+      params['affToken'].should == DGMAffiliateCode
+      params['partnerId'].should == '1002'
+      params['uo'].should == '5'
+    end
+  end
+  
+  context "when using an itunes link withOUT parameter" do
+    before(:each) do
+      @link = ItunesAffiliate::ItunesLink.new  RawLinkWithoutQuestionMark
+    end
+
+    it "should create a valid linkshare link" do
+      params = link_to_hash  @link.affiliate_link(:linkshare)
+            
+      params['siteID'].should == LinkShareAffiliateCode
+      params['partnerId'].should == '30'
+    end
+
+    it "should create a valid linkshare japan link" do
+      params = link_to_hash  @link.affiliate_link(:linkshare_japan)
+            
+      params['siteID'].should == LinkShareJapanAffiliateCode
+      params['partnerId'].should == '30'
+    end
+    
+    it "should create a valid tradedoubler link" do
+      params = link_to_hash  @link.affiliate_link(:tradedoubler)
+            
+      params['tduid'].should == TradeDoublerAffiliateCode
+      params['partnerId'].should == '2003'
+    end
+
+    it "should create a valid dgm link" do
+      params = link_to_hash  @link.affiliate_link(:dgm)
+            
+      params['affToken'].should == DGMAffiliateCode
+      params['partnerId'].should == '1002'
+    end
+  end
+  
+  
+  # Missing specs:
+  # Must raise ArgumentException if invalid affiliate link
+  # Must raise ArgumentException if no link is passed
+  # check invalid url
+  # check no params -> make sure url is correct
+  # check that the source url is still present
+  # select code based on language
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'bundler/setup'
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rspec'
+require 'itunes-affiliate'
+require 'uri'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+module TestHelpers
+  
+  def link_to_hash(link)
+    res = URI.parse link
+     res = res.query ?  res.query.split('&') : []
+     
+    params = {}
+    res.each {|x| y = x.split("=");params[ y[0]] = y[1] }
+     
+    params
+  end
+end
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end
+
+
+

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification 
+name: itunes-affiliate
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Martin Wawrusch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-27 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.1"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.8"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  version_requirements: *id003
+description: This gem provides you with an ItunesLink class that simplifies adding affiliate information to itunes links.
+email: 
+- martin@wawrusch.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- .travis.yml
+- .yardopts
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- itunes-affiliate.gemspec
+- lib/itunes-affiliate.rb
+- lib/itunes_affiliate/configuration.rb
+- lib/itunes_affiliate/itunes_link.rb
+- lib/itunes_affiliate/version.rb
+- spec/itunes_link_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/freshfugu/itunes-affiliate
+licenses: []
+
+post_install_message: |
+  **********************************************************************************
+    Thank you for using this gem.
+    
+    Follow @martin_sunset on Twitter for announcements, updates and news
+    https://twitter.com/martin_sunset
+  
+    To get the source go to http://github.com/freshfugu/itunes-affiliate
+  
+  **********************************************************************************    
+
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: itunes-affiliate
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Easily add affiliate information to your itunes links.
+test_files: 
+- spec/itunes_link_spec.rb
+- spec/spec_helper.rb