fidor_starter_kits 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cdb8b69552898f7064d5809486b5d0626e1692ea
-  data.tar.gz: 4edd4bda246051c1195cb7e2b78a542d8544117d
+  metadata.gz: cadf95388bb8c66509a1fe4bb7f97a602ed97336
+  data.tar.gz: eba96a1ff9e37cc594a8515464b597e0d9f00eea
 SHA512:
-  metadata.gz: 112725ce81cb35fae7d13355e54ac09125cd1e2fd98991e75bb8a4337a15f747f95ba03ab3edfd7154205749920e57fc834dfa195322483953b97fe5cfa2235b
-  data.tar.gz: 87c863028b83ffd22097bfbd3303caa96611eb3e89cf875f64331340024216f8ef772b03ffca6025e6fd0b7c0061dce133587fd36e672c1fddc206dd5b4b3224
+  metadata.gz: 0c74727119b8ec44167a91fcbebd587931d124ee2b5754ce8559f6059077f059277e35eeaf2a990e0fd929b8bee84bedc984473e4a1a764bdc5d5781f5a3aa23
+  data.tar.gz: 524b14ea5fee55c16565133a04cd848134bba62c966a4be79261acb3f05cce3a1c69925e1cbd069e9670883f9cc9868f48734728a051faa8c6c10d96c9e320b1

data/README.md

@@ -3,7 +3,7 @@
 This repo features fidor application examples. The apps use oAuth to 
 authenticate with fidor, so you must register an app at fidor first to get your 
 personal app credentials. 
-Afterwards just copy on of the /starter_kits, add your app credentials to the 
+Afterwards just copy one of the /starter_kits, add your app credentials to the 
 example source and start to play.
 
 For Ruby Heros, this repo is also available as ruby gem and provides a tiny 

data/lib/fidor_starter_kits/version.rb

@@ -1,3 +1,3 @@
 module FidorStarterKits
-  VERSION = '0.1.3'
+  VERSION = '0.2.0'
 end

data/lib/fidor_starter_kits.rb

@@ -2,6 +2,7 @@ require 'fidor_starter_kits/version'
 require 'fileutils'
 require 'tmpdir'
 require 'zip'
+require 'json'
 
 module FidorStarterKits
 
@@ -31,7 +32,7 @@ module FidorStarterKits
     # @return [Nil | String] path to zipped example im /tmp folder or nil if app does not exists
     def build(opts)
       app_name = opts[:app_name]
-      return if !app_name || !exists?(app_name) || !app_name.in?(STARTER_KITS)
+      return if !app_name || !exists?(app_name) || !(STARTER_KITS).include?(app_name)
 
       # move example to a safe location
       example_src_path = File.join(path, app_name)
@@ -59,5 +60,29 @@ module FidorStarterKits
       zip_file_path
     end
 
+    def all
+      @conf ||= {}
+      return @conf unless @conf.length == 0
+
+      STARTER_KITS.each do |kit|
+        base = File.join(path, kit)
+        meta = File.join(base, ".fidor_meta.json")
+        if File.exists? meta
+          File.open(meta) {|f| @conf[kit] = JSON.parse(f.read)}
+        else
+          @conf[kit] = "meh"   
+        end
+      end
+      return @conf
+    end
+
+    def get app_name
+      all[app_name]
+    end
+
+    def each 
+      all.each_value { |conf| yield conf } 
+    end
+
   end
 end

data/spec/fidor_starter_kits_spec.rb

@@ -48,4 +48,20 @@ describe FidorStarterKits do
       expect( content ).to include 'fidor-oauth-url'
     end
   end
-end
+
+  describe '.all' do 
+    it 'lists all starter kits' do
+      expect(FidorStarterKits.all.count).to eq(FidorStarterKits::STARTER_KITS.size)
+    end
+
+    it 'loads the json meta data' do
+      conf = FidorStarterKits.all
+      expect(conf["golang_plain"]["display_name"]).to eq("Go Plain")
+      expect(conf["node_tx"]["description"]).to eq("A simple nodejs based app, showing how to get user transactions")
+      expect(conf["php_plain"]["app_name"]).to eq("php_plain")
+      expect(conf["sinatra_plain"]["app_url"]).to eq("http://localhost:4567")
+      expect(conf["java_servlet"]["callback_urls"]).to eq("http://localhost:8080/JavaServlet/Example")
+    end
+  end
+
+end

data/starter_kits/golang_plain/.fidor_meta.json

@@ -0,0 +1,7 @@
+{
+  "display_name" : "Go Plain",
+  "description"  : "A simple Go based app, showing how to get the access token",
+  "app_name":"golang_plain",
+  "app_url":"http://localhost:8080",
+  "callback_urls":"http://localhost:8080"
+}

data/starter_kits/golang_plain/README.md

@@ -0,0 +1,27 @@
+# Basic Go Example
+
+This is a basic example project that demonstrates the Fidor API OAuth
+flow. It provides the same functionality as the php example if you would
+like to compare the two sample projects.
+
+## Usage
+
+In order to run the example you'll need a Go environment installed (see
+www.golang.org) and can start the sample with:
+
+    go run example.go
+
+The server will listen on port 8080, you can access the example in your
+browser under the following URL:
+
+  http://localhost:8080
+
+## Configuration
+
+In case you downloaded this project from the Fidor AppManager, all the
+configuration should have already been set up for you. In case you
+retrieved this example from another source, you'll need to open the
+`example.go` file and fill in the configuration values at the top of the
+file. You will be able to find out the values in the AppManager, create
+a new App and use the configuration from the new App's detail page.
+

data/starter_kits/golang_plain/example.go

@@ -1,21 +1,168 @@
+package main
+
+// This is a basic example to illustrate how to access the Fidor API
+// using Go.
+//
+// To run this example type:
+//
+//     $ go run example.go
+//
+// And point your browser to:
+//
+//     $ http://localhost:8080
+
 import (
+	"encoding/json"
 	"fmt"
-	"io/ioutil"
 	"net/http"
+	"net/url"
 )
 
+// The following sections define the settings you require for the
+// app to be able to connect to and authorize itself against the api.
+
+// app ID and secret, can be found in this apps "Details" page in the
+// AppManager.
+var client_id = "<CLIENT_ID>"
+var client_secret = "<CLIENT_SECRET>"
+
+// Fidor's OAuth Endpoint (this changes between Sandbox and Production)
+var fidor_oauth_url = "<FIDOR_OAUTH_URL>" // e.g https://fidor.com/api_sandbox/oauth
+// The OAuth Endpoint this App provides
+var oauth_cb_url = "<APP_URL>"
+
+// The URL of the Fidor API (this changes between Sandbox and
+// Production)
+var fidor_api_url = "<FIDOR_API_URL>" // e.g https://fidor.com/api_sandbox vs /api
+
+
+
 
 func main() {
-    http.HandleFunc("/", viewHandler)
-    http.ListenAndServe(":8080", nil)
+	// register a handler function (see next function) to service
+	// requests ...
+	http.HandleFunc("/", indexHandler)
+	// ... and start listening.
+	http.ListenAndServe(":8080", nil)
+}
+
+func indexHandler(w http.ResponseWriter, r *http.Request) {
+
+	// ignore any favicon requests, etc.
+	if r.URL.Path != "/" {
+		w.WriteHeader(404)
+		return
+	}
+
+	// check whether we have a GET parameter named `code`, if so,
+	// this is a redirect back from the Fidor OAuth server.
+	values := r.URL.Query()
+	if values["code"] != nil {
+		// retrieve the actual OAuth access token ....
+		code := values.Get("code")
+		if token, err := retrieveTokenFromCode(code); err != nil {
+			fmt.Printf("err: %v\n", err)
+			w.WriteHeader(500)
+			fmt.Fprintf(w, "Unfortunately, an error occured retrieving oauth token")
+		} else {
+			// ... and finally, greet the user and assemble links
+			renderWelcome(w, token)
+		}
+	} else {
+		// we don't have an oauth `code` yet, so we need to
+		// redirect the user to the OAuth provider to get one ...
+		oauth_url := fmt.Sprintf("%s/authorize?client_id=%s&redirect_uri=%s",
+			fidor_oauth_url,
+			client_id,
+			url.QueryEscape(oauth_cb_url))
+
+		header := w.Header()
+		header.Add("location", oauth_url)
+		w.WriteHeader(307)
+	}
+}
+
+
+// Our TokenResponse representation used to pick it out from the JSON
+// returned by the OAuth server.
+type TokenResponse struct {
+	Token string `json:"access_token"`
+}
+
+// Use the OAuth code that the user's browser picked up from the OAuth
+// server to request an OAuth access_token to use in API requests.
+func retrieveTokenFromCode(code string) (token string, err error) {
+	// assemble the API endpoint URL and request payload
+	tokenUrl := fmt.Sprintf("%s/token", fidor_oauth_url)
+	tokenPayload := url.Values{
+		"client_id":     {client_id},
+		"client_secret": {client_secret},
+		"code":          {code},
+	}
+	// Call API
+	if resp, err := http.PostForm(tokenUrl, tokenPayload); err != nil {
+		return "", err
+	} else {
+		// if successful, pick the access_token out of the reply.
+		var tokenResponse TokenResponse
+		decoder := json.NewDecoder(resp.Body)
+		if err = decoder.Decode(&tokenResponse); err != nil {
+			return "", err
+		} else {
+			return tokenResponse.Token, nil
+		}
+	}
 }
 
-func viewHandler(w http.ResponseWriter, r *http.Request) {
 
-	app_url := "<APP-URL>"  			//default: http://localhost:8080
- 	client_id := "<CLIENT-ID>"
- 	client_secret := "<CLIENT-SECRET>"
-	fidor_url := "<FIDOR-URL>"
+// Our server code only makes a single call to the API to retrieve user
+// information. This is our internal representation of the returned JSON
+// used to pick out the user's email.
+type UserResponse struct {
+	Email string `json:"email"`
+}
+
+// function to retreive user information from the API
+func getUser(token string) (u UserResponse, err error) {
+	// Assemble endpoint URL...
+	url := fmt.Sprintf("%s/users/current?access_token=%s", fidor_api_url, token)
+	if resp, err := http.Get(url); err != nil {
+		return u, err
+	} else {
+		decoder := json.NewDecoder(resp.Body)
+		if err = decoder.Decode(&u); err != nil {
+			return u, err
+		} else {
+			return u, nil
+		}
+	}
+}
 
-    fmt.Fprintf(w, "<h1>You made it!</h1><div>%s</div>", p)
+
+// once all the OAuth calls have been taken care of, this function is
+// called from the http handler. It retrieves the user's email address
+// and inserts links to `transaction` and `accounts` endpoints.
+
+func renderWelcome(w http.ResponseWriter, token string) {
+	if user, err := getUser(token); err != nil {
+		fmt.Printf("err: %v\n", err)
+		w.WriteHeader(500)
+	} else {
+		txLink := fmt.Sprintf("%s/transactions?access_token=%s", fidor_api_url, token)
+		acctsLink := fmt.Sprintf("%s/accounts?access_token=%s", fidor_api_url, token)
+		fmt.Fprintf(w, indexTemplate, user.Email, token, txLink, acctsLink)
+	}
 }
+
+var indexTemplate = `
+<html>
+<head>
+</head>
+<body>
+	<h1>Welcome %s!</h1>
+	<i>retrieved <tt>access_token</tt>: %s</i>
+	<p><a href="%s">Transactions</a></p>
+	<p><a href="%s">Accounts</a></p>
+</body>
+</html>
+`

data/starter_kits/java_servlet/.fidor_meta.json

@@ -0,0 +1,7 @@
+{
+  "display_name" : "Java Servlet Plain",
+  "description"  : "A simple java servlet based app, showing how to get the access token",
+  "app_name":"java_servlet",
+  "app_url":"http://localhost:8080/JavaServlet/Example",
+  "callback_urls":"http://localhost:8080/JavaServlet/Example"
+}

data/starter_kits/node_tx/.fidor_meta.json

@@ -0,0 +1,7 @@
+{
+  "display_name" : "Node Transactions",
+  "description"  : "A simple nodejs based app, showing how to get user transactions",
+  "app_name":"node_tx",
+  "app_url":"http://localhost:3001",
+  "callback_urls":"http://localhost:3001/code"
+}

data/starter_kits/php_plain/.fidor_meta.json

@@ -0,0 +1,7 @@
+{
+  "display_name" : "PHP Plain",
+  "description"  : "A simple php script, showing how to get the access token",
+  "app_name":"php_plain",
+  "app_url":"http://localhost:8000/example.php",
+  "callback_urls":"http://localhost:8080/example.php"
+}

data/starter_kits/php_plain/README.md

@@ -1,6 +1,7 @@
 # Plain PHP Login - Example
 
-A single view showing how to get an access token
+A single view that demonstrates the Fidor API OAuth login flow and how to get 
+an access token.
 
 ## Usage
 
@@ -11,4 +12,14 @@ Start your local php server:
 And point your browser to http://localhost:8000/example.php
 
 If you run the example under a different url, please update the url in the 
-source file
+source file
+
+
+## Configuration
+
+In case you downloaded this project from the Fidor AppManager, all the
+configuration should have already been set up for you. In case you
+retrieved this example from another source, you'll need to open the
+`example.php` file and fill in the configuration values at the top of the
+file. You will be able to find out the values in the AppManager, create
+a new App and use the configuration from the new App's detail page.

data/starter_kits/php_plain/example.php

@@ -7,6 +7,7 @@
   $fidor_api_url = "<FIDOR_API_URL>";       # e.g https://fidor.com/api_sandbox vs /api
 
   $code = $_REQUEST["code"];
+
   # 1. redirect to authorize url
   if(empty($code)) {
     $dialog_url = $fidor_oauth_url . "/authorize?" .
@@ -40,10 +41,10 @@
   $user = json_decode(file_get_contents($usr_url));
   $transactions_url = $fidor_api_url . "/transactions?access_token=" . $resp->access_token;
   echo( "<h2>Hello " . $user->email . "</h2>
-         <i>May i present the access token response:</i>
+         <i>May I present the access token response:</i>
          <blockquote>");
    print_r($resp);
    echo("</blockquote>
-        <p>Now use the access token in <br> <a href='" . $transactions_url . "'>".$transactions_url."</a></p>");
+        <p>Now use the access token here: <br> <a href='" . $transactions_url . "'>".$transactions_url."</a></p>");
 
-?>
+?>

data/starter_kits/sinatra_plain/.fidor_meta.json

@@ -0,0 +1,7 @@
+{
+  "display_name" : "Ruby Sinatra Plain",
+  "description"  : "A simple Sinatra based app, showing how to get an access token.",
+  "app_name":"sinatra_plain",
+  "app_url":"http://localhost:4567",
+  "callback_urls":"http://localhost:4567"
+}

data/starter_kits/sinatra_plain/README.md

@@ -1,8 +1,9 @@
-= Plain Login - Example
+# Ruby Plain oAuth Login - Example
 
-A single view showing how to get an access token
+A single view that demonstrates the Fidor API OAuth login flow and how to get 
+an access token.
 
-== Usage
+## Usage
 
 This uses bundler to install the required gems:
 
@@ -12,3 +13,12 @@ This uses bundler to install the required gems:
   
   # or run on different port than :4567 provided by WEBrick
   ruby example.rb -p 3004
+
+## Configuration
+
+In case you downloaded this project from the Fidor AppManager, all the
+configuration should have already been set up for you. In case you
+retrieved this example from another source, you'll need to open the
+`example.rb` file and fill in the configuration values at the top of the
+file. You will be able to find out the values in the AppManager, create
+a new App and use the configuration from the new App's detail page.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fidor_starter_kits
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Georg Leciejewski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-10 00:00:00.000000000 Z
+date: 2014-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -84,8 +84,11 @@ files:
 - lib/fidor_starter_kits/version.rb
 - spec/fidor_starter_kits_spec.rb
 - spec/spec_helper.rb
+- starter_kits/golang_plain/.fidor_meta.json
+- starter_kits/golang_plain/README.md
 - starter_kits/golang_plain/example.go
 - starter_kits/java_servlet/.classpath
+- starter_kits/java_servlet/.fidor_meta.json
 - starter_kits/java_servlet/.project
 - starter_kits/java_servlet/.settings/.jsdtscope
 - starter_kits/java_servlet/.settings/org.eclipse.jdt.core.prefs
@@ -103,9 +106,12 @@ files:
 - starter_kits/java_servlet/WebContent/WEB-INF/lib/httpmime-4.3.5.jar
 - starter_kits/java_servlet/WebContent/WEB-INF/lib/json-simple-1.1.1.jar
 - starter_kits/java_servlet/src/de/fidor/api/example/Example.java
+- starter_kits/node_tx/.fidor_meta.json
 - starter_kits/node_tx/example.js
+- starter_kits/php_plain/.fidor_meta.json
 - starter_kits/php_plain/README.md
 - starter_kits/php_plain/example.php
+- starter_kits/sinatra_plain/.fidor_meta.json
 - starter_kits/sinatra_plain/Gemfile
 - starter_kits/sinatra_plain/README.md
 - starter_kits/sinatra_plain/example.rb