flickr.rb 1.1.2 → 1.2.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -2,106 +2,129 @@
2
2
 
3
3
  <html>
4
4
  <head>
5
- <meta charset="UTF-8">
5
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
6
6
 
7
7
  <title>README - Flickr</title>
8
8
 
9
- <link href="./fonts.css" rel="stylesheet">
10
- <link href="./rdoc.css" rel="stylesheet">
9
+ <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
11
10
 
12
11
  <script type="text/javascript">
13
12
  var rdoc_rel_prefix = "./";
14
13
  </script>
15
14
 
16
- <script src="./js/jquery.js"></script>
17
- <script src="./js/navigation.js"></script>
18
- <script src="./js/search_index.js"></script>
19
- <script src="./js/search.js"></script>
20
- <script src="./js/searcher.js"></script>
21
- <script src="./js/darkfish.js"></script>
15
+ <script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
16
+ <script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
17
+ <script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
18
+ <script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
19
+ <script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
20
+ <script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
22
21
 
23
22
 
24
- <body id="top" role="document" class="file">
25
- <nav role="navigation">
26
- <div id="project-navigation">
27
- <div id="home-section" role="region" title="Quick navigation" class="nav-section">
28
- <h2>
29
- <a href="./index.html" rel="home">Home</a>
30
- </h2>
31
-
32
- <div id="table-of-contents-navigation">
33
- <a href="./table_of_contents.html#pages">Pages</a>
23
+ <body class="file">
24
+ <nav id="metadata">
25
+ <nav id="home-section" class="section">
26
+ <h3 class="section-header">
27
+ <a href="./index.html">Home</a>
34
28
  <a href="./table_of_contents.html#classes">Classes</a>
35
29
  <a href="./table_of_contents.html#methods">Methods</a>
36
- </div>
37
- </div>
30
+ </h3>
31
+ </nav>
32
+
38
33
 
39
- <div id="search-section" role="search" class="project-section initially-hidden">
34
+ <nav id="search-section" class="section project-section" class="initially-hidden">
40
35
  <form action="#" method="get" accept-charset="utf-8">
41
- <div id="search-field-wrapper">
42
- <input id="search-field" role="combobox" aria-label="Search"
43
- aria-autocomplete="list" aria-controls="search-results"
44
- type="text" name="search" placeholder="Search" spellcheck="false"
36
+ <h3 class="section-header">
37
+ <input type="text" name="search" placeholder="Search" id="search-field"
45
38
  title="Type to search, Up and Down to navigate, Enter to load">
46
- </div>
47
-
48
- <ul id="search-results" aria-label="Search Results"
49
- aria-busy="false" aria-expanded="false"
50
- aria-atomic="false" class="initially-hidden"></ul>
39
+ </h3>
51
40
  </form>
52
- </div>
53
41
 
54
- </div>
42
+ <ul id="search-results" class="initially-hidden"></ul>
43
+ </nav>
44
+
55
45
 
56
46
 
57
- <div class="nav-section">
58
- <h3>Table of Contents</h3>
59
-
60
- <ul class="link-list" role="directory">
61
- <li><a href="#label-flickr">flickr</a>
62
- <li><a href="#label-DESCRIPTION%3A">DESCRIPTION:</a>
63
- <li><a href="#label-FEATURES%2FPROBLEMS%3A">FEATURES/PROBLEMS:</a>
64
- <li><a href="#label-SYNOPSIS%3A">SYNOPSIS:</a>
65
- <li><a href="#label-REQUIREMENTS%3A">REQUIREMENTS:</a>
66
- <li><a href="#label-INSTALL%3A">INSTALL:</a>
67
- <li><a href="#label-CONFIGURING%3A">CONFIGURING:</a>
68
- <li><a href="#label-LICENSE%3A">LICENSE:</a>
69
- </ul>
47
+ <div id="table-of-contents">
48
+ <nav class="section">
49
+ <h3 class="section-header">Table of Contents</h3>
50
+ <ul>
51
+ <li><a href="#label-flickr.rb">flickr.rb</a>
52
+ <li><a href="#label-DESCRIPTION%3A">DESCRIPTION:</a>
53
+ <li><a href="#label-FEATURES%2FPROBLEMS%3A">FEATURES/PROBLEMS:</a>
54
+ <li><a href="#label-SYNOPSIS%3A">SYNOPSIS:</a>
55
+ <li><a href="#label-REQUIREMENTS%3A">REQUIREMENTS:</a>
56
+ <li><a href="#label-INSTALLATION%3A">INSTALLATION:</a>
57
+ <li><a href="#label-CONFIGURING%3A">CONFIGURING:</a>
58
+ <li><a href="#label-CONTRIBUTING">CONTRIBUTING</a>
59
+ <li><a href="#label-THANKS">THANKS</a>
60
+ <li><a href="#label-LICENSE">LICENSE</a>
61
+ </ul>
62
+ </nav>
70
63
  </div>
71
64
 
72
65
 
73
66
  <div id="project-metadata">
74
- <div id="fileindex-section" class="nav-section">
75
- <h3>Pages</h3>
67
+ <nav id="fileindex-section" class="section project-section">
68
+ <h3 class="section-header">Pages</h3>
69
+
70
+ <ul>
71
+
72
+ <li class="file"><a href="./README_md.html">README</a>
73
+
74
+ </ul>
75
+ </nav>
76
+
77
+ <nav id="classindex-section" class="section project-section">
78
+ <h3 class="section-header">Class and Module Index</h3>
76
79
 
77
80
  <ul class="link-list">
78
81
 
79
- <li><a href="./README_txt.html">README</a>
82
+ <li><a href="./Flickr.html">Flickr</a>
83
+
84
+ <li><a href="./Flickr/Config.html">Flickr::Config</a>
85
+
86
+ <li><a href="./Flickr/Group.html">Flickr::Group</a>
87
+
88
+ <li><a href="./Flickr/Photo.html">Flickr::Photo</a>
89
+
90
+ <li><a href="./Flickr/PhotoCollection.html">Flickr::PhotoCollection</a>
91
+
92
+ <li><a href="./Flickr/Photoset.html">Flickr::Photoset</a>
93
+
94
+ <li><a href="./Flickr/User.html">Flickr::User</a>
80
95
 
81
96
  </ul>
82
- </div>
97
+ </nav>
83
98
 
84
99
  </div>
85
100
  </nav>
86
101
 
87
- <main role="main" aria-label="Page README.txt">
88
-
89
- <h1 id="label-flickr">flickr<span><a href="#label-flickr">&para;</a> <a href="#documentation">&uarr;</a></span></h1>
102
+ <div id="documentation" class="description">
103
+
104
+ <h1 id="label-flickr.rb">flickr.rb<span><a href="#label-flickr.rb">&para;</a> <a href="#documentation">&uarr;</a></span></h1>
90
105
 
91
106
  <p><a href="http://github.com/RaVbaker/flickr">github.com/RaVbaker/flickr</a></p>
92
107
 
108
+ <p><a href="https://badge.fury.io/rb/flickr.rb.svg">{Gem Version</a>]</p>
109
+
93
110
  <h2 id="label-DESCRIPTION%3A">DESCRIPTION:<span><a href="#label-DESCRIPTION%3A">&para;</a> <a href="#documentation">&uarr;</a></span></h2>
94
111
 
95
112
  <p>An insanely easy interface to the <a href="Flickr.html">Flickr</a>
96
113
  photo-sharing service. By Scott Raymond. (&amp; updated May 2008 by Chris
97
114
  Taggart, <a href="http://pushrod.wordpress.com">pushrod.wordpress.com</a>
98
- &amp; updated May 2010 by Rafal Piekarski)</p>
115
+ &amp; maintained since May 2010 by me - Rafal Piekarski)</p>
116
+
117
+ <p>It&#39;s a simple interface for using <a href="Flickr.html">Flickr</a> API
118
+ - <a
119
+ href="https://www.flickr.com/services/api/">www.flickr.com/services/api/</a></p>
99
120
 
100
121
  <h2 id="label-FEATURES%2FPROBLEMS%3A">FEATURES/PROBLEMS:<span><a href="#label-FEATURES%2FPROBLEMS%3A">&para;</a> <a href="#documentation">&uarr;</a></span></h2>
101
122
 
102
123
  <p>The flickr gem (famously featured in a RubyonRails screencast) had broken
103
- with Flickr&#39;s new authentication scheme and updated API. This has now
104
- been largely corrected, though not all current API calls are supported yet.</p>
124
+ with Flickr&#39;s new authentication scheme and updated API.
125
+ This has now
126
+ been largely corrected, though not all current API calls are supported yet.
127
+ If you need something let me know in pull requests.</p>
105
128
 
106
129
  <h2 id="label-SYNOPSIS%3A">SYNOPSIS:<span><a href="#label-SYNOPSIS%3A">&para;</a> <a href="#documentation">&uarr;</a></span></h2>
107
130
 
@@ -116,7 +139,7 @@ been largely corrected, though not all current API calls are supported yet.</p>
116
139
  <span class="ruby-identifier">user</span>.<span class="ruby-identifier">favorites</span> <span class="ruby-comment"># ...favorite photos...</span>
117
140
  <span class="ruby-identifier">user</span>.<span class="ruby-identifier">photosets</span> <span class="ruby-comment"># ...their photo sets...</span>
118
141
  <span class="ruby-identifier">user</span>.<span class="ruby-identifier">tags</span> <span class="ruby-comment"># ...their tags...</span>
119
- <span class="ruby-identifier">user</span>.<span class="ruby-identifier">popular_tags</span> <span class="ruby-comment"># ...and their popular tags</span>
142
+ <span class="ruby-identifier">user</span>.<span class="ruby-identifier">popular_tags</span> <span class="ruby-comment"># ...and their popular tags</span>
120
143
  <span class="ruby-identifier">recentphotos</span> = <span class="ruby-identifier">flickr</span>.<span class="ruby-identifier">photos</span> <span class="ruby-comment"># get the 100 most recent public photos</span>
121
144
  <span class="ruby-identifier">photo</span> = <span class="ruby-identifier">recentphotos</span>.<span class="ruby-identifier">first</span> <span class="ruby-comment"># or very most recent one</span>
122
145
  <span class="ruby-identifier">photo</span>.<span class="ruby-identifier">url</span> <span class="ruby-comment"># see its URL,</span>
@@ -138,9 +161,19 @@ been largely corrected, though not all current API calls are supported yet.</p>
138
161
  <p>Xmlsimple gem</p>
139
162
  </li></ul>
140
163
 
141
- <h2 id="label-INSTALL%3A">INSTALL:<span><a href="#label-INSTALL%3A">&para;</a> <a href="#documentation">&uarr;</a></span></h2>
164
+ <h2 id="label-INSTALLATION%3A">INSTALLATION:<span><a href="#label-INSTALLATION%3A">&para;</a> <a href="#documentation">&uarr;</a></span></h2>
165
+
166
+ <p>Add this line to your application&#39;s Gemfile:</p>
167
+
168
+ <pre>gem &#39;flickr.rb&#39;</pre>
142
169
 
143
- <pre>sudo gem install flickr.rb</pre>
170
+ <p>And then execute:</p>
171
+
172
+ <pre>$ bundle</pre>
173
+
174
+ <p>Or install it yourself as:</p>
175
+
176
+ <pre>$ gem install flickr.rb</pre>
144
177
  <ul><li>
145
178
  <p>Gem homepage: <a
146
179
  href="http://rubygems.org/gems/flickr.rb">rubygems.org/gems/flickr.rb</a></p>
@@ -148,9 +181,25 @@ href="http://rubygems.org/gems/flickr.rb">rubygems.org/gems/flickr.rb</a></p>
148
181
 
149
182
  <h2 id="label-CONFIGURING%3A">CONFIGURING:<span><a href="#label-CONFIGURING%3A">&para;</a> <a href="#documentation">&uarr;</a></span></h2>
150
183
 
151
- <p>If you want to use this gem/plugin with Rails you can create configuration
152
- file in /config directory with specified api connection settings. For
153
- example:</p>
184
+ <p>You can provide just a api_key <code>Flickr.new(&#39;api_key&#39;)</code>
185
+ or full set of advanced configuration options:</p>
186
+
187
+ <pre>flickr = Flickr.new(
188
+ api_key: &#39;your_api_key&#39;,
189
+ shared_secret: &#39;shared_secret_code&#39;,
190
+ auth_token: &#39;authSecretToken&#39;,
191
+ verify_ssl: true,
192
+ ca_file: &#39;/path/to/cert.pem&#39;
193
+ )</pre>
194
+
195
+ <p>As you see you can turn off ssl verification (<code>verify_ssl:
196
+ false</code>) or provide your own CA file (<code>:ca_file</code> option)
197
+ for SSL verification. By default gem uses the
198
+ <code>OpenSSL::X509::DEFAULT_CERT_FILE</code> definitions.</p>
199
+
200
+ <p>If you want to use this gem/plugin with Rails (for version 3) you can
201
+ create configuration file in /config directory with specified api
202
+ connection settings. For example:</p>
154
203
 
155
204
  <pre>development:
156
205
  api_key: SomeLongApiKey
@@ -162,38 +211,42 @@ beta:
162
211
  shared_secret: secretBeta!
163
212
  auth_token: authSecretTokenBeta</pre>
164
213
 
165
- <h2 id="label-LICENSE%3A">LICENSE:<span><a href="#label-LICENSE%3A">&para;</a> <a href="#documentation">&uarr;</a></span></h2>
166
-
167
- <p>(The MIT License)</p>
214
+ <h2 id="label-CONTRIBUTING">CONTRIBUTING<span><a href="#label-CONTRIBUTING">&para;</a> <a href="#documentation">&uarr;</a></span></h2>
215
+ <ol><li>
216
+ <p>Fork it</p>
217
+ </li><li>
218
+ <p>Create your feature branch (<code>git checkout -b my-new-feature</code>)</p>
219
+ </li><li>
220
+ <p>Commit your changes (<code>git commit -am &#39;Add some
221
+ feature&#39;</code>)</p>
222
+ </li><li>
223
+ <p>Push to the branch (<code>git push origin my-new-feature</code>)</p>
224
+ </li><li>
225
+ <p>Create new Pull Request</p>
226
+ </li></ol>
227
+
228
+ <h2 id="label-THANKS">THANKS<span><a href="#label-THANKS">&para;</a> <a href="#documentation">&uarr;</a></span></h2>
229
+ <ul><li>
230
+ <p>Scott Raymond</p>
231
+ </li><li>
232
+ <p>Patrick Plattes</p>
233
+ </li><li>
234
+ <p>Chris Taggart</p>
235
+ </li></ul>
168
236
 
169
- <p>Copyright © 2005-2010 Scott Raymond, Patrick Plattes, Chris Taggart, Rafal
170
- Piekarski</p>
237
+ <h2 id="label-LICENSE">LICENSE<span><a href="#label-LICENSE">&para;</a> <a href="#documentation">&uarr;</a></span></h2>
171
238
 
172
- <p>Permission is hereby granted, free of charge, to any person obtaining a
173
- copy of this software and associated documentation files (the
174
- &#39;Software&#39;), to deal in the Software without restriction, including
175
- without limitation the rights to use, copy, modify, merge, publish,
176
- distribute, sublicense, and/or sell copies of the Software, and to permit
177
- persons to whom the Software is furnished to do so, subject to the
178
- following conditions:</p>
239
+ <p>MIT License , see <code>LICENSE</code> for more details.</p>
179
240
 
180
- <p>The above copyright notice and this permission notice shall be included in
181
- all copies or substantial portions of the Software.</p>
241
+ <p 2010 - 2014 Rafal “RaVbaker” Piekarski</p>
182
242
 
183
- <p>THE SOFTWARE IS PROVIDED &#39;AS IS&#39;, WITHOUT WARRANTY OF ANY KIND,
184
- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
185
- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
186
- NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
187
- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
188
- OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
189
- USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
190
- </main>
243
+ </div>
191
244
 
192
245
 
193
246
 
194
- <footer id="validator-badges" role="contentinfo">
195
- <p><a href="http://validator.w3.org/check/referer">Validate</a>
196
- <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.1.
197
- <p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
247
+ <footer id="validator-badges">
248
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
249
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.0.
250
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
198
251
  </footer>
199
252
 
@@ -1,3 +1,3 @@
1
- Thu, 17 Apr 2014 10:23:21 +0200
2
- README.txt Thu, 17 Apr 2014 08:35:59 +0200
3
- lib/flickr.rb Thu, 17 Apr 2014 10:19:59 +0200
1
+ Tue, 13 May 2014 12:21:39 +0200
2
+ README.md Tue, 13 May 2014 11:53:03 +0200
3
+ lib/flickr.rb Tue, 13 May 2014 12:12:08 +0200
@@ -2,71 +2,60 @@
2
2
 
3
3
  <html>
4
4
  <head>
5
- <meta charset="UTF-8">
5
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
6
6
 
7
7
  <title>Flickr</title>
8
8
 
9
- <link href="./fonts.css" rel="stylesheet">
10
- <link href="./rdoc.css" rel="stylesheet">
9
+ <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
11
10
 
12
11
  <script type="text/javascript">
13
12
  var rdoc_rel_prefix = "./";
14
13
  </script>
15
14
 
16
- <script src="./js/jquery.js"></script>
17
- <script src="./js/navigation.js"></script>
18
- <script src="./js/search_index.js"></script>
19
- <script src="./js/search.js"></script>
20
- <script src="./js/searcher.js"></script>
21
- <script src="./js/darkfish.js"></script>
15
+ <script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
16
+ <script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
17
+ <script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
18
+ <script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
19
+ <script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
20
+ <script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
22
21
 
23
22
 
24
- <body id="top" role="document" class="file">
25
- <nav role="navigation">
26
- <div id="project-navigation">
27
- <div id="home-section" role="region" title="Quick navigation" class="nav-section">
28
- <h2>
29
- <a href="./index.html" rel="home">Home</a>
30
- </h2>
31
-
32
- <div id="table-of-contents-navigation">
33
- <a href="./table_of_contents.html#pages">Pages</a>
23
+ <body>
24
+ <nav id="metadata">
25
+ <nav id="home-section" class="section">
26
+ <h3 class="section-header">
27
+ <a href="./index.html">Home</a>
34
28
  <a href="./table_of_contents.html#classes">Classes</a>
35
29
  <a href="./table_of_contents.html#methods">Methods</a>
36
- </div>
37
- </div>
30
+ </h3>
31
+ </nav>
38
32
 
39
33
 
40
- <div id="search-section" role="search" class="project-section initially-hidden">
34
+ <nav id="search-section" class="section project-section" class="initially-hidden">
41
35
  <form action="#" method="get" accept-charset="utf-8">
42
- <div id="search-field-wrapper">
43
- <input id="search-field" role="combobox" aria-label="Search"
44
- aria-autocomplete="list" aria-controls="search-results"
45
- type="text" name="search" placeholder="Search" spellcheck="false"
36
+ <h3 class="section-header">
37
+ <input type="text" name="search" placeholder="Search" id="search-field"
46
38
  title="Type to search, Up and Down to navigate, Enter to load">
47
- </div>
48
-
49
- <ul id="search-results" aria-label="Search Results"
50
- aria-busy="false" aria-expanded="false"
51
- aria-atomic="false" class="initially-hidden"></ul>
39
+ </h3>
52
40
  </form>
53
- </div>
54
41
 
55
- </div>
42
+ <ul id="search-results" class="initially-hidden"></ul>
43
+ </nav>
44
+
56
45
 
57
46
  <div id="project-metadata">
58
- <div id="fileindex-section" class="nav-section">
59
- <h3>Pages</h3>
47
+ <nav id="fileindex-section" class="section project-section">
48
+ <h3 class="section-header">Pages</h3>
60
49
 
61
- <ul class="link-list">
50
+ <ul>
62
51
 
63
- <li><a href="./README_txt.html">README</a>
52
+ <li class="file"><a href="./README_md.html">README</a>
64
53
 
65
54
  </ul>
66
- </div>
55
+ </nav>
67
56
 
68
- <div id="classindex-section" class="nav-section">
69
- <h3>Class and Module Index</h3>
57
+ <nav id="classindex-section" class="section project-section">
58
+ <h3 class="section-header">Class and Module Index</h3>
70
59
 
71
60
  <ul class="link-list">
72
61
 
@@ -85,20 +74,19 @@
85
74
  <li><a href="./Flickr/User.html">Flickr::User</a>
86
75
 
87
76
  </ul>
88
- </div>
77
+ </nav>
89
78
 
90
79
  </div>
91
80
  </nav>
92
81
 
93
- <main role="main">
82
+ <div id="documentation" class="description">
94
83
  <p>This is the API documentation for Flickr.
95
- </main>
96
-
84
+ </div>
97
85
 
98
86
 
99
- <footer id="validator-badges" role="contentinfo">
100
- <p><a href="http://validator.w3.org/check/referer">Validate</a>
101
- <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.1.
102
- <p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
87
+ <footer id="validator-badges">
88
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
89
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.0.
90
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
103
91
  </footer>
104
92
 
@@ -52,6 +52,20 @@ function hookDebuggingToggle() {
52
52
  $('#debugging-toggle img').click( toggleDebuggingSection );
53
53
  };
54
54
 
55
+ function hookTableOfContentsToggle() {
56
+ $('.indexpage li .toc-toggle').each( function() {
57
+ $(this).click( function() {
58
+ $(this).toggleClass('open');
59
+ });
60
+
61
+ var section = $(this).next();
62
+
63
+ $(this).click( function() {
64
+ section.slideToggle();
65
+ });
66
+ });
67
+ }
68
+
55
69
  function hookSearch() {
56
70
  var input = $('#search-field').eq(0);
57
71
  var result = $('#search-results').eq(0);
@@ -135,6 +149,7 @@ $(document).ready( function() {
135
149
  hookDebuggingToggle();
136
150
  hookSearch();
137
151
  highlightLocationTarget();
152
+ hookTableOfContentsToggle();
138
153
 
139
154
  $('ul.link-list a').bind( "click", highlightClickTarget );
140
155
  });