sipgate_io 0.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b17a778854facd17224ca88b612bae3fef9a52c
+  data.tar.gz: 355292121b876c9892579d2966f89debe73abaf4
+SHA512:
+  metadata.gz: f8788976a23b97d954d8ecf49635f583f8a842e8f5763ca44538eceb5078bca7e6b2c9491510296d8ace41153e7ab29d6888d80cb0cd544dc29031c8e257f2c9
+  data.tar.gz: ff2504faac215e638e8869dd87ef399328229b9d0d57b1cb5f681529d55459e49a198a305286dd5c002280e9b1e4b99e7c70b8f0b26a7027d9b1eb2b6aacaa7f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Chris Schmidt
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SipgateIo'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/sipgate_io/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/javascripts/sipgate_io/events.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/sipgate_io/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/sipgate_io/events.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/sipgate_io/application_controller.rb

@@ -0,0 +1,4 @@
+module SipgateIo
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/sipgate_io/events_controller.rb

@@ -0,0 +1,39 @@
+require_dependency "sipgate_io/application_controller"
+
+module SipgateIo
+  class EventsController < ApplicationController
+    skip_before_action :verify_authenticity_token, raise: false
+
+    def create
+      event_type = params[:event]
+      case event_type
+      when "newCall"
+        event = NewCall.new(params)
+      when "answer"
+        event = Answer.new(params)
+      when "hangup"
+        event = Hangup.new(params)
+      when "dtmf"
+        event = Dtmf.new(params)
+      else
+        head 500 and return
+      end
+      (head 500 and return) if event.invalid?
+
+      answer = process_event event
+      render xml: answer
+    end
+
+    private
+
+    delegate :processor_class, :processor_method, to: :sipgate_io_configuration
+
+    def process_event(event)
+      processor_class.new(event).public_send(processor_method)
+    end
+
+    def sipgate_io_configuration
+      SipgateIo.configuration
+    end
+  end
+end

data/app/helpers/sipgate_io/application_helper.rb

@@ -0,0 +1,4 @@
+module SipgateIo
+  module ApplicationHelper
+  end
+end

data/app/helpers/sipgate_io/events_helper.rb

@@ -0,0 +1,4 @@
+module SipgateIo
+  module EventsHelper
+  end
+end

data/app/views/layouts/sipgate_io/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>SipgateIo</title>
+  <%= stylesheet_link_tag    "sipgate_io/application", media: "all" %>
+  <%= javascript_include_tag "sipgate_io/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/sipgate_io/events/create.html.erb

@@ -0,0 +1,2 @@
+<h1>Events#create</h1>
+<p>Find me in app/views/sipgate_io/events/create.html.erb</p>

data/config/routes.rb

@@ -0,0 +1,4 @@
+SipgateIo::Engine.routes.draw do
+  post 'events/create'
+
+end

data/lib/sipgate_io/answer.rb

@@ -0,0 +1,13 @@
+module SipgateIo
+  class Answer
+    include ActiveModel::Validations
+
+    attr_reader :event, :call_id, :user
+
+    def initialize(params)
+      @event = params[:event]
+      @call_id = params[:callId]
+      @user = params[:user]
+    end
+  end
+end

data/lib/sipgate_io/configuration.rb

@@ -0,0 +1,50 @@
+module SipgateIo
+  @@configuration = nil
+
+  def self.configure
+    @@configuration = Configuration.new
+
+    if block_given?
+      yield configuration
+    end
+
+    configuration
+  end
+
+  def self.configuration
+    @@configuration || configure
+  end
+
+  class Configuration
+    attr_accessor :processor_class, :processor_method, :callback_url
+
+    def processor_class
+      @processor_class ||=
+        begin
+          if Kernel.const_defined?(:EventProcessor)
+            "EventProcessor"
+          else
+            raise NameError.new(<<-ERROR.strip_heredoc, 'EventProcessor')
+              To use SipgateIo, you must either define `EventProcessor` or configure a
+              different processor. See https://github.com/superbilk/sipgate_io#defaults for
+              more information.
+            ERROR
+          end
+        end
+
+      @processor_class.constantize
+    end
+
+    def processor_class=(klass)
+      @processor_class = klass.to_s
+    end
+
+    def processor_method
+      @processor_method ||= :process
+    end
+
+    def callback_url
+      @callback_url ||= :callback_url
+    end
+  end
+end

data/lib/sipgate_io/dtmf.rb

@@ -0,0 +1,13 @@
+module SipgateIo
+  class Dtmf
+    include ActiveModel::Validations
+
+    attr_reader :event, :call_id, :dtmf
+
+    def initialize(params)
+      @event = params[:event]
+      @call_id = params[:callId]
+      @dtmf = params[:dtmf]
+    end
+  end
+end

data/lib/sipgate_io/engine.rb

@@ -0,0 +1,5 @@
+module SipgateIo
+  class Engine < ::Rails::Engine
+    isolate_namespace SipgateIo
+  end
+end

data/lib/sipgate_io/hangup.rb

@@ -0,0 +1,13 @@
+module SipgateIo
+  class Hangup
+    include ActiveModel::Validations
+
+    attr_reader :event, :call_id, :cause
+
+    def initialize(params)
+      @event = params[:event]
+      @call_id = params[:callId]
+      @cause = params[:cause]
+    end
+  end
+end

data/lib/sipgate_io/new_call.rb

@@ -0,0 +1,22 @@
+module SipgateIo
+  class NewCall
+    include ActiveModel::Validations
+
+    attr_reader :to, :from, :direction, :event, :call_id, :users, :diversion
+
+    validates :to, :from, :direction, :event, :call_id, :users, presence: true
+    validates :direction, inclusion: { in: %w(in out) }
+    validates :event, inclusion: { in: %w(newCall) }
+    validates :to, :from, format: { with: /\A\+?[1-9]\d{1,14}\z|\Aanonymous\z/ }
+
+    def initialize(params)
+      @to = params[:to]
+      @from = params[:from]
+      @direction = params[:direction]
+      @event = params[:event]
+      @call_id = params[:callId]
+      @users = params[:user]
+      @diversion = params[:diversion] unless params[:diversion].blank?
+    end
+  end
+end

data/lib/sipgate_io/version.rb

@@ -0,0 +1,3 @@
+module SipgateIo
+  VERSION = "0.1.6"
+end

data/lib/sipgate_io/xml_response.rb

@@ -0,0 +1,86 @@
+require 'builder'
+
+module SipgateIo
+  class XmlResponse
+
+    def self.dial(target, options = nil)
+      self.builder.Response do |b|
+        if target == :voicemail
+          b.Dial { |b| b.Voicemail }
+        elsif options.nil?
+          b.Dial { |b| b.Number(target) }
+        elsif !options[:anonymous].nil?
+          b.Dial(anonymous: true) { |b| b.Number(target) }
+        elsif !options[:caller_id].nil?
+          b.Dial(callerId: options[:caller_id]) { |b| b.Number(target) }
+        end
+      end
+    end
+
+    def self.play(url)
+      self.builder.Response { |b| b.Play { |b| b.Url(url) } }
+    end
+
+    def self.gather(options = nil)
+      options ||= {}
+      options[:type] ||= :dtmf
+      options[:callback_url] ||= SipgateIo.configuration.callback_url
+      options[:max_digits] ||= 1
+      options[:timeout] ||= 1000
+      self.builder.Response do |b|
+        b.Gather(onData: options[:callback_url],
+                 maxDigits: options[:max_digits],
+                 timeout: options[:timeout]) do |b|
+          unless options[:play_url].nil?
+            b.Play { |b| b.Url(options[:play_url]) }
+          end
+        end
+      end
+    end
+
+    def self.reject(reason = nil)
+      self.builder.Response do |b|
+        if reason.nil?
+          b.Reject
+        else
+          b.Reject(reason: reason)
+        end
+      end
+    end
+
+    def self.hangup
+      self.builder.Response { |b| b.Hangup }
+    end
+
+    def self.on_answer
+      self.builder.Response(onAnswer: SipgateIo.configuration.callback_url)
+    end
+
+    def self.on_hangup
+      self.builder.Response(onHangup: SipgateIo.configuration.callback_url)
+    end
+
+    private
+
+    def self.builder
+      b = Builder::XmlMarkup.new(indent: 2)
+      b.instruct!
+      b
+    end
+
+  end
+end
+
+# puts SipgateIo::XmlResponse.gather()
+# puts SipgateIo::XmlResponse.gather(play_url: "http://google.de")
+
+# puts SipgateIo::XmlResponse.play("http://google.de")
+# puts SipgateIo::XmlResponse.dial(:voicemail)
+# puts SipgateIo::XmlResponse.dial("491234567")
+# puts SipgateIo::XmlResponse.dial("491234567", anonymous: true)
+# puts SipgateIo::XmlResponse.dial("491234567", caller_id: "555")
+
+# puts SipgateIo::XmlResponse.reject
+# puts SipgateIo::XmlResponse.reject(:busy)
+# puts SipgateIo::XmlResponse.reject(:rejected)
+# puts SipgateIo::XmlResponse.hangup

data/lib/sipgate_io.rb

@@ -0,0 +1,11 @@
+require "sipgate_io/engine"
+require "sipgate_io/version"
+require "sipgate_io/new_call"
+require "sipgate_io/answer"
+require "sipgate_io/dtmf"
+require "sipgate_io/hangup"
+require "sipgate_io/configuration"
+require "sipgate_io/xml_response"
+
+module SipgateIo
+end

data/lib/tasks/sipgate_io_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :sipgate_io do
+#   # Task goes here
+# end

data/test/controllers/sipgate_io/events_controller_test.rb

@@ -0,0 +1,46 @@
+require 'test_helper'
+
+module SipgateIo
+  class EventsControllerTest < ActionController::TestCase
+    setup do
+      @routes = Engine.routes
+    end
+
+    test "create without params gives 500" do
+      post :create
+      assert_response :error
+    end
+
+    test "a new call" do
+      post :create, { to: "12345",
+                     from: "anonymous",
+                     direction: "in",
+                     event: "newCall",
+                     callId: "55555",
+                     user: ["Bob"]
+                   }
+      assert_response :success
+    end
+
+    test "a new call with missing to/from" do
+      post :create, { direction: "in",
+                     event: "newCall",
+                     callId: "55555",
+                     user: ["Bob"]
+                   }
+      assert_response :error
+    end
+
+    test "a new call with invalid to/from" do
+      post :create, { to: "",
+                     from: "peter",
+                     direction: "in",
+                     event: "newCall",
+                     callId: "55555",
+                     user: ["Bob"]
+                   }
+      assert_response :error
+    end
+
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/event_processor.rb

@@ -0,0 +1,13 @@
+class EventProcessor
+  def initialize(event)
+    @event = event
+  end
+
+  def process
+    puts "#" * 40
+    puts "EventProcessor"
+    puts @event.inspect
+    puts "#" * 40
+    return SipgateIo::XmlResponse.reject
+  end
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,25 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "sipgate_io"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)