Project

jemquarie

0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
Connect to Macquarie ESI web services
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 1.11
~> 1.3
~> 11.2
~> 3.4

Runtime

~> 2.11
 Project Readme

jemquarie

Build Status

Jemquarie provides an easy way to interact with Macquarie ESI api. For Ruby and Ruby on Rails.

Installation

Add this line to your application's Gemfile:

gem 'jemquarie'

And then execute:

$ bundle

Or install it yourself as:

$ gem install jemquarie

Usage

For Ruby on Rails

Create an initializer file under config/initializers

The api key needs to be the unhashed value.

require 'jemquarie'
Jemquarie::Jemquarie.api_credentials(YOUR_KEY, YOUR_APPLICATION_NAME, LOG_LEVEl = :warn)

Import transactions

The auth code and password need to be the unhashed values.

  Jemquarie::Importer.new(username, password).cash_transactions(1.day.ago.to_date, Date.today)
  Jemquarie::Importer.new(username, password).cash_transactions(10.years.ago.to_date, Date.today, account_number)

Success with data

The gem should return an array with formatted data. Here an example:

[
 {
   :foreign_identifier => "123456",
   :date_time          => "2013-01-01 00:00:00.000 UTC",
   :amount             => "-200",
   :type_name          => "TYPE",
   :description        => "NARRATIVE",
   :meta_data => {
   :updated_at         => "2013-01-01 03:45:23.876 UTC"
 }
]

Success with no data

It just returns an empty Array

Authentication failure

It returns an Hash {:error => "Invalid credentials"} .

Other available calls are:

  • client balances
  • account details
  • expiry of credentials

Authors

How to contribute

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request