soundcloud-auth 0.1.0 → 0.1.1

data/README.markdown

@@ -1,2 +1,75 @@
-SoundCloudAuth
-===========
+SoundcloudAuth
+===========
+
+SoundcloudAuth aims to provide a complete authentication and API access solution for creating SoundCloud applications in Rails. It provides a generator and all of the necessary components to use Soundcloud as the sole authentication provider for an application using OAuth.
+
+### Major Props
+
+SoundcloudAuth is largely influenced and in a lot of ways identical to [Michael Bleigh's](http://github.com/mbleigh) amazing [TwitterAuth](http://github.com/mbleigh/twitter-auth) plugin. I've used TwitterAuth so many times on my Twitter app development that I found it sorely missed when I tried to tackle the SoundCloud platform.  All props and donations should be forwarded to Michael.
+
+Installation
+============
+
+You can include SoundcloudAuth as a gem in your project like so:
+
+    config.gem `soundcloud-auth`, :lib => `soundcloud_auth`
+
+Or you can install it as a traditional Rails plugin:
+
+    script/plugin install git://github.com/leemartin/soundcloud-auth.git
+
+Note that because SoundcloudAuth utilizes Rails Engines functionality introduced in Rails 2.3, it will not work with earlier versions of Rails.
+
+Usage
+=====
+
+To utilize SoundcloudAuth in your application you will need to run the generator:
+
+    script/generate soundcloud_auth
+
+This will generate a migration as well as set up the stubs needed to use the Rails Engines controllers and models set up by SoundcloudAuth. It will also create a User class that inherits from SoundcloudUser, abstracting away all of the SoundCloud authentication functionality and leaving you a blank slate to work with for your application. 
+
+Finally, it will create a configuration file in `config/soundcloud_auth.yml` in which you should input your OAuth consumer key and secret as well as a custom callback for development (the 'oauth_callback' option is where SoundCloud will send the browser after authentication is complete).
+
+Usage Basics
+------------
+
+SoundcloudAuth borrows heavily from [Restful Authentication](http://github.com/technoweenie/restful-authentication) for its API because it's simple and well-known. Here are some of the familiar methods that are available:
+
+* `login_required`: a before filter that can be added to a controller to require that a user logs in before he/she can view the page.
+* `current_user`: returns the logged in user if one exists, otherwise returns `nil`.
+* `logged_in?`: true if logged in, false otherwise.
+* `redirect_back_or_default(url)`: redirects to the location where `store_location` was last called or the specified default URL.
+* `store_location`: store the current URL for returning to when a `redirect_back_or_default` is called.
+* `authorized?`: override this to add fine-grained access control for when `login_required` is already called.
+
+Accessing the SoundCloud API
+-------------------------
+
+The `User` class will have a `soundcloud` method that provides a generic dispatcher with HTTP verb commands available (`get`, `put`, `post`, and `delete`). These are automatically initialized to the `base_url` you specified in the `twitter_auth.yml` file, so you need only specify a path. Additionally, it will automatically append a .json extension and parse the JSON if you don't provide.
+
+    user.soundcloud.get('/me')
+    # => {'username' => 'leemartin', 'full_name' => 'Lee Martin' ... }
+
+		user.soundcloud.put('/me', 'user[website]=http://lee.ma/rtin')
+		# => {'username' => 'leemartin', 'website' => 'http://lee.ma/rtin'}
+
+If SoundCloud returns something other than a 200 response code, SoundcloudAuth will catch it and try to raise a salient error message. The exception class is `SoundcloudAuth::Dispatcher::Error`.
+
+Customizing SoundcloudAuth
+-----------------------
+
+There are a number of hooks to extend the functionality of SoundcloudAuth. Here is a brief description of each of them.
+
+### Controller Methods
+
+SoundcloudAuth provides some default controller methods that may be overridden in your `ApplicationController` to behave differently.
+
+* `authentication_failed(message)`: called when SoundCloud authorization has failed during the process. By default, simply redirects to the site root and sets the `flash[:error]`.
+* `authentication_succeeded(message=default)`: called when SoundCloud authorization has completed successfully. By default, simply redirects to the site root and sets the `flash[:notice]`.
+* `access_denied`: what happens when the `login_required` before filter fails. By default it stores the current location to return to and redirects to the login process.
+
+Copyright
+---------
+
+**SoundcloudAuth** is Copyright (c) 2010 [Lee Martin](http://lee.ma/rtin), released under the MIT License.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/app/controllers/sessions_controller.rb

@@ -32,16 +32,14 @@ class SessionsController < ApplicationController
     
     session[:request_token] = nil
     session[:request_token_secret] = nil
-    
-    puts @access_token
 
-    #@user = User.identify_or_create_from_access_token(@access_token)
+    @user = User.identify_or_create_from_access_token(@access_token)
 
-    #session[:user_id] = @user.id
+    session[:user_id] = @user.id
 
-    #cookies[:remember_token] = @user.remember_me
+    cookies[:remember_token] = @user.remember_me
 
-    #authentication_succeeded 
+    authentication_succeeded 
     
     rescue Net::HTTPServerException => e
       case e.message

data/app/models/soundcloud_auth/generic_user.rb

@@ -1,7 +1,7 @@
 module SoundcloudAuth
   class GenericUser < ActiveRecord::Base
     
-    attr_protected :soundcloud_id, :remember_token, :remember_token_expires_at
+    attr_protected :soundcloud_id, :remember_token, :remember_token_expires_at, :access_token, :access_secret
     
     SOUNDCLOUD_ATTRIBUTES = [
       :plan,
@@ -67,7 +67,8 @@ module SoundcloudAuth
       
       token = OAuth::AccessToken.new(SoundcloudAuth.consumer, token, secret) unless token.is_a?(OAuth::AccessToken)
       
-      user_info = JSON.parse(token.get(SoundcloudAuth.path_prefix + '/me.json'))
+      response = token.get(SoundcloudAuth.path_prefix + '/me.json')
+      user_info = JSON.parse(response.body)
       
       if user = User.find_by_soundcloud_id(user_info['id'].to_s)
         user.assign_soundcloud_attributes(user_info)
@@ -94,7 +95,7 @@ module SoundcloudAuth
     end
 
     def soundcloud
-      # OAuth::AccessToken.new(TwitterAuth.consumer, access_token, access_secret)
+      SoundcloudAuth::Dispatcher::Oauth.new(self)
     end
 
     def remember_me

data/lib/soundcloud_auth.rb

@@ -29,7 +29,7 @@ module SoundcloudAuth
   def self.consumer
     
     options = {
-      :site => TwitterAuth.base_url,
+      :site => SoundcloudAuth.base_url,
       :request_token_path => "/oauth/request_token",
       :access_token_path => "/oauth/access_token",
       :authorize_path => "/oauth/authorize"
@@ -43,9 +43,14 @@ module SoundcloudAuth
     
   end
   
-=end
-  
 end
 
 require 'soundcloud_auth/controller_extensions'
+require 'soundcloud_auth/dispatcher/oauth'
 
+module SoundcloudAuth
+  module Dispatcher
+    class Error < StandardError; end
+    class Unauthorized < Error; end
+  end
+end

data/lib/soundcloud_auth/dispatcher/oauth.rb

@@ -0,0 +1,56 @@
+require 'oauth'
+
+module SoundcloudAuth
+  module Dispatcher
+    class Oauth < OAuth::AccessToken
+    
+      attr_accessor :user
+    
+      def append_extension_to(path)
+        path, query_string = *(path.split("?"))
+        path << '.json' unless path.match(/\.(:?xml|json)\z/i)
+        "#{path}#{"?#{query_string}" if query_string}"
+      end
+    
+      def handle_response(response)
+        case response
+        when Net::HTTPOK 
+          begin
+            JSON.parse(response.body)
+          rescue JSON::ParserError
+            response.body
+          end
+        when Net::HTTPUnauthorized
+          raise SoundcloudAuth::Dispatcher::Unauthorized, 'The credentials provided did not authorize the user.'
+        else
+          message = begin
+            JSON.parse(response.body)['error']
+          rescue JSON::ParserError
+            if match = response.body.match(/<error>(.*)<\/error>/)
+              match[1]
+            else
+              'An error occurred processing your SoundCloud request.'
+            end
+          end
+
+          raise SoundcloudAuth::Dispatcher::Error, message
+        end
+      end
+    
+      def initialize(user)
+        self.user = user
+        super(SoundcloudAuth.consumer, user.access_token, user.access_secret)
+      end
+
+      def request(http_method, path, *arguments)
+        path = SoundcloudAuth.path_prefix + path
+        path = append_extension_to(path)
+
+        response = super
+
+        handle_response(response)
+      end
+
+  end
+ end
+end

data/soundcloud-auth.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{soundcloud-auth}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Lee Martin"]
+  s.date = %q{2010-06-25}
+  s.description = %q{SoundcloudAuth is a Rails plugin gem that provides Single Sign-On capabilities for Rails applications via SoundCloud.}
+  s.email = %q{lee@soundcloud.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "app/controllers/sessions_controller.rb",
+     "app/models/soundcloud_auth/generic_user.rb",
+     "config/routes.rb",
+     "generators/soundcloud_auth/USAGE",
+     "generators/soundcloud_auth/soundcloud_auth_generator.rb",
+     "generators/soundcloud_auth/templates/migration.rb",
+     "generators/soundcloud_auth/templates/soundcloud_auth.yml",
+     "generators/soundcloud_auth/templates/user.rb",
+     "init.rb",
+     "lib/soundcloud_auth.rb",
+     "lib/soundcloud_auth/controller_extensions.rb",
+     "lib/soundcloud_auth/dispatcher/oauth.rb",
+     "pkg/soundcloud-auth-0.1.0.gem",
+     "rails/init.rb",
+     "soundcloud-auth.gemspec"
+  ]
+  s.homepage = %q{http://github.com/leemartin/soundcloud-auth}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{SoundcloudAuth is a Rails plugin gem that provides Single Sign-On capabilities for Rails applications via SoundCloud.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<oauth>, [">= 0.3.1"])
+    else
+      s.add_dependency(%q<oauth>, [">= 0.3.1"])
+    end
+  else
+    s.add_dependency(%q<oauth>, [">= 0.3.1"])
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: soundcloud-auth
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Lee Martin
@@ -57,7 +57,10 @@ files:
 - init.rb
 - lib/soundcloud_auth.rb
 - lib/soundcloud_auth/controller_extensions.rb
+- lib/soundcloud_auth/dispatcher/oauth.rb
+- pkg/soundcloud-auth-0.1.0.gem
 - rails/init.rb
+- soundcloud-auth.gemspec
 has_rdoc: true
 homepage: http://github.com/leemartin/soundcloud-auth
 licenses: []