lolcommits-protonet 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: ccf80abf39ee5154cafea89424ae584216103332
4
+ data.tar.gz: b52fc7bc8225865cb6e9f8c5df45c59e355959ca
5
+ SHA512:
6
+ metadata.gz: 5c44d256b04b3bcbd0eaa3c60adc1a8f124e3004276221238d7f358c3e8d97fc5f783857de9b45a164e0f4ec5bc5ae68853e219ac16f19821fc9f18d5a614d84
7
+ data.tar.gz: 9b5643307b5db2292c2fec305bae5693335603f7d46aa967c62457c0473943a2274214cda0a930d4b047bec92873d1ebf399669c952174b2915c1e3a8e8247a2
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.simplecov ADDED
@@ -0,0 +1,9 @@
1
+ SimpleCov.start do
2
+ add_filter '/test/'
3
+ add_filter '/vendor/'
4
+ end
5
+
6
+ SimpleCov.at_exit do
7
+ SimpleCov.result.format!
8
+ `open ./coverage/index.html` if RUBY_PLATFORM =~ /darwin/
9
+ end
data/.travis.yml ADDED
@@ -0,0 +1,35 @@
1
+ sudo: false
2
+ language: ruby
3
+ cache: bundler
4
+ rvm:
5
+ - 2.0.0
6
+ - 2.1.10
7
+ - 2.2.8
8
+ - 2.3.5
9
+ - 2.4.2
10
+ - ruby-head
11
+
12
+ before_install:
13
+ - gem install bundler -v 1.13.7
14
+ - git --version
15
+ - git config --global user.email "lol@commits.org"
16
+ - git config --global user.name "Lolcommits"
17
+
18
+ matrix:
19
+ allow_failures:
20
+ - rvm: ruby-head
21
+
22
+ branches:
23
+ except:
24
+ - gh-pages
25
+
26
+ env:
27
+ global:
28
+ - CC_TEST_REPORTER_ID=d4f619e1b965d1f20d30863766651e6ff56ec35cdfda0c2188c9db9c1ff9cc74
29
+ - GIT_COMMITTED_AT=$(if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then git log -1 --pretty=format:%ct; else git log -1 --skip 1 --pretty=format:%ct; fi)
30
+ before_script:
31
+ - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
32
+ - chmod +x ./cc-test-reporter
33
+ - ./cc-test-reporter before-build - GIT_COMMITTED_AT=$(if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then git log -1 --pretty=format:%ct; else git log -1 --skip 1 --pretty=format:%ct; fi)
34
+ after_script:
35
+ - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
@@ -0,0 +1,50 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer via [GitHub][maintainer]. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [maintainer]: https://github.com/matthutchinson
49
+ [homepage]: http://contributor-covenant.org
50
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/CONTRIBUTING.md ADDED
@@ -0,0 +1,37 @@
1
+ ### Contributing
2
+
3
+ Pull Requests are welcome! To start helping out:
4
+
5
+ [Fork](https://guides.github.com/activities/forking) then clone the repository:
6
+
7
+ git clone git@github.com:your-username/lolcommits-protonet.git
8
+
9
+ Create your feature branch:
10
+
11
+ git checkout -b my-new-feature
12
+
13
+ When you are happy with your change, run the full test suite:
14
+
15
+ bundle exec rake
16
+
17
+ With a passing test suite, commit your changes, push and submit a new [Pull
18
+ Request](https://github.com/lolcommits/lolcommits-protonet/compare):
19
+
20
+ git commit -am 'Added some feature'
21
+ git push origin my-new-feature
22
+
23
+ At this point you'll be waiting for one of our maintainers to review it. We will
24
+ try to reply to new Pull Requests within a few days. We might suggest some
25
+ changes, improvements or alternatives. To increase the chance that your pull
26
+ request gets accepted:
27
+
28
+ * Explain what your are doing (and why) in your Pull Request description.
29
+ * If you are fixing an
30
+ [issue](https://github.com/lolcommits/lolcommits-protonet/issues), link to
31
+ it in your description and [mention
32
+ it](https://help.github.com/articles/closing-issues-via-commit-messages) in
33
+ the commit message.
34
+ * Write a good [commit
35
+ message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
36
+ * Write tests.
37
+
data/Gemfile ADDED
@@ -0,0 +1,2 @@
1
+ source 'https://rubygems.org'
2
+ gemspec
data/LICENSE ADDED
@@ -0,0 +1,165 @@
1
+ GNU LESSER GENERAL PUBLIC LICENSE
2
+ Version 3, 29 June 2007
3
+
4
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
5
+ Everyone is permitted to copy and distribute verbatim copies
6
+ of this license document, but changing it is not allowed.
7
+
8
+
9
+ This version of the GNU Lesser General Public License incorporates
10
+ the terms and conditions of version 3 of the GNU General Public
11
+ License, supplemented by the additional permissions listed below.
12
+
13
+ 0. Additional Definitions.
14
+
15
+ As used herein, "this License" refers to version 3 of the GNU Lesser
16
+ General Public License, and the "GNU GPL" refers to version 3 of the GNU
17
+ General Public License.
18
+
19
+ "The Library" refers to a covered work governed by this License,
20
+ other than an Application or a Combined Work as defined below.
21
+
22
+ An "Application" is any work that makes use of an interface provided
23
+ by the Library, but which is not otherwise based on the Library.
24
+ Defining a subclass of a class defined by the Library is deemed a mode
25
+ of using an interface provided by the Library.
26
+
27
+ A "Combined Work" is a work produced by combining or linking an
28
+ Application with the Library. The particular version of the Library
29
+ with which the Combined Work was made is also called the "Linked
30
+ Version".
31
+
32
+ The "Minimal Corresponding Source" for a Combined Work means the
33
+ Corresponding Source for the Combined Work, excluding any source code
34
+ for portions of the Combined Work that, considered in isolation, are
35
+ based on the Application, and not on the Linked Version.
36
+
37
+ The "Corresponding Application Code" for a Combined Work means the
38
+ object code and/or source code for the Application, including any data
39
+ and utility programs needed for reproducing the Combined Work from the
40
+ Application, but excluding the System Libraries of the Combined Work.
41
+
42
+ 1. Exception to Section 3 of the GNU GPL.
43
+
44
+ You may convey a covered work under sections 3 and 4 of this License
45
+ without being bound by section 3 of the GNU GPL.
46
+
47
+ 2. Conveying Modified Versions.
48
+
49
+ If you modify a copy of the Library, and, in your modifications, a
50
+ facility refers to a function or data to be supplied by an Application
51
+ that uses the facility (other than as an argument passed when the
52
+ facility is invoked), then you may convey a copy of the modified
53
+ version:
54
+
55
+ a) under this License, provided that you make a good faith effort to
56
+ ensure that, in the event an Application does not supply the
57
+ function or data, the facility still operates, and performs
58
+ whatever part of its purpose remains meaningful, or
59
+
60
+ b) under the GNU GPL, with none of the additional permissions of
61
+ this License applicable to that copy.
62
+
63
+ 3. Object Code Incorporating Material from Library Header Files.
64
+
65
+ The object code form of an Application may incorporate material from
66
+ a header file that is part of the Library. You may convey such object
67
+ code under terms of your choice, provided that, if the incorporated
68
+ material is not limited to numerical parameters, data structure
69
+ layouts and accessors, or small macros, inline functions and templates
70
+ (ten or fewer lines in length), you do both of the following:
71
+
72
+ a) Give prominent notice with each copy of the object code that the
73
+ Library is used in it and that the Library and its use are
74
+ covered by this License.
75
+
76
+ b) Accompany the object code with a copy of the GNU GPL and this license
77
+ document.
78
+
79
+ 4. Combined Works.
80
+
81
+ You may convey a Combined Work under terms of your choice that,
82
+ taken together, effectively do not restrict modification of the
83
+ portions of the Library contained in the Combined Work and reverse
84
+ engineering for debugging such modifications, if you also do each of
85
+ the following:
86
+
87
+ a) Give prominent notice with each copy of the Combined Work that
88
+ the Library is used in it and that the Library and its use are
89
+ covered by this License.
90
+
91
+ b) Accompany the Combined Work with a copy of the GNU GPL and this license
92
+ document.
93
+
94
+ c) For a Combined Work that displays copyright notices during
95
+ execution, include the copyright notice for the Library among
96
+ these notices, as well as a reference directing the user to the
97
+ copies of the GNU GPL and this license document.
98
+
99
+ d) Do one of the following:
100
+
101
+ 0) Convey the Minimal Corresponding Source under the terms of this
102
+ License, and the Corresponding Application Code in a form
103
+ suitable for, and under terms that permit, the user to
104
+ recombine or relink the Application with a modified version of
105
+ the Linked Version to produce a modified Combined Work, in the
106
+ manner specified by section 6 of the GNU GPL for conveying
107
+ Corresponding Source.
108
+
109
+ 1) Use a suitable shared library mechanism for linking with the
110
+ Library. A suitable mechanism is one that (a) uses at run time
111
+ a copy of the Library already present on the user's computer
112
+ system, and (b) will operate properly with a modified version
113
+ of the Library that is interface-compatible with the Linked
114
+ Version.
115
+
116
+ e) Provide Installation Information, but only if you would otherwise
117
+ be required to provide such information under section 6 of the
118
+ GNU GPL, and only to the extent that such information is
119
+ necessary to install and execute a modified version of the
120
+ Combined Work produced by recombining or relinking the
121
+ Application with a modified version of the Linked Version. (If
122
+ you use option 4d0, the Installation Information must accompany
123
+ the Minimal Corresponding Source and Corresponding Application
124
+ Code. If you use option 4d1, you must provide the Installation
125
+ Information in the manner specified by section 6 of the GNU GPL
126
+ for conveying Corresponding Source.)
127
+
128
+ 5. Combined Libraries.
129
+
130
+ You may place library facilities that are a work based on the
131
+ Library side by side in a single library together with other library
132
+ facilities that are not Applications and are not covered by this
133
+ License, and convey such a combined library under terms of your
134
+ choice, if you do both of the following:
135
+
136
+ a) Accompany the combined library with a copy of the same work based
137
+ on the Library, uncombined with any other library facilities,
138
+ conveyed under the terms of this License.
139
+
140
+ b) Give prominent notice with the combined library that part of it
141
+ is a work based on the Library, and explaining where to find the
142
+ accompanying uncombined form of the same work.
143
+
144
+ 6. Revised Versions of the GNU Lesser General Public License.
145
+
146
+ The Free Software Foundation may publish revised and/or new versions
147
+ of the GNU Lesser General Public License from time to time. Such new
148
+ versions will be similar in spirit to the present version, but may
149
+ differ in detail to address new problems or concerns.
150
+
151
+ Each version is given a distinguishing version number. If the
152
+ Library as you received it specifies that a certain numbered version
153
+ of the GNU Lesser General Public License "or any later version"
154
+ applies to it, you have the option of following the terms and
155
+ conditions either of that published version or of any later version
156
+ published by the Free Software Foundation. If the Library as you
157
+ received it does not specify a version number of the GNU Lesser
158
+ General Public License, you may choose any version of the GNU Lesser
159
+ General Public License ever published by the Free Software Foundation.
160
+
161
+ If the Library as you received it specifies that a proxy can decide
162
+ whether future versions of the GNU Lesser General Public License shall
163
+ apply, that proxy's public statement of acceptance of any version is
164
+ permanent authorization for you to choose that version for the
165
+ Library.
data/README.md ADDED
@@ -0,0 +1,105 @@
1
+ # Lolcommits Protonet
2
+
3
+ [![Gem Version](https://img.shields.io/gem/v/lolcommits-protonet.svg?style=flat)](http://rubygems.org/gems/lolcommits-protonet)
4
+ [![Travis Build Status](https://travis-ci.org/lolcommits/lolcommits-protonet.svg?branch=master)](https://travis-ci.org/lolcommits/lolcommits-protonet)
5
+ [![Test Coverage](https://api.codeclimate.com/v1/badges/5754a7b62824fe86a9e4/test_coverage)](https://codeclimate.com/github/lolcommits/lolcommits-protonet/test_coverage)
6
+ [![Code Climate](https://api.codeclimate.com/v1/badges/5754a7b62824fe86a9e4/maintainability)](https://codeclimate.com/github/lolcommits/lolcommits-protonet/maintainability)
7
+ [![Gem Dependency Status](https://gemnasium.com/badges/github.com/lolcommits/lolcommits-protonet.svg)](https://gemnasium.com/github.com/lolcommits/lolcommits-protonet)
8
+
9
+ [lolcommits](https://lolcommits.github.io/) takes a snapshot with your webcam
10
+ every time you git commit code, and archives a lolcat style image with it. Git
11
+ blame has never been so much fun!
12
+
13
+ This plugin allows you to push lolcommits to your Protonet box. The captured
14
+ commit image is uploaded with a randomly generated message that includes the
15
+ commit sha and branch name.
16
+
17
+ You should follow the API documentation found on your box under Help/"Protonet
18
+ REST API" to get an API token.
19
+
20
+ ## Requirements
21
+
22
+ * Ruby >= 2.0.0
23
+ * A webcam
24
+ * [ImageMagick](http://www.imagemagick.org)
25
+ * [ffmpeg](https://www.ffmpeg.org) (optional) for animated gif capturing
26
+ * A [Protonet](https://protonet.com) box
27
+
28
+ ## Installation
29
+
30
+ After installing the lolcommits gem, install this plugin with:
31
+
32
+ $ gem install lolcommits-protonet
33
+
34
+ Then configure to enable and set the api endpoint and token:
35
+
36
+ $ lolcommits --config -p protonet
37
+ # set enabled to `true`
38
+ # set the api endpoint and token
39
+
40
+ That's it! To disable uninstall this gem or:
41
+
42
+ $ lolcommits --config -p protonet
43
+ # and set enabled to `false`
44
+
45
+ ## Development
46
+
47
+ Check out this repo and run `bin/setup`, this will install all dependencies and
48
+ generate docs. Use `bundle exec rake` to run all tests and generate a coverage
49
+ report.
50
+
51
+ You can also run `bin/console` for an interactive prompt that will allow you to
52
+ experiment with the gem code.
53
+
54
+ ## Tests
55
+
56
+ MiniTest is used for testing. Run the test suite with:
57
+
58
+ $ rake test
59
+
60
+ ## Docs
61
+
62
+ Generate docs for this gem with:
63
+
64
+ $ rake rdoc
65
+
66
+ ## Troubles?
67
+
68
+ If you think something is broken or missing, please raise a new
69
+ [issue](https://github.com/lolcommits/lolcommits-protonet/issues). Take
70
+ a moment to check it hasn't been raised in the past (and possibly closed).
71
+
72
+ ## Contributing
73
+
74
+ Bug [reports](https://github.com/lolcommits/lolcommits-protonet/issues) and [pull
75
+ requests](https://github.com/lolcommits/lolcommits-protonet/pulls) are welcome on
76
+ GitHub.
77
+
78
+ When submitting pull requests, remember to add tests covering any new behaviour,
79
+ and ensure all tests are passing on [Travis
80
+ CI](https://travis-ci.org/lolcommits/lolcommits-protonet). Read the
81
+ [contributing
82
+ guidelines](https://github.com/lolcommits/lolcommits-protonet/blob/master/CONTRIBUTING.md)
83
+ for more details.
84
+
85
+ This project is intended to be a safe, welcoming space for collaboration, and
86
+ contributors are expected to adhere to the [Contributor
87
+ Covenant](http://contributor-covenant.org) code of conduct. See
88
+ [here](https://github.com/lolcommits/lolcommits-protonet/blob/master/CODE_OF_CONDUCT.md)
89
+ for more details.
90
+
91
+ ## License
92
+
93
+ The gem is available as open source under the terms of
94
+ [LGPL-3](https://opensource.org/licenses/LGPL-3.0).
95
+
96
+ ## Links
97
+
98
+ * [Travis CI](https://travis-ci.org/lolcommits/lolcommits-protonet)
99
+ * [Code Climate](https://codeclimate.com/github/lolcommits/lolcommits-protonet/maintainability)
100
+ * [Test Coverage](https://codeclimate.com/github/lolcommits/lolcommits-protonet/test_coverage)
101
+ * [RDoc](http://rdoc.info/projects/lolcommits/lolcommits-protonet)
102
+ * [Issues](http://github.com/lolcommits/lolcommits-protonet/issues)
103
+ * [Report a bug](http://github.com/lolcommits/lolcommits-protonet/issues/new)
104
+ * [Gem](http://rubygems.org/gems/lolcommits-protonet)
105
+ * [GitHub](https://github.com/lolcommits/lolcommits-protonet)
data/Rakefile ADDED
@@ -0,0 +1,31 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+ require "rdoc/task"
4
+
5
+ # generate docs
6
+ RDoc::Task.new do |rd|
7
+ rd.main = "README.md"
8
+ rd.title = "Lolcommits Protonet"
9
+ rd.rdoc_dir = "doc"
10
+ rd.options << "--all"
11
+ rd.rdoc_files.include("README.md", "LICENSE", "lib/**/*.rb")
12
+ end
13
+
14
+ # run tests
15
+ Rake::TestTask.new(:test) do |t|
16
+ t.libs << "test"
17
+ t.libs << "lib"
18
+ t.test_files = FileList["test/**/*_test.rb"]
19
+ end
20
+
21
+ # run tests with code coverage (default)
22
+ namespace :test do
23
+ desc "Run all tests and features and generate a code coverage report"
24
+ task :coverage do
25
+ ENV['COVERAGE'] = 'true'
26
+ Rake::Task['test'].execute
27
+ end
28
+ end
29
+
30
+
31
+ task :default => ['test:coverage']
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "lolcommits/protonet"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,10 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ # install deps
7
+ bundle install
8
+
9
+ # generate docs
10
+ bundle exec rake rdoc
@@ -0,0 +1,140 @@
1
+ require 'rest_client'
2
+ require 'lolcommits/plugin/base'
3
+
4
+ module Lolcommits
5
+ module Plugin
6
+ class Protonet < Base
7
+
8
+ ##
9
+ # Initialize plugin with runner, config and set all configurable options.
10
+ #
11
+ def initialize(runner: nil, config: nil)
12
+ super
13
+ options.concat(plugin_options)
14
+ end
15
+
16
+ ##
17
+ # Returns the name of the plugin to identify the plugin to lolcommits.
18
+ #
19
+ # @return [String] the plugin name
20
+ #
21
+ def self.name
22
+ 'protonet'
23
+ end
24
+
25
+ ##
26
+ # Returns position(s) of when this plugin should run during the capture
27
+ # process. Posting to a Protonet box happens when a new capture is ready.
28
+ #
29
+ # @return [Array] the position(s) (:capture_ready)
30
+ #
31
+ def self.runner_order
32
+ [:capture_ready]
33
+ end
34
+
35
+ ##
36
+ # Prompts the user to configure plugin options.
37
+ #
38
+ # @return [Hash] a hash of configured plugin options
39
+ #
40
+ def configure_options!
41
+ puts "-----------------------------------------------------------------"
42
+ puts " Lolcommits Protonet Plugin Config"
43
+ puts "-----------------------------------------------------------------"
44
+ puts "\n"
45
+ puts "We'll need an API endpoint & token. Find API info on your box at "
46
+ puts "Help/Protonet Rest API. Visit https://protonet.com for more info."
47
+ puts "-----------------------------------------------------------------"
48
+ puts "\n"
49
+ super
50
+ end
51
+
52
+ ##
53
+ # Returns true if the plugin has been configured.
54
+ #
55
+ # @return [Boolean] true/false indicating if plugin is configured. An API
56
+ # token and endpoint are required.
57
+ #
58
+ def configured?
59
+ !!(configuration['enabled'] &&
60
+ configuration['api_token'] &&
61
+ configuration['api_endpoint'])
62
+ end
63
+
64
+ ##
65
+ # Post-capture hook, runs after lolcommits captures a snapshot. Posts the
66
+ # lolcommit image with a message to the Protonet box. API Documentation
67
+ # can be found on the Protonet box under Help/"Protonet REST API"
68
+ #
69
+ # @return [RestClient::Response] response object from POST request
70
+ # @return [Nil] if any error occurs
71
+ #
72
+ def run_capture_ready
73
+ debug "Posting image (and message) to #{configuration['api_endpoint']}"
74
+ RestClient.post(
75
+ configuration['api_endpoint'],
76
+ {
77
+ files: [File.new(runner.main_image)],
78
+ message: message
79
+ },
80
+ 'X-Protonet-Token' => configuration['api_token']
81
+ )
82
+ rescue => e
83
+ log_error(e, "ERROR: RestClient POST FAILED #{e.class} - #{e.message}")
84
+ nil
85
+ end
86
+
87
+
88
+ private
89
+
90
+ ##
91
+ # Returns a randomly generated message describing the lolcommit, with repo
92
+ # info, commit sha and branch name.
93
+ #
94
+ # @return [String]
95
+ #
96
+ def message
97
+ "commited some #{random_adjective} #{random_noun} to #{runner.vcs_info.repo}@#{runner.sha} (#{runner.vcs_info.branch})"
98
+ end
99
+
100
+ ##
101
+ # Returns a randomly chosen noun to describe the lolcommit.
102
+ #
103
+ # @return [String]
104
+ #
105
+ def random_noun
106
+ %w(screws bolts exceptions errors cookies).sample
107
+ end
108
+
109
+ ##
110
+ # Returns a randomly chosen adjective to describe the lolcommit.
111
+ #
112
+ # @return [String]
113
+ #
114
+ def random_adjective
115
+ [
116
+ 'awesome', 'great', 'interesting', 'cool', 'EPIC', 'gut', 'good', 'pansy',
117
+ 'powerful', 'boring', 'quirky', 'untested', 'german', 'iranian', 'neutral', 'crazy', 'well tested',
118
+ 'jimmy style', 'nasty', 'bibliographical (we received complaints about the original wording)',
119
+ 'bombdiggidy', 'narly', 'spiffy', 'smashing', 'xing style',
120
+ 'leo apotheker style', 'black', 'white', 'yellow', 'shaggy', 'tasty', 'mind bending', 'JAY-Z',
121
+ 'Kanye (the best ever)', '* Toby Keith was here *', 'splendid', 'stupendulous',
122
+ '(freedom fries!)', '[vote RON PAUL]', '- these are not my glasses -', 'typical pansy',
123
+ '- ze goggles zey do nothing! -', 'almost working', 'legen- wait for it -', '-dairy!',
124
+ ' - Tavonius would be proud of this - ', 'Meg FAILMAN!', '- very brofessional of you -',
125
+ 'heartbleeding', 'juciy', 'supercalifragilisticexpialidocious', 'failing', 'loving'
126
+ ].sample
127
+ end
128
+
129
+ ##
130
+ # Returns all configuration options available for this plugin. An API
131
+ # endpoint and token.
132
+ #
133
+ # @return [Array] the option names
134
+ #
135
+ def plugin_options
136
+ %w(api_endpoint api_token)
137
+ end
138
+ end
139
+ end
140
+ end
@@ -0,0 +1,2 @@
1
+ require 'lolcommits/protonet/version'
2
+ require 'lolcommits/plugin/protonet'
@@ -0,0 +1,5 @@
1
+ module Lolcommits
2
+ module Protonet
3
+ VERSION = "0.0.1".freeze
4
+ end
5
+ end
@@ -0,0 +1,46 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'lolcommits/protonet/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "lolcommits-protonet"
8
+ spec.version = Lolcommits::Protonet::VERSION
9
+ spec.authors = ["Matthew Hutchinson"]
10
+ spec.email = ["matt@hiddenloop.com"]
11
+ spec.summary = %q{Posts lolcommits to a Protonet box}
12
+
13
+ spec.description = <<-EOF
14
+ Automatically post lolcommit images (with a message) to your Protonet box.
15
+ EOF
16
+
17
+ spec.homepage = "https://github.com/lolcommits/lolcommits-protonet"
18
+ spec.license = "LGPL-3"
19
+
20
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
21
+ # to allow pushing to a single host or delete this section to allow pushing to any host.
22
+ if spec.respond_to?(:metadata)
23
+ spec.metadata['allowed_push_host'] = "https://rubygems.org"
24
+ else
25
+ raise "RubyGems 2.0 or newer is required to protect against " \
26
+ "public gem pushes."
27
+ end
28
+
29
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(assets|test|features)/}) }
30
+ spec.test_files = `git ls-files -- {test,features}/*`.split("\n")
31
+ spec.bindir = "bin"
32
+ spec.executables = []
33
+ spec.require_paths = ["lib"]
34
+
35
+ spec.required_ruby_version = ">= 2.0.0"
36
+
37
+ spec.add_runtime_dependency "rest-client"
38
+
39
+ spec.add_development_dependency "lolcommits", ">= 0.9.5"
40
+ spec.add_development_dependency "bundler"
41
+ spec.add_development_dependency "webmock"
42
+ spec.add_development_dependency "pry"
43
+ spec.add_development_dependency "rake"
44
+ spec.add_development_dependency "minitest"
45
+ spec.add_development_dependency "simplecov"
46
+ end
@@ -0,0 +1,126 @@
1
+ require "test_helper"
2
+ require 'webmock/minitest'
3
+
4
+ describe Lolcommits::Plugin::Protonet do
5
+ include Lolcommits::TestHelpers::GitRepo
6
+ include Lolcommits::TestHelpers::FakeIO
7
+
8
+ def plugin_name
9
+ "protonet"
10
+ end
11
+
12
+ it "should have a name" do
13
+ ::Lolcommits::Plugin::Protonet.name.must_equal plugin_name
14
+ end
15
+
16
+ it "should run on capture ready" do
17
+ ::Lolcommits::Plugin::Protonet.runner_order.must_equal [:capture_ready]
18
+ end
19
+
20
+ describe "with a runner" do
21
+ def runner
22
+ # a simple lolcommits runner with an empty configuration Hash
23
+ @runner ||= Lolcommits::Runner.new(
24
+ main_image: Tempfile.new('main_image.jpg'),
25
+ config: OpenStruct.new(read_configuration: {})
26
+ )
27
+ end
28
+
29
+ def plugin
30
+ @plugin ||= Lolcommits::Plugin::Protonet.new(runner: runner)
31
+ end
32
+
33
+ def valid_enabled_config
34
+ @config ||= OpenStruct.new(
35
+ read_configuration: {
36
+ "protonet" => {
37
+ "enabled" => true,
38
+ "api_endpoint" => api_endpoint,
39
+ "api_token" => "proto-token"
40
+ }
41
+ }
42
+ )
43
+ end
44
+
45
+ def api_endpoint
46
+ "https://yourbox.protonet.info/path"
47
+ end
48
+
49
+ describe "initalizing" do
50
+ it "assigns runner and all plugin options" do
51
+ plugin.runner.must_equal runner
52
+ plugin.options.must_equal %w(enabled api_endpoint api_token)
53
+ end
54
+ end
55
+
56
+ describe "#enabled?" do
57
+ it "is false by default" do
58
+ plugin.enabled?.must_equal false
59
+ end
60
+
61
+ it "is true when configured" do
62
+ plugin.config = valid_enabled_config
63
+ plugin.enabled?.must_equal true
64
+ end
65
+ end
66
+
67
+ describe "run_capture_ready" do
68
+ before { commit_repo_with_message("first commit!") }
69
+ after { teardown_repo }
70
+
71
+ it "posts lolcommit with message to protonet box" do
72
+ in_repo do
73
+ plugin.config = valid_enabled_config
74
+
75
+ stub_request(:post, api_endpoint).to_return(status: 200)
76
+
77
+ plugin.run_capture_ready
78
+
79
+ assert_requested :post, api_endpoint, times: 1,
80
+ headers: {'Content-Type' => /multipart\/form-data/ } do |req|
81
+ req.body.must_match(/Content-Disposition: form-data;.+name="files\[\]"; filename="main_image.jpg.+"/)
82
+ req.body.must_match 'name="message"'
83
+ req.body.must_match "plugin-test-repo"
84
+ end
85
+ end
86
+ end
87
+
88
+ it "returns nil if an error occurs" do
89
+ in_repo do
90
+ plugin.config = valid_enabled_config
91
+ stub_request(:post, api_endpoint).to_return(status: 501)
92
+
93
+ assert_nil plugin.run_capture_ready
94
+ end
95
+ end
96
+ end
97
+
98
+ describe "configuration" do
99
+ it "returns false when not configured" do
100
+ plugin.configured?.must_equal false
101
+ end
102
+
103
+ it "returns true when configured" do
104
+ plugin.config = valid_enabled_config
105
+ plugin.configured?.must_equal true
106
+ end
107
+
108
+ it "allows plugin options to be configured" do
109
+ # enabled, api endpoint, api token
110
+ inputs = %W(true #{api_endpoint} proto-token)
111
+
112
+ configured_plugin_options = {}
113
+
114
+ fake_io_capture(inputs: inputs) do
115
+ configured_plugin_options = plugin.configure_options!
116
+ end
117
+
118
+ configured_plugin_options.must_equal({
119
+ "enabled" => true,
120
+ "api_endpoint" => api_endpoint,
121
+ "api_token" => inputs[2]
122
+ })
123
+ end
124
+ end
125
+ end
126
+ end
@@ -0,0 +1,22 @@
1
+ $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
2
+
3
+ # necessary libs from lolcommits (allowing plugin to run)
4
+ require 'git'
5
+ require 'lolcommits/runner'
6
+ require 'lolcommits/vcs_info'
7
+ require 'lolcommits/backends/git_info'
8
+
9
+ # lolcommit test helpers
10
+ require 'lolcommits/test_helpers/git_repo'
11
+ require 'lolcommits/test_helpers/fake_io'
12
+
13
+ if ENV['COVERAGE']
14
+ require 'simplecov'
15
+ end
16
+
17
+ # plugin gem test libs
18
+ require 'lolcommits/protonet'
19
+ require 'minitest/autorun'
20
+
21
+ # swallow all debug output during test runs
22
+ def debug(msg); end
Binary file
metadata ADDED
@@ -0,0 +1,178 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: lolcommits-protonet
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Matthew Hutchinson
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2017-12-02 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rest-client
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: lolcommits
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: 0.9.5
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: 0.9.5
41
+ - !ruby/object:Gem::Dependency
42
+ name: bundler
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
+ - !ruby/object:Gem::Dependency
56
+ name: webmock
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: pry
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rake
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: minitest
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ - !ruby/object:Gem::Dependency
112
+ name: simplecov
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - ">="
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
125
+ description: " Automatically post lolcommit images (with a message) to your Protonet
126
+ box.\n"
127
+ email:
128
+ - matt@hiddenloop.com
129
+ executables: []
130
+ extensions: []
131
+ extra_rdoc_files: []
132
+ files:
133
+ - ".gitignore"
134
+ - ".simplecov"
135
+ - ".travis.yml"
136
+ - CODE_OF_CONDUCT.md
137
+ - CONTRIBUTING.md
138
+ - Gemfile
139
+ - LICENSE
140
+ - README.md
141
+ - Rakefile
142
+ - bin/console
143
+ - bin/setup
144
+ - lib/lolcommits/plugin/protonet.rb
145
+ - lib/lolcommits/protonet.rb
146
+ - lib/lolcommits/protonet/version.rb
147
+ - lolcommits-protonet.gemspec
148
+ - test/lolcommits/plugin/protonet_test.rb
149
+ - test/test_helper.rb
150
+ - vendor/fonts/Impact.ttf
151
+ homepage: https://github.com/lolcommits/lolcommits-protonet
152
+ licenses:
153
+ - LGPL-3
154
+ metadata:
155
+ allowed_push_host: https://rubygems.org
156
+ post_install_message:
157
+ rdoc_options: []
158
+ require_paths:
159
+ - lib
160
+ required_ruby_version: !ruby/object:Gem::Requirement
161
+ requirements:
162
+ - - ">="
163
+ - !ruby/object:Gem::Version
164
+ version: 2.0.0
165
+ required_rubygems_version: !ruby/object:Gem::Requirement
166
+ requirements:
167
+ - - ">="
168
+ - !ruby/object:Gem::Version
169
+ version: '0'
170
+ requirements: []
171
+ rubyforge_project:
172
+ rubygems_version: 2.6.13
173
+ signing_key:
174
+ specification_version: 4
175
+ summary: Posts lolcommits to a Protonet box
176
+ test_files:
177
+ - test/lolcommits/plugin/protonet_test.rb
178
+ - test/test_helper.rb