Class: SBF::Client::Photo

Inherits:
TopLevelEntity show all
Defined in:
lib/stbaldricks/entities/photo.rb

Defined Under Namespace

Modules: Category, ModelType Classes: FullCampaign, FullEvent, FullEventSupporter, FullFund, FullFundraiser, FullKid, FullMemorial, FullParticipant, FullTeam, PartialCampaign, PartialEvent, PartialEventSupporter, PartialFund, PartialFundraiser, PartialKid, PartialMemorial, PartialParticipant, PartialTeam

Constant Summary

Constants inherited from TopLevelEntity

TopLevelEntity::DEFAULT_CLASS_ACTIONS, TopLevelEntity::DEFAULT_CRUD_ACTIONS, TopLevelEntity::DEFAULT_ENDPOINT, TopLevelEntity::DEFAULT_INSTANCE_ACTIONS

Constants inherited from BaseEntity

BaseEntity::ELSE

Instance Attribute Summary collapse

Attributes inherited from BaseEntity

#errors

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from TopLevelEntity

_endpoint, action, actions, blacklist_action, class_action, define_endpoint, endpoint, #endpoint, instance_action

Methods included from Entities::Cacheable

#cache_id, included

Methods inherited from BaseEntity

allow_instantiation?, attr_accessor, attr_reader, attr_writer, collection_attributes, defined_attributes, #destroyed?, #dirty_data, entity_attr_accessor, entity_attr_reader, entity_attr_writer, entity_attributes, entity_collection_attr_accessor, entity_collection_attr_reader, entity_collection_attr_writer, #error, inherited, #initialize, #keys_hash, #model_name, multitype_attr_accessor, multitype_attr_reader, multitype_attr_writer, multitype_collection_attr_accessor, multitype_collection_attr_reader, multitype_collection_attr_writer, #not_provided_attributes, optional_attributes, #persisted?, #reload!, #reload_recursive, #rollback!, #to_hash, #to_partial

Methods included from EntityResponseConcern

#add_errors, #data, #error?, #errors?, #errors_http_code=, #http_code, #success?

Constructor Details

This class inherits a constructor from SBF::Client::BaseEntity

Instance Attribute Details

#base_photo_url ⇒ Object

Returns the value of attribute base_photo_url.



87
88
89
 
# File 'lib/stbaldricks/entities/photo.rb', line 87

def base_photo_url
  @base_photo_url
end

#caption ⇒ Object

Returns the value of attribute caption.



30
31
32
 
# File 'lib/stbaldricks/entities/photo.rb', line 30

def caption
  @caption
end

#category ⇒ Object

Returns the value of attribute category.



33
34
35
 
# File 'lib/stbaldricks/entities/photo.rb', line 33

def category
  @category
end

#file ⇒ Object

Returns the value of attribute file.



34
35
36
 
# File 'lib/stbaldricks/entities/photo.rb', line 34

def file
  @file
end

#filename ⇒ Object

Returns the value of attribute filename.



35
36
37
 
# File 'lib/stbaldricks/entities/photo.rb', line 35

def filename
  @filename
end

#id ⇒ Object

Returns the value of attribute id.



29
30
31
 
# File 'lib/stbaldricks/entities/photo.rb', line 29

def id
  @id
end

#original_file_id ⇒ Object (readonly)

Returns the value of attribute original_file_id.



88
89
90
 
# File 'lib/stbaldricks/entities/photo.rb', line 88

def original_file_id
  @original_file_id
end

#original_filename ⇒ Object (readonly)

Returns the value of attribute original_filename.



89
90
91
 
# File 'lib/stbaldricks/entities/photo.rb', line 89

def original_filename
  @original_filename
end

#sort_order ⇒ Object

Returns the value of attribute sort_order.



31
32
33
 
# File 'lib/stbaldricks/entities/photo.rb', line 31

def sort_order
  @sort_order
end

#year ⇒ Object

Returns the value of attribute year.



32
33
34
 
# File 'lib/stbaldricks/entities/photo.rb', line 32

def year
  @year
end

Class Method Details

.upload(*args) ⇒ Object 



25
26
27
 
# File 'lib/stbaldricks/entities/photo.rb', line 25

def self.upload(*args)
  endpoint.send(:upload, *args)
end

Instance Method Details

#to_json(*a) ⇒ Object 



91
92
93
 
# File 'lib/stbaldricks/entities/photo.rb', line 91

def to_json(*a)
  to_hash.reject { |k, _v| %i(file filename).include? k }.to_json(*a)
end

#upload(image_data_url, with = {}) ⇒ Object 



20
21
22
23
 
# File 'lib/stbaldricks/entities/photo.rb', line 20

def upload(image_data_url, with = {})
  photo = endpoint.upload(image_data_url, self, with)
  photo.errors? ? false : photo
end