Merge pull request #1 from FRReinert/dev

Dev

Author: FRReinert

.project

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>PySSRS</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.python.pydev.PyDevBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.python.pydev.pythonNature</nature>
+	</natures>
+</projectDescription>

.pydevproject

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<?eclipse-pydev version="1.0"?><pydev_project>
+<pydev_property name="org.python.pydev.PYTHON_PROJECT_INTERPRETER">Default</pydev_property>
+<pydev_property name="org.python.pydev.PYTHON_PROJECT_VERSION">python 2.7</pydev_property>
+</pydev_project>

.settings/org.eclipse.core.resources.prefs

@@ -0,0 +1,9 @@
+eclipse.preferences.version=1
+encoding//SSRS/__init__.py=utf-8
+encoding//samples/FindItem.py=utf-8
+encoding//samples/GetParameters.py=utf-8
+encoding//samples/ListDir.py=utf-8
+encoding//samples/ListMethods.py=utf-8
+encoding//samples/__init__.py=utf-8
+encoding//samples/connection_data.py=utf-8
+encoding//samples/context.py=utf-8

README.md

@@ -1,2 +1,80 @@
 # PySSRS
 Microsoft Reporting Services (SSRS) RPC trough SOAP
+
+## Installation
+You just need to run ```pip install PySSRS```
+
+### Connecting to SSRS
+You can use it as a facilitator to make SOAP RPCs.
+For example:
+```python
+
+From SSRS import SSRS
+
+RS = SSRS('localhost', 'user@domain.com', '@paswd2017')
+result = RS.client.service.ListChildren(dir, recursive)
+
+for item in result.CatalogItem:
+  print(item['Name'])
+```
+
+### Available Functions
+We implemented some functions to make it easy to use. Feel free to check their usage on the  **samples** folder.
+
+These functions are available by now:
+
+Function      | Objective                      | Return Type
+--------------|--------------------------------|------------
+ListMethods() | List all SOAP procedures | List []
+DirItems() | List all objects in a directory | Dictionary {}
+Find() | Find for a item by it's name | Dictionary {}
+GetParameters() | Return all parameters from a Report object | Dictionary {}
+
+### Snippet
+
+Check this small code, it's an sample of usage
+
+```python
+# Conneting to SSRS SOAP server
+
+wsdl = 'http://localhost/ReportinServices/ReportService2010.asmx?wsdl'
+user = 'user@domain.com
+psw  = '@password2017'
+
+RS = SSRS(wsdl, user, psw)
+
+'''
+Return a LIST with all available SOAP procedures
+so you can iterate over them...
+'''
+Methods = RS.ListMethods()
+
+'''
+Return a DICTIONARY with all items in a specific folder
+you can also use the <recursive> parameter to scan subfolders.
+If you don't specify the <dir> parameter it'll take the root ('/') as default
+'''
+DirItems = RS.ListDirItems(dir='/MyReports', recursive=True)
+
+'''
+Find() will retrieve a list of items which the name matches with the <text> parameter.
+It's recursive, you don't need to specify any folder and you can also specify the object type that you want
+by using the <objtype> parameter.
+
+Those are the accepted types of objects
+            -> Component 
+            -> DataSource 
+            -> Folder
+            -> Model
+            -> LinkedReport
+            -> Report
+            -> Resource
+            -> DataSet
+            -> Site
+            -> Unknown
+'''
+ItemsFound = RS.Find(text="Sales", objtype="Report")
+
+#GetParameters() will retrieve a list of paremeters for the report on the specific path
+Parameters = RS.GetParameters(path='/MyReports/SalesOrder')
+```

SSRS/__init__.py

@@ -0,0 +1,166 @@
+# -*- coding: utf-8 -*-
+
+from suds.client import Client
+from suds.sax.text import Text
+from suds.transport.http import HttpAuthenticated
+import logging as log
+import sys
+
+class SSRS():
+    '''
+    Create a SOAP connection to a SSRS (Microsoft Reporting Services)
+
+    Example of usage on SSRS 2008:
+        RS = SSRS(host='http://localhost/ReportinServices/ReportService2010.asmx?wsdl', user:'user@domain.com', key_password='myfreakingpassword')
+
+    '''
+
+    def __init__(self, host='http://localhost/reportserver/ReportService2010.asmx?wsdl', user='SEPTODONT\admin', key_password='admin', verbose=True):
+        
+        self.verbose = verbose 
+        credentials  = dict(username=user, password=key_password)          
+        credentials  = HttpAuthenticated(**credentials)
+        log.basicConfig(filename='SSRS.log', level=log.INFO)
+        
+        try:
+            self.client = Client(host, transport=credentials)
+        
+        except BaseException as e:        
+           
+            msg = "Could not connect to %s with user %s: %s" % (host, user, str(e))
+            log.error(msg)          
+        
+            if self.verbose:            
+                print(msg)
+                
+            exit() 
+                
+            
+    def ListMethods(self):
+        '''
+        Return the list of methods available for your SSRS version
+        '''
+        try:
+            list_of_methods = [method for method in self.client.wsdl.services[0].ports[0].methods]
+            return list_of_methods
+
+        except BaseException as e:
+
+            msg = "ListMethod() Could not retrieve the methods: %s" % (str(e))            
+            log.error(msg)            
+            
+            if self.verbose:                
+                print(msg)
+                
+            return False
+
+    
+    def ListDirItems(self, dir=r'/', recursive=False):
+        '''
+        List all itens in a folder. 
+        if specified the <recursive> parameter, subfolders will be scanned too
+        '''
+
+        try:
+            it = self.client.service.ListChildren(dir, recursive)
+            it = it.CatalogItem
+
+        except BaseException as e:
+            msg = "ListDirItems() Could not retrieve the Objects: %s" % (str(e))    
+            log.error(msg)
+            
+            if self.verbose:     
+                print(msg)
+                
+            return False
+
+        catalog_dict = {}
+        
+        for item in it:
+            catalog_dict[item['ID']] = {
+                    'Name'          : item['Name'],
+                    'Path'          : item['Path'],
+                    'TypeName'      : item['TypeName'],
+                    'CreationDate'  : item['CreationDate'],
+                    'ModifiedDate'  : item['ModifiedDate'],
+                    'CreatedBy'     : item['CreatedBy'],
+                    'ModifiedBy'    : item['ModifiedBy'],
+                    'ItemMetadata'  : item['ItemMetadata'],
+                }
+        
+        return catalog_dict
+        
+    
+    def Find(self, text, objtype=None):       
+        '''
+        Find objects on SSRS 
+        '''
+        
+        try: 
+            it = self.ListDirItems(recursive=True)
+            if isinstance(it, Text):
+                return dict(it)
+                
+        
+        except BaseException as e:
+            msg = "Find() Could not retrieve the Objects: %s" % (str(e))    
+            log.error(msg)
+            
+            if self.verbose:     
+                print(msg)  
+                
+            return False
+        
+        catalog_dict = {}
+        for key, value in it.items() :
+            for word in value.values():
+                if text in str(word):
+                    if objtype == None:
+                        catalog_dict[key] = value
+                        
+                    else:
+                        if it[key]['TypeName'] == objtype:
+                            catalog_dict[key] = value
+        
+        return catalog_dict
+    
+    
+    def GetParameters(self, path):
+        '''
+        Retrieve parameters from an SSRS Report
+        '''
+        
+        try:
+            it = self.client.service.GetItemParameters(path, None, True, None, None)
+            if isinstance(it, Text):
+                return dict(it)
+            
+        except BaseException as e:
+            msg = "GetParameters() Could not retrieve the parameters: %s" % str(e)    
+            log.error(msg)
+            
+            if self.verbose:     
+                print(msg)  
+                
+            return False        
+       
+        param_dict = {}
+        for item in it.ItemParameter:
+            param_dict[item['Name']] = {
+                 'ParameterTypeName'        : item['ParameterTypeName'],
+                 'Nullable'                 : item['Nullable'],
+                 'AllowBlank'               : item['AllowBlank'],
+                 'MultiValue'               : item['MultiValue'],
+                 'QueryParameter'           : item['QueryParameter'],
+                 'Prompt'                   : item['Prompt'],
+                 'PromptUser'               : item['PromptUser'],
+                 'ValidValuesQueryBased'    : item['ValidValuesQueryBased'],
+                 'DefaultValuesQueryBased'  : item['DefaultValuesQueryBased'],
+            }
+        
+        return param_dict
+
+        
+        
+        
+        

samples/FindItem.py

@@ -0,0 +1,41 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+import connection_data as d
+import context
+from SSRS import SSRS
+
+RS = SSRS(d._host, d._user, d._psw)
+result = RS.Find(text='OP', objtype='Report')
+
+if result:
+    print(
+        '''
+        This method will search for any property value that matches with the parameter <text>
+        It'll match if any property value of the object CONTAINS the <text> value
+        
+        You can also specify the type of the object by using the <objtype> parameter as a string
+        
+        Types accepted:
+            -> Component 
+            -> DataSource 
+            -> Folder
+            -> Model
+            -> LinkedReport
+            -> Report
+            -> Resource
+            -> DataSet
+            -> Site
+            -> Unknown
+            
+        if you leave the <text> parameter blank it'll retrieve all objects (respecting the <objtype> parameter)
+        '''
+    )
+    
+    for key, value in result.items() :
+        print('ID:', key)
+        
+        for key2, value2 in value.items():
+            print(key2,':', value2)
+        
+        print('\n')

samples/GetParameters.py

@@ -0,0 +1,34 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+import connection_data as d
+import context
+from SSRS import SSRS
+
+RS      = SSRS(d._host, d._user, d._psw)
+result  = RS.GetParameters('/Qualidade/Indice de Conformidade')
+
+print(
+        '''
+        Get Parameters linked to a specific report.
+        
+        Available Parameters:
+                ParameterTypeName
+                Nullable
+                AllowBlank      
+                MultiValue      
+                QueryParameter  
+                Prompt       
+                PromptUser
+                ValidValuesQueryBased
+                DefaultValuesQueryBased
+        '''
+    )
+
+for key, value in result.items() :
+    print('Name:', key)
+    
+    for key2, value2 in value.items():
+        print(key2,':', value2)
+    
+    print('\n')