claudiob-yesradio 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+.DS_Store

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,22 @@
+# YesRadio #
+
+Ruby gem to access Yes.com API
+
+<a name="rubygem_install" />
+## Installation ##
+
+    sudo gem install yesradio -s http://gems.github.com
+
+## Examples ##
+
+### To show a list of 'Rock' stations ###
+
+    require 'yesradio'
+    query = Yesradio::StationsSearchCriteria.new
+    query.match = "KWOF"
+    result = Yesradio::search_stations query  
+
+### To show details of 'WFNX' radio ###
+
+    require 'yesradio'
+    Yesradio::match_station "WFNX"

data/Rakefile

@@ -0,0 +1,71 @@
+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 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.0.1

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,9 @@
+Feature: something something
+  In order to something something
+  A user something something
+  something something something
+
+  Scenario: something something
+    Given inspiration
+    When I create a sweet new gem
+    Then everyone should see how awesome I am

data/lib/main.rb

@@ -0,0 +1,24 @@
+#=============================================================================
+#
+# 2009 Claudio Baccigalupo
+#
+# Licensed under the Ruby License
+#
+#=============================================================================
+
+require 'yesradio'
+
+# get the list of radio stations
+query = Yesradio::StationsSearchCriteria.new
+query.match = "KWOF"
+stations = Yesradio::search_stations query  
+p stations
+
+# get the details of a radio station
+Yesradio::match_station "WFNX"
+
+# get the log of songs played on a radio
+Yesradio::get_log "KEXP"
+
+# get the recent songs played on a radio
+Yesradio::get_recent "KEXP"

data/lib/song.rb

@@ -0,0 +1,21 @@
+#=============================================================================
+#
+# 2009 Claudio Baccigalupo
+#
+# Licensed under the Ruby License
+#
+#=============================================================================
+
+module Yesradio
+  class Song
+    @@elements = {'at' => :datetime, 'by' => :text, 'title' => :text, 
+                  'id' => :int, 'type' => :text, 'rank' => :int, 
+                  'cover' => :text, 'video' => :text, 'ago' => :int}
+    attr_accessor *@@elements.keys
+    def elements
+      @@elements
+    end  
+  end
+end
+
+

data/lib/station.rb

@@ -0,0 +1,23 @@
+#=============================================================================
+#
+# 2009 Claudio Baccigalupo
+#
+# Licensed under the Ruby License
+#
+#=============================================================================
+
+module Yesradio
+  class Station
+    @@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
+    def elements
+      @@elements
+    end  
+  end
+end
+
+

data/lib/stations_search_criteria.rb

@@ -0,0 +1,33 @@
+#=============================================================================
+#
+# 2009 Claudio Baccigalupo
+#
+# Licensed under the Ruby License
+#
+#=============================================================================
+
+module Yesradio
+  class StationsSearchCriteria
+
+    attr_accessor :match, :freq, :mid, :genre, :loc, :max
+  
+    def initialize(options = {})
+      options.each do |key, value|
+        eval("@#{key} = '#{value.to_s}'")
+      end
+    end
+
+    def to_query_params_string
+      url = ''
+      url = url + "&match=" + CGI::escape(@match) if !@match.nil?
+      url = url + "&freq=" + CGI::escape(@freq) if !@freq.nil? 
+      url = url + "&mid=" + CGI::escape(@mid.to_s) if !@mid.nil?
+      url = url + "&genre=" + CGI::escape(@genre) if !@genre.nil?
+      url = url + "&loc=" + CGI::escape(@loc) if !@loc.nil?
+      url = url + "&max=" + CGI::escape(@max.to_s) if !@max.nil? 
+      url
+    end
+  end
+end
+
+

data/lib/yesradio.rb

@@ -0,0 +1,122 @@
+#=============================================================================
+#
+# 2009 Claudio Baccigalupo
+#
+# Licensed under the Ruby License
+#
+#=============================================================================
+
+require 'cgi'
+require 'net/http'
+require 'rexml/document'
+require 'date'
+
+require 'station'
+require 'stations_search_criteria'
+require 'song'
+
+module Yesradio
+  
+  YESRADIO_VERSION = 1
+  YESRADIO_SERVER = "http://api.yes.com/#{YESRADIO_VERSION}"
+
+  def self.element_to_station(element)
+    station = Station.new
+    station.elements.each do |name, type|
+      new_value = get_element_child element, name.gsub('_', '/'), type
+      station.instance_variable_set("@#{name}", new_value) unless new_value.nil?
+    end
+    station
+  end
+
+  # TO DO, dry with the previous function
+  def self.element_to_song(element)
+    song = Song.new
+    song.elements.each do |name, type|
+      new_value = get_element_child element, name.gsub('_', '/'), type
+      song.instance_variable_set("@#{name}", new_value) unless new_value.nil?
+    end
+    song
+  end
+
+  def self.search_stations(search_criteria)
+    stations = Array.new
+
+    url = Yesradio::YESRADIO_SERVER + "/stations?type=xml"
+    url = url + search_criteria.to_query_params_string
+    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 = REXML::Document.new res.body
+    doc.elements.each("//api/array/stations") do |element|
+      stations << element_to_station(element)
+    end
+    stations
+  end
+
+  def self.get_station(station_name)
+    url = Yesradio::YESRADIO_SERVER + "/station?type=xml"
+    url = url + "&name=" + CGI::escape(station_name)
+    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 = REXML::Document.new res.body
+    element_to_station(doc.elements["//api"])
+  end
+
+  def self.get_log(station_name, ago = nil)
+    songs = Array.new
+    
+    url = Yesradio::YESRADIO_SERVER + "/log?type=xml"
+    url = url + "&name=" + CGI::escape(station_name)
+    url = url + "&ago=" + CGI::escape(ago.to_s) unless ago.nil?
+    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 = REXML::Document.new res.body
+    doc.elements.each("//api/array/songs") do |element|
+      songs << element_to_song(element)
+    end
+    songs
+  end
+
+  def self.get_recent(station_name, max = nil)
+    songs = Array.new
+    
+    url = Yesradio::YESRADIO_SERVER + "/recent?type=xml"
+    url = url + "&name=" + CGI::escape(station_name)
+    url = url + "&max=" + CGI::escape(max.to_s) unless max.nil?
+    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 = REXML::Document.new res.body
+    doc.elements.each("//api/array/songs") do |element|
+      songs << element_to_song(element)
+    end
+    songs
+  end
+
+  protected
+
+  def self.get_element_child(element, child, type = :text)
+    return if element.elements[child].nil?
+    child = element.elements[child][0].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
+

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,61 @@
+# 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.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Claudio Baccigalupo"]
+  s.date = %q{2009-09-15}
+  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/main.rb",
+     "lib/song.rb",
+     "lib/station.rb",
+     "lib/stations_search_criteria.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"])
+    else
+      s.add_dependency(%q<cucumber>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<cucumber>, [">= 0"])
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: claudiob-yesradio
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Claudio Baccigalupo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-15 00:00:00 -07: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: 
+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/main.rb
+- lib/song.rb
+- lib/station.rb
+- lib/stations_search_criteria.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