Contents

# CiviCRM Client

## Installation

```
$ gem install civicrm
```

## Getting started

```ruby
# Required config
CiviCrm.api_base = "https://www.example.org/path/to/civi/codebase/"
CiviCrm.site_key = "YOUR_SITE_KEY"

# Authenticate with username/password
CiviCrm.authenticate("username", "password")

# OR, authenticate with API key
CiviCrm.api_key = "..."
```

## CiviCrm Objects

```ruby
# Get list of contacts
CiviCrm::Contact.all

# Create contact
CiviCrm::Contact.create(contact_type: "Organization", organization_name: "test")

# Find and delete
CiviCrm::Contact.find(1).delete
```

## Testing

```
$ bundle exec rspec spec
```

## Useful links

* https://docs.civicrm.org/dev/en/latest/api/interfaces/#rest-interface
* http://drupal.demo.civicrm.org/civicrm/api/explorer

## Acknowledgements

Created by [Iskander Haziev](https://github.com/gvalmon). Maintained by [EFF](https://www.eff.org/).

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
civicrm-1.1.1	README.md
civicrm-1.1.0	README.md
civicrm-1.0.7	README.md
civicrm-1.0.6	README.md