Module: FlickRaw

Defined in:
lib/flickraw.rb,
lib/flickraw/api.rb,
lib/flickraw/error.rb,
lib/flickraw/oauth.rb,
lib/flickraw/request.rb,
lib/flickraw/response.rb

Defined Under Namespace

Classes: Error, FailedResponse, Flickr, FlickrAppNotConfigured, OAuthClient, Request, Response, ResponseList

Constant Summary collapse

VERSION = 
'0.9.7'
USER_AGENT = 
"FlickRaw/#{VERSION}"
END_POINT = 
'http://api.flickr.com/services'.freeze
END_POINT2 = 
'http://www.flickr.com/services'.freeze
END_POINT_SECURE = 
'https://secure.flickr.com/services'.freeze
FLICKR_OAUTH_REQUEST_TOKEN = 
(END_POINT2 + '/oauth/request_token').freeze
FLICKR_OAUTH_AUTHORIZE = 
(END_POINT2 + '/oauth/authorize').freeze
FLICKR_OAUTH_ACCESS_TOKEN = 
(END_POINT2 + '/oauth/access_token').freeze
FLICKR_OAUTH_REQUEST_TOKEN_SECURE = 
(END_POINT_SECURE + '/oauth/request_token').freeze
FLICKR_OAUTH_AUTHORIZE_SECURE = 
(END_POINT_SECURE + '/oauth/authorize').freeze
FLICKR_OAUTH_ACCESS_TOKEN_SECURE = 
(END_POINT_SECURE + '/oauth/access_token').freeze
REST_PATH = 
(END_POINT + '/rest/').freeze
UPLOAD_PATH = 
(END_POINT + '/upload/').freeze
REPLACE_PATH = 
(END_POINT + '/replace/').freeze
REST_PATH_SECURE = 
(END_POINT_SECURE + '/rest/').freeze
UPLOAD_PATH_SECURE = 
(END_POINT_SECURE + '/upload/').freeze
REPLACE_PATH_SECURE = 
(END_POINT_SECURE + '/replace/').freeze
PHOTO_SOURCE_URL = 
'http://farm%s.staticflickr.com/%s/%s_%s%s.%s'.freeze
URL_PROFILE = 
'http://www.flickr.com/people/'.freeze
URL_PHOTOSTREAM = 
'http://www.flickr.com/photos/'.freeze
URL_SHORT = 
'http://flic.kr/p/'.freeze
BASE58_ALPHABET = 
"123456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ".freeze

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.api_key ⇒ Object

Your flickr API key, see www.flickr.com/services/api/keys for more information



157
158
159
 
# File 'lib/flickraw/api.rb', line 157

def api_key
  @api_key
end

.proxy ⇒ Object

Use a proxy



163
164
165
 
# File 'lib/flickraw/api.rb', line 163

def proxy
  @proxy
end

.secure ⇒ Object

Use ssl connection



166
167
168
 
# File 'lib/flickraw/api.rb', line 166

def secure
  @secure
end

.shared_secret ⇒ Object

The shared secret of api_key, see www.flickr.com/services/api/keys for more information



160
161
162
 
# File 'lib/flickraw/api.rb', line 160

def shared_secret
  @shared_secret
end

Class Method Details

.base58(id) ⇒ Object 



169
170
171
172
173
174
175
176
177
178
 
# File 'lib/flickraw/api.rb', line 169

def base58(id)
  id = id.to_i
  alphabet = BASE58_ALPHABET.split(//)
  base = alphabet.length
  begin
    id, m = id.divmod(base)
    r = alphabet[m] + (r || '')
  end while id > 0
  r
end

.url(r) ⇒ Object 



180
 
# File 'lib/flickraw/api.rb', line 180

def url(r);   PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret, "",   "jpg"]   end

.url_b(r) ⇒ Object 



184
 
# File 'lib/flickraw/api.rb', line 184

def url_b(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret, "_b", "jpg"] end

.url_c(r) ⇒ Object 



188
 
# File 'lib/flickraw/api.rb', line 188

def url_c(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret, "_c", "jpg"] end

.url_m(r) ⇒ Object 



181
 
# File 'lib/flickraw/api.rb', line 181

def url_m(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret, "_m", "jpg"] end

.url_n(r) ⇒ Object 



187
 
# File 'lib/flickraw/api.rb', line 187

def url_n(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret, "_n", "jpg"] end

.url_o(r) ⇒ Object 



189
 
# File 'lib/flickraw/api.rb', line 189

def url_o(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.originalsecret, "_o", r.originalformat] end

.url_photopage(r) ⇒ Object 



191
 
# File 'lib/flickraw/api.rb', line 191

def url_photopage(r); url_photostream(r) + r.id end

.url_photoset(r) ⇒ Object 



193
 
# File 'lib/flickraw/api.rb', line 193

def url_photoset(r); url_photosets(r) + r.id end

.url_photosets(r) ⇒ Object 



192
 
# File 'lib/flickraw/api.rb', line 192

def url_photosets(r); url_photostream(r) + "sets/" end

.url_photostream(r) ⇒ Object 



200
201
202
203
204
205
206
207
208
209
 
# File 'lib/flickraw/api.rb', line 200

def url_photostream(r)
  URL_PHOTOSTREAM +
    if r.respond_to?(:pathalias) and r.pathalias
      r.pathalias
    elsif r.owner.respond_to?(:nsid)
      r.owner.nsid
    else
      r.owner
    end + "/"
end

.url_profile(r) ⇒ Object 



190
 
# File 'lib/flickraw/api.rb', line 190

def url_profile(r); URL_PROFILE + (r.owner.respond_to?(:nsid) ? r.owner.nsid : r.owner) + "/" end

.url_q(r) ⇒ Object 



186
 
# File 'lib/flickraw/api.rb', line 186

def url_q(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret, "_q", "jpg"] end

.url_s(r) ⇒ Object 



182
 
# File 'lib/flickraw/api.rb', line 182

def url_s(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret, "_s", "jpg"] end

.url_short(r) ⇒ Object 



194
 
# File 'lib/flickraw/api.rb', line 194

def url_short(r); URL_SHORT + base58(r.id) end

.url_short_m(r) ⇒ Object 



195
 
# File 'lib/flickraw/api.rb', line 195

def url_short_m(r); URL_SHORT + "img/" + base58(r.id) + "_m.jpg" end

.url_short_n(r) ⇒ Object 



199
 
# File 'lib/flickraw/api.rb', line 199

def url_short_n(r); URL_SHORT + "img/" + base58(r.id) + "_n.jpg" end

.url_short_q(r) ⇒ Object 



198
 
# File 'lib/flickraw/api.rb', line 198

def url_short_q(r); URL_SHORT + "img/" + base58(r.id) + "_q.jpg" end

.url_short_s(r) ⇒ Object 



196
 
# File 'lib/flickraw/api.rb', line 196

def url_short_s(r); URL_SHORT + "img/" + base58(r.id) + ".jpg" end

.url_short_t(r) ⇒ Object 



197
 
# File 'lib/flickraw/api.rb', line 197

def url_short_t(r); URL_SHORT + "img/" + base58(r.id) + "_t.jpg" end

.url_t(r) ⇒ Object 



183
 
# File 'lib/flickraw/api.rb', line 183

def url_t(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret, "_t", "jpg"] end

.url_z(r) ⇒ Object 



185
 
# File 'lib/flickraw/api.rb', line 185

def url_z(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret, "_z", "jpg"] end