twilio-ruby 4.13.0 → 5.0.0.alpha1

data/lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb

@@ -0,0 +1,235 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Wireless < Domain
+      class V1 < Version
+        class SimContext < InstanceContext
+          class UsageRecordList < ListResource
+            ##
+            # Initialize the UsageRecordList
+            # @param [Version] version Version that contains the resource
+            # @param [String] sim_sid The sim_sid
+            # @return [UsageRecordList] UsageRecordList
+            def initialize(version, sim_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {
+                  sim_sid: sim_sid
+              }
+              @uri = "/Sims/#{@solution[:sim_sid]}/UsageRecords"
+            end
+
+            ##
+            # Lists UsageRecordInstance records from the API as a list.
+            # Unlike stream(), this operation is eager and will load `limit` records into
+            # memory before returning.
+            # @param [Time] end_ The end
+            # @param [Time] start The start
+            # @param [usage_record.Granularity] granularity The granularity
+            # @param [Integer] limit Upper limit for the number of records to return. stream()
+            #                   guarantees to never return more than limit.  Default is no limit
+            # @param [Integer] page_size Number of records to fetch per request, when not set will                      use
+            #  the default value of 50 records.  If no page_size is                      defined
+            #  but a limit is defined, stream() will attempt to read                      the
+            #  limit with the most efficient page size,                      i.e. min(limit, 1000)
+            # @return [Array] Array of up to limit results
+            def list(end_: :unset, start: :unset, granularity: :unset, limit: nil, page_size: nil)
+              self.stream(
+                  end_: end_,
+                  start: start,
+                  granularity: granularity,
+                  limit: limit,
+                  page_size: page_size
+              ).entries
+            end
+
+            ##
+            # Streams UsageRecordInstance records from the API as an Enumerable.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            # @param [Time] end_ The end
+            # @param [Time] start The start
+            # @param [usage_record.Granularity] granularity The granularity
+            # @param [Integer] limit Upper limit for the number of records to return.                  stream()
+            #  guarantees to never return more than limit.                  Default is no limit
+            # @param [Integer] page_size Number of records to fetch per request, when                      not set will use
+            #  the default value of 50 records.                      If no page_size is defined
+            #                       but a limit is defined, stream() will attempt to                      read the
+            #  limit with the most efficient page size,                       i.e. min(limit, 1000)
+            # @return [Enumerable] Enumerable that will yield up to limit results
+            def stream(end_: :unset, start: :unset, granularity: :unset, limit: nil, page_size: nil)
+              limits = @version.read_limits(limit, page_size)
+
+              page = self.page(
+                  end_: end_,
+                  start: start,
+                  granularity: granularity,
+                  page_size: limits[:page_size],
+              )
+
+              @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+            end
+
+            ##
+            # When passed a block, yields UsageRecordInstance records from the API.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            def each
+              limits = @version.read_limits
+
+              page = self.page(
+                  page_size: limits[:page_size],
+              )
+
+              @version.stream(page,
+                              limit: limits[:limit],
+                              page_limit: limits[:page_limit]).each {|x| yield x}
+            end
+
+            ##
+            # Retrieve a single page of UsageRecordInstance records from the API.
+            # Request is executed immediately.
+            # @param [Time] end_ The end
+            # @param [Time] start The start
+            # @param [usage_record.Granularity] granularity The granularity
+            # @param [String] page_token PageToken provided by the API
+            # @param [Integer] page_number Page Number, this value is simply for client state
+            # @param [Integer] page_size Number of records to return, defaults to 50
+            # @return [Page] Page of UsageRecordInstance
+            def page(end_: :unset, start: :unset, granularity: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+              params = Twilio::Values.of({
+                  'End' => Twilio.serialize_iso8601_datetime(end_),
+                  'Start' => Twilio.serialize_iso8601_datetime(start),
+                  'Granularity' => granularity,
+                  'PageToken' => page_token,
+                  'Page' => page_number,
+                  'PageSize' => page_size,
+              })
+              response = @version.page(
+                  'GET',
+                  @uri,
+                  params
+              )
+              UsageRecordPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of UsageRecordInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of UsageRecordInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              UsageRecordPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Wireless.V1.UsageRecordList>'
+            end
+          end
+
+          class UsageRecordPage < Page
+            ##
+            # Initialize the UsageRecordPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [UsageRecordPage] UsageRecordPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of UsageRecordInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [UsageRecordInstance] UsageRecordInstance
+            def get_instance(payload)
+              UsageRecordInstance.new(
+                  @version,
+                  payload,
+                  sim_sid: @solution[:sim_sid],
+              )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Wireless.V1.UsageRecordPage>'
+            end
+          end
+
+          class UsageRecordInstance < InstanceResource
+            ##
+            # Initialize the UsageRecordInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] sim_sid The sim_sid
+            # @return [UsageRecordInstance] UsageRecordInstance
+            def initialize(version, payload, sim_sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'sim_sid' => payload['sim_sid'],
+                  'account_sid' => payload['account_sid'],
+                  'period' => payload['period'],
+                  'commands' => payload['commands'],
+                  'data' => payload['data'],
+              }
+            end
+
+            ##
+            # @return [String] The sim_sid
+            def sim_sid
+              @properties['sim_sid']
+            end
+
+            ##
+            # @return [String] The account_sid
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [Hash] The period
+            def period
+              @properties['period']
+            end
+
+            ##
+            # @return [Hash] The commands
+            def commands
+              @properties['commands']
+            end
+
+            ##
+            # @return [Hash] The data
+            def data
+              @properties['data']
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              "<Twilio.Wireless.V1.UsageRecordInstance>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/{util → security}/request_validator.rb

@@ -1,14 +1,14 @@
 module Twilio
-  module Util
+  module Security
     class RequestValidator
-
       def initialize(auth_token = nil)
         @auth_token = auth_token || Twilio.auth_token
         raise ArgumentError, 'Auth token is required' if @auth_token.nil?
       end
 
       def validate(url, params, signature)
-        expected = build_signature_for url, params
+        params_hash = params_to_hash(params)
+        expected = build_signature_for(url, params_hash)
         secure_compare(expected, signature)
       end
 
@@ -30,7 +30,24 @@ module Twilio
 
         res = 0
         b.each_byte { |byte| res |= byte ^ l.shift }
-        res == 0
+        res.zero?
+      end
+
+      # `ActionController::Parameters` no longer, as of Rails 5, inherits
+      # from `Hash` so the `sort` method, used above in `build_signature_for`
+      # is deprecated.
+      #
+      # `to_unsafe_h` was introduced in Rails 4.2.1, before then it is still
+      # possible to sort on an ActionController::Parameters object.
+      #
+      # We use `to_unsafe_h` as `to_h` returns a hash of the permitted
+      # parameters only and we need all the parameters to create the signature.
+      def params_to_hash(params)
+        if params.respond_to?(:to_unsafe_h)
+          params.to_unsafe_h
+        else
+          params
+        end
       end
     end
   end

data/lib/twilio-ruby/twiml/messaging_response.rb

@@ -0,0 +1,141 @@
+module Twilio
+  module TwiML
+    # Messaging TwiML Response
+    class MessagingResponse < TwiML
+      # Create a new <Response>
+      def initialize
+        super()
+        self.name = 'Response'
+        yield(self) if block_given?
+      end
+
+      # Create a <Message> element
+      #
+      # == Parameters:
+      # body:: body of the message
+      # to:: number to send to
+      # from_:: number to send from
+      # method:: action HTTP method
+      # action:: action URL
+      # status_callback:: callback URL
+      # keyword_args:: additional attributes
+      #
+      # == Returns:
+      # A <Response> element with a <Message> child element
+      def message(body: nil, to: nil, from: nil, method: nil, action: nil, status_callback: nil, **keyword_args)
+        message = Message.new(
+          body: body,
+          to: to,
+          from: from,
+          method: method,
+          action: action,
+          status_callback: status_callback,
+          **keyword_args
+        )
+
+        yield(message) if block_given?
+        append(message)
+      end
+
+      # Create an <Redirect> element
+      #
+      # == Parameters:
+      # url:: URL to redirect to
+      # method:: HTTP method
+      # keyword_args:: attributes
+      #
+      # == Returns:
+      # A <Response> element with an <Redirect> child element
+      def redirect(url, method: nil, **keyword_args)
+        append(Redirect.new(url, method: method, **keyword_args))
+      end
+    end
+
+    # <Message> element
+    class Message < TwiML
+      # Create a <Message> element
+      #
+      # == Parameters:
+      # body:: message body
+      # keyword_args:: additional attributes
+      #
+      # == Returns:
+      # A <Message> element
+      def initialize(body: nil, **keyword_args)
+        super(**keyword_args)
+        @value = body unless body.nil?
+        yield(self) if block_given?
+      end
+
+      # Create a <Body> element
+      #
+      # == Parameters:
+      # body:: body of message
+      # keyword_args:: additional attributes
+      #
+      # == Returns:
+      # A <Message> element with a <Body> child element
+      def body(body)
+        append(Body.new(body))
+      end
+
+      # Create a <Media> element
+      #
+      # == Parameters:
+      # body:: body of message
+      # keyword_args:: additional attributes
+      #
+      # == Returns:
+      # A <Message> element with a <Media> child element
+      def media(url)
+        append(Media.new(url))
+      end
+    end
+
+    # <Body> element
+    class Body < TwiML
+      # Create a <Body> element
+      #
+      # == Parameters:
+      # body:: message body
+      #
+      # == Returns:
+      # A <Body> element
+      def initialize(body)
+        super()
+        @value = body
+      end
+    end
+
+    # <Media> element
+    class Media < TwiML
+      # Create a <Media> element
+      #
+      # == Parameters:
+      # url:: media URL location
+      #
+      # == Returns:
+      # A <Media> element
+      def initialize(url)
+        super()
+        @value = url
+      end
+    end
+
+    # <Redirect> element
+    class Redirect < TwiML
+      # Create a <Redirect> element
+      #
+      # == Parameters:
+      # url:: redirect URL location
+      # keyword_args:: additional attributes
+      #
+      # == Returns:
+      # A <Redirect> element
+      def initialize(url, **keyword_args)
+        super(**keyword_args)
+        @value = url
+      end
+    end
+  end
+end

data/lib/twilio-ruby/twiml/twiml.rb

@@ -0,0 +1,69 @@
+require 'libxml'
+
+module Twilio
+  module TwiML
+    class TwiMLError < StandardError
+    end
+
+    # TwiML Base Class
+    class TwiML
+      # Generate getter/setter methods
+      attr_accessor :name
+      attr_accessor :indent
+
+      alias to_xml to_s
+
+      def initialize(indent: false, **keyword_args)
+        @name = self.class.name.split('::').last
+        @indent = indent
+        @value = nil
+        @verbs = []
+        @attrs = {}
+
+        keyword_args.each do |key, val|
+          @attrs[TwiML.to_lower_camel_case(key)] = val unless val.nil?
+        end
+      end
+
+      def self.to_lower_camel_case(symbol)
+        # Symbols don't have the .split method, so convert to string first
+        result = symbol.to_s.split('_').map(&:capitalize).join
+        result[0].downcase + result[1..result.length]
+      end
+
+      def to_s(xml_declaration = true)
+        xml = self.xml.to_s(indent: indent)
+
+        return ('<?xml version="1.0" encoding="UTF-8"?>' + xml) if xml_declaration
+        xml
+      end
+
+      def xml
+        # create XML element
+        elem = LibXML::XML::Node.new(@name, @value)
+
+        # set element attributes
+        keys = @attrs.keys.sort
+        keys.each do |key|
+          value = @attrs[key]
+
+          value_is_boolean = value.is_a?(TrueClass) || value.is_a?(FalseClass)
+          elem[key] = value_is_boolean ? value.to_s.downcase : value.to_s
+        end
+
+        @verbs.each do |verb|
+          elem << verb.xml
+        end
+
+        elem
+      end
+
+      def append(verb)
+        raise TwiMLError, 'Only appending of TwiML is allowed' unless verb.is_a?(TwiML)
+
+        @verbs << verb
+        self
+      end
+    end
+  end
+end