twilio-ruby 3.11.5 → 5.0.0

data/lib/twilio-ruby/rest/conferences/participants.rb

@@ -1,23 +0,0 @@
-module Twilio
-  module REST
-    class Participants < ListResource
-      def initialize(path, client)
-        super
-        # hard-code the json key since participants don't have sids
-        @instance_id_key = 'call_sid'
-      end
-    end
-
-    class Participant < InstanceResource
-      def mute
-        update :muted => 'true'
-      end
-
-      def unmute
-        update :muted => 'false'
-      end
-
-      alias :kick :delete
-    end
-  end
-end

data/lib/twilio-ruby/rest/conferences.rb

@@ -1,12 +0,0 @@
-module Twilio
-  module REST
-    class Conferences < ListResource; end
-
-    class Conference < InstanceResource
-      def initialize(path, client, params={})
-        super path, client, params
-        resource :participants
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/connect_apps.rb

@@ -1,6 +0,0 @@
-module Twilio
-  module REST
-    class ConnectApps < ListResource; end
-    class ConnectApp < InstanceResource; end
-  end
-end

data/lib/twilio-ruby/rest/errors.rb

@@ -1,14 +0,0 @@
-module Twilio
-  module REST
-    class ServerError < StandardError; end
-
-    class RequestError < StandardError
-      attr_reader :code
-
-      def initialize(message, code=nil);
-        super message
-        @code = code
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/incoming_phone_numbers/local.rb

@@ -1,13 +0,0 @@
-module Twilio
-  module REST
-    module NumberType
-      class Local < ListResource
-        def initialize(path, client)
-          @path, @client = path, client
-          @instance_class = Twilio::REST::IncomingPhoneNumber
-          @list_key, @instance_id_key = 'incoming_phone_numbers', 'sid'
-        end
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/incoming_phone_numbers/mobile.rb

@@ -1,13 +0,0 @@
-module Twilio
-  module REST
-    module NumberType
-      class Mobile < ListResource
-        def initialize(path, client)
-          @path, @client = path, client
-          @instance_class = Twilio::REST::IncomingPhoneNumber
-          @list_key, @instance_id_key = 'incoming_phone_numbers', 'sid'
-        end
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/incoming_phone_numbers/toll_free.rb

@@ -1,13 +0,0 @@
-module Twilio
-  module REST
-    module NumberType
-      class TollFree < ListResource
-        def initialize(path, client)
-          @path, @client = path, client
-          @instance_class = Twilio::REST::IncomingPhoneNumber
-          @list_key, @instance_id_key = 'incoming_phone_numbers', 'sid'
-        end
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/incoming_phone_numbers.rb

@@ -1,17 +0,0 @@
-module Twilio
-  module REST
-    class IncomingPhoneNumbers < ListResource
-      def initialize(path, client)
-        super
-        @submodule = :NumberType
-        resource :mobile, :local, :toll_free
-      end
-
-      def buy(phone_number)
-        create :phone_number => phone_number
-      end
-    end
-
-    class IncomingPhoneNumber < InstanceResource; end
-  end
-end

data/lib/twilio-ruby/rest/instance_resource.rb

@@ -1,101 +0,0 @@
-module Twilio
-  module REST
-    ##
-    # A class to wrap an instance resource (like a call or application) within
-    # the Twilio API. All other instance resource classes within this library
-    # inherit from this class. You shouldn't need to instantiate this class
-    # directly. But reviewing the available methods is informative since they
-    # are rarely overridden in the inheriting class.
-    class InstanceResource
-      include Utils
-
-      ##
-      # Instantiate a new instance resource object. You must pass the +path+ of
-      # the instance (e.g. /2010-04-01/Accounts/AC123/Calls/CA456) as well as a
-      # +client+ object that responds to #get #post and #delete. This client
-      # is meant to be an instance of Twilio::REST::Client but could just as
-      # well be a mock object if you want to test the interface. The optional
-      # +params+ hash will be converted into attributes on the instantiated
-      # object.
-      def initialize(path, client, params = {})
-        @path, @client = path, client
-        set_up_properties_from params
-      end
-
-      def inspect # :nodoc:
-        "<#{self.class} @path=#{@path}>"
-      end
-
-      ##
-      # Update the properties of this instance resource using the key/value
-      # pairs in +params+. This makes an HTTP POST request to <tt>@path</tt>
-      # to handle the update. For example, to update the +VoiceUrl+ of a Twilio
-      # Application you could write:
-      #
-      #   @app.update :voice_url => 'http://my.other.app.com/handle_voice'
-      #
-      # After returning, the object will contain the most recent state of the
-      # instance resource, including the newly updated properties.
-      def update(params = {})
-        raise "Can't update a resource without a REST Client" unless @client
-        set_up_properties_from(@client.post(@path, params))
-        self
-      end
-
-      ##
-      # Refresh the attributes of this instance resource object by fetching it
-      # from Twilio. Calling this makes an HTTP GET request to <tt>@path</tt>.
-      def refresh
-        raise "Can't refresh a resource without a REST Client" unless @client
-        @updated = false
-        set_up_properties_from(@client.get(@path))
-        self
-      end
-
-      ##
-      # Delete an instance resource from Twilio. This operation isn't always
-      # supported. For instance, you can't delete an SMS. Calling this method
-      # makes an HTTP DELETE request to <tt>@path</tt>.
-      def delete
-        raise "Can't delete a resource without a REST Client" unless @client
-        @client.delete @path
-      end
-
-      ##
-      # Lazily load attributes of the instance resource by waiting to fetch it
-      # until an attempt is made to access an unknown attribute.
-      def method_missing(method, *args)
-        super if @updated
-        set_up_properties_from(@client.get(@path))
-        self.send method, *args
-      end
-
-      protected
-
-      def set_up_properties_from(hash)
-        eigenclass = class << self; self; end
-        hash.each do |p,v|
-          property = detwilify p
-          unless ['client', 'updated'].include? property
-            eigenclass.send :define_method, property.to_sym, &lambda {v}
-          end
-        end
-        @updated = !hash.keys.empty?
-      end
-
-      def resource(*resources)
-        custom_resource_names = {:sms => 'SMS', :sip => 'SIP'}
-        resources.each do |r|
-          resource = twilify r
-          relative_path = custom_resource_names.fetch(r, resource)
-          path = "#{@path}/#{relative_path}"
-          enclosing_module = @submodule == nil ? (Twilio::REST) : (Twilio::REST.const_get(@submodule))
-          resource_class = enclosing_module.const_get resource
-          instance_variable_set("@#{r}", resource_class.new(path, @client))
-        end
-        self.class.instance_eval {attr_reader *resources}
-      end
-
-    end
-  end
-end

data/lib/twilio-ruby/rest/list_resource.rb

@@ -1,110 +0,0 @@
-module Twilio
-  module REST
-    class ListResource
-      include Utils
-
-
-      def initialize(path, client)
-        custom_names = {"Media" => "MediaInstance", "IpAddresses" => "IpAddress"}
-        @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 = parent_module == "REST" ? (Twilio::REST) : (Twilio::REST.const_get parent_module)
-
-        @instance_class = full_module_path.const_get instance_name
-        @list_key, @instance_id_key = detwilify(resource_name), 'sid'
-      end
-
-      def inspect # :nodoc:
-        "<#{self.class} @path=#{@path}>"
-      end
-
-      ##
-      # Grab a list of this kind of resource and return it as an array. The
-      # array includes a special attribute named +total+ which will return the
-      # total number of items in the list on Twilio's server. This may differ
-      # from the +size+ and +length+ attributes of the returned array since
-      # by default Twilio will only return 50 resources, and the maximum number
-      # of resources you can request is 1000.
-      #
-      # The optional +params+ hash allows you to filter the list returned. The
-      # filters for each list resource type are defined by Twilio.
-      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 +total+ 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, :total, &lambda {response['total']}
-          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
-
-      ##
-      # Ask Twilio for the total number of items in the list.
-      # Calling this method makes an HTTP GET request to <tt>@path</tt> with a
-      # page size parameter of 1 to minimize data over the wire while still
-      # obtaining the total. Don't use this if you are planning to
-      # call #list anyway, since the array returned from #list will have a
-      # +total+ attribute as well.
-      def total
-        raise "Can't get a resource total without a REST Client" unless @client
-        @client.get(@path, :page_size => 1)['total']
-      end
-
-      ##
-      # 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.
-      def get(sid)
-        @instance_class.new "#{@path}/#{sid}", @client
-      end
-      alias :find :get # for the ActiveRecord lovers
-
-      ##
-      # 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 <tt>@path</tt> with the given params
-      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
-
-      def resource(*resources)
-        custom_resource_names = {:sms => 'SMS', :sip => 'SIP'}
-        resources.each do |r|
-          resource = twilify r
-          relative_path = custom_resource_names.fetch(r, resource)
-          path = "#{@path}/#{relative_path}"
-          enclosing_module = @submodule == nil ? (Twilio::REST) : (Twilio::REST.const_get(@submodule))
-          resource_class = enclosing_module.const_get resource
-          instance_variable_set("@#{r}", resource_class.new(path, @client))
-        end
-        self.class.instance_eval {attr_reader *resources}
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/media.rb

@@ -1,14 +0,0 @@
-module Twilio
-  module REST
-    class Media < ListResource
-
-      def initialize(path, client)
-        super
-        @list_key = 'media_list'
-      end
-
-    end
-
-    class MediaInstance < InstanceResource; end
-  end
-end

data/lib/twilio-ruby/rest/messages.rb

@@ -1,17 +0,0 @@
-module Twilio
-  module REST
-    class Messages < ListResource
-      def initialize(path, client)
-        path.gsub! '/SMS', ''
-        super
-      end
-    end
-
-    class Message < InstanceResource
-      def initialize(path, client, params={})
-        super
-        resource :media
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/notifications.rb

@@ -1,6 +0,0 @@
-module Twilio
-  module REST
-    class Notifications < ListResource; end
-    class Notification < InstanceResource; end
-  end
-end

data/lib/twilio-ruby/rest/outgoing_caller_ids.rb

@@ -1,25 +0,0 @@
-module Twilio
-  module REST
-    class OutgoingCallerIds < ListResource
-      def add(phone_number)
-        create :phone_number => phone_number
-      end
-      alias :verify :add
-
-      ##
-      # Override ListResource#create to instantiate the proper instance class.
-      # This doesn't actually matter since all properties are lazily loaded into
-      # whatever object is instantiated. But it might matter in the future.
-      def create(params={}) # :nodoc:
-        old_instance_class = @instance_class
-        @instance_class = Twilio::REST::PhoneNumberVerificationRequest
-        verification_request = super
-        @instance_class = old_instance_class
-        verification_request
-      end
-    end
-
-    class OutgoingCallerId < InstanceResource; end
-    class PhoneNumberVerificationRequest < InstanceResource; end
-  end
-end

data/lib/twilio-ruby/rest/queues/members.rb

@@ -1,29 +0,0 @@
-module Twilio
-  module REST
-    class Members < ListResource
-      def initialize(path, client)
-        super
-        # hard-code the json keys since members are special
-        @list_key, @instance_id_key = 'queue_members', 'call_sid'
-      end
-
-      def front
-        @instance_class.new "#{@path}/Front", @client
-      end
-
-      def front!
-        front.refresh
-      end
-
-      def dequeue(url, method='POST')
-        front.dequeue url, method
-      end
-    end
-
-    class Member < InstanceResource
-      def dequeue(url, method='POST')
-        update :url => url, :method => method
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/queues.rb

@@ -1,12 +0,0 @@
-module Twilio
-  module REST
-    class Queues < ListResource; end
-
-    class Queue < InstanceResource
-      def initialize(path, client, params={})
-        super path, client, params
-        resource :members
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/recordings.rb

@@ -1,35 +0,0 @@
-module Twilio
-  module REST
-    class Recordings < ListResource; end
-
-    class Recording < InstanceResource
-      def initialize(path, client, params={})
-        path.sub! /\/Calls\/CA[^\/]+/, ''
-        super path, client, params
-        resource :transcriptions
-        # grab a reference to the client's connection object for streaming
-        @connection = @client.instance_variable_get :@connection
-      end
-
-      ##
-      # Return the wav URL for this recording.
-      def wav
-        "https://#{@connection.address}#{@path}.wav"
-      end
-
-      def wav!(&block)
-        @connection.request_get @path, &block
-      end
-
-      ##
-      # Return the mp3 URL for this recording.
-      def mp3
-        "https://#{@connection.address}#{@path}.mp3"
-      end
-
-      def mp3!(&block)
-        @connection.request_get "#{@path}.mp3", &block
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/sandbox.rb

@@ -1,5 +0,0 @@
-module Twilio
-  module REST
-    class Sandbox < InstanceResource; end
-  end
-end

data/lib/twilio-ruby/rest/sip/credential_lists/credentials.rb

@@ -1,6 +0,0 @@
-module Twilio
-  module REST
-    class Credentials < ListResource; end
-    class Credential < InstanceResource; end
-  end
-end

data/lib/twilio-ruby/rest/sip/credential_lists.rb

@@ -1,11 +0,0 @@
-module Twilio
-  module REST
-    class CredentialLists < ListResource; end
-    class CredentialList < InstanceResource
-      def initialize(path, client, params={})
-        super
-        resource :credentials
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/sip/domains/credential_list_mappings.rb

@@ -1,6 +0,0 @@
-module Twilio
-  module REST
-    class CredentialListMappings < ListResource; end
-    class CredentialListMapping < InstanceResource; end
-  end
-end

data/lib/twilio-ruby/rest/sip/domains/ip_access_control_list_mappings.rb

@@ -1,6 +0,0 @@
-module Twilio
-  module REST
-    class IpAccessControlListMappings < ListResource; end
-    class IpAccessControlListMapping < InstanceResource; end
-  end
-end

data/lib/twilio-ruby/rest/sip/domains.rb

@@ -1,12 +0,0 @@
-module Twilio
-  module REST
-    class Domains < ListResource; end
-    class Domain < InstanceResource
-      def initialize(path, client, params={})
-        super
-        resource :ip_access_control_list_mappings,
-            :credential_list_mappings
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/sip/ip_access_control_lists/ip_addresses.rb

@@ -1,6 +0,0 @@
-module Twilio
-  module REST
-    class IpAddresses < ListResource; end
-    class IpAddress < InstanceResource; end
-  end
-end

data/lib/twilio-ruby/rest/sip/ip_access_control_lists.rb

@@ -1,11 +0,0 @@
-module Twilio
-  module REST
-    class IpAccessControlLists < ListResource; end
-    class IpAccessControlList < InstanceResource
-      def initialize(path, client, params={})
-        super
-        resource :ip_addresses
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/sip.rb

@@ -1,12 +0,0 @@
-module Twilio
-  module REST
-    class Sip < InstanceResource
-      def initialize(path, client, params={})
-        super
-        resource :domains, 
-            :ip_access_control_lists,
-            :credential_lists
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/sms/messages.rb

@@ -1,15 +0,0 @@
-module Twilio
-  module REST
-    module SMS
-      class Messages < ListResource
-        def initialize(path, client)
-          super
-          @list_key = 'sms_messages'
-        end
-      end
-
-      class Message < InstanceResource
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/sms/short_codes.rb

@@ -1,8 +0,0 @@
-module Twilio
-  module REST
-    module SMS
-      class ShortCodes < ListResource; end
-      class ShortCode < InstanceResource; end
-    end
-  end
-end

data/lib/twilio-ruby/rest/sms.rb

@@ -1,11 +0,0 @@
-module Twilio
-  module REST
-    class Sms < InstanceResource
-      def initialize(path, client, params={})
-        super
-        @submodule = :SMS
-        resource :messages, :short_codes
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/transcriptions.rb

@@ -1,6 +0,0 @@
-module Twilio
-  module REST
-    class Transcriptions < ListResource; end
-    class Transcription < InstanceResource; end
-  end
-end

data/lib/twilio-ruby/rest/usage/records.rb

@@ -1,21 +0,0 @@
-module Twilio
-  module REST
-    class Records < ListResource
-
-      SUBRESOURCES = [:daily, :monthly, :yearly, :all_time, :today, :yesterday,
-        :this_month, :last_month]
-
-      def initialize(path, client)
-        super
-        @list_key = 'usage_records'
-      end
-
-      def method_missing(method, *args)
-        return super unless SUBRESOURCES.include? method
-        self.class.new "#{@path}/#{twilify(method)}", @client
-      end
-    end
-
-    class Record < InstanceResource; end
-  end
-end

data/lib/twilio-ruby/rest/usage/triggers.rb

@@ -1,12 +0,0 @@
-module Twilio
-  module REST
-    class Triggers < ListResource
-      def initialize(path, client)
-        super
-        @list_key = 'usage_triggers'
-      end
-    end
-
-    class Trigger < InstanceResource; end
-  end
-end

data/lib/twilio-ruby/rest/usage.rb

@@ -1,10 +0,0 @@
-module Twilio
-  module REST
-    class Usage < InstanceResource
-      def initialize(path, client, params={})
-        super
-        resource :records, :triggers
-      end
-    end
-  end
-end