DEV.to Interactions to Orbit Workspace

This is a Ruby gem that can be used to integrate your DEV interactions, like DEV comments on blog posts, into your organization's Orbit workspace.

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 expected environment variables:

ORBIT_API_KEY
ORBIT_WORKSPACE_ID
DEV_API_KEY
DEV_USERNAME

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: '...'
)

Post New DEV Comments to Orbit Workspace

You can use the gem to get new DEV comments on your DEV user or organization by invoking the #comments method on your client instance:

client.comments

This method will fetch all your 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 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 followers and post them to Orbit

$ ORBIT_API_KEY='...' ORBIT_WORKSPACE='...' DEV_API_KEY='...' DEV_USERNAME='...' bundle exec dev_orbit --check-followers

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/bencgreenberg/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.