A simple tool to help you get articles from Forem/Dev.to.

The patterns laid out in this gem could easily be used to finish building out the rest of the API, but I only needed articles so I am leaving the rest up to contributors or for when I eventually need to use it as well.

Installation

Add this line to your application's Gemfile:

gem "forem_lite"

And then execute:

bundle install

Or install it yourself as:

gem install forem_lite

Usage

require "forem_lite"

c = ForemLite::Client.new

# https://docs.dev.to/api/#operation/getArticles
articles = c.articles
articles.first.title # => "How do you keep notes?"

# https://docs.dev.to/api/#operation/getArticleById
article = c.article(279134)
article.title # => "A11Y in Rails: Automated Linting with AccessLint🎉"
article.url # => "https://dev.to/andrewmcodes/a11y-in-rails-automated-linting-with-accesslint-1618"

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/andrewmcodes/forem_liteent. 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 DevApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.