metronome-client 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 2abb65c33ffa196efaaa5437d616f83236e9e272
4
+ data.tar.gz: ecc6ff76d19db43d30d24195583925950327b3e4
5
+ SHA512:
6
+ metadata.gz: fe75ebb995d0a53ff2a11c1d8194e8548fa60a28195891f8dcf11ff2f2159290191c98378ba56d04f6dcc79dff6ae5be45a8d42a820c293c56243b8d8bf952da
7
+ data.tar.gz: 732599ce0408bc2efb59fe964864669780413e52ab8295ec5f2f1ca6c40e9b887b8d6f6f8a0ba1c5fe109dbecdf8f36450b3b0810aa12f43d96cee48391996ad
data/.gitignore ADDED
@@ -0,0 +1,17 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ # rspec failure tracking
11
+ .rspec_status
12
+
13
+ Gemfile.lock
14
+ target/
15
+ test.rb
16
+
17
+ metronome-client-0.1.0.gem
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.travis.yml ADDED
@@ -0,0 +1,8 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.4.1
5
+ before_install: gem install bundler -v 1.16.0
6
+ script:
7
+ - bundle exec rubocop
8
+ - bundle exec rspec
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in metronome-client.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Duranleau,Christian
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,69 @@
1
+ # Metronome::Ruby
2
+
3
+ A simple ruby client for [Metronome](https://github.com/dcos/metronome)
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'metronome-client'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install metronome-client
20
+
21
+ ## Usage
22
+
23
+ Configure with an authentication token
24
+ ```
25
+ require 'metronome'
26
+ Metronome.configure('http://url', token: 'token')
27
+ ```
28
+
29
+ Once the client is configured,
30
+
31
+ ### Jobs
32
+
33
+ ```ruby
34
+ puts Metronome::Job.all
35
+ #<Flexirest::ResultIterator:0x007fdddb39d558>
36
+ puts Metronome::Job.find('cloud-app-engineering-security-dev-plugins-observatoryhttp')
37
+ #<Metronome::Job:0x007fdddb34cc70>
38
+ ```
39
+
40
+ ### Runs
41
+
42
+ ```ruby
43
+
44
+ puts Metronome::Run.all(job_id: j.id)
45
+ #<Flexirest::ResultIterator:0x007feb06307cf0>
46
+ puts Metronome::Run.find(job_id: 'id_one', run_id: 'id')
47
+ #<Metronome::Run:0x007fdddb34cc70>
48
+ ```
49
+
50
+ ### Metrics
51
+
52
+ ```ruby
53
+ puts Metronome::Metric.all
54
+ #<Metronome::Metric:0x007ff1810c8648>
55
+ ```
56
+
57
+ ## Development
58
+
59
+ After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rake test` to run the tests.
60
+
61
+ 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](https://rubygems.org).
62
+
63
+ ## Contributing
64
+
65
+ Bug reports and pull requests are welcome on GitHub at https://github.com/cduranleau/metronome-ruby.
66
+
67
+ ## License
68
+
69
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require 'bundler/gem_tasks'
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task default: :spec
data/lib/metronome.rb ADDED
@@ -0,0 +1,28 @@
1
+ require 'metronome/version'
2
+
3
+ require 'flexirest'
4
+ require 'metronome/entities/job'
5
+ require 'metronome/entities/run'
6
+ require 'metronome/entities/schedule'
7
+ require 'metronome/entities/metric'
8
+
9
+ # Configuration for Metronome connection
10
+ module Metronome
11
+ # Configuration for Metronome connection
12
+ def self.configure(url, options = {})
13
+ raise 'You must supply a URL' if url.nil? || url.empty?
14
+ raise 'Missing :token' unless options.key?(:token)
15
+
16
+ Flexirest::Base.base_url = url
17
+
18
+ Flexirest::Base.faraday_config do |c|
19
+ c.use Faraday::Response::RaiseError
20
+ c.headers['Content-Type'] = 'application/json'
21
+ # TODO: add in un/pw validation
22
+ c.headers['Authorization'] = "token=#{options[:token]}"
23
+ c.ssl.verify = false # TODO: Remove this
24
+ c.path_prefix = '/service/metronome'
25
+ c.adapter Faraday.default_adapter
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,11 @@
1
+
2
+ module Metronome
3
+ # Gets/Puts/Posts for jobs
4
+ class Job < Flexirest::Base
5
+ get :all, 'v1/jobs'
6
+ get :find, 'v1/jobs/:id'
7
+ put :save, 'v1/jobs/:id'
8
+ post :create, 'v1/jobs'
9
+ delete :remove, 'v1/jobs/:id'
10
+ end
11
+ end
@@ -0,0 +1,6 @@
1
+ module Metronome
2
+ # Gets/Puts/Posts for metrics
3
+ class Metric < Flexirest::Base
4
+ get :all, 'v1/metrics'
5
+ end
6
+ end
@@ -0,0 +1,9 @@
1
+ module Metronome
2
+ # Gets/Puts/Posts for runs
3
+ class Run < Flexirest::Base
4
+ get :all, 'v1/jobs/:job_id/runs'
5
+ post :start, 'v1/jobs/:job_id/runs'
6
+ get :find, 'v1/jobs/:job_id/runs/:run_id'
7
+ post :stop, 'v1/jobs/:job_id/runs/:run_id'
8
+ end
9
+ end
@@ -0,0 +1,11 @@
1
+ module Metronome
2
+ # Gets/Puts/Posts for schedules
3
+ class Schedule < Flexirest::Base
4
+ get :all, 'v1/jobs/:job_id/schedules'
5
+ post :start, 'v1/jobs/:job_id/schedules'
6
+
7
+ get :find, 'v1/jobs/:job_id/schedules/:schedule_id'
8
+ put :save, 'v1/jobs/:job_id/schedules/:schedule_id'
9
+ delete :remove, 'v1/jobs/:job_id/schedules/:schedule_id'
10
+ end
11
+ end
@@ -0,0 +1,3 @@
1
+ module Metronome
2
+ VERSION = '0.1.0'.freeze
3
+ end
@@ -0,0 +1,29 @@
1
+
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'metronome/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = 'metronome-client'
8
+ spec.version = Metronome::VERSION
9
+ spec.authors = ['Christian Duranleau']
10
+ spec.email = ['cduranleau@gmail.com']
11
+
12
+ spec.summary = 'Metronome client'
13
+ spec.description = 'Metronome client that uses flexirest'
14
+ spec.homepage = 'https://github.com/cduranleau/metronome-ruby'
15
+ spec.license = 'MIT'
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
18
+ f.match(%r{^(test|spec|features)/})
19
+ end
20
+ spec.require_paths = ['lib']
21
+
22
+ spec.add_dependency 'flexirest', '~> 1.5'
23
+
24
+ spec.add_development_dependency 'bundler', '~> 1.16'
25
+ spec.add_development_dependency 'rake', '~> 12.3'
26
+ spec.add_development_dependency 'rspec', '~> 3.7'
27
+ spec.add_development_dependency 'rubocop', '~> 0.51'
28
+ spec.add_development_dependency 'simplecov', '~> 0.15'
29
+ end
metadata ADDED
@@ -0,0 +1,142 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: metronome-client
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Christian Duranleau
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2017-11-22 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: flexirest
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.5'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.5'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.16'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.16'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '12.3'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '12.3'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.7'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.7'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rubocop
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '0.51'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '0.51'
83
+ - !ruby/object:Gem::Dependency
84
+ name: simplecov
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '0.15'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '0.15'
97
+ description: Metronome client that uses flexirest
98
+ email:
99
+ - cduranleau@gmail.com
100
+ executables: []
101
+ extensions: []
102
+ extra_rdoc_files: []
103
+ files:
104
+ - ".gitignore"
105
+ - ".rspec"
106
+ - ".travis.yml"
107
+ - Gemfile
108
+ - LICENSE.txt
109
+ - README.md
110
+ - Rakefile
111
+ - lib/metronome.rb
112
+ - lib/metronome/entities/job.rb
113
+ - lib/metronome/entities/metric.rb
114
+ - lib/metronome/entities/run.rb
115
+ - lib/metronome/entities/schedule.rb
116
+ - lib/metronome/version.rb
117
+ - metronome-client.gemspec
118
+ homepage: https://github.com/cduranleau/metronome-ruby
119
+ licenses:
120
+ - MIT
121
+ metadata: {}
122
+ post_install_message:
123
+ rdoc_options: []
124
+ require_paths:
125
+ - lib
126
+ required_ruby_version: !ruby/object:Gem::Requirement
127
+ requirements:
128
+ - - ">="
129
+ - !ruby/object:Gem::Version
130
+ version: '0'
131
+ required_rubygems_version: !ruby/object:Gem::Requirement
132
+ requirements:
133
+ - - ">="
134
+ - !ruby/object:Gem::Version
135
+ version: '0'
136
+ requirements: []
137
+ rubyforge_project:
138
+ rubygems_version: 2.6.12
139
+ signing_key:
140
+ specification_version: 4
141
+ summary: Metronome client
142
+ test_files: []