123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304 |
- # Copyright (C) 2012-2015 Zammad Foundation, http://zammad-foundation.org/
- =begin
- fetch tweets from twitter account
- options = {
- adapter: 'twitter',
- auth: {
- consumer_key: consumer_key,
- consumer_secret: consumer_secret,
- oauth_token: armin_theo_token,
- oauth_token_secret: armin_theo_token_secret,
- },
- sync: {
- search: [
- {
- term: '#citheo42',
- group_id: 2,
- },
- {
- term: '#citheo24',
- group_id: 1,
- },
- ],
- mentions: {
- group_id: 2,
- },
- direct_messages: {
- group_id: 2,
- }
- }
- }
- instance = Channel::Driver::Twitter.new
- result = instance.fetch(options, channel)
- returns
- {
- result: 'ok',
- }
- =end
- class Channel::Driver::Twitter
- def fetch (options, channel)
- options = check_external_credential(options)
- # only fetch once a hour
- if Rails.env.production? || Rails.env.development?
- if channel.preferences && channel.preferences[:last_fetch] && channel.preferences[:last_fetch] > Time.zone.now - 1.hour
- return {
- result: 'ok',
- notice: '',
- }
- end
- end
- @rest_client = TweetRest.new(options[:auth])
- @sync = options[:sync]
- @channel = channel
- Rails.logger.debug 'twitter fetch started'
- fetch_mentions
- fetch_search
- fetch_direct_messages
- disconnect
- Rails.logger.debug 'twitter fetch completed'
- {
- result: 'ok',
- notice: '',
- }
- end
- =begin
- instance = Channel::Driver::Twitter.new
- instance.send(
- {
- adapter: 'twitter',
- auth: {
- consumer_key: consumer_key,
- consumer_secret: consumer_secret,
- oauth_token: armin_theo_token,
- oauth_token_secret: armin_theo_token_secret,
- },
- },
- twitter_attributes,
- notification
- )
- =end
- def send(options, article, _notification = false)
- # return if we run import mode
- return if Setting.get('import_mode')
- options = check_external_credential(options)
- @rest_client = TweetRest.new(options[:auth])
- tweet = @rest_client.from_article(article)
- disconnect
- tweet
- end
- def disconnect
- @stream_client.disconnect if @stream_client
- @rest_client.disconnect if @rest_client
- end
- =begin
- create stream endpoint form twitter account
- options = {
- adapter: 'twitter',
- auth: {
- consumer_key: consumer_key,
- consumer_secret: consumer_secret,
- oauth_token: armin_theo_token,
- oauth_token_secret: armin_theo_token_secret,
- },
- sync: {
- search: [
- {
- term: '#citheo42',
- group_id: 2,
- },
- {
- term: '#citheo24',
- group_id: 1,
- },
- ],
- mentions: {
- group_id: 2,
- },
- direct_messages: {
- group_id: 2,
- }
- }
- }
- instance = Channel::Driver::Twitter.new
- stream_instance = instance.stream_instance(channel)
- returns
- instance_of_stream_handle
- =end
- def stream_instance(channel)
- @channel = channel
- options = @channel.options
- @stream_client = TweetStream.new(options[:auth])
- end
- =begin
- stream tweets from twitter account
- stream_instance.stream
- returns
- # endless loop
- =end
- def stream
- hashtags = []
- @channel.options['sync']['search'].each {|item|
- hashtags.push item['term']
- }
- filter = {
- track: hashtags.join(','),
- }
- if @channel.options['sync']['mentions']['group_id'] != ''
- filter[:replies] = 'all'
- end
- @stream_client.client.user(filter) do |tweet|
- next if tweet.class != Twitter::Tweet && tweet.class != Twitter::DirectMessage
- next if Ticket::Article.find_by(message_id: tweet.id)
- # check direct message
- if tweet.class == Twitter::DirectMessage
- if @channel.options['sync']['direct_messages']['group_id'] != ''
- next if @stream_client.direct_message_limit_reached(tweet)
- @stream_client.to_group(tweet, @channel.options['sync']['direct_messages']['group_id'], @channel)
- end
- next
- end
- next if @stream_client.tweet_limit_reached(tweet)
- # check if it's mention
- if @channel.options['sync']['mentions']['group_id'] != ''
- hit = false
- if tweet.user_mentions
- tweet.user_mentions.each {|user|
- if user.id.to_s == @channel.options['user']['id'].to_s
- hit = true
- end
- }
- end
- if hit
- @stream_client.to_group(tweet, @channel.options['sync']['mentions']['group_id'], @channel)
- next
- end
- end
- # check hashtags
- if @channel.options['sync']['search'] && tweet.hashtags
- hit = false
- @channel.options['sync']['search'].each {|item|
- tweet.hashtags.each {|hashtag|
- next if item['term'] !~ /^#/
- if item['term'].sub(/^#/, '') == hashtag.text
- hit = item
- end
- }
- }
- if hit
- @stream_client.to_group(tweet, hit['group_id'], @channel)
- next
- end
- end
- # check stings
- if @channel.options['sync']['search']
- hit = false
- body = tweet.text
- @channel.options['sync']['search'].each {|item|
- next if item['term'] =~ /^#/
- if body =~ /#{item['term']}/
- hit = item
- end
- }
- if hit
- @stream_client.to_group(tweet, hit['group_id'], @channel)
- end
- end
- end
- end
- private
- def fetch_search
- return if !@sync[:search]
- return if @sync[:search].empty?
- @sync[:search].each { |search|
- result_type = search[:type] || 'mixed'
- Rails.logger.debug " - searching for '#{search[:term]}'"
- @rest_client.client.search(search[:term], result_type: result_type).collect { |tweet|
- next if Ticket::Article.find_by(message_id: tweet.id)
- break if @rest_client.tweet_limit_reached(tweet)
- @rest_client.to_group(tweet, search[:group_id], @channel)
- }
- }
- end
- def fetch_mentions
- return if !@sync[:mentions]
- return if @sync[:mentions].empty?
- Rails.logger.debug ' - searching for mentions'
- @rest_client.client.mentions_timeline.each { |tweet|
- next if Ticket::Article.find_by(message_id: tweet.id)
- break if @rest_client.tweet_limit_reached(tweet)
- @rest_client.to_group(tweet, @sync[:mentions][:group_id], @channel)
- }
- end
- def fetch_direct_messages
- return if !@sync[:direct_messages]
- return if @sync[:direct_messages].empty?
- Rails.logger.debug ' - searching for direct_messages'
- @rest_client.client.direct_messages.each { |tweet|
- next if Ticket::Article.find_by(message_id: tweet.id)
- break if @rest_client.direct_message_limit_reached(tweet)
- @rest_client.to_group(tweet, @sync[:direct_messages][:group_id], @channel)
- }
- end
- def check_external_credential(options)
- if options[:auth] && options[:auth][:external_credential_id]
- external_credential = ExternalCredential.find_by(id: options[:auth][:external_credential_id])
- fail "No such ExternalCredential.find(#{options[:auth][:external_credential_id]})" if !external_credential
- options[:auth][:consumer_key] = external_credential.credentials['consumer_key']
- options[:auth][:consumer_secret] = external_credential.credentials['consumer_secret']
- end
- options
- end
- end
|