{"id":19124121,"url":"https://github.com/efforg/ruby-civicrm","last_synced_at":"2025-05-05T19:12:02.824Z","repository":{"id":42170619,"uuid":"149521817","full_name":"EFForg/ruby-civicrm","owner":"EFForg","description":"Ruby client for CiviCRM REST interface","archived":false,"fork":false,"pushed_at":"2022-07-22T02:09:17.000Z","size":56,"stargazers_count":1,"open_issues_count":6,"forks_count":4,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-30T22:51:19.649Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/EFForg.png","metadata":{"files":{"readme":"README.md","changelog":"History.txt","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-09-19T23:01:06.000Z","updated_at":"2021-08-03T18:33:11.000Z","dependencies_parsed_at":"2022-08-12T08:31:37.012Z","dependency_job_id":null,"html_url":"https://github.com/EFForg/ruby-civicrm","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EFForg%2Fruby-civicrm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EFForg%2Fruby-civicrm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EFForg%2Fruby-civicrm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EFForg%2Fruby-civicrm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/EFForg","download_url":"https://codeload.github.com/EFForg/ruby-civicrm/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249600370,"owners_count":21297683,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T05:28:11.995Z","updated_at":"2025-04-19T03:32:46.516Z","avatar_url":"https://github.com/EFForg.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CiviCRM Client\n\n## Installation\n\n```\n$ gem install civicrm\n```\n\n## Getting started\n\n```ruby\n# Required config\nCiviCrm.api_base = \"https://www.example.org/path/to/civi/codebase/\"\nCiviCrm.site_key = \"YOUR_SITE_KEY\"\nCiviCrm.api_key = \"...\"\n\n# Optional config\nCiviCrm.timeout = 60 # Change request timeout in seconds (nil to disable)\n```\n\n## CiviCrm Objects\n\n```ruby\n# Get list of contacts\nCiviCrm::Contact.all\n\n# Create contact\nCiviCrm::Contact.create(contact_type: \"Organization\", organization_name: \"test\")\n\n# Find and delete\nCiviCrm::Contact.find(1).delete\n```\n\n## Testing\n\n```\n$ bundle exec rspec spec\n```\n\n## Debugging\n\nSet these `ENV` options to a truthy value to print CiviCRM REST API data.\n\n```DEBUG_CIVICRM_REQUEST```\n\nExample: \n\n```\n[CiviCRM] [REQ] [FinancialType] [get] {\"method\":\"post\",\"timeout\":null,\"headers\":{\"user_agent\":\"CiviCrm RubyClient/1.3.6\",\"request_id\":\"8168cbfc-36d1-4967-bf94-8fd72fd48455\"},\"payload\":{\"json\":\"{\\\"id\\\":12}\"},\"url\":\"...\"}\n```\n\n```DEBUG_CIVICRM_RESPONSE```\n\nExample:\n\n```\n[CiviCRM] [RES] [FinancialType] [get] {\"is_error\":0,\"version\":3,\"count\":1,\"id\":12,\"values\":{\"12\":{\"id\":\"12\",\"name\":\"Matching Gift\",\"is_deductible\":\"0\",\"is_active\":\"1\"}}}\n```\n\n\n## Useful links\n\n* https://docs.civicrm.org/dev/en/latest/api/interfaces/#rest-interface\n* http://drupal.demo.civicrm.org/civicrm/api/explorer\n\n## Acknowledgements\n\nCreated by [Iskander Haziev](https://github.com/gvalmon). Maintained by [EFF](https://www.eff.org/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fefforg%2Fruby-civicrm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fefforg%2Fruby-civicrm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fefforg%2Fruby-civicrm/lists"}