Code Monkey home page Code Monkey logo

spage's Introduction

Spage

Gem Version

Spage is a Ruby client for integrating Statuspage.io into your ruby app. The idea is for it to be more than just a set of http requests to the server. It tries to model the data on the server for you so you don't have to.

Installation

Add this line to your application's Gemfile:

gem 'spage'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install spage

Official Docs

StatusPage API documentation

Usage

Configuration

Configure the client with your API key You can put this in an initailizer in Rails

Spage.configure do |config|
  config.api_key(YOUR_API_KEY)
end

Client

Spage::Api::Page.new.all returns all the pages for your account
Spage::Api::Page.new.find(id) returns a single page
Spage::Api::Page.new.update(id, page) updates the page

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/nulty/spage.

Testing

The test suite should run normally. If the recorded API requests need to be updated, set an environment variable for the API key and pass the record: :all to the use_cassette function you want to re-record.

VCR=1 STATUSPAGE_API_KEY=your-api-key bundle exec rspec

Roadmap

  • Add a logger with null logging
  • Add url_encoded body option to configuration
  • Validations on the resources
  • Respect HTTP caching like faraday/http_cache

License

The gem is available as open source under the terms of the MIT License.

spage's People

Contributors

nulty avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.