bleacher_api 0.1.0 → 0.1.1

data/README.md

@@ -15,6 +15,8 @@ Table of Contents
 
 * [GET /api/article/article.json](#article_article)
 * [POST /api/authenticate/login.json](#authenticate_login)
+* [GET /api/authenticate/logout.json](#authenticate_logout)
+* [GET /api/authenticate/signup](#authenticate_signup)
 * [GET /api/front/lead_articles.json](#front_lead_articles)
 * [GET /api/geolocation/teams.json](#geolocation_teams)
 * [GET /api/related/channel.json](#related_channel)
@@ -32,6 +34,7 @@ GET /api/article/article.json
 * id - Article ID (required)
 * article - When given any value, action includes article body in JSON output
 * article[entry_id] - Changes article body to a quick hit or live blog entry
+* article[only] - When given comma-separated parameters, returns only values for the parameters in JSON output
 * comments[page] - When given a page number, action includes comments in JSON output
 * related_content - When given any value, action includes related content in JSON output
 
@@ -62,6 +65,7 @@ POST /api/authenticate/login.json
 
 * user[email]
 * user[password]
+* redirect_url (optional)
 
 ### Returns
 
@@ -81,6 +85,68 @@ http://bleacherreport.com/api/authenticate/login.json?user[email]=your@email.com
 
 Please note that any request with a password should be sent as a POST, despite this example using GET.
 
+### Redirect
+
+When a `redirect_url` parameter is specified, B/R will redirect the request back to that URL, passing basic information
+from the <a href="#user_user">User API</a> as GET parameters.
+
+If the login fails, B/R will redirect the request back to the URL with a `fail=1` GET parameter.
+
+<a name="authenticate_logout"></a>
+
+GET /api/authenticate/logout.json
+---------------------------------
+
+### Parameters
+
+* redirect_url (optional)
+
+### Returns
+
+Returns `true` if succeeded, `false` if not.
+
+### Ruby Example
+
+<pre>
+BleacherApi::Authenticate.logout
+</pre>
+
+### HTTP Example
+
+<pre>
+http://bleacherreport.com/api/authenticate/logout.json
+</pre>
+
+### Redirect
+
+When a `redirect_url` parameter is specified, B/R will redirect the request back to that URL, passing a `fail=1` parameter
+if the logout failed.
+
+<a name="authenticate_signup"></a>
+
+GET /api/authenticate/signup
+----------------------------
+
+### Parameters
+
+* redirect_url
+* type (optional) - Optional values for this include: "fantasy"
+
+### Returns
+
+An HTML page with a sign up form.
+
+### HTTP Example
+
+<pre>
+http://bleacherreport.com/api/authenticate/signup?redirect_url=http://bleacherreport.com&type=fantasy
+</pre>
+
+### Redirect
+
+A `redirect_url` parameter is mandatory. B/R will redirect the request back to that URL, passing basic information
+from the <a href="#user_user">User API</a> as GET parameters.
+
 <a name="front_lead_articles"></a>
 
 GET /api/front/lead_articles.json
@@ -341,4 +407,4 @@ LOGIN=user@user.com PASSWORD=password URL=http://localhost ONLY=geolocation spec
 
 <code>URL</code> defaults to "http://bleacherreport.com".
 
-<code>ONLY</code> is optional, and allows you to only run a specific group of specs.
+<code>ONLY</code> is optional, and allows you to only run a specific group of specs.

data/config/gemspec.yml

@@ -1,5 +1,5 @@
 name: bleacher_api
-version: 0.1.0
+version: 0.1.1
 authors:
   - Bleacher Report
 email: wwelsh@bleacherreport.com

data/lib/bleacher_api.rb

@@ -27,16 +27,21 @@ class BleacherApi
   
   class Authenticate
     class <<self
-      def login(email, password)
+      def login(email, password, redirect=nil)
         result = BleacherApi.call(:post, 'authenticate/login', {
           'user[email]' => email,
-          'user[password]' => password
+          'user[password]' => password,
+          'redirect' => nil
         })
         if result
           BleacherApi::Config.token result['token']
         end
         result
       end
+
+      def logout
+        BleacherApi.call(:get, 'authenticate/logout')
+      end
     end
   end
   

data/spec/bleacher_api_spec.rb

@@ -8,26 +8,40 @@ describe BleacherApi do
   
   if only?(:Authenticate)
     describe :Authenticate do
-      describe 'success' do
-        before(:all) do
-          @response = BleacherApi::Authenticate.login(ENV['LOGIN'], ENV['PASSWORD'])
-        end
-    
-        it "should return a hash with valid keys" do
-          @response.keys.length.should == @user_keys.length
-          (@response.keys - @user_keys).should == []
+      describe :login do
+        
+        describe 'success' do
+          before(:all) do
+            @response = BleacherApi::Authenticate.login(ENV['LOGIN'], ENV['PASSWORD'])
+          end
+      
+          it "should return a hash with valid keys" do
+            @response.keys.length.should == @user_keys.length
+            (@response.keys - @user_keys).should == []
+          end
+        
+          it "should set Config.token" do
+            BleacherApi::Config.token.should == @response['token']
+          end
         end
       
-        it "should set Config.token" do
-          BleacherApi::Config.token.should == @response['token']
+        describe 'failure' do
+          before(:all) do
+            @response = BleacherApi::Authenticate.login('fail', 'fail')
+          end
+      
+          it "should return false" do
+            @response.should == false
+          end
         end
       end
-    
-      describe 'failure' do
+
+      describe :logout do
+
         before(:all) do
-          @response = BleacherApi::Authenticate.login('fail', 'fail')
+          @response = BleacherApi::Authenticate.logout
         end
-    
+
         it "should return false" do
           @response.should == false
         end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bleacher_api
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Bleacher Report
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-25 00:00:00 -07:00
+date: 2011-07-29 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency