Posts tagged: passbook

iOS Passbook: an introduction

Passbook è una nuova applicazione presente nell'ultimo rilascio iOS 6 della Apple. In sostanza è una sorta di portafoglio virtuale, che consente di memorizzare coupon, biglietti per il cinema, carte di imbarco, biglietti e altro in modo molto semplice e naturale. I passbook sono interattivi, consentono di visualizzare informazioni sugli oggetti memorizzati, ad esempio il credito residuo, oppure le ultime offerte connesse ad un coupon, o altro. I passbook sono time and location enabled, ovvero è possibile attivarli in prossimità di un punto geografico preciso oppure in un momento ben preciso. Sono memorizzati in locale al device e contengono informazioni essenziali attraverso le quali un'utente può fruire di un oggetto ben preciso. I passbook possono essere aggiornati dinamicamente attraverso il servizio di Push Notification messo a disposizione da Apple, comunicando così variazioni o aggiornamenti in tempo reale. Possono essere distribuiti via email, via web o tramite applicazione.
Per veder decollare del tempo, visto che anche le aziende dovranno supportarlo. L'ultima ad averlo integrato nella propria applicazione è l'app di booking.com….non c'è bisogno che scriva a chi fa riferimento.

Ad ogni modo, quello che a noi interessa è la parte tecnica, vediamo un pò come si fa a creare un Passbook e cosa serve per renderlo interattivo. In questo articolo vedremo una parte di introduzione per farci un'idea. Per creare un'oggetto Passbook è necessario avere:

  • un'identificativo
  • un pass-style
  • informazioni dell'utente
  • immagini, logo e altro
  • location, data e ora

Pass identifier

E' necessario poter distinguere tra un pass e un'altro per questo sono stati introdotti i pass identifier. In generale un'identifier, da diritto all'applicazione di accedere al Passbook tramite la libreria PassKit di iOS.
Esistono diversi tipi di identifier:

Team Identifier

E' un'identificatore stringa di 10 caratteri rilasciato  sul developer portal. Viene utilizzato per recuperare dalla libreria del passbook quello identificato, nel nostro caso, dal teamIdentifier.

 "teamIdentifier" : "DK9N2M2GK6"

Pass Type Identifier

Utilizzato per definire/identificare una classe o una categoria di passbook. Viene rilasciato sul developer portal.

 "passTypeIdentifier" : "it.devme.coupon"

Serial Number Identifier

Utilizzato in congiunzione al pass type identifeer per identificare univocamente e globalmente ciascun passbook. Viene scelto dallo sviluppatore e deve avere una sintassi ben precisa. Vedremo in seguito un caso d'uso che ne chiarisce il funzionamento.  

 "serialNumber" : "B5BD0271-B90B-400D-8344-36A789714CC8"

Come caso d'uso si pensi ad una compagnia aerea che intende distribuire le proprie carte d'imbarco attraverso l'utilizzo dei PassBook. Per ciascuna carta d'imbarco, viene rilasciato un passbook come segue:

 "passTypeIdentifier" : "it.airdevme.boardingpass"

Ciascun passbook deve poter essere univocamente identificato, dal momento che è assegnato a ciascun viaggiatore. Per poter effettuare tale identificazione, si associa al pass type identifier, il serial number, che per semplicità possiamo considerare come:

 "serialNumber" : "001"
 "serialNumber" : "002" 
 "serialNumber" : "003"

Pass Style

Identificato il modo in cui verrà presentato un passbook dal punto di vista grafico. Esistono diverse tipologie di passbook:

  • Coupons
  • Store cards
  • Boarding passes
  • Event tickets
  • Generic

Ogni diverso stile identifica un diverso modello grafico che rappresenterà il passbook sul dispositivo. Ciascun passbook consentirà di inserire le seguenti informazioni per modellare la sua presentazione:

"coupon" : {
     headerFields : ...
     primaryFields : ...
     secondaryFields : ...
     auxilliaryFields : ...
     backFields : ...
     }

Fields

I Fields o informazioni dell'utente, arrichiscono il passbook presentandolo all'utente secondo le informazioni essenziali che lo stesso dovrà presentare. 

"boardingPass": {
    "headerFields" : [ {
		"key": "gate",
		"label": "GATE",
		"value": "82",
		"changeMessage": "Gate changed to %@" 
		}
	],
    "auxiliaryFields" : [ {
		"label" : "DEPARTS",
	}
	],
	"value" : "2012-05-21T12:20:00-07:00",
	"dateStyle" : "PKDateStyleNone",
	"timeStyle" : "PKDateStyleShort"
	"key" : "departs",
   "transitType" : "PKTransitTypeAir"
}

I dati definiti sopra consentono di modellare la carta d'imbarco del nostro esempio. E' facile pensare che le informazioni minime per una carta di imbarco sono il numero del GATE, la data e ora di partenza, eventuli informazioni che devono essere comunicate al viaggiatore.

Color (Immagini logo e altro)

Consente di attribuire un colore al passbook in tutte le sezioni in cui è consentito. Con riferimento al colore di sfondo, colore di primo piano, un colore per l'header, attribuire un logo, un'immagine nell'header, del testo, etc. In generale ci si riferisce a tutte le informazioni di presentazione del passbook.

Location, Data e Ora

E' possibile attribuire ad un Passbook un numero finito di location, ovvero punti di localizzazione, in cui il passbook sarà attivato notificandolo all'utente. Si pensi ad esempio se l'utente si trova in prossimità di un negozio o altro punto di interesse.  E' possibile definire fino a 10 punti di localizzazione nel pass.json. Allo stesso modo è possibile definire una data e un'ora in cui il passbook sarà attivato, proponendo solo in quel momento il passbook all'utente. E' possibile modificare le informazioni sulla localizzazione e sulla data e l'ora anche dopo avere inizializzate. 

"locations" : [
     {
       "longitude" : -122.3748889,
       "latitude" : 37.6189722
     },
     {
       "longitude" : -122.03118,
       "latitude" : 37.33182
     }
   ],
 "relevantDate" : "2011-12-08T13:00-08:00"

L'esempio di sopra inizializza 2 informazioni di localizzazione ed una per data e ora. Nei prossimi articoli vedremo quali servizi è necessario implementare lato server per interagire con i Passbook e quali lato client per gestirne il loro ciclo di vita.

Stay tuned!

RESTEasy: le chiamate rest in Java

In questo piccolo tutorial vedremo come realizzare una piccola chiamata REST verso un servizio remoto, il tutto realizzato in Java. Ricordiamo che le chiamate REST consentono di invocare servizi remoti tramite il protocollo HTTP.
La libreria che ho utilizzato per il supporto alle chiamate REST è RESTEasy la quale oltre al supporto HTTP fornisce il supporto alle annotation JAX-RS. Vediamo subito come procedere. Intanto, utilizzando il vostro IDE preferito (Eclipse ad esempio) create un nuovo progetto e aggiungete le seguente librerie nel build path: 

libraries

Alcune di queste non sono essenziali per la creazione del servizio, ma vi consiglio comunque di lasciarle in modo tale da avere supporto a future implementazioni. Il progetto che sono andato a creare è J2EE installato all’interno di tomcat. Ogni servizio verrà testato da una unit test presente all’interno del progetto stesso, così da verificare la correttezza del servizio. Quindi si parte con la configurazione del nostro web descriptor in modo da configurare il nostro contesto: 

<?xml version="1.0" encoding="UTF-8"?>
 
<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
 
    <display-name>resteasy</display-name>
 
    <listener>
        <listener-class>
            org.jboss.resteasy.plugins.server.servlet.ResteasyBootstrap
        </listener-class>
    </listener>
 
    <servlet>
        <servlet-name>drest</servlet-name>
        <servlet-class>org.jboss.resteasy.plugins.server.servlet.HttpServletDispatcher</servlet-class>
    </servlet>
 
    <servlet-mapping>
        <servlet-name>drest</servlet-name>
        <url-pattern>/restful-services/*</url-pattern>
    </servlet-mapping>
 
    <context-param>
         <param-name>resteasy.scan</param-name>
        <param-value>true</param-value>    
    </context-param>
 
 
    <context-param>
        <param-name>resteasy.servlet.mapping.prefix</param-name>
        <param-value>/restful-services</param-value>
    </context-param>
 
</web-app>

Fatto questo procediamo con la definizione del servizio. Una premessa fondamentale da fare è la seguente: la creazione di un servizio REST richiede una fase di progettazione attenta e puntuale, in cui molti aspetti devono essere tenuti in considerazione e risolti nel migliore dei modi. L’accesso al servizio, l’autenticazione, l’invio dei dati in input e la restituzione del risultato sono tutti aspetti che fanno parte della progettazione di un servizio. Ciò detto, nel nostro esempio, non considereremo la fase di progettazione in tutti i suoi punti, ma procederemo con la creazione di un servizio a scopo di esempio. Definiamo quindi la classe contenitore del nostro servizio attraverso l’utilizzo delle annotation:

@Path("/devmeservice")
public class DevMeService {
 
	@GET
    @Path("/v1/passes/{pass_type_id}/{device_id}")
    @Produces("text/plain")
    public Response getPassLatestVersion(@HeaderParam("Authorization") String authorization,
					   @PathParam("pass_type_id")String pass_type_id,
					   @PathParam("serial_number")String serial_number){
 
		String auth_token = null;
		if (!authorization.matches("^ApplePass.*")) {
			return Response.status(HttpStatus.SC_FORBIDDEN).build();
		}
		String [] items = authorization.split(" ");
		if (items.length!=2) {
			return Response.status(HttpStatus.SC_FORBIDDEN).build();
		}
 
		auth_token = items[1];
 
		String sql = "SELECT * " +
			 "FROM passes " +
			 "WHERE serial_number = ? AND authentication_token = ? LIMIT 1";
		DBHandle dbhandle = DBHandle.getInstance();
		try {
			PreparedStatement ps = dbhandle.getPreparedStatement(sql);
			ps.setString(1, serial_number);
			ps.setString(2, pass_type_id);
			ResultSet rs = ps.executeQuery();
			if (rs.next()) {
				String pass = readFile(/* PASSES ROOT PATH */"/data/passes/"+serial_number+"/pass.json");
 
			}else {
				return Response.status(HttpStatus.SC_UNAUTHORIZED).build();
			}
		} catch (SQLException e) {
			log.error("Error while registering new device.", e);
			return Response.status(HttpStatus.SC_SERVICE_UNAVAILABLE).build();
		} finally {
			dbhandle.close();
		}
		return null;
    }
 
}

Il metodo di sopra restituisce l’ultima versione di un pass (Passbook) associato ad un particolare dispositivo, sulla base di un codice di autorizzazione concesso al client e dei dati associato al pass stesso. Il metodo verifica prima se il client è autorizzato all’accesso al servizio e successivamente tenta di recuperare le informazioni associate al pass e quindi di restituirlo in output.
Si noti l’utilizzo delle annotation in testa alla classe e in testa al nostro metodo, la prima definizione il nome del servizio che dovrà essere invocato, una sorta di base url. Le seconde annotation definiscono il metodo HTTP che viene utilizzato per l’invocazione del metodo, il percorso del servizio ed infine il mime type della risposta fornita dal metodo. Invocando il servizio con un client HTTP saremo in grado di ottenere la risposta da elaborare localmente.

Nei prossimi articoli tratteremo altri contesti in cui utilizzare le chiamate REST, come i Passbook recentemente introdotti dalla Apple come prossima release in iOS6.

Stay tuned!

WordPress Themes