tunecore_direct 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-04-09
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 FIXME full name
+
+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/Manifest.txt

@@ -0,0 +1,26 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/tunecore_direct.rb
+lib/tunecore_direct/album.rb
+lib/tunecore_direct/base.rb
+lib/tunecore_direct/person.rb
+lib/tunecore_direct/request.rb
+lib/tunecore_direct/response.rb
+lib/tunecore_direct/song.rb
+lib/tunecore_direct/version.rb
+log/debug.log
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_helper.rb
+test/test_tunecore_direct.rb

data/README.txt

@@ -0,0 +1,48 @@
+= tunecore_direct
+
+* FIX (url)
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+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/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,70 @@
+require 'tunecore_direct/version'
+
+AUTHOR = 'Alex Kane'  # can also be an array of Authors
+EMAIL = "alex@tunecore.com"
+DESCRIPTION = "Ruby SDK for TuneCore web services"
+GEM_NAME = 'tunecore_direct' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'tunecoredirect' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "alexkane"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = YAML.load(`svn info`)['Revision']
+VERS = TunecoreDirect::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'tunecore_direct documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/tunecore_direct.rb

@@ -0,0 +1,14 @@
+# See TunecoreDirect::Base
+module TunecoreDirect
+  require 'rexml/document'
+  require 'net/http'
+  require 'uri'
+  
+  require "tunecore_direct"
+  require "tunecore_direct/base"
+  require "tunecore_direct/request"
+  require "tunecore_direct/response"
+  require "tunecore_direct/person"
+  require "tunecore_direct/album"
+  require "tunecore_direct/song"
+end

data/lib/tunecore_direct/album.rb

@@ -0,0 +1,105 @@
+# See TunecoreDirect#Base
+module TunecoreDirect
+  
+  # Represents an individual TuneCore Album.  Each album belongs to a Person and has one or more Song objects attached to it.
+  # To attach artwork to the Album you should place the Artwork file on Amazon S3 and provide the S3 location in the #artwork_s3_url accessor.
+  # You can upload the artwork file using !TuneCore's web-based upload tool or you can use a 3rd party S3 interface such as the
+  # Amazon_S3_Library_for_REST_in_Ruby[http://developer.amazonwebservices.com/connect/entry.jspa?externalID=135].
+  #
+  # Stores should be defined using the following abbreviations, seperated by commas:
+  # iTunesUS
+  # iTunesAU
+  # iTunesCA
+  # iTunesEU
+  # iTunesJP
+  # iTunesUK
+  # RhapsodyRH
+  # MusicNet
+  # Napster
+  # eMusic
+  # Amazon
+  # Lala
+  #
+  class Album < TunecoreDirect::Base
+    include TunecoreDirect
+    
+    attr_accessor :album_id, :person_id, :name, :orig_release_year, :sale_date, :primary_genre, :secondary_genre
+    attr_accessor :artist_name, :label_name, :c_copyright, :p_copyright, :recording_location
+    attr_accessor :errors
+    attr_accessor :artwork_s3_url
+    attr_accessor :stores, :state
+    
+    
+    def initialize(options = {})
+      options.each do |k,v|
+        self.send("#{k}=", v)
+      end
+    end
+    
+    # Creates an Album object from a Rexml:Element
+    def self.from_xml_element( album_element)
+      album = self.new
+      album.album_id = album_element.elements["id"].text
+      album.person_id = album_element.elements["person-id"].text 
+      album.name = album_element.elements["name"].text
+      album.orig_release_year = album_element.elements["orig-release-year"].text
+      album.sale_date = album_element.elements["sale-date"].text
+      album.primary_genre = album_element.elements["primary-genre"].text 
+      album.secondary_genre = album_element.elements["secondary-genre"].text unless album_element.elements["secondary-genre"].nil?
+      album.artist_name = album_element.elements["artist"].elements["name"].text
+      album.label_name = album_element.elements["label"].elements["name"].text
+      album.c_copyright = album_element.elements["c-copyright"].text
+      album.p_copyright = album_element.elements["p-copyright"].text
+      album.recording_location = album_element.elements["recording-location"].text
+      album.state = album_element.elements["state"].text
+      return album
+    end
+    
+    # Creates a new album
+    def create
+     req = Request.new
+     params = { "person_id" => @person_id, 
+                "name" => @name, 
+                "orig_release_year" => @orig_release_year, 
+                "sale_date" => @sale_date, 
+                "primary_genre" => @primary_genre,
+                "secondary_genre" => @secondary_genre,
+                "artist_name" => @artist_name, 
+                "label_name" => @label_name,
+                "c_copyright" => @c_copyright, 
+                "p_copyright" => @p_copyright,
+                "recording_location" => @recording_location }
+      res = req.create_album(params)
+      raise "Unexpected return type: #{res.type}" unless res.type == "album"
+      if res.status == "created"
+        @album_id = res.object.album_id
+        return true
+      else
+        @errors = res.errors
+        return false
+      end
+    end
+        
+    # Returns an array that contains every Song in this Album
+    def songs
+      raise "Album#songs is not implemented in this version of the SDK"
+    end
+    
+    # Returns the number of songs that have been created for this album
+    def song_count
+      raise "Album#song_count is not implemented in this version of the SDK"
+    end
+    
+    # Once you call Album#finalize the album will be queued for delivery to the stores.  After you call finalize you can no longer make changes to the Album.  
+    # All the songs should be created and media assets for the Album should be uploaded to S3.
+    def finalize
+      raise "Album#finalize is not implemented in this version of the SDK"
+    end
+    
+    # Returns the XML element for this Album, if it was created from the api.
+    def to_xml
+      raise "Album#to_xml is not implemented in this version of the SDK"
+    end
+      
+  end
+end

data/lib/tunecore_direct/base.rb

@@ -0,0 +1,90 @@
+module TunecoreDirect
+
+  # = TunecoreDirect
+  # TunecoreDirect is a REST/XML based web service API that allows Tunecore partners to "white label" the Tunecore
+  # media distribution platform, letting you offer Tunecore's services to your customers transparently.
+  # The web service allows a partner to:
+  # 
+  # 1. Create/Query customer accounts
+  # 2. Publish albums that belong to customer accounts
+  # 
+  # To get started with the API first obtain an API key, then have a look at these three class which you will use to interact with TuneCore:
+  # * Person
+  # * Album
+  # * Song
+  # These three classes provide all the functionality you will need to easily manage your accounts and publish albums through TuneCore.  Under the hood they use the
+  # Request and Response classes to interact with the TunecoreDirect REST API.
+  # ---
+  # === Short Example 
+  # Set up your environment:
+  #
+  #      require 'tunecore_direct'
+  #      TunecoreDirect::Base.tunecore_server = "http://localhost:3000"
+  #      TunecoreDirect::Base.api_key = "57247d992de24d7840a1b75dc2e5c30a"
+  #      request = TunecoreDirect::Request.new
+  # 
+  # Create a person:
+  #      # Make a new a person object and set all the attributes
+  #      person = TunecoreDirect::Person.new( :name => "Alex Kane", 
+  #                                          :email => "alex@gmail.com", 
+  #                                          :phone_number => "212-555-1212", 
+  #                                          :country => "United States", 
+  #                                          :postal_code => "11201" )
+  #      # Create the person on the Tunecore server
+  #      person.create
+  #      => false
+  #      # Hmm it didn't work.  Let's find out why.
+  #      person.errors
+  #      => [{:message=>"can't be blank", :attribute=>"password"}]
+  #      # Doh! We forgot to set a password.
+  #      person.password = "paSSword"
+  #      person.create
+  #      => true
+  #      # It worked, and we can now get the person_id which we will use later to create albums for this person
+  #      person.person_id
+  #      => 55342
+  #
+  # Get a list of your people:
+  #
+  #      response = request.list_people
+  #      response.status
+  #      => "complete"
+  #      response.type
+  #      => "people"
+  #      response.object.first.email
+  #      => "joe1243@blow.com"
+  #  
+  # Author:: Alex Kane (mailto:alex@tunecore.com)
+  # Copyright:: Copyright (c) 2008 Tunecore
+  # License::  GNU LPGPL
+  class TunecoreDirect::Base    
+    @@tunecore_server = nil
+    @@api_key = nil
+  
+    def self.tunecore_server=(uri)
+      @@tunecore_server = uri
+    end
+  
+    def self.tunecore_server
+      @@tunecore_server
+    end
+  
+    def tunecore_server
+      @@tunecore_server
+    end
+  
+    def self.api_key=(key)
+      @@api_key = key
+    end
+  
+    def self.api_key
+      @@api_key
+    end
+  
+    def api_key
+      @@api_key
+    end
+
+  end
+  
+end

data/lib/tunecore_direct/person.rb

@@ -0,0 +1,83 @@
+module TunecoreDirect
+
+  # Represents a individual TuneCore account
+  #
+  # Required fields are:
+  # * email
+  # * name
+  # * phone_number
+  # * postal_code
+  # * country
+  # * password
+  # 
+  # Once you set these instance variables you can call Person#create to create the account at TuneCore.  When the account is created the person_id will be 
+  # set which you should use to track the user in your system.
+  # 
+  # If you don't set these instance variables before calling Person#create the call will return false and the Person#errors accessor will be 
+  # populated with a list of errors that you will need to fix.
+  class TunecoreDirect::Person < TunecoreDirect::Base
+    include TunecoreDirect
+  
+    attr_accessor :person_id, :email, :name, :phone_number, :postal_code, :country, :password, :errors
+  
+    def initialize(options = {})
+      options.each do |k,v|
+        self.send("#{k}=", v)
+      end
+    end
+  
+    # takes an Rexml::Element and builds a person out of it
+    def self.from_xml_element(person_element)
+      @xml_element = person_element
+      person = self.new
+      person.person_id = person_element.attributes["person_id"]
+      person.email = person_element.elements["email"].text
+      person.name = person_element.elements["name"].text
+      person.phone_number = person_element.elements["phone_number"].text
+      return person
+    end
+  
+    # Returns the XML representation of this person
+    def to_xml
+      return false if @xml_element.nil?
+      @xml_element.text
+    end
+  
+    # Creates this person record in the Tunecore system
+    def create
+      req = Request.new
+      res = req.create_person(@email, @password, @name, @phone_number, @country, @postal_code)
+      raise "Unexpected return type: #{res.type}" unless res.type == "person"
+      if res.status == "complete"
+        @person_id = res.object.person_id
+        return true
+      else
+        @errors = res.errors
+        return false
+      end
+    end
+    
+    # Creates a new album for this Person
+    def create_album(params={})
+      params[:person_id] = self.person_id
+      album = TunecoreDirect::Album.new(params)
+      album.create
+      return album
+    end
+  
+    # Returns an array of people associated with your account
+    def self.get_people
+      req = Request.new
+      req.get_people.object
+    end
+    
+    # Returns an array of albums owned by this person
+    def albums
+      req = Request.new
+      req.get_albums(person_id).object
+    end
+    
+    
+    
+  end
+end