reflex 0.0.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,24 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+rerun.txt
+test.sqlite3
+
+## PROJECT::SPECIFIC
+reflex.yml

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Tom-Eric Gerritsen (i76)
+
+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/README.rdoc

@@ -0,0 +1,193 @@
+= reflex
+
+Reflex is a gem that allows you to connect your application to the React Social API.
+
+== Install / Usage
+
+=== 1. Install Authlogic and setup your application
+
+Install authlogic (http://github.com/binarylogic/authlogic) in your rails application, and
+set it up according to the authlogic docs (http://rdoc.info/projects/binarylogic/authlogic).
+
+Take a look at the authlogic example app (http://github.com/binarylogic/authlogic_example), or
+use it as a basis, if you get stuck.
+
+=== 2. Install Reflex
+
+*WARNING!* Because the reflex gem is not yet available, the notes below are incorrect. For now, 
+simply install reflex as a rails plugin and _don't_ add it in your environment.rb or Gemfile:
+
+  $ script/plugin install git@github.com:i76/reflex.git
+
+Add the gem dependencies in your config:
+
+==== Rails 2.3
+
+Add the dependencies to your environment:
+  
+  # config/environment.rb
+  config.gem "reflex"
+
+And install them:
+
+  $ rake gems:install
+
+==== Rails 3.0 (untested)
+
+Add the dependencies to your Gemfile
+
+  # Gemfile
+  gem "reflex"
+  
+And install them:
+
+  $ bundle install
+  $ bundle lock
+
+=== 3. Generate the reflex_connections migration
+
+Now that we have the reflex gem installed, we need to generate a migration that connects our users to
+a reflex provider:
+
+==== Rails 2.3
+  
+  $ script/generate reflex_connections_migration
+
+==== Rails 3.0 (untested)
+
+  $ rails generate reflex_connections_migration
+
+=== 4. Configure the reflex gem
+
+Create a reflex configuration file:
+
+  # config/reflex.yml
+  development: &DEFAULTS
+    key: development_key
+    secret: development_secret
+    endpoint: http://social.react.com/XmlRpc_v2/
+  
+  production:
+    << DEFAULTS
+    key: production_key
+    secret: production_secret
+  
+=== 5. Make sure you save your objects properly
+
+Save your session objects with a block. Why? Because we need to redirect the user to their login provider 
+so that they can authenticate. When we do this, we don't want to execute that block of code, because if 
+we do, we will get a DoubleRender error. Using a block allows us to skip that entire block and send the 
+user along their way if they choose to authenticate via React's OAuth Server.
+
+You probably want to do this in your controllers. It should look something like this:
+
+  # app/controllers/user_session_controller.rb
+  def create
+    @user_session.save do |result|
+      if result
+        flash[:notice] = "Login successful!"
+        redirect_back_or_default account_url
+      else
+        render :action => :new
+      end
+    end
+  end
+
+When creating new users, react_profile is set if available. In order to make use of this, 
+alter your user class like this:
+
+  # app/models/user.rb
+  class User < ActiveRecord::Base
+    acts_as_authentic
+    
+    def react_profile=(profile)
+      self.name = profile['real_name'] || profile['user_name']
+    end
+  end
+
+=== 6. Add providers to your login form
+
+Add providers to your login form:
+
+  # app/views/new.html.erb
+  <h1>Log in</h1>
+  <% form_for(@user_session) do |f| %>
+    <%= f.error_messages %>
+    <h2>Log in with your account</h2>
+    <p>
+      <%= f.label :login %>
+      <br>
+      <%= f.text_field :login %>
+    </p>
+    <p>
+      <%= f.label :password %>
+      <br>
+      <%= f.password_field :password %>
+    </p>
+    <p><%= f.submit "Login" %></p>
+    
+    <h2>Or log in via:</h2>
+    <% Reflex::OAuthServer.get_providers.each do |provider| %>
+      <%= f.submit provider, :name => "react_provider" %>
+      <br>
+    <% end %>
+  <% end %>
+
+== Connecting existing users to react
+
+Ofcourse connecting an existing user to a social network should be as easy and straightforward as
+authenticating a new user. And luckilly it is!
+
+Modify your user update method to accept a block:
+
+  # app/controllers/users_controller.rb
+  def update
+    @user = User.find(params[:id])
+    @user.attributes = params[:attributes]
+    
+    @user.save do |result|
+      if result
+        flash[:notice] = "User updated successfully!"
+        redirect_to(@user)
+      else
+        render :action => :edit
+      end
+    end
+  end
+
+And add the react providers in the view:
+
+  # app/views/users/edit.html.erb
+  <% form_for(@user) do |f| %>
+    <%= f.error_messages %>
+    <p>
+      Connect to a provider:
+      <br>
+      <% Reflex::OAuthServer.get_providers.each do |provider| %>
+        <%= f.submit provider, :name => "react_provider" %>
+      <% end %>
+    </p>
+
+    <p><%= f.submit "Save" %></p>
+  <% end %>
+
+== Roadmap
+
+The reflex gem is far from finished. Here are some of the upcoming features:
+
+1. Easily access the React API — If a user connected to, for example twitter,
+   then it should be a matter of calling:
+   `@user.twitter.update_status("I've connected my Twitter profile")`
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Tom-Eric Gerritsen. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,146 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "reflex"
+    gem.summary = %Q{Reflex connects your app to the React Social API}
+    gem.description = %Q{Reflex is a gem that allows you to connect your application to the React Social API}
+    gem.email = "tomeric@i76.nl"
+    gem.homepage = "http://github.com/i76/reflex"
+    gem.authors = ["Tom-Eric Gerritsen"]
+    gem.add_dependency "authlogic", ">= 2.1.3"
+    gem.add_dependency "uuidtools", ">= 2.1.1"
+    gem.add_development_dependency "cucumber",         ">= 0.6.2"
+    gem.add_development_dependency "cucumber-rails",   ">= 0.2.4"
+    gem.add_development_dependency "capybara",         ">= 0.3.0"
+    gem.add_development_dependency "database_cleaner", ">= 0.4.3"
+    gem.add_development_dependency "mocha",            ">= 0.9.8"
+    gem.add_development_dependency "rspec",            ">= 1.2.9"
+    gem.add_development_dependency "fakeweb",          ">= 1.2.8"
+    gem.add_development_dependency "mime-types",       ">= 1.16"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "reflex #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'cucumber/rake/task'
+  load 'features/support/rails_root/Rakefile'
+
+  namespace :cucumber do
+    Cucumber::Rake::Task.new({:ok => ['db:reset']}, 'Run features that should pass') do |t|
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'default'
+    end
+
+    Cucumber::Rake::Task.new({:wip => ['db:reset']}, 'Run features that are being worked on') do |t|
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'wip'
+    end
+
+    desc 'Run all features'
+    task :all => [:ok, :wip]
+  end
+  desc 'Alias for cucumber:ok'
+  task :cucumber => 'cucumber:ok'
+
+  task :default => :cucumber
+
+  task :features => :cucumber do
+    STDERR.puts "*** The 'features' task is deprecated. See rake -T cucumber ***"
+  end
+
+rescue LoadError
+  desc 'cucumber rake task not available (cucumber not installed)'
+  task :cucumber do
+    abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+  end
+end
+
+namespace :reflex do
+  desc "Configure reflex"
+  task :config do
+    require 'yaml'
+    require 'lib/reflex'
+    
+    config_file = File.join(File.dirname(__FILE__), 'spec', 'reflex.yml')    
+    
+    if File.exists?(config_file)
+      settings = YAML.load(File.open(config_file))
+      configuration = settings.inject({}) do |options, (key, value)|
+                        options[(key.to_sym rescue key) || key] = value
+                        options
+                      end
+
+      Reflex.configure(configuration)
+    else
+      puts "** [Reflex] #{config_file} does not exist, skipping Reflex configuration"
+    end
+  end
+  
+  desc "List methods that have not yet been added to the library, but are available"
+  task :missing_methods do
+    Rake::Task['reflex:config'].invoke
+    
+    def class_exists? kls
+      begin
+        kls = constantize(kls)
+        kls.kind_of? Class
+      rescue Exception
+        false
+      end
+    end
+    
+    def constantize(kls)
+      Object.module_eval("::#{kls}", __FILE__, __LINE__)      
+    end
+    
+    all_methods = Reflex::System.list_methods
+    all_methods.each do |method|
+      remote_class, camel_cased_method = method.split('.')
+      local_class  = "Reflex::#{remote_class}"
+      local_method = camel_cased_method.gsub(/::/, '/').gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').gsub(/([a-z\d])([A-Z])/,'\1_\2').tr("-", "_").downcase.to_sym
+      
+      class_exists  = class_exists?(local_class)
+      method_exists = class_exists && constantize(local_class).respond_to?(local_method)
+      
+      unless class_exists && method_exists
+        method_description = Reflex::System.method_description(method)
+        parameters  = method_description['parameters'].map { |name, doc| "(#{doc['type']}) #{name} : #{doc['description']}" }.join("\n             ")
+        description = method_description['method']['description']
+        
+        puts "\n             == #{method} ==\n      Local: #{local_class}.#{local_method}\n Parameters: #{parameters}\nDescription: #{description}\n"
+      end
+    end
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/cucumber.yml

@@ -0,0 +1,7 @@
+<%
+rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
+rerun_opts = rerun.to_s.strip.empty? ? "--format progress features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
+std_opts = "#{rerun_opts} --format rerun --out rerun.txt --strict --tags ~@wip"
+%>
+default: <%= std_opts %>
+wip: --tags @wip:3 --wip features

data/features/connect_to_provider.feature

@@ -0,0 +1,18 @@
+Feature: Connect to provider
+  In order to use the new social login features
+  As an existing user
+  I want to connect my profile to a social provider
+  
+  Scenario: Connect to a provider
+    Given a registered user exists with login: "marshall", password: "awesome"
+    And I am logged in as "marshall" with password "awesome"
+    And I am on my profile
+    And I follow "Edit my profile"   
+    
+    Given a token access is expected for an unregistered user
+    And a user id is set for the available token    
+    When I press "Twitter"
+    # And I press "Allow"
+    
+    When I go to my profile
+    Then I should see "Twitter"

data/features/social_authentication.feature

@@ -0,0 +1,50 @@
+Feature: Social authentication
+  In order to allow visitors to get access to certain features
+  As a visitor who is connected to one of our social providers
+  I want to login via one of these social providers
+  
+  Scenario: Logging in for the first time
+    Given I am on the homepage
+    And I follow "Login"
+
+    Given a token request is expected
+    When I press "Twitter"
+
+    Given a token access is expected for an unregistered user
+    And a session profile fetched is expected
+    And a user id is set for the available token
+    When I press "Allow"
+
+    Then I should be logged in
+    And I should see "Marshall Eriksen"
+  
+  Scenario: Logging in for the second time
+    Given a "Twitter" user exists
+    And I am on the homepage
+    Then I should see "Marshall Eriksen"
+    
+    When I follow "Login"
+    
+    Given a token request is expected
+    When I press "Twitter"
+    
+    Given a token access is expected for a registered user
+    When I press "Allow"
+    And I should be logged in
+    And 1 user should exist
+    
+    When I follow "My Profile"
+    Then I should see "Marshall Eriksen"
+  
+  Scenario: Updating my profile
+    Given I login as the "Twitter" user "Marshall Eriksen"
+    And I am on the homepage
+    
+    When I follow "My Profile"
+    And I follow "Edit my profile"
+    And I fill in "Name" with "Big Fudge"
+    And I press "Save"
+    Then I should see "Succesfully updated user"
+    
+    When I follow "My Profile"
+    Then I should see "Big Fudge"

data/features/step_definitions/reflex_steps.rb

@@ -0,0 +1,93 @@
+Given /^a "([^\"]*)" user exists$/ do |provider|
+  Given "a \"#{provider}\" user exists with name: \"Marshall Eriksen\""
+end
+
+Given /^a "([^\"]*)" user exists with name: "([^\"]*)"$/ do |provider, name|
+  record = User.new(:name => name)
+  record.reflex_connections.build(:provider => 'Twitter')
+  record.save!
+end
+
+Given /^I login as the "([^\"]*)" user "([^\"]*)"$/ do |provider, name|
+  Given "a \"#{provider}\" user exists with name: \"#{name}\""
+  And "I am on the login page"
+  
+  Given "a token request is expected"
+  When "I press \"Twitter\""
+  
+  Given "a token access is expected for a registered user"
+  When "I press \"Allow\""
+  
+  Then "I should be logged in"
+end
+
+Given /^([0-9]+) users? should exist$/ do |count|
+  User.count.should eql(count.to_i)
+end
+
+Given /^a token request is expected$/ do
+  @provider ||= 'Twitter'
+
+  Reflex::OAuthServer.expects(:token_request).with(@provider).returns({ 
+    'redirectUrl'       => 'https://twitter.com/fake_controller/oauth/authorize',
+    'reactOAuthSession' => 'FAKE_OAUTH_TOKEN'
+  })
+end
+
+Given /^a token access is expected for an unregistered user$/ do
+  @provider ||= 'Twitter'
+
+  Reflex::OAuthServer.expects(:token_access).returns({ 
+    'connectedWithProvider' => @provider,
+    'reactOAuthSession'     => 'FAKE_REACT_OAUTH_SESSION'
+  })
+end
+
+Given /^a token access is expected for a registered user$/ do
+  @provider ||= 'Twitter'
+  application_user_id = User.last.reflex_connections.first.uuid
+
+  Reflex::OAuthServer.expects(:token_access).returns({ 
+    'connectedWithProvider' => @provider,
+    'reactOAuthSession'     => 'FAKE_REACT_OAUTH_SESSION',
+    'applicationUserId'     => application_user_id
+  })
+end
+
+Given /^a session profile fetched is expected$/ do
+  Reflex::OAuthServer.expects(:session_get_profile).with('FAKE_OAUTH_TOKEN').returns({
+    'real_name'       => 'Marshall Eriksen',
+    'user_name'       => 'marshall',
+    'profile_picture' => 'http://awesome.com/marshall.jpg'
+  })  
+end
+
+Given /^a user id is set for the available token$/ do
+  @provider ||= 'Twitter'
+
+  Reflex::OAuthServer.expects(:token_set_user_id).returns({
+    'applicationUserId'     => 1,
+    'connectedWithProvider' => @provider,
+  })
+end
+
+Given /^a registered user exists with login: "([^\"]*)", password: "([^\"]*)"$/ do |login, password|
+  User.create!(:login => login, :name => login, :password => password, :password_confirmation => password)
+end
+
+Given /^I am logged in as "([^\"]*)" with password "([^\"]*)"$/ do |login, password|
+  When "I am on the login page"
+  And "I fill in \"Login\" with \"#{login}\""
+  And "I fill in \"Password\" with \"#{password}\""
+  And "I press \"Login\""
+end
+
+Then /^I should be logged out$/ do
+  Then "I should not see \"My Profile\""
+  And "I should see \"Login\""
+end
+
+Then /^I should be logged in$/ do
+  Then "I should see \"My Profile\""
+  And "I should see \"Logout\""
+end