blipfm 0.1.0

data/README.txt

@@ -0,0 +1,47 @@
+= Blip.fm API for Ruby
+
+Published by Chris Koehler under the Ruby License.
+For information see http://rubyforge.org/projects/blipfm/
+
+== DESCRIPTION:
+
+A ruby library for the Blip.fm API. Developed to facilitate the development of Blip.fm (social media service centered around music) applications in ruby.
+
+== FEATURES:
+
+- Ruby implementation of the Blip.fm API: http://api.blip.fm/
+
+== GETTING STARTED:
+
+* Add your Blip.fm developer key and secret key to config.yml
+
+== KNOWN ISSUES:
+
+- Missing save preferences method
+
+== INSTALL:
+
+sudo gem install blipfm
+
+== LICENSE:
+
+Copyright (c) 2009 Chris Koehler 
+
+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/lib/blipfm.rb

@@ -0,0 +1,304 @@
+require 'rubygems'
+require 'uuid'
+require 'hmac-sha1'
+require 'base64'
+require 'cgi'
+require 'net/http'
+require 'uri'
+require 'rexml/document'
+
+def if_nill(input_string, nill_string = '')
+  if (input_string.nil?)
+    return nill_string
+  else
+    return input_string
+  end
+end
+
+module BlipFm
+  
+  CONFIG = YAML.load_file('config.yml')
+  
+  def BlipFm.generate_blip_nonce()
+    return UUID.generate().gsub('-', '')
+  end
+  
+  def BlipFm.blip_signature(blip_method, blip_timestamp, blip_nonce)
+    blip_data = blip_method + "\n" + blip_timestamp.to_s + "\n" + blip_nonce
+    CGI.escape(Base64.encode64(HMAC::SHA1.digest(CONFIG['blip_secret_key'], blip_data)).strip)
+  end
+  
+  def BlipFm.execute_blip_method(blip_method, require_key, require_auth, parameter_hash = nil, require_user_auth = false, blip_user_name = '', blip_user_password = '', request_type = 'GET')
+    # INIT URL
+    blip_url = '/' + blip_method + '.xml?a=1'
+    if (require_key)
+      blip_url += '&apiKey=' + CONFIG['blip_api_key']
+    end
+    
+    # SIGN REQUEST
+    if (require_auth)
+      blip_nonce = generate_blip_nonce()
+      blip_timestamp = get_blip_timestamp()
+      blip_url += '&nonce=' + blip_nonce
+      blip_url += '&timestamp=' + blip_timestamp
+      blip_url += '&signature=' + blip_signature(request_type, blip_timestamp, blip_nonce)
+    end
+    
+    # ADD PARAMETERS TO URL IF GET
+    if ((!parameter_hash.nil?) && (request_type == 'GET'))
+      parameter_hash.each do |blip_parameter, blip_value|
+        blip_url += '&' + blip_parameter + '=' + CGI.escape(blip_value.to_s)
+      end
+    end
+  
+    # PROCESS REQUEST
+    Net::HTTP.start(CONFIG['blip_base_url']) {|http|
+      request = nil
+      if (request_type == 'GET')
+        request = Net::HTTP::Get.new(blip_url)
+      else
+        request = Net::HTTP::Post.new(blip_url)
+        request.set_form_data(parameter_hash)
+      end
+      if (require_user_auth)
+        request.basic_auth blip_user_name, blip_user_password
+      end
+      response = http.request(request)
+      response_xml = response.body
+      return response.body
+    }
+  end
+  
+  def BlipFm.create_blip_array(blip_xml, object_type = 'Blip')
+    blip_array = []
+    blip_collection_xml = REXML::Document.new(blip_xml).elements['BlipApiResponse/result/collection']
+    blip_collection_xml.elements.each(object_type) do |current_blip_xml|
+      case (object_type)
+        when 'Song'
+          blip_array << Song.create_by_xml(current_blip_xml)
+        when 'user', 'User'
+          blip_array << User.create_by_xml(current_blip_xml)
+        else
+          blip_array << Blip.create_by_xml(current_blip_xml)
+      end
+    end
+    return blip_array
+  end
+  
+  def BlipFm.delete_blip(user_name, user_password, blip_id)
+    return execute_blip_method('blip/delete', true, true, {'id' => blip_id}, true, user_name, user_password, 'POST')
+  end
+    
+  def BlipFm.get_blips(blip_id_array)
+    return create_blip_array(execute_blip_method('blip/getById', false, false, {'id' => blip_id_array.join(',')}))
+  end
+  
+  def BlipFm.get_public_stream(last_blip_timestamp = 0, offset_blip_id = 0, blip_limit = 25)
+    return create_blip_array(execute_blip_method('blip/getPublic', true, true, {'ts' => last_blip_timestamp, 'offset' => offset_blip_id, 'limit' => blip_limit}))
+  end
+  
+  def BlipFm.get_user_home(blip_user_name, blip_password, last_blip_timestamp = 0, offset_blip_id = 0, blip_limit = 25)
+    return create_blip_array(execute_blip_method('blip/getUserHome', true, true, {'ts' => last_blip_timestamp, 'offset' => offset_blip_id, 'limit' => blip_limit}, true, blip_user_name, blip_password))
+  end
+  
+  def BlipFm.get_user_playlist(blip_user_name)
+    return create_blip_array(execute_blip_method('blip/getUserPlaylist', true, true, {'username' => blip_user_name}))
+  end
+  
+  def BlipFm.get_user_profile(blip_user_name, offset_blip_id = 0, blip_limit = 25)
+    return create_blip_array(execute_blip_method('blip/getUserProfile', true, true, {'username' => blip_user_name, 'offset' => offset_blip_id, 'limit' => blip_limit}))
+  end
+  
+  def BlipFm.get_user_replies(blip_user_name, offset_blip_id = 0, blip_limit = 150)
+    return create_blip_array(execute_blip_method('blip/getUserReplies', true, true, {'username' => blip_user_name, 'offset' => offset_blip_id, 'limit' => blip_limit}))
+  end
+  
+  def BlipFm.post_blip(user_name, user_password, song_artist, song_title, song_url, blip_message, song_bitrate, song_genre, blip_type, reblip_id = 0, get_recommendations = 1)
+    return execute_blip_method('blip/post', true, true, {'artist' => song_artist, 'title' => song_title, 'url' => song_url, 'message' => blip_message, 'bitrate' => song_bitrate, 'genre' => song_genre, 'blipType' => blip_type, 'reblipId' => reblip_id, 'getUserRecs' => get_recommendations}, true, user_name, user_password, 'POST')
+  end
+  
+  def BlipFm.add_dj(user_name, user_password, dj_user_name)
+    return execute_blip_method('favorite/addDJ', true, true, {'username' => dj_user_name}, true, user_name, user_password, 'POST')
+  end
+  
+  def BlipFm.add_blip_to_playlist(user_name, user_password, blip_id)
+    return execute_blip_method('favorite/addToPlaylist', true, true, {'blipId' => blip_id}, true, user_name, user_password, 'POST')
+  end
+  
+  def BlipFm.remove_dj(user_name, user_password, dj_user_name)
+    return execute_blip_method('favorite/removeDJ', true, true, {'username' => dj_user_name}, true, user_name, user_password, 'POST')
+  end
+  
+  def BlipFm.remove_blip_from_playlist(user_name, user_password, blip_id)
+    return execute_blip_method('favorite/removeFromPlaylist', true, true, {'blipId' => blip_id}, true, user_name, user_password, 'POST')
+  end
+  
+  def BlipFm.update_playlist(user_name, user_password, blip_id_array)
+    return execute_blip_method('favorite/updatePlaylist', true, true, {'ids' => blip_id_array.join(',')}, true, user_name, user_password, 'POST')
+  end
+  
+  def BlipFm.find_songs(search_term)
+    return create_blip_array(execute_blip_method('search/findSongs', true, true, {'searchTerm' => search_term}), 'Song')
+  end
+  
+  def BlipFm.find_users(search_term, offset = 0, limit = 25)
+    return create_blip_array(execute_blip_method('search/findUsers', true, true, {'searchTerm' => search_term, 'offset' => offset, 'limit' => limit}), 'user')
+  end
+  
+  def BlipFm.get_users(user_name_array)
+    return create_blip_array(execute_blip_method('user/getByUsername', true, true, {'username' => user_name_array.join(',')}), 'User')
+  end
+  
+  def BlipFm.get_user_djs(user_name, offset = 0, limit = 25)
+    return create_blip_array(execute_blip_method('user/getFavoriteDJs', true, true, {'username' => user_name, 'offset' => offset, 'limit' => limit}), 'User')
+  end
+  
+  def BlipFm.get_user_listeners(user_name, offset = 0, limit = 25)
+    return create_blip_array(execute_blip_method('user/getListeners', true, true, {'username' => user_name, 'offset' => offset, 'limit' => limit}), 'User')
+  end
+  
+  def BlipFm.get_user_preferences(user_name, user_password)
+    return execute_blip_method('user/getPreferences', true, true, {}, true, user_name, user_password)
+  end
+  
+  def BlipFm.get_user_stats(user_name)
+    return execute_blip_method('user/getStats', true, true, {'username' => user_name})
+  end
+  
+  def BlipFm.give_user_props(user_name, user_password, dj_user_name, blip_id = 0)
+    return execute_blip_method('user/giveProps', true, true, {'username' => dj_user_name, 'blipId' => blip_id}, true, user_name, user_password, 'POST')
+  end
+  
+  def BlipFm.create_user(user_name, user_email, user_password)
+    return execute_blip_method('user/signup', true, true, {'username' => user_name, 'emailAddress' => user_email, 'password' => user_password}, false, nil, nil, 'POST')
+  end
+  
+  def BlipFm.get_blip_timestamp()
+    time_xml = execute_blip_method('util/time', false, false)
+    return REXML::Document.new(time_xml).root.elements['result'].text
+  end
+  
+  # BLIP CLASSES
+  class User
+    attr_reader :id, :display_name, :profile_pic_url, :status, :props_count, :country_code, :user_name, :website_url, :time_zone, :last_blip_time, :create_time, :update_time, :listener_count
+    
+    def User.create_by_xml(user_xml)
+      if (!user_xml.elements['id'].nil?)
+        id = user_xml.elements['id'].text
+        display_name = user_xml.elements['urlName'].text
+        profile_pic_url = user_xml.elements['profilePic'].text
+        status = user_xml.elements['status'].text
+        props_count = user_xml.elements['propsCount'].text
+        country_code = user_xml.elements['countryAbbr'].text
+        user_name = user_xml.elements['name'].text
+        website_url = user_xml.elements['website'].text
+        time_zone = user_xml.elements['timeZone'].text
+        last_blip_time = user_xml.elements['lastBlipTime'].text
+        create_time = user_xml.elements['insTime'].text
+        update_time = user_xml.elements['updateTime'].text
+        listener_count = nil    #user_xml.elements['listeners'].text
+        
+        User.new(id, display_name, profile_pic_url, status, props_count, country_code, user_name, website_url, time_zone, last_blip_time, create_time, update_time, listener_count)
+      end
+    end
+    
+    def initialize(id, display_name, profile_pic_url, status, props_count, country_code, user_name, website_url, time_zone, last_blip_time, create_time, update_time, listener_count)
+      @id = if_nill(id).strip
+      @display_name = if_nill(display_name).strip
+      @profile_pic_url = if_nill(profile_pic_url).strip
+      @status = if_nill(status).strip
+      @props_count = if_nill(props_count).strip
+      @country_code = if_nill(country_code).strip
+      @user_name = if_nill(user_name).strip
+      @website_url = if_nill(website_url).strip
+      @time_zone = if_nill(time_zone).strip
+      @last_blip_time = if_nill(last_blip_time).strip
+      @create_time = if_nill(create_time).strip
+      @update_time = if_nill(update_time).strip
+      @listener_count = if_nill(listener_count).strip
+    end
+  end
+  
+  class Blip
+    attr_reader :id, :media_url, :owner, :artist, :title, :create_time, :message, :unix_time, :to_user_id, :type, :status, :reblip_id, :thumbplay_url, :via, :via_url, :bitrate, :genre, :is_favorite
+    
+    def Blip.create_by_xml(blip_xml)
+      owner = User.create_by_xml(blip_xml.elements['owner'])
+      
+      if (!blip_xml.elements['id'].nil?)
+        id = blip_xml.elements['id'].text
+        media_url = blip_xml.elements['url'].text
+        artist = blip_xml.elements['artist'].text
+        title = blip_xml.elements['title'].text
+        create_time = blip_xml.elements['insTime'].text
+        message = blip_xml.elements['message'].text
+        unix_time = blip_xml.elements['unixTime'].text
+        to_user_id = blip_xml.elements['toId'].text
+        type = blip_xml.elements['type'].text
+        status = blip_xml.elements['status'].text
+        reblip_id = blip_xml.elements['reblipId'].text
+        thumbplay_url = blip_xml.elements['thumbplayLink'].text
+        via = blip_xml.elements['via'].text
+        via_url = blip_xml.elements['viaUrl'].text
+        bitrate = blip_xml.elements['bitrate'].text
+        genre = blip_xml.elements['genre'].text
+        is_favorite = nil
+        
+        Blip.new(id, media_url, owner, artist, title, create_time, message, unix_time, to_user_id, type, status, reblip_id, thumbplay_url, via, via_url, bitrate, genre, is_favorite)
+      end
+    end
+    
+    def Blip.get(id)
+      blip_xml = REXML::Document.new(BlipFm::execute_blip_method('blip/getById', false, false, {'id' => id})).elements['BlipApiResponse/result/collection/Blip']
+      create_by_xml(blip_xml)
+    end
+    
+    def initialize(id, media_url, owner, artist, title, create_time, message, unix_time, to_user_id, type, status, reblip_id, thumbplay_url, via, via_url, bitrate, genre, is_favorite)
+      @id = if_nill(id).strip
+      @media_url = if_nill(media_url).strip
+      @owner = owner
+      @artist = if_nill(artist).strip
+      @title = if_nill(title).strip
+      @create_time = if_nill(create_time).strip
+      @message = if_nill(message).strip
+      @unix_time = if_nill(unix_time).strip
+      @to_user_id = if_nill(to_user_id).strip
+      @type = if_nill(type).strip
+      @status = if_nill(status).strip
+      @reblip_id = if_nill(reblip_id).strip
+      @thumbplay_url = if_nill(thumbplay_url).strip
+      @via = if_nill(via).strip
+      @via_url = if_nill(via_url).strip
+      @bitrate = if_nill(bitrate).strip
+      @genre = if_nill(genre).strip
+      @is_favorite = if_nill(is_favorite).strip
+    end
+  end
+  
+  class Song
+    attr_reader :location, :title, :artist, :bitrate, :genre, :duration, :type
+  
+    def Song.create_by_xml(song_xml)
+      
+      location = song_xml.elements['location'].text
+      title = song_xml.elements['title'].text
+      artist = song_xml.elements['artist'].text
+      bitrate = song_xml.elements['bitrate'].text
+      genre = song_xml.elements['genre'].text
+      duration = song_xml.elements['duration'].text
+      type = song_xml.elements['blipType'].text
+      
+      Song.new(location, title, artist, bitrate, genre, duration, type)
+    end
+  
+    def initialize(location, title, artist, bitrate, genre, duration, type)
+      @location = if_nill(location).strip
+      @title = if_nill(title).strip
+      @artist = if_nill(artist).strip
+      @bitrate = if_nill(bitrate).strip
+      @genre = if_nill(genre).strip
+      @duration = if_nill(duration).strip
+      @type = if_nill(type).strip
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: blipfm
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2009-06-15 00:00:00 -07:00
+summary: A ruby library for the Blip.fm API. Developed to facilitate the development of Blip.fm (social media service centered around music) applications in ruby.
+require_paths: 
+- lib
+email: chris@tucsonconsulting.com
+homepage: http://blipfm.rubyforge.org/
+rubyforge_project: blipfm
+description: A ruby library for the Blip.fm API. Developed to facilitate the development of Blip.fm (social media service centered around music) applications in ruby.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Chris Koehler
+files: 
+- README.txt
+- lib/blipfm.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: uuid
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-hmac
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.2
+    version: