spacer 0.5.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.5.0 / 2008-02-09
+
+* Initial release
+  * Birthday!

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2008 Shane Vitarana <shanev@gmail.com>, CrimsonJet LLC
+
+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/Manifest.txt

@@ -0,0 +1,34 @@
+History.txt
+MIT-LICENSE
+Manifest.txt
+README.txt
+Rakefile
+bin/spacer
+lib/spacer.rb
+lib/spacer/auth.rb
+lib/spacer/client.rb
+lib/spacer/model.rb
+lib/spacer/models/album.rb
+lib/spacer/models/details.rb
+lib/spacer/models/group.rb
+lib/spacer/models/interest.rb
+lib/spacer/models/mood.rb
+lib/spacer/models/photo.rb
+lib/spacer/models/profile.rb
+lib/spacer/models/status.rb
+lib/spacer/models/user.rb
+lib/spacer/models/video.rb
+tasks/annotations.rake
+tasks/doc.rake
+tasks/gem.rake
+tasks/manifest.rake
+tasks/post_load.rake
+tasks/rubyforge.rake
+tasks/setup.rb
+tasks/spec.rake
+tasks/svn.rake
+tasks/test.rake
+test/test_client.rb
+test/test_helper.rb
+test/test_spacer.rb
+test/test_user.rb

data/README.txt

@@ -0,0 +1,54 @@
+spacer
+    by Shane Vitarana
+    http://shanesbrain.net
+
+== DESCRIPTION:
+
+Ruby API for the MySpace Platform REST API
+
+== FEATURES/PROBLEMS:
+
+* Implements v1.0 of the MySpace Platform REST API
+* Uses JSON for minimal transport footprint
+
+== SYNOPSIS:
+
+  @myspace = Spacer::Client.new(api_key, secret_key)
+  user = @myspace.user('3454354')
+  puts user.interests.music
+  puts user.photos.first.caption
+
+== REQUIREMENTS:
+
+* OAuth
+* ActiveSupport
+* Mocha (for testing)
+
+== INSTALL:
+
+* sudo gem install spacer
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Shane Vitarana <shanev@gmail.com>, CrimsonJet LLC
+
+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/Rakefile

@@ -0,0 +1,20 @@
+# Look in the tasks/setup.rb file for the various options that can be
+# configured in this Rakefile. The .rake files in the tasks directory
+# are where the options are used.
+
+load 'tasks/setup.rb'
+
+ensure_in_path 'lib'
+require 'spacer'
+
+task :default => 'test:run'
+
+PROJ.name = 'spacer'
+PROJ.authors = 'Shane Vitarana'
+PROJ.email = 'shanev@gmail.com'
+PROJ.url = 'http://shanesbrain.net'
+PROJ.rubyforge_name = 'spacer'
+
+PROJ.spec_opts << '--color'
+
+# EOF

data/bin/spacer

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), '..', 'lib', 'spacer'))
+
+# Put your code here
+
+# EOF

data/lib/spacer.rb

@@ -0,0 +1,63 @@
+# $Id$
+
+# Equivalent to a header guard in C/C++
+# Used to prevent the class/module from being loaded more than once
+unless defined? Spacer
+
+require 'rubygems'
+require 'oauth/consumer'
+require 'activesupport'
+require 'spacer/model'
+
+module Spacer
+
+  # :stopdoc:
+  VERSION = '0.5.0'
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  # :startdoc:
+
+  # Returns the version string for the library.
+  #
+  def self.version
+    VERSION
+  end
+
+  # Returns the library path for the module. If any arguments are given,
+  # they will be joined to the end of the libray path using
+  # <tt>File.join</tt>.
+  #
+  def self.libpath( *args )
+    args.empty? ? LIBPATH : ::File.join(LIBPATH, *args)
+  end
+
+  # Returns the lpath for the module. If any arguments are given,
+  # they will be joined to the end of the path using
+  # <tt>File.join</tt>.
+  #
+  def self.path( *args )
+    args.empty? ? PATH : ::File.join(PATH, *args)
+  end
+
+  # Utility method used to rquire all files ending in .rb that lie in the
+  # directory below this file that has the same name as the filename passed
+  # in. Optionally, a specific _directory_ name can be passed in such that
+  # the _filename_ does not have to be equivalent to the directory.
+  #
+  def self.require_all_libs_relative_to( fname, dir = nil )
+    dir ||= ::File.basename(fname, '.*')
+    search_me = ::File.expand_path(
+        ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
+
+    Dir.glob(search_me).sort.each do |rb|
+      require rb
+    end
+  end
+
+end  # module Spacer
+
+Spacer.require_all_libs_relative_to __FILE__
+
+end  # unless defined?
+
+# EOF

data/lib/spacer/auth.rb

@@ -0,0 +1,23 @@
+module Spacer
+  
+  class Authentication
+    def initialize(api_key, secret_key)
+      @oauth_consumer = OAuth::Consumer.new(CGI.escape(api_key), secret_key)
+    end
+    
+    def process_request(http, request)
+      request.oauth!(http, @oauth_consumer, nil, { :scheme => :query_string, :nonce => nonce, :timestamp => timestamp })
+      request
+    end
+    
+  private
+    def nonce
+      rand(2**128).to_s
+    end
+  
+    def timestamp
+      Time.new.to_i.to_s
+    end
+  end
+  
+end

data/lib/spacer/client.rb

@@ -0,0 +1,141 @@
+module Spacer
+  class Client
+    
+    SERVER    = 'api.msappspace.com'
+    VERSION   = 'v1'
+    FORMAT    = :json
+    LOG_LEVEL = Logger::INFO
+    
+    def initialize(api_key, secret_key, logger=nil)
+      @auth = Authentication.new(api_key, secret_key)
+      
+      if logger
+        @log = logger
+      else
+        @log = Logger.new(STDOUT)
+        @log.level = LOG_LEVEL
+      end
+    end
+    
+    def user(user_id)
+      response = do_request "users/#{user_id}"
+      @user = User.from_hash_with_client(response, self)
+    end
+    
+    def profile(user_id)
+      response = do_request "users/#{user_id}/profile"
+      @profile = Profile.from_hash(response)
+    end
+    
+    def friends(user_id, page=nil, page_size=nil, list=nil)
+      response = do_request "users/#{user_id}/friends.#{FORMAT.to_s}?page=#{page}&page_size=#{page_size}&list=#{list}"
+      @friends = response['friends'].map do |friend|
+        User.from_hash_with_client(friend, self)
+      end
+    end
+    
+    def albums(user_id)
+      response = do_request "users/#{user_id}/albums"
+      @albums = response['albums'].map do |album|
+        Album.from_hash(album)
+      end
+    end
+    
+    def album(user_id, album_id)
+      response = do_request "users/#{user_id}/albums/#{album_id}"
+      @album = Album.from_hash(response)
+    end
+    
+    def photos_for_album(user_id, album_id)
+      response = do_request "users/#{user_id}/albums/#{album_id}/photos"
+      @photos = response['photos'].map do |photo|
+        Photo.from_hash(photo)
+      end
+    end
+    
+    def photos(user_id)
+      response = do_request "users/#{user_id}/photos"
+      @photos = response['photos'].map do |photo|
+        Photo.from_hash(photo)
+      end      
+    end
+    
+    def interests(user_id)
+      response = do_request "users/#{user_id}/interests"
+      @interests = Interest.from_hash(response)
+    end
+    
+    def details(user_id)
+      response = do_request "users/#{user_id}/details"
+      @details = Details.from_hash(response)
+    end
+    
+    def videos(user_id)
+      response = do_request "users/#{user_id}/videos"
+      @videos = response['videos'].map do |video|
+        Video.from_hash(video)
+      end            
+    end
+    
+    def video(user_id, video_id)
+      response = do_request "users/#{user_id}/videos/#{video_id}"
+      @video = Video.from_hash(response)
+    end
+    
+    def photo(user_id, photo_id)
+      response = do_request "users/#{user_id}/photos/#{photo_id}"
+      @photo = Photo.from_hash(response)
+    end
+    
+    def status(user_id)
+      response = do_request "users/#{user_id}/status"
+      @status = Status.from_hash(response)
+    end
+    
+    def mood(user_id)
+      response = do_request "users/#{user_id}/mood"
+      @mood = Mood.from_hash(response)      
+    end
+    
+    def friendship?(user_id, friend_ids)
+      multiple_friends = friend_ids.is_a?(Array)
+
+      friend_ids = friend_ids.join(';') if multiple_friends
+      response = do_request "users/#{user_id}/friends/#{friend_ids}"
+      
+      if multiple_friends
+        @friendships = response['friendship'].map do |friendship|
+          friendship['areFriends']
+        end
+      else
+        response['friendship'].first['areFriends']
+      end
+    end
+    
+    def groups(user_id)
+      response = do_request "users/#{user_id}/groups"
+      @groups = response['Groups'].map do |group|
+        Group.from_hash(group)
+      end
+    end
+  
+  private 
+    def do_request(query)
+      request_uri = request_uri(query)
+
+      http = Net::HTTP.new(request_uri.host, request_uri.port)
+      request = Net::HTTP::Get.new(request_uri.path)
+      request = @auth.process_request(http, request)
+      @log.debug "REQUEST PATH: #{request.path}"
+      
+      response = http.request(request)
+      @log.debug "RESPONSE BODY: #{response.body}\n"
+      
+      ActiveSupport::JSON.decode(response.body)     
+    end
+    
+    def request_uri(query)
+      URI.parse("http://#{SERVER}/#{VERSION}/#{query}.#{FORMAT.to_s}")
+    end    
+  end
+end

data/lib/spacer/model.rb

@@ -0,0 +1,124 @@
+## Graciously stolen from Facebooker
+#
+# Copyright (c) 2007 Chad Fowler <chad@infoether.com>
+# 
+# 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.
+
+module Spacer
+  ##
+  # helper methods primarily supporting the management of Ruby objects which are populatable via Hashes.  
+  # Since most Facebook API calls accept and return hashes of data (as XML), the Model module allows us to
+  # directly populate a model's attributes given a Hash with matching key names.
+  module Model
+    class UnboundSessionException < Exception; end
+    def self.included(includer)
+      includer.extend ClassMethods
+    end
+    module ClassMethods
+      ##
+      # Instantiate a new instance of the class into which we are included and populate that instance's
+      # attributes given the provided Hash.  Key names in the Hash should map to attribute names on the model.
+      def from_hash(hash)
+        instance = new(hash)
+        yield instance if block_given?
+        instance
+      end
+      
+      ##
+      # Create a standard attr_writer and a populating_attr_reader      
+      def populating_attr_accessor(*symbols)
+        attr_writer *symbols
+        populating_attr_reader *symbols
+      end
+
+      ## 
+      # Create a reader that will attempt to populate the model if it has not already been populated
+      def populating_attr_reader(*symbols)
+        symbols.each do |symbol|
+          define_method(symbol) do
+            populate unless populated?
+            instance_variable_get("@#{symbol}")
+          end
+        end
+      end
+      
+      def populating_hash_settable_accessor(symbol, klass)
+        populating_attr_reader symbol
+        hash_settable_writer(symbol, klass)
+      end
+        
+      def populating_hash_settable_list_accessor(symbol, klass)
+        populating_attr_reader symbol
+        hash_settable_list_writer(symbol, klass)
+      end
+      
+      #
+      # Declares an attribute named ::symbol:: which can be set with either an instance of ::klass::
+      # or a Hash which will be used to populate a new instance of ::klass::.
+      def hash_settable_accessor(symbol, klass)
+        attr_reader symbol
+        hash_settable_writer(symbol, klass)
+      end
+      
+      def hash_settable_writer(symbol, klass)
+        define_method("#{symbol}=") do |value|
+          instance_variable_set("@#{symbol}", value.kind_of?(Hash) ? klass.from_hash(value) : value)
+        end        
+      end
+      
+      #
+      # Declares an attribute named ::symbol:: which can be set with either a list of instances of ::klass::
+      # or a list of Hashes which will be used to populate a new instance of ::klass::.      
+      def hash_settable_list_accessor(symbol, klass)
+        attr_reader symbol
+        hash_settable_list_writer(symbol, klass)
+      end
+      
+      def hash_settable_list_writer(symbol, klass)
+        define_method("#{symbol}=") do |list|
+          instance_variable_set("@#{symbol}", list.map do |item|
+            item.kind_of?(Hash) ? klass.from_hash(item) : item
+          end)
+        end
+      end      
+    end
+    
+    def initialize(hash = {})
+      populate_from_hash!(hash)
+    end
+
+    def populate
+      raise NotImplementedError, "#{self.class} included me and should have overriden me"
+    end
+
+    def populated?
+      !@populated.nil?
+    end
+    
+    ##
+    # Set model's attributes via Hash.  Keys should map directly to the model's attribute names.
+    def populate_from_hash!(hash)
+      unless hash.empty?
+        hash.each do |key, value|
+          self.__send__("#{key}=", value)
+        end
+        @populated = true
+      end      
+    end    
+  end
+end