connfu-client 0.1

data/examples/provisioning/twitter/get.rb

@@ -0,0 +1,32 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..', 'lib')
+
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..')
+
+require 'connfu'
+
+require 'examples/provisioning/setup'
+
+ARGV.length < 1 and
+    (
+    puts "Please include as argument the api_key"
+    exit
+    )
+
+api_key = ARGV.shift
+
+channel = if ARGV.length < 1
+                ""
+              else
+                ARGV.shift
+              end
+
+
+application = Connfu::Provisioning::Application.new(api_key, CONNFU_ENDPOINT)
+
+begin
+  puts application.get_twitter_channel(channel)
+rescue Exception => ex
+  puts "There was an error:"
+  puts "Exception message: #{ex.message}"
+end
+

data/examples/provisioning/twitter/put.rb

@@ -0,0 +1,29 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..', 'lib')
+
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..')
+
+require 'connfu'
+
+require 'examples/provisioning/setup'
+
+ARGV.length < 3 and
+(
+  puts "Please include as argument the api_key, the channel and the new topic value to be used"
+  exit
+)
+
+api_key = ARGV.shift
+channel = ARGV.shift
+topic = ARGV.shift
+
+
+application = Connfu::Provisioning::Application.new(api_key, CONNFU_ENDPOINT)
+
+begin
+  puts application.update_voice_channel(channel, topic)
+
+rescue Exception => ex
+  puts "There was an error:"
+  puts "Exception message: #{ex.message}"
+end
+

data/examples/provisioning/voice/create.rb

@@ -0,0 +1,26 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..', 'lib')
+
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..')
+
+require 'connfu'
+
+require 'examples/provisioning/setup'
+
+ARGV.length < 2 and
+(
+  puts "Please include as argument the api_key and the channel name to be used"
+  exit
+)
+
+api_key = ARGV.shift
+channel_name = ARGV.shift
+
+application = Connfu::Provisioning::Application.new(api_key, CONNFU_ENDPOINT)
+
+begin
+  puts application.create_voice_channel(channel_name, "uk")
+rescue Exception => ex
+  puts "There was an error: #{ex.inspect}"
+  puts "Exception message: #{ex.message}"
+end
+

data/examples/provisioning/voice/delete.rb

@@ -0,0 +1,27 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..', 'lib')
+
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..')
+
+require 'connfu'
+
+require 'examples/provisioning/setup'
+
+ARGV.length < 2 and
+(
+  puts "Please include as argument the api_key and channel to be used"
+  exit
+)
+
+api_key = ARGV.shift
+channel = ARGV.shift
+
+
+application = Connfu::Provisioning::Application.new(api_key, CONNFU_ENDPOINT)
+
+begin
+  puts application.delete_voice_channel(channel)
+rescue Exception => ex
+  puts "There was an error:"
+  puts "Exception message: #{ex.message}"
+end
+

data/examples/provisioning/voice/get.rb

@@ -0,0 +1,36 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..', 'lib')
+
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..')
+
+require 'connfu'
+
+require 'examples/provisioning/setup'
+
+ARGV.length < 1 and
+    (
+    puts "Please include as argument the api_key"
+    exit
+    )
+
+api_key = ARGV.shift
+
+channel = if ARGV.length < 1
+                ""
+              else
+                ARGV.shift
+              end
+
+
+Connfu.log_level = Logger::DEBUG
+
+application = Connfu::Provisioning::Application.new(api_key, CONNFU_ENDPOINT)
+
+
+begin
+  app = application.get_voice_channel(channel)
+  p app
+rescue Exception => ex
+  puts "There was an error:"
+  puts "Exception message: #{ex.message}"
+end
+

data/examples/provisioning/voice/phones/create.rb

@@ -0,0 +1,26 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..', '..', 'lib')
+
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..', '..')
+
+require 'connfu'
+
+require 'examples/provisioning/setup'
+
+ARGV.length < 2 and
+(
+  puts "Please include as argument the api_key and the channel name to be used"
+  exit
+)
+
+api_key = ARGV.shift
+channel_name = ARGV.shift
+
+application = Connfu::Provisioning::Application.new(api_key, CONNFU_ENDPOINT)
+
+begin
+  puts application.add_phone(channel_name, "UK")
+rescue Exception => ex
+  puts "There was an error: #{ex.inspect}"
+  puts "Exception message: #{ex.message}"
+end
+

data/examples/provisioning/voice/phones/delete.rb

@@ -0,0 +1,28 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..', '..', 'lib')
+
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..', '..')
+
+require 'connfu'
+
+require 'examples/provisioning/setup'
+
+ARGV.length < 3 and
+(
+  puts "Please include as argument the api_key, the channel and the phone to be deleted"
+  exit
+)
+
+api_key = ARGV.shift
+channel = ARGV.shift
+phone = ARGV.shift
+
+
+application = Connfu::Provisioning::Application.new(api_key, CONNFU_ENDPOINT)
+
+begin
+  puts application.delete_phone(channel, phone)
+rescue Exception => ex
+  puts "There was an error:"
+  puts "Exception message: #{ex.message}"
+end
+

data/examples/provisioning/voice/phones/get.rb

@@ -0,0 +1,38 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..', '..', 'lib')
+
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..', '..')
+
+require 'connfu'
+
+require 'examples/provisioning/setup'
+
+ARGV.length < 2 and
+    (
+    puts "Please include as argument the api_key, the channel and optionally the phone number"
+    exit
+    )
+
+api_key = ARGV.shift
+
+channel = ARGV.shift
+
+number = if ARGV.length < 1
+                ""
+              else
+                ARGV.shift
+              end
+
+
+Connfu.log_level = Logger::DEBUG
+
+application = Connfu::Provisioning::Application.new(api_key, CONNFU_ENDPOINT)
+
+
+begin
+  phones = application.get_phones(channel, number)
+  p phones
+rescue Exception => ex
+  puts "There was an error:"
+  puts "Exception message: #{ex.message}"
+end
+

data/examples/provisioning/voice/put.rb

@@ -0,0 +1,38 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..', 'lib')
+
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..')
+
+require 'connfu'
+
+require 'examples/provisioning/setup'
+
+ARGV.length < 3 and
+(
+  puts "Please include as argument the api_key, the channel and the new topic value to be used"
+  exit
+)
+
+api_key = ARGV.shift
+channel = ARGV.shift
+if ARGV.length.eql?(1)
+  attributes = ARGV.shift
+else
+  if ARGV.length % 2 == 0
+    # create a hash using array values: odd values => key, even values => value
+    attributes = Hash[*ARGV]
+  else
+    puts "Invalid number of arguments"
+    exit
+  end
+end
+
+application = Connfu::Provisioning::Application.new(api_key, CONNFU_ENDPOINT)
+
+begin
+  puts application.update_voice_channel(channel, attributes)
+
+rescue Exception => ex
+  puts "There was an error:#{ex.inspect}"
+  puts "Exception message: #{ex.message}"
+end
+

data/examples/provisioning/voice/whitelist/create.rb

@@ -0,0 +1,26 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..', '..', 'lib')
+
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..', '..')
+
+require 'connfu'
+
+require 'examples/provisioning/setup'
+
+ARGV.length < 4 and
+(
+  puts "Please include as argument the api_key, channel, whitelist name and whitelist number to be used"
+  exit
+)
+
+api_key = ARGV.shift
+channel_name = ARGV.shift
+
+application = Connfu::Provisioning::Application.new(api_key, CONNFU_ENDPOINT)
+
+begin
+  puts application.add_whitelist(channel_name, ARGV.shift, ARGV.shift)
+rescue Exception => ex
+  puts "There was an error:"
+  puts "Exception message: #{ex.inspect}"
+end
+

data/examples/provisioning/voice/whitelist/delete.rb

@@ -0,0 +1,27 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..', '..', 'lib')
+
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..', '..')
+
+require 'connfu'
+
+require 'examples/provisioning/setup'
+
+ARGV.length < 2 and
+    (
+    puts "Please include as argument the api_key and channel to be used"
+    exit
+    )
+
+api_key = ARGV.shift
+channel = ARGV.shift
+number = ARGV.shift
+
+
+application = Connfu::Provisioning::Application.new(api_key, CONNFU_ENDPOINT)
+
+begin
+  puts application.delete_whitelist(channel, number)
+rescue Exception => ex
+  puts "There was an error:"
+  puts "Exception message: #{ex.message}"
+end

data/examples/provisioning/voice/whitelist/get.rb

@@ -0,0 +1,36 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..', '..', 'lib')
+
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..', '..')
+
+require 'connfu'
+
+require 'examples/provisioning/setup'
+
+ARGV.length < 2 and
+(
+  puts "Please include as argument the api_key and the channel to retrieve the whitelist"
+  exit
+)
+
+api_key = ARGV.shift
+
+channel = ARGV.shift
+
+number = if ARGV.length < 1
+                ""
+              else
+                ARGV.shift
+              end
+
+
+
+application = Connfu::Provisioning::Application.new(api_key, CONNFU_ENDPOINT)
+
+begin
+  puts application.get_whitelist(channel, number)
+rescue Exception => ex
+  puts "There was an error:"
+  puts "Exception message: #{ex.message}"
+  puts ex.backtrace
+end
+

data/examples/provisioning/voice/whitelist/put.rb

@@ -0,0 +1,27 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..', '..', 'lib')
+
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..', '..')
+
+require 'connfu'
+
+require 'examples/provisioning/setup'
+
+ARGV.length < 4 and
+(
+  puts "Please include as argument the api_key, channel, whitelist name and whitelist number to be used"
+  exit
+)
+
+api_key = ARGV.shift
+channel_name = ARGV.shift
+
+application = Connfu::Provisioning::Application.new(api_key, CONNFU_ENDPOINT)
+
+begin
+  user = Connfu::Provisioning::WhitelistUser.new(ARGV.shift, ARGV.shift)
+  puts application.update_whitelist(channel_name, user)
+rescue Exception => ex
+  puts "There was an error:"
+  puts "Exception message: #{ex.inspect}"
+end
+

data/lib/connfu.rb

@@ -0,0 +1,134 @@
+##
+# connFu is a platform of Telefonica delivered by Bluevia Labs.
+#
+# Please, check out www.connfu.com and if you need further information
+# contact us at mailto:support@connfu.com
+
+require 'connfu/connfu_logger'
+
+module Connfu
+  include Connfu::ConnfuLogger
+  
+  autoload :ConnfuMessageFormatter, 'connfu/connfu_message_formatter'
+  autoload :ConnfuStream, 'connfu/connfu_stream'
+  autoload :Dispatcher, 'connfu/dispatcher'
+  autoload :DSL, 'connfu/dsl'
+  autoload :Events, 'connfu/events'
+  autoload :Listener, 'connfu/listener'
+  autoload :ListenerChannel, 'connfu/listener_channel'
+  autoload :Provisioning, 'connfu/provisioning'
+
+
+  # connFu provisioning API endpoint
+  CONNFU_ENDPOINT = "https://api.connfu.com/v1"
+  
+  # connFu HTTP streaming API endpoint
+  STREAM_ENDPOINT = "https://stream.connfu.com/"
+
+  class << self
+
+    # The token defines the application that is using the connFu platform.
+    # Get a valid one using connfu portal
+    attr_reader :token
+
+    # Hash that keeps information about the blocks to be executed when a new event is thrown
+    attr_reader :listener_channels
+
+    # Hash that keeps information about the connFu application channels
+    attr_reader :app_channels
+
+    # events dispatcher handler
+    attr_accessor :dispatcher
+
+    # events listener. It gets incoming events and forward them to the dispatcher layer
+    attr_accessor :listener
+
+    ##
+    # This method is used to start a connFu application.
+    # Check the examples folder to find some code snippets.
+    #
+    # ==== Parameters
+    #
+    # * +token+ valid application token got from connfu
+    # * +endpoint+ connFu endpoint (valid provisioning API endpoint)
+    # * +stream_endpoint+ connFu streaming endpoint
+    def application(token, endpoint = CONNFU_ENDPOINT, stream_endpoint = STREAM_ENDPOINT)
+      @token = token
+      @listener_channels = {}
+      @app_channels = []
+      @endpoint = endpoint
+      
+      # set the log level to DEBUG if we are in debug mode
+      $DEBUG and self.log_level=Logger::DEBUG
+
+      logger.info("Starting application with token #{token}")
+
+      # stop if invalid token
+      stream = nil
+      begin
+        app_info = prov_client.get_info
+      rescue RestClient::Unauthorized => ex
+        logger.error("Invalid token provided")
+        logger.error(ex.inspect)
+        raise "Token is invalid"
+      rescue Exception => ex
+        logger.error("Error retrieving application info")
+        logger.error(ex.inspect)
+        raise "Token is invalid"
+      end
+
+      app_info.nil? and raise "Unable to find application data"
+
+      app_stream = app_info.stream_name
+
+      channels = prov_client.get_channels
+
+      # Get the interesting channel data using the channel specific method to_hash
+      @app_channels = channels.map { |channel| channel.to_hash }
+
+      # Duplicate voice channels to sms channels
+      sms = channels.select { |channel| channel.type.eql?("voice") }
+      sms.map!{|channel| channel.type = "sms"; channel.to_hash}
+
+      sms.each{|channel|
+        @app_channels << channel
+      }
+
+      logger.debug "The application #{app_info.name} has these channels: #{@app_channels}"
+
+      if block_given?
+
+        # Load the listening channels defined using the DSL
+        @listener_channels = DSL.run &Proc.new
+        
+        # This Queue will be used by the listener to put events
+        # and by the dispatcher to handle them
+        events = Connfu::Events.new
+        
+        # Start the dispatcher
+        @dispatcher = Connfu::Dispatcher.new(events, self.listener_channels, self.app_channels)
+        @dispatcher.start
+
+        # Start the listener
+        @listener = Connfu::Listener.new(events, app_stream, token, stream_endpoint)
+        @listener.start
+        
+        @listener.join # wait for incoming events
+        @dispatcher.join
+      end
+
+      # Return the module
+      self
+    end
+
+    private
+
+    ##
+    # Provisioning client to retrieve application valid streams
+    def prov_client
+      # create client instance to retrieve valid streams
+      @prov_client ||= Connfu::Provisioning::Application.new(@token, @endpoint)
+    end
+
+  end
+end