steward-io 0.0.1

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.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 4c8f81cf4b1fceb2a4c04d28f0dc78183df7d9c0
4
+ data.tar.gz: 4255d5d3c9a5c6fecf68bb0015695d6771918dc8
5
+ SHA512:
6
+ metadata.gz: 2be574de2e46a777d2701fe092d57d51e28913d55177463c8919552c9cbbfdad2775b8692d535e149233a3fe27736ffff6bbd391a0f0900f0041dd51fe02211d
7
+ data.tar.gz: d74ce2ec057afa1fa283acb282132856c66651b5bac9c8c942142b234b7bb35d656e2f05b4120812f7b8b90fd49a88acdcce2c8e631ece3eec48b5911f4ce498
@@ -0,0 +1,18 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
18
+ .idea/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in steward-io.gemspec
4
+ gemspec
data/LICENSE ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2014 Chris Ledet
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,66 @@
1
+ # steward-io
2
+
3
+ Official Ruby client for [Steward](http://steward.io)
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ gem 'steward-io'
10
+
11
+ And then execute:
12
+
13
+ $ bundle
14
+
15
+ Or install it yourself as:
16
+
17
+ $ gem install steward-io
18
+
19
+ ## Usage
20
+
21
+ Connect to your Steward account with your access token
22
+
23
+ ```ruby
24
+ client = Steward::Client.new("st3w08aa8c4tb3w7a45rd10ef4c274d1")
25
+ ```
26
+
27
+ Notify Steward your job has started
28
+
29
+ ```ruby
30
+ client.job_started("4zWz31k")
31
+ # => {"job"=>"4zWz31k", "status"=>"started"}
32
+ ```
33
+
34
+ Notify Steward your job has finished
35
+
36
+ ```
37
+ client.job_finished("4zWz31k")
38
+ # => {"job"=>"4zWz31k", "status"=>"completed"}
39
+ ```
40
+
41
+ Notify Steward your job failed
42
+
43
+ ```ruby
44
+ client.job_failed("4zWz31k")
45
+ # => {"job"=>"4zWz31k", "status"=>"failed"}
46
+ ```
47
+
48
+ or just wrap your code inside a block.
49
+
50
+ ```ruby
51
+ client.job("4zWz31k") do
52
+ # your code here
53
+ end
54
+ # => {"job"=>"4zWz31k", "status"=>"completed"}
55
+ ```
56
+
57
+ The client will handle the start and end calls to Steward. If any exceptions
58
+ were raised inside the block, Steward will be notified that the job did actually fail.
59
+
60
+ ## Contributing
61
+
62
+ 1. Fork it
63
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
64
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
65
+ 4. Push to the branch (`git push origin my-new-feature`)
66
+ 5. Create new Pull Request
@@ -0,0 +1 @@
1
+ require "bundler/gem_tasks"
@@ -0,0 +1,5 @@
1
+ require 'steward/client'
2
+ require 'steward/version'
3
+
4
+ module Steward
5
+ end
@@ -0,0 +1,43 @@
1
+ require 'httparty'
2
+ require 'json'
3
+
4
+ module Steward
5
+ class Client
6
+ include HTTParty
7
+ base_uri 'steward.io'
8
+
9
+ attr_accessor :api_key
10
+
11
+ def initialize(api_key)
12
+ self.api_key = api_key
13
+ end
14
+
15
+ def job_started(job)
16
+ notify(job, :start)
17
+ end
18
+
19
+ def job_ended(job)
20
+ notify(job, :end)
21
+ end
22
+
23
+ def job_failed(job)
24
+ notify(job, :failed)
25
+ end
26
+
27
+ def job(job, &block)
28
+ job_started(job)
29
+ block.call
30
+ job_ended(job)
31
+ rescue Exception => e
32
+ job_failed(job)
33
+ raise e
34
+ end
35
+
36
+ private
37
+
38
+ def notify(job, endpoint)
39
+ response = self.class.get("/j/#{job}/#{endpoint}", headers: { 'X-StewardToken' => api_key })
40
+ JSON.parse(response.body)
41
+ end
42
+ end
43
+ end
@@ -0,0 +1,3 @@
1
+ module Steward
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,25 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'steward/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "steward-io"
8
+ spec.version = Steward::VERSION
9
+ spec.authors = ["Steward"]
10
+ spec.email = ["support@steward.io"]
11
+ spec.description = "Official Ruby client for Steward.io"
12
+ spec.summary = "Official Ruby client for Steward.io"
13
+ spec.homepage = "http://steward.io"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files`.split($/)
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_dependency 'httparty'
22
+
23
+ spec.add_development_dependency "bundler", "~> 1.3"
24
+ spec.add_development_dependency "rake"
25
+ end
metadata ADDED
@@ -0,0 +1,95 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: steward-io
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Steward
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2014-03-01 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: httparty
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - '>='
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - '>='
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
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.3'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ~>
39
+ - !ruby/object:Gem::Version
40
+ version: '1.3'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - '>='
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - '>='
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ description: Official Ruby client for Steward.io
56
+ email:
57
+ - support@steward.io
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - .gitignore
63
+ - Gemfile
64
+ - LICENSE
65
+ - README.md
66
+ - Rakefile
67
+ - lib/steward.rb
68
+ - lib/steward/client.rb
69
+ - lib/steward/version.rb
70
+ - steward-io.gemspec
71
+ homepage: http://steward.io
72
+ licenses:
73
+ - MIT
74
+ metadata: {}
75
+ post_install_message:
76
+ rdoc_options: []
77
+ require_paths:
78
+ - lib
79
+ required_ruby_version: !ruby/object:Gem::Requirement
80
+ requirements:
81
+ - - '>='
82
+ - !ruby/object:Gem::Version
83
+ version: '0'
84
+ required_rubygems_version: !ruby/object:Gem::Requirement
85
+ requirements:
86
+ - - '>='
87
+ - !ruby/object:Gem::Version
88
+ version: '0'
89
+ requirements: []
90
+ rubyforge_project:
91
+ rubygems_version: 2.1.11
92
+ signing_key:
93
+ specification_version: 4
94
+ summary: Official Ruby client for Steward.io
95
+ test_files: []