sonar-client 0.0.1 → 0.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (7) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +3 -1
  4. data/lib/sonar/cli/cli.rb +33 -8
  5. data/lib/sonar/cli/rcfile.rb +2 -0
  6. data/lib/sonar/version.rb +1 -1
  7. metadata +38 -38
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 9e04adb9fca3c12bc9ae907eaa64df648c568ca6
4
- data.tar.gz: f363d98148215460920438b61f5c0f025224bbdb
3
+ metadata.gz: 5880f8913b5f5cde97f0ec7bbc57db5ab17e4c03
4
+ data.tar.gz: f42f280930382afc000aaae0f77081dbf908805e
5
5
  SHA512:
6
- metadata.gz: d80394c4745caba23f50df647c3b83ecfa0dccbbc76afe1986021f7f904e14bdf1d4a3c11b86ecee306e9ddc6247ff5b70aa3d48fad4213aea3aacaf5646c44a
7
- data.tar.gz: 40263868a73f583575e963a2573a82a39b8e3c00ce0f37ba37d5f4c7ddda6c0d67fb17c98ecdb6dda8bc68fcdf71c10915fbcfd56945545496a9a71b1ab5ed58
6
+ metadata.gz: 81d8366866002b3e468ccfd8e93011a3eb7e7fa67ddf07223c346d5141f906a45922572fec455ca101317ae639f44c685e04e556b4695f6604517b406e0f4679
7
+ data.tar.gz: e72e00fc42c7bca8055a8dc6d093e1fcc43f1d5c97ee4299b18e60e1a57b351277fdb50e3812d810b421a09e78f83a711e5e833ca372b1a647b992bee6f15a7f
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- sonar-client (0.0.1)
4
+ sonar-client (0.0.2)
5
5
  awesome_print
6
6
  faraday_middleware (~> 0.9.0)
7
7
  hashie (~> 2.0.3)
data/README.md CHANGED
@@ -65,8 +65,10 @@ On the first run, sonar will setup a sonar.rc config file in your user folder.
65
65
  email: YOUR_EMAIL
66
66
  access_token: SONAR_TOKEN
67
67
  api_url: https://sonar.labs.rapid7.com
68
+ format: flat
69
+ record_limit: 10000
68
70
  ```
69
- Replace YOUR_EMAIL with the email you used to register on the [Sonar website](https://sonar.labs.rapid7.com). Replace SONAR_TOKEN with your API token found on the [Settings page](https://sonar.labs.rapid7.com/users/edit) of the Sonar website. Enclosing quotes around these two credentials are not needed.
71
+ Replace YOUR_EMAIL with the email you used to register on the [Sonar website](https://sonar.labs.rapid7.com). Replace SONAR_TOKEN with your API token found on the [Settings page](https://sonar.labs.rapid7.com/users/edit) of the Sonar website. The format option can either pretty-print the return JSON or display it in a flat output (by default). The record limit is the maximum number of records to return for a query. Responses are returned in 1000 record chunks that are streamed into the output to avoid API timeouts. Enclosing quotes around these two settings are not needed. These configurations can always be overwritten for a single command line query by specifying the option and argument: `--format pretty`.
70
72
 
71
73
  ## CLI usage
72
74
 
data/lib/sonar/cli/cli.rb CHANGED
@@ -8,39 +8,64 @@ module Sonar
8
8
  class CLI < Thor
9
9
  class_option 'profile', aliases: '-P', type: :string, default: File.join(File.expand_path('~'), Sonar::RCFile::FILENAME),
10
10
  desc: 'Path to Sonar RC file', banner: 'FILE'
11
+ class_option 'format', type: :string, desc: 'Flat JSON or pretty printed [flat/pretty]'
11
12
 
12
13
  def initialize(*)
13
- @rcfile = Sonar::RCFile.instance.load_file
14
- @client = Sonar::Client.new(email: @rcfile["email"], access_token: @rcfile["access_token"], api_url: @rcfile["api_url"])
14
+ @config = Sonar::RCFile.instance.load_file
15
+ @client = Sonar::Client.new(email: @config["email"], access_token: @config["access_token"], api_url: @config["api_url"])
15
16
  super
16
17
  end
17
18
 
18
19
  desc 'profile', 'Display the current profile from sonar.rc'
19
20
  def profile
20
- ap @rcfile
21
+ ap @config
21
22
  end
22
23
 
23
- desc 'usage', 'Display API usage for current user.'
24
+ desc 'usage', 'Display API usage for current user'
24
25
  def usage
25
26
  ap @client.usage
26
27
  end
27
28
 
28
- desc 'search [QUERY TYPE] [QUERY TERM]', 'Search anything from Sonar.'
29
+ desc 'search [QUERY TYPE] [QUERY TERM]', 'Search anything from Sonars'
30
+ method_option 'record_limit', type: :numeric, aliases: '-n', desc: 'Maximum number of records to fetch'
29
31
  def search(type, term)
30
32
  @query = {}
31
33
  @query[type.to_sym] = term
32
- ap @client.search(@query)
34
+ @query[:limit] = options['record_limit']
35
+ @client.search(@query).each do |data|
36
+ print_json(data, options['format'])
37
+ end
33
38
  end
34
39
 
35
- desc 'types', 'List all Sonar query types.'
40
+ desc 'types', 'List all Sonar query types'
36
41
  def types
37
42
  ap Search::QUERY_TYPES_MAP
38
43
  end
39
44
 
40
- desc 'config', 'Update Sonar config file'
45
+ desc 'config', 'Sonar config file location'
41
46
  def config
42
47
  # TODO: add a way to set config
43
48
  puts "Your config file is located at #{RCFile.instance.path}"
44
49
  end
50
+
51
+ private
52
+
53
+ def print_json(json, format)
54
+ case format
55
+ when 'pretty'
56
+ ap(json)
57
+ else
58
+ # TODO: use a faster JSON generator?
59
+ puts(json.to_json)
60
+ end
61
+ end
62
+
63
+ # Merge Thor options with those stored in sonar.rc file
64
+ # where all default options are set.
65
+ def options
66
+ original_options = super
67
+ user_defaults = @config
68
+ user_defaults.merge(original_options)
69
+ end
45
70
  end
46
71
  end
data/lib/sonar/cli/rcfile.rb CHANGED
@@ -19,6 +19,8 @@ module Sonar
19
19
  f.puts 'email: YOUR_EMAIL'
20
20
  f.puts 'access_token: SONAR_TOKEN'
21
21
  f.puts 'api_url: https://sonar.labs.rapid7.com'
22
+ f.puts 'format: flat'
23
+ f.puts 'record_limit: 10000'
22
24
  end
23
25
  puts "Config file setup at: #{@path}"
24
26
  end
data/lib/sonar/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Sonar
2
- VERSION = "0.0.1"
2
+ VERSION = "0.0.2"
3
3
  end
metadata CHANGED
@@ -1,223 +1,223 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: sonar-client
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1
4
+ version: 0.0.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Paul Deardorff & HD Moore
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2015-01-15 00:00:00.000000000 Z
11
+ date: 2015-03-14 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday_middleware
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - "~>"
17
+ - - ~>
18
18
  - !ruby/object:Gem::Version
19
19
  version: 0.9.0
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
- - - "~>"
24
+ - - ~>
25
25
  - !ruby/object:Gem::Version
26
26
  version: 0.9.0
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: hashie
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
- - - "~>"
31
+ - - ~>
32
32
  - !ruby/object:Gem::Version
33
33
  version: 2.0.3
34
34
  type: :runtime
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
- - - "~>"
38
+ - - ~>
39
39
  - !ruby/object:Gem::Version
40
40
  version: 2.0.3
41
41
  - !ruby/object:Gem::Dependency
42
42
  name: multi_json
43
43
  requirement: !ruby/object:Gem::Requirement
44
44
  requirements:
45
- - - ">="
45
+ - - '>='
46
46
  - !ruby/object:Gem::Version
47
47
  version: '0'
48
48
  type: :runtime
49
49
  prerelease: false
50
50
  version_requirements: !ruby/object:Gem::Requirement
51
51
  requirements:
52
- - - ">="
52
+ - - '>='
53
53
  - !ruby/object:Gem::Version
54
54
  version: '0'
55
55
  - !ruby/object:Gem::Dependency
56
56
  name: thor
57
57
  requirement: !ruby/object:Gem::Requirement
58
58
  requirements:
59
- - - ">="
59
+ - - '>='
60
60
  - !ruby/object:Gem::Version
61
61
  version: '0'
62
62
  type: :runtime
63
63
  prerelease: false
64
64
  version_requirements: !ruby/object:Gem::Requirement
65
65
  requirements:
66
- - - ">="
66
+ - - '>='
67
67
  - !ruby/object:Gem::Version
68
68
  version: '0'
69
69
  - !ruby/object:Gem::Dependency
70
70
  name: awesome_print
71
71
  requirement: !ruby/object:Gem::Requirement
72
72
  requirements:
73
- - - ">="
73
+ - - '>='
74
74
  - !ruby/object:Gem::Version
75
75
  version: '0'
76
76
  type: :runtime
77
77
  prerelease: false
78
78
  version_requirements: !ruby/object:Gem::Requirement
79
79
  requirements:
80
- - - ">="
80
+ - - '>='
81
81
  - !ruby/object:Gem::Version
82
82
  version: '0'
83
83
  - !ruby/object:Gem::Dependency
84
84
  name: bundler
85
85
  requirement: !ruby/object:Gem::Requirement
86
86
  requirements:
87
- - - ">="
87
+ - - '>='
88
88
  - !ruby/object:Gem::Version
89
89
  version: '0'
90
90
  type: :development
91
91
  prerelease: false
92
92
  version_requirements: !ruby/object:Gem::Requirement
93
93
  requirements:
94
- - - ">="
94
+ - - '>='
95
95
  - !ruby/object:Gem::Version
96
96
  version: '0'
97
97
  - !ruby/object:Gem::Dependency
98
98
  name: rake
99
99
  requirement: !ruby/object:Gem::Requirement
100
100
  requirements:
101
- - - ">="
101
+ - - '>='
102
102
  - !ruby/object:Gem::Version
103
103
  version: '0'
104
104
  type: :development
105
105
  prerelease: false
106
106
  version_requirements: !ruby/object:Gem::Requirement
107
107
  requirements:
108
- - - ">="
108
+ - - '>='
109
109
  - !ruby/object:Gem::Version
110
110
  version: '0'
111
111
  - !ruby/object:Gem::Dependency
112
112
  name: rspec
113
113
  requirement: !ruby/object:Gem::Requirement
114
114
  requirements:
115
- - - ">="
115
+ - - '>='
116
116
  - !ruby/object:Gem::Version
117
117
  version: '0'
118
118
  type: :development
119
119
  prerelease: false
120
120
  version_requirements: !ruby/object:Gem::Requirement
121
121
  requirements:
122
- - - ">="
122
+ - - '>='
123
123
  - !ruby/object:Gem::Version
124
124
  version: '0'
125
125
  - !ruby/object:Gem::Dependency
126
126
  name: simplecov
127
127
  requirement: !ruby/object:Gem::Requirement
128
128
  requirements:
129
- - - ">="
129
+ - - '>='
130
130
  - !ruby/object:Gem::Version
131
131
  version: '0'
132
132
  type: :development
133
133
  prerelease: false
134
134
  version_requirements: !ruby/object:Gem::Requirement
135
135
  requirements:
136
- - - ">="
136
+ - - '>='
137
137
  - !ruby/object:Gem::Version
138
138
  version: '0'
139
139
  - !ruby/object:Gem::Dependency
140
140
  name: simplecov-rcov
141
141
  requirement: !ruby/object:Gem::Requirement
142
142
  requirements:
143
- - - ">="
143
+ - - '>='
144
144
  - !ruby/object:Gem::Version
145
145
  version: '0'
146
146
  type: :development
147
147
  prerelease: false
148
148
  version_requirements: !ruby/object:Gem::Requirement
149
149
  requirements:
150
- - - ">="
150
+ - - '>='
151
151
  - !ruby/object:Gem::Version
152
152
  version: '0'
153
153
  - !ruby/object:Gem::Dependency
154
154
  name: yard
155
155
  requirement: !ruby/object:Gem::Requirement
156
156
  requirements:
157
- - - ">="
157
+ - - '>='
158
158
  - !ruby/object:Gem::Version
159
159
  version: '0'
160
160
  type: :development
161
161
  prerelease: false
162
162
  version_requirements: !ruby/object:Gem::Requirement
163
163
  requirements:
164
- - - ">="
164
+ - - '>='
165
165
  - !ruby/object:Gem::Version
166
166
  version: '0'
167
167
  - !ruby/object:Gem::Dependency
168
168
  name: vcr
169
169
  requirement: !ruby/object:Gem::Requirement
170
170
  requirements:
171
- - - "~>"
171
+ - - ~>
172
172
  - !ruby/object:Gem::Version
173
173
  version: 2.8.0
174
174
  type: :development
175
175
  prerelease: false
176
176
  version_requirements: !ruby/object:Gem::Requirement
177
177
  requirements:
178
- - - "~>"
178
+ - - ~>
179
179
  - !ruby/object:Gem::Version
180
180
  version: 2.8.0
181
181
  - !ruby/object:Gem::Dependency
182
182
  name: shoulda
183
183
  requirement: !ruby/object:Gem::Requirement
184
184
  requirements:
185
- - - ">="
185
+ - - '>='
186
186
  - !ruby/object:Gem::Version
187
187
  version: '0'
188
188
  type: :development
189
189
  prerelease: false
190
190
  version_requirements: !ruby/object:Gem::Requirement
191
191
  requirements:
192
- - - ">="
192
+ - - '>='
193
193
  - !ruby/object:Gem::Version
194
194
  version: '0'
195
195
  - !ruby/object:Gem::Dependency
196
196
  name: webmock
197
197
  requirement: !ruby/object:Gem::Requirement
198
198
  requirements:
199
- - - "~>"
199
+ - - ~>
200
200
  - !ruby/object:Gem::Version
201
201
  version: 1.8.0
202
202
  type: :development
203
203
  prerelease: false
204
204
  version_requirements: !ruby/object:Gem::Requirement
205
205
  requirements:
206
- - - "~>"
206
+ - - ~>
207
207
  - !ruby/object:Gem::Version
208
208
  version: 1.8.0
209
209
  - !ruby/object:Gem::Dependency
210
210
  name: api_matchers
211
211
  requirement: !ruby/object:Gem::Requirement
212
212
  requirements:
213
- - - ">="
213
+ - - '>='
214
214
  - !ruby/object:Gem::Version
215
215
  version: '0'
216
216
  type: :development
217
217
  prerelease: false
218
218
  version_requirements: !ruby/object:Gem::Requirement
219
219
  requirements:
220
- - - ">="
220
+ - - '>='
221
221
  - !ruby/object:Gem::Version
222
222
  version: '0'
223
223
  description: API Wrapper for Sonar
@@ -229,9 +229,9 @@ executables:
229
229
  extensions: []
230
230
  extra_rdoc_files: []
231
231
  files:
232
- - ".gitignore"
233
- - ".rspec"
234
- - ".rubocop.yml"
232
+ - .gitignore
233
+ - .rspec
234
+ - .rubocop.yml
235
235
  - Gemfile
236
236
  - Gemfile.lock
237
237
  - LICENSE
@@ -266,17 +266,17 @@ require_paths:
266
266
  - lib
267
267
  required_ruby_version: !ruby/object:Gem::Requirement
268
268
  requirements:
269
- - - ">="
269
+ - - '>='
270
270
  - !ruby/object:Gem::Version
271
271
  version: '0'
272
272
  required_rubygems_version: !ruby/object:Gem::Requirement
273
273
  requirements:
274
- - - ">="
274
+ - - '>='
275
275
  - !ruby/object:Gem::Version
276
276
  version: '0'
277
277
  requirements: []
278
278
  rubyforge_project:
279
- rubygems_version: 2.4.3
279
+ rubygems_version: 2.1.11
280
280
  signing_key:
281
281
  specification_version: 4
282
282
  summary: API Wrapper for Sonar