Class: UEConnection

Inherits:
Object show all
Defined in:
lib/models/UEConnection.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(connection_name, connection_uri, user) ⇒ UEConnection

Returns a new instance of UEConnection.

Parameters:

  • connection_name (String) —

    the connection identifier

  • connection_uri (String) —

    the connection uri

  • User (User) —

    the User instance of the user owning the connection



9
10
11
12
13
 
# File 'lib/models/UEConnection.rb', line 9

def initialize(connection_name, connection_uri, user)
    @name = connection_name
    @uri = connection_uri
    @user = user
end

Class Method Details

.generate_unique_id ⇒ Object

Used for message parts



31
32
33
 
# File 'lib/models/UEConnection.rb', line 31

def self.generate_unique_id()
    UUIDTools::UUID.timestamp_create.to_s
end

Instance Method Details

#build_message_query(message_options) ⇒ Object

Builds the API message parameter from passed options

Parameters:

  • message_options (Object) —

    options for message

  • message_options.receivers (Array) —

    channels receiving the message

  • message_options.receivers.name (String) —

    channel name (Me | Page)

  • message_options.receivers.id (String) —

    in case of Page, this is the page id

  • message_options.message.subject (String) —

    message subject

  • message_options.message.body (Array) —

    message body

  • message_options.message.image (Array) —

    image uri

  • message_options.message.link (Array) —

    message link

  • message_options.message.link.uri (Array) —

    message link uri

  • message_options.message.link.description (Array) —

    message link description

  • message_options.message.link.title (Array) —

    message link title



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/models/UEConnection.rb', line 53

def build_message_query(message_options)
    throw :RECEIVERS_AND_MESSAGE_REQUIRED if !message_options.key?(:receivers) || !message_options.key?(:message)


    default_content_type = "binary";
    params = message_options
    queryObject = {}

    #Formulate Receivers
    params[:receivers] = params[:receivers].map { |receiver|
        if receiver[:name ] && receiver[:name].downcase == "me"
            {
                name:"Me",
                address:"test.test",
                Connector: @name
            }
        elsif receiver[:name] && receiver[:name].downcase == "page"
            {
                name:"Page",
                address: receiver[:id],
                Connector: @name
            }
        end
    }
    queryObject[:receivers] = params[:receivers];


    #Formulate Message Parts
    queryObject[:parts] = [];
    if params[:message].key?(:body)
        queryObject[:parts].push({
            id: UEConnection.generate_unique_id,
            contentType: default_content_type,
            type: "body",
            data: params[:message][:body],
        })
    end

    #Image Part
    if params[:message].key?(:image)
        queryObject[:parts].push({
            id: UEConnection.generate_unique_id,
            contentType: default_content_type,
            type: "image_link",
            data: params[:message][:image]
        })
    end


    #Link Part
    if params[:message].key?(:link)
        if params[:message][:link][:uri]
            queryObject[:parts].push({
                id: UEConnection.generate_unique_id,
                contentType: default_content_type,
                type: "link",
                data: params[:message][:link][:uri]
            });
        end

        if params[:message][:link][:description]
            queryObject[:parts].push({

                id: UEConnection.generate_unique_id,
                contentType: default_content_type,
                type: "link_description",
                data: params[:message][:link][:description]
            })
        end

        if params[:message][:link][:title]
            queryObject[:parts].push({
                id: UEConnection.generate_unique_id,
                contentType: default_content_type,
                type: "link_title",
                data: params[:message][:link][:title]
            })
        end

    end

    #Subject
    if params[:message][:subject]
        queryObject[:subject ]= params[:message][:subject];
    end


    # $logger.info(queryObject);
    return queryObject;


end

#name ⇒ Object 



19
20
21
 
# File 'lib/models/UEConnection.rb', line 19

def name
  @name
end

#refresh_connection ⇒ Object 



23
24
 
# File 'lib/models/UEConnection.rb', line 23

def refresh_connection()
end

#send_message(message_options) ⇒ Object

Sends a message to service using a connector. A message can have multiple parts each with a different type. eg: One can send a message with 2 parts (image_link, body) to send a message with an image and text

Parameters:

  • message_options (Object) —

    options for message

  • message_options.receivers (Array) —

    channels receiving the message

  • message_options.receivers.name (String) —

    channel name (Me | Page)

  • message_options.receivers.id (String) —

    in case of Page, this is the page id

  • message_options.message.subject (String) —

    message subject

  • message_options.message.body (Array) —

    message body

  • message_options.message.image (Array) —

    image uri

  • message_options.message.link (Array) —

    message link

  • message_options.message.link.uri (Array) —

    message link uri

  • message_options.message.link.description (Array) —

    message link description

  • message_options.message.link.title (Array) —

    message link title



166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/models/UEConnection.rb', line 166

def send_message(message_options)
    response = UERequest.fetch "message/send", {
        user: @user.user_key,
        pass: @user.user_secret,
        form:{
            message: self.build_message_query(message_options)
        }
    }

    response[:URIs] rescue []

end

#user ⇒ Object 



15
16
17
 
# File 'lib/models/UEConnection.rb', line 15

def user
    @user
end