Skip to content

RagicClient is a simple tool integrate with RAGIC system.

Notifications You must be signed in to change notification settings

dereknguyen269/ragic_client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RagicClient

RagicClient is a simple tool integrate with Ragic System. It's free and quite easy to use 😄 .

Ragic HTTP API Integration Guide.

Features

Installation

Add this line to your application's Gemfile:

gem 'ragic_client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ragic_client

Usage

Config

First thing you need to set up is placing something like this either in initializer or in application.rb file:

  RagicClient.config do |config|
    config.ragic_api_url = 'your ragic_api_url'
    config.ragic_api_key = 'Basic your_ragic_api_key'
  end

Note: What you need to do is use the field ids of the fields as name, and the values that you want to insert as parameter values.

See here Ragic API Documents.

Create Entry

  params = {
    '1000001' => 'Project Name',
    '1000002' => '15000'
  }
  RagicClient.create params

Update Entry

  ragic_id = 1
  params = {
    '1000001' => 'Project Name Update'
  }
  RagicClient.update ragic_id, params

Delete Entry

  RagicClient.delete 1

Find Entry by id

  RagicClient.find 1

Find Entry by field id and value

  RagicClient.find_by { '1000001' => 'Project Name' }

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/[USERNAME]/ragic_client. 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.

License

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

Code of Conduct

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

About

RagicClient is a simple tool integrate with RAGIC system.

Resources

Stars

Watchers

Forks

Packages

No packages published