myspaceid-sdk 0.1.8

data/lib/myspace/oauth.rb

@@ -0,0 +1,62 @@
+require 'openid/extension'
+require 'openid/util'
+require 'openid/message'
+require 'oauth/token'
+
+module MySpace
+  module OAuth
+    NS_URI = 'http://specs.openid.net/extensions/oauth/1.0'
+
+#     begin
+#       Message.register_namespace_alias(NS_URI, 'oauth')
+#     rescue NamespaceAliasRegistrationError => e
+#       Util.log(e)
+#     end
+
+    # An object to hold the state of a simple registration request.
+    class Request < OpenID::Extension
+      attr_reader :consumer, :scope, :ns_uri
+      def initialize(consumer, scope)
+        super()
+
+        @ns_uri = NS_URI
+        @ns_alias = 'oauth'
+        @consumer = consumer
+        @scope = scope
+      end
+
+      def get_extension_args
+        args = {}
+
+        args['consumer'] = @consumer
+#         args['scope'] = @scope
+
+        return args
+      end
+    end
+
+    # Represents the data returned in a simple registration response
+    # inside of an OpenID id_res response. This object will be
+    # created by the OpenID server, added to the id_res response
+    # object, and then extracted from the id_res message by the Consumer.
+    class Response < OpenID::Extension
+      attr_reader :ns_uri, :authorized_request_token
+
+      def initialize(request_token = nil)
+        @ns_uri = NS_URI
+        @ns_alias = 'oauth'
+        @authorized_request_token = request_token
+      end
+
+      # Create an Response object from an
+      # OpenID::Consumer::SuccessResponse from consumer.complete
+      # If you set the signed_only parameter to false, unsigned data from
+      # the id_res message from the server will be processed.
+      def self.from_success_response(success_response, oauth_consumer)
+        args = success_response.extension_response(NS_URI, nil)
+        new(::OAuth::RequestToken.new(oauth_consumer, args['request_token'], ''))
+      end
+    end
+  end
+end
+

data/lib/patches.rb

@@ -0,0 +1,42 @@
+require 'rexml/element'
+require 'rexml/formatters/default'
+
+# fixes exception when element is too big to fit on a line
+module REXML
+  module Formatters
+    # Pretty-prints an XML document.  This destroys whitespace in text nodes
+    # and will insert carriage returns and indentations.
+    #
+    # TODO: Add an option to print attributes on new lines
+    class Pretty < Default
+      def wrap(string, width)
+#         p("wrap(" + string.to_s + "," + width.to_s + ")")
+        # Recursively wrap string at width.
+        return string if string.length <= width
+        place = string.rindex(' ', width) # Position in string with last ' ' before cutoff
+        return string unless place        # too wide, but no spaces to break
+        return string[0,place] + "\n" + wrap(string[place+1..-1], width)
+      end
+    end
+  end
+
+  class Document < Element
+    def pretty_print(q)
+      write($stdout, 2)
+    end
+  end
+end
+
+
+module OAuth::RequestProxy::Net
+  module HTTP
+    class HTTPRequest < OAuth::RequestProxy::Base
+      def query_string
+        params = [ query_params, auth_header_params ]
+        is_form_urlencoded = request['Content-Type'] != nil && request['Content-Type'].downcase == 'application/x-www-form-urlencoded'
+        params << post_params if ['POST', 'PUT'].include?(method.to_s.upcase) && is_form_urlencoded
+        params.compact.join('&')
+      end
+    end
+  end
+end

data/samples/rails/README

@@ -0,0 +1,83 @@
+Overview of the samples in this directory:
+-------------------------------------------
+
+	The samples have been unified into a single rails project for simplicity.
+
+	openid-combined-consumer:
+	-------------------------
+	This sample demonstrates an OpenID "Combined Consumer" by
+	implementing the openid/oauth "hybrid" spec as specified at:
+	http://step2.googlecode.com/svn/spec/openid_oauth_extension/latest/openid_oauth_extension.html
+	
+	This sample also demostrates the interaction with MySpace using
+	the MySpace library to fetch the user's profile and friends data
+
+
+	oauth:
+	------
+	This sample demonstrates an OAuth Consumer application by
+	implementing the oauth delegated access flow ("3 legged oauth").
+	Once the User authrizes the Consumer's request, it fetches the
+	user's profile and friend information using the library.
+
+    NOTE: Please note that in the samples above we store the access
+          token in the session. But, in a real application you would
+          probably need to store it an the user database so that you
+          can call the MySpace API methods in the future using the
+          stored access token
+
+	8-bit Music:
+	------------
+	This sample demonstrates using a popup window with directed
+	identity to do OpenID/OAuth without leaving the main page.  It
+	also demonstrates activity streams.
+
+
+Running the sample applications:
+--------------------------------
+
+	The samples provided in this directory are based on Ruby on Rails
+	2.2. Most of these files are boilerplate code generated by rails.
+	The main files to look at are:
+
+		sample/app/controllers/openid_controller.rb
+		sample/app/views/openid/index.rhtml
+
+		sample/app/controllers/oauth_controller.rb
+		sample/app/views/oauth/index.rhtml
+		sample/app/views/oauth/profile.rhtml
+
+		sample/app/controllers/user_controller.rb
+		sample/app/views/user/index.rhtml
+		sample/app/views/user/complete.rhtml
+		sample/public/javascripts/myspaceid.rev.0.js
+
+	To run the samples, please follow these steps:
+
+	   1. Type `server/start' from the sample root directory
+	      (samples/rails/sample). This should fire up your local
+	      instance of the web server and will start listening on port
+	      3000
+	   
+	   2. You can access the sample from your browser by navigating to
+		  http://localhost:3000
+	 
+	The application key and secret that come with the SDK will only
+	work if you are running the web server on localhost, i.e. the same
+	machine as the web browser you are using.  If you want to run the
+	code on a different machine, you must go to:
+
+	http://developer.myspace.com/modules/apps/pages/CreateAppAccount.aspx
+
+	to create a new MySpace application.  Make sure to select the
+	"Create MySpaceID App" link and complete the application creation
+	process.  Copy the new application's consumer key and secret to
+	the file consumer_key.rb located in the same directory as this
+	README.
+
+	IMPORTANT: The domain on which you run your server MUST be entered
+	as a realm on your MySpace app configuration page.  In order for
+	the rails samples to work you MUST INCLUDE A SLASH AT THE END OF
+	YOUR DOMAIN, e.g. http://your-domain:3000/, when you enter it as a
+	realm.
+

data/samples/rails/consumer_key.rb

@@ -0,0 +1,4 @@
+module ConsumerKey
+  CONSUMER_KEY    = '18bed0f4247a4f79bc9941bfed5b534c' unless const_defined?('CONSUMER_KEY')
+  CONSUMER_SECRET = '2e8ebdafbef844a5929086e659e4188c' unless const_defined?('CONSUMER_SECRET')
+end

data/samples/rails/consumer_key.rb-copyme

@@ -0,0 +1,4 @@
+module ConsumerKey
+  CONSUMER_KEY    = '' unless const_defined?('CONSUMER_KEY')
+  CONSUMER_SECRET = '' unless const_defined?('CONSUMER_SECRET')
+end

data/samples/rails/sample/README

@@ -0,0 +1,256 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create 
+database-backed web applications according to the Model-View-Control pattern. 
+
+This pattern splits the view (also called the presentation) into "dumb" templates
+that are primarily responsible for inserting pre-built data in between HTML tags.
+The model contains the "smart" domain objects (such as Account, Product, Person,
+Post) that holds all the business logic and knows how to persist themselves to
+a database. The controller handles the incoming requests (such as Save New Account,
+Update Product, Show Post) by manipulating the model and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails.  You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, start a new Rails application using the <tt>rails</tt> command
+   and your application name. Ex: rails myapp
+2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
+3. Go to http://localhost:3000/ and get "Welcome aboard: You're riding the Rails!"
+4. Follow the guidelines to start developing your application
+
+
+== Web Servers
+
+By default, Rails will try to use Mongrel and lighttpd if they are installed, otherwise
+Rails will use WEBrick, the webserver that ships with Ruby. When you run script/server,
+Rails will check if Mongrel exists, then lighttpd and finally fall back to WEBrick. This ensures
+that you can always get up and running quickly.
+
+Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is
+suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
+getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
+More info at: http://mongrel.rubyforge.org
+
+If Mongrel is not installed, Rails will look for lighttpd. It's considerably faster than
+Mongrel and WEBrick and also suited for production use, but requires additional
+installation and currently only works well on OS X/Unix (Windows users are encouraged
+to start with Mongrel). We recommend version 1.4.11 and higher. You can download it from
+http://www.lighttpd.net.
+
+And finally, if neither Mongrel or lighttpd are installed, Rails will use the built-in Ruby
+web server, WEBrick. WEBrick is a small Ruby web server suitable for development, but not
+for production.
+
+But of course its also possible to run Rails on any platform that supports FCGI.
+Apache, LiteSpeed, IIS are just a few. For more information on FCGI,
+please visit: http://wiki.rubyonrails.com/rails/pages/FastCGI
+
+
+== Apache .htaccess example
+
+# General Apache options
+AddHandler fastcgi-script .fcgi
+AddHandler cgi-script .cgi
+Options +FollowSymLinks +ExecCGI
+
+# If you don't want Rails to look in certain directories,
+# use the following rewrite rules so that Apache won't rewrite certain requests
+# 
+# Example:
+#   RewriteCond %{REQUEST_URI} ^/notrails.*
+#   RewriteRule .* - [L]
+
+# Redirect all requests not available on the filesystem to Rails
+# By default the cgi dispatcher is used which is very slow
+# 
+# For better performance replace the dispatcher with the fastcgi one
+#
+# Example:
+#   RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
+RewriteEngine On
+
+# If your Rails application is accessed via an Alias directive,
+# then you MUST also set the RewriteBase in this htaccess file.
+#
+# Example:
+#   Alias /myrailsapp /path/to/myrailsapp/public
+#   RewriteBase /myrailsapp
+
+RewriteRule ^$ index.html [QSA]
+RewriteRule ^([^.]+)$ $1.html [QSA]
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteRule ^(.*)$ dispatch.cgi [QSA,L]
+
+# In case Rails experiences terminal errors
+# Instead of displaying this message you can supply a file here which will be rendered instead
+# 
+# Example:
+#   ErrorDocument 500 /500.html
+
+ErrorDocument 500 "<h2>Application error</h2>Rails application failed to start properly"
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong.  Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files.  Have "tail -f" commands running
+on the server.log and development.log. Rails will automatically display debugging
+and runtime information to these files. Debugging info will also be shown in the
+browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code using
+the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/ including:
+
+* The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/
+* Learn to Program: http://pine.fm/LearnToProgram/  (a beginners guide)
+
+These two online (and free) books will bring you up to speed on the Ruby language
+and also on programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your Mongrel or
+Webrick server with --debugger. This means that you can break out of execution at any point
+in the code, investigate and change the model, AND then resume execution! 
+You need to install ruby-debug to run the server in debugging mode. With gems, use 'gem install ruby-debug'
+Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.find(:all)
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>,
+       #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better is that you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you enter "cont"
+
+
+== Console
+
+You can interact with the domain model by starting the console through <tt>script/console</tt>.
+Here you'll have all parts of the application configured, just like it is when the
+application is running. You can inspect domain models, change values, and save to the
+database. Starting the script without arguments will launch it in the development environment.
+Passing an argument will specify a different environment, like <tt>script/console production</tt>.
+
+To reload your controllers and models after launching the console run <tt>reload!</tt>
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>script/dbconsole</tt>.
+You would be connected to the database with the credentials defined in database.yml.
+Starting the script without arguments will connect you to the development database. Passing an
+argument will connect you to a different database, like <tt>script/dbconsole production</tt>.
+Currently works for mysql, postgresql and sqlite.
+
+== Description of Contents
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from ApplicationController
+  which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb.
+  Most models will descend from ActiveRecord::Base.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use eRuby
+  syntax.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the common
+  header/footer method of wrapping views. In your views, define a layout using the
+  <tt>layout :default</tt> and create a file named default.html.erb. Inside default.html.erb,
+  call <% yield %> to render the view using this layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are generated
+  for you automatically when using script/generate for controllers. Helpers can be used to
+  wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database, and other dependencies.
+
+db
+  Contains the database schema in schema.rb.  db/migrate contains all
+  the sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when generated
+  using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that doesn't
+  belong under controllers, models, or helpers. This directory is in the load path.
+
+public
+  The directory available for the web server. Contains subdirectories for images, stylesheets,
+  and javascripts. Also contains the dispatchers and the default HTML files. This should be
+  set as the DOCUMENT_ROOT of your web server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the script/generate scripts, template
+  test files will be generated for you and placed in this directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins subdirectory.
+  If the app has frozen rails, those gems also go here, under vendor/rails/.
+  This directory is in the load path.