Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/grype/plaidst

Plaid client for Pharo
https://github.com/grype/plaidst

pharo pharo-smalltalk plaid seaside smalltalk

Last synced: 19 days ago
JSON representation

Plaid client for Pharo

Awesome Lists containing this project

README 

        
# PlaidSt

Pharo Smalltalk Bindings for the Plaid API (https://www.plaid.com/docs).



The whole available Plaid API is defined in the `PlaidClient` and various subclasses of `PlaidEndpoint`. Link support is provided via `JSPlaid`.



Uses [Ethel](https://github.com/grype/Ethel), [Seaside](https://github.com/SeasideSt/Seaside) for providing Link support, and [Magritte](https://github.com/magritte-metamodel/magritte) for models.



### Installation

``` smalltalk

Metacello

	new

		baseline: 'Plaid';

		repository: 'github://grype/PlaidSt/';

		onConflictUseLoaded;

		load.

```



Note: PlaidSt depends on Magritte3 and Magritte3AddOns. Those packages haven't been updated for Pharo7 and will ultimately result in some issues during load. For that reason, BaselineOfPlaid pins down their versions, and pulls in the latest Seaside from github. It is also for that reason that the Metacello script above is instructed to #onConflictUseLoaded.



### Versioning

Currently supported API version is 2018-05-22, and is defined in:

```smalltalk

PlaidClient class>>apiVersion

	^ '2018-05-22'

```



### Basic Usage

``` smalltalk

"Creating an instance of PlaidClient"

client := PlaidClient sandbox

    clientName: 'Acme';

	credentials: (PlaidCredentials new

		publicKey: '...';

		secret: '...';

		clientId: '...';

		yourself);

	yourself.



"Institutions"

client institutions getFrom: 0 count: 100.

client institutions search: 'Platypus' products: nil.

client institutions getById: 'ins_10'.



"Enumeration"

client institutions first: 10. "Fetches first 10 institutions"

client institutions collect: #yourself as: Set. "Fetches all institutions into a Set"

client institutions select: [:each | each products includes: 'identity']. "Fetches all institutions and selects only those that provide 'identity' product"

client institutions detect: [:each | each name asLowercase includesSubstring: 'platypus' ]. "Fetches institutions until it finds one that has the word 'platypus' in the name, returning the resulting institution object..."



"Public tokens"

client publicToken create.

client publicToken exchange: 'public-sandbox-...'.



"Other fun things which should be self-explanatory"

client accounts get.

client item get.



client transactions get: [:endpoint | 

    endpoint startDate: Date today - 1 days; 

    	endDate: Date today; 

    	accountIds: nil; 

    	count: 300; 

    	offset: 0].

      

"Select all uber related transactions in the last 30 days"

client transactions get 

  startDate: Date today - 30 days; 

  endDate: Date today;

  select: [:each | each name asLowercase includesSubstring: 'uber'].



"Total spent on uber in the last 30 days"

(client transactions get 

  startDate: Date today - 30 days; 

  endDate: Date today;

  select: [:each | each name asLowercase includesSubstring: 'uber']

  thenCollect: #amount) sum.

  

"Select all transactions in the last 30 days and group them by date"

client transactions get 

  startDate: Date today - 30 days; 

  endDate: Date today;

  groupedBy: [ :each | each date ].

```



API calls are synchronous and return responses that are defined in subclasses of `PlaidResponse`. Fork those calls if you'd like things asynchronously.



API calls may also raise an error, which could be at either the transport, SDK or API level. You may want to wrap those API calls in a block and handle errors via #on:do:



```smalltalk

[client item get] on: Error do: [...]

```



### Defaults



All of the variables required to instantiate `PlaidClient` are wired up in Settings, making it possible to enter credentials and client name there, and then simply ask for `PlaidClient default`.



### Using Link with Seaside



Use the following snippet as a guide to rendering Link in a Seaside component:



```smalltalk

MyLinkComponent class>>initialize

	(WAAdmin register: self asApplicationAt: 'link')

		addLibrary: PlaidLinkLibrary.

		

MyLinkComponent>>renderContentOn: html

	super renderContentOn: html.

	html

		script:

			((html javascript plaid

				create: self plaidClient

				with: [ :builder | self buildLinkPropertiesOn: builder ]) call: 'open').



MyLinkComponent>>buildLinkPropertiesOn: aBuilder

	aBuilder

		product: #(#transactions ...);

		onLoad: [ ... ];

		onSuccess: [ :accessToken :meta | ... ];

		onExit: [ :err :meta | ... ];

		onEvent: [ :event :meta | ... ].



    "Existing link could be updated. This may need to happen when user is required to authenticate again"

    "In which case, #isUpdating would return true..."

	self isUpdating

		ifTrue: [ aBuilder token: self publicToken ].



```



### Coverage