Module: Flickrie::Media

Extended by:
ClassMethods
Includes:
Base58
Included in:
Photo, Video
Defined in:
lib/flickrie/objects/media.rb,
lib/flickrie/objects/media/tag.rb,
lib/flickrie/objects/media/exif.rb,
lib/flickrie/objects/media/note.rb,
lib/flickrie/objects/media/visibility.rb

Defined Under Namespace

Modules: ClassMethods Classes: Exif, Note, Tag, Visibility

Constant Summary

Constants included from Base58

Base58::ALPHABET

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ClassMethods

new_collection

Methods included from Base58

#to_base58

Instance Attribute Details

#camera ⇒ String (readonly)

Returns:

  • (String) 


40
41
42
 
# File 'lib/flickrie/objects/media.rb', line 40

def camera
  @camera
end

#can_add_meta? ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


119
120
121
 
# File 'lib/flickrie/objects/media.rb', line 119

def can_add_meta?
  @can_add_meta?
end

#can_blog? ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


129
130
131
 
# File 'lib/flickrie/objects/media.rb', line 129

def can_blog?
  @can_blog?
end

#can_comment? ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


117
118
119
 
# File 'lib/flickrie/objects/media.rb', line 117

def can_comment?
  @can_comment?
end

#can_download? ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


127
128
129
 
# File 'lib/flickrie/objects/media.rb', line 127

def can_download?
  @can_download?
end

#can_everyone_add_meta? ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


124
125
126
 
# File 'lib/flickrie/objects/media.rb', line 124

def can_everyone_add_meta?
  @can_everyone_add_meta?
end

#can_everyone_comment? ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


122
123
124
 
# File 'lib/flickrie/objects/media.rb', line 122

def can_everyone_comment?
  @can_everyone_comment?
end

#can_print? ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


131
132
133
 
# File 'lib/flickrie/objects/media.rb', line 131

def can_print?
  @can_print?
end

#can_share? ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


133
134
135
 
# File 'lib/flickrie/objects/media.rb', line 133

def can_share?
  @can_share?
end

#comments_count ⇒ Fixnum (readonly)

Returns:

  • (Fixnum) 


55
56
57
 
# File 'lib/flickrie/objects/media.rb', line 55

def comments_count
  @comments_count
end

#description ⇒ String (readonly)

Returns:

  • (String) 


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

def description
  @description
end

#exif ⇒ Flickrie::Media::Exif (readonly)

Returns exif of the photo/video. Example:

photo.exif.get('Model') # => 'Canon PowerShot G12'

photo.exif.get('X-Resolution', data: 'raw')   # => '180'
photo.exif.get('X-Resolution', data: 'clean') # => '180 dpi'
photo.exif.get('X-Resolution')                   # => '180 dpi'

Returns:



50
51
52
 
# File 'lib/flickrie/objects/media.rb', line 50

def exif
  @exif
end

#farm ⇒ Fixnum (readonly)

Returns:

  • (Fixnum) 


29
30
31
 
# File 'lib/flickrie/objects/media.rb', line 29

def farm
  @farm
end

#faved? ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


144
145
146
 
# File 'lib/flickrie/objects/media.rb', line 144

def faved?
  @faved?
end

#favorite? ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


114
115
116
 
# File 'lib/flickrie/objects/media.rb', line 114

def favorite?
  @favorite?
end

#favorites ⇒ Flickrie::Collection<Flickrie::User> (readonly)

Returns:



153
154
155
 
# File 'lib/flickrie/objects/media.rb', line 153

def favorites
  @favorites
end

#geo_permissions ⇒ Flickrie::Media::Visibility (readonly)

Returns:



60
61
62
 
# File 'lib/flickrie/objects/media.rb', line 60

def geo_permissions
  @geo_permissions
end

#has_people? ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


141
142
143
 
# File 'lib/flickrie/objects/media.rb', line 141

def has_people?
  @has_people?
end

#hash ⇒ Hash (readonly)

Returns the raw hash from the response. Useful if something isn't available by methods.

Returns:



164
165
166
 
# File 'lib/flickrie/objects/media.rb', line 164

def hash
  @hash
end

#id ⇒ String (readonly)

Returns:

  • (String) 


23
24
25
 
# File 'lib/flickrie/objects/media.rb', line 23

def id
  @id
end

#license ⇒ Flickrie::License (readonly)

Returns:



68
69
70
 
# File 'lib/flickrie/objects/media.rb', line 68

def license
  @license
end

#location ⇒ Flickrie::Location (readonly)

Returns:



58
59
60
 
# File 'lib/flickrie/objects/media.rb', line 58

def location
  @location
end

#machine_tags ⇒ Array<Flickrie::Media::Tag> (readonly)

Returns:



65
66
67
 
# File 'lib/flickrie/objects/media.rb', line 65

def machine_tags
  @machine_tags
end

#media_status ⇒ String (readonly)

Returns:

  • (String) 


35
36
37
 
# File 'lib/flickrie/objects/media.rb', line 35

def media_status
  @media_status
end

#moderate? ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/flickrie/objects/media.rb', line 90

def moderate?
  @moderate?
end

#notes ⇒ Array<Flickrie::Media::Note> (readonly)

Returns:



147
148
149
 
# File 'lib/flickrie/objects/media.rb', line 147

def notes
  @notes
end

#owner ⇒ Flickrie::User (readonly)

Returns:



82
83
84
 
# File 'lib/flickrie/objects/media.rb', line 82

def owner
  @owner
end

#path_alias ⇒ String (readonly)

Returns:

  • (String) 


37
38
39
 
# File 'lib/flickrie/objects/media.rb', line 37

def path_alias
  @path_alias
end

#posted_at ⇒ Time (readonly)

Returns:

  • (Time) 


71
72
73
 
# File 'lib/flickrie/objects/media.rb', line 71

def posted_at
  @posted_at
end

#primary? ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


111
112
113
 
# File 'lib/flickrie/objects/media.rb', line 111

def primary?
  @primary?
end

#restricted? ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


92
93
94
 
# File 'lib/flickrie/objects/media.rb', line 92

def restricted?
  @restricted?
end

#safe? ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


88
89
90
 
# File 'lib/flickrie/objects/media.rb', line 88

def safe?
  @safe?
end

#safety_level ⇒ Fixnum (readonly)

Returns:

  • (Fixnum) 


85
86
87
 
# File 'lib/flickrie/objects/media.rb', line 85

def safety_level
  @safety_level
end

#secret ⇒ String (readonly)

Returns:

  • (String) 


25
26
27
 
# File 'lib/flickrie/objects/media.rb', line 25

def secret
  @secret
end

#server ⇒ String (readonly)

Returns:

  • (String) 


27
28
29
 
# File 'lib/flickrie/objects/media.rb', line 27

def server
  @server
end

#short_url ⇒ String (readonly)

Returns:

  • (String) 


103
104
105
 
# File 'lib/flickrie/objects/media.rb', line 103

def short_url
  @short_url
end

#tags ⇒ Array<Flickrie::Media::Tag> (readonly)

Returns:



63
64
65
 
# File 'lib/flickrie/objects/media.rb', line 63

def tags
  @tags
end

#taken_at ⇒ Time (readonly)

Returns:

  • (Time) 


77
78
79
 
# File 'lib/flickrie/objects/media.rb', line 77

def taken_at
  @taken_at
end

#taken_at_granularity ⇒ Fixnum (readonly)

Returns:

  • (Fixnum) 


79
80
81
 
# File 'lib/flickrie/objects/media.rb', line 79

def taken_at_granularity
  @taken_at_granularity
end

#title ⇒ String (readonly)

Returns:

  • (String) 


31
32
33
 
# File 'lib/flickrie/objects/media.rb', line 31

def title
  @title
end

#updated_at ⇒ Time (readonly)

Returns:

  • (Time) 


75
76
77
 
# File 'lib/flickrie/objects/media.rb', line 75

def updated_at
  @updated_at
end

#uploaded_at ⇒ Time (readonly)

Returns:

  • (Time) 


73
74
75
 
# File 'lib/flickrie/objects/media.rb', line 73

def uploaded_at
  @uploaded_at
end

#url ⇒ String (readonly)

Returns:

  • (String) 


95
96
97
 
# File 'lib/flickrie/objects/media.rb', line 95

def url
  @url
end

#views_count ⇒ Fixnum (readonly)

Returns:

  • (Fixnum) 


53
54
55
 
# File 'lib/flickrie/objects/media.rb', line 53

def views_count
  @views_count
end

#visibility ⇒ Flickrie::Media::Visibility (readonly)

Returns:



108
109
110
 
# File 'lib/flickrie/objects/media.rb', line 108

def visibility
  @visibility
end

Instance Method Details

#[](key) ⇒ Object 



160
 
# File 'lib/flickrie/objects/media.rb', line 160

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

#adding_meta_permissions ⇒ Boolean

Returns:

  • (Boolean) 


138
 
# File 'lib/flickrie/objects/media.rb', line 138

def adding_meta_permissions() Integer(@hash['permissions']['permaddmeta']) rescue nil end

#commenting_permissions ⇒ Boolean

Returns:

  • (Boolean) 


136
 
# File 'lib/flickrie/objects/media.rb', line 136

def commenting_permissions()  Integer(@hash['permissions']['permcomment']) rescue nil end

#content_type ⇒ Integer

Returns:

  • (Integer) 


150
 
# File 'lib/flickrie/objects/media.rb', line 150

def content_type() Integer(@hash['content_type']) rescue nil end

#get_exif(params = {}) ⇒ self

Same as calling Flickrie.get_(photo|video)_exif(id).

Returns:

  • (self) 


177
178
179
180
 
# File 'lib/flickrie/objects/media.rb', line 177

def get_exif(params = {})
  @hash.deep_merge!(@api_caller.send("get_#{media_type}_exif", id, params).hash)
  self
end

#get_favorites(params = {}) ⇒ self

Same as calling Flickrie.get_(photo|video)_favorites(id).

Returns:

  • (self) 


185
186
187
188
 
# File 'lib/flickrie/objects/media.rb', line 185

def get_favorites(params = {})
  @hash.deep_merge!(@api_caller.send("get_#{media_type}_favorites", id, params).hash)
  self
end

#get_info(params = {}) ⇒ self

Same as calling Flickrie.get_(photo|video)_info(id).

Returns:

  • (self) 


169
170
171
172
 
# File 'lib/flickrie/objects/media.rb', line 169

def get_info(params = {})
  @hash.deep_merge!(@api_caller.send("get_#{media_type}_info", id, params).hash)
  self
end

#initialize(hash, api_caller) ⇒ Object 



190
191
192
193
 
# File 'lib/flickrie/objects/media.rb', line 190

def initialize(hash, api_caller)
  @hash = hash
  @api_caller = api_caller
end