Class: Twilio::REST::ListResource

Inherits:
Object
  • Object
show all
Includes:
Utils
Defined in:
lib/twilio-ruby/rest/list_resource.rb

Instance Method Summary collapse

Methods included from Utils

#detwilify, #twilify

Constructor Details

#initialize(path, client) ⇒ ListResource

Returns a new instance of ListResource.



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/twilio-ruby/rest/list_resource.rb', line 6

def initialize(path, client)
  custom_names = {
    'Activities' => 'Activity',
    'Addresses' => 'Address',
    'Countries' => 'Country',
    'Feedback' => 'FeedbackInstance',
    'IpAddresses' => 'IpAddress',
    'Media' => 'MediaInstance',
  }
  @path, @client = path, client
  resource_name = self.class.name.split('::')[-1]
  instance_name = custom_names.fetch(resource_name, resource_name.chop)

  # The next line grabs the enclosing module. Necessary for resources
  # contained in their own submodule like /SMS/Messages
  parent_module = self.class.to_s.split('::')[-2]
  full_module_path = if parent_module == "REST"
    Twilio::REST
  else
    Twilio::REST.const_get parent_module
  end

  @instance_class = full_module_path.const_get instance_name
  @list_key, @instance_id_key = detwilify(resource_name), 'sid'
end

Instance Method Details

#create(params = {}) ⇒ Object

Return a newly created resource. Some params may be required. Consult the Twilio REST API documentation related to the kind of resource you are attempting to create for details. Calling this method makes an HTTP POST request to @path with the given params



92
93
94
95
96
97
 
# File 'lib/twilio-ruby/rest/list_resource.rb', line 92

def create(params={})
  raise "Can't create a resource without a REST Client" unless @client
  response = @client.post @path, params
  @instance_class.new "#{@path}/#{response[@instance_id_key]}", @client,
    response
end

#get(sid) ⇒ Object Also known as: find

Return an empty instance resource object with the proper path. Note that this will never raise a Twilio::REST::RequestError on 404 since no HTTP request is made. The HTTP request is made when attempting to access an attribute of the returned instance resource object, such as its #date_created or #voice_url attributes.



82
83
84
 
# File 'lib/twilio-ruby/rest/list_resource.rb', line 82

def get(sid)
  @instance_class.new "#{@path}/#{sid}", @client
end

#inspect ⇒ Object

:nodoc:



32
33
34
 
# File 'lib/twilio-ruby/rest/list_resource.rb', line 32

def inspect # :nodoc:
  "<#{self.class} @path=#{@path}>"
end

#list(params = {}, full_path = false) ⇒ Object

Grab a list of this kind of resource and return it as an array. The array includes two special methods previous_page and next_page which will return the previous or next page or resources. By default Twilio will only return 50 resources, and the maximum number of resources you can request (using the :page_size param) is 1000.

The optional params hash allows you to filter the list returned. The filters for each list resource type are defined by Twilio.



45
46
47
48
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
 
# File 'lib/twilio-ruby/rest/list_resource.rb', line 45

def list(params={}, full_path=false)
  raise "Can't get a resource list without a REST Client" unless @client
  response = @client.get @path, params, full_path
  resources = response[@list_key]
  path = full_path ? @path.split('.')[0] : @path
  resource_list = resources.map do |resource|
    @instance_class.new "#{path}/#{resource[@instance_id_key]}", @client,
      resource
  end
  # set the +previous_page+ and +next_page+ properties on the array
  client, list_class = @client, self.class
  resource_list.instance_eval do
    eigenclass = class << self; self; end
    eigenclass.send :define_method, :previous_page, &lambda {
      if response['previous_page_uri']
        list_class.new(response['previous_page_uri'], client).list({}, true)
      else
        []
      end
    }
    eigenclass.send :define_method, :next_page, &lambda {
      if response['next_page_uri']
        list_class.new(response['next_page_uri'], client).list({}, true)
      else
        []
      end
    }
  end
  resource_list
end