Google Summer of Code Project

https://www.dropbox.com/s/0azhjxjs15r3s8l/vivek_kumar_verma.zip?dl=0

Access an exteral url using php curl

I will start will a working code:

<?php

$handle=curl_init('complete url here');

curl_setopt($handle, CURLOPT_VERBOSE, true);

curl_setopt($handle, CURLOPT_RETURNTRANSFER, true);

curl_setopt($handle, CURLOPT_SSL_VERIFYPEER, false);

$content = curl_exec($handle);

if(!curl_errno($handle))

{

    $info = curl_getinfo($handle);

    echo '<br/> Took ' . $info['total_time'] . ' seconds to send a request to ' . $info['url'];

}

else

{

    echo 'Curl error: ' . curl_error($handle);

}

echo $content;

?>

This will first initialize the handle. Then it is setting properties which will be used to access the webpage.

After that it is checking for errors,if any. And finally it is printing the obtained webpage.

This can be modified a little bit by setting url external to curl_init:

<?php

$ch=curl_init();
$url="url";
curl_setopt($ch,CURLOPT_URL,$url);
curl_setopt($ch, CURLOPT_VERBOSE, true);
curl_setopt($ch,CURLOPT_RETURNTRANSFER,1);
curl_setopt($ch,CURLOPT_CONNECTTIMEOUT,5);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
$curlresult=curl_exec($ch);
curl_close($ch);
echo $curlresult;

?>

Handle oracle cursor in java program

In my previous post, i explained how to create a cursor in pl/sql to be used in the java program.
In this post, i will be showing how to use a cursor inside a java program

First connection can be made using following string
dbConnection= DriverManager.getConnection(
                                                        "jdbc:oracle:thin:@host_name:port_name:sid/service_name", "user_id",
                                                        "password");

This connection can be used to call the function and get cursor reference:
CallableStatement cstmt = dbConnection.prepareCall("{? = call GetRefCursors1.sfGetAccountInterval1}");
after call package_name.function_name is given

cstmt.setFetchSize(500);
This statement will restrict the number of rows to be fetched by the cursor in one run
cstmt.registerOutParameter(1,OracleTypes.CURSOR);
This statement will set the return type as oracle cursor. After this cursor reference will be obtained.
cstmt.executeQuery();

ResultSet rs = (ResultSet)cstmt.getObject(1);
This will be used to traverse the cursor
Data can be obtained from the resultset in following manner:

rs.getInt("id");
rs.getString("from_email_address");
These can be used in any manner required.

Use cursor to fetch data in java

Suppose following table is present in the database:

Queue (id NUMBER(10),email1 VARCHAR2(100), email2 VARCHAR2(100),head VARCHAR2(200),body VARCHAR2(1000));

In the backend package can be defined as 

CREATE OR REPLACE PACKAGE GetRefCursors1 IS

TYPE csGetResultSet is REF CURSOR;

function sfGetAccountInterval1

return csGetResultSet;

end GetRefCursors1;

CREATE OR REPLACE package body GetRefCursors1 is

function sfGetAccountInterval1

return csGetResultSet is

csGetAccounts csGetResultSet;

begin

open csGetAccounts for

SELECT Queue.id,Queue.email1,Queue.email2,Queue.head,Queue.body

FROM Queue

ORDER BY Queue.id ;

return csGetAccounts;

end sfGetAccountInterval1;

end GetRefCursors1;

This function will return a cursor which can be used in the java program to access backend data

#Check next post to get handling of cursor in java program

Send mail using gmail SMTP server

First of all three libraries need to be added in the JDK
jaf-1_1_1.zip,
ojdbc6_g.jar and
javax.mail.jar

javax.mail.jar contains the mail server libraries

Complete working code for sending mail using gmail smtp server
===============================================
package com.javapapers.java;

import java.util.Properties;

import javax.mail.Message;
import javax.mail.MessagingException;
import javax.mail.Session;
import javax.mail.Transport;
import javax.mail.internet.AddressException;
import javax.mail.internet.InternetAddress;
import javax.mail.internet.MimeMessage;
import java.sql.DriverManager;
import java.sql.Connection;
import java.sql.SQLException;

public class JavaEmail {

  Properties emailProperties;
  Session mailSession;
  MimeMessage emailMessage;

  public static void main(String args[]) throws AddressException,
      MessagingException {

    JavaEmail javaEmail = new JavaEmail();

    javaEmail.setMailServerProperties();
    javaEmail.createEmailMessage();
    javaEmail.sendEmail();
  }

  public void setMailServerProperties() {

    String emailPort = "587";//gmail's smtp port

    emailProperties = System.getProperties();
    emailProperties.put("mail.smtp.ssl.trust", "smtp.gmail.com");
    emailProperties.put("mail.smtp.port", emailPort);
    emailProperties.put("mail.smtp.auth", "true");
    emailProperties.put("mail.smtp.starttls.enable", "true");

  }

  public void createEmailMessage() throws AddressException,
      MessagingException {
    String toEmails =  "complete_email_address_of_receiver" ;
    String emailSubject = "Java Email";
    String emailBody = "This is an email sent by <b>JavaMail</b> api.";//here we can add HTML syntax also

    mailSession = Session.getDefaultInstance(emailProperties, null);
    emailMessage = new MimeMessage(mailSession);

   // for (int i = 0; i < toEmails.length; i++) {
      emailMessage.addRecipient(Message.RecipientType.TO, new InternetAddress(toEmails));
 //   }

    emailMessage.setSubject(emailSubject);
    emailMessage.setContent(emailBody, "text/html");//for a html email
    //emailMessage.setText(emailBody);// for a text email

  }

  public void sendEmail() throws AddressException, MessagingException {

    String emailHost = "smtp.gmail.com";
    String fromUser = "gmail_id_of_sender_without_@gmail.com";//just the id alone without @gmail.com
    String fromUserEmailPassword = "password_of_the_gmail_account";

    Transport transport = mailSession.getTransport("smtp");

    transport.connect(emailHost, fromUser, fromUserEmailPassword);
    transport.sendMessage(emailMessage, emailMessage.getAllRecipients());
    transport.close();
    System.out.println("Email sent successfully.");
  }

}



//Enjoy using gmail to make your own mail client

Sphinx extension

Sphinx is a tool to provide a special feature for the documentation of a python project. It can used to test snippets in the documentation, to link to another project's documentation, to add links to highlighted source code, to generate autodoc summaries etc. These can be achieved by some of the inbuilt extensions of the sphinx. Sphinx also provide a facility of third party extension in which a user can write an extension for some specific purpose and can upload the extension in sphinx repository.

Understanding the working of sphinx project
Sphinx project is built in several phases.
In phase0, source files are searched from the source directory and initialization of extension takes place. In phase 1, parsing of the source file takes place leading to the formation of doctree(tree formation by the use of docutils). Separate nodes are created for the directives defined in the extension. In phase 2, the doctree is checked for the formation of proper nodes with proper tagname and classes. In phase 3, the temporary nodes created in phase 1 due to improper data are converted in to nodes which can be converted into output using the meta data obtained in phase 2. In phase 4, output is obtained in desired output format.

Steps in designing of sphinx extension
Basically sphinx extension consists of four main components: Directives, Treenodes, Config files and Event handlers.Each extension consists of a setup function which registers all of these components.
Treenodes can be defined by extending the docutil classes defined in docutils.node . These are the nodes of the doctree formed during step 1 of building of sphinx project. Directives can be derived from docutils.parsers.rst.Directives or sphinx.util.compat.Directives . Config files can be used to decide the behavior extension. Finally the event handler does the main function of the extension. There are a lot of phinx APIs which can be used while writing an extension. Those can be found from http://sphinx-doc.org/ext/appapi.html

Running robot tests from rst test files

Current rst parser of robotframework recognizes just the test cases in rst format inside the rest files.

To run the text cases in rst files, it has to be first extracted into a separate file and run using text parser.

The extraction can be done by two methods, either by using regex or by using docutils.

In implementation using regex, to detect the literal block, some prefix or suffix needs to be added so that it doesn't consider the statements after the literal blocks used in the statements as test cases.
 eg. in the following statement "Create an example ReST-file with multiple ``.. code:: robotframework``
   -parts and figure out," ".code::robotframework" is the literal block, but  " -parts and figure out," should not be confused with the test case.
Also an indication has to be made to inform that test case has ended.
So while using regex a lot of changes has to be made in the predefined format.

So on the safer side, docutils can be used to bring out the txt test cases. This can be done by forming the doctree using docutils. Then each nodes of  the doctree can be traversed to find if the tagname of the node is the desired literal block. If desired tagname is found at any node, the content of that node can be appended in a temporary file. After the completion of traversal, the temporary file contains all the txt test cases present in the rst file. This temporary file can be run using text parser of robot framework.