dada 0.0.1

data/CHANGELOG

@@ -0,0 +1,4 @@
+= 0.1
+=== 24th May, 2008
+
+Initial release of the dada ruby library.

data/README

@@ -0,0 +1,7 @@
+= dada - A ruby interface to the Dada Entertainment API
+
+This library will allow you to easily interface with the Dada Entertainment API, through ruby.
+
+= Author
+
+Copyright (c) 2008 by Edward Waller

data/lib/dada.rb

@@ -0,0 +1,7 @@
+require 'net/http'
+require 'uri'
+require 'cgi'
+require 'rexml/document'
+require 'dada/dada_result'
+require 'dada/dada_results'
+require 'dada/dada_searcher'

data/lib/dada/dada_result.rb

@@ -0,0 +1,47 @@
+module Dada
+  class DadaResult
+    def initialize(xml)
+      @xml = xml
+      @result = xml
+    end
+
+    attr_reader :xml
+  
+    def content_id
+      @result.elements['contentId'].text
+    end
+  
+    def title
+      @result.elements['title'].text
+    end
+  
+    def artist_id
+      @result.elements['artistId'].text
+    end
+  
+    def artist
+      @result.elements['artist'].text
+    end
+  
+    def artist_url
+      @result.elements['artisturl'].text
+    end
+  
+    def landing_page_artist_url
+      @result.elements['landingpageartisturl'].text
+    end
+  
+    def landing_page_content_url
+      @result.elements['landingpagecontenturl'].text
+    end
+  
+    def preview_url
+      @result.elements['previewURL'].text
+    end
+  
+    def image_medium_url
+      @result.elements['imageMediumURL'].text
+    end
+  
+  end
+end

data/lib/dada/dada_results.rb

@@ -0,0 +1,40 @@
+module Dada
+  class DadaResults < Array
+    # Returns a ruby representation of dada search results.
+    def initialize(xml)
+      @xml = xml
+      doc = REXML::Document.new(xml)
+      @response = doc.root
+      @results = []
+      @response.elements.each('results/result') do |result|
+        self << DadaResult.new(result)
+      end
+    end
+  
+    attr_reader :xml
+  
+    def artist
+      @response.elements['searchRequest/artist'].text
+    end
+  
+    def query_duration
+      @response.elements['searchRequest/queryDuration'].text.to_f
+    end
+  
+    def url_path
+      @response.elements['searchRequest/urlPath'].text
+    end
+  
+    def content_types
+      @response.elements['searchRequest/contentTypes'].text.split('|')
+    end
+  
+    def total_result_count
+      @response.elements['searchRequest/totalResultCount'].text.to_i
+    end
+  
+    def status
+      @response.elements['status'].text
+    end
+  end
+end

data/lib/dada/dada_searcher.rb

@@ -0,0 +1,84 @@
+module Dada
+  class DadaSearcher
+    # Returns a new DadaSearcher object, with the specified api key, and optional partner key
+    def initialize(api_key, partner_key = nil)
+      @api_key = api_key
+      @partner_key = partner_key
+    end
+
+    attr_accessor :partner_key, :api_key
+
+    # Builds the url needed to make the api request.
+    def build_url(opts)
+      opts = setup_opts(opts)
+      url = URI.parse('http://api.dada-ent.com/')
+      url += 
+        if opts[:artist] and opts[:title]
+          "/search/artist/#{opts[:artist]}/title/#{opts[:title]}/"
+        elsif opts[:artist]
+          "/search/artist/#{opts[:artist]}/"
+        elsif opts[:title]
+          "/search/title/#{opts[:title]}/"
+        elsif opts[:keywords]
+          "/keywords/#{opts[:keywords].join('+')}/"
+        elsif opts[:category]
+          "/chart/category/#{opts[:category]}/"
+        end
+      url += "contenttypes/#{opts[:content_types].join('%7C')}/" if opts[:content_types]
+      url += "numresults/#{opts[:num_results]}/"                 if opts[:num_results]
+      url += "start/#{opts[:start]}/"                            if opts[:start]
+      url += "partner/#{opts[:partner_key]}/"                    if opts[:partner_key]
+    
+      url
+    end
+  
+    # Searches the Dada network for ringtones.
+    #
+    # Options are:
+    # * :artist - a musical artist
+    # * :title - title of a song
+    # * :keywords - an array of keywords to use
+    # * :category - the musical category the ringtone would be under
+    # * :content_types - an array of content types to search for (mp3, real, etc)
+    # * :num_results - the number of results you would like to receive
+    # * :start - the start index of the results
+    # * :partner_key - your partner key
+    #
+    # Examples:
+    #  searcher = DadaSearcher.new('my-api-key')
+    #
+    #  # find all ringtones with justin timberlake songs
+    #  searcher.search(:artist => 'justin timberlake')
+    #
+    #  # find the ringtone for justin timberlake's song "rock your body"
+    #  searcher.search(:artist => 'justin timberlake', :title => 'Rock Your Body')
+    #
+    #  # find the ringtones for the top rock songs on the chart
+    #  searcher.search(:category => 'rock')
+    #
+    #  # find all real and mp3 ringtones by justin timberlake
+    #  searcher.search(:artist => 'justin timberlake', :content_types => ['real', 'mp3'])
+    def search(opts)
+      url = build_url(opts)
+      response = Net::HTTP.start(url.host) do |http|
+        http.get(url.path, 'API-Key' => @api_key)
+      end
+    
+      DadaResults.new(response.body)
+    end
+  
+    private
+    
+    # Sets up the options for use by the url builder
+    def setup_opts(opts)
+      opts[:partner_key] ||= @partner_key if @partner_key
+      opts.each do |key, value|
+        if key == :keywords or  key == :content_types
+          opts[key] = value.map { |x| CGI::escape(x) }
+        else
+          opts[key] = CGI::escape(value)
+        end
+      end
+    end
+  end
+end

data/spec/dada_result_spec.rb

@@ -0,0 +1,45 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+include Dada
+
+describe DadaResult do
+  setup do
+    xml = File.read("spec/chris_brown.xml")
+    @result = DadaResults.new(xml).first
+  end
+  
+  it "should have the correct content id" do
+    @result.content_id.should == '90563'
+  end
+  
+  it "should have the correct artist id" do
+    @result.artist_id.should == '430'
+  end
+  
+  it "should have the correct title" do
+    @result.title.should == 'Take You Down'
+  end
+  
+  it "should have the correct artist" do
+    @result.artist.should == 'Chris Brown'
+  end
+  
+  it "should have the correct artist url" do
+    @result.artist_url.should == 'http://us.dada.net/music/chrisbrown/'
+  end
+  
+  it "should have the correct landing page artist url" do
+    @result.landing_page_artist_url.should == 'http://us.sso.dada.net/landing.php?artist=Chris+Brown&partner=XXX&artisturl=http://us.dada.net/music/chrisbrown/'
+  end
+  
+  it "should have the correct landing page content url" do
+    @result.landing_page_content_url.should == 'http://us.sso.dada.net/landing.php?artist=Chris+Brown&partner=XXX&contentID=90563&artisturl=http://us.dada.net/music/chrisbrown/'
+  end
+  
+  it "should have the correct image (medium) url" do
+    @result.image_medium_url.should == 'http://preview.dada.net/mobi/9/0/5/90563/90563_m.gif'
+  end
+  
+  it "should have the correct mp3 preview url" do
+    @result.preview_url.should == 'http://preview.dada.net/mobi/9/0/5/90563/90563_20.mp3'
+  end
+end

data/spec/dada_results_spec.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+include Dada
+
+describe DadaResults do
+  setup do
+    xml = File.read("spec/chris_brown.xml")
+    @results = DadaResults.new(xml)
+  end
+  
+  it "should have the correct artist" do
+    @results.artist.should == 'chris brown'
+  end
+  
+  it "should have the correct status" do
+    @results.status.should == 'success'
+  end
+  
+  it "should have the correct query duration" do
+    @results.query_duration.should == 0.0037
+  end
+  
+  it "should have the correct url path" do
+    @results.url_path.should == '/search/artist/chris brown/contenttypes/mp3|real/'
+  end
+  
+  it "should have the correct content types" do
+    @results.content_types.should == ['mp3', 'real']
+  end
+  
+  it "should have the correct total result count" do
+    @results.total_result_count.should == 10
+  end
+  
+  it "should have the same number of results as specified" do
+    @results.total_result_count.should == @results.size
+  end
+  
+end

data/spec/dada_searcher_spec.rb

@@ -0,0 +1,79 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+include Dada
+
+describe DadaSearcher do
+  setup do
+    @dada = DadaSearcher.new('')
+  end
+  describe "building urls" do
+    it "should work with an artist" do
+      @dada.build_url(:artist => 'justin timberlake').to_s.should ==
+        'http://api.dada-ent.com/search/artist/justin+timberlake/'
+    end
+  
+    it "should work with an artist and title" do
+      @dada.build_url(:artist => 'justin timberlake', :title => 'cry me a river').to_s.should ==
+        'http://api.dada-ent.com/search/artist/justin+timberlake/title/cry+me+a+river/'
+    end
+  
+    it "should work with a title" do
+      @dada.build_url(:title => 'cry me a river').to_s.should ==
+        'http://api.dada-ent.com/search/title/cry+me+a+river/'
+    end
+  
+    it "should work with a single keyword" do
+      @dada.build_url(:keywords => ['justin']).to_s.should ==
+        'http://api.dada-ent.com/keywords/justin/'
+    end
+  
+    it "should work with multiple keywords" do
+      @dada.build_url(:keywords => %w{justin timberlake}).to_s.should ==
+        'http://api.dada-ent.com/keywords/justin+timberlake/'
+    end
+  
+    it "should work with categories" do
+      @dada.build_url(:category => 'rock').to_s.should ==
+        'http://api.dada-ent.com/chart/category/rock/'
+    end
+  
+    it "should work with a single content type" do
+      @dada.build_url(:artist => 'justin timberlake', :content_types => ['mp3']).to_s.should ==
+        'http://api.dada-ent.com/search/artist/justin+timberlake/contenttypes/mp3/'
+    end
+  
+    it "should work with multiple content types" do
+      @dada.build_url(:artist => 'justin timberlake', :content_types => ['mp3', 'real']).to_s.should ==
+        'http://api.dada-ent.com/search/artist/justin+timberlake/contenttypes/mp3%7Creal/'
+    end
+  
+    it "should work with a start index" do
+      @dada.build_url(:artist => 'justin timberlake', :start => '5').to_s.should ==
+        'http://api.dada-ent.com/search/artist/justin+timberlake/start/5/'
+    end
+  
+    it "should work with a specified number of results" do
+      @dada.build_url(:artist => 'justin timberlake', :num_results => '5').to_s.should ==
+        'http://api.dada-ent.com/search/artist/justin+timberlake/numresults/5/'
+    end
+    
+    it "should work with a specified number of results and a start index" do
+      
+        @dada.build_url(:artist => 'justin timberlake', :num_results => '5', :start => '10').to_s.should ==
+          'http://api.dada-ent.com/search/artist/justin+timberlake/numresults/5/start/10/'
+    end
+  
+    it "should work with a specified partner id" do
+      @dada.build_url(:artist => 'justin timberlake', :partner_key => '12345').to_s.should ==
+        'http://api.dada-ent.com/search/artist/justin+timberlake/partner/12345/'
+    end
+    
+    it "should override the partner key if specified" do
+      @dada.partner_key = '54321'
+      @dada.build_url(:artist => 'justin timberlake').to_s.should ==
+        'http://api.dada-ent.com/search/artist/justin+timberlake/partner/54321/'
+      @dada.build_url(:artist => 'justin timberlake', :partner_key => '12345').to_s.should ==
+        'http://api.dada-ent.com/search/artist/justin+timberlake/partner/12345/'
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
+require 'dada'

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: dada
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Edward Waller
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-24 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/dada/dada_result.rb
+- lib/dada/dada_results.rb
+- lib/dada/dada_searcher.rb
+- lib/dada.rb
+- spec/dada_result_spec.rb
+- spec/dada_results_spec.rb
+- spec/dada_searcher_spec.rb
+- spec/spec_helper.rb
+- README
+- CHANGELOG
+has_rdoc: true
+homepage: http://wallerdev.com/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: dada
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: A library for interfacing with the Dada Entertainment API.
+test_files: []
+