myspace-ruby 0.7.0

data/lib/myspace/error.rb

@@ -0,0 +1,12 @@
+module MySpace
+  class InvalidDataFormat < Exception;  end
+  class InvalidResponse < Exception; end
+  class InvalidCredentials < Exception; end
+  class InvalidClassDefinition < Exception; end
+  class InvalidObjectMap < Exception; end
+  class UnknownDataType < Exception; end
+  class InvalidRequest < Exception; end
+  class InvalidRequestParams < Exception; end
+end
+
+fail "\nThis is a library, not a command line app" if $0 == __FILE__

data/lib/myspace/loader.rb

@@ -0,0 +1,74 @@
+# MySpace libs
+%w( connection object  
+  album detail friends friendship group 
+  interest mood photo profile status user video
+).each(&method(:require))
+# Base libraries
+%w( pp net/http cgi ).each(&method(:require))
+
+require "rubygems"
+
+# External libs
+REQUIRED = { 
+  "oauth"     => "http://oauth.googlecode.com/svn/code/ruby/",
+  # http://rubyforge.org/frs/download.php/22501/json-1.1.1-mswin32.gem
+  "json/pure" => "http://json.rubyforge.org/",
+}
+
+# Hard exit and describe what libraries failed 
+def remote_install_failed(load_failures)
+  puts "Installation failed, try to install the following modules manually:\n"
+  load_failures.each {|lib| puts "'#{lib}' ('#{REQUIRED[lib]}')" }
+  exit(1)
+end
+
+# Try to remotely install libs based on our load failures 
+def remote_install(load_failures)
+  puts "
+We couldn't load all modules required for the MySpace API. You appear to need:"
+  puts 
+  load_failures.each {|lib| puts "'#{lib.gsub(/\/.*$/,'')}' (#{REQUIRED[lib]})" }
+  print "
+If you like, we can try to fetch what you need from the Internet, and install it.
+
+Do you want to try and install from the net? [Y/n]: "
+   answer = $stdin.getc.chr
+   if answer.downcase == "y" || answer.chomp.empty?
+     begin 
+       require 'rubygems/remote_installer'
+       installer = Gem::RemoteInstaller.new
+       installed_gems = []
+       load_failures.each {|lib|
+         lib.gsub!(/\/.*$/,'')
+         installed_gems << installer.install(lib,">0",false,$LOAD_PATH[0])
+       }
+
+       if installed_gems.compact.length == load_failures.compact.length
+         installed_gems.compact.each {|spec| puts "installed #{spec.full_name}" }
+       else
+         remote_install_failed(load_failures)
+       end
+     rescue Exception => e
+       remote_install_failed(load_failures)
+     end
+  else
+    puts "
+Ok, but you need to get the required libraries before you can continue.
+
+Go to http://developer.myspace.com for more information or updates.
+"
+  end
+end
+
+# The actual load
+load_failures = []
+REQUIRED.keys.each {|lib|
+  begin 
+    require lib
+  rescue LoadError
+    load_failures << lib
+  end
+}
+remote_install(load_failures) if !load_failures.empty?
+
+fail "This is a library, not a command line app\n" if $0 == __FILE__

data/lib/myspace/object.rb

@@ -0,0 +1,116 @@
+# Base class for all the MySpace objects
+module MySpace
+class Object
+  # (String) the REST path on MySpace::API_HOST (printf format)
+  @pathFormat = nil
+  # (Integer) the number of parameters needed for @pathFormat
+  @numParams  = 1
+  # (Hash) optional parameters for the request (passed as GET query string)
+  @optParams  = nil
+  # (String) The type of data we expect from the API servers
+  @dataType   = "Hash"
+  # (String) The type of the child objects if we're dealing with collections
+  @childType  = nil
+  # (String) The instance variable that holds the collection
+  @childBase  = nil
+  # (String) the format we want from the api servers (MySpace::API_FORMATS)
+  @format     = "json"
+
+  def initialize(attribs={})
+    attribs.each {|key,val| instance_variable_set("@#{key}",val) }
+  end
+
+  class << self 
+    # Attempts to convert JSON to MySpace objects
+    def json_to_obj(body)
+      begin
+        obj = self.new(JSON.parse(body)) 
+        obj.user = MySpace::User.new(obj.user) if obj.respond_to?("user")
+      rescue Exception => e
+        raise InvalidResponse, "could not parse json from #{body}: '#{e}'"
+      end
+      obj
+    end
+
+    # Attempts to convert JSON to a MySpace objects (with child collections)
+    def json_to_obj_collection(body)
+      begin
+        obj = json_to_obj(body)
+
+        col = obj.instance_variable_get "@#{@childBase}"
+        raise InvalidResponse, "No '#{@childBase}' in response" if !col
+
+        col = obj.instance_variable_set "@#{@childBase}", 
+                col.collect {|o| eval("#{@childType}.new(o)") }
+
+      rescue Exception => e
+        raise InvalidResponse, "could not parse json from #{body}: '#{e}'"
+      end
+      obj
+    end
+
+    # Builds a REST request based on the supplied params and optParams
+    def build_request(params,optParams=nil,format="json")
+      if params == Array && params.length != @numParams
+        raise InvalidRequestParams.new(
+                "#{self}.get needs #{@numParams} (#{@pathFormat})")
+      end
+
+      raise InvalidRequest.new(
+        "try a collection of #{self} objects") if @pathFormat.nil?
+
+      begin 
+        path = "/#{API_VERSION}#{@pathFormat % params}.#{format}"
+      rescue Exception => e
+        raise InvalidRequestParams.new(
+          "couldn't build a path from params '#{params.join("'")}' \
+           and format string #{@pathFormat}. Exception is: (#{e})")
+      end
+
+      if optParams 
+        raise InvalidRequestParams.new(
+          "optParams should be a Hash.") if !optParams.kind_of?(Hash)
+
+        path += "?"
+
+        optParams.each {|k,v| 
+          if @optParams && !@optParams.has_key?(k)
+            raise InvalidRequestParams.new("option '#{k}' is not valid.") 
+          end
+          path += "#{k}=#{v}&"
+        }
+        path.sub!(/&$/,"")
+      end
+      path
+    end
+
+    # Performs a request to the API servers and returns the raw JSON/XML 
+    def get_raw(params,optParams=nil,format="json")
+      path = self.build_request(params,optParams,format)
+      MySpace.connection.get_body(path)
+    end
+
+    # Performs a get request to the API servers and returns some MySpace object
+    def get(params,optParams=nil)
+
+      path = self.build_request(params,optParams)
+      #puts "#{path} pathFormat #{@pathFormat} childType #{@childType} 
+      #childBase #{@childBase} numParams #{@numParams}"
+
+      body = MySpace.connection.get_body(path)
+
+      if @dataType == "Hash"
+        self.json_to_obj(body)
+      elsif @dataType == "Array"
+        body.sub!(/\{"Groups"\:/,'{"groups":') # you did not see this
+        self.json_to_obj_collection(body)
+      else
+        raise InvalidRequestParams.new("#{@dataType} is not a valid data type.")
+      end
+    end
+  end # end static class methods
+end # end class Object
+end # end module MySpace
+
+fail "This is a library, not a command line app\n" if $0 == __FILE__
+

data/tests/test.rb

@@ -0,0 +1,148 @@
+require "test/unit"
+
+class MySpaceAPITest < Test::Unit::TestCase
+  # set these to something that will work for you
+  # (until we have a proper test account)
+  @@userId    = 0
+  @@friendId  = 0
+  @@friendIds = "0;1"
+  @@albumId   = 0 
+
+  @@classes = %w[ album detail friends friendship group 
+interest mood photo profile status user video ]
+
+  def setup
+    $:.unshift File.dirname(__FILE__) + "/../lib"
+    require "myspace"
+    @@classes.each(&method(:require))
+  end
+
+  # basic tests to make sure we actually get the response we expect
+  def test_album
+    a = MySpace::Album.get(@@userId,@@albumId)
+    assert_kind_of MySpace::Album, a
+    assert_match /http\:/, a.albumUri
+    assert_match /http\:/, a.defaultImage
+    assert_kind_of Fixnum, a.id
+    assert_kind_of String, a.location
+    assert_kind_of Fixnum, a.photoCount
+    assert_match /http\:/, a.photosUri
+    assert_kind_of String, a.privacy
+    assert_kind_of String, a.title
+    assert_kind_of MySpace::User, a.user
+  end
+
+  def test_detail
+    d = MySpace::Detail.get(@@userId)
+    assert_kind_of MySpace::Detail, d
+    assert_kind_of MySpace::User,d.user
+    assert_kind_of String,d.status
+    assert_kind_of String,d.ethnicity
+    assert_kind_of String,d.drink
+    assert_kind_of String,d.zodiacsign
+    assert_kind_of String,d.orientation
+    assert_kind_of String,d.religion
+    assert_kind_of String,d.herefor
+    assert_kind_of String,d.smoke
+    assert_kind_of String,d.education
+    assert_kind_of String,d.income
+    assert_kind_of String,d.children
+    assert_kind_of String,d.hometown
+    assert_kind_of String,d.bodyType
+  end
+
+  def test_friends
+    f = MySpace::Friends.get(@@userId)
+    assert_kind_of MySpace::Friends, f
+    assert_kind_of Fixnum, f.count
+    assert_kind_of Array, f.friends
+    assert_kind_of MySpace::User, f.friends.first
+  end
+
+  def test_friendship
+    f = MySpace::Friendship.get(@@userId,@@friendId)
+    assert_kind_of MySpace::Friendship, f
+    assert_kind_of MySpace::User,f.user
+    assert_kind_of Array,f.friendship
+    assert(f.friendship.first.areFriends.kind_of?(TrueClass) || 
+           f.friendship.first.areFriends.kind_of?(FalseClass))
+    assert_kind_of Fixnum,f.friendship.first.friendId
+  end
+
+  def test_group
+    assert_kind_of MySpace::Groups, MySpace::Groups.get(@@userId)
+  end
+
+  def test_interest
+    i = MySpace::Interest.get(@@userId)
+    assert_kind_of MySpace::Interest, i 
+    assert_kind_of MySpace::User,i.user
+    assert_kind_of String, i.books
+    assert_kind_of String, i.general
+    assert_kind_of String, i.heroes
+    assert_kind_of String, i.movies
+    assert_kind_of String, i.music
+    assert_kind_of String, i.television
+  end
+
+  def test_mood
+    m = MySpace::Mood.get(@@userId)
+    assert_kind_of MySpace::Mood, m
+    assert_kind_of String, m.mood
+    assert_kind_of MySpace::User, m.user
+  end
+
+  def test_photo
+    p = MySpace::Photos.get(@@userId)
+    assert_kind_of MySpace::Photos, p
+    assert_kind_of Fixnum, p.count
+    assert_kind_of Array, p.photos
+    assert_kind_of MySpace::User, p.user
+    assert_kind_of MySpace::Photo, p.photos.first
+    assert_kind_of String, p.photos.first.caption
+    assert_kind_of Fixnum, p.photos.first.id
+    assert_match /^http\:/, p.photos.first.imageUri
+    assert_match /^http\:/, p.photos.first.photoUri
+  end
+
+  def test_profile
+    p = MySpace::Profile.get(@@userId)
+    assert_kind_of MySpace::Profile, p
+    assert_kind_of String, p.aboutme
+    assert_kind_of Fixnum, p.age
+    assert_kind_of String, p.city
+    assert_kind_of String, p.country
+    assert_kind_of String, p.culture
+    assert_kind_of String, p.gender
+    assert_kind_of String, p.hometown
+    assert_kind_of String, p.maritalstatus
+    assert_kind_of String, p.postalcode
+    assert_kind_of String, p.region
+  end
+
+  def test_status
+    s = MySpace::Status.get(@@userId)
+    assert_kind_of MySpace::Status, s
+    assert_kind_of String, s.status
+  end
+
+  def test_user
+    assert_kind_of MySpace::User, MySpace::User.get(@@userId)
+    u = MySpace::User.get(@@userId)
+    assert_match /http\:/,u.image
+    assert_match /http\:/,u.webUri
+    assert_match /^\d+$/,u.userId.to_s
+    assert_kind_of Fixnum,u.userId
+    assert_kind_of String,u.name
+    assert(u.onlineNow.kind_of?(TrueClass) || 
+           u.onlineNow.kind_of?(FalseClass))
+
+  end
+
+  def test_video
+    assert_kind_of MySpace::Videos, MySpace::Videos.get(@@userId)
+# TODO
+  end
+
+end
+

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: myspace-ruby
+version: !ruby/object:Gem::Version 
+  version: 0.7.0
+date: 2008-03-06 00:00:00 -08:00
+summary: A library to interface with the MySpace REST API.
+require_paths: 
+- lib
+email: cbell|myspace.com
+homepage: myspace-ruby.rubyforge.org/myspace-ruby
+rubyforge_project: myspace-ruby
+description: 
+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 Bell
+files: 
+- tests/test.rb
+- doc/index.html
+- doc/fr_file_index.html
+- doc/classes
+- doc/fr_method_index.html
+- doc/created.rid
+- doc/rdoc-style.css
+- doc/fr_class_index.html
+- doc/files
+- doc/classes/MySpace.html
+- doc/classes/MySpace
+- doc/classes/MySpaceAPITest.html
+- doc/files/lib
+- doc/files/tests
+- doc/files/pkg
+- doc/classes/MySpace/InvalidCredentials.html
+- doc/classes/MySpace/User.html
+- doc/classes/MySpace/Groups.html
+- doc/classes/MySpace/Mood.html
+- doc/classes/MySpace/Group.html
+- doc/classes/MySpace/Detail.html
+- doc/classes/MySpace/InvalidRequest.html
+- doc/classes/MySpace/InvalidRequestParams.html
+- doc/classes/MySpace/InvalidDataFormat.html
+- doc/classes/MySpace/Photos.html
+- doc/classes/MySpace/Status.html
+- doc/classes/MySpace/InvalidObjectMap.html
+- doc/classes/MySpace/Video.html
+- doc/classes/MySpace/Friendship.html
+- doc/classes/MySpace/Object.html
+- doc/classes/MySpace/Friends.html
+- doc/classes/MySpace/UnknownDataType.html
+- doc/classes/MySpace/Photo.html
+- doc/classes/MySpace/InvalidResponse.html
+- doc/classes/MySpace/Connection.html
+- doc/classes/MySpace/InvalidClassDefinition.html
+- doc/classes/MySpace/Profile.html
+- doc/classes/MySpace/Interest.html
+- doc/classes/MySpace/Videos.html
+- doc/classes/MySpace/Album.html
+- doc/classes/MySpace/FriendStatus.html
+- doc/files/lib/myspace_rb.html
+- doc/files/lib/myspace
+- doc/files/tests/test_rb.html
+- doc/files/pkg/myspace-ruby-0_7_0
+- lib/myspace.rb
+- lib/myspace/object.rb
+- lib/myspace/connection.rb
+- lib/myspace/loader.rb
+- lib/myspace/error.rb
+- lib/myspace/classes/video.rb
+- lib/myspace/classes/album.rb
+- lib/myspace/classes/profile.rb
+- lib/myspace/classes/mood.rb
+- lib/myspace/classes/interest.rb
+- lib/myspace/classes/group.rb
+- lib/myspace/classes/detail.rb
+- lib/myspace/classes/friendship.rb
+- lib/myspace/classes/user.rb
+- lib/myspace/classes/status.rb
+- lib/myspace/classes/friends.rb
+- lib/myspace/classes/photo.rb
+- README
+test_files: 
+- tests/test.rb
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+