Project

formi9

0.0
Low commit activity in last 3 years
No release in over a year
A Ruby API wrapper for formi9.com
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

> 2.0.0
>= 0
>= 12.3.3
>= 3.9.0

Runtime

 Project Readme

formi9

A Ruby API wrapper for formi9.com Build Status

Installation

Add this line to your application's Gemfile:

gem 'formi9'

And then execute:

$ bundle install

You can use an initializer to configure this gem, please put the following code into config/initializers/formi9_complicance.rb

Formi9.configure do |config|
  config.partner_id = 'Your Partner Id'
  config.username = 'Your username'
  config.password = 'Your password'
  # config.b2b_encryption_key = 'key'
  # config.b2b_encryption_iv = 'iv'
end

Usage

Create a company

Formi9.create_company_with_mou(options)

Create section 1 for employee

Formi9.create_section1(options)

the response contains

  • resultId
  • auto login link for employee to fill the form section 1

Create section 2 for HR

Formi9.create_section2

Retrieve the status of form

Formi9.case_status(result_id, auto_login_url: true)

Download the PDF of formi9

Formi9.download_pdf(result_id, {
  printSignatures: true,
  printNotes: true,
  printEverify: true,
  printDocs: true,
  printAudit_trail: true 
})

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/helloworld1812/formi9. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

Reference

  1. formi9.com API documentation

License

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

Code of Conduct

Everyone interacting in the Formi9 project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.