Codebase list osrframework / 5315caf osrframework / utils / global_api.py
5315caf

Tree @5315caf (Download .tar.gz)

global_api.py @5315caf — raw · history · blame 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
#!/usr/bin/env python
# encoding: utf-8
#
##################################################################################
#
#    Copyright 2015 Félix Brezo and Yaiza Rubio (i3visio, [email protected])
#
#    This file is part of OSRFramework. You can redistribute it and/or modify
#    it under the terms of the GNU General Public License as published by
#    the Free Software Foundation, either version 3 of the License, or
#    (at your option) any later version.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#
#    You should have received a copy of the GNU General Public License
#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
##################################################################################

import argparse
import json
import csv

import osrframework.utils.config_api_keys as api_keys

class APIWrapper():
    '''
        Global API wrapper.
    '''

    def __init__(self, api_data=None):
        '''
            :param api_data:    dictionary containing the credentials for the given platform.
        '''
        pass        
        
    def get_user(self, screen_name):
        '''
            Method to perform the usufy searches.
                    
            :param screen_name: nickname to be searched.        

            :return:    User.
        '''
        return {}

    def search_users(self, query, n=20, maxUsers=60):
        '''
            Method to perform the searchfy searches.
                    
            :param query:   Query to be performed.
            :param n:   Number of results per query.
            :param maxUsers:    Max. number of users to be recovered.
            
            :return:    List of users.
        '''           
        return []
        
        
    def get_all_docs(self, screen_name):
        '''
            :param screen_name: nick from which we will try to recover the docs, i. e., tweets, publications, etc.
            
            :return:    List of publications, i. e., tweets, publications, etc.            
        '''
        return []