Class: MachineShop::MachineShopObject

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/machineshop/machineshop_object.rb

Direct Known Subclasses

APIResource

Constant Summary collapse

@@permanent_attributes = 
Set.new([:auth_token, :id])

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id = nil, auth_token = nil) ⇒ MachineShopObject

Returns a new instance of MachineShopObject.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/machineshop/machineshop_object.rb', line 13

def initialize(id=nil, auth_token=nil)
  # parameter overloading!
  if id.kind_of?(Hash)
    @retrieve_options = id.dup
    @retrieve_options.delete(:id)
    id = id[:id] ? id[:id] : id[:_id]
  else
    @retrieve_options = {}
  end

  @auth_token = auth_token    

  @values = {}
  # This really belongs in APIResource, but not putting it there allows us
  # to have a unified inspect method
  @unsaved_values = Set.new
  @transient_values = Set.new
  self.id = id if id
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args) ⇒ Object (protected) 



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/machineshop/machineshop_object.rb', line 142

def method_missing(name, *args)
  # TODO: only allow setting in updateable classes.
  if name.to_s.end_with?('=')
    attr = name.to_s[0...-1].to_sym
    @values[attr] = args[0]
    @unsaved_values.add(attr)
    add_accessors([attr])
    return
  else
    return @values[name] if @values.has_key?(name)
  end

  begin
    super
  rescue NoMethodError => e
    if @transient_values.include?(name)
      raise NoMethodError.new(e.message + ".  HINT: The '#{name}' attribute was set in the past, however.  It was then wiped when refreshing the object with the result returned by MachineShop's API, probably as a result of a save().  The attributes currently available on this object are: #{@values.keys.join(', ')}")
    else
      raise
    end
  end
end

Instance Attribute Details

#auth_token ⇒ Object

Returns the value of attribute auth_token.



5
6
7
 
# File 'lib/machineshop/machineshop_object.rb', line 5

def auth_token
  @auth_token
end

Class Method Details

.construct_from(values, auth_token = nil) ⇒ Object 



33
34
35
36
37
38
 
# File 'lib/machineshop/machineshop_object.rb', line 33

def self.construct_from(values, auth_token=nil)
  values[:id] = values[:_id] if values[:_id]
  obj = self.new(values[:id], auth_token)
  obj.refresh_from(values, auth_token)
  obj
end

Instance Method Details

#[](k) ⇒ Object 



78
79
80
81
 
# File 'lib/machineshop/machineshop_object.rb', line 78

def [](k)
  k = k.to_sym if k.kind_of?(String)
  @values[k]
end

#[]=(k, v) ⇒ Object 



83
84
85
 
# File 'lib/machineshop/machineshop_object.rb', line 83

def []=(k, v)
  send(:"#{k}=", v)
end

#as_json(*a) ⇒ Object 



99
100
101
 
# File 'lib/machineshop/machineshop_object.rb', line 99

def as_json(*a)
  @values.as_json(*a)
end

#each(&blk) ⇒ Object 



107
108
109
 
# File 'lib/machineshop/machineshop_object.rb', line 107

def each(&blk)
  @values.each(&blk)
end

#inspect ⇒ Object 



44
45
46
47
 
# File 'lib/machineshop/machineshop_object.rb', line 44

def inspect()
  id_string = (self.respond_to?(:id) && !self.id.nil?) ? " id=#{self.id}" : ""
  "#<#{self.class}:0x#{self.object_id.to_s(16)}#{id_string}> JSON: " + MachineShop::JSON.dump(@values, :pretty => true)
end

#keys ⇒ Object 



87
88
89
 
# File 'lib/machineshop/machineshop_object.rb', line 87

def keys
  @values.keys
end

#refresh_from(values, auth_token, partial = false) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/machineshop/machineshop_object.rb', line 49

def refresh_from(values, auth_token, partial=false)
  @auth_token = auth_token
  case values
  when Array
    values = values[0]
  else
    #do nothing
  end
  values[:id] = values[:_id] if values[:_id]

  removed = partial ? Set.new : Set.new(@values.keys - values.keys)
  added = Set.new(values.keys - @values.keys)

  instance_eval do
    remove_accessors(removed)
    add_accessors(added)
  end
  removed.each do |k|
    @values.delete(k)
    @transient_values.add(k)
    @unsaved_values.delete(k)
  end
  values.each do |k, v|
    @values[k] = Util.convert_to_machineshop_object(v, auth_token)
    @transient_values.delete(k)
    @unsaved_values.delete(k)
  end
end

#to_hash ⇒ Object 



103
104
105
 
# File 'lib/machineshop/machineshop_object.rb', line 103

def to_hash
  @values
end

#to_json(*a) ⇒ Object 



95
96
97
 
# File 'lib/machineshop/machineshop_object.rb', line 95

def to_json(*a)
  MachineShop::JSON.dump(@values)
end

#to_s(*args) ⇒ Object 



40
41
42
 
# File 'lib/machineshop/machineshop_object.rb', line 40

def to_s(*args)
  MachineShop::JSON.dump(@values, :pretty => true)
end

#values ⇒ Object 



91
92
93
 
# File 'lib/machineshop/machineshop_object.rb', line 91

def values
  @values.values
end