{"id":26566227,"url":"https://github.com/katanacode/evvnt","last_synced_at":"2026-05-08T11:06:29.438Z","repository":{"id":48769424,"uuid":"123818926","full_name":"KatanaCode/evvnt","owner":"KatanaCode","description":"A Ruby wrapper for the EVVNT JSON API","archived":false,"fork":false,"pushed_at":"2023-01-20T09:57:12.000Z","size":114,"stargazers_count":0,"open_issues_count":6,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-03-26T04:20:11.740Z","etag":null,"topics":["api","evvnt","json-api","rest-api","ruby"],"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/KatanaCode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-03-04T18:57:37.000Z","updated_at":"2018-03-16T18:10:20.000Z","dependencies_parsed_at":"2023-02-12T01:15:50.699Z","dependency_job_id":null,"html_url":"https://github.com/KatanaCode/evvnt","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KatanaCode%2Fevvnt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KatanaCode%2Fevvnt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KatanaCode%2Fevvnt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KatanaCode%2Fevvnt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KatanaCode","download_url":"https://codeload.github.com/KatanaCode/evvnt/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244966455,"owners_count":20539794,"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":["api","evvnt","json-api","rest-api","ruby"],"created_at":"2025-03-22T18:19:30.145Z","updated_at":"2026-05-08T11:06:29.380Z","avatar_url":"https://github.com/KatanaCode.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# evvnt\n\nProvides a Ruby wrapper around the evvnt APIs\n\n[![Latest Version](https://img.shields.io/gem/v/evvnt.svg)](https://rubygems.org/gems/evvnt)\n[![CircleCI](https://img.shields.io/circleci/project/github/KatanaCode/evvnt/master.svg)](https://circleci.com/gh/KatanaCode/evvnt)\n[![Downloads](https://img.shields.io/github/downloads/katanacode/evvnt/total.svg)](https://img.shields.io/github/downloads/katanacode/evvnt/total.svg)\n[![Maintainability](https://api.codeclimate.com/v1/badges/fdd8cffc25d6002a68df/maintainability)](https://codeclimate.com/github/KatanaCode/evvnt/maintainability)\n[![Test Coverage](https://api.codeclimate.com/v1/badges/fdd8cffc25d6002a68df/test_coverage)](https://codeclimate.com/github/KatanaCode/evvnt/test_coverage)\n\n\n\n---\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'evvnt'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install evvnt\n\n## Usage\n\nBefore you begin, you'll need to obtain an API key and secret from evvnt. Once you have that in place, include these in your gem configuration.\n\n### Configuration\n\nTo configure the gem, create an initializer and define the following block:\n\n``` ruby\n# config/initializers/evvnt.rb\nEvvnt.configure do |config|\n  config.environment = Rails.env.production? ? :live : :sandbox\n  # Print out useful logger info to the Rails log\n  config.logger     = Rails.logger\n  config.debug      = Rails.env.development?\n  # Your API key and secret\n  config.api_key    = \"...\"\n  config.api_secret = \"secret\"\nend\n\n```\n\n### In your code\n\nThis gem provides an equivalent endpoint for each of the endpoints on the evvnt API. It follows a familiar, idomatic rails pattern to create, fetch, and, update records.\n\nFor example:\n\n```ruby\n# =\u003e Returns all of the categories from the API as an Evvnt::Category object\n@categories = Evvnt::Category.all\n\n# The same as the above, aliased\n@categories = Evvnt::Category.index\n\n# Returns the first Category\n@category = Evvnt::Category.first\n@category.name # =\u003e \"Academic / Learning\"\n\n# Fetch one event from the API\n@event = Evvnt::Event.find(\"....\")\n\n# The same as above, aliased\n@event = Evvnt::Event.show(\"....\")\n\n# Returns the last Category\n@category = Evvnt::Category.last\n@category.name # =\u003e \"Alternative Investment\"\n\n# Create a User on the API\n@user = Evvnt::User.create(name: \"Sarah Connor\", email: \"sarah@example.com\")\n\n# Grab the last User from the API and update their email address:\n@user = Evvnt::User.last\n@user.email = \"newemail@example.com\"\n@user.save\n```\n\n## Documentation\n\nFor a full list of the Evvnt _model_ classes and their endpoints, please check out the documentation in the models, or in the [auto-generated docs](http://www.rubydoc.info/gems/evvnt/)\n\n - [Category](lib/evvnt/category.rb)\n   - index (GET /categories List categories)\n- [Contract](lib/evvnt/contract.rb)\n  - index (GET /contract Get contract information)\n- [Event](lib/evvnt/event.rb)\n  - index (GET /events List Events)\n  - create (POST /events  Create an event)\n  - show (GET /events/:event_id Get one event)\n  - update (PUT /events/:event_id  Update an event)\n  - ours (GET /events/ours(/:id) Get events of you and your created users)\n  - mine (GET /events/mine  List my events)\n- [Package](lib/evvnt/package.rb)\n  - index (GET /users/:user_id/packages Lists all of the packages belonging to a user)\n  - create (POST /packages Create a package)\n  - show (GET /packages/:package_id Get the details of a package)\n  - mine (GET /packages/mine List my packages)\n- [PublishedEvent](lib/evvnt/published_event,rb)\n  - index (GET /events List Events)\n  - show (GET /events/:event_id Get one event)\n  - update (PUT /events/:event_id Update an event)\n- [Publisher](lib/evvnt/publisher.rb)\n  - index (GET /publishers List my publishing sites)\n- [Report](lib/evvnt/report.rb)\n  - show (/events/:event_id/report View report data for my event)\n- [User](lib/evvnt/user.rb)\n   - create (POST /users Create a user)\n   - index (GET /users Get a list of all users created by you)\n   - show (GET /users/:user_id Get details of a user)\n   - update (PUT /users/:user_id Update a user)\n\n## Development\n\nAfter 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.\n\nTo 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](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/katanacode/evvnt.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkatanacode%2Fevvnt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkatanacode%2Fevvnt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkatanacode%2Fevvnt/lists"}