guestlist 0.0.1

data/README.textile

@@ -0,0 +1,48 @@
+h1. Guestlist
+
+Simple authentication using Github credentials.
+
+h2. Installation
+
+The installation is really simple, just throw this in your @Gemfile@:
+
+bc. gem 'guestlist'
+
+And run:
+
+bc. bundle install
+
+Or -- if you're using Rails 2.x -- put this in @config/environment.rb@:
+
+bc. config.gem 'guestlist'
+
+And run:
+
+bc. rake gems:install
+
+Include @Guestlist@ in your user model (mine is called @User@):
+
+<pre><code>class User
+  # It works with ActiveRecord too. ;)
+  include MongoMapper::Document
+  include Guestlist
+
+  key :login,           String
+  key :encrypted_token, String
+end</code></pre>
+
+Make sure you have both @login@ and @encrypted_token@ fields in your database if you're using ActiveRecord ("here's a migration":http://gist.github.com/369610), or add some <code>key</code>s to your "MongoMapper":mongomapper.com/ model like in the example above.
+
+Believe it or not, you're all set. Let's try it (you can find your token on the "Github account page":https://github.com/account):
+
+bc. User.authenticate 'github_login', 'github_token'
+
+Guestlist will automatically create a new @User@ for you and return that, or false if you've entered a wrong login or token. The user's token is stored -- yes, encrypted -- , so next time you log in, it'll just authenticate you via the database.
+
+h2. Contributing
+
+Found any issues? Have a great idea? Want to help? Great! Create an issue "issue":http://github.com/jeffkreeftmeijer/guestlist/issues for it, or even better; "fork the project":http://github.com/jeffkreeftmeijer/guestlist/fork. Pull requests are always welcome. :)
+
+h2. License
+
+Copyright (c) 2009 Jeff Kreeftmeijer, released under the MIT license

data/lib/guestlist.rb

@@ -0,0 +1,28 @@
+require 'guestlist/github'
+
+module Guestlist
+  module ClassMethods
+    def authenticate(login, token)
+      attributes = {:login => login, :encrypted_token => encrypt(token)}
+
+      if user = find_by_login(login)
+        return user if user.encrypted_token == attributes[:encrypted_token]
+      end
+
+      if Github.fetch(login, token)
+        user.update_attributes(attributes) if user
+        user || User.create!(attributes)
+      end
+    end
+
+    protected
+
+    def encrypt(string)
+      Digest::SHA1.hexdigest(string)
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+end

data/lib/guestlist/github.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'httparty'
+
+module Guestlist
+  class Github
+    class StatusError < StandardError; end
+
+    def self.fetch(login, token)
+      response = HTTParty.post(
+        "http://github.com/api/v2/json/user/show/#{login}",
+        {
+          :query => {
+            :login => login,
+            :token => token
+          }
+        }
+      )
+
+      case response.code
+        when 200; response
+        when 401; false
+        else; raise StatusError, response.code
+      end
+    end
+  end
+end

data/spec/guestlist/github_spec.rb

@@ -0,0 +1,65 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Guestlist::Github do
+  describe '.fetch' do
+    before do
+      @ok = File.read(
+        File.expand_path(
+          File.dirname(__FILE__) + '/../stubs/github_200.xml'
+        )
+      )
+    end
+
+    it 'should call to Github via HTTParty' do
+      HTTParty.should_receive(:post).with(
+        'http://github.com/api/v2/json/user/show/login',
+        :query => {
+          :login => 'login',
+          :token => 't0k3n'
+        }
+      ).and_return(
+        HTTParty::Response.new(
+          Crack::JSON.parse(@ok), @ok, 200, 'message'
+        )
+      )
+
+      Guestlist::Github.fetch('login', 't0k3n')
+    end
+
+    it 'should return a hash with user data' do
+      HTTParty.stub!(:post).and_return(
+        HTTParty::Response.new(
+          Crack::JSON.parse(@ok), @ok, 200, 'message'
+        )
+      )
+
+      result = Guestlist::Github.fetch('login', 't0k3n')
+      result.should be_instance_of Hash
+      result.length.should == 1
+      result['user']['name'].should == 'Bob'
+      result['user']['blog'].should == 'http://bobsblog.com'
+    end
+
+    it 'should return false when authentication fails' do
+      HTTParty.stub!(:post).and_return(
+        HTTParty::Response.new(
+          {}, '', 401, 'message'
+        )
+      )
+
+      Guestlist::Github.fetch('wronglogin', 't3k0n').should == false
+    end
+
+    it 'should raise an error when anything else happens' do
+      HTTParty.stub!(:post).and_return(
+        HTTParty::Response.new(
+          {}, '', 500, 'message'
+        )
+      )
+
+      lambda {
+        Guestlist::Github.fetch('login', 't0k3n')
+      }.should raise_error(Guestlist::Github::StatusError, 500)
+    end
+  end
+end

data/spec/guestlist_spec.rb

@@ -0,0 +1,114 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Guestlist do
+  before do
+    @github_200 = Crack::JSON.parse(
+      File.read(
+        File.expand_path(
+          File.dirname(__FILE__) + '/stubs/github_200.xml'
+        )
+      )
+    )
+  end
+  describe '#authenticate' do
+    it 'should call find with the login' do
+      User.should_receive(:find_by_login).with('login')
+      User.authenticate('login', 'token')
+    end
+
+    describe 'when authenticating an existing user' do
+      describe 'with the correct token' do
+        it 'should return the user' do
+          User.authenticate('exists', 'token').should be_instance_of User
+        end
+
+        it 'should not try to fetch the user' do
+          Guestlist::Github.should_not_receive(:fetch)
+          User.authenticate('exists', 'token')
+        end
+
+        it 'should not create a new user' do
+          User.should_not_receive(:create!)
+          User.authenticate('exists', 'token')
+        end
+      end
+      
+      describe 'with an incorrect token' do
+        it 'should not return the user' do
+          User.authenticate('exists', 'wrongtoken').should == nil
+        end
+        
+        it 'should try to fetch the user' do
+          Guestlist::Github.should_receive(:fetch).with('exists', 'wrongtoken')
+          User.authenticate('exists', 'wrongtoken')
+        end
+        
+        describe 'that seems to be correct after all' do
+          before do
+            Guestlist::Github.stub!(:fetch).and_return(@github_200)
+          end
+          
+          it 'should return the user' do
+            User.authenticate('exists', 'newtoken').should be_instance_of User
+          end
+          
+          it 'should not create a new user' do
+            User.should_not_receive(:create!)
+            User.authenticate('exists', 'newtoken')
+          end
+
+          it 'should update the user token' do
+            user = User.new
+            User.stub(:find_by_login).and_return(user)
+            user.should_receive(:update_attributes).with({
+              :login =>           'exists',
+              :encrypted_token => Digest::SHA1.hexdigest('newtoken')
+            })
+            @user = User.authenticate('exists', 'newtoken')
+          end
+        end
+      end
+    end
+
+    describe 'when authenticating a user that does not exist yet' do
+      before do
+        User.stub(:find_by_login).and_return(nil)
+        Guestlist::Github.stub!(:fetch).and_return(@github_200)
+      end
+
+      it 'should try to fetch the user' do
+        Guestlist::Github.should_receive(:fetch).with('doesnt_exist_yet', 'token')
+        User.authenticate('doesnt_exist_yet', 'token')
+      end
+
+      it 'should create a new user' do
+        User.should_receive(:create!).with({
+          :login =>           'doesnt_exist_yet',
+          :encrypted_token => Digest::SHA1.hexdigest('token')
+        })
+        User.authenticate('doesnt_exist_yet', 'token')
+      end
+    end
+
+    describe 'when authenticating a user that does not exist' do
+      before do
+        User.stub(:find_by_login).and_return(nil)
+        Guestlist::Github.stub!(:fetch).and_return(false)
+      end
+      it 'should return nil' do
+        User.should_receive(:find_by_login).and_return(nil)
+        User.authenticate('doesnt_exist', 'token').should == nil
+      end
+
+      it 'should try to fetch the user' do
+        Guestlist::Github.should_receive(:fetch).with('doesnt_exist', 'token')
+        User.authenticate('doesnt_exist', 'token')
+      end
+
+      it 'should not create a new user' do
+        User.should_not_receive(:create!)
+        User.authenticate('doesnt_exist', 'token')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'guestlist'
+require 'spec'
+require 'spec/autorun'
+
+require 'crack'
+
+Spec::Runner.configure do |config|
+end
+
+class User
+  include Guestlist
+
+  def self.find_by_login(*args)
+    return new
+  end
+
+  def self.create!(*args)
+    return new
+  end
+  
+  def encrypted_token
+    Digest::SHA1.hexdigest('token')
+  end
+  
+  def update_attributes(*args)
+    return true
+  end
+end

data/spec/stubs/github_200.xml

@@ -0,0 +1,28 @@
+{
+  "user": {
+    "plan": {
+      "name":"free",
+      "collaborators":0,
+      "space":307200,
+      "private_repos":0
+     },
+     "gravatar_id":"f03f4ce7b507aede346263d218228b6a",
+     "name":"Bob",
+     "company":"c0mp4ny",
+     "location":"l0c4ti0n",
+     "created_at":"2009/01/01 07:26:12 -0800",
+     "collaborators":0,
+     "disk_usage":21900,
+     "public_gist_count":24,
+     "public_repo_count":15,
+     "blog":"http://bobsblog.com",
+     "following_count":12,
+     "id":43621,
+     "private_gist_count":5,
+     "owned_private_repo_count":0,
+     "total_private_repo_count":0,
+     "followers_count":14,
+     "login":"login",
+     "email":"bob@email.com"
+  }
+}

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: guestlist
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jeff Kreeftmeijer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-18 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: 
+description: Simple authentication using Github credentials.
+email: jeff@kreeftmeijer.nl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/guestlist/github.rb
+- lib/guestlist.rb
+- spec/guestlist/github_spec.rb
+- spec/guestlist_spec.rb
+- spec/spec_helper.rb
+- spec/stubs/github_200.xml
+- README.textile
+has_rdoc: true
+homepage: http://github.com/jeffkreeftmeijer/guestlist
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Simple authentication using Github credentials.
+test_files: []
+