rotten_tomatoes 1.0.2 → 1.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +16 -9
- data/lib/rotten_tomatoes.rb +4 -2
- data/lib/rotten_tomatoes/client.rb +102 -100
- data/lib/rotten_tomatoes/version.rb +3 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: fc3fafbba4af750f27f66a987c11417ad5973c8d
|
|
4
|
+
data.tar.gz: 8ea16fae149bf2216efed41dd56f827d7fecc66f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 85dc89a5e672e82ef514852a650ab7c1304f029494afd4ca77f28a7f3350eb8a316f6906e1364623a1f7a4d9c5953a2a68b9c9a1d467541e589aabede1e54188
|
|
7
|
+
data.tar.gz: 16d3621985a4124399b852bfc55d49a0c264b9a2e274b5712547121e2337e609d4b171ad45a4dd9bf84b18a92c8e75ea2241265543bbd8c035ce77c2211b156b
|
data/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[](https://travis-ci.org/kkirsche/rotten_tomatoes) [](https://codeclimate.com/github/kkirsche/rotten_tomatoes) [](https://codeclimate.com/github/kkirsche/rotten_tomatoes)
|
|
1
|
+
[](https://travis-ci.org/kkirsche/rotten_tomatoes) [](https://codeclimate.com/github/kkirsche/rotten_tomatoes) [](https://codeclimate.com/github/kkirsche/rotten_tomatoes) [](http://badge.fury.io/rb/rotten_tomatoes) [](https://gemnasium.com/kkirsche/rotten_tomatoes)
|
|
2
2
|
|
|
3
3
|
# Rotten Tomatoes
|
|
4
4
|
|
|
@@ -14,21 +14,28 @@ gem 'rotten_tomatoes'
|
|
|
14
14
|
|
|
15
15
|
And then execute:
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
```shell
|
|
18
|
+
$ bundle
|
|
19
|
+
```
|
|
18
20
|
|
|
19
21
|
Or install it yourself as:
|
|
20
22
|
|
|
21
|
-
|
|
23
|
+
```shell
|
|
24
|
+
$ gem install rotten_tomatoes
|
|
25
|
+
```
|
|
22
26
|
|
|
23
27
|
## Usage
|
|
28
|
+
```shell
|
|
29
|
+
$ gem install rotten_tomatoes
|
|
30
|
+
```
|
|
24
31
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
api_client = RottenTomatoes::Client.new api_key: 'myAPIkey'
|
|
30
|
-
# Start enjoying the Rotten Tomatoes API
|
|
32
|
+
```ruby
|
|
33
|
+
# your_file.rb
|
|
34
|
+
require 'rotten_tomatoes'
|
|
35
|
+
api_client = RottenTomatoes::Client.new api_key: 'myAPIkey'
|
|
31
36
|
|
|
37
|
+
# Start enjoying the Rotten Tomatoes API
|
|
38
|
+
```
|
|
32
39
|
## Development
|
|
33
40
|
|
|
34
41
|
After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
|
data/lib/rotten_tomatoes.rb
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
|
-
require
|
|
2
|
-
require
|
|
1
|
+
require 'rotten_tomatoes/version'
|
|
2
|
+
require 'rotten_tomatoes/client'
|
|
3
3
|
|
|
4
|
+
# RottenTomatoes module contains code used to interact with the v1.0 JSON
|
|
5
|
+
# API provided by Rotten Tomatoes.
|
|
4
6
|
module RottenTomatoes
|
|
5
7
|
end
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
require 'hurley'
|
|
2
2
|
require 'json'
|
|
3
3
|
|
|
4
|
+
# RottenTomatoes module contains code used to interact with the v1.0 JSON
|
|
5
|
+
# API provided by Rotten Tomatoes.
|
|
4
6
|
module RottenTomatoes
|
|
5
7
|
# The Client class is the interface to the Rotten Tomatoes API
|
|
6
8
|
class Client
|
|
@@ -12,11 +14,11 @@ module RottenTomatoes
|
|
|
12
14
|
#
|
|
13
15
|
# == Parameters
|
|
14
16
|
#
|
|
15
|
-
# +api_key+ -
|
|
17
|
+
# @param [String] +api_key+ - The Rotten tomatoes API key.
|
|
16
18
|
#
|
|
17
19
|
# == Returns
|
|
18
20
|
#
|
|
19
|
-
#
|
|
21
|
+
# @return [RottenTomatoes::Client] - An instance of `RottenTomatoes::Client`
|
|
20
22
|
#
|
|
21
23
|
# == Example
|
|
22
24
|
#
|
|
@@ -28,16 +30,16 @@ module RottenTomatoes
|
|
|
28
30
|
end
|
|
29
31
|
|
|
30
32
|
# == Argument Hash (Private Method)
|
|
31
|
-
# Internal method, not for use by third-party developers. The argument_hash method is used to generate the hash which will be URL encoded when making the next request with the Rotten Tomatoes API.
|
|
33
|
+
# Internal method, not for use by third-party developers. The +argument_hash+ method is used to generate the hash which will be URL encoded when making the next request with the Rotten Tomatoes API.
|
|
32
34
|
#
|
|
33
35
|
# == Parameters
|
|
34
36
|
#
|
|
35
|
-
# +args+ -
|
|
36
|
-
# +symbols -
|
|
37
|
+
# @param [Hash] +args+ - The original hash which was sent to the calling method.
|
|
38
|
+
# @param [Hash] +symbols+ - An array of symbols which you would like to send to the API.
|
|
37
39
|
#
|
|
38
40
|
# == Returns
|
|
39
41
|
#
|
|
40
|
-
#
|
|
42
|
+
# @return [void]
|
|
41
43
|
#
|
|
42
44
|
# == Example
|
|
43
45
|
#
|
|
@@ -55,15 +57,15 @@ module RottenTomatoes
|
|
|
55
57
|
private :argument_hash
|
|
56
58
|
|
|
57
59
|
# == Request (Private Method)
|
|
58
|
-
# Internal method, not for use by third-party developers. The request method is used to send the get request to the API and then will return the parsed body as a hash.
|
|
60
|
+
# Internal method, not for use by third-party developers. The +request+ method is used to send the get request to the API and then will return the parsed body as a hash.
|
|
59
61
|
#
|
|
60
62
|
# == Parameters
|
|
61
63
|
#
|
|
62
|
-
# +args+ -
|
|
64
|
+
# @param [Hash] +args+ - The hash may, as all parameters except `:url` are optional, contain `:url` containing the API endpoint which will be contacted, `:args` which represent the arguments of the calling method, and `:symbols` which are the symbols which may be sent with the request. Examples include `:page`, `:limit`, `:query`.
|
|
63
65
|
#
|
|
64
66
|
# == Returns
|
|
65
67
|
#
|
|
66
|
-
# Hash - Response body after being parsed from JSON will be returned as a Hash.
|
|
68
|
+
# @return [Hash] - Response body after being parsed from JSON will be returned as a Hash.
|
|
67
69
|
#
|
|
68
70
|
# == Example
|
|
69
71
|
#
|
|
@@ -78,19 +80,19 @@ module RottenTomatoes
|
|
|
78
80
|
private :request
|
|
79
81
|
|
|
80
82
|
# == Movies Search
|
|
81
|
-
# The movies_search method is used to do plain text searches allowing you to find your favorite movies.
|
|
82
|
-
# http://developer.rottentomatoes.com/docs/read/json/v10/Movies_Search
|
|
83
|
+
# The +movies_search+ method is used to do plain text searches allowing you to find your favorite movies.
|
|
84
|
+
# {http://developer.rottentomatoes.com/docs/read/json/v10/Movies_Search Documentation}
|
|
83
85
|
#
|
|
84
86
|
# == Parameters
|
|
85
87
|
#
|
|
86
|
-
# +args+ -
|
|
87
|
-
# *
|
|
88
|
-
# *
|
|
89
|
-
# *
|
|
88
|
+
# @param [Hash] +args+ - May contain the following keys:
|
|
89
|
+
# * `:q` - The plain text search query to search for a movie. Default value is nil.
|
|
90
|
+
# * `:page_limit` - The amount of movie search results to show per page. Default value is 30.
|
|
91
|
+
# * `:page` - The selected page of movie search results. Default value is 1.
|
|
90
92
|
#
|
|
91
93
|
# == Returns
|
|
92
94
|
#
|
|
93
|
-
# Hash - Response body after being parsed from JSON will be returned as a Hash.
|
|
95
|
+
# @return [Hash] - Response body after being parsed from JSON will be returned as a Hash.
|
|
94
96
|
#
|
|
95
97
|
# == Example
|
|
96
98
|
#
|
|
@@ -103,21 +105,21 @@ module RottenTomatoes
|
|
|
103
105
|
end
|
|
104
106
|
|
|
105
107
|
# == Lists Directory
|
|
106
|
-
# The lists_directory method is used to retrieve the top level lists available in the API.
|
|
107
|
-
# http://developer.rottentomatoes.com/docs/read/json/v10/Lists_Directory
|
|
108
|
+
# The +lists_directory+ method is used to retrieve the top level lists available in the API.
|
|
109
|
+
# {http://developer.rottentomatoes.com/docs/read/json/v10/Lists_Directory Documentation}
|
|
108
110
|
#
|
|
109
111
|
# == Parameters
|
|
110
112
|
#
|
|
111
|
-
#
|
|
113
|
+
# @param N/A
|
|
112
114
|
#
|
|
113
115
|
# == Returns
|
|
114
116
|
#
|
|
115
|
-
# Hash - Response body after being parsed from JSON will be returned as a Hash with the following example response:
|
|
117
|
+
# @return [Hash] - Response body after being parsed from JSON will be returned as a Hash with the following example response:
|
|
116
118
|
#
|
|
117
|
-
#
|
|
118
|
-
#
|
|
119
|
-
#
|
|
120
|
-
#
|
|
119
|
+
# links: {
|
|
120
|
+
# movies: 'http://api.rottentomatoes.com/api/public/v1.0/lists/movies.json',
|
|
121
|
+
# dvds: 'http://api.rottentomatoes.com/api/public/v1.0/lists/dvds.json'
|
|
122
|
+
# }
|
|
121
123
|
#
|
|
122
124
|
# == Example
|
|
123
125
|
#
|
|
@@ -128,16 +130,16 @@ module RottenTomatoes
|
|
|
128
130
|
end
|
|
129
131
|
|
|
130
132
|
# == Movie Lists Directory
|
|
131
|
-
# The movie_lists_directory method is used to retrieve the movie lists available.
|
|
132
|
-
# http://developer.rottentomatoes.com/docs/read/json/v10/Movie_Lists_Directory
|
|
133
|
+
# The +movie_lists_directory+ method is used to retrieve the movie lists available.
|
|
134
|
+
# {http://developer.rottentomatoes.com/docs/read/json/v10/Movie_Lists_Directory Documentation}
|
|
133
135
|
#
|
|
134
136
|
# == Parameters
|
|
135
137
|
#
|
|
136
|
-
# None
|
|
138
|
+
# @param None
|
|
137
139
|
#
|
|
138
140
|
# == Returns
|
|
139
141
|
#
|
|
140
|
-
# Hash - Response body after being parsed from JSON will be returned as a Hash.
|
|
142
|
+
# @return [Hash] - Response body after being parsed from JSON will be returned as a Hash.
|
|
141
143
|
#
|
|
142
144
|
# == Example
|
|
143
145
|
#
|
|
@@ -148,16 +150,16 @@ module RottenTomatoes
|
|
|
148
150
|
end
|
|
149
151
|
|
|
150
152
|
# == DVD Lists Directory
|
|
151
|
-
# The dvd_lists_directory method is used to retrieve the dvd lists available.
|
|
152
|
-
# http://developer.rottentomatoes.com/docs/read/json/v10/DVD_Lists_Directory
|
|
153
|
+
# The +dvd_lists_directory+ method is used to retrieve the dvd lists available.
|
|
154
|
+
# {http://developer.rottentomatoes.com/docs/read/json/v10/DVD_Lists_Directory Documentation}
|
|
153
155
|
#
|
|
154
156
|
# == Parameters
|
|
155
157
|
#
|
|
156
|
-
# None
|
|
158
|
+
# @param None
|
|
157
159
|
#
|
|
158
160
|
# == Returns
|
|
159
161
|
#
|
|
160
|
-
# Hash - Response body after being parsed from JSON will be returned as a Hash.
|
|
162
|
+
# @return [Hash] - Response body after being parsed from JSON will be returned as a Hash.
|
|
161
163
|
#
|
|
162
164
|
# == Example
|
|
163
165
|
#
|
|
@@ -173,13 +175,13 @@ module RottenTomatoes
|
|
|
173
175
|
#
|
|
174
176
|
# == Parameters
|
|
175
177
|
#
|
|
176
|
-
# +args+ -
|
|
177
|
-
# *
|
|
178
|
-
# *
|
|
178
|
+
# @param [Hash] +args+ - May contain the following keys:
|
|
179
|
+
# * `:limit` - Limits the number of box office movies returned. Default value is 10.
|
|
180
|
+
# * `:country` - Provides localized data for the selected country (ISO 3166-1 alpha-2) if available. Otherwise, returns US data. Default value is 'us'
|
|
179
181
|
#
|
|
180
182
|
# == Returns
|
|
181
183
|
#
|
|
182
|
-
# Hash - Response body after being parsed from JSON will be returned as a Hash.
|
|
184
|
+
# @return [Hash] - Response body after being parsed from JSON will be returned as a Hash.
|
|
183
185
|
#
|
|
184
186
|
# == Example
|
|
185
187
|
#
|
|
@@ -193,18 +195,18 @@ module RottenTomatoes
|
|
|
193
195
|
|
|
194
196
|
# == In Theater Movies
|
|
195
197
|
# Retrieves movies currently in theaters.
|
|
196
|
-
# http://developer.rottentomatoes.com/docs/read/json/v10/In_Theaters_Movies
|
|
198
|
+
# {http://developer.rottentomatoes.com/docs/read/json/v10/In_Theaters_Movies Documentation}
|
|
197
199
|
#
|
|
198
200
|
# == Parameters
|
|
199
201
|
#
|
|
200
|
-
# +args+ -
|
|
201
|
-
# *
|
|
202
|
-
# *
|
|
203
|
-
# *
|
|
202
|
+
# @param [Hash] +args+ - May contain the following keys:
|
|
203
|
+
# * `:page_limit` - The amount of movies in theaters to show per page. Default value is 16.
|
|
204
|
+
# * `:page` - The selected page of in theaters movies. Default value is 1.
|
|
205
|
+
# * `:country` - Provides localized data for the selected country (ISO 3166-1 alpha-2) if available. Otherwise, returns US data. Default value is 'us'
|
|
204
206
|
#
|
|
205
207
|
# == Returns
|
|
206
208
|
#
|
|
207
|
-
# Hash - Response body after being parsed from JSON will be returned as a Hash.
|
|
209
|
+
# @return [Hash] - Response body after being parsed from JSON will be returned as a Hash.
|
|
208
210
|
#
|
|
209
211
|
# == Example
|
|
210
212
|
#
|
|
@@ -218,17 +220,17 @@ module RottenTomatoes
|
|
|
218
220
|
|
|
219
221
|
# == Opening Movies
|
|
220
222
|
# Retrieves movies current opening movies.
|
|
221
|
-
# http://developer.rottentomatoes.com/docs/read/json/v10/Opening_Movies
|
|
223
|
+
# {http://developer.rottentomatoes.com/docs/read/json/v10/Opening_Movies Documentation}
|
|
222
224
|
#
|
|
223
225
|
# == Parameters
|
|
224
226
|
#
|
|
225
|
-
# +args+ -
|
|
226
|
-
# *
|
|
227
|
-
# *
|
|
227
|
+
# @param [Hash] +args+ - May contain the following keys:
|
|
228
|
+
# * `:limit` - Limits the number of opening movies returned. Default value is 16.
|
|
229
|
+
# * `:country` - Provides localized data for the selected country (ISO 3166-1 alpha-2) if available. Otherwise, returns US data. Default value is 'us'
|
|
228
230
|
#
|
|
229
231
|
# == Returns
|
|
230
232
|
#
|
|
231
|
-
# Hash - Response body after being parsed from JSON will be returned as a Hash.
|
|
233
|
+
# @return [Hash] - Response body after being parsed from JSON will be returned as a Hash.
|
|
232
234
|
#
|
|
233
235
|
# == Example
|
|
234
236
|
#
|
|
@@ -242,18 +244,18 @@ module RottenTomatoes
|
|
|
242
244
|
|
|
243
245
|
# == Upcoming Movies
|
|
244
246
|
# Retrieves movies current opening movies.
|
|
245
|
-
# http://developer.rottentomatoes.com/docs/read/json/v10/Upcoming_Movies
|
|
247
|
+
# {http://developer.rottentomatoes.com/docs/read/json/v10/Upcoming_Movies Documentation}
|
|
246
248
|
#
|
|
247
249
|
# == Parameters
|
|
248
250
|
#
|
|
249
|
-
# +args+ -
|
|
250
|
-
# *
|
|
251
|
-
# *
|
|
252
|
-
# *
|
|
251
|
+
# @param [Hash] +args+ - May contain the following keys:
|
|
252
|
+
# * `:page_limit` - The amount of upcoming movies to show per page. Default value is 16.
|
|
253
|
+
# * `:page` - The selected page of upcoming movies. Default value is 1.
|
|
254
|
+
# * `:country` - Provides localized data for the selected country (ISO 3166-1 alpha-2) if available. Otherwise, returns US data. Default value is 'us'
|
|
253
255
|
#
|
|
254
256
|
# == Returns
|
|
255
257
|
#
|
|
256
|
-
# Hash - Response body after being parsed from JSON will be returned as a Hash.
|
|
258
|
+
# @return [Hash] - Response body after being parsed from JSON will be returned as a Hash.
|
|
257
259
|
#
|
|
258
260
|
# == Example
|
|
259
261
|
#
|
|
@@ -267,17 +269,17 @@ module RottenTomatoes
|
|
|
267
269
|
|
|
268
270
|
# == Top Rentals
|
|
269
271
|
# Retrieves the current top dvd rentals.
|
|
270
|
-
# http://developer.rottentomatoes.com/docs/read/json/v10/Top_Rentals
|
|
272
|
+
# {http://developer.rottentomatoes.com/docs/read/json/v10/Top_Rentals Documentation}
|
|
271
273
|
#
|
|
272
274
|
# == Parameters
|
|
273
275
|
#
|
|
274
|
-
# +args+ -
|
|
275
|
-
# *
|
|
276
|
-
# *
|
|
276
|
+
# @param [Hash] +args+ - May contain the following keys:
|
|
277
|
+
# * `:limit` - Limits the number of top rentals returned. Default value is 10.
|
|
278
|
+
# * `:country` - Provides localized data for the selected country (ISO 3166-1 alpha-2) if available. Otherwise, returns US data. Default value is 'us'
|
|
277
279
|
#
|
|
278
280
|
# == Returns
|
|
279
281
|
#
|
|
280
|
-
# Hash - Response body after being parsed from JSON will be returned as a Hash.
|
|
282
|
+
# @return [Hash] - Response body after being parsed from JSON will be returned as a Hash.
|
|
281
283
|
#
|
|
282
284
|
# == Example
|
|
283
285
|
#
|
|
@@ -291,18 +293,18 @@ module RottenTomatoes
|
|
|
291
293
|
|
|
292
294
|
# == Current Release DVDs
|
|
293
295
|
# Retrieves current release dvds. Results are paginated if they go past the specified page limit.
|
|
294
|
-
# http://developer.rottentomatoes.com/docs/read/json/v10/Current_Release_DVDs
|
|
296
|
+
# {http://developer.rottentomatoes.com/docs/read/json/v10/Current_Release_DVDs Documentation}
|
|
295
297
|
#
|
|
296
298
|
# == Parameters
|
|
297
299
|
#
|
|
298
|
-
# +args+ -
|
|
299
|
-
# *
|
|
300
|
-
# *
|
|
301
|
-
# *
|
|
300
|
+
# @param [Hash] +args+ - May contain the following keys:
|
|
301
|
+
# * `:page_limit` - The amount of new release dvds to show per page. Default value is 16.
|
|
302
|
+
# * `:page` - The selected page of current DVD releases. Default value is 1.
|
|
303
|
+
# * `:country` - Provides localized data for the selected country (ISO 3166-1 alpha-2) if available. Otherwise, returns US data. Default value is 'us'
|
|
302
304
|
#
|
|
303
305
|
# == Returns
|
|
304
306
|
#
|
|
305
|
-
# Hash - Response body after being parsed from JSON will be returned as a Hash.
|
|
307
|
+
# @return [Hash] - Response body after being parsed from JSON will be returned as a Hash.
|
|
306
308
|
#
|
|
307
309
|
# == Example
|
|
308
310
|
#
|
|
@@ -316,18 +318,18 @@ module RottenTomatoes
|
|
|
316
318
|
|
|
317
319
|
# == New Release DVDs
|
|
318
320
|
# Retrieves new release dvds. Results are paginated if they go past the specified page limit.
|
|
319
|
-
# http://developer.rottentomatoes.com/docs/read/json/v10/New_Release_DVDs
|
|
321
|
+
# {http://developer.rottentomatoes.com/docs/read/json/v10/New_Release_DVDs Documentation}
|
|
320
322
|
#
|
|
321
323
|
# == Parameters
|
|
322
324
|
#
|
|
323
|
-
# +args+ -
|
|
324
|
-
# *
|
|
325
|
-
# *
|
|
326
|
-
# *
|
|
325
|
+
# @param [Hash] +args+ - May contain the following keys:
|
|
326
|
+
# * `:page_limit` - The amount of new release dvds to show per page. Default value is 16.
|
|
327
|
+
# * `:page` - The selected page of new release DVDs. Default value is 1.
|
|
328
|
+
# * `:country - Provides localized data for the selected country (ISO 3166-1 alpha-2) if available. Otherwise, returns US data. Default value is 'us'
|
|
327
329
|
#
|
|
328
330
|
# == Returns
|
|
329
331
|
#
|
|
330
|
-
# Hash - Response body after being parsed from JSON will be returned as a Hash.
|
|
332
|
+
# @return [Hash] - Response body after being parsed from JSON will be returned as a Hash.
|
|
331
333
|
#
|
|
332
334
|
# == Example
|
|
333
335
|
#
|
|
@@ -341,18 +343,18 @@ module RottenTomatoes
|
|
|
341
343
|
|
|
342
344
|
# == Upcoming DVDs
|
|
343
345
|
# Retrieves upcoming dvds. Results are paginated if they go past the specified page limit.
|
|
344
|
-
# http://developer.rottentomatoes.com/docs/read/json/v10/Upcoming_DVDs
|
|
346
|
+
# {http://developer.rottentomatoes.com/docs/read/json/v10/Upcoming_DVDs Documentation}
|
|
345
347
|
#
|
|
346
348
|
# == Parameters
|
|
347
349
|
#
|
|
348
|
-
# +args+ -
|
|
349
|
-
# *
|
|
350
|
-
# *
|
|
351
|
-
# *
|
|
350
|
+
# @param [Hash] +args+ - May contain the following keys:
|
|
351
|
+
# * `:page_limit` - The amount of new release dvds to show per page. Default value is 16.
|
|
352
|
+
# * `:page` - The selected page of new release DVDs. Default value is 1.
|
|
353
|
+
# * `:country` - Provides localized data for the selected country (ISO 3166-1 alpha-2) if available. Otherwise, returns US data. Default value is 'us'
|
|
352
354
|
#
|
|
353
355
|
# == Returns
|
|
354
356
|
#
|
|
355
|
-
# Hash - Response body after being parsed from JSON will be returned as a Hash.
|
|
357
|
+
# @return [Hash] - Response body after being parsed from JSON will be returned as a Hash.
|
|
356
358
|
#
|
|
357
359
|
# == Example
|
|
358
360
|
#
|
|
@@ -366,15 +368,15 @@ module RottenTomatoes
|
|
|
366
368
|
|
|
367
369
|
# == Movie Info
|
|
368
370
|
# Detailed information on a specific movie specified by ID. You can use the movies_search method or peruse the lists of movies/dvds to get the urls to movies.
|
|
369
|
-
# http://developer.rottentomatoes.com/docs/read/json/v10/Movie_Info
|
|
371
|
+
# {http://developer.rottentomatoes.com/docs/read/json/v10/Movie_Info Documentation}
|
|
370
372
|
#
|
|
371
373
|
# == Parameters
|
|
372
374
|
#
|
|
373
|
-
#
|
|
375
|
+
# @param [Int|String] - +movie_id+ - Example: 770672122
|
|
374
376
|
#
|
|
375
377
|
# == Returns
|
|
376
378
|
#
|
|
377
|
-
# Hash - Response body after being parsed from JSON will be returned as a Hash.
|
|
379
|
+
# @return [Hash] - Response body after being parsed from JSON will be returned as a Hash.
|
|
378
380
|
#
|
|
379
381
|
# == Example
|
|
380
382
|
#
|
|
@@ -386,15 +388,15 @@ module RottenTomatoes
|
|
|
386
388
|
|
|
387
389
|
# == Movie Cast
|
|
388
390
|
# Pulls the complete movie cast for a movie.
|
|
389
|
-
# http://developer.rottentomatoes.com/docs/read/json/v10/Movie_Cast
|
|
391
|
+
# {http://developer.rottentomatoes.com/docs/read/json/v10/Movie_Cast Documentation}
|
|
390
392
|
#
|
|
391
393
|
# == Parameters
|
|
392
394
|
#
|
|
393
|
-
# +movie_id+ -
|
|
395
|
+
# @param [Int|String] +movie_id+ - Example: 770672122
|
|
394
396
|
#
|
|
395
397
|
# == Returns
|
|
396
398
|
#
|
|
397
|
-
# Hash - Response body after being parsed from JSON will be returned as a Hash.
|
|
399
|
+
# @return [Hash] - Response body after being parsed from JSON will be returned as a Hash.
|
|
398
400
|
#
|
|
399
401
|
# == Example
|
|
400
402
|
#
|
|
@@ -406,20 +408,20 @@ module RottenTomatoes
|
|
|
406
408
|
|
|
407
409
|
# == Movie Reviews
|
|
408
410
|
# Retrieves the reviews for a movie. Results are paginated if they go past the specified page limit.
|
|
409
|
-
# http://developer.rottentomatoes.com/docs/read/json/v10/Movie_Reviews
|
|
411
|
+
# {http://developer.rottentomatoes.com/docs/read/json/v10/Movie_Reviews Documentation}
|
|
410
412
|
#
|
|
411
413
|
# == Parameters
|
|
412
414
|
#
|
|
413
|
-
# +movie_id+ -
|
|
414
|
-
# +args+ -
|
|
415
|
-
# *
|
|
416
|
-
# *
|
|
417
|
-
# *
|
|
418
|
-
# *
|
|
415
|
+
# @param [Int|String] +movie_id+ - Example: 770672122
|
|
416
|
+
# @param [Hash] +args+ - May contain the following keys:
|
|
417
|
+
# * `:review_type` - 3 different review types are possible: "all", "top_critic", and "dvd". "top_critic" shows all the Rotten Tomatoes designated top critics. "dvd" pulls the reviews given on the DVD of the movie. "all" as the name implies retrieves all reviews. Default value is "top_critic".
|
|
418
|
+
# * `:page_limit` - The number of reviews to show per page. Default value is 20.
|
|
419
|
+
# * `:page` - The selected page of reviews. Default value is 1.
|
|
420
|
+
# * `:country` - Provides localized data for the selected country (ISO 3166-1 alpha-2) if available. Otherwise, returns US data. Default value is 'us'
|
|
419
421
|
#
|
|
420
422
|
# == Returns
|
|
421
423
|
#
|
|
422
|
-
# Hash - Response body after being parsed from JSON will be returned as a Hash.
|
|
424
|
+
# @return [Hash] - Response body after being parsed from JSON will be returned as a Hash.
|
|
423
425
|
#
|
|
424
426
|
# == Example
|
|
425
427
|
#
|
|
@@ -432,17 +434,17 @@ module RottenTomatoes
|
|
|
432
434
|
|
|
433
435
|
# == Movie Similar
|
|
434
436
|
# Shows similar movies for a movie.
|
|
435
|
-
# http://developer.rottentomatoes.com/docs/read/json/v10/Movie_Similar
|
|
437
|
+
# {http://developer.rottentomatoes.com/docs/read/json/v10/Movie_Similar Documentation}
|
|
436
438
|
#
|
|
437
439
|
# == Parameters
|
|
438
440
|
#
|
|
439
|
-
# +movie_id+ -
|
|
440
|
-
# +args+ -
|
|
441
|
-
# *
|
|
441
|
+
# @param [Int|String] +movie_id+ - Example: 770672122
|
|
442
|
+
# @return [Hash] +args+ - May contain the following keys:
|
|
443
|
+
# * `:limit` - Limit the number of similar movies to show.
|
|
442
444
|
#
|
|
443
445
|
# == Returns
|
|
444
446
|
#
|
|
445
|
-
# Hash - Response body after being parsed from JSON will be returned as a Hash.
|
|
447
|
+
# @return [Hash] - Response body after being parsed from JSON will be returned as a Hash.
|
|
446
448
|
#
|
|
447
449
|
# == Example
|
|
448
450
|
#
|
|
@@ -455,17 +457,17 @@ module RottenTomatoes
|
|
|
455
457
|
|
|
456
458
|
# == Movie Alias
|
|
457
459
|
# Provides a movie lookup by an ID from a different vendor. Only supports imdb lookup at this time. WARNING: This feature is Beta quality. Accuracy of the lookup is not promised. If you see inaccuracies, please report them in the Rotten Tomatoes forums.
|
|
458
|
-
# http://developer.rottentomatoes.com/docs/read/json/v10/Movie_Alias
|
|
460
|
+
# {http://developer.rottentomatoes.com/docs/read/json/v10/Movie_Alias Documentation}
|
|
459
461
|
#
|
|
460
462
|
# == Parameters
|
|
461
463
|
#
|
|
462
|
-
# +args+ -
|
|
463
|
-
# *
|
|
464
|
-
# *
|
|
464
|
+
# @param [Hash] +args+ - May contain the following keys:
|
|
465
|
+
# * `:type` - alias type you want to look up - only imdb is supported at this time.
|
|
466
|
+
# * `:id` - The ID you want to look up
|
|
465
467
|
#
|
|
466
468
|
# == Returns
|
|
467
469
|
#
|
|
468
|
-
# Hash - Response body after being parsed from JSON will be returned as a Hash.
|
|
470
|
+
# @return [Hash] - Response body after being parsed from JSON will be returned as a Hash.
|
|
469
471
|
#
|
|
470
472
|
# == Example
|
|
471
473
|
#
|