xoxzo-cloudruby 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20b8dbe6b4b4c792c3eb918b2283e60401b275f8
-  data.tar.gz: 08fdea29480d7914e54148bb89ddf75e70ca966c
+  metadata.gz: 594c617a8a9834f06f819038c718dcfce60b9687
+  data.tar.gz: 72b022af8779a53992421034a46cdf4224dd75ad
 SHA512:
-  metadata.gz: 20fc3388a54f6d939ed36e81063f8e12a3ca614165faf2328e701d6743e615a8e35248cacfa6f482e4c70db70e1e5283ae9b0233859b481568d9e099d57bfed1
-  data.tar.gz: a2b3a224464805ceabc3ed8ffb96527e696a9d88db70b568b00853f6ead4fadd0adcbb7c7eb44dc5103de331fae3a24d8a53fba45f0b934a9b6da5725f92ad9c
+  metadata.gz: 3823e61df8fe22310db8e66362d89e7f6dbb9147182ee3d04a953846daea6361a5ae0005fd89950c6b23861351bfddfa179ea571c13a42af5466b1d036b930b2
+  data.tar.gz: 1686a9888e6b25498b3e20a46a3d4ad2c11f0c28b7556f5b405bebbf2cef3d0547d725ff1f593d5b3ed6a747848ac6049f4b51da98d73949cdb7d3056750e0d3

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in xoxzo-cloudruby.gemspec
 gemspec
+
+add_runtime_dependency 'httparty', '~> 0.13', '>= 0.13.7'

data/Makefile

@@ -1,2 +1,5 @@
 all:
-	gem build xoxzo-cloudruby.gemspec
+	gem build xoxzo-cloudruby.gemspec
+
+release:
+	bundle exec rake release

data/README.md

@@ -1,8 +1,6 @@
 # Xoxzo::Cloudruby
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/xoxzo/cloudruby`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+xoxzo-cloudruby is the API wrapper for Xoxzo telephoney cloud API for Ruby.
 
 ## Installation
 
@@ -22,9 +20,9 @@ Or install it yourself as:
 
 ## Usage
 
-Sample Code 1
+## Sample Code 1
 
-Send SMS
+### Send SMS
 
     require 'pp'
     require 'xoxzo/cloudruby'
@@ -38,10 +36,28 @@ Send SMS
       pp res
       exit -1
     end
+    
+    msgid = res.messages[0]['msgid']
+    res = xc.get_sms_delivery_status(msgid: msgid)
+    pp res
+
+#### Explanation
+
++ First, you need to create `XoxzoClient()` object. You must provide xoxzo sid and auth_token when initializing this object. You can get sid and auth_token after you sign up the xoxzo account and access the xoxzo dashboard.
+
++ Then you can call `send_sms()` method. You need to provide three parameters.
 
-Sample Code 2
+  - message: sms text you want to send.
+  - recipient: phone number of the sms recipient. This must start with Japanese country code "+81" and follow the E.164 format.
+  - sender: this number will be displayed on the recipient device.
 
-Simple Playback
++ This method will return `XoxzoResponse` object. If `XoxzoResponse.errors == nil`, `XoxzoResponse.messages[0]['msgid']` is the meesage id that you can pass to the `get_sms_delivery_status()` call.
+
++ You can check the sms delivery status by `get_sms_delivery_status()` method. You will provide message-id of the sms you want to check.
+
+## Sample Code 2
+
+### Simple Playback
 
     sid = ENV['XOXZO_API_SID']
     token = ENV['XOXZO_API_AUTH_TOKEN']
@@ -55,13 +71,24 @@ Simple Playback
     callid = res.messages[0]['callid']
     pp xc.get_simple_playback_status(callid: callid)
         
-    msgid = res.messages[0]['msgid']
-    res = xc.get_sms_delivery_status(msgid: msgid)
-    pp res
-    
-Sample Code 3
+#### Explanation
+
++ You can call `call_simple_playback()` method to playback MP3 files. You need to provide three parameters.
 
-Get list of available DINs.
+  - caller: this number will be displayed on the recipient device.
+  - recording_url: MP3 file URL.
+  - recipient: phone number of the sms recipient. This must start with Japanese country code "+81" and follow the E.164 format.
+
++ This method will return `XoxzoResponse` object. If `XoxzoResponse.errors == nil`, `XoxzoResponse.messages[0]['callid']` is the call id that you can pass to the `get_simple_playback_status()` call.
+
++ You can check the call status by `get_simple_playback_status()` method. You will provide call-id of the phone call you want to check.
+
+
+## Sample Code 3
+
+### DIN (Dial in numbers)
+
+### Get list of available DINs.
 
     sid = ENV['XOXZO_API_SID']
     token = ENV['XOXZO_API_AUTH_TOKEN']
@@ -69,23 +96,44 @@ Get list of available DINs.
     res = xc.get_din_list()
     din_uid = res.message[0]['din_uid'] # get the din unique ID for the frist one for expample
 
-Subscribe a DIN. 
+#### Explanation
+
+1. In order to subscribe DIN, you must find available unsubscribed DINs using get_din_list() method.
+
+### Subscribe a DIN. 
   
     res = xc.subscribe_din(din_uid: din_uid)
 
-Set the action url.
+#### Explanation
+
+1. Then you subscribe a DIN via subscribe_din() method specifying din unique id.
+
+### Set the action url.
     
     dummy_action_url = 'http://example.com/dummy_action'
     res = xc.set_action_url(din_uid: din_uid, action_url: dummy_action_url)
 
-Get the list of subscriptions.
+#### Explanation
+
+1. Once you subscribed the DIN, you can set action url to the DIN. This URL will be called in the event of the DIN gets called.
+The URL will called by http GET method with the parameters, caller and recipient.
+
+### Get the list of subscriptions.
 
     res = xc.get_subscription_list()
+
+#### Explanation
+
+1. In order to get the list of current subscription, you can call the method above.
     
-Unsubscribe the DIN.
+### Unsubscribe the DIN.
 
     res = xc.unsubscribe_din(din_uid: din_uid)
 
+#### Explanation
+
+1. When you no longer use DIN, you can unsubscribe the DIN by specifying the din unique id.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/xoxzo/cloudruby.rb

@@ -41,8 +41,9 @@ module Xoxzo
       def send_sms(message:, recipient:, sender:)
         body = {"message" => message , "recipient" => recipient , "sender" => sender}
         res = HTTParty.post(@xoxzo_api_sms_url, :basic_auth => @auth,
-                            :body => body.to_json,
-                            :headers => { 'Content-Type' => 'application/json', 'Accept' => 'application/json'})
+                            :body => body,
+                            #:debug_output => $stdout,
+                            :headers => { 'Content-Type' => 'application/x-www-form-urlencoded', 'Accept' => 'application/json'})
         if res.code == 201
           xr = XoxzoRespose.new(messages: json_safe_parse(res.body))
         else
@@ -91,8 +92,8 @@ module Xoxzo
       def call_simple_playback(caller:, recipient:, recording_url:)
         body = {"caller" => caller , "recipient" => recipient , "recording_url" => recording_url}
         res = HTTParty.post(@xoxzo_api_voice_simple_url, :basic_auth => @auth,
-                            :body => body.to_json,
-                            :headers => { 'Content-Type' => 'application/json', 'Accept' => 'application/json'})
+                            :body => body,
+                            :headers => { 'Content-Type' => 'application/x-www-form-urlencoded', 'Accept' => 'application/json'})
         if res.code == 201
           xr = XoxzoRespose.new(messages: json_safe_parse(res.body))
         else
@@ -134,8 +135,8 @@ module Xoxzo
         url = @xoxzo_api_dins_url + 'subscriptions/'
         body = {"din_uid" => din_uid }
         res = HTTParty.post(url, :basic_auth => @auth,
-                            :body => body.to_json,
-                            :headers => { 'Content-Type' => 'application/json', 'Accept' => 'application/json'})
+                            :body => body,
+                            :headers => { 'Content-Type' => 'application/x-www-form-urlencoded', 'Accept' => 'application/json'})
         if res.code == 201
           xr = XoxzoRespose.new(messages: json_safe_parse(res.body))
         else
@@ -170,8 +171,8 @@ module Xoxzo
         url = @xoxzo_api_dins_url + 'subscriptions/' + din_uid + '/'
         body = {'action_url': action_url}
         res = HTTParty.post(url, :basic_auth => @auth,
-                            :body => body.to_json,
-                            :headers => { 'Content-Type' => 'application/json', 'Accept' => 'application/json'})
+                            :body => body,
+                            :headers => { 'Content-Type' => 'application/x-www-form-urlencoded', 'Accept' => 'application/json'})
         if res.code == 200
           xr = XoxzoRespose.new(messages: json_safe_parse(res.body))
         else

data/lib/xoxzo/cloudruby/version.rb

@@ -1,5 +1,5 @@
 module Xoxzo
   module Cloudruby
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xoxzo-cloudruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Akira Nonaka
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-20 00:00:00.000000000 Z
+date: 2016-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -113,3 +113,4 @@ signing_key:
 specification_version: 4
 summary: Xoxzo telephony API library
 test_files: []
+has_rdoc: