Class: Parse::Object

Inherits:
Object
  • Object
show all
Includes:
Util
Defined in:
lib/parse/object.rb

Direct Known Subclasses

Installation, Role, User

Constant Summary collapse

@@parse_class_vs_class_table = 
{}

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Util

#string_keyed_hash

Constructor Details

#initialize(hash = {}) ⇒ Object

Returns a new instance of Object.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/parse/object.rb', line 73

def initialize hash={}
  body_hash = nil
  hash = string_keyed_hash hash
  if hash.has_key? 'objectId'
    @parse_object_id = hash['objectId']
    @raw_hash = hash
    @updated_hash = {}
    body_hash = @raw_hash
  else
    @raw_hash = {}
    @updated_hash = hash
    body_hash = @updated_hash
  end
  @deleted = false

  hash.each do |k, v|
    if v.is_a? Hash
      body_hash[k] = 
        case v['__type']
        when nil
          Parse::ACL.new v
        when 'Date'
          Parse::Date.parse v['iso']
        when 'File'
          Parse::File.new v
        when 'Pointer'
          Parse::Pointer.new v, self
        when 'Relation'
          Parse::Relation.new self, k, v
        when 'GeoPoint'
          Parse::GeoPoint.new v
        else
          v
        end
    end
  end
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args, &block) ⇒ Object 



236
237
238
239
240
241
242
243
244
 
# File 'lib/parse/object.rb', line 236

def method_missing name, *args, &block
  if name =~ /^\w+$/ && args.empty? && block.nil?
    get_column name
  elsif name[-1] == '=' && args.size == 1 && block.nil?
    set_column name[0..-2], args.first
  else
    super
  end
end

Class Attribute Details

.auto_camel_case ⇒ Object

Returns the value of attribute auto_camel_case.



15
16
17
 
# File 'lib/parse/object.rb', line 15

def auto_camel_case
  @auto_camel_case
end

.parse_class_name ⇒ Object

Returns the value of attribute parse_class_name.



15
16
17
 
# File 'lib/parse/object.rb', line 15

def parse_class_name
  @parse_class_name
end

.parse_client ⇒ Object

Returns the value of attribute parse_client.



15
16
17
 
# File 'lib/parse/object.rb', line 15

def parse_client
  @parse_client
end

Instance Attribute Details

#acl ⇒ Object

Returns the value of attribute acl.



71
72
73
 
# File 'lib/parse/object.rb', line 71

def acl
  @acl
end

#created_at ⇒ Object

Returns the value of attribute created_at.



71
72
73
 
# File 'lib/parse/object.rb', line 71

def created_at
  @created_at
end

#parse_object_id ⇒ Object Also known as: obj_id

Returns the value of attribute parse_object_id.



71
72
73
 
# File 'lib/parse/object.rb', line 71

def parse_object_id
  @parse_object_id
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



71
72
73
 
# File 'lib/parse/object.rb', line 71

def updated_at
  @updated_at
end

Class Method Details

.create(parse_class_name, mod = ::Object) ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/parse/object.rb', line 21

def create parse_class_name, mod=::Object
  raise 'already defined' if mod.const_defined? parse_class_name

  if RESERVED_PARSE_CLASS.has_key? parse_class_name.to_s
    eval RESERVED_PARSE_CLASS[parse_class_name.to_s]
  else
    klass = Class.new(Parse::Object)
    klass.parse_class_name = parse_class_name.to_sym
    klass.auto_camel_case = true
    mod.const_set parse_class_name, klass
    register_parse_class klass
  end
end

.find(object_id_or_conditions, opts = {}) ⇒ Object 



43
44
45
46
 
# File 'lib/parse/object.rb', line 43

def find object_id_or_conditions, opts={}
  results = [parse_client.find(self.parse_class_name, object_id_or_conditions, opts)].flatten
  results.map! {|hash| self.new hash}
end

.find!(object_id_or_conditions, opts = {}) ⇒ Object

TODO: need refactoring



53
54
55
56
 
# File 'lib/parse/object.rb', line 53

def find! object_id_or_conditions, opts={}
  results = [parse_client.find!(self.parse_class_name, object_id_or_conditions, opts)].flatten
  results.map! {|hash| self.new hash}
end

.find_all(opts = {}) ⇒ Object 



62
63
64
 
# File 'lib/parse/object.rb', line 62

def find_all opts={}
  find :all, opts
end

.find_all!(opts = {}) ⇒ Object 



66
67
68
 
# File 'lib/parse/object.rb', line 66

def find_all! opts={}
  find! :all, opts
end

.find_by_id(object_id, opts = {}) ⇒ Object 



48
49
50
 
# File 'lib/parse/object.rb', line 48

def find_by_id object_id, opts={}
  find(object_id, opts).first
end

.find_by_id!(object_id, opts = {}) ⇒ Object 



58
59
60
 
# File 'lib/parse/object.rb', line 58

def find_by_id! object_id, opts={}
  find!(object_id, opts).first
end

.register_parse_class(parse_class) ⇒ Object 



17
18
19
 
# File 'lib/parse/object.rb', line 17

def register_parse_class parse_class
  @@parse_class_vs_class_table[parse_class.parse_class_name] = parse_class
end

Instance Method Details

#create(hash, use_master_key = false) ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/parse/object.rb', line 150

def create hash, use_master_key=false
  check_deleted!
  hash = string_keyed_hash hash
  @updated_hash.update hash
  @updated_hash.reject! do |k, v|
    v.is_a?(Parse::Relation) && !v.changed?
  end
  method = use_master_key ? :create! : :create
  parse_client.send(method, self.parse_class_name, @updated_hash) do |response|
    @parse_object_id = response['objectId']
    @created_at = Parse::Date.parse response['createdAt']
    @updated_at = @created_at
    @raw_hash.update @updated_hash
    @raw_hash.update response
    @updated_hash.clear
  end
end

#create!(hash) ⇒ Object 



168
169
170
 
# File 'lib/parse/object.rb', line 168

def create! hash
  create hash, true
end

#delete(use_master_key = false) ⇒ Object 



188
189
190
191
192
193
194
195
 
# File 'lib/parse/object.rb', line 188

def delete use_master_key=false
  raise 'You cannot delete new object' if new?
  check_deleted!
  method = use_master_key ? :delete! : :delete
  parse_client.send(method, parse_class_name, parse_object_id) do |response|
    @deleted = true
  end
end

#delete! ⇒ Object 



197
198
199
 
# File 'lib/parse/object.rb', line 197

def delete!
  delete true
end

#deleted? ⇒ Boolean

Returns:

  • (Boolean) 


119
120
121
 
# File 'lib/parse/object.rb', line 119

def deleted?
  @deleted
end

#get_column(name) ⇒ Object 



208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/parse/object.rb', line 208

def get_column name
  name = name.to_s
  ret = @updated_hash[name]
  if ret.nil? && self.class.auto_camel_case
    ret = @updated_hash[name.camelize :lower]
  end
  if ret.nil?
    ret = @raw_hash[name]
    if ret.nil? && self.class.auto_camel_case
      ret = @raw_hash[name.camelize :lower]
    end
  end
  ret
end

#new? ⇒ Boolean

Returns:

  • (Boolean) 


111
112
113
 
# File 'lib/parse/object.rb', line 111

def new?
  !@deleted && @raw_hash.empty?
end

#parse_class_name ⇒ Object 



127
128
129
 
# File 'lib/parse/object.rb', line 127

def parse_class_name
  self.class.parse_class_name
end

#parse_client ⇒ Object 



123
124
125
 
# File 'lib/parse/object.rb', line 123

def parse_client
  self.class.parse_client
end

#pointer ⇒ Object 



228
229
230
 
# File 'lib/parse/object.rb', line 228

def pointer
  Pointer.new 'className' => parse_class_name, 'objectId' => parse_object_id
end

#save(hash = @updated_hash, use_master_key = false) ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/parse/object.rb', line 131

def save hash=@updated_hash, use_master_key=false
  check_deleted!

  unless hash.is_a? Hash
    hash = @updated_hash
    use_master_key = hash 
  end
  hash = string_keyed_hash hash
  if new?
    create hash, use_master_key
  else
    update hash, use_master_key
  end
end

#save!(hash = @updated_hash) ⇒ Object 



146
147
148
 
# File 'lib/parse/object.rb', line 146

def save! hash=@updated_hash
  save hash, true
end

#set_column(name, value) ⇒ Object 



223
224
225
226
 
# File 'lib/parse/object.rb', line 223

def set_column name, value
  check_deleted!
  @updated_hash[name] = value
end

#to_s ⇒ Object 



232
233
234
 
# File 'lib/parse/object.rb', line 232

def to_s
  "<#{parse_class_name}: #{{}.update(@raw_hash).update(@updated_hash).to_s}>"
end

#update(hash, use_master_key = false) ⇒ Object 



172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/parse/object.rb', line 172

def update hash, use_master_key=false
  check_deleted!
  hash = string_keyed_hash hash
  method = use_master_key ? :update! : :update
  parse_client.send(method, parse_class_name, parse_object_id, hash) do |response|
    @raw_hash.update @updated_hash
    @raw_hash.update response
    @updated_at = Parse::Date.parse response['updatedAt']
    @updated_hash.clear
  end
end

#update!(hash) ⇒ Object 



184
185
186
 
# File 'lib/parse/object.rb', line 184

def update! hash
  update hash, true
end

#updated? ⇒ Boolean

Returns:

  • (Boolean) 


115
116
117
 
# File 'lib/parse/object.rb', line 115

def updated?
  !@deleted && !@updated_hash.empty?
end