sipgate_io 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f30b274bab11bd493409b71dfd60537942d7342a
-  data.tar.gz: 332a7828f261fc6609bffb04d6f610d9ea7ef7af
+  metadata.gz: d250a89b7760c16184aafb4a732e0cee508dcf7d
+  data.tar.gz: f5495d6e33dfee38b7325481418cf3450dafbf39
 SHA512:
-  metadata.gz: 629927f349be9610dee7a64fc4c481dd07bfc722d35c725437c8d154b4ebb53a1be4742486f457dd1e7b1726509ad810799fb6c264b1a772f9d1b84e86f012ec
-  data.tar.gz: 7297f3857e245530be42e771391b342b599b3a6c7feb33e3913c65d27fd51a86a7ba2d63ef9a8af9e642ac697a021742372939d972343bfea31e6c8202efa6f5
+  metadata.gz: 386852cee73a88acc8adf787998d72bc8740d6e13660f36cdfcbb57dfabc48020ba093b535bed173add08ae15a1409add364d7cd8896e267da0c4fbc2fd99403
+  data.tar.gz: 20632df508025f91b636bb2878a50d3709fdd334fa0363da5b70f37ed73d00b2de6e99e95fe18ee187d8d655d1e5208943412598a2e294617a3743aac12ff799

data/README.md

@@ -0,0 +1,144 @@
+# gem "sipgate_io"
+[![Gem Version](https://badge.fury.io/rb/sipgate_io.svg)](https://badge.fury.io/rb/sipgate_io)
+[![Build Status](https://travis-ci.org/superbilk/sipgate_io.svg?branch=master)](https://travis-ci.org/superbilk/sipgate_io)
+
+This project rocks and uses MIT-LICENSE.
+
+## Receive realtime call meta data in your Rails app
+
+This gem is a Rails engine that provides an endpoint for sipgate.io that parses these Push-API POSTs and hands off a
+built event object to a class implemented by you.
+
+### sipgate says:
+
+> sipgate.io is sipgate's new Push-API. With sipgate.io booked, we send you call meta data every time someone calls. And when someone picks up. And when someone hangs up.
+
+### Requirement: Account with sipgate
+
+You need an account and phonenumber with sipgate. A free sipgate basic account is sufficient.
+
+* [x] [Create a free sipgate basic account](https://www.sipgate.de/go)
+* [x] [Book the sipgate.io feature](https://www.sipgate.de/go/feature-store/sipgate.io)
+* [x] [Enter an URL for incoming/outgoing calls in the dashboard](https://www.sipgate.de/go/dashboard)
+
+### Have a working example in 5 Minutes
+
+There is a fully working example app included in this gem.
+
+* Have your sipgate account ready (you can create one in a minute, see above)
+* You need [ngrok](https://ngrok.com/) to receive a POST from sipgate on your locale machine
+* Clone this gem `git clone https://github.com/superbilk/sipgate_io.git` and cd into it `cd sipgate_io`
+* Go to app root `cd test/dummy`
+* Make sure all gems are installed `bundle install`
+* Start rails app `rails s`
+* Start ngrok in another terminal `ngrok http 3000` you get a secure forwarding URL like `https://999b1wa06.ngrok.io`
+* Add your forwarding URL to your sipgate account, don't forget to add `/sipgate_io` (`https://999b1wa06.ngrok.io/sipgate_io`). Use the same URL for incoming & outgoing calls
+* Make a phonecall and you will see the call in realtime in your console (the one with the rails server running)
+* Change what happens with the call here [`test/dummy/app/models/event_processor.rb`](https://github.com/superbilk/sipgate_io/blob/master/test/dummy/app/models/event_processor.rb)
+
+You can also check out my complete Rails 5 (beta2) app with ActionCable with a sipgate.io proof of concept. IT' called [callmonitor](https://github.com/superbilk/callmonitor)
+
+## Installation
+
+1. Add `sipgate_io` gem to your application's Gemfile
+   and run `bundle install`.
+
+2. A route is needed for the endpoint which receives `POST` messages. To add the
+   route, in `config/routes.rb` you may either use the provided routing method
+   `mount_sipgate_io` or set the route explicitly. Examples:
+
+   ```ruby
+   # config/routes.rb
+
+   # mount using default path: /sipgate_io
+   mount_sipgate_io
+
+   # mount using a custom path
+   mount_sipgate_io('/call/push')
+
+   # the DIY approach:
+   post '/call_processor' => 'sipgate_io/events#create'
+   ```
+
+### Configuration Options
+
+An initializer can be created to control some of the options in sipgate_io.
+Defaults are shown below with sample overrides following. In
+`config/initializers/sipgate_io.rb`:
+
+```ruby
+SipgateIo.configure do |config|
+  config.processor_class = EventProcessor # CountMyCalls
+  config.processor_method = :process # :add_call (A method on CountMyCalls)
+  config.callback_url = "https://example.org/sipgate_io"
+end
+```
+
+| Option             | Meaning
+| ------             | -------
+| `processor_class`  | The class sipgate.io will use to handle your incoming events.
+| `processor_method` | The method sipgate.io will call on the processor class when handling your incoming events.
+| `callback_url`     | Used for DTMF, on_answer and on_hangup.
+
+By default sipgate.io will look for a class named `EventProcessor`. The class is
+initialized with a event object representing the event, and has a `process` method to actually process the event.
+For example, in `./lib/event_processor.rb`:
+
+```ruby
+class EventProcessor
+  def initialize(event)
+    @event = event
+  end
+
+  def process
+    # all of your application-specific code here - creating models,
+    # processing reports, etc
+    return SipgateIo::XmlResponse.hangup
+  end
+end
+```
+
+Keep in mind, that Rails does NOT autoload files in `lib`. You can conveniently put tis file in `controllers` or `models` - there it is autoloaded.
+
+
+## How to use it
+
+You find the API documentation here: https://github.com/sipgate/sipgate.io
+
+This gem makes the usage a bit more rubiesque. (call_id instead of callId, e.g.)
+
+## Response helper
+
+Your EventProcessor has to decide what to to with an event (hangup this call, forward it to voicemail, ...). You can build your own XML as shown in the sipgate documentation. To make your life easier, there are helper methods you can use.
+
+Here are some examples:
+
+```ruby
+# don't answer that call
+SipgateIo::XmlResponse.reject
+SipgateIo::XmlResponse.reject(reason: :busy)
+SipgateIo::XmlResponse.reject(reason: :rejected)
+SipgateIo::XmlResponse.hangup
+
+# forward that call
+SipgateIo::XmlResponse.dial(target: :voicemail)
+SipgateIo::XmlResponse.dial(target: "491234567", callback: :on_hangup)
+SipgateIo::XmlResponse.dial(target: "491234567", clip: :anonymous)
+SipgateIo::XmlResponse.dial(target: "491234567", clip: "555")
+
+# play an announcement
+SipgateIo::XmlResponse.play(soundfile_url: "http://some.wav", callback: :on_answer)
+
+# wait for DTMF
+SipgateIo::XmlResponse.gather()
+SipgateIo::XmlResponse.gather(soundfile_url: "http://some.wav", timeout: 5000, callback: :on_hangup)
+```
+
+## Testing In Your App
+
+* tba
+
+## Credits
+
+Most of the code is copied fom Griddler by Caleb Thompson and Joel Oliveira / thoughtbot.
+You find the code [here](https://github.com/thoughtbot/griddler)

data/app/controllers/sipgate_io/events_controller.rb

@@ -3,6 +3,7 @@ require_dependency "sipgate_io/application_controller"
 module SipgateIo
   class EventsController < ApplicationController
     skip_before_action :verify_authenticity_token, raise: false
+    before_action :add_response_header
 
     def create
       (head 500 and return) unless params.key?(:event)
@@ -18,6 +19,10 @@ module SipgateIo
 
     private
 
+    def add_response_header
+      response.headers["X-API-Client"] = "sipgate_io-#{SipgateIo::VERSION} (source: https://github.com/superbilk/sipgate_io)"
+    end
+
     def create_event(params)
       event_type = params[:event].clone
       event_type[0] = event_type[0].upcase

data/lib/sipgate_io/version.rb

@@ -1,3 +1,3 @@
 module SipgateIo
-  VERSION = "0.3.1"
+  VERSION = "0.3.3"
 end

data/test/dummy/log/development.log

@@ -112,3 +112,15 @@ Started POST "/sipgate_io" for 217.116.118.254 at 2016-02-12 22:08:57 +0100
 Processing by SipgateIo::EventsController#create as XML
   Parameters: {"event"=>"newCall", "direction"=>"out", "from"=>"4915792303200", "to"=>"498003303000", "callId"=>"1208245019208840124", "user"=>["Christian Schmidt"]}
 Completed 200 OK in 3ms (Views: 0.1ms | ActiveRecord: 0.0ms)
+
+
+Started POST "/sipgate_io" for ::1 at 2016-02-17 19:22:38 +0100
+Processing by SipgateIo::EventsController#create as */*
+  Parameters: {"from"=>"492111234567", "to"=>"4915791234567", "direction"=>"in", "event"=>"newCall", "callId"=>"123456", "user"=>["Alice", "Bob"]}
+Completed 200 OK in 5ms (Views: 0.1ms | ActiveRecord: 0.0ms)
+
+
+Started POST "/sipgate_io" for ::1 at 2016-02-17 19:23:00 +0100
+Processing by SipgateIo::EventsController#create as */*
+  Parameters: {"from"=>"492111234567", "to"=>"4915791234567", "direction"=>"in", "event"=>"newCall", "callId"=>"123456", "user"=>["Alice", "Bob"]}
+Completed 200 OK in 2ms (Views: 0.2ms | ActiveRecord: 0.0ms)