myspace-ruby 0.7.0

data/lib/myspace.rb

@@ -0,0 +1,45 @@
+base = File.expand_path(File.dirname(__FILE__))
+
+$:.unshift base + "/myspace"
+$:.unshift base + "/myspace/classes"
+
+load "loader.rb"
+load "error.rb"
+
+# :include:../README
+module MySpace
+  VERSION      = "0.7"
+  API_FORMATS  = ["json","xml"]
+  API_HOST     = "api.msappspace.com"
+  API_VERSION  = "v1"
+  API_CONF     = if File.exist?("myspace.conf")
+                   "myspace.conf"
+                 elsif ENV["MYSPACE_CONF"] && File.exist?(ENV["MYSPACE_CONF"])
+                   ENV["MYSPACE_CONF"]
+                 else 
+                   File.dirname(__FILE__)+"/myspace.conf"
+                 end
+
+  # Load YAML configuration from a file and use those parameters  
+  CONF = YAML.load(File.open(API_CONF)) or {} rescue CONF = {}
+
+  # Connect to MySpace's API servers 
+  def self.connect(apiKey=CONF["apiKey"],secretKey=CONF["secretKey"])
+    raise InvalidCredentials.new("No apiKey or secretKey, aborting connect. 
+    You need to pass them to MySpace.connect or put them in myspace.conf") \
+    if apiKey.empty? || secretKey.empty? ||
+       apiKey =~ /x{7}/ || secretKey =~ /x{7}/
+
+    @connection = Connection.new(:apiKey => apiKey, :secretKey => secretKey)
+    
+    yield @connection if block_given?
+    @connection
+  end
+
+  def self.connection
+    @connection ||= self.connect
+  end
+end
+
+fail "This is a library, not a command line app" if $0 == __FILE__
+

data/lib/myspace/classes/album.rb

@@ -0,0 +1,25 @@
+class MySpace::Album < MySpace::Object
+  @pathFormat = "/users/%s/albums/%s".freeze
+  @numParams  = 2.freeze
+  @dataType   = "Hash".freeze
+
+  attr_accessor :albumUri
+  attr_accessor :defaultImage
+  attr_accessor :id
+  attr_accessor :location
+  attr_accessor :photoCount
+  attr_accessor :photosUri
+  attr_accessor :privacy
+  attr_accessor :title
+  attr_accessor :user
+
+  def self.get(userId,albumId)
+    super([userId,albumId])
+  end
+
+  def self.get_raw(userId,albumId,format="json")
+    super([userId,albumId],nil,format)
+  end
+end
+
+fail "This is a library, not a command line app\n" if $0 == __FILE__

data/lib/myspace/classes/detail.rb

@@ -0,0 +1,22 @@
+class MySpace::Detail < MySpace::Object
+  @pathFormat = "/users/%s/details".freeze
+  @dataType   = "Hash".freeze
+
+  attr_accessor :user
+  attr_accessor :status
+  attr_accessor :ethnicity
+  attr_accessor :drink
+  attr_accessor :zodiacsign
+  attr_accessor :orientation
+  attr_accessor :religion
+  attr_accessor :herefor
+  attr_accessor :smoke
+  attr_accessor :education
+  attr_accessor :income
+  attr_accessor :children
+  attr_accessor :hometown
+  attr_accessor :bodyType
+
+end
+
+fail "This is a library, not a command line app\n" if $0 == __FILE__

data/lib/myspace/classes/friends.rb

@@ -0,0 +1,16 @@
+class MySpace::Friends < MySpace::Object
+  @pathFormat = "/users/%s/friends".freeze
+  @numParams  = 1.freeze
+  @optParams  = { :page => nil,
+                  :page_size => nil }.freeze
+  @dataType   = "Array".freeze
+  @childType  = "User".freeze
+  @childBase  = "friends".freeze
+
+  attr_accessor :user
+  attr_accessor :topFriends
+  attr_accessor :friends
+  attr_accessor :count
+end
+
+fail "This is a library, not a command line app\n" if $0 == __FILE__

data/lib/myspace/classes/friendship.rb

@@ -0,0 +1,27 @@
+class MySpace::FriendStatus < MySpace::Object
+  attr_accessor :friendId
+  attr_accessor :areFriends
+end
+
+class MySpace::Friendship < MySpace::Object
+  @pathFormat = "/users/%s/friends/%s".freeze
+  @numParams  = 2.freeze
+  @dataType   = "Hash".freeze
+
+  attr_accessor :user
+  attr_accessor :friendship
+
+  alias :friends :friendship
+
+  def self.get(userId,friendId)
+    o = super([userId,friendId])
+    o.friendship = o.friendship.collect {|f| MySpace::FriendStatus.new(f) }
+    o
+  end
+
+  def self.get_raw(userId,friendId,format="json")
+    super([userId,friendId],nil,format)
+  end
+end
+
+fail "This is a library, not a command line app\n" if $0 == __FILE__

data/lib/myspace/classes/group.rb

@@ -0,0 +1,55 @@
+class MySpace::Groups < MySpace::Object
+  @pathFormat = "/users/%s/groups".freeze
+  @numParams  = 1.freeze
+  @dataType   = "Array".freeze
+  @childType  = "Group".freeze
+  @childBase  = "groups".freeze
+
+  attr_accessor :user
+  attr_accessor :prev
+  attr_accessor :groups
+  attr_accessor :next
+  attr_accessor :count
+end
+
+class MySpace::Group < MySpace::Object
+  attr_accessor :user
+  attr_accessor :prev
+  attr_accessor :groups
+  attr_accessor :next
+  attr_accessor :count
+
+  attr_accessor :approveMembers
+  attr_accessor :categoryId
+  attr_accessor :categoryName
+  attr_accessor :city
+  attr_accessor :country
+  attr_accessor :createDate
+  attr_accessor :description
+  attr_accessor :descriptionShort
+  attr_accessor :groupId
+  attr_accessor :groupName
+  attr_accessor :groupUri
+  attr_accessor :groupUrl
+  attr_accessor :imageId
+  attr_accessor :imageType
+  attr_accessor :isAdult
+  attr_accessor :isPrivate
+  attr_accessor :isPublic
+  attr_accessor :memberBulletins
+  attr_accessor :memberCount
+  attr_accessor :memberImages
+  attr_accessor :membersCanInvite
+  attr_accessor :moderatorUserId
+  attr_accessor :nonMemberBoardPosting
+  attr_accessor :postalCode
+  attr_accessor :region
+  attr_accessor :user
+  attr_accessor :image
+  attr_accessor :name
+  attr_accessor :onlineNow
+  attr_accessor :uri
+  attr_accessor :userId
+end
+
+fail "This is a library, not a command line app\n" if $0 == __FILE__

data/lib/myspace/classes/interest.rb

@@ -0,0 +1,16 @@
+class MySpace::Interest < MySpace::Object
+  @pathFormat = "/users/%s/interests".freeze
+  @numParams  = 1.freeze
+  @dataType   = "Hash".freeze
+
+  attr_accessor :user
+  attr_accessor :heroes
+  attr_accessor :general
+  attr_accessor :music
+  attr_accessor :television
+  attr_accessor :movies
+  attr_accessor :books
+
+end
+
+fail "This is a library, not a command line app\n" if $0 == __FILE__

data/lib/myspace/classes/mood.rb

@@ -0,0 +1,9 @@
+class MySpace::Mood < MySpace::Object
+  @pathFormat = "/users/%s/mood".freeze
+  @dataType   = "Hash".freeze
+
+  attr_accessor :user
+  attr_accessor :mood
+end
+
+fail "This is a library, not a command line app\n" if $0 == __FILE__

data/lib/myspace/classes/photo.rb

@@ -0,0 +1,21 @@
+class MySpace::Photos < MySpace::Object
+  @pathFormat = "/users/%s/photos".freeze
+  @dataType   = "Array".freeze
+  @childType  = "Photo".freeze
+  @childBase  = "photos".freeze
+
+  attr_accessor :user
+  attr_accessor :photos
+  attr_accessor :count
+end
+
+class MySpace::Photo < MySpace::Object
+  attr_accessor :caption
+  attr_accessor :id
+  attr_accessor :imageUri
+  attr_accessor :photoUri
+  attr_accessor :user
+
+end
+
+fail "This is a library, not a command line app\n" if $0 == __FILE__

data/lib/myspace/classes/profile.rb

@@ -0,0 +1,22 @@
+class MySpace::Profile < MySpace::Object
+  @pathFormat = "/users/%s/profile".freeze
+  @dataType   = "Hash".freeze
+  @numParams  = 1.freeze
+  @optParams  = {"page"      => "", 
+                 "page_size" => "",
+                 "list"      => ""}.freeze
+
+  attr_accessor :city
+  attr_accessor :region
+  attr_accessor :country
+  attr_accessor :gender
+  attr_accessor :postalcode
+  attr_accessor :culture
+  attr_accessor :basicprofile
+  attr_accessor :age
+  attr_accessor :aboutme
+  attr_accessor :maritalstatus
+  attr_accessor :hometown
+end
+
+fail "This is a library, not a command line app\n" if $0 == __FILE__

data/lib/myspace/classes/status.rb

@@ -0,0 +1,9 @@
+class MySpace::Status < MySpace::Object
+  @pathFormat = "/users/%s/status".freeze
+  @dataType   = "Hash".freeze
+
+  attr_accessor :user
+  attr_accessor :status
+end
+
+fail "This is a library, not a command line app\n" if $0 == __FILE__

data/lib/myspace/classes/user.rb

@@ -0,0 +1,17 @@
+class MySpace::User < MySpace::Object
+  @pathFormat = "/users/%s".freeze
+  @dataType   = "Hash".freeze
+
+  # the name the user specified for the profile (not username/vanity url)
+  attr_accessor :name
+  # the URL of the user's profile page
+  attr_accessor :uri
+  attr_accessor :webUri
+  attr_accessor :userType
+  attr_accessor :userId
+  attr_accessor :onlineNow
+  attr_accessor :image 
+
+end
+
+fail "This is a library, not a command line app\n" if $0 == __FILE__

data/lib/myspace/classes/video.rb

@@ -0,0 +1,41 @@
+class MySpace::Videos < MySpace::Object
+  @pathFormat = "/users/%s/videos".freeze
+  @numParams  = 1.freeze
+  @dataType   = "Array".freeze
+  @childType  = "Video".freeze
+  @childBase  = "videos".freeze
+
+  attr_accessor :videos
+end
+
+class MySpace::Video < MySpace::Object
+  attr_accessor :country
+  attr_accessor :datecreated
+  attr_accessor :dateupdated
+  attr_accessor :description
+  attr_accessor :id
+  attr_accessor :image
+  attr_accessor :language
+  attr_accessor :mediastatus
+  attr_accessor :mediatype
+  attr_accessor :name
+  attr_accessor :onlineNow
+  attr_accessor :privacy
+  attr_accessor :resourceuserid
+  attr_accessor :runtime
+  attr_accessor :thumbnail
+  attr_accessor :title
+  attr_accessor :totalrating
+  attr_accessor :totalviews
+  attr_accessor :totalvotes
+  attr_accessor :uri
+  attr_accessor :uri
+  attr_accessor :user
+  attr_accessor :userId
+  attr_accessor :userType
+  attr_accessor :videos
+  attr_accessor :videoUri
+  attr_accessor :webUri
+end
+
+fail "This is a library, not a command line app\n" if $0 == __FILE__

data/lib/myspace/connection.rb

@@ -0,0 +1,110 @@
+require "net/http"
+require "oauth/consumer"
+
+module MySpace
+# MySpace::Connection connects to the MySpace API servers, and performs
+# connection oriented tasks.  Most attributes map directly
+# to their configuration file counterparts unless they're specified during
+# initialization.
+class Connection
+  include Net
+  # API username
+  attr_accessor :username
+  # API password
+  attr_accessor :apiSecret
+  # API key
+  attr_accessor :apiKey
+  # host to connect 
+  attr_accessor :host
+  # preferred output format
+  attr_accessor :format
+
+  # Constructor for the MySpace::Connection class
+  def initialize(attributes={})
+    @apiKey    = attributes[:apiKey]     ||= CONF["apiKey"]
+    @secretKey = attributes[:apiSecret]  ||= CONF["secretKey"]
+    @host      = attributes[:host]       ||= API_HOST
+    @format    = attributes[:format]     ||= "json"
+
+    @oauthOptions = {
+      :scheme    => :query_string,
+      :nonce     => rand(65535).to_s,
+      :timestamp => Time.now.to_i.to_s,
+      :site      => "http://#{API_HOST}",
+    }
+
+    yield self if block_given?
+  end
+
+  # Returns an rfc1123 format string 
+  def timestamp
+    Time.now.utc.strftime("%a, %d %b %Y %H:%M:%S GMT")
+  end
+
+  def consumer
+    OAuth::Consumer.new(CGI.escape(@apiKey),@secretKey,@oauthOptions)
+  end
+
+  # Connects to the MySapce API servers, returning a Net::HTTP class
+  # instance.  If a block is given, then that instance is yielded.
+  def connect
+    # require "net/https"
+    # http = Net::HTTP.new(MYSPACE_API_HOST, 443)
+    # http.use_ssl = true
+    @http = HTTP.start(@host)
+    yield @http if block_given?
+  end
+  
+  # Perform a POST operation against the MySpace API servers.
+  # You can pass a 'path', post data 'data' and a 'content_type'
+  # optionally.
+  # application/x-www-form-urlencoded
+  # text/xml; charset=utf-8
+  def post(path="/",data="",headers={},content_type="application/x-www-form-urlencoded")
+    connect if !@http
+
+    req = HTTP::Post.new(path,headers)
+    req.set_form_data({ }, ';')
+    req.body = data
+    req.content_type = content_type
+      
+    yield @http.request(req) if block_given? 
+  end
+
+  # Fetches the response body from the API servers
+  def get_body(path)
+    connect if !@http
+
+    get(path) {|res|
+      case res.code
+      when "200"
+        return res.body
+      when "401"
+        raise InvalidCredentials,
+          "Access denied. (#{res.code})\n#{res.body}"
+      else
+        raise InvalidResponse,"(#{res.code})\n#{res.body}"
+      end
+    }
+  end
+
+
+  # Performs a GET request against the MySpace API servers.
+  # The 'path' is the first argument, and the second argument 'http'
+  # is an optional, existing Net::HTTP connection.
+  # Returns or yields a Net::HTTP::Response instance, depending on how it's
+  # called.
+  def get(path="/")
+    req = HTTP::Get.new(path)
+
+    connect if !@http
+
+    la = lambda { req.oauth!(@http,consumer,nil,@oauthOptions)
+                  @http.request(req) }
+
+    yield la.call if block_given?
+  end
+end # end class
+end # end namespace
+
+fail "This is a library, not a command line app\n" if $0 == __FILE__