Class: Inbox::RestfulModelCollection

Inherits:
Object
  • Object
show all
Defined in:
lib/restful_model_collection.rb

Direct Known Subclasses

ManagementModelCollection

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(model_class, api, namespace_id, filters = {}) ⇒ RestfulModelCollection

Returns a new instance of RestfulModelCollection.

Raises:

  • (StandardError) 


8
9
10
11
12
13
14
 
# File 'lib/restful_model_collection.rb', line 8

def initialize(model_class, api, namespace_id, filters = {})
  raise StandardError.new unless api.class <= Inbox::API
  @model_class = model_class
  @filters = filters
  @namespace_id = namespace_id
  @_api = api
end

Instance Attribute Details

#filters ⇒ Object

Returns the value of attribute filters.



6
7
8
 
# File 'lib/restful_model_collection.rb', line 6

def filters
  @filters
end

Instance Method Details

#all ⇒ Object 



41
42
43
 
# File 'lib/restful_model_collection.rb', line 41

def all
  range(0, Float::INFINITY)
end

#build(args) ⇒ Object 



92
93
94
95
96
97
98
99
 
# File 'lib/restful_model_collection.rb', line 92

def build(args)
  for key in args.keys
    args[key.to_s] = args[key]
  end
  model = @model_class.new(@_api, @namespace_id)
  model.inflate(args)
  model
end

#count ⇒ Object 



30
31
32
33
34
35
 
# File 'lib/restful_model_collection.rb', line 30

def count
  RestClient.get(url, params: @filters.merge(view: 'count')) { |response,request,result|
    json = Inbox.interpret_response(result, response)
    return json['count']
  }
end

#delete(item_or_id) ⇒ Object 



82
83
84
85
 
# File 'lib/restful_model_collection.rb', line 82

def delete(item_or_id)
  item_or_id = item_or_id.id if item_or_id.is_a?(RestfulModel)
  RestClient.delete("#{url}/#{id}")
end

#each ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/restful_model_collection.rb', line 16

def each
  offset = 0
  chunk_size = 100
  finished = false
  while (!finished) do
    results = get_model_collection(offset, chunk_size)
    results.each { |item|
      yield item
    }
    offset += results.length
    finished = results.length < chunk_size
  end
end

#find(id) ⇒ Object 



87
88
89
90
 
# File 'lib/restful_model_collection.rb', line 87

def find(id)
  return nil unless id
  get_model(id)
end

#first ⇒ Object 



37
38
39
 
# File 'lib/restful_model_collection.rb', line 37

def first
  get_model_collection.first
end

#inflate_collection(items = []) ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/restful_model_collection.rb', line 101

def inflate_collection(items = [])
  models = []

  return unless items.is_a?(Array)
  items.each do |json|
    if @model_class < RestfulModel
      model = @model_class.new(@_api)
      model.inflate(json)
    else
      model = @model_class.new(json)
    end
    models.push(model)
  end
  models
end

#range(offset = 0, limit = 100) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/restful_model_collection.rb', line 61

def range(offset = 0, limit = 100)
  accumulated = []
  finished = false
  chunk_size = 100

  if limit < chunk_size
    chunk_size = limit
  end

  while (!finished && accumulated.length < limit) do
    results = get_model_collection(offset + accumulated.length, chunk_size)
    accumulated = accumulated.concat(results)

    # we're done if we have more than 'limit' items, or if we asked for 50 and got less than 50...
    finished = accumulated.length >= limit || results.length == 0 || (results.length % chunk_size != 0)
  end

  accumulated = accumulated[0..limit] if limit < Float::INFINITY
  accumulated
end

#url ⇒ Object 



117
118
119
120
 
# File 'lib/restful_model_collection.rb', line 117

def url
  prefix = "/n/#{@namespace_id}" if @namespace_id
  @_api.url_for_path("#{prefix}/#{@model_class.collection_name}")
end

#where(filters) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/restful_model_collection.rb', line 45

def where(filters)
  collection = self.clone

  # deep copy the object, otherwise filter is shared among all
  # the instances of the collection, which leads to confusing behaviour.
  # - karim
  if collection.filters == nil
    collection.filters = {}
  else
    collection.filters = Marshal.load(Marshal.dump(collection.filters))
  end

  collection.filters.merge!(filters)
  collection
end