PartnerAPI

An API client to connect to API provided by all Ascenda Partners:

• First Abu Dhabi Bank
• Virgin Money Australia
• Westpac
• Bank of New Zealand
• Gemini

Installation

Add this line to your application's Gemfile:

gem 'partner_api', ascenda_private: 'kaligo/partner_api', tag: 'v0.9.3'

And then execute:

$ bundle install

Usage

• FabApi Usage
• VmaApi Usage
• WestpacApi Usage
• BnzApi Usage
• Gemini Usage
• Anz Usage

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Add new endpoint

• Add endpoint into FabApi::Client:

module FabApi
  class Client
    endpoint :new_endpoint
  end
end

• Create new endpoint class. By convention, the class is put in lib/fab_api/endpoints folder, and is inside module FabApi::Endpoints. After creating the class, overwrite necessary methods to make the class work. With the above example, the class should be:

module FabApi
  module Endpoints
    class NewEndpoint < Endpoint
      prepend Initializer

      def initialize(...)
        # initializing thing
      end

      private

      def method
        # HTTP method
      end

      # ...
    end
  end
end

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/kaligo/fab_api.

License

The gem is available as open source under the terms of the MIT License.