sumologic 0.0.4 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 82e71f26d737a16fa3be8725e9682190d0a35644
-  data.tar.gz: ea4659b8b3b8ac5391bb1e213fb3a0b572d8b1ee
+SHA256:
+  metadata.gz: e0a2d652ea33bfff6d30ad4ec9d4c0c60fe9797951b8cbc8d9503468f89ea639
+  data.tar.gz: 259ef8c527bcbcc937f69b16313b0ab395ac78a3c8592656607bfb287ff226f3
 SHA512:
-  metadata.gz: ce3d3e2f6ebeaf48876a50fd8035c00d0bb6d4fdda250725d737230a2f7223e76e5b073b6744e8fed687188db9d1f0c96336faf3f0a17230760a3357a803caa0
-  data.tar.gz: b153ae1c248995ec482ced3f9f87568c5b2beebd1eac83039f2e90e4ea724bda865a5d09d0d98fd47ec1912f8e6f433c122795e8bf930adb6eca7893b6772f09
+  metadata.gz: 0a83123eb9d5f2ee1d8df627d245bb2e2f44fabe93703807dabd6dc6e5b9b286db68ea0fd2589b037590a28bc43ada3cec4b76467695cec4feaf2d5f0072b4ca
+  data.tar.gz: 42edc7494d98554f6c81b98303e310f6b7631602b3c3ef27aa80ac1ef6f26b3af06288547c7ca393b75ad2f7bab736819f2b4c18102a935c0b04f7c8cbcf983b

data/CHANGELOG.md

@@ -1,11 +1,25 @@
 CHANGELOG
 ---------
-- **2015-09-14**: 0.0.3
+- **0.1.0** - 2016-10-23
+  - Add `search_job_messages` method
+  - Add `collectors`, `collector`, `update_collector`, `delete_collector` methods
+  - Add `sources`, `source`, `update_source`, `delete_source` methods
+  - Add `create_content`, `get_content`, `delete_content` methods
+  - Add redirect support
+  - Add accessor for Faraday HTTP client
+  - Add Waffle.io project and shield
+- **0.0.5** - 2016-02-05
+  - Update to Ruby 1.9 hash syntax
+  - Remove `version.rb` file
+- **0.0.4** - 2015-10-02
+  - Add dashboard support: `dashboards`, `dashboard`, and `dashboard_data`
+- **0.0.3** - 2015-09-14
   - Add Scrutinizer support
   - Update `README.md`
-- **2015-07-11**: 0.0.2
-  - Add single shot search() method
+- **0.0.2** - 2015-07-11
+  - Add single shot search support: `search`
   - Add Travis CI support
   - Add Code Climate support
-- **2015-06-09**: 0.0.1
+- **0.0.1** - 2015-06-09
   - Initial commit
+  - Add search job support: `search_job`, `search_job_status`, `search_job_records`

data/{LICENSE.txt → LICENSE.md}

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 John Wang
+Copyright (c) 2015-2023 John Wang
  
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,40 +1,66 @@
 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]
+[![Docs][docs-rubydoc-svg]][docs-rubydoc-link]
+[![License][license-svg]][license-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_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
 
-r = sumo.dashboard(dashboard_id)
+# Sources
+r = sumo.sources collector_id [, limit, offset]
 
-r = sumo.dashboard_data(dashboard_id)
+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.
@@ -53,6 +79,7 @@ Project Repo
 
 Sumo Logic API Documentation
 
+* https://help.sumologic.com/APIs
 * https://github.com/SumoLogic/sumo-api-doc/wiki
 
 Sumo Logic Python SDK
@@ -69,6 +96,27 @@ Please report these on [Github](https://github.com/grokify/sumologic-sdk-ruby)
 
 ## 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
+Sumo Logic Ruby SDK is available under an MIT-style license. See [LICENSE.md](LICENSE.md) for details.
+
+Sumo Logic Ruby SDK © 2015-2023 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
+ [dependency-status-svg]: https://gemnasium.com/grokify/sumologic-sdk-ruby.svg
+ [dependency-status-link]: https://gemnasium.com/grokify/sumologic-sdk-ruby
+ [codacy-svg]: https://api.codacy.com/project/badge/Grade/d6c7f184a9394629a9a65a1406e9f767
+ [codacy-link]: https://www.codacy.com/app/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

data/Rakefile

@@ -14,6 +14,6 @@ end
 desc 'Generate YARD documentation.'
 task :gendoc do
   # puts 'yard doc generation disabled until JRuby build native extensions for redcarpet or yard removes the dependency.'
-  system "yardoc"
-  system "yard stats --list-undoc"
+  system 'yardoc'
+  system 'yard stats --list-undoc'
 end

data/lib/sumologic.rb

@@ -4,77 +4,131 @@ require 'faraday-cookie_jar'
 require 'multi_json'
 
 module SumoLogic
-
+  VERSION = '0.1.1'
   URL = 'https://api.sumologic.com/api/v1'
 
   class Client
+    attr_accessor :http
 
     def initialize(access_id=nil, access_key=nil, endpoint=SumoLogic::URL)
       @endpoint = endpoint
-      @session  = Faraday
-      headers   = {'Content-Type' => 'application/json', 'Accept' => 'application/json'}
-      @session  = Faraday.new(:url => @endpoint, :headers => headers) do |conn|
+      headers = {'Content-Type' => 'application/json', 'Accept' => 'application/json'}
+      @http = Faraday.new(url: @endpoint, headers: headers) do |conn|
         conn.basic_auth(access_id, access_key)
+        conn.use      FaradayMiddleware::FollowRedirects, limit: 5
         conn.use      :cookie_jar
         conn.request  :json
-        conn.response :json, :content_type => 'application/json'
+        conn.response :json, content_type: 'application/json'
         conn.adapter  Faraday.default_adapter
       end
     end
 
+    def post(path, data={})
+      @http.post do |req|
+        req.url path
+        req.body = data unless data.empty?
+      end
+    end
+
     def search(query, from_time=nil, to_time=nil, time_zone='UTC')
-      params = {:q => query, :from => from_time, :to => to_time, :tz => time_zone}
-      r = @session.get do |req|
+      @http.get do |req|
         req.url 'logs/search'
-        req.params = params
-      end    
+        req.params = {q: query, from: from_time, to: to_time, tz: time_zone}
+      end
     end
 
     def search_job(query, from_time=nil, to_time=nil, time_zone='UTC')
-      params = {:query => query, :from => from_time, :to => to_time, :timeZone => time_zone}
-      r = @session.post do |req|
+      params = {query: query, from: from_time, to: to_time, timeZone: time_zone}
+      @http.post do |req|
         req.url 'search/jobs'
         req.body = MultiJson.encode(params)
       end
     end
 
     def search_job_status(search_job={})
-      r = @session.get do |req|
-        req.url 'search/jobs/' + search_job['id'].to_s
-      end
+      @http.get "search/jobs/#{search_job['id']}"
+    end
+
+    def search_job_messages(search_job, limit=nil, offset=0)
+      @http.get "search/jobs/#{search_job['id']}/messages", params_limit_offset(limit, offset)
     end
-    
+
     def search_job_records(search_job, limit=nil, offset=0)
-      params = {:limit => limit, :offset => offset}
-      r = @session.get do |req|
-        req.url 'search/jobs/' + search_job['id'].to_s + '/records'
-        req.params = params
+      @http.get "search/jobs/#{search_job['id']}/records", params_limit_offset(limit, offset)
+    end
+
+    def collectors(limit=nil, offset=nil)
+      @http.get 'collectors', params_limit_offset(limit, offset)
+    end
+
+    def collector(collector_id)
+      @http.get "collectors/#{collector_id}"
+    end
+
+    def update_collector(collector, etag)
+      @http.put do |req|
+        req.url "collectors/#{collector['collector']['id']}"
+        req.headers['If-Match'] = etag
+        req.body = collector
       end
     end
 
-    def dashboards(monitors=false)
-      params = {:dashboards => monitors}
-      r = @session.get do |req|
-        req.url 'dashboards'
-        req.params = params
+    def delete_collector(collector)
+      @http.delete "collectors/#{collector['id']}"
+    end
+
+    def sources(collector_id, limit=nil, offset=nil)
+      @http.get "collectors/#{collector_id}/sources", params_limit_offset(limit, offset)
+    end
+
+    def source(collector_id, source_id)
+      @http.get "collectors/#{collector_id}/sources/#{source_id}"
+    end
+
+    def update_source(collector_id, source, etag)
+      @http.put do |req|
+        req.url "collectors/#{collector_id}/sources/#{source['source']['id']}"
+        req.headers['If-Match'] = etag
+        req.body = source
       end
-      return r.body.has_key?('dashboards') ? r.body['dashboards'] : nil
+    end
+
+    def delete_source(collector_id, source)
+      @http.delete "collectors/#{collector_id}/sources/#{source['source']['id']}"
+    end
+
+    def create_content(path, data)
+      @http.post "content/#{path}", data
+    end
+
+    def get_content(path)
+      @http.get "content/#{path}"
+    end
+
+    def delete_content(path)
+      @http.delete "content/#{path}"
+    end
+
+    def dashboards(monitors=false)
+      r = @http.get 'dashboards', {dashboards: monitors}
+      return r.body.key?('dashboards') ? r.body['dashboards'] : nil
     end
 
     def dashboard(dashboard_id)
-      r = @session.get do |req|
-        req.url 'dashboards/' + dashboard_id.to_s
-      end
-      return r.body.has_key?('dashboard') ? r.body['dashboard'] : nil
+      r = @http.get "dashboards/#{dashboard_id}"
+      return r.body.key?('dashboard') ? r.body['dashboard'] : nil
     end
 
     def dashboard_data(dashboard_id)
-      r = @session.get do |req|
-        req.url 'dashboards/' + dashboard_id.to_s + '/data'
-      end
-      return r.body.has_key?('dashboardMonitorDatas') ? r.body['dashboardMonitorDatas'] : nil
+      r = @http.get "dashboards/#{dashboard_id}/data"
+      return r.body.key?('dashboardMonitorDatas') ? r.body['dashboardMonitorDatas'] : nil
     end
 
+    def params_limit_offset(limit, offset)
+      params = {}
+      params[:limit] = limit unless limit.nil?
+      params[:offset] = offset unless offset.nil?
+      params
+    end
   end
-
 end

data/test/test_helper.rb

@@ -4,7 +4,4 @@ Coveralls.wear!
 require 'test/unit'
 require 'sumologic'
 
-client = SumoLogic::Client.new(
-  'myAccessId',
-  'myAccessKey'
-)
+SumoLogic::Client.new 'myAccessId', 'myAccessKey'

data/test/test_setup.rb

@@ -3,7 +3,7 @@ require './test/test_helper.rb'
 require 'sumologic'
 
 class SumoLogicTest < Test::Unit::TestCase
-  def testSetup
+  def test_setup
 
     client = SumoLogic::Client.new(
       'myAccessId',

metadata

@@ -1,133 +1,207 @@
 --- !ruby/object:Gem::Specification
 name: sumologic
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.1
 platform: ruby
 authors:
 - John Wang
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-10-02 00:00:00.000000000 Z
+date: 2023-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
-    - - '>='
+        version: '1.10'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 1.10.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
-    - - '>='
+        version: '1.10'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 1.10.3
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-    - - '>='
+        version: '1.2'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-    - - '>='
+        version: '1.2'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: faraday-cookie_jar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-description: Ruby Sumo Logic SDK for the Sumo Logic REST API
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description:
 email: johncwang@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- LICENSE.txt
+- LICENSE.md
 - README.md
 - Rakefile
-- VERSION.txt
 - lib/sumologic.rb
-- lib/sumologic/version.rb
 - test/test_helper.rb
 - test/test_setup.rb
 homepage: https://github.com/grokify/sumologic-sdk-ruby
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.1.5
-signing_key: 
+rubygems_version: 3.4.2
+signing_key:
 specification_version: 4
 summary: Ruby Sumo Logic SDK for the Sumo Logic REST API
-test_files: []
+test_files:
+- test/test_helper.rb
+- test/test_setup.rb

data/VERSION.txt

@@ -1 +0,0 @@
-0.0.4

data/lib/sumologic/version.rb

@@ -1,3 +0,0 @@
-module SumoLogic
-  VERSION = '0.0.4'
-end