plivo 0.3.19 → 4.0.0.beta.2

data/lib/plivo/version.rb

@@ -0,0 +1,3 @@
+module Plivo
+  VERSION = '4.0.0.beta.2'.freeze
+end

data/lib/plivo/xml.rb

@@ -0,0 +1,27 @@
+require 'rexml/document'
+require 'htmlentities'
+
+require_relative 'xml/element'
+require_relative 'xml/response'
+require_relative 'xml/conference'
+require_relative 'xml/dial'
+require_relative 'xml/dtmf'
+require_relative 'xml/get_digits'
+require_relative 'xml/hangup'
+require_relative 'xml/message'
+require_relative 'xml/number'
+require_relative 'xml/play'
+require_relative 'xml/pre_answer'
+require_relative 'xml/record'
+require_relative 'xml/redirect'
+require_relative 'xml/speak'
+require_relative 'xml/user'
+require_relative 'xml/wait'
+require_relative 'xml/plivo_xml'
+
+include Plivo::Exceptions
+
+module Plivo
+  module XML
+  end
+end

data/lib/plivo/xml/conference.rb

@@ -0,0 +1,20 @@
+module Plivo
+  module XML
+    class Conference < Element
+      @nestables = []
+      @valid_attributes = %w[muted beep startConferenceOnEnter
+                             endConferenceOnExit waitSound enterSound exitSound
+                             timeLimit hangupOnStar maxMembers
+                             record recordFileFormat action method redirect
+                             digitsMatch callbackUrl callbackMethod
+                             stayAlone floorEvent
+                             transcriptionType transcriptionUrl
+                             transcriptionMethod recordWhenAlone relayDTMF]
+
+      def initialize(body, attributes = {})
+        raise PlivoXMLError, 'No conference name set for Conference' unless body
+        super(body, attributes)
+      end
+    end
+  end
+end

data/lib/plivo/xml/dial.rb

@@ -0,0 +1,16 @@
+module Plivo
+  module XML
+    class Dial < Element
+      @nestables = %w[Number User]
+      @valid_attributes = %w[action method timeout hangupOnStar
+                             timeLimit callerId callerName confirmSound
+                             dialMusic confirmKey redirect
+                             callbackUrl callbackMethod digitsMatch digitsMatchBLeg
+                             sipHeaders]
+
+      def initialize(attributes = {}, &block)
+        super(nil, attributes, &block)
+      end
+    end
+  end
+end

data/lib/plivo/xml/dtmf.rb

@@ -0,0 +1,13 @@
+module Plivo
+  module XML
+    class DTMF < Element
+      @nestables = []
+      @valid_attributes = %w[async]
+
+      def initialize(body, attributes = {})
+        raise PlivoXMLError, 'No digits set for DTMF' unless body
+        super(body, attributes)
+      end
+    end
+  end
+end

data/lib/plivo/xml/element.rb

@@ -0,0 +1,83 @@
+module Plivo
+  module XML
+    class Element
+      class << self
+        attr_accessor :valid_attributes, :nestables
+      end
+      @nestables = []
+      @valid_attributes = []
+
+      attr_accessor :node, :name
+
+      def initialize(body = nil, attributes = {})
+        @name = self.class.name.split('::')[2]
+        @body = body
+        @node = REXML::Element.new @name
+        attributes.each do |k, v|
+          if self.class.valid_attributes.include?(k.to_s)
+            @node.attributes[k.to_s] = convert_value(v)
+          else
+            raise PlivoXMLError, "invalid attribute #{k} for #{@name}"
+          end
+        end
+
+        @node.text = @body if @body
+
+        # Allow for nested "nestable" elements using a code block
+        # ie
+        # Plivo::XML::Response.new do |r|
+        #   r.Dial do |n|
+        #     n.Number '+15557779999'
+        #   end
+        # end
+        yield(self) if block_given?
+      end
+
+      def method_missing(method, *args, &block)
+        # Handle the addElement methods
+        method = Regexp.last_match(1).to_sym if method.to_s =~ /^add(.*)/
+        # Add the element
+        begin
+          add(Plivo::XML.const_get(method).new(*args, &block))
+        rescue StandardError => e
+          raise PlivoXMLError, e.message
+        end
+      end
+
+      def convert_value(v)
+        case v
+        when true
+          'true'
+        when false
+          'false'
+        when nil
+          'none'
+        when 'get'
+          'GET'
+        when 'post'
+          'POST'
+        else
+          v
+        end
+      end
+
+      def add(element)
+        raise PlivoXMLError, 'invalid element' unless element
+        if self.class.nestables.include?(element.name)
+          @node.elements << element.node
+          element
+        else
+          raise PlivoXMLError, "#{element.name} not nestable in #{@name}"
+        end
+      end
+
+      def to_xml
+        @node.to_s
+      end
+
+      def to_s
+        @node.to_s
+      end
+    end
+  end
+end

data/lib/plivo/xml/get_digits.rb

@@ -0,0 +1,15 @@
+module Plivo
+  module XML
+    class GetDigits < Element
+      @nestables = %w[Speak Play Wait]
+      @valid_attributes = %w[action method timeout digitTimeout
+                             numDigits retries invalidDigitsSound
+                             validDigits playBeep redirect finishOnKey
+                             digitTimeout log]
+
+      def initialize(attributes = {}, &block)
+        super(nil, attributes, &block)
+      end
+    end
+  end
+end

data/lib/plivo/xml/hangup.rb

@@ -0,0 +1,12 @@
+module Plivo
+  module XML
+    class Hangup < Element
+      @nestables = []
+      @valid_attributes = %w[schedule reason]
+
+      def initialize(attributes = {})
+        super(nil, attributes)
+      end
+    end
+  end
+end

data/lib/plivo/xml/message.rb

@@ -0,0 +1,13 @@
+module Plivo
+  module XML
+    class Message < Element
+      @nestables = []
+      @valid_attributes = %w[src dst type callbackUrl callbackMethod]
+
+      def initialize(body, attributes = {})
+        raise PlivoXMLError, 'No text set for Message' unless body
+        super(body, attributes)
+      end
+    end
+  end
+end

data/lib/plivo/xml/number.rb

@@ -0,0 +1,13 @@
+module Plivo
+  module XML
+    class Number < Element
+      @nestables = []
+      @valid_attributes = %w[sendDigits sendOnPreanswer]
+
+      def initialize(body, attributes = {})
+        raise PlivoXMLError, 'No number set for Number' unless body
+        super(body, attributes)
+      end
+    end
+  end
+end

data/lib/plivo/xml/play.rb

@@ -0,0 +1,13 @@
+module Plivo
+  module XML
+    class Play < Element
+      @nestables = []
+      @valid_attributes = %w[loop]
+
+      def initialize(body, attributes = {})
+        raise PlivoXMLError 'No url set for Play' unless body
+        super(body, attributes)
+      end
+    end
+  end
+end

data/lib/plivo/xml/plivo_xml.rb

@@ -0,0 +1,19 @@
+module Plivo
+  module XML
+    class PlivoXML
+      attr_accessor :response
+
+      def initialize(response = nil)
+        response.nil? ? @response = Plivo::XML::Response.new : @response = response
+      end
+
+      def to_xml
+        '<?xml version="1.0" encoding="utf-8" ?>' + @response.to_xml
+      end
+
+      def to_s
+        '<?xml version="1.0" encoding="utf-8" ?>' + @response.to_s
+      end
+    end
+  end
+end

data/lib/plivo/xml/pre_answer.rb

@@ -0,0 +1,12 @@
+module Plivo
+  module XML
+    class PreAnswer < Element
+      @nestables = %w[Play Speak GetDigits Wait Redirect Message DTMF]
+      @valid_attributes = []
+
+      def initialize(attributes = {}, &block)
+        super(nil, attributes, &block)
+      end
+    end
+  end
+end

data/lib/plivo/xml/record.rb

@@ -0,0 +1,17 @@
+module Plivo
+  module XML
+    class Record < Element
+      @nestables = []
+      @valid_attributes = %w[action method timeout finishOnKey
+                             maxLength playBeep recordSession
+                             startOnDialAnswer redirect fileFormat
+                             callbackUrl callbackMethod
+                             transcriptionType transcriptionUrl
+                             transcriptionMethod]
+
+      def initialize(attributes = {})
+        super(nil, attributes)
+      end
+    end
+  end
+end

data/lib/plivo/xml/redirect.rb

@@ -0,0 +1,13 @@
+module Plivo
+  module XML
+    class Redirect < Element
+      @nestables = []
+      @valid_attributes = ['method']
+
+      def initialize(body, attributes = {})
+        raise PlivoError 'No url set for Redirect' unless body
+        super(body, attributes)
+      end
+    end
+  end
+end

data/lib/plivo/xml/response.rb

@@ -0,0 +1,21 @@
+module Plivo
+  module XML
+    class Response < Element
+      @nestables = %w[Speak Play GetDigits Record Dial Message
+                      Redirect Wait Hangup PreAnswer Conference DTMF]
+      @valid_attributes = []
+
+      def initialize
+        super(nil, {})
+      end
+
+      def to_xml
+        super()
+      end
+
+      def to_s
+        super()
+      end
+    end
+  end
+end

data/lib/plivo/xml/speak.rb

@@ -0,0 +1,17 @@
+module Plivo
+  module XML
+    class Speak < Element
+      @nestables = []
+      @valid_attributes = %w[voice language loop]
+
+      def initialize(body, attributes = {})
+        if !body
+          raise PlivoXMLError, 'No text set for Speak'
+        else
+          body = HTMLEntities.new(:html4).encode(body, :decimal)
+        end
+        super(body, attributes)
+      end
+    end
+  end
+end

data/lib/plivo/xml/user.rb

@@ -0,0 +1,13 @@
+module Plivo
+  module XML
+    class User < Element
+      @nestables = []
+      @valid_attributes = %w[sendDigits sendOnPreanswer sipHeaders]
+
+      def initialize(body, attributes = {})
+        raise PlivoXMLError, 'No user set for User' unless body
+        super(body, attributes)
+      end
+    end
+  end
+end

data/lib/plivo/xml/wait.rb

@@ -0,0 +1,12 @@
+module Plivo
+  module XML
+    class Wait < Element
+      @nestables = []
+      @valid_attributes = %w[length silence minSilence beep]
+
+      def initialize(attributes = {})
+        super(nil, attributes)
+      end
+    end
+  end
+end

data/plivo.gemspec

@@ -0,0 +1,44 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'plivo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'plivo'
+  spec.version       = Plivo::VERSION
+  spec.authors       = ['The Plivo SDKs Team']
+  spec.email         = ['sdks@plivo.com']
+
+  spec.summary       = 'A Ruby SDK to make voice calls & send SMS using Plivo '\
+                       'and to generate Plivo XML'
+  spec.description   = 'The Plivo Ruby SDK makes it simpler to integrate '\
+                       'communications into your Ruby applications using the '\
+                       'Plivo REST API. Using the SDK, you will be able to '\
+                       'make voice calls, send SMS and generate Plivo XML to '\
+                       'control your call flows.'\
+                       ''\
+                       'See https://github.com/plivo/plivo-ruby for more information.'
+  spec.homepage      = 'https://github.com/plivo/plivo-ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_dependency 'faraday', '~> 0.9'
+  spec.add_dependency 'faraday_middleware', '~> 0.11.0.1'
+  spec.add_dependency 'htmlentities'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'json'
+  spec.add_development_dependency 'simplecov'
+end

metadata

@@ -1,101 +1,189 @@
 --- !ruby/object:Gem::Specification
 name: plivo
 version: !ruby/object:Gem::Version
-  version: 0.3.19
+  version: 4.0.0.beta.2
 platform: ruby
 authors:
-- Plivo Inc
+- The Plivo SDKs Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-25 00:00:00.000000000 Z
+date: 2017-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: builder
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.7
+        version: 0.11.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 0.11.0.1
+- !ruby/object:Gem::Dependency
+  name: htmlentities
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.7
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.6
-  type: :runtime
+        version: '1.14'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
-    - - ">="
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.6
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: htmlentities
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.3.1
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.3.1
-description: A Ruby gem for interacting with the Plivo Cloud Platform
-email: support@plivo.com
-executables: []
-extensions:
-- ext/mkrf_conf.rb
-extra_rdoc_files:
-- README.md
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The Plivo Ruby SDK makes it simpler to integrate communications into
+  your Ruby applications using the Plivo REST API. Using the SDK, you will be able
+  to make voice calls, send SMS and generate Plivo XML to control your call flows.See
+  https://github.com/plivo/plivo-ruby for more information.
+email:
+- sdks@plivo.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- AUTHORS.md
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
 - README.md
-- ext/mkrf_conf.rb
+- Rakefile
+- bin/console
+- bin/setup
 - lib/plivo.rb
-homepage: http://www.plivo.com
+- lib/plivo/base.rb
+- lib/plivo/base/resource.rb
+- lib/plivo/base/resource_interface.rb
+- lib/plivo/base/response.rb
+- lib/plivo/exceptions.rb
+- lib/plivo/resources.rb
+- lib/plivo/resources/accounts.rb
+- lib/plivo/resources/applications.rb
+- lib/plivo/resources/calls.rb
+- lib/plivo/resources/conferences.rb
+- lib/plivo/resources/endpoints.rb
+- lib/plivo/resources/messages.rb
+- lib/plivo/resources/numbers.rb
+- lib/plivo/resources/pricings.rb
+- lib/plivo/resources/recordings.rb
+- lib/plivo/rest_client.rb
+- lib/plivo/utils.rb
+- lib/plivo/version.rb
+- lib/plivo/xml.rb
+- lib/plivo/xml/conference.rb
+- lib/plivo/xml/dial.rb
+- lib/plivo/xml/dtmf.rb
+- lib/plivo/xml/element.rb
+- lib/plivo/xml/get_digits.rb
+- lib/plivo/xml/hangup.rb
+- lib/plivo/xml/message.rb
+- lib/plivo/xml/number.rb
+- lib/plivo/xml/play.rb
+- lib/plivo/xml/plivo_xml.rb
+- lib/plivo/xml/pre_answer.rb
+- lib/plivo/xml/record.rb
+- lib/plivo/xml/redirect.rb
+- lib/plivo/xml/response.rb
+- lib/plivo/xml/speak.rb
+- lib/plivo/xml/user.rb
+- lib/plivo/xml/wait.rb
+- plivo.gemspec
+homepage: https://github.com/plivo/plivo-ruby
 licenses:
 - MIT
 metadata: {}
@@ -107,16 +195,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: A Ruby gem for communicating with the Plivo Cloud Platform
+summary: A Ruby SDK to make voice calls & send SMS using Plivo and to generate Plivo
+  XML
 test_files: []