feapaydin / parasut-v4

Parasut API v4 Integration for Ruby applications.

parasut-v4

Parasut API V4 integration. You can sign up for an parasut account at https://www.parasut.com/

Dependencies

• her
• kaminari 0.17.0

Requirements

• Ruby 2.0.0 or newer

Installation

Add this line to your application's Gemfile:

gem 'parasut-v4'

And then execute:

$ bundle

Or install it yourself as:

$ gem install parasut-v4

Usage

Create an initializer for Parasut options.

  require 'parasut'

  # config/initializers/parasut.rb
  Parasut.options do |option|
    option.api_base_url="https://url" # this is optional, default is "https://api.parasut.com/"
    option.client_id = 'client_id'
    option.client_secret = 'client_secret'
    option.username = 'username'
    option.password = 'password'
    option.company_id = 'company_id'
  end

Afterwards you can call a model:

account = Parasut::Account.find(1)
puts account.inspect

contacts = Parasut::Contact.all
puts contacts.inspect

account.destroy

To paginate collections:

contacts=Parasut::Contact.all
contacts.page(2).per(25)
# Pagination uses kaminari. (https://github.com/kaminari/kaminari)

HttpClient

Parasut-v4 provides an http client integration to execute tasks manually. You can make your calls simply providing endpoint, body and headers. It automatically handles authentication and handles your request.

This is an http client, hence it does not manipulate the response into objects.

Making get requests:

# Parasut::HttpClient.get(endpoint, query_parameters, headers, parse_json=true)
#   parse_json tries to parse the response body into hash 
contact=Parasut::HttpClient.get("contacts/123")
contact[:data][:attributes][:name]

Executing post calls:

# Parasut::HttpClient.post(endpoint, body, headers, parse_json=true)
contact=Parasut::HttpClient.post("contacts", {
  data:{
    type: :contacts,
    attributes:{
      name: "Test From Api",
      account_type: :customer
    }
  }
)

ENVs

• PARASUT_API_BASE_URL
• PARASUT_CLIENT_ID
• PARASUT_CLIENT_SECRET
• PARASUT_USERNAME
• PARASUT_PASSWORD
• PARASUT_COMPANY_ID

Development

After checking out the repo, run bin/setup to install dependencies. 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/dijitalgaraj/parasut-v4. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Contributors

This gem uses @ahtung 's Parasut API v1 gem as its base. (https://github.com/ahtung/parasut)

API Version 4 compability implemented by @dijitalgaraj - @feapaydin

License

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