DEV.to Interactions to Orbit Workspace
Add your DEV interactions into your Orbit workspace with this community-built integration.
:sparkles: This is a community project. The Orbit team does its best to maintain it and keep it up to date with any recent API changes.We welcome community contributions to make sure that it stays current. :sparkles: |
---|
Installation
Add this line to your application's Gemfile:
gem 'dev_orbit'
Usage
Instantiation of the Client
To instantiate a DevOrbit client, you can either pass along your credentials for DEV and Orbit directly to the instantiation or retain them in your environment variables.
The following are the environment variables, you can provide either or both a DEV_USERNAME
or a DEV_ORGANIZATION
:
ORBIT_API_KEY
ORBIT_WORKSPACE_ID
DEV_API_KEY
DEV_USERNAME
DEV_ORGANIZATION
With the credentials as environment variables:
client = DevOrbit::Client.new
Passing in the credentials directly into the instantiation:
client = DevOrbit::Client.new(
orbit_api_key: '...',
orbit_workspace: '...',
dev_api_key: '...',
dev_username: '...',
dev_organization: '...'
)
Performing a Historical Import
By default, the integration will only import comments that are newer than the newest DEV comment in your Orbit workspace. You may want to perform a one-time historical import to fetch all your previous DEV comments and bring them into your Orbit workspace. To do so, instantiate your client
with the historical_import
flag:
client = DevOrbit::Client.new(
historical_import: true
)
Post New DEV Comments from a DEV User to Orbit Workspace
You can use the gem to get new DEV comments on your DEV user by invoking the #comments
method on your client
instance:
client.comments
This method will fetch all your user articles from DEV, gather their respective comments, filter them for anything within the past day, and then send them to your Orbit workspace via the Orbit API.
Post New DEV Comments from a DEV Organization to Orbit Workspace
You can use the gem to get new DEV comments on your DEV organization by invoking the #comments
method on your client
instance:
client.organization_comments
This method will fetch all your organization articles from DEV, gather their respective comments, filter them for anything within the past day, and then send them to your Orbit workspace via the Orbit API.
Post New DEV Followers to Orbit Workspace
You can use the gem to get new DEV followers by invoking the #followers
method on your client
instance:
client.followers
You can run this either of those or any one of them as a daily cron job, for example, to add your newest DEV comments and/or followers as activities and members in your Orbit workspace.
CLI
You can also use the built-in CLI to perform the following operations:
- Check for new DEV user comments and post them to Orbit
$ ORBIT_API_KEY='...' ORBIT_WORKSPACE='...' DEV_API_KEY='...' DEV_USERNAME='...' bundle exec dev_orbit --check-comments
- Check for new DEV user followers and post them to Orbit
$ ORBIT_API_KEY='...' ORBIT_WORKSPACE='...' DEV_API_KEY='...' DEV_USERNAME='...' bundle exec dev_orbit --check-followers
- Check for new DEV organization comments and post them to Orbit
$ ORBIT_API_KEY='...' ORBIT_WORKSPACE='...' DEV_API_KEY='...' DEV_ORGANIZATION='...' bundle exec dev_orbit --check-organization-comments
Add the --historical-import
flag to your CLI command to perform a historical import of all your DEV comments using the CLI.
GitHub Actions Automation Setup
⚡ You can set up this integration in a matter of minutes using our GitHub Actions template. It will run regularly to add new activities to your Orbit workspace. All you need is a GitHub account.
See our guide for setting up this automation.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/orbit-love/community-ruby-dev-orbit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the 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 project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.