README.md in sumologic-0.0.4 vs README.md in sumologic-0.1.0

- old
+ new

@@ -1,42 +1,71 @@ Sumo Logic Ruby SDK =================== -[![Gem Version](https://badge.fury.io/rb/sumologic.svg)](http://badge.fury.io/rb/sumologic) -[![Build Status](https://img.shields.io/travis/grokify/sumologic-sdk-ruby/master.svg)](https://travis-ci.org/grokify/sumologic-sdk-ruby) -[![Code Climate](https://codeclimate.com/github/grokify/sumologic-sdk-ruby/badges/gpa.svg)](https://codeclimate.com/github/grokify/sumologic-sdk-ruby) -[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/grokify/sumologic-sdk-ruby/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/grokify/sumologic-sdk-ruby/?branch=master) -[![Docs](https://img.shields.io/badge/docs-rubydoc-blue.svg)](http://www.rubydoc.info/gems/sumologic/) -[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/grokify/sumologic-sdk-ruby/master/LICENSE.txt) +[![Gem Version][gem-version-svg]][gem-version-link] +[![Build Status][build-status-svg]][build-status-link] +[![Code Climate][codeclimate-status-svg]][codeclimate-status-link] +[![Scrutinizer Code Quality][scrutinizer-status-svg]][scrutinizer-status-link] +[![Downloads][downloads-svg]][downloads-link] +[![Docs][docs-rubydoc-svg]][docs-rubydoc-link] +[![License][license-svg]][license-link] +[![Stories in Ready][story-status-svg]][story-status-link] + Ruby interface to the Sumo Logic REST API. ## Usage -The interface for this SDK is still being built out to follow the structure in the -[Sumo Logic Python SDK](https://github.com/SumoLogic/sumologic-python-sdk). +The Ruby SDK is ported from the [Sumo Logic Python SDK](https://github.com/SumoLogic/sumologic-python-sdk). The following methods are currently implemented: ```ruby -sumo = SumoLogic::Client.new(access_id, access_key) +sumo = SumoLogic::Client.new access_id, access_key # Search -r = sumo.search(query [, from, to, time_zone]) +r = sumo.search query [, from, to, time_zone] -r = sumo.search_job(query [, from, to, time_zone]) +r = sumo.search_job query [, from, to, time_zone] -r = sumo.search_job_records({'id' => search_job_id}, limit, offset) +r = sumo.search_job_messages {'id' => search_job_id}, limit, offset -r = sumo.search_job_status( {'id' => search_job_id}) +r = sumo.search_job_records {'id' => search_job_id}, limit, offset +r = sumo.search_job_status {'id' => search_job_id} + # Dashboards -r = sumo.dashboards() +r = sumo.dashboards -r = sumo.dashboard(dashboard_id) +r = sumo.dashboard dashboard_id -r = sumo.dashboard_data(dashboard_id) +r = sumo.dashboard_data dashboard_id + +# Collectors +r = sumo.collectors [limit, offset] + +r = sumo.collector collector_id + +r = sumo.update_collector collector, etag + +r = sumo.delete_collector collector + +# Sources +r = sumo.sources collector_id [, limit, offset] + +r = sumo.source collector_id, source_id + +r = sumo.update_source collector_id, source, etag + +r = sumo.delete_source collector_id, source + +# Content +r = sumo.create_content path, data + +r = sumo.get_content path + +r = sumo.delete_content path ``` Note, for the search methods, the query parameter can be exactly the same query that is entered into the Sumo Logic web console. Example scripts are located in the `scripts` directory of the [GitHub repo](https://github.com/grokify/sumologic-sdk-ruby). @@ -51,10 +80,11 @@ * https://github.com/grokify/sumologic-sdk-ruby Sumo Logic API Documentation +* https://help.sumologic.com/APIs * https://github.com/SumoLogic/sumo-api-doc/wiki Sumo Logic Python SDK * https://github.com/SumoLogic/sumologic-python-sdk @@ -69,6 +99,23 @@ ## License Sumo Logic Ruby SDK is available under an MIT-style license. See [LICENSE.txt](LICENSE.txt) for details. -Sumo Logic Ruby SDK © 2015 by John Wang \ No newline at end of file +Sumo Logic Ruby SDK © 2015-2016 by John Wang + + [gem-version-svg]: https://badge.fury.io/rb/sumologic.svg + [gem-version-link]: http://badge.fury.io/rb/sumologic + [downloads-svg]: http://ruby-gem-downloads-badge.herokuapp.com/sumologic + [downloads-link]: https://rubygems.org/gems/sumologic + [build-status-svg]: https://api.travis-ci.org/grokify/sumologic-sdk-ruby.svg?branch=master + [build-status-link]: https://travis-ci.org/grokify/sumologic-sdk-ruby + [codeclimate-status-svg]: https://codeclimate.com/github/grokify/sumologic-sdk-ruby/badges/gpa.svg + [codeclimate-status-link]: https://codeclimate.com/github/grokify/sumologic-sdk-ruby + [scrutinizer-status-svg]: https://scrutinizer-ci.com/g/grokify/sumologic-sdk-ruby/badges/quality-score.png?b=master + [scrutinizer-status-link]: https://scrutinizer-ci.com/g/grokify/sumologic-sdk-ruby/?branch=master + [story-status-svg]: https://badge.waffle.io/grokify/sumologic-sdk-ruby.svg?label=ready&title=Ready + [story-status-link]: https://waffle.io/grokify/sumologic-sdk-ruby + [docs-rubydoc-svg]: https://img.shields.io/badge/docs-rubydoc-blue.svg + [docs-rubydoc-link]: http://www.rubydoc.info/gems/sumologic/ + [license-svg]: https://img.shields.io/badge/license-MIT-blue.svg + [license-link]: https://github.com/grokify/sumologic-sdk-ruby/blob/master/LICENSE.txt