Class: XStreamly::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/xstreamly.rb

Instance Method Summary collapse

Constructor Details

#initialize(appKey, email, password) ⇒ Client

Returns a new instance of Client.



11
12
13
14
15
16
17
 
# File 'lib/xstreamly.rb', line 11

def initialize(appKey,email,password)
  @appKey = appKey
  @email = email
  @password = password
  @http = Net::HTTP.new('api.x-stream.ly', 443)
  @http.use_ssl = true
end

Instance Method Details

#activeChannels ⇒ Object 



146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/xstreamly.rb', line 146

def activeChannels()
  req = Net::HTTP::Get.new(URI.encode('/api/v1.1/'+@appKey+'/activeChannels'), initheader = {'Content-Type' =>'application/json'})
 req.basic_auth @email, @password
 response = @http.request(req)
  
  case response.code.to_i
    when 200..299
      return (JSON(response.body))['channels']
    else 
      raise RuntimeError, "Unknown error (status code #{response.code} ): #{response.body}"
  end
end

#createToken(read = true, write = true, channel = nil, event = nil, source = nil, isPrivate = false) ⇒ Object 



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/xstreamly.rb', line 198

def createToken(read=true,write=true,channel=nil,event=nil,source=nil,isPrivate=false)
  req = Net::HTTP::Post.new(URI.encode('/api/v1.1/'+@appKey+'/security'), initheader = {'Content-Type' =>'application/json'})
 req.basic_auth @email, @password
 data = {}
 if(read && write)
   # don't set the value then
  elsif (read)
    data['action']='read|view'
  elsif (write)
    data['action']='write|view'
  else
    data['action']='view'
  end
  
  if(!channel.nil?)
    data['channel']=channel
  end
  
  if(!event.nil?)
    data['event']=event
  end
  
  if(!source.nil?)
    data['source']=source
  end
  
  data['private']=isPrivate
 
 req.body = data.to_json
 
 puts req.body
 
 response = @http.request(req)
  
  case response.code.to_i
    when 200..299
      return response.body
    else 
      raise RuntimeError, "Unknown error (status code #{response.code} ): #{response.body}"
  end
end

#deleteToken(token) ⇒ Object 



240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/xstreamly.rb', line 240

def deleteToken(token)
  req = Net::HTTP::Delete.new(URI.encode('/api/v1.1/'+@appKey+'/security/'+token), initheader = {'Content-Type' =>'application/json'})
 req.basic_auth @email, @password
 response = @http.request(req)
  
  case response.code.to_i
    when 200..299
      return true
    else 
      raise RuntimeError, "Unknown error (status code #{response.code} ): #{response.body}"
  end
end

#generateRequestData(trackParameter, consumerKey, consumerSecret, accessToken, accessTokenSecret) ⇒ Object 



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
 
# File 'lib/xstreamly.rb', line 90

def generateRequestData(trackParameter,consumerKey,consumerSecret,accessToken,accessTokenSecret)
  #generate a random nonce
  nonce  =(0...10).map{65.+(rand(25)).chr}.join
  timestamp = (Time.now.to_i).to_s
  track = CGI.escape(trackParameter)
  
  base = "POST&https%3A%2F%2Fstream.twitter.com%2F1%2Fstatuses%2Ffilter.json&" +
    "oauth_consumer_key%3D" + consumerKey +
    "%26oauth_nonce%3D"+nonce +
    "%26oauth_signature_method%3DHMAC-SHA1%26oauth_timestamp%3D" + timestamp +
    "%26oauth_token%3D" + accessToken +
    "%26oauth_version%3D1.0"+ 
    "%26track%3D" +CGI.escape(track)
    
  key = consumerSecret +'&'+CGI.escape(accessTokenSecret);
  
  digest  = OpenSSL::Digest::Digest.new('sha1')
  signature=CGI.escape(Base64.encode64(OpenSSL::HMAC.digest(digest,key,base)).strip)
  
  requestData = "oauth_signature=" + signature +
    "&oauth_token=" + accessToken +
    "&track=" + track +
    "&oauth_consumer_key=" + consumerKey +
    "&oauth_signature_method=HMAC-SHA1&oauth_version=1.0" +
    "&oauth_nonce=" + nonce +
    "&oauth_timestamp=" + timestamp
  
  return requestData
end

#getCallbacks ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/xstreamly.rb', line 62

def getCallbacks()
  req = Net::HTTP::Get.new(URI.encode('/api/v1.1/'+@appKey+'/feeds/out/custom'), initheader = {'Content-Type' =>'application/json'})
 req.basic_auth @email, @password
 response = @http.request(req)
  
  case response.code.to_i
    when 200..299
      return (JSON(response.body))['items']
    else 
      raise RuntimeError, "Unknown error (status code #{response.code} ): #{response.body}"
  end
end

#getTokens ⇒ Object 



185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/xstreamly.rb', line 185

def getTokens()
  req = Net::HTTP::Get.new(URI.encode('/api/v1.1/'+@appKey+'/security'), initheader = {'Content-Type' =>'application/json'})
 req.basic_auth @email, @password
 response = @http.request(req)
  
  case response.code.to_i
    when 200..299
      return (JSON(response.body))['sessions']
    else 
      raise RuntimeError, "Unknown error (status code #{response.code} ): #{response.body}"
  end
end

#getTwitterStreams ⇒ Object 



133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/xstreamly.rb', line 133

def getTwitterStreams()
  req = Net::HTTP::Get.new(URI.encode('/api/v1.1/'+@appKey+'/feeds/in/twitter'), initheader = {'Content-Type' =>'application/json'})
 req.basic_auth @email, @password
 response = @http.request(req)
  
  case response.code.to_i
    when 200..299
      return (JSON(response.body))['items']
    else 
      raise RuntimeError, "Unknown error (status code #{response.code} ): #{response.body}"
  end
end

#removeCallback(index) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/xstreamly.rb', line 49

def removeCallback(index)
  req = Net::HTTP::Delete.new(URI.encode('/api/v1.1/'+@appKey+'/feeds/out/custom/'+index.to_s), initheader = {'Content-Type' =>'application/json'})
 req.basic_auth @email, @password
  response = @http.request(req)
  
  case response.code.to_i
    when 200..299
      return true
    else 
      raise RuntimeError, "Unknown error (status code #{response.code} ): #{response.body}"
  end
end

#removeTwitterStream(index) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/xstreamly.rb', line 120

def removeTwitterStream(index)
  req = Net::HTTP::Delete.new(URI.encode('/api/v1.1/'+@appKey+'/feeds/in/twitter/'+index.to_s), initheader = {'Content-Type' =>'application/json'})
 req.basic_auth @email, @password
  response = @http.request(req)
  
  case response.code.to_i
    when 200..299
      return true
    else 
      raise RuntimeError, "Unknown error (status code #{response.code} ): #{response.body}"
  end
end

#send(channel, eventName, data, persisted = false) ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/xstreamly.rb', line 19

def send(channel, eventName, data,persisted = false)
 req = Net::HTTP::Post.new(URI.encode('/api/v1.1/'+@appKey+'/channels/'+channel+'/events/'+eventName+'?persisted='+persisted.to_s), initheader = {'Content-Type' =>'application/json'})
 req.basic_auth @email, @password

 req.body = data
 response = @http.request(req)
 result = response.code.to_i
  case result
      when 200..299
        return true
      else 
        raise RuntimeError, "Unknown error (status code #{result}): #{response.body}"
      end
end

#setCallback(channel, endPoint, secret, eventName) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/xstreamly.rb', line 34

def setCallback(channel,endPoint,secret,eventName)
  req = Net::HTTP::Post.new(URI.encode('/api/v1.1/'+@appKey+'/feeds/out/custom'), initheader = {'Content-Type' =>'application/json'})
 req.basic_auth @email, @password

 req.body = '{"channel":"'+channel+'","endpoint":"'+endPoint+'", "secret":"'+secret+'", "event": "'+eventName+'"}'
 response = @http.request(req)
      
  case response.code.to_i
    when 200..299
      return response.body
    else 
      raise RuntimeError, "Unknown error (status code #{response.code} ): #{response.body}"
  end
end

#setTwitterStream(channel, event, requestData) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/xstreamly.rb', line 75

def setTwitterStream(channel,event,requestData)
  req = Net::HTTP::Post.new(URI.encode('/api/v1.1/'+@appKey+'/feeds/in/twitter'), initheader = {'Content-Type' =>'application/json'})
 req.basic_auth @email, @password

 req.body = '{"channel":"'+channel+'","event":"'+event+'", "requestData":"'+requestData+'"}'
 response = @http.request(req)
      
  case response.code.to_i
    when 200..299
      return response.body
    else 
      raise RuntimeError, "Unknown error (status code #{response.code} ): #{response.body}"
  end
end

#usageConnections ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/xstreamly.rb', line 159

def usageConnections()
  req = Net::HTTP::Get.new(URI.encode('/usage/connections'), initheader = {'Content-Type' =>'application/json'})
 req.basic_auth @email, @password
 response = @http.request(req)
  
  case response.code.to_i
    when 200..299
      return (JSON(response.body))['data']
    else 
      raise RuntimeError, "Unknown error (status code #{response.code} ): #{response.body}"
  end
end

#usageMessages ⇒ Object 



172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/xstreamly.rb', line 172

def usageMessages()
  req = Net::HTTP::Get.new(URI.encode('/usage/messages'), initheader = {'Content-Type' =>'application/json'})
 req.basic_auth @email, @password
 response = @http.request(req)
  
  case response.code.to_i
    when 200..299
      return (JSON(response.body))['data']
    else 
      raise RuntimeError, "Unknown error (status code #{response.code} ): #{response.body}"
  end
end