yesradio 0.1.3

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+doc/*
+pkg/**/*

data/LICENSE

@@ -0,0 +1,6 @@
+Copyright (c) 2009 Claudio Baccigalupo
+
+Copying and distribution of this file, with or without modification,
+are permitted in any medium without royalty provided the copyright
+notice and this notice are preserved.  This file is offered as-is,
+without any warranty.

data/README.md

@@ -0,0 +1,78 @@
+# YesRadio #
+
+Ruby gem to access Yes.com API
+
+## Installation ##
+
+    sudo gem install claudiob-yesradio -s http://gems.github.com
+
+## Documentation ##
+
+http://rdoc.info/projects/claudiob/yesradio
+
+## Examples ##
+
+### To show a list of 'Rock' stations ###
+
+    require 'yesradio'
+    Yesradio::search_stations :match => "Rock"
+
+### To show details of 'WFNX' radio ###
+
+    require 'yesradio'
+    Yesradio::get_station :name => "WFNX"
+
+### To show log of tracks played on 'WFNX' radio ###
+
+    require 'yesradio'
+    Yesradio::get_log :name => "WFNX"
+
+### To show recent tracks played on 'WFNX' radio ###
+
+    require 'yesradio'
+    Yesradio::get_recent :name => "WFNX"
+
+### To show a chart of popular Rock songs ###
+
+    require 'yesradio'
+    Yesradio::get_chart :genre => "Rock"
+
+### To show a list of songs by artist Rihanna ###
+
+    require 'yesradio'
+    Yesradio::get_media :aid => 610471
+
+### To show a list of songs related to Umbrella (Rihanna) ###
+
+    require 'yesradio'
+    Yesradio::get_related :mid => 11586843
+
+
+## History ##
+
+v0.1.3  2009/09/29
+        Fixed wrong example in README
+
+v0.1.2  2009/09/17
+        Changed REXML with Nokogiri for XML parsing
+
+v0.1.1  2009/09/15
+        Fixed bug that made gem unusable (required inexistent file)
+
+v0.1.0  2009/09/15
+        First release with all the actions and documentation on rdoc.info
+
+v0.0.2  2009/09/15
+        Added support for actions: chart, media, related.
+        Added documentation through RDoc.
+        Added cucumber features for listing stations.
+
+v0.0.1  2009/09/15
+        Added support for actions: log, recent.
+
+v0.0.0  2009/09/14
+        Added support for actions: station, stations
+
+## Copyright ##
+
+Copyright (c) 2009 Claudio Baccigalupo. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,72 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "yesradio"
+    gem.summary = %Q{Ruby library for Yes.com radio Web Services (http://api.yes.com).}
+    gem.description = %Q{YesRadio makes available as a ruby gem the method exposed by Yes.com API to retrieve songs broadcast by thousands of radios.}
+    gem.email = "claudiob@gmail.com"
+    gem.homepage = "http://github.com/claudiob/yesradio"
+    gem.authors = ["Claudio Baccigalupo"]
+    gem.rubyforge_project = "yesradio"
+    gem.add_development_dependency "cucumber"
+    gem.add_dependency "nokogiri", ">=1.3.2"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "rdoc"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+
+  task :features => :check_dependencies
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "yesradio #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.3

data/features/step_definitions/yesradio_steps.rb

@@ -0,0 +1,17 @@
+Given /^nothing$/ do
+  
+end
+
+When /^I look for ([0-9]+) stations called "([^\"]*)"$/ do |max, match|
+  @stations = Yesradio::search_stations :match => match, :max => max
+end
+
+Then /^I should see a radio with name "([^\"]*)" and market "([^\"]*)"$/ do |name, market|
+  @stations.collect do |station| 
+    station.name == name && station.market == market
+  end.inject{ |sum, el| sum || el }.should be_true
+end
+
+Then /^I should see nothing$/ do
+  @stations.should be_nil
+end

data/features/support/env.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'yesradio'
+
+require 'test/unit/assertions'
+
+World(Test::Unit::Assertions)

data/features/yesradio.feature

@@ -0,0 +1,14 @@
+Feature: Call Yes.com API using Ruby
+  In order to retrieve Yes.com data in Ruby code
+  programmers
+  want a Ruby interface to Yes.com API
+
+  Scenario: List Stations
+    Given nothing
+    When I look for 10 stations called "KEXP"
+    Then I should see a radio with name "KEXP" and market "Seattle - Tacoma, WA"
+
+  Scenario: List Stations Empty
+    Given nothing
+    When I look for 10 stations called "ABCDEFGH"
+    Then I should see nothing

data/lib/item.rb

@@ -0,0 +1,36 @@
+# Author::    Claudio Baccigalupo
+# Copyright:: Copyright (c) 2009 - see LICENSE file
+
+require 'date'
+
+module Yesradio
+  class Item
+    class << self
+      attr_accessor :elements 
+    end
+    
+    def initialize(element = nil)
+      self.class.elements.each do |name, type|
+        new_value = get_element_child element, name.gsub('_', '/'), type
+        self.instance_variable_set("@#{name}", new_value) unless new_value.nil?
+      end
+    end
+
+    private
+
+    def get_element_child(element, child, type = :text)
+      return if element.nil? || element.xpath(child).empty?
+      child = element.xpath(child).text.to_s
+      return case type
+        when :int then child.to_i
+        when :float then child.to_f 
+        when :datetime then DateTime.parse(child)
+        else child
+      end
+
+    end
+
+  end
+end
+
+

data/lib/main.rb

@@ -0,0 +1,7 @@
+# Author::    Claudio Baccigalupo
+# Copyright:: Copyright (c) 2009 - see LICENSE file
+
+require 'yesradio'
+
+# TODO: a file that prompts the user for the action to take
+# and the parameters, and returns the result (as a shell command)

data/lib/song.rb

@@ -0,0 +1,15 @@
+# Author::    Claudio Baccigalupo
+# Copyright:: Copyright (c) 2009 - see LICENSE file
+
+require 'item'
+module Yesradio
+  class Song < Item
+    @elements = {'at' => :datetime, 'by' => :text, 'title' => :text, 
+                  'id' => :int, 'type' => :text, 'rank' => :int, 
+                  'cover' => :text, 'video' => :text, 'link' => :text,
+                  'ago' => :int}
+    attr_accessor *@elements.keys
+  end
+end
+
+

data/lib/station.rb

@@ -0,0 +1,16 @@
+# Author::    Claudio Baccigalupo
+# Copyright:: Copyright (c) 2009 - see LICENSE file
+
+require 'item'
+module Yesradio
+  class Station < Item
+    @elements = {'name' => :text, 'desc' => :text, 'genre' => :text, 
+                  'market' => :text, 'type' => :text, 'id' => :int, 
+                  'tz' => :text, 'stream' => :text, 'yes' => :text, 
+                  'relay' => :text, 'audiostream' => :text, 'array_id' => :int,
+                  'array_song' => :text, 'array_artist' => :text}
+    attr_accessor *@elements.keys
+  end
+end
+
+

data/lib/yesradio.rb

@@ -0,0 +1,148 @@
+# Author::    Claudio Baccigalupo
+# Copyright:: Copyright (c) 2009 - see LICENSE file
+
+require 'cgi'
+require 'net/http'
+require 'nokogiri'
+
+require 'station'
+require 'song'
+
+module Yesradio
+  
+  YESRADIO_VERSION = 1
+  YESRADIO_SERVER = "http://api.yes.com/#{YESRADIO_VERSION}"
+
+  # Get current information about a single station including now playing song, 
+  # slogan, frequency, market, and links to any known webcast stream or site.
+  #
+  # == Parameters
+  # [+name+] The station name (for AM/FM it is just the call letters).
+  #
+  # == Examples
+  #     get_station :name => "KEXP"
+  #--
+  def self.get_station(query_hash)
+    array = self.search('Station', "station", "//api", query_hash)
+    array[0] unless array.nil? || array[0].name.nil?
+  end
+
+  # Search and find a list of stations by name, frequency, genre, artist, 
+  # or location.
+  #
+  # == Parameters
+  # [+match+] [optional] Used to search station names, call letters, slogans, frequency, or cities/states.
+  # [+freq+] [optional] Also match an exact AM/FM frequency.
+  # [+mid+] [optional] Also match only stations that have this media id (see #media call) in their top 100 charts.
+  # [+genre+] [optional] Also match any genre keywords like pop, rock, etc.
+  # [+loc+] [optional] Also match stations within 60 miles of the given zip code, "lat,lon", or city/state names.
+  # [+max+] [optional] Defaults to 10 stations returned.
+  #
+  # == Examples
+  #     search_stations :match => "KEX"
+  #--
+  def self.search_stations(query_hash)
+    self.search('Station', "stations", "//api/array/stations", query_hash)
+  end
+
+  # Get the log of all the songs played on the given station in a selected day 
+  # within the last week. 
+  #
+  # == Parameters
+  # [+name+] The station name.
+  # [+ago+] [optional] The days ago from now for the given date you want, an integer from 0-6 and defaults to 0 (the log today so far).
+  #
+  # == Examples
+  #     get_log :name => "KEXP", :ago => 3
+  #--
+  def self.get_log(query_hash)
+    self.search('Song', "log", "//api/array/songs", query_hash)
+  end
+
+  # Get the most recent songs played on any station.
+  #
+  # == Parameters
+  # [+name+] The station name.
+  # [+max+] How many recent songs to return (default is 10).
+  #
+  # == Examples
+  #     get_recent :name => "KEXP", :max => 3
+  #--
+  def self.get_recent(query_hash)
+    self.search('Song', "recent", "//api/array/songs", query_hash)
+  end
+
+  # Get the current top 100 songs for any station based on number of times 
+  # played and user voting (calculated daily).
+  #
+  # == Parameters
+  # [+name+] [optional] The station name, defaults to US national top 100 if none given.
+  # [+date+] [optional] Return just the charts from a specific date in the format year-mm-dd (April 2008 and newer).
+  # [+genre+] [optional] Filter any request to a specific Genre ( Americana Blues Christian Classical Country Electronica Hip-Hop Jazz Latin Metal New Age Pop Punk R&B/Soul Rock Smooth Jazz World ).
+  # [+hot+] [optional] Alternative sorting, must be either "fresh" (by most increase in charts day-to-day, not supported in combination with date field) or "vote" (most votes via yes.com).
+  # [+max+] How many songs to return (default is 10).
+  #
+  # == Examples
+  #     get_chart :genre => "Rock"
+  #--
+  def self.get_chart(query_hash)
+    self.search('Song', "chart", "//api/array/songs", query_hash)
+  end
+
+  # Get a list of any matching artist names or song titles based on airtime 
+  # popularity.
+  #
+  # == Parameters
+  # [+q+] The string to search with, can be partial (used for autocomplete) or full names.
+  # [+aid+] [optional] Instead of a general query, a known Artist ID can be passed to return just media from that artist.
+  # [+mid+] [optional] Instead of a general query, a known Media ID can be passed to return extra information (lyrics from Lyric Wiki and matching videos from YouTube and MTV) about just that song.
+  # [+max+] How many songs to return (default is 10, max is 50).  
+  #
+  # == Examples
+  #     get_media :aid => 610471
+  #--
+  # Run test with http://api.yes.com/1/media?mid=12812281&type=xml
+  # which returns an XML error (Yes.com's fault)
+  def self.get_media(query_hash)
+    self.search('Song', "media", "//api/array/songs", query_hash)
+  end
+
+  # Given a song, return a list of related songs based on airtime in the last 
+  # week.
+  #
+  # == Parameters
+  # [+mid+] The media ID (use media call to search for IDs).
+  # [+max+] Maximum number of related songs to return (default is 20).
+  #
+  # == Examples
+  #     get_related :mid => 11586843
+  #--
+  def self.get_related(query_hash)
+    self.search('Song', "related", "//api/array/songs", query_hash)
+  end
+
+  protected
+  
+  def self.search(item_class, action, xml_element, query_hash)
+    url = create_url(action, query_hash)
+    uri = URI.parse(url)
+    req = Net::HTTP::Get.new(uri.path + '?' + uri.query)
+    res = Net::HTTP.start(uri.host, uri.port) { |http|
+      http.request(req)
+    }
+    doc = Nokogiri::XML res.body
+    return if doc.xpath(xml_element).empty?
+    doc.xpath(xml_element).collect do |element|    
+      eval "Yesradio::#{item_class}.new(element)"
+    end
+  end
+  
+  def self.create_url(action, query_hash)
+    url = Yesradio::YESRADIO_SERVER + "/#{action}?type=xml"
+    query_hash.each do |name, value|
+      url = url + "&#{name}=" + CGI::escape(value.to_s) unless value.nil?  
+    end
+    url
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'yesradio'
+
+class Test::Unit::TestCase
+end

data/test/yesradio_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class YesradioTest < Test::Unit::TestCase
+  def test_something_for_real
+    assert true
+  end
+end

data/yesradio.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{yesradio}
+  s.version = "0.1.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Claudio Baccigalupo"]
+  s.date = %q{2009-09-29}
+  s.description = %q{YesRadio makes available as a ruby gem the method exposed by Yes.com API to retrieve songs broadcast by thousands of radios.}
+  s.email = %q{claudiob@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "features/step_definitions/yesradio_steps.rb",
+     "features/support/env.rb",
+     "features/yesradio.feature",
+     "lib/item.rb",
+     "lib/main.rb",
+     "lib/song.rb",
+     "lib/station.rb",
+     "lib/yesradio.rb",
+     "test/test_helper.rb",
+     "test/yesradio_test.rb",
+     "yesradio.gemspec"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/claudiob/yesradio}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{yesradio}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Ruby library for Yes.com radio Web Services (http://api.yes.com).}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/yesradio_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 1.3.2"])
+    else
+      s.add_dependency(%q<cucumber>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 1.3.2"])
+    end
+  else
+    s.add_dependency(%q<cucumber>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 1.3.2"])
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: yesradio
+version: !ruby/object:Gem::Version 
+  version: 0.1.3
+platform: ruby
+authors: 
+- Claudio Baccigalupo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-29 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.2
+    version: 
+description: YesRadio makes available as a ruby gem the method exposed by Yes.com API to retrieve songs broadcast by thousands of radios.
+email: claudiob@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- features/step_definitions/yesradio_steps.rb
+- features/support/env.rb
+- features/yesradio.feature
+- lib/item.rb
+- lib/main.rb
+- lib/song.rb
+- lib/station.rb
+- lib/yesradio.rb
+- test/test_helper.rb
+- test/yesradio_test.rb
+- yesradio.gemspec
+has_rdoc: true
+homepage: http://github.com/claudiob/yesradio
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: yesradio
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Ruby library for Yes.com radio Web Services (http://api.yes.com).
+test_files: 
+- test/test_helper.rb
+- test/yesradio_test.rb