fidor_starter_kits 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe72996845c734b423e4c9571e3ea15427168a27
-  data.tar.gz: 311aa52916b738f63844d0e5eb902c752282f2df
+  metadata.gz: c40f1a70c94e4892f40607a57997d6d8f3a3f684
+  data.tar.gz: 25a939d8c4eabb519dc5d27dccf031adfeef229f
 SHA512:
-  metadata.gz: 0892a53df4347cc65ddf716e80039413f81dd49fe8065d831bf795344618b7f43d607354c69154a72c08ad3c5b190bbcd9182d078c0b310f92c95ea82491be48
-  data.tar.gz: 3c6673db52300cd822794a9aab7dc29948e9a7dac46638d763eed429e04113dfa9bfa4f02c0d956deeb93aaa4dc56f4cd7d6f9eb6ae4af4eed8c2ccbe1a917ae
+  metadata.gz: 3c055c409b78ac09c41a3305f37f80678ced864462ab2e9e30dd8620e2e98ed4b38aac02d0c70e19ed1c1f515461f14e2ea4f7e9c50a06a481f8c556c8b52f9d
+  data.tar.gz: f21988b94f1a1f24b905a07059febdebf3248efff20acb35bad57aec7c6dd3526d1e01c2b4413740475cafabc824457ad9fed02828b67949d889e7a3026dc5a9

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog Fidor Admin API Schema
 See [commit messages](https://github.com/fidor/fidor_starter_kits/commits/) for details.
 
+##2016-04
+
+* add PHP advanced example
+
 ##2016-01
 
 * remove client_secret usage in params => moved to BasicAuth header

data/lib/fidor_starter_kits.rb

@@ -6,7 +6,7 @@ require 'json'
 
 module FidorStarterKits
 
-  STARTER_KITS = %w{ node_tx golang_transactions php_oauth_plain ruby_oauth_plain java_servlet }
+  STARTER_KITS = %w{ node_tx golang_transactions php_oauth_plain ruby_oauth_plain java_servlet php_advanced }
 
   class << self
 

data/lib/fidor_starter_kits/version.rb

@@ -1,3 +1,3 @@
 module FidorStarterKits
-  VERSION = '0.5.1'
+  VERSION = '0.6.0'
 end

data/starter_kits/php_advanced/.fidor_meta.json

@@ -0,0 +1,8 @@
+{
+  "display_name" : "PHP Advanced",
+  "description"  : "PHP Website using multiple API objects and a tiny PHP SDK",
+  "app_name":"php_advanced",
+  "app_url":"http://localhost:8000",
+  "callback_urls":"http://localhost:8000",
+  "language" : "php"
+}

data/starter_kits/php_advanced/Fidor/SDK/Accounts.php

@@ -0,0 +1,47 @@
+<?php
+namespace Fidor\SDK;
+
+/**
+ * @property Transactions $transactions Get transactions resource
+ * @property Transactions $transactions Get transfer resource
+ */
+class Accounts extends Client {
+
+    /**
+     *
+     * @var string 
+     */
+    protected $id;
+    
+    /**
+     * 
+     * @param \Fidor\SDK\Config $config
+     */
+    public function __construct( Config $config ) {
+        parent::__construct( $config );
+    }
+    
+    /**
+     * 
+     * @param string $name
+     * @return mixed
+     */
+    public function __get( $name ) {
+        $obj = parent::__get( $name );
+        return $obj;
+    }
+    
+    /**
+     * 
+     * @param integer $id
+     * @return string
+     */
+    public function get( $id = null ) {
+        $data = parent::get( $this->config->getApiUrl() . '/accounts' );
+        if ( ! empty( $data['data'] ) ) {
+            $data = $data['data'];
+        }
+        return $data;
+    }
+    
+}

data/starter_kits/php_advanced/Fidor/SDK/Authorization.php

@@ -0,0 +1,276 @@
+<?php
+namespace Fidor\SDK;
+
+class Authorization {
+    
+    /**
+     * Configuration
+     * 
+     * @var \Fidor\SDK\Config 
+     */
+    protected $config;
+    
+    /**
+     * User agent used in HTTP requests
+     * 
+     * @var string 
+     */
+    protected $user_agent = 'FidorSDK (+https://docs.fidor.de)';
+    
+    /**
+     *
+     * @var integer 
+     */
+    protected $connect_timeout = 15;
+    
+    /**
+     *
+     * @var integer 
+     */
+    protected $timeout = 60;
+    
+    /**
+     * Stores last request log
+     * 
+     * @var string 
+     */
+    protected static $debug_log;
+    
+    /**
+     *
+     * @var boolean 
+     */
+    protected $debug_enabled = false;
+    
+    /**
+     * 
+     * @param \Fidor\SDK\Config $config
+     * @param string $redirect_uri
+     */
+    public function __construct( Config $config ) {
+        $this->config = $config;
+    }
+    
+    /**
+     * Turn debugging on
+     * 
+     * @return \Fidor\SDK\Authorization
+     */
+    public function enableDebug( ) {
+        $this->debug_enabled = true;
+        return $this;
+    }
+    
+    /**
+     * Turn debugging off
+     * 
+     * @return \Fidor\SDK\Authorization
+     */
+    public function disableDebug( ) {
+        $this->debug_enabled = false;
+        return $this;
+    }
+    
+    /**
+     * Defines the HTTP user agent string used in requests 
+     * 
+     * @param string $userAgent
+     * @return \Fidor\SDK\Authorization
+     */
+    public function setUserAgent( $userAgent ) {
+        $this->user_agent = $userAgent;
+        return $this;
+    }
+    
+    /**
+     * Sets connection timeout
+     * 
+     * @param integer $connectTimeout
+     * @return \Fidor\SDK\Authorization
+     */
+    public function setConnectTimeout( $connectTimeout ) {
+        $this->connect_timeout = $connectTimeout;
+        return $this;
+    }
+    
+    /**
+     * 
+     * @param integer $timeout
+     * @return \Fidor\SDK\Authorization
+     */
+    public function setTimeout( $timeout ) {
+        $this->timeout = (int) $timeout;
+        return $this;
+    }
+    
+    /**
+     * 
+     * @return string
+     */
+    public function getRequestUrl( $redirect_uri = null, $state = null ) {
+        return sprintf( '%s/authorize?response_type=code&client_id=%s&state=%s&redirect_uri=%s',  $this->config->getOAuthUrl(), $this->config->getClientId(), $state, urlencode( $redirect_uri ) );
+    }
+    
+    /**
+     * 
+     * @return string
+     */
+    public function getTokenUrl( ) {
+        return $this->config->getOAuthUrl() . '/token';
+    }
+    
+    /**
+     * 
+     * @return string
+     */
+    public function getRevokeTokenUrl( ) {
+        return $this->config->getOAuthUrl() . '/revoke';
+    }
+    
+    /**
+     * Redirect user browser to authorization server.
+     * 
+     * @param string $state
+     */
+    public function start( $state = null ) {
+        $state = $state ? $state : self::makeState();
+        $auth_url = $this->getRequestUrl( $this->config->getCallbackUrl(), $state );        
+        header( 'Location: ' . $auth_url );
+        exit;
+    }
+    
+    /**
+     * Request access token after authorization was grantd by resource owner
+     * 
+     * @param string $code
+     * @return string
+     */
+    public function finish( $code ) {
+        $json = $this->http_post( 
+                    $this->getTokenUrl(), 
+                    sprintf( 'client_id=%s&client_secret=%s&code=%s&redirect_uri=%s&grant_type=authorization_code', $this->config->getClientId(), $this->config->getClientSecret(), $code, urlencode( $this->config->getCallbackUrl() ) ),
+                    array( 'auth' => true, 'auth_scheme' => 'Bearer', )
+                );
+        
+        return json_decode( $json, true );
+    }
+    
+    /**
+     * Refresh access token
+     * 
+     * @param string $refresh_token
+     * @return string
+     */
+    public function refresh( $refresh_token = null ) {
+        $json = $this->http_post( 
+                    $this->getTokenUrl(), sprintf( 'grant_type=refresh_token&refresh_token=%s', $refresh_token ? $refresh_token : $this->config->getRefreshToken() ),
+                    array( 'auth' => true, ) 
+                );
+        
+        return json_decode( $json, true );
+    }
+    
+    /**
+     * Revoke both access and refresh tokens. By default, it revokes access token.
+     * 
+     * @param string|null $token
+     * @return string
+     */
+    public function revoke( $token = null ) {
+        $json = $this->http_post( 
+                    $this->getRevokeTokenUrl(), 
+                    sprintf( 'token=%s', $token ? $token : $this->config->getAccessToken() ),
+                    array( 'auth' => true, ) 
+                );
+        
+        return json_decode( $json, true );
+    }
+    
+    protected function http_post( $url, $data, $options = array() ) {
+        if ( function_exists( 'curl_init' ) ) {
+            $headers = array( 'Content-Type: application/x-www-form-urlencoded' );
+            
+            $ch = curl_init( $url );
+            
+            if ( array_key_exists( 'auth', $options ) && true === $options['auth'] ) {
+                $scheme = ! empty( $options['auth_scheme'] ) ? $options['auth_scheme'] : 'Basic';
+                $token  = base64_encode( $this->config->getClientId() . ":" . $this->config->getClientSecret() );
+                $headers[] = sprintf( 'Authorization: %s %s', $scheme, $token );
+            }
+            
+            curl_setopt( $ch, CURLOPT_HEADER, false );
+            curl_setopt( $ch, CURLOPT_POST, true );
+            curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
+            
+            if ( preg_match( '/^https:/is', trim( $url ) ) ) {
+                curl_setopt( $ch, CURLOPT_SSL_VERIFYPEER, false );
+                curl_setopt( $ch, CURLOPT_SSL_VERIFYHOST, 2 );
+            }
+            
+            /**
+             * In case we're debugging
+             */
+            $fh = null;
+            if ( $this->debug_enabled ) {
+                curl_setopt( $ch, CURLOPT_VERBOSE, true );
+                $fh = fopen( 'php://temp', 'w+' );
+                curl_setopt( $ch, CURLOPT_STDERR, $fh );
+            }
+            
+            curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, $this->connect_timeout );
+            curl_setopt( $ch, CURLOPT_TIMEOUT, $this->timeout );
+            curl_setopt( $ch, CURLOPT_POSTFIELDS, $data );
+            curl_setopt( $ch, CURLOPT_USERAGENT, $this->user_agent );
+            curl_setopt( $ch, CURLOPT_HTTPHEADER, $headers );
+            
+            $resp = curl_exec( $ch );
+            
+            /**
+             * Debugging was enabled
+             */
+            if ( $this->debug_enabled ) {
+                rewind( $fh );
+                self::$debug_log = ( $data ? "sent data: \n" . ( is_array( $data ) ? print_r( $data, true ) : $data ) : '' ) . "\n\nHTTP logs:\n" . stream_get_contents( $fh );
+            }
+            
+            curl_close( $ch );
+            
+            return $resp;
+        } else {
+            $headers = "Content-type: application/x-www-form-urlencoded\r\n";
+            
+            if ( array_key_exists( 'auth', $options ) && true === $options['auth'] ) {
+                $scheme = ! empty( $options['auth_scheme'] ) ? $options['auth_scheme'] : 'Basic';
+                $token  = base64_encode( $this->config->getClientId() . ":" . $this->config->getClientSecret() );
+                $headers .= sprintf( "Authorization: %s %s\r\n", $scheme, $token );
+            }
+            
+            $options = array(
+                'http' => array(
+                    'header'  => $headers,
+                    'method'  => 'POST',
+                    'content' => $data,
+                ),
+            );
+            $context  = stream_context_create( $options );
+            return file_get_contents( $url, false, $context );
+        }
+    }
+    
+    /**
+     * 
+     * @return string
+     */
+    public static function getDebugLog( ) {
+        return self::$debug_log;
+    }
+    
+    /**
+     * Generate a random string for use as state parameter
+     * 
+     * @return string
+     */
+    public static function makeState( ) {
+        return md5( time() . rand( 1000000, 9999999 ) );
+    }
+}

data/starter_kits/php_advanced/Fidor/SDK/Autoload.php

@@ -0,0 +1,33 @@
+<?php
+namespace Fidor\SDK;
+
+class Autoload {
+    
+    /**
+     * Register class autoloader
+     */
+    public static function register() {
+        spl_autoload_register( array( __CLASS__, 'load' ) );
+    }
+    
+    /**
+     * Load class
+     * 
+     * @param string $class
+     */
+    public static function load( $class ) {
+        // load only Fidor classes
+        if ( 'Fidor\\' === substr( $class, 0, 6 ) ) {         
+            // turn namespace separator and _ to directory separtor
+            $file_path = __DIR__ . '/' . preg_replace( '/[\\_]/', DIRECTORY_SEPARATOR, substr( $class, strrpos( $class, '\\' ) + 1 ) ) . '.php';
+            
+            // load class file if exists
+            if ( is_readable( $file_path ) ) {
+                require_once $file_path;
+            }
+        }
+    }
+    
+}
+
+Autoload::register();

data/starter_kits/php_advanced/Fidor/SDK/Client.php

@@ -0,0 +1,239 @@
+<?php
+namespace Fidor\SDK;
+
+/**
+ * @property \Fidor\SDK\Users $users Get users resource
+ * @property \Fidor\SDK\Accounts $accounts Get accounts resource
+ * @property \Fidor\SDK\Customers $customers Get customers resource
+ * @property \Fidor\SDK\Transactions $transactions Get transactions resource
+ * @property \Fidor\SDK\Transfers $transfers Get transfers resource
+ * 
+ */
+class Client {
+
+    /**
+     *
+     * @var Config 
+     */
+    protected $config;
+    
+    /**
+     *
+     * @var integer 
+     */
+    protected $connect_timeout = 15;
+    
+    /**
+     *
+     * @var integer 
+     */
+    protected $timeout = 60;
+    
+    /**
+     *
+     * @var string 
+     */
+    protected $user_agent = 'FidorSDK (+https://docs.fidor.de)';
+    
+    /**
+     *
+     * @var string 
+     */
+    protected static $debug_log;
+    
+    /**
+     * 
+     * @param \Fidor\SDK\Config $config
+     */
+    public function __construct( Config $config ) {
+        $this->config = $config;
+    }
+    
+    /**
+     * 
+     * @param string $name
+     * @return mixed
+     */
+    public function __get( $name ) {
+        $class = __NAMESPACE__ . '\\' . ucfirst( $name );
+        if ( class_exists( $class ) && is_subclass_of( $class, __CLASS__ ) ) {
+            $obj = new $class( $this->config );
+            return $obj;
+        }
+    }
+    
+    /**
+     * 
+     * @param string $url
+     * @return string
+     */
+    public function get( $url ) {
+        return $this->request( 'get', $url );
+    }
+    
+    /**
+     * 
+     * @param string $url
+     * @param string|array $data
+     * @return string
+     */
+    public function post( $url, $data ) {
+        return $this->request( 'post', $url, $data );
+    }
+    
+    /**
+     * 
+     * @param string $url
+     * @param string|array $data
+     * @return string
+     */
+    public function put( $url, $data ) {
+        return $this->request( 'put', $url, $data );
+    }
+    
+    /**
+     * 
+     * @param string $url
+     * @param string|array $data
+     * @return string
+     */
+    public function patch( $url, $data ) {
+        return $this->request( 'patch', $url, $data );
+    }
+    
+    /**
+     * 
+     * @param string $url
+     * @return string
+     */
+    public function delete( $url ) {
+        return $this->request( 'put', $url );
+    }
+    
+    /**
+     * 
+     * @param string $method
+     * @param string $url
+     * @param string|null $data
+     */
+    public function request( $method, $url, $data = null ) {
+        if ( function_exists( 'curl_init' ) ) {
+            return $this->curl_request( $method, $url, $data );
+        } else {
+            return $this->stream_request( $method, $url, $data );
+        }
+    }
+    
+    /**
+     * 
+     * @param string $method
+     * @param string $url
+     * @param mixed $data
+     * @return string
+     */
+    protected function curl_request( $method, $url, $data = null ) {
+        $method = trim( strtoupper( $method ) );
+        
+        /**
+         * The empty Expect headers removes HTTP 100-continue mechanism
+         */
+        $headers = array(
+                        'Accept: application/vnd.fidor.de; version=1,text/json',
+                        'Authorization: Bearer ' . $this->config->getAccessToken(),
+                        'Expect: ',
+                    );
+        
+        $ch = curl_init( $url );
+        curl_setopt( $ch, CURLOPT_HEADER, false );
+
+        if ( 'POST' === $method ) {
+            curl_setopt( $ch, CURLOPT_POST, true );
+        } elseif ( in_array( $method, array( 'HEAD', 'PUT', 'PATCH', 'DELETE' ) ) ) {
+            curl_setopt( $ch, CURLOPT_CUSTOMREQUEST, $method );
+        }
+        
+        curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
+        
+        if ( preg_match( '/^https:/is', trim( $this->uri ) ) ) {
+            curl_setopt( $ch, CURLOPT_SSL_VERIFYPEER, false );
+            curl_setopt( $ch, CURLOPT_SSL_VERIFYHOST, 2 );
+        }
+        
+        // debugging
+        curl_setopt( $ch, CURLOPT_VERBOSE, true );
+        $fh = fopen( 'php://temp', 'w+' );
+        curl_setopt( $ch, CURLOPT_STDERR, $fh );
+        // -debugging
+        
+        curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, $this->connect_timeout );
+        curl_setopt( $ch, CURLOPT_TIMEOUT, $this->timeout );
+
+        if ( ! empty( $data ) ) {
+            if ( is_array( $data ) ) {
+                $data = json_encode( $data );
+            }
+            if ( in_array( $method, array( 'PUT', 'PATCH', 'DELETE' ) ) ) {
+                 curl_setopt( $ch, CURLOPT_CUSTOMREQUEST, $data );
+            } else {
+                curl_setopt( $ch, CURLOPT_POSTFIELDS, $data );
+            }
+
+            $headers[] = 'Content-Type: application/json';
+        }
+        
+        if ( $this->user_agent ) {
+            curl_setopt( $ch, CURLOPT_USERAGENT, $this->user_agent );
+        }
+        
+        curl_setopt( $ch, CURLOPT_HTTPHEADER, $headers );
+        
+        $result = curl_exec( $ch );
+        
+        $request_info = curl_getinfo( $ch );
+        
+        rewind( $fh );
+        self::$debug_log = ( $data ? "SENDING DATA: \n" . ( is_array( $data ) ? print_r( $data, true ) : $data ) . "\n\n" : '' ) . stream_get_contents( $fh ) . "\n\nRESPONSE:\n" . $result;
+        
+        curl_close( $ch );
+        
+        return json_decode( $result, true );
+    }
+    
+    /**
+     * 
+     * @param string $method
+     * @param string $url
+     * @param mixed $data
+     * @return string
+     */
+    protected function stream_request( $method, $url, $data = null ) {
+        $headers = "Accept: application/vnd.fidor.de; version=1,text/json\r\n";
+        $headers .= "Authorization: Bearer " . $this->config->getAccessToken() . "\r\n";  
+        $headers .= "Expect: \r\n"; 
+
+        $options = array();
+        $options['http']['method'] = $method;
+        
+        if ( ! empty( $data ) ) {
+            if ( is_array( $data ) ) {
+                $data = json_encode( $data );
+            }
+            $headers .= "Content-Type: application/json\r\n"; 
+            $options['http']['content'] = $data;
+        }
+        
+        $options['http']['header'] = $headers;
+        
+        $context  = stream_context_create( $options );
+        return file_get_contents( $url, false, $context );
+    }
+    
+    /**
+     * 
+     * @return string
+     */
+    public static function get_debug_log( ) {
+        return self::$debug_log;
+    }
+    
+}