Class: Flickrie::User

Inherits:
Object
  • Object
show all
Defined in:
lib/flickrie/objects/user.rb,
lib/flickrie/objects/user/upload_status.rb

Defined Under Namespace

Classes: UploadStatus

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#buddy_icon_url ⇒ String (readonly)

Returns:

  • (String) 


33
34
35
 
# File 'lib/flickrie/objects/user.rb', line 33

def buddy_icon_url
  @buddy_icon_url
end

#description ⇒ String (readonly)

Returns:

  • (String) 


24
25
26
 
# File 'lib/flickrie/objects/user.rb', line 24

def description
  @description
end

#favorited_at ⇒ Time (readonly)

Returns:

  • (Time) 


64
65
66
 
# File 'lib/flickrie/objects/user.rb', line 64

def favorited_at
  @favorited_at
end

#first_taken ⇒ Time (readonly)

Returns:

  • (Time) 


59
60
61
 
# File 'lib/flickrie/objects/user.rb', line 59

def first_taken
  @first_taken
end

#hash ⇒ Hash (readonly)

Returns:



120
121
122
 
# File 'lib/flickrie/objects/user.rb', line 120

def hash
  @hash
end

#icon_farm ⇒ Fixnum (readonly)

Returns:

  • (Fixnum) 


30
31
32
 
# File 'lib/flickrie/objects/user.rb', line 30

def icon_farm
  @icon_farm
end

#icon_server ⇒ String (readonly)

Returns:

  • (String) 


28
29
30
 
# File 'lib/flickrie/objects/user.rb', line 28

def icon_server
  @icon_server
end

#id ⇒ String (readonly)

Returns:

  • (String) 


14
15
16
 
# File 'lib/flickrie/objects/user.rb', line 14

def id
  @id
end

#location ⇒ String (readonly)

Returns:

  • (String) 


22
23
24
 
# File 'lib/flickrie/objects/user.rb', line 22

def location
  @location
end

#media_count ⇒ Fixnum (readonly) Also known as: photos_count, videos_count

Returns:

  • (Fixnum) 


67
68
69
 
# File 'lib/flickrie/objects/user.rb', line 67

def media_count
  @media_count
end

#mobile_url ⇒ String (readonly)

Returns:

  • (String) 


56
57
58
 
# File 'lib/flickrie/objects/user.rb', line 56

def mobile_url
  @mobile_url
end

#nsid ⇒ String (readonly)

Returns:

  • (String) 


16
17
18
 
# File 'lib/flickrie/objects/user.rb', line 16

def nsid
  @nsid
end

#path_alias ⇒ String (readonly)

Returns:

  • (String) 


26
27
28
 
# File 'lib/flickrie/objects/user.rb', line 26

def path_alias
  @path_alias
end

#photos_url ⇒ String (readonly)

Returns:

  • (String) 


52
53
54
 
# File 'lib/flickrie/objects/user.rb', line 52

def photos_url
  @photos_url
end

#pro? ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


110
111
112
 
# File 'lib/flickrie/objects/user.rb', line 110

def pro?
  @pro?
end

#profile_url ⇒ String (readonly)

Returns:

  • (String) 


54
55
56
 
# File 'lib/flickrie/objects/user.rb', line 54

def profile_url
  @profile_url
end

#real_name ⇒ String (readonly)

Returns:

  • (String) 


20
21
22
 
# File 'lib/flickrie/objects/user.rb', line 20

def real_name
  @real_name
end

#time_zone ⇒ Struct (readonly)

Returns the time zone of the user. Example:

user.time_zone.offset # => "+01:00"
user.time_zone.label  # => "Sarajevo, Skopje, Warsaw, Zagreb"

Returns:

  • (Struct) 


49
50
51
 
# File 'lib/flickrie/objects/user.rb', line 49

def time_zone
  @time_zone
end

#upload_status ⇒ Flickrie::User::UploadStatus (readonly)

Returns the upload status of the user (obtained by calling Flickrie.get_upload_status).

Returns:



116
117
118
 
# File 'lib/flickrie/objects/user.rb', line 116

def upload_status
  @upload_status
end

#username ⇒ String (readonly)

Returns:

  • (String) 


18
19
20
 
# File 'lib/flickrie/objects/user.rb', line 18

def username
  @username
end

Instance Method Details

#[](key) ⇒ Object 



118
 
# File 'lib/flickrie/objects/user.rb', line 118

def [](key) @hash[key] end

#first_uploaded ⇒ Time

Returns:

  • (Time) 


61
 
# File 'lib/flickrie/objects/user.rb', line 61

def first_uploaded() Time.at(Integer(@hash['photos']['firstdate'])) rescue nil end

#get_info(params = {}) ⇒ self

The same as calling Flickrie.get_user_info(user.nsid)

Returns:

  • (self) 


125
126
127
128
 
# File 'lib/flickrie/objects/user.rb', line 125

def get_info(params = {})
  @hash.deep_merge!(@api_caller.(nsid || id, params).hash)
  self
end

#media(params = {}) ⇒ Flickrie::Collection<Flickrie::Photo, Flickrie::Video>

Same as calling Flickrie.media_from_user(user.nsid).

Returns:



105
106
107
 
# File 'lib/flickrie/objects/user.rb', line 105

def media(params = {})
  @api_caller.media_from_user(nsid || id, params)
end

#photos(params = {}) ⇒ Flickrie::Collection<Flickrie::Photo>

Same as calling Flickrie.photos_from_user(user.nsid).

Returns:



93
94
95
 
# File 'lib/flickrie/objects/user.rb', line 93

def photos(params = {})
  @api_caller.photos_from_user(nsid || id, params)
end

#public_media(params = {}) ⇒ Flickrie::Collection<Flickrie::Photo, Flickrie::Video>

Same as calling Flickrie.public_media_from_user(user.nsid).

Returns:



86
87
88
 
# File 'lib/flickrie/objects/user.rb', line 86

def public_media(params = {})
  @api_caller.public_media_from_user(nsid || id, params)
end

#public_photos(params = {}) ⇒ Flickrie::Collection<Flickrie::Photo>

Same as calling Flickrie.public_photos_from_user(user.nsid).

Returns:



74
75
76
 
# File 'lib/flickrie/objects/user.rb', line 74

def public_photos(params = {})
  @api_caller.public_photos_from_user(nsid || id, params)
end

#public_videos(params = {}) ⇒ Flickrie::Collection<Flickrie::Video>

Same as calling Flickrie.public_videos_from_user(user.nsid).

Returns:



80
81
82
 
# File 'lib/flickrie/objects/user.rb', line 80

def public_videos(params = {})
  @api_caller.public_videos_from_user(nsid || id, params)
end

#videos(params = {}) ⇒ Flickrie::Collection<Flickrie::Video>

Same as calling Flickrie.videos_from_user(user.nsid).

Returns:



99
100
101
 
# File 'lib/flickrie/objects/user.rb', line 99

def videos(params = {})
  @api_caller.videos_from_user(nsid || id, params)
end