faraday_middleware-reddit 0.2.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +17 -0
- data/Gemfile +10 -0
- data/LICENSE +202 -0
- data/README.md +69 -0
- data/Rakefile +7 -0
- data/faraday_middleware-reddit.gemspec +26 -0
- data/lib/faraday_middleware/reddit.rb +19 -0
- data/lib/faraday_middleware/reddit/request/authentication.rb +49 -0
- data/lib/faraday_middleware/reddit/use/force_json.rb +27 -0
- data/lib/faraday_middleware/reddit/use/modhash.rb +41 -0
- data/lib/faraday_middleware/reddit/use/rate_limit.rb +47 -0
- data/lib/faraday_middleware/reddit/version.rb +5 -0
- data/spec/helper.rb +11 -0
- metadata +125 -0
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright {yyyy} {name of copyright owner}
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
202
|
+
|
data/README.md
ADDED
@@ -0,0 +1,69 @@
|
|
1
|
+
# FaradayMiddleware::Reddit
|
2
|
+
|
3
|
+
A collection of Faraday middleware for use with the Reddit API.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
gem 'faraday_middleware-reddit'
|
10
|
+
|
11
|
+
And then execute:
|
12
|
+
|
13
|
+
$ bundle
|
14
|
+
|
15
|
+
Or install it yourself as:
|
16
|
+
|
17
|
+
$ gem install faraday_middleware-reddit
|
18
|
+
|
19
|
+
## Requirements
|
20
|
+
|
21
|
+
`faraday` and `faraday_middleware` are currently gemspec dependencies.
|
22
|
+
|
23
|
+
Like `faraday_middleware`, `faraday_middleware-reddit` requires a `json` library. Ruby versions prior to 1.9 will need to have one installed.
|
24
|
+
|
25
|
+
## Usage
|
26
|
+
|
27
|
+
`faraday_middleware-reddit` currently provides the following middleware:
|
28
|
+
|
29
|
+
| Middleware | Type | Description |
|
30
|
+
| --- | --- | --- |
|
31
|
+
| `:reddit_authentication` | request | Authentication based on a username, password or pre-generated cookie. |
|
32
|
+
| `:reddit_force_json` | request | Coerces reddit into returnign JSON for GET and POST requests. |
|
33
|
+
| `:reddit_modhash` | use | Automatic modhash handling. |
|
34
|
+
| `:reddit_rate_limit` | use | Rate limiting based on reddit's `x-ratelimit` headers. Accepts a `strategy` proc to override default linear strategy. |
|
35
|
+
|
36
|
+
## Examples
|
37
|
+
|
38
|
+
An example Farday client might look like:
|
39
|
+
|
40
|
+
require 'faraday_middleware/reddit'
|
41
|
+
|
42
|
+
conn = Faraday.new(:url => 'http://www.reddit.com', :headers => {'User-Agent' => 'faraday_middleware-reddit example (v 0.0.1)'}) do |faraday|
|
43
|
+
faraday.request :url_encoded
|
44
|
+
faraday.request :reddit_authentication, user: 'yourusername', password: 'yourpassword'
|
45
|
+
|
46
|
+
faraday.response :logger
|
47
|
+
faraday.response :follow_redirects
|
48
|
+
|
49
|
+
faraday.use :reddit_force_json
|
50
|
+
faraday.use :reddit_rate_limit
|
51
|
+
faraday.use :reddit_modhash
|
52
|
+
|
53
|
+
faraday.adapter Faraday.default_adapter
|
54
|
+
end
|
55
|
+
|
56
|
+
## Contributing
|
57
|
+
|
58
|
+
1. Fork it
|
59
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
60
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
61
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
62
|
+
5. Create new Pull Request
|
63
|
+
|
64
|
+
Contributors
|
65
|
+
------------
|
66
|
+
|
67
|
+
* Maintainer: [Daniel O'Brien](http://github.com/dobs)
|
68
|
+
|
69
|
+
This project is copyright 2014 by its contributors, licensed under [Apache License 2.0](https://github.com/dobs/faraday_middleware-reddit/blob/master/LICENSE).
|
data/Rakefile
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'faraday_middleware/reddit/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "faraday_middleware-reddit"
|
8
|
+
spec.version = FaradayMiddleware::Reddit::VERSION
|
9
|
+
spec.authors = ["Daniel O'Brien"]
|
10
|
+
spec.email = ["dan@dobs.org"]
|
11
|
+
spec.description = %q{A collection of Faraday middleware for use with the Reddit API.}
|
12
|
+
spec.summary = %q{A collection of Faraday middleware for use with the Reddit API.}
|
13
|
+
spec.homepage = ""
|
14
|
+
spec.licenses = ['Apache 2.0']
|
15
|
+
|
16
|
+
spec.files = `git ls-files`.split($/)
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_development_dependency "bundler", "~> 1.3"
|
22
|
+
spec.add_development_dependency "rake"
|
23
|
+
|
24
|
+
spec.add_dependency 'faraday', '~> 0.9'
|
25
|
+
spec.add_dependency 'faraday_middleware', '~> 0.9'
|
26
|
+
end
|
@@ -0,0 +1,19 @@
|
|
1
|
+
require 'faraday'
|
2
|
+
|
3
|
+
module FaradayMiddleware
|
4
|
+
module Reddit
|
5
|
+
autoload :Authentication, 'faraday_middleware/reddit/request/authentication'
|
6
|
+
autoload :ForceJson, 'faraday_middleware/reddit/use/force_json'
|
7
|
+
autoload :Modhash, 'faraday_middleware/reddit/use/modhash'
|
8
|
+
autoload :RateLimit, 'faraday_middleware/reddit/use/rate_limit'
|
9
|
+
|
10
|
+
if Faraday::Middleware.respond_to? :register_middleware
|
11
|
+
Faraday::Request.register_middleware \
|
12
|
+
:reddit_authentication => lambda { Authentication }
|
13
|
+
Faraday::Middleware.register_middleware \
|
14
|
+
:reddit_force_json => lambda { ForceJson },
|
15
|
+
:reddit_modhash => lambda { Modhash },
|
16
|
+
:reddit_rate_limit => lambda { RateLimit }
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
@@ -0,0 +1,49 @@
|
|
1
|
+
require 'faraday'
|
2
|
+
|
3
|
+
module FaradayMiddleware::Reddit
|
4
|
+
# Request middleware that automatically handles user login.
|
5
|
+
#
|
6
|
+
# Requires that either a `user` and `password` are provided or a
|
7
|
+
# pre-generated `cookie`. Performs an additional login request when no
|
8
|
+
# valid login cookie is available.
|
9
|
+
class Authentication < Faraday::Middleware
|
10
|
+
AUTH_URL = 'https://ssl.reddit.com/post/login'.freeze
|
11
|
+
|
12
|
+
dependency do
|
13
|
+
require 'json' unless defined?(::JSON)
|
14
|
+
end
|
15
|
+
|
16
|
+
def initialize(app, options)
|
17
|
+
super(app)
|
18
|
+
@options = options
|
19
|
+
@user = @options[:user]
|
20
|
+
@passwd = @options[:password]
|
21
|
+
@rem = @options[:remember]
|
22
|
+
@cookie = @options[:cookie]
|
23
|
+
|
24
|
+
unless (@options[:user] && @options[:password]) || @options[:cookie]
|
25
|
+
raise ArgumentError, 'Either `user` and `password` or `cookie` need to be provided as options to the :reddit_authentication middleware'
|
26
|
+
end
|
27
|
+
end
|
28
|
+
|
29
|
+
def call(env)
|
30
|
+
authenticate(env) unless @cookie
|
31
|
+
set_cookie(env)
|
32
|
+
@app.call(env)
|
33
|
+
end
|
34
|
+
|
35
|
+
def authenticate(env)
|
36
|
+
response = Faraday.post AUTH_URL, {:user => @user, :passwd => @passwd, :rem => @rem, :api_type => 'json'}
|
37
|
+
@cookie = response.headers['set-cookie']
|
38
|
+
end
|
39
|
+
|
40
|
+
def set_cookie(env)
|
41
|
+
upstream_cookies = env[:request_headers]['Cookie']
|
42
|
+
env[:request_headers]['Cookie'] = if upstream_cookies
|
43
|
+
"#{upstream_cookies}; #{@cookie}"
|
44
|
+
else
|
45
|
+
@cookie
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
@@ -0,0 +1,27 @@
|
|
1
|
+
require 'faraday'
|
2
|
+
|
3
|
+
module FaradayMiddleware
|
4
|
+
module Reddit
|
5
|
+
# Request middleware to force reddit to provide JSON responses when
|
6
|
+
# available.
|
7
|
+
#
|
8
|
+
# For GET requests that means adding `.json` to the ends of URLs. For POST
|
9
|
+
# requests that means adding `api_type=json` to sent requests.
|
10
|
+
class ForceJson < Faraday::Middleware
|
11
|
+
def initialize(app, options = nil)
|
12
|
+
super(app)
|
13
|
+
@options = options || {}
|
14
|
+
end
|
15
|
+
|
16
|
+
def call(env)
|
17
|
+
if env[:method].to_s == 'get'
|
18
|
+
env[:url].path += '.json' unless env[:url].path.end_with?('.json')
|
19
|
+
elsif env[:method].to_s == 'post'
|
20
|
+
env[:body] = [env[:body], 'api_type=json'].compact.join('&')
|
21
|
+
end
|
22
|
+
|
23
|
+
@app.call(env)
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
27
|
+
end
|
@@ -0,0 +1,41 @@
|
|
1
|
+
require 'faraday'
|
2
|
+
|
3
|
+
module FaradayMiddleware::Reddit
|
4
|
+
# Middleware that keeps track of and sets modhash-related HTTP headers.
|
5
|
+
#
|
6
|
+
# Reddit uses modhashes as a form of XSS protection and requires them for
|
7
|
+
# most POST and PUT requests. Modhashes are currently provided in response
|
8
|
+
# to listing GET requests.
|
9
|
+
class Modhash < Faraday::Middleware
|
10
|
+
dependency do
|
11
|
+
require 'json' unless defined?(::JSON)
|
12
|
+
end
|
13
|
+
|
14
|
+
def initialize(app, options = nil)
|
15
|
+
super(app)
|
16
|
+
@options = options || {}
|
17
|
+
@modhash = @options[:modhash]
|
18
|
+
end
|
19
|
+
|
20
|
+
def call(env)
|
21
|
+
@modhash = env[:modhash] if env[:modhash]
|
22
|
+
env[:request_headers]['X-Modhash'] = @modhash if @modhash
|
23
|
+
@app.call(env).on_complete do |env|
|
24
|
+
update_modhash(env)
|
25
|
+
end
|
26
|
+
end
|
27
|
+
|
28
|
+
def from_json(data)
|
29
|
+
if data.is_a?(String) && !data.strip.empty? && data.include?('modhash')
|
30
|
+
JSON.parse(data)
|
31
|
+
else
|
32
|
+
data
|
33
|
+
end
|
34
|
+
end
|
35
|
+
|
36
|
+
def update_modhash(env)
|
37
|
+
body = from_json(env[:body])
|
38
|
+
@modhash = body['data']['modhash'] if body['data']
|
39
|
+
end
|
40
|
+
end
|
41
|
+
end
|
@@ -0,0 +1,47 @@
|
|
1
|
+
require 'faraday'
|
2
|
+
|
3
|
+
module FaradayMiddleware::Reddit
|
4
|
+
# Middleware for automatic rate limiting.
|
5
|
+
#
|
6
|
+
# Logs reddit's ratelimit HTTP headers and applies a caching strategy
|
7
|
+
# based on them. The default strategy is to block for x-ratelimit-reset /
|
8
|
+
# x-ratelimit_remaining.
|
9
|
+
class RateLimit < Faraday::Middleware
|
10
|
+
def initialize(app, options = nil)
|
11
|
+
super(app)
|
12
|
+
@options = options || {}
|
13
|
+
@strategy = @options[:strategy] || lambda { linear_strategy }
|
14
|
+
|
15
|
+
# Default rate limit settings.
|
16
|
+
@ratelimit_remaining = 30
|
17
|
+
@ratelimit_used = 0
|
18
|
+
@ratelimit_reset = 60
|
19
|
+
@ratelimit_cap = 30
|
20
|
+
end
|
21
|
+
|
22
|
+
def call(env)
|
23
|
+
if @ratelimit_remaining <= 0 || env[:status] == 429
|
24
|
+
sleep(@ratelimit_reset)
|
25
|
+
else
|
26
|
+
@strategy.call
|
27
|
+
end
|
28
|
+
|
29
|
+
@app.call(env).on_complete do |env|
|
30
|
+
@ratelimit_remaining = env[:response_headers]['x-ratelimit-remaining'].to_i
|
31
|
+
@ratelimit_used = env[:response_headers]['x-ratelimit-used'].to_i
|
32
|
+
@ratelimit_reset = env[:response_headers]['x-ratelimit-reset'].to_i
|
33
|
+
@ratelimit_cap = @ratelimit_remaining + @ratelimit_used
|
34
|
+
end
|
35
|
+
end
|
36
|
+
|
37
|
+
def linear_strategy
|
38
|
+
sleep (@ratelimit_reset.to_f / [1, @ratelimit_remaining].max)
|
39
|
+
end
|
40
|
+
|
41
|
+
def burst_strategy(threshold = 0.5)
|
42
|
+
if (@ratelimit_used / @ratelimit_cap.to_f) > threshold
|
43
|
+
linear_strategy
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
data/spec/helper.rb
ADDED
metadata
ADDED
@@ -0,0 +1,125 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: faraday_middleware-reddit
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.2.1
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Daniel O'Brien
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2014-04-24 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: bundler
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
none: false
|
18
|
+
requirements:
|
19
|
+
- - ~>
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: '1.3'
|
22
|
+
type: :development
|
23
|
+
prerelease: false
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ~>
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '1.3'
|
30
|
+
- !ruby/object:Gem::Dependency
|
31
|
+
name: rake
|
32
|
+
requirement: !ruby/object:Gem::Requirement
|
33
|
+
none: false
|
34
|
+
requirements:
|
35
|
+
- - ! '>='
|
36
|
+
- !ruby/object:Gem::Version
|
37
|
+
version: '0'
|
38
|
+
type: :development
|
39
|
+
prerelease: false
|
40
|
+
version_requirements: !ruby/object:Gem::Requirement
|
41
|
+
none: false
|
42
|
+
requirements:
|
43
|
+
- - ! '>='
|
44
|
+
- !ruby/object:Gem::Version
|
45
|
+
version: '0'
|
46
|
+
- !ruby/object:Gem::Dependency
|
47
|
+
name: faraday
|
48
|
+
requirement: !ruby/object:Gem::Requirement
|
49
|
+
none: false
|
50
|
+
requirements:
|
51
|
+
- - ~>
|
52
|
+
- !ruby/object:Gem::Version
|
53
|
+
version: '0.9'
|
54
|
+
type: :runtime
|
55
|
+
prerelease: false
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
57
|
+
none: false
|
58
|
+
requirements:
|
59
|
+
- - ~>
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0.9'
|
62
|
+
- !ruby/object:Gem::Dependency
|
63
|
+
name: faraday_middleware
|
64
|
+
requirement: !ruby/object:Gem::Requirement
|
65
|
+
none: false
|
66
|
+
requirements:
|
67
|
+
- - ~>
|
68
|
+
- !ruby/object:Gem::Version
|
69
|
+
version: '0.9'
|
70
|
+
type: :runtime
|
71
|
+
prerelease: false
|
72
|
+
version_requirements: !ruby/object:Gem::Requirement
|
73
|
+
none: false
|
74
|
+
requirements:
|
75
|
+
- - ~>
|
76
|
+
- !ruby/object:Gem::Version
|
77
|
+
version: '0.9'
|
78
|
+
description: A collection of Faraday middleware for use with the Reddit API.
|
79
|
+
email:
|
80
|
+
- dan@dobs.org
|
81
|
+
executables: []
|
82
|
+
extensions: []
|
83
|
+
extra_rdoc_files: []
|
84
|
+
files:
|
85
|
+
- .gitignore
|
86
|
+
- Gemfile
|
87
|
+
- LICENSE
|
88
|
+
- README.md
|
89
|
+
- Rakefile
|
90
|
+
- faraday_middleware-reddit.gemspec
|
91
|
+
- lib/faraday_middleware/reddit.rb
|
92
|
+
- lib/faraday_middleware/reddit/request/authentication.rb
|
93
|
+
- lib/faraday_middleware/reddit/use/force_json.rb
|
94
|
+
- lib/faraday_middleware/reddit/use/modhash.rb
|
95
|
+
- lib/faraday_middleware/reddit/use/rate_limit.rb
|
96
|
+
- lib/faraday_middleware/reddit/version.rb
|
97
|
+
- spec/helper.rb
|
98
|
+
homepage: ''
|
99
|
+
licenses:
|
100
|
+
- Apache 2.0
|
101
|
+
post_install_message:
|
102
|
+
rdoc_options: []
|
103
|
+
require_paths:
|
104
|
+
- lib
|
105
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
106
|
+
none: false
|
107
|
+
requirements:
|
108
|
+
- - ! '>='
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '0'
|
111
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
112
|
+
none: false
|
113
|
+
requirements:
|
114
|
+
- - ! '>='
|
115
|
+
- !ruby/object:Gem::Version
|
116
|
+
version: '0'
|
117
|
+
requirements: []
|
118
|
+
rubyforge_project:
|
119
|
+
rubygems_version: 1.8.23
|
120
|
+
signing_key:
|
121
|
+
specification_version: 3
|
122
|
+
summary: A collection of Faraday middleware for use with the Reddit API.
|
123
|
+
test_files:
|
124
|
+
- spec/helper.rb
|
125
|
+
has_rdoc:
|