bleacher_api 0.1.1 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. data/README.md +23 -9
  2. data/config/gemsets.yml +3 -3
  3. data/config/gemspec.yml +1 -1
  4. metadata +5 -16
data/README.md CHANGED
@@ -14,7 +14,8 @@ Table of Contents
14
14
  -----------------
15
15
 
16
16
  * [GET /api/article/article.json](#article_article)
17
- * [POST /api/authenticate/login.json](#authenticate_login)
17
+ * [GET /api/authenticate/login](#authenticate_login)
18
+ * [POST /api/authenticate/login.json](#authenticate_login_post)
18
19
  * [GET /api/authenticate/logout.json](#authenticate_logout)
19
20
  * [GET /api/authenticate/signup](#authenticate_signup)
20
21
  * [GET /api/front/lead_articles.json](#front_lead_articles)
@@ -58,6 +59,27 @@ http://bleacherreport.com/api/article/article.json?id=595888&article=1&comments[
58
59
 
59
60
  <a name="authenticate_login"></a>
60
61
 
62
+ GET /api/authenticate/login
63
+ ---------------------------
64
+
65
+ ### Parameters
66
+
67
+ * redirect_url
68
+ * type (optional) - Optional values for this include: "fantasy"
69
+
70
+ ### HTTP Example
71
+
72
+ <pre>
73
+ http://bleacherreport.com/api/authenticate/login?redirect_url=http://bleacherreport.com&type=fantasy
74
+ </pre>
75
+
76
+ ### Redirect
77
+
78
+ A `redirect_url` parameter is mandatory. B/R will redirect the request back to that URL, passing basic information
79
+ from the <a href="#user_user">User API</a> as GET parameters.
80
+
81
+ <a name="authenticate_login_post"></a>
82
+
61
83
  POST /api/authenticate/login.json
62
84
  ---------------------------------
63
85
 
@@ -65,7 +87,6 @@ POST /api/authenticate/login.json
65
87
 
66
88
  * user[email]
67
89
  * user[password]
68
- * redirect_url (optional)
69
90
 
70
91
  ### Returns
71
92
 
@@ -85,13 +106,6 @@ http://bleacherreport.com/api/authenticate/login.json?user[email]=your@email.com
85
106
 
86
107
  Please note that any request with a password should be sent as a POST, despite this example using GET.
87
108
 
88
- ### Redirect
89
-
90
- When a `redirect_url` parameter is specified, B/R will redirect the request back to that URL, passing basic information
91
- from the <a href="#user_user">User API</a> as GET parameters.
92
-
93
- If the login fails, B/R will redirect the request back to the URL with a `fail=1` GET parameter.
94
-
95
109
  <a name="authenticate_logout"></a>
96
110
 
97
111
  GET /api/authenticate/logout.json
@@ -1,4 +1,4 @@
1
1
  bleacher_api:
2
- httparty: =0.5.2
3
- rake: >=0.8.7
4
- rspec: ~>1.0
2
+ httparty: '=0.5.2'
3
+ rake: '>=0.8.7'
4
+ rspec: '~>1.0'
@@ -1,5 +1,5 @@
1
1
  name: bleacher_api
2
- version: 0.1.1
2
+ version: 0.1.2
3
3
  authors:
4
4
  - Bleacher Report
5
5
  email: wwelsh@bleacherreport.com
metadata CHANGED
@@ -1,13 +1,12 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: bleacher_api
3
3
  version: !ruby/object:Gem::Version
4
- hash: 25
5
- prerelease:
4
+ prerelease: false
6
5
  segments:
7
6
  - 0
8
7
  - 1
9
- - 1
10
- version: 0.1.1
8
+ - 2
9
+ version: 0.1.2
11
10
  platform: ruby
12
11
  authors:
13
12
  - Bleacher Report
@@ -15,18 +14,16 @@ autorequire:
15
14
  bindir: bin
16
15
  cert_chain: []
17
16
 
18
- date: 2011-07-29 00:00:00 -07:00
17
+ date: 2011-09-19 00:00:00 -07:00
19
18
  default_executable:
20
19
  dependencies:
21
20
  - !ruby/object:Gem::Dependency
22
21
  name: httparty
23
22
  prerelease: false
24
23
  requirement: &id001 !ruby/object:Gem::Requirement
25
- none: false
26
24
  requirements:
27
25
  - - "="
28
26
  - !ruby/object:Gem::Version
29
- hash: 15
30
27
  segments:
31
28
  - 0
32
29
  - 5
@@ -38,11 +35,9 @@ dependencies:
38
35
  name: rake
39
36
  prerelease: false
40
37
  requirement: &id002 !ruby/object:Gem::Requirement
41
- none: false
42
38
  requirements:
43
39
  - - ">="
44
40
  - !ruby/object:Gem::Version
45
- hash: 49
46
41
  segments:
47
42
  - 0
48
43
  - 8
@@ -54,11 +49,9 @@ dependencies:
54
49
  name: rspec
55
50
  prerelease: false
56
51
  requirement: &id003 !ruby/object:Gem::Requirement
57
- none: false
58
52
  requirements:
59
53
  - - ~>
60
54
  - !ruby/object:Gem::Version
61
- hash: 15
62
55
  segments:
63
56
  - 1
64
57
  - 0
@@ -100,27 +93,23 @@ rdoc_options: []
100
93
  require_paths:
101
94
  - lib
102
95
  required_ruby_version: !ruby/object:Gem::Requirement
103
- none: false
104
96
  requirements:
105
97
  - - ">="
106
98
  - !ruby/object:Gem::Version
107
- hash: 3
108
99
  segments:
109
100
  - 0
110
101
  version: "0"
111
102
  required_rubygems_version: !ruby/object:Gem::Requirement
112
- none: false
113
103
  requirements:
114
104
  - - ">="
115
105
  - !ruby/object:Gem::Version
116
- hash: 3
117
106
  segments:
118
107
  - 0
119
108
  version: "0"
120
109
  requirements: []
121
110
 
122
111
  rubyforge_project:
123
- rubygems_version: 1.4.2
112
+ rubygems_version: 1.3.6
124
113
  signing_key:
125
114
  specification_version: 3
126
115
  summary: A Ruby Interface to the Bleacher Report API