alterego 0.0.3 → 0.0.4

data/.travis.yml

@@ -0,0 +1 @@
+rvm: 1.9.2

data/Gemfile

@@ -5,10 +5,10 @@ gem 'json'
 
 # Add dependencies to develop your gem here.
 group :development do
-	gem 'bundler', '~> 1.0.0'
+	gem 'bundler', '> 1.0.0'
 	gem 'fakeweb'
 	gem 'guard-rspec'
-	gem 'jeweler', '~> 1.6.4'
-	gem 'rcov'
+	gem 'jeweler', '> 1.6.4'
+	gem 'simplecov'
   gem 'rspec'
 end

data/README.rdoc

@@ -1,4 +1,4 @@
-= AlterEgo
+= AlterEgo {<img src="http://travis-ci.org/terra-firma/alterego.png" />}[http://travis-ci.org/terra-firma/alterego] {<img src="https://gemnasium.com/terra-firma/alterego.png" alt="Dependency Status" />}[https://gemnasium.com/terra-firma/alterego]
 
 AlterEgo is a Ruby gem for integrating {AlterEgo}[https://alteregoapp.com] two-factor authentication into your web application. You'll need an {AlterEgo account}[https://alteregoapp.com/#signupfree] in order to register your {register your app}[https://alteregoapp.com/app/register] and get your "App Authentication ID".
 
@@ -6,9 +6,17 @@ AlterEgo is a Ruby gem for integrating {AlterEgo}[https://alteregoapp.com] two-f
 
   (sudo) gem install alterego
 
-== Authorizing Your Application
+== Usage
 
-In order to use AlterEgo, users of your application will need to sign up for their own {AlterEgo account}[https://alteregoapp.com/#signupfree]. You will need your users to authorize the connection between your application and {AlterEgo}[https://alteregoapp.com] by simply redirecting them:
+To start with, you will need an {AlterEgo account}[https://alteregoapp.com/#signup] as a developer so that you can register your app. People that want to use your application will also need to {signup for an AlterEgo account}[https://alteregoapp.com/#signup] (obviously) as well.
+
+=== Register Your App
+
+{Login to your AlterEgo account}[https://alteregoapp.com/app/] and click "{register a new app}[https://alteregoapp.com/app/register]" on the "Developer" page. Once your app is registered, you will get an "App Authentication ID", which we refer to in this document at the "App ID". You're now ready to get started.
+
+=== Connect Your App
+
+The first thing you will need to do is prompt your users to authorize the connection between your application and {AlterEgo}[https://alteregoapp.com]. Once they are logged in, simply redirect them:
 
   redirect_to AlterEgo.authorization_url("your_app_id", "https://yourapp.com/alterego/callback")
 
@@ -19,28 +27,37 @@ In order to use AlterEgo, users of your application will need to sign up for the
 
 Once authorized successfully, a POST request will be sent to the +redirect_url+ with a "key" parameter containing the API key for that user's {AlterEgo}[https://alteregoapp.com] account. Be sure to store this key somewhere, as you will need it to run API requests later. If authorization fails for some reason, an "error" parameter will be present in the POST request, containing an error message.
 
-  if params[:key]
-    current_user.alter_ego_key = params[:key]
-  elsif params[:error]
-    flash[:alert] = params[:error]
+  def callback
+    # POST /alterego/callback
+    if params[:key]
+      current_user.alter_ego_key = params[:key]
+      current_user.save
+      ...
+    elsif params[:error]
+      flash[:alert] = params[:error]
+      ...
+    end
   end
 
-== Authenticating With AlterEgo
+As you can see, we are saving the key that AlterEgo returns for the currently logged in user, and we have successfully connected this user account to AlterEgo.
+
+=== Authenticating With AlterEgo
 
-Once your users have authorized your application and you have retrieved an API key for their account, you can easily integrate two-factor authentication. To authenticate using {AlterEgo}[https://alteregoapp.com] (either as part of an existing login process, or as a stand-alone authentication system) simply prompt the user to input a valid {AlterEgo}[https://alteregoapp.com] passcode and verify it:
+Once the user account has been connected, you can easily integrate two-factor authentication into your app, either as part of an existing login process, or as a stand-alone authentication system. In most cases, {AlterEgo}[https://alteregoapp.com] is integrated into an existing authentication system such that once the user has provided the correct username/password combination, they are then asked to provide a valid {AlterEgo}[https://alteregoapp.com] passcode to finalize the login process:
 
-  passcode = params[:alter_ego_passcode]
-  if AlterEgo.password(current_user.alter_ego_key, passcode)
-    # Passcode is valid.
-    ...
-  else
-    # Passcode is not valid.
-    ...
+  def verify
+    # POST /alterego/verify
+    passcode = params[:alter_ego_passcode]
+    if AlterEgo.password(current_user.alter_ego_key, passcode)
+      # Passcode is valid, log this user in...
+    else
+      # Passcode is not valid.
+    end
   end
 
 {AlterEgo}[https://alteregoapp.com] does not provide any kind of error message or explanation as to why a passcode is not valid, so you will want to be sure and keep your error messages appropriately generic.
 
-== Pinging The API
+=== Pinging The API
 
 The {AlterEgo}[https://alteregoapp.com] API also has a method for pinging the API, in case you want to periodically check to ensure that your user's API keys are still valid. A successful ping to the API will always return "PONG!" as a response.
 
@@ -48,16 +65,15 @@ The {AlterEgo}[https://alteregoapp.com] API also has a method for pinging the AP
 
 == Contributing to AlterEgo
  
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
 == Copyright
 
-Copyright (c) 2011 Brian Getting. See LICENSE.txt for
-further details.
+Copyright (c) 2011 Terra Firma Design & Consulting. See LICENSE.txt for further details.
 

data/Rakefile

@@ -15,11 +15,11 @@ require 'jeweler'
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
   gem.name = "alterego"
-  gem.homepage = "http://github.com/terra-firma/alterego"
+  gem.homepage = "http://github.com/tatemae-consultancy/alterego"
   gem.license = "MIT"
   gem.summary = %Q{Ruby gem for interacting with the AlterEgo API.}
   gem.description = %Q{AlterEgo is a Ruby gem for integrating two-factor authentication into your web application.}
-  gem.email = "brian@terra-firma-design.com"
+  gem.email = "brian@tatem.ae"
   gem.authors = ["Brian Getting"]
   # dependencies defined in Gemfile
 end
@@ -32,14 +32,6 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-  test.rcov_opts << '--exclude "gems/*"'
-end
-
 task :default => :test
 
 require 'rdoc/task'

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/alterego.gemspec

@@ -5,19 +5,20 @@
 
 Gem::Specification.new do |s|
   s.name = %q{alterego}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Brian Getting}]
-  s.date = %q{2011-10-17}
+  s.date = %q{2012-08-02}
   s.description = %q{AlterEgo is a Ruby gem for integrating two-factor authentication into your web application.}
-  s.email = %q{brian@terra-firma-design.com}
+  s.email = %q{brian@tatem.ae}
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
   ]
   s.files = [
     ".document",
+    ".travis.yml",
     "Gemfile",
     "Guardfile",
     "LICENSE.txt",
@@ -30,7 +31,7 @@ Gem::Specification.new do |s|
     "spec/alterego/fixtures/error.json",
     "spec/spec_helper.rb"
   ]
-  s.homepage = %q{http://github.com/terra-firma/alterego}
+  s.homepage = %q{http://github.com/tatemae-consultancy/alterego}
   s.licenses = [%q{MIT}]
   s.require_paths = [%q{lib}]
   s.rubygems_version = %q{1.8.8}
@@ -41,28 +42,28 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<json>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<bundler>, ["> 1.0.0"])
       s.add_development_dependency(%q<fakeweb>, [">= 0"])
       s.add_development_dependency(%q<guard-rspec>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["> 1.6.4"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
     else
       s.add_dependency(%q<json>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<bundler>, ["> 1.0.0"])
       s.add_dependency(%q<fakeweb>, [">= 0"])
       s.add_dependency(%q<guard-rspec>, [">= 0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
-      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["> 1.6.4"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 0"])
     end
   else
     s.add_dependency(%q<json>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<bundler>, ["> 1.0.0"])
     s.add_dependency(%q<fakeweb>, [">= 0"])
     s.add_dependency(%q<guard-rspec>, [">= 0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
-    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["> 1.6.4"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 0"])
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alterego
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-17 00:00:00.000000000Z
+date: 2012-08-02 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2153522520 !ruby/object:Gem::Requirement
+  requirement: &2153238280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,21 +21,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153522520
+  version_requirements: *2153238280
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2153520800 !ruby/object:Gem::Requirement
+  requirement: &2153237180 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>'
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2153520800
+  version_requirements: *2153237180
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &2153518960 !ruby/object:Gem::Requirement
+  requirement: &2153235820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153518960
+  version_requirements: *2153235820
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &2153517220 !ruby/object:Gem::Requirement
+  requirement: &2153234600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,21 +54,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153517220
+  version_requirements: *2153234600
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2153515440 !ruby/object:Gem::Requirement
+  requirement: &2153232340 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>'
       - !ruby/object:Gem::Version
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *2153515440
+  version_requirements: *2153232340
 - !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: &2153512980 !ruby/object:Gem::Requirement
+  name: simplecov
+  requirement: &2153231140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153512980
+  version_requirements: *2153231140
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153510180 !ruby/object:Gem::Requirement
+  requirement: &2153230140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153510180
+  version_requirements: *2153230140
 description: AlterEgo is a Ruby gem for integrating two-factor authentication into
   your web application.
-email: brian@terra-firma-design.com
+email: brian@tatem.ae
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -98,6 +98,7 @@ extra_rdoc_files:
 - README.rdoc
 files:
 - .document
+- .travis.yml
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -109,7 +110,7 @@ files:
 - spec/alterego/alterego_spec.rb
 - spec/alterego/fixtures/error.json
 - spec/spec_helper.rb
-homepage: http://github.com/terra-firma/alterego
+homepage: http://github.com/tatemae-consultancy/alterego
 licenses:
 - MIT
 post_install_message: 
@@ -124,7 +125,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3242706057364793623
+      hash: -803280784846671092
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: