Skip to content

README.md

Latest commit

 

History

History
83 lines (64 loc) · 1.36 KB

README.md

File metadata and controls

83 lines (64 loc) · 1.36 KB
Raw

Parsehub

TODO: Write a gem description

Installation

Add this line to your application's Gemfile:

gem 'parsehub'

And then execute:

$ bundle

Or install it yourself as:

$ gem install parsehub

Configure

Parsehub.configure do |config|
  config.api_key = 'your-account-api-key'
end

Usage

Project

Get list of projects

Parsehub::Project.list

Get project

Parsehub::Project.fetch('project-token')

Run project

Parsehub::Project.run('project-token')

Get last run data for a project

Parsehub::Project.last_ready_run('project-token')

Run

Get run

Parsehub::Run.fetch('run-token')

Get run data

Parsehub::Run.data('run-token')

Cancel run

Parsehub::Run.cancel('run-token')

Delete run

Parsehub::Run.delete('run-token')

Versioning

Version # x.y.z

  • x = Parsehub's API major version
  • y = Parsehub's API minor version
  • z = Gem's release number

For instance, 2.0.1 Gem version 1 that maps to Parsehub's API v2.0.

Contributing

  1. Fork it ( https://github.com/[my-github-username]/parsehub/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request