howkast 0.0.0
Sign up to get free protection for your applications and to get access to all the features.
- data/.document +5 -0
- data/.rspec +1 -0
- data/GPL-LICENSE +278 -0
- data/Gemfile +16 -0
- data/Gemfile.lock +50 -0
- data/MIT-LICENSE +18 -0
- data/README.md +272 -0
- data/RELEASENOTES +2 -0
- data/Rakefile +49 -0
- data/VERSION +1 -0
- data/features/howkast.feature +9 -0
- data/features/step_definitions/howkast_steps.rb +0 -0
- data/features/support/env.rb +13 -0
- data/howkast.gemspec +109 -0
- data/lib/howkast.rb +22 -0
- data/lib/howkast/api.rb +37 -0
- data/lib/howkast/base.rb +90 -0
- data/lib/howkast/configuration.rb +17 -0
- data/lib/howkast/errors.rb +18 -0
- data/lib/howkast/ext/icebox.rb +261 -0
- data/lib/howkast/ext/string.rb +27 -0
- data/lib/howkast/model.rb +36 -0
- data/lib/howkast/processors/base.rb +40 -0
- data/lib/howkast/processors/categories.rb +50 -0
- data/lib/howkast/processors/playlists.rb +53 -0
- data/lib/howkast/processors/search.rb +41 -0
- data/lib/howkast/processors/users.rb +60 -0
- data/lib/howkast/processors/videos.rb +100 -0
- data/sample/adhoc.rb +29 -0
- data/sample/quickstart.rb +69 -0
- data/spec/howkast/api_service_spec.rb +120 -0
- data/spec/howkast/api_spec.rb +24 -0
- data/spec/howkast/model_spec.rb +73 -0
- data/spec/howkast/processors/categories_spec.rb +27 -0
- data/spec/howkast/processors/playlists_spec.rb +26 -0
- data/spec/howkast/processors/search_spec.rb +26 -0
- data/spec/howkast/processors/users_spec.rb +51 -0
- data/spec/howkast/processors/videos_spec.rb +38 -0
- data/spec/howkast_spec.rb +7 -0
- data/spec/spec_helper.rb +13 -0
- metadata +199 -0
data/.document
ADDED
data/.rspec
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
--color
|
data/GPL-LICENSE
ADDED
@@ -0,0 +1,278 @@
|
|
1
|
+
GNU GENERAL PUBLIC LICENSE
|
2
|
+
Version 2, June 1991
|
3
|
+
|
4
|
+
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
|
5
|
+
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
6
|
+
Everyone is permitted to copy and distribute verbatim copies
|
7
|
+
of this license document, but changing it is not allowed.
|
8
|
+
|
9
|
+
Preamble
|
10
|
+
|
11
|
+
The licenses for most software are designed to take away your
|
12
|
+
freedom to share and change it. By contrast, the GNU General Public
|
13
|
+
License is intended to guarantee your freedom to share and change free
|
14
|
+
software--to make sure the software is free for all its users. This
|
15
|
+
General Public License applies to most of the Free Software
|
16
|
+
Foundation's software and to any other program whose authors commit to
|
17
|
+
using it. (Some other Free Software Foundation software is covered by
|
18
|
+
the GNU Lesser General Public License instead.) You can apply it to
|
19
|
+
your programs, too.
|
20
|
+
|
21
|
+
When we speak of free software, we are referring to freedom, not
|
22
|
+
price. Our General Public Licenses are designed to make sure that you
|
23
|
+
have the freedom to distribute copies of free software (and charge for
|
24
|
+
this service if you wish), that you receive source code or can get it
|
25
|
+
if you want it, that you can change the software or use pieces of it
|
26
|
+
in new free programs; and that you know you can do these things.
|
27
|
+
|
28
|
+
To protect your rights, we need to make restrictions that forbid
|
29
|
+
anyone to deny you these rights or to ask you to surrender the rights.
|
30
|
+
These restrictions translate to certain responsibilities for you if you
|
31
|
+
distribute copies of the software, or if you modify it.
|
32
|
+
|
33
|
+
For example, if you distribute copies of such a program, whether
|
34
|
+
gratis or for a fee, you must give the recipients all the rights that
|
35
|
+
you have. You must make sure that they, too, receive or can get the
|
36
|
+
source code. And you must show them these terms so they know their
|
37
|
+
rights.
|
38
|
+
|
39
|
+
We protect your rights with two steps: (1) copyright the software, and
|
40
|
+
(2) offer you this license which gives you legal permission to copy,
|
41
|
+
distribute and/or modify the software.
|
42
|
+
|
43
|
+
Also, for each author's protection and ours, we want to make certain
|
44
|
+
that everyone understands that there is no warranty for this free
|
45
|
+
software. If the software is modified by someone else and passed on, we
|
46
|
+
want its recipients to know that what they have is not the original, so
|
47
|
+
that any problems introduced by others will not reflect on the original
|
48
|
+
authors' reputations.
|
49
|
+
|
50
|
+
Finally, any free program is threatened constantly by software
|
51
|
+
patents. We wish to avoid the danger that redistributors of a free
|
52
|
+
program will individually obtain patent licenses, in effect making the
|
53
|
+
program proprietary. To prevent this, we have made it clear that any
|
54
|
+
patent must be licensed for everyone's free use or not licensed at all.
|
55
|
+
|
56
|
+
The precise terms and conditions for copying, distribution and
|
57
|
+
modification follow.
|
58
|
+
|
59
|
+
GNU GENERAL PUBLIC LICENSE
|
60
|
+
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
61
|
+
|
62
|
+
0. This License applies to any program or other work which contains
|
63
|
+
a notice placed by the copyright holder saying it may be distributed
|
64
|
+
under the terms of this General Public License. The "Program", below,
|
65
|
+
refers to any such program or work, and a "work based on the Program"
|
66
|
+
means either the Program or any derivative work under copyright law:
|
67
|
+
that is to say, a work containing the Program or a portion of it,
|
68
|
+
either verbatim or with modifications and/or translated into another
|
69
|
+
language. (Hereinafter, translation is included without limitation in
|
70
|
+
the term "modification".) Each licensee is addressed as "you".
|
71
|
+
|
72
|
+
Activities other than copying, distribution and modification are not
|
73
|
+
covered by this License; they are outside its scope. The act of
|
74
|
+
running the Program is not restricted, and the output from the Program
|
75
|
+
is covered only if its contents constitute a work based on the
|
76
|
+
Program (independent of having been made by running the Program).
|
77
|
+
Whether that is true depends on what the Program does.
|
78
|
+
|
79
|
+
1. You may copy and distribute verbatim copies of the Program's
|
80
|
+
source code as you receive it, in any medium, provided that you
|
81
|
+
conspicuously and appropriately publish on each copy an appropriate
|
82
|
+
copyright notice and disclaimer of warranty; keep intact all the
|
83
|
+
notices that refer to this License and to the absence of any warranty;
|
84
|
+
and give any other recipients of the Program a copy of this License
|
85
|
+
along with the Program.
|
86
|
+
|
87
|
+
You may charge a fee for the physical act of transferring a copy, and
|
88
|
+
you may at your option offer warranty protection in exchange for a fee.
|
89
|
+
|
90
|
+
2. You may modify your copy or copies of the Program or any portion
|
91
|
+
of it, thus forming a work based on the Program, and copy and
|
92
|
+
distribute such modifications or work under the terms of Section 1
|
93
|
+
above, provided that you also meet all of these conditions:
|
94
|
+
|
95
|
+
a) You must cause the modified files to carry prominent notices
|
96
|
+
stating that you changed the files and the date of any change.
|
97
|
+
|
98
|
+
b) You must cause any work that you distribute or publish, that in
|
99
|
+
whole or in part contains or is derived from the Program or any
|
100
|
+
part thereof, to be licensed as a whole at no charge to all third
|
101
|
+
parties under the terms of this License.
|
102
|
+
|
103
|
+
c) If the modified program normally reads commands interactively
|
104
|
+
when run, you must cause it, when started running for such
|
105
|
+
interactive use in the most ordinary way, to print or display an
|
106
|
+
announcement including an appropriate copyright notice and a
|
107
|
+
notice that there is no warranty (or else, saying that you provide
|
108
|
+
a warranty) and that users may redistribute the program under
|
109
|
+
these conditions, and telling the user how to view a copy of this
|
110
|
+
License. (Exception: if the Program itself is interactive but
|
111
|
+
does not normally print such an announcement, your work based on
|
112
|
+
the Program is not required to print an announcement.)
|
113
|
+
|
114
|
+
These requirements apply to the modified work as a whole. If
|
115
|
+
identifiable sections of that work are not derived from the Program,
|
116
|
+
and can be reasonably considered independent and separate works in
|
117
|
+
themselves, then this License, and its terms, do not apply to those
|
118
|
+
sections when you distribute them as separate works. But when you
|
119
|
+
distribute the same sections as part of a whole which is a work based
|
120
|
+
on the Program, the distribution of the whole must be on the terms of
|
121
|
+
this License, whose permissions for other licensees extend to the
|
122
|
+
entire whole, and thus to each and every part regardless of who wrote it.
|
123
|
+
|
124
|
+
Thus, it is not the intent of this section to claim rights or contest
|
125
|
+
your rights to work written entirely by you; rather, the intent is to
|
126
|
+
exercise the right to control the distribution of derivative or
|
127
|
+
collective works based on the Program.
|
128
|
+
|
129
|
+
In addition, mere aggregation of another work not based on the Program
|
130
|
+
with the Program (or with a work based on the Program) on a volume of
|
131
|
+
a storage or distribution medium does not bring the other work under
|
132
|
+
the scope of this License.
|
133
|
+
|
134
|
+
3. You may copy and distribute the Program (or a work based on it,
|
135
|
+
under Section 2) in object code or executable form under the terms of
|
136
|
+
Sections 1 and 2 above provided that you also do one of the following:
|
137
|
+
|
138
|
+
a) Accompany it with the complete corresponding machine-readable
|
139
|
+
source code, which must be distributed under the terms of Sections
|
140
|
+
1 and 2 above on a medium customarily used for software interchange; or,
|
141
|
+
|
142
|
+
b) Accompany it with a written offer, valid for at least three
|
143
|
+
years, to give any third party, for a charge no more than your
|
144
|
+
cost of physically performing source distribution, a complete
|
145
|
+
machine-readable copy of the corresponding source code, to be
|
146
|
+
distributed under the terms of Sections 1 and 2 above on a medium
|
147
|
+
customarily used for software interchange; or,
|
148
|
+
|
149
|
+
c) Accompany it with the information you received as to the offer
|
150
|
+
to distribute corresponding source code. (This alternative is
|
151
|
+
allowed only for noncommercial distribution and only if you
|
152
|
+
received the program in object code or executable form with such
|
153
|
+
an offer, in accord with Subsection b above.)
|
154
|
+
|
155
|
+
The source code for a work means the preferred form of the work for
|
156
|
+
making modifications to it. For an executable work, complete source
|
157
|
+
code means all the source code for all modules it contains, plus any
|
158
|
+
associated interface definition files, plus the scripts used to
|
159
|
+
control compilation and installation of the executable. However, as a
|
160
|
+
special exception, the source code distributed need not include
|
161
|
+
anything that is normally distributed (in either source or binary
|
162
|
+
form) with the major components (compiler, kernel, and so on) of the
|
163
|
+
operating system on which the executable runs, unless that component
|
164
|
+
itself accompanies the executable.
|
165
|
+
|
166
|
+
If distribution of executable or object code is made by offering
|
167
|
+
access to copy from a designated place, then offering equivalent
|
168
|
+
access to copy the source code from the same place counts as
|
169
|
+
distribution of the source code, even though third parties are not
|
170
|
+
compelled to copy the source along with the object code.
|
171
|
+
|
172
|
+
4. You may not copy, modify, sublicense, or distribute the Program
|
173
|
+
except as expressly provided under this License. Any attempt
|
174
|
+
otherwise to copy, modify, sublicense or distribute the Program is
|
175
|
+
void, and will automatically terminate your rights under this License.
|
176
|
+
However, parties who have received copies, or rights, from you under
|
177
|
+
this License will not have their licenses terminated so long as such
|
178
|
+
parties remain in full compliance.
|
179
|
+
|
180
|
+
5. You are not required to accept this License, since you have not
|
181
|
+
signed it. However, nothing else grants you permission to modify or
|
182
|
+
distribute the Program or its derivative works. These actions are
|
183
|
+
prohibited by law if you do not accept this License. Therefore, by
|
184
|
+
modifying or distributing the Program (or any work based on the
|
185
|
+
Program), you indicate your acceptance of this License to do so, and
|
186
|
+
all its terms and conditions for copying, distributing or modifying
|
187
|
+
the Program or works based on it.
|
188
|
+
|
189
|
+
6. Each time you redistribute the Program (or any work based on the
|
190
|
+
Program), the recipient automatically receives a license from the
|
191
|
+
original licensor to copy, distribute or modify the Program subject to
|
192
|
+
these terms and conditions. You may not impose any further
|
193
|
+
restrictions on the recipients' exercise of the rights granted herein.
|
194
|
+
You are not responsible for enforcing compliance by third parties to
|
195
|
+
this License.
|
196
|
+
|
197
|
+
7. If, as a consequence of a court judgment or allegation of patent
|
198
|
+
infringement or for any other reason (not limited to patent issues),
|
199
|
+
conditions are imposed on you (whether by court order, agreement or
|
200
|
+
otherwise) that contradict the conditions of this License, they do not
|
201
|
+
excuse you from the conditions of this License. If you cannot
|
202
|
+
distribute so as to satisfy simultaneously your obligations under this
|
203
|
+
License and any other pertinent obligations, then as a consequence you
|
204
|
+
may not distribute the Program at all. For example, if a patent
|
205
|
+
license would not permit royalty-free redistribution of the Program by
|
206
|
+
all those who receive copies directly or indirectly through you, then
|
207
|
+
the only way you could satisfy both it and this License would be to
|
208
|
+
refrain entirely from distribution of the Program.
|
209
|
+
|
210
|
+
If any portion of this section is held invalid or unenforceable under
|
211
|
+
any particular circumstance, the balance of the section is intended to
|
212
|
+
apply and the section as a whole is intended to apply in other
|
213
|
+
circumstances.
|
214
|
+
|
215
|
+
It is not the purpose of this section to induce you to infringe any
|
216
|
+
patents or other property right claims or to contest validity of any
|
217
|
+
such claims; this section has the sole purpose of protecting the
|
218
|
+
integrity of the free software distribution system, which is
|
219
|
+
implemented by public license practices. Many people have made
|
220
|
+
generous contributions to the wide range of software distributed
|
221
|
+
through that system in reliance on consistent application of that
|
222
|
+
system; it is up to the author/donor to decide if he or she is willing
|
223
|
+
to distribute software through any other system and a licensee cannot
|
224
|
+
impose that choice.
|
225
|
+
|
226
|
+
This section is intended to make thoroughly clear what is believed to
|
227
|
+
be a consequence of the rest of this License.
|
228
|
+
|
229
|
+
8. If the distribution and/or use of the Program is restricted in
|
230
|
+
certain countries either by patents or by copyrighted interfaces, the
|
231
|
+
original copyright holder who places the Program under this License
|
232
|
+
may add an explicit geographical distribution limitation excluding
|
233
|
+
those countries, so that distribution is permitted only in or among
|
234
|
+
countries not thus excluded. In such case, this License incorporates
|
235
|
+
the limitation as if written in the body of this License.
|
236
|
+
|
237
|
+
9. The Free Software Foundation may publish revised and/or new versions
|
238
|
+
of the General Public License from time to time. Such new versions will
|
239
|
+
be similar in spirit to the present version, but may differ in detail to
|
240
|
+
address new problems or concerns.
|
241
|
+
|
242
|
+
Each version is given a distinguishing version number. If the Program
|
243
|
+
specifies a version number of this License which applies to it and "any
|
244
|
+
later version", you have the option of following the terms and conditions
|
245
|
+
either of that version or of any later version published by the Free
|
246
|
+
Software Foundation. If the Program does not specify a version number of
|
247
|
+
this License, you may choose any version ever published by the Free Software
|
248
|
+
Foundation.
|
249
|
+
|
250
|
+
10. If you wish to incorporate parts of the Program into other free
|
251
|
+
programs whose distribution conditions are different, write to the author
|
252
|
+
to ask for permission. For software which is copyrighted by the Free
|
253
|
+
Software Foundation, write to the Free Software Foundation; we sometimes
|
254
|
+
make exceptions for this. Our decision will be guided by the two goals
|
255
|
+
of preserving the free status of all derivatives of our free software and
|
256
|
+
of promoting the sharing and reuse of software generally.
|
257
|
+
|
258
|
+
NO WARRANTY
|
259
|
+
|
260
|
+
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
261
|
+
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
262
|
+
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
263
|
+
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
264
|
+
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
265
|
+
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
266
|
+
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
267
|
+
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
268
|
+
REPAIR OR CORRECTION.
|
269
|
+
|
270
|
+
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
271
|
+
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
272
|
+
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
273
|
+
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
274
|
+
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
275
|
+
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
276
|
+
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
277
|
+
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
278
|
+
POSSIBILITY OF SUCH DAMAGES.
|
data/Gemfile
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
source "http://rubygems.org"
|
2
|
+
|
3
|
+
group :production do
|
4
|
+
gem "activesupport", ">= 3.0.3"
|
5
|
+
gem "httparty", ">= 0.6.1"
|
6
|
+
gem "named-parameters", ">= 0.0.22"
|
7
|
+
end
|
8
|
+
|
9
|
+
group :development do
|
10
|
+
gem "rspec", "~> 2.3.0"
|
11
|
+
gem "yard", "~> 0.6.0"
|
12
|
+
gem "cucumber", ">= 0"
|
13
|
+
gem "bundler", "~> 1.0.0"
|
14
|
+
gem "jeweler", "~> 1.5.2"
|
15
|
+
gem "rcov", ">= 0"
|
16
|
+
end
|
data/Gemfile.lock
ADDED
@@ -0,0 +1,50 @@
|
|
1
|
+
GEM
|
2
|
+
remote: http://rubygems.org/
|
3
|
+
specs:
|
4
|
+
activesupport (3.0.3)
|
5
|
+
builder (3.0.0)
|
6
|
+
crack (0.1.8)
|
7
|
+
cucumber (0.10.0)
|
8
|
+
builder (>= 2.1.2)
|
9
|
+
diff-lcs (~> 1.1.2)
|
10
|
+
gherkin (~> 2.3.2)
|
11
|
+
json (~> 1.4.6)
|
12
|
+
term-ansicolor (~> 1.0.5)
|
13
|
+
diff-lcs (1.1.2)
|
14
|
+
gherkin (2.3.3)
|
15
|
+
json (~> 1.4.6)
|
16
|
+
git (1.2.5)
|
17
|
+
httparty (0.6.1)
|
18
|
+
crack (= 0.1.8)
|
19
|
+
jeweler (1.5.2)
|
20
|
+
bundler (~> 1.0.0)
|
21
|
+
git (>= 1.2.5)
|
22
|
+
rake
|
23
|
+
json (1.4.6)
|
24
|
+
named-parameters (0.0.22)
|
25
|
+
rake (0.8.7)
|
26
|
+
rcov (0.9.9)
|
27
|
+
rspec (2.3.0)
|
28
|
+
rspec-core (~> 2.3.0)
|
29
|
+
rspec-expectations (~> 2.3.0)
|
30
|
+
rspec-mocks (~> 2.3.0)
|
31
|
+
rspec-core (2.3.1)
|
32
|
+
rspec-expectations (2.3.0)
|
33
|
+
diff-lcs (~> 1.1.2)
|
34
|
+
rspec-mocks (2.3.0)
|
35
|
+
term-ansicolor (1.0.5)
|
36
|
+
yard (0.6.4)
|
37
|
+
|
38
|
+
PLATFORMS
|
39
|
+
ruby
|
40
|
+
|
41
|
+
DEPENDENCIES
|
42
|
+
activesupport (>= 3.0.3)
|
43
|
+
bundler (~> 1.0.0)
|
44
|
+
cucumber
|
45
|
+
httparty (>= 0.6.1)
|
46
|
+
jeweler (~> 1.5.2)
|
47
|
+
named-parameters (>= 0.0.22)
|
48
|
+
rcov
|
49
|
+
rspec (~> 2.3.0)
|
50
|
+
yard (~> 0.6.0)
|
data/MIT-LICENSE
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
2
|
+
a copy of this software and associated documentation files (the
|
3
|
+
"Software"), to deal in the Software without restriction, including
|
4
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
5
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
6
|
+
permit persons to whom the Software is furnished to do so, subject to
|
7
|
+
the following conditions:
|
8
|
+
|
9
|
+
The above copyright notice and this permission notice shall be
|
10
|
+
included in all copies or substantial portions of the Software.
|
11
|
+
|
12
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
13
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
14
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
15
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
16
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
17
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
18
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,272 @@
|
|
1
|
+
This gem implements Ruby bindings for the [Howcast](http://howcast.com) API.
|
2
|
+
|
3
|
+
From Howcast's [About Us](http://info.howcast.com/about) page:
|
4
|
+
|
5
|
+
> Howcast empowers people with engaging, useful how-to information wherever,
|
6
|
+
> whenever they need to know how.
|
7
|
+
>
|
8
|
+
> Known for high-quality content, Howcast streams tens of millions of videos
|
9
|
+
> every month across its multi-platform distribution network. Approaching two
|
10
|
+
> million downloads across iPhone, iPad, Android, and BlackBerry phones, Howcast
|
11
|
+
> is the #1 mobile app for instructional content -- wherever you are.
|
12
|
+
|
13
|
+
Install
|
14
|
+
-------
|
15
|
+
|
16
|
+
gem install howkast
|
17
|
+
|
18
|
+
Configure
|
19
|
+
---------
|
20
|
+
Most of the service requests require an API key. You can either set this when
|
21
|
+
you create an instance of `Howkast::API`:
|
22
|
+
|
23
|
+
howcast = Howkast::API.new :api_key => 'YOUR-API-KEY'
|
24
|
+
howcast.categories
|
25
|
+
|
26
|
+
Or create a configuration that file and set it by invoking the `Howkast::configure`
|
27
|
+
method:
|
28
|
+
|
29
|
+
# create the configuration file
|
30
|
+
cat > ~/.howkast <<EOF
|
31
|
+
:api_key: YOUR-API-KEY
|
32
|
+
EOF
|
33
|
+
|
34
|
+
# now use it
|
35
|
+
require 'rubygems'
|
36
|
+
require 'yaml'
|
37
|
+
require 'howkast'
|
38
|
+
|
39
|
+
Howkast::configure YAML.load File.read('~/.howkast')
|
40
|
+
howcast = Howkast::API.new
|
41
|
+
howcast.categories
|
42
|
+
|
43
|
+
Quickstart
|
44
|
+
----------
|
45
|
+
|
46
|
+
require 'rubygems'
|
47
|
+
require 'yaml'
|
48
|
+
begin
|
49
|
+
require 'howkast'
|
50
|
+
rescue LoadError
|
51
|
+
$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
|
52
|
+
require 'howkast'
|
53
|
+
end
|
54
|
+
|
55
|
+
# configure
|
56
|
+
Howkast::configure YAML.load File.read('.howkast')
|
57
|
+
|
58
|
+
# create instance
|
59
|
+
howcast = Howkast::API.new
|
60
|
+
|
61
|
+
# alternative instantiation
|
62
|
+
# howcast = Howkast::API.new :api_key => 'YOUR-HOWCAST-API-KEY'
|
63
|
+
|
64
|
+
# search for jujitsu how-to videos
|
65
|
+
search = howcast.search :query => 'jujitsu'
|
66
|
+
|
67
|
+
# get detail for the first video listed in the search
|
68
|
+
video_id = search.videos.first.id
|
69
|
+
video = howcast.video :id => video_id
|
70
|
+
puts video.title
|
71
|
+
puts video.embed
|
72
|
+
|
73
|
+
# find out what other videos where uploaded by the same user
|
74
|
+
username = video.username
|
75
|
+
user = howcast.user :id => username, :resource => :videos
|
76
|
+
puts user.title
|
77
|
+
user.videos.each do |video|
|
78
|
+
puts "- #{video.id}\t#{video.title}"
|
79
|
+
end
|
80
|
+
|
81
|
+
# list user's favorite videos
|
82
|
+
user = howcast.user :id => username, :resource => :favorites
|
83
|
+
puts user.title
|
84
|
+
user.videos.each do |video|
|
85
|
+
puts "- #{video.id}\t#{video.title}\t#{video.description}"
|
86
|
+
end
|
87
|
+
|
88
|
+
# list user's playlists
|
89
|
+
user = howcast.user :id => username, :resource => :playlists
|
90
|
+
puts user.title
|
91
|
+
user.playlists.each do |video|
|
92
|
+
puts "- #{video.id}\t#{video.title}"
|
93
|
+
end
|
94
|
+
|
95
|
+
# list available categories
|
96
|
+
categories = howcast.categories
|
97
|
+
categories.each do |category|
|
98
|
+
puts "#{category.id}\t#{category.name}"
|
99
|
+
end
|
100
|
+
|
101
|
+
# get details about a category
|
102
|
+
category = howcast.category :id => categories.first.id
|
103
|
+
puts category.name
|
104
|
+
category.subcategories.each do |category|
|
105
|
+
puts "- #{category.id}\t#{category.name}"
|
106
|
+
end
|
107
|
+
|
108
|
+
# list the videos in a playlist
|
109
|
+
playlist = howcast.playlist :id => '4261'
|
110
|
+
puts playlist.title
|
111
|
+
puts playlist.description
|
112
|
+
playlist.videos.each do |video|
|
113
|
+
puts "- #{video.id}\t#{video.title}"
|
114
|
+
end
|
115
|
+
|
116
|
+
Services
|
117
|
+
--------
|
118
|
+
To identify what services are supported, you can invoke the `services` class
|
119
|
+
method from the `Howkast::API` class:
|
120
|
+
|
121
|
+
Howkast::API.services # => [:video, :videos, :search, :user, :playlist, :category, :categories]
|
122
|
+
|
123
|
+
At the time of this writing, this gem implements all of the services listed in
|
124
|
+
the [Howcast API Documentation](http://groups.google.com/group/howcast-developers/web/api-documentation)
|
125
|
+
|
126
|
+
The current implementation is that each service expects a `Hash` that names
|
127
|
+
the parameters required to fulfill the request. The acceptable parameters
|
128
|
+
(with a minor adjustments to make the parameter names consistent) closely
|
129
|
+
match the documented service signatures.
|
130
|
+
|
131
|
+
Here are some examples to illustrate the service calls. Notice that the `format`
|
132
|
+
parameter does not need to be specified and that the `api_key` only needs to
|
133
|
+
be set at configuration or when the `Howkast::API` object is created:
|
134
|
+
|
135
|
+
### Get Video
|
136
|
+
|
137
|
+
# GET http://www.howcast.com/videos/<video_id>.<format>?api_key=<api_key>
|
138
|
+
howcast.video :id => 6570
|
139
|
+
|
140
|
+
### List Videos
|
141
|
+
|
142
|
+
# GET http://www.howcast.com/videos/<sort>/<filter>/<category>.<format>?api_key=<api_key>
|
143
|
+
howcast.videos :sort => :top_rated, :filter => :howcast_studios, :page => 5
|
144
|
+
|
145
|
+
### Search Videos
|
146
|
+
|
147
|
+
# GET http://www.howcast.com/search.<format>?q=<query>&view=video&api_key=<api_key>
|
148
|
+
howcast.search :query => 'jujitsu'
|
149
|
+
|
150
|
+
### List Top-Level Categories
|
151
|
+
|
152
|
+
# GET http://www.howcast.com/categories.<format>?api_key=<api_key>
|
153
|
+
howcast.categories
|
154
|
+
|
155
|
+
Anyway, you get the idea.
|
156
|
+
|
157
|
+
Read the [Howcast API Documentation](http://groups.google.com/group/howcast-developers/web/api-documentation)
|
158
|
+
for details.
|
159
|
+
|
160
|
+
Models
|
161
|
+
------
|
162
|
+
The return value of a service request is an instance of `Howkast::Model` - the
|
163
|
+
actual type returned depends on the service invoked.
|
164
|
+
|
165
|
+
The rule to determine the type of the response is:
|
166
|
+
|
167
|
+
1. The name of the service in singular form dictates the name of the model
|
168
|
+
(eg: `video` returns `Howkast::Model::Video`)
|
169
|
+
2. If the service name is in plural form, then an `Array` of the expected
|
170
|
+
model is returned.
|
171
|
+
|
172
|
+
The `Howkast::Model` instance returned will have the appropriate attributes
|
173
|
+
as described in the [Howcast API Documentation](http://groups.google.com/group/howcast-developers/web/api-documentation)
|
174
|
+
|
175
|
+
You can examine the list of attributes by invoking the `#instance_attributes`
|
176
|
+
method of the returned model:
|
177
|
+
|
178
|
+
video = howcast.video :id => 6570
|
179
|
+
video.class # => Howkast::Model::Video
|
180
|
+
video.instance_attributes # => [:id, :category_id, :category_hierarchy, :easy_steps, :badges, :created_at, :filename, :tags, :title, :description, :permalink, :edit_url, :state, :duration, :width, :height, :embed, :rating, :username, :thumbnail_url, :views, :content_rating, :overlay, :ingredients, :markers, :related_videos, :comments]
|
181
|
+
|
182
|
+
And of course examine each attribute as needed:
|
183
|
+
|
184
|
+
video.category_hierarchy # => Array of Howkast::Model::Category
|
185
|
+
video.title # => "How To Drive a Stick Shift"
|
186
|
+
video.related_videos # => Array of Howkast::Model::Video
|
187
|
+
video.markers # => Array of Howkast::Model::Marker
|
188
|
+
video.markers.first.type # => Step
|
189
|
+
|
190
|
+
Errors
|
191
|
+
------
|
192
|
+
If a service request fails then a `Howkast::Error::RequestError` error type is
|
193
|
+
raised. The actual type raised depends on the error.
|
194
|
+
|
195
|
+
The following shows several service calls, any one of which may raise an
|
196
|
+
error, along with possible ways to deal with the error:
|
197
|
+
|
198
|
+
howcast = Howkast::API.new
|
199
|
+
begin
|
200
|
+
howcast.user :id => "kreektrebano", :resource => :videos
|
201
|
+
howcast.user :id => "jurisgalang", :resource => :favorite
|
202
|
+
howcast.videos :sort => :most_recent,
|
203
|
+
:filter => :all,
|
204
|
+
:page => 99999999
|
205
|
+
howcast.categories
|
206
|
+
rescue Howkast::Error::UserNotFound
|
207
|
+
# ignore
|
208
|
+
rescue Howkast::Error::HTTP404
|
209
|
+
# ignore but log, this is raised if the resource requested is not found;
|
210
|
+
# eg: specifying a :resource that is not supported, or the :page requested
|
211
|
+
# does not exist
|
212
|
+
rescue Howkast::Error::InvalidAPIKey
|
213
|
+
# the service call requires registration and a valid API key to work
|
214
|
+
rescue Howkast::Error::HTTP500
|
215
|
+
# ignore but log and file a bug at support+api@howcast.com
|
216
|
+
end
|
217
|
+
|
218
|
+
Of the above `Howkast::Error::UserNotFound` and `Howkast::Error::HTTP404` are
|
219
|
+
most likely benign.
|
220
|
+
|
221
|
+
Read the **HTTP Status Codes and Errors** section of the [Howcast API Documentation](http://groups.google.com/group/howcast-developers/web/api-documentation)
|
222
|
+
for details on the types of errors that may be encountered.
|
223
|
+
|
224
|
+
Gotchas
|
225
|
+
-------
|
226
|
+
At the moment, this gem is intended for `Ruby 1.9.x` use only.
|
227
|
+
|
228
|
+
Currently, Howcast responds with an HTTP500 error when the `:q` parameter
|
229
|
+
value is empty the `#search` service plugs this parameter with something that
|
230
|
+
*might not* exist and hopefully it returns an appropriate search result (ie:
|
231
|
+
an empty list)
|
232
|
+
|
233
|
+
Download
|
234
|
+
--------
|
235
|
+
You can download this project in either
|
236
|
+
[zip](http://github.com/jurisgalang/howkast/zipball/master) or
|
237
|
+
[tar](http://github.com/jurisgalang/howkast/tarball/master") formats.
|
238
|
+
|
239
|
+
You can also clone the project with [Git](http://git-scm.com)
|
240
|
+
by running:
|
241
|
+
|
242
|
+
git clone git://github.com/jurisgalang/howkast
|
243
|
+
|
244
|
+
Note on Patches/Pull Requests
|
245
|
+
-----------------------------
|
246
|
+
* Fork the project.
|
247
|
+
* Make your feature addition or bug fix.
|
248
|
+
* Add tests for it. This is important so I don't break it in a future version
|
249
|
+
unintentionally.
|
250
|
+
* Commit, do not mess with rakefile, version, or history. (if you want to have
|
251
|
+
your own version, that is fine but bump version in a commit by itself I can
|
252
|
+
ignore when I pull)
|
253
|
+
* Send me a pull request. Bonus points for topic branches.
|
254
|
+
|
255
|
+
Releases
|
256
|
+
--------
|
257
|
+
Please read the `RELEASENOTES` file for the details of each release.
|
258
|
+
|
259
|
+
In general: patch releases will not include breaking changes while releases
|
260
|
+
that bumps the major or minor components of the version string may or may not
|
261
|
+
include breaking changes.
|
262
|
+
|
263
|
+
Author
|
264
|
+
------
|
265
|
+
[Juris Galang](http://github.com/jurisgalang/)
|
266
|
+
|
267
|
+
License
|
268
|
+
-------
|
269
|
+
Dual licensed under the MIT or GPL Version 2 licenses.
|
270
|
+
See the MIT-LICENSE and GPL-LICENSE files for details.
|
271
|
+
|
272
|
+
Copyright (c) 2010 Juris Galang. All Rights Reserved.
|