xoxzo-cloudruby 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62d70753656e4100817c7d786f10512777377ede
-  data.tar.gz: 2a3ca357a49b2d2567d6f767fa9d26c0617765ab
+  metadata.gz: 20b8dbe6b4b4c792c3eb918b2283e60401b275f8
+  data.tar.gz: 08fdea29480d7914e54148bb89ddf75e70ca966c
 SHA512:
-  metadata.gz: b6b2a2c892402acc8b4c8d805d884fb096bca341ff82fce99e22b7e85afeff82ea1e72c6939b717e38d3d38b9053e843e80842b78edae706246cc8377a9442dd
-  data.tar.gz: 8bc71724d76199c169b08f1499ff9f9a29f64867961a9243eece4392805c2e81179cbe7e296e2e4a5cfdd24c03b4f8732bb6285707e265b2894266773f9193db
+  metadata.gz: 20fc3388a54f6d939ed36e81063f8e12a3ca614165faf2328e701d6743e615a8e35248cacfa6f482e4c70db70e1e5283ae9b0233859b481568d9e099d57bfed1
+  data.tar.gz: a2b3a224464805ceabc3ed8ffb96527e696a9d88db70b568b00853f6ead4fadd0adcbb7c7eb44dc5103de331fae3a24d8a53fba45f0b934a9b6da5725f92ad9c

data/Makefile

@@ -0,0 +1,2 @@
+all:
+	gem build xoxzo-cloudruby.gemspec

data/README.md

@@ -8,7 +8,7 @@ TODO: Delete this and the text above, and describe your gem
 
 Add this line to your application's Gemfile:
 
-```ruby
+```
 gem 'xoxzo-cloudruby'
 ```
 
@@ -22,7 +22,69 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Sample Code 1
+
+Send SMS
+
+    require 'pp'
+    require 'xoxzo/cloudruby'
+    include Xoxzo::Cloudruby
+    
+    sid = ENV['XOXZO_API_SID']
+    token = ENV['XOXZO_API_AUTH_TOKEN']
+    xc = XoxzoClient.new(sid,token)
+    res = xc.send_sms(message: "Hello! This is Xoxzo!", recipient: "+818012345678", sender: "8108012345678")
+    if res.errors != nil
+      pp res
+      exit -1
+    end
+
+Sample Code 2
+
+Simple Playback
+
+    sid = ENV['XOXZO_API_SID']
+    token = ENV['XOXZO_API_AUTH_TOKEN']
+    xc = XoxzoClient.new(sid,token)
+    res = xc.call_simple_playback(caller:"810812345678",recipient: "+818012345678",recording_url: "http://example.com/example.mp3")
+    if res.errors != nil
+      pp res
+      exit -1
+    end
+    
+    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
+
+Get list of available DINs.
+
+    sid = ENV['XOXZO_API_SID']
+    token = ENV['XOXZO_API_AUTH_TOKEN']
+    xc = XoxzoClient.new(sid,token)
+    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. 
+  
+    res = xc.subscribe_din(din_uid: din_uid)
+
+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.
+
+    res = xc.get_subscription_list()
+    
+Unsubscribe the DIN.
+
+    res = xc.unsubscribe_din(din_uid: din_uid)
 
 ## Development
 
@@ -32,5 +94,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/xoxzo-cloudruby.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/xoxzo/xoxzo-cloudruby.

data/lib/xoxzo/cloudruby.rb

@@ -6,23 +6,38 @@ require 'json'
 module Xoxzo
   module Cloudruby
 
+    # Return object class for Xoxzo Cloud API
     class XoxzoRespose
       def initialize(errors: nil, message: Hash.new, messages: [])
+        # error status, nil if no errors
         @errors = errors
+        # return informaint in hash
         @message = message
+        # retrun information in array
         @messages = messages
       end
       attr_accessor :errors,:message,:messages
     end
 
+    # API obejet class Xoxzo service
     class XoxzoClient
+      # initialize xoxzo api client
+      # sid :: your api sid of Xoxzo account
+      # token :: your api token of Xoxzo account
+      # retrun :: XoxzoRespose
       def initialize(sid,token)
           @auth = {:username => sid, :password => token}
           api_host = "https://api.xoxzo.com"
           @xoxzo_api_sms_url = api_host + "/sms/messages/"
           @xoxzo_api_voice_simple_url = api_host + "/voice/simple/playback/"
+          @xoxzo_api_dins_url = api_host + "/voice/dins/"
       end
 
+      # send sms method
+      # messages :: sms text message
+      # recipient :: sms recipient phone numner eg. "+818012345678", remove first 0 in front of area number
+      # sender :: sem sender phone number. This value may not be displayed as is for some operators.
+      # retrun :: XoxzoRespose
       def send_sms(message:, recipient:, sender:)
         body = {"message" => message , "recipient" => recipient , "sender" => sender}
         res = HTTParty.post(@xoxzo_api_sms_url, :basic_auth => @auth,
@@ -36,6 +51,9 @@ module Xoxzo
         return xr
       end
 
+      # get sms delivery status method
+      # msgid :: message id of in the return value of the send_sms method.
+      # retrun :: XoxzoRespose
       def get_sms_delivery_status(msgid:)
         url = @xoxzo_api_sms_url + msgid
         res = HTTParty.get(url, :basic_auth => @auth)
@@ -47,6 +65,9 @@ module Xoxzo
         return xr
       end
 
+      # get setn sms list method
+      # send_data :: query string. eg. "=2016-05-18"
+      # retrun :: XoxzoRespose
       def get_sent_sms_list(sent_date: nil)
         if sent_date == nil
           url = @xoxzo_api_sms_url
@@ -62,6 +83,11 @@ module Xoxzo
         return xr
       end
 
+      # call simple palyback method
+      # caller :: caller phone number displayed on the recipient hand set
+      # recipient :: sms recipient phone numner eg. "+818012345678", remove first 0 in front of area number
+      # recording_url :: URL of the mp3 file to playback. eg. "http://example.com/example.mp3"
+      # retrun :: XoxzoRespose
       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,
@@ -75,6 +101,9 @@ module Xoxzo
         return xr
       end
 
+      # get simple plaback status method
+      # callid :: call id in the return value of the call_simple_playback method
+      # retrun :: XoxzoRespose
       def get_simple_playback_status(callid:)
         url = @xoxzo_api_voice_simple_url + callid
         res = HTTParty.get(url, :basic_auth => @auth)
@@ -86,6 +115,72 @@ module Xoxzo
         return xr
       end
 
+      def get_din_list(search_string: nil)
+        if search_string == nil
+          url = @xoxzo_api_dins_url
+        else
+          url = @xoxzo_api_dins_url + '?' + search_string
+        end
+        res = HTTParty.get(url, :basic_auth => @auth)
+        if res.code == 200
+          xr = XoxzoRespose.new(message: json_safe_parse(res.body))
+        else
+          xr = XoxzoRespose.new(errors: res.code,message: json_safe_parse(res.body))
+        end
+        return xr
+      end
+
+      def subscribe_din(din_uid:)
+        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'})
+        if res.code == 201
+          xr = XoxzoRespose.new(messages: json_safe_parse(res.body))
+        else
+          xr = XoxzoRespose.new(errors: res.code,message: json_safe_parse(res.body))
+        end
+        return xr
+      end
+
+      def unsubscribe_din(din_uid:)
+        url = @xoxzo_api_dins_url + 'subscriptions/' + din_uid + '/'
+        res = HTTParty.delete(url, :basic_auth => @auth)
+        if res.code == 200
+          xr = XoxzoRespose.new(messages: json_safe_parse(res.body))
+        else
+          xr = XoxzoRespose.new(errors: res.code,message: json_safe_parse(res.body))
+        end
+        return xr
+      end
+
+      def get_subscription_list()
+        url = @xoxzo_api_dins_url + 'subscriptions/'
+        res = HTTParty.get(url, :basic_auth => @auth)
+        if res.code == 200
+          xr = XoxzoRespose.new(messages: json_safe_parse(res.body))
+        else
+          xr = XoxzoRespose.new(errors: res.code,message: json_safe_parse(res.body))
+        end
+        return xr
+      end
+
+      def set_action_url(din_uid:, action_url:)
+        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'})
+        if res.code == 200
+          xr = XoxzoRespose.new(messages: json_safe_parse(res.body))
+        else
+          xr = XoxzoRespose.new(errors: res.code,message: json_safe_parse(res.body))
+        end
+        return xr
+      end
+
+      private
       def json_safe_parse(s)
         return JSON.parse(s)
       rescue JSON::ParserError => e

data/lib/xoxzo/cloudruby/version.rb

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

data/xoxzo-usage.rb

@@ -5,7 +5,7 @@ require 'pp'
 sid = ENV['XOXZO_API_SID']
 token = ENV['XOXZO_API_AUTH_TOKEN']
 xc = XoxzoClient.new(sid,token)
-res = xc.send_sms(message: "Hello! This is Xoxzo!", recipient: "+818054695209", sender: "8108012345678")
+res = xc.send_sms(message: "Hello! This is Xoxzo!", recipient: "+818012345678", sender: "8108012345678")
 if res.errors != nil
   pp res
   return

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xoxzo-cloudruby
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Akira Nonaka
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-24 00:00:00.000000000 Z
+date: 2016-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -79,6 +79,7 @@ files:
 - ".travis.yml"
 - Gemfile
 - LICENSE
+- Makefile
 - README.md
 - Rakefile
 - bin/console