lolcommits-dotcom 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.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 69702497db7a7934819a6cf372605df4aca752f2
4
+ data.tar.gz: aa92777d600ab65f6cd415f0615f20dbf0b8f10e
5
+ SHA512:
6
+ metadata.gz: 3677e0a39ca66a6382ad8ec23d3f5e2caab8d8d5e48342de981acac4a4a9b4b9acee6e0ac65e06eb3332659465833743dd27f802db17ac604d2275d03f867d26
7
+ data.tar.gz: d3ec96e4da44315d185b4d892e9b6c58917fcc2ce22f9a821eac0929b3af1e48131d516347bee3f635336fbb2592951e8ad22eb639e9a7a2d402542646805646
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.7
7
+ - 2.2.4
8
+ - 2.3.3
9
+ - 2.4.1
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=532a74c750c62a8be219553f20773cb091b721dd05b5d7064b506160a0f9c76f
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-dotcom.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-dotcom/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-dotcom/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,122 @@
1
+ # Lolcommits Dotcom
2
+
3
+ [![Gem Version](https://img.shields.io/gem/v/lolcommits-dotcom.svg?style=flat)](http://rubygems.org/gems/lolcommits-dotcom)
4
+ [![Travis Build Status](https://travis-ci.org/lolcommits/lolcommits-dotcom.svg?branch=master)](https://travis-ci.org/lolcommits/lolcommits-dotcom)
5
+ [![Test Coverage](https://codeclimate.com/github/lolcommits/lolcommits-dotcom/badges/coverage.svg)](https://codeclimate.com/github/lolcommits/lolcommits-dotcom/coverage)
6
+ [![Code Climate](https://codeclimate.com/github/lolcommits/lolcommits-dotcom/badges/gpa.svg)](https://codeclimate.com/github/lolcommits/lolcommits-dotcom)
7
+ [![Gem Dependency Status](https://gemnasium.com/badges/github.com/lolcommits/lolcommits-dotcom.svg)](https://gemnasium.com/github.com/lolcommits/lolcommits-dotcom)
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
+ [lolcommits-dot-com](http://lolcommits-dot-com.herokuapp.com) is web app hosting
14
+ lolcommits for multiple repositories! You can signup for free via GitHub. This
15
+ plugin integrates your lolcommits gem with the website. The app itself has been
16
+ open-sourced and lives on
17
+ [GitHub](https://github.com/lolcommits/lolcommits-dot-com), pull-requests are
18
+ welcome!
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
+
27
+ ## Installation
28
+
29
+ After installing the lolcommits gem, install this plugin with:
30
+
31
+ $ gem install lolcommits-dotcom
32
+
33
+ Sign up (for free) [here](http://lolcommits-dot-com.herokuapp.com) (via GitHub).
34
+ From the top menu, click 'New Repo' (give your repository a name). Then click
35
+ '[Account Info](http://lolcommits-dot-com.herokuapp.com/users/account)' to see
36
+ the keys you'll need to configure the gem.
37
+
38
+ Then configure to enable and set these keys:
39
+
40
+ $ lolcommits --config -p dotcom
41
+ # set enabled to `true`
42
+ # paste your api key, secret api and repo (external) id
43
+
44
+ That's it! Your next lolcommit will be sent to
45
+ [lolcommits-dot-com](http://lolcommits-dot-com.herokuapp.com). To disable use:
46
+
47
+ $ lolcommits --config -p dotcom
48
+ # and set enabled to `false`
49
+
50
+ ## Development
51
+
52
+ Check out this repo and run `bin/setup`, this will install all dependencies and
53
+ generate docs. Use `bundle exec rake` to run all tests and generate a coverage
54
+ report.
55
+
56
+ You can also run `bin/console` for an interactive prompt that will allow you to
57
+ experiment with the gem code.
58
+
59
+ After capturing every lolcommit is uploaded to the `/git_commits.json` endpoint
60
+ with the following multi-part POST body params (JSON encoded):
61
+
62
+ * `t` - timestamp, seconds since epoch
63
+ * `token` - hex digest of `api_secret` from plugin config and timestamp
64
+ * `key` - `api_key` from plugin config
65
+ * `git_commit` - a hash with these params:
66
+ * `sha` - the commit sha
67
+ * `repo_external_id` - the `repo_id` from plugin config
68
+ * `image` - the lolcommit image file (processed)
69
+ * `raw` - the original captured camera image
70
+
71
+ ## Tests
72
+
73
+ MiniTest is used for testing. Run the test suite with:
74
+
75
+ $ rake test
76
+
77
+ ## Docs
78
+
79
+ Generate docs for this gem with:
80
+
81
+ $ rake rdoc
82
+
83
+ ## Troubles?
84
+
85
+ If you think something is broken or missing, please raise a new
86
+ [issue](https://github.com/lolcommits/lolcommits-dotcom/issues). Take
87
+ a moment to check it hasn't been raised in the past (and possibly closed).
88
+
89
+ ## Contributing
90
+
91
+ Bug [reports](https://github.com/lolcommits/lolcommits-dotcom/issues) and [pull
92
+ requests](https://github.com/lolcommits/lolcommits-dotcom/pulls) are welcome on
93
+ GitHub.
94
+
95
+ When submitting pull requests, remember to add tests covering any new behaviour,
96
+ and ensure all tests are passing on [Travis
97
+ CI](https://travis-ci.org/lolcommits/lolcommits-dotcom). Read the
98
+ [contributing
99
+ guidelines](https://github.com/lolcommits/lolcommits-dotcom/blob/master/CONTRIBUTING.md)
100
+ for more details.
101
+
102
+ This project is intended to be a safe, welcoming space for collaboration, and
103
+ contributors are expected to adhere to the [Contributor
104
+ Covenant](http://contributor-covenant.org) code of conduct. See
105
+ [here](https://github.com/lolcommits/lolcommits-dotcom/blob/master/CODE_OF_CONDUCT.md)
106
+ for more details.
107
+
108
+ ## License
109
+
110
+ The gem is available as open source under the terms of
111
+ [LGPL-3](https://opensource.org/licenses/LGPL-3.0).
112
+
113
+ ## Links
114
+
115
+ * [Travis CI](https://travis-ci.org/lolcommits/lolcommits-dotcom)
116
+ * [Code Climate](https://codeclimate.com/github/lolcommits/lolcommits-dotcom)
117
+ * [Test Coverage](https://codeclimate.com/github/lolcommits/lolcommits-dotcom/coverage)
118
+ * [RDoc](http://rdoc.info/projects/lolcommits/lolcommits-dotcom)
119
+ * [Issues](http://github.com/lolcommits/lolcommits-dotcom/issues)
120
+ * [Report a bug](http://github.com/lolcommits/lolcommits-dotcom/issues/new)
121
+ * [Gem](http://rubygems.org/gems/lolcommits-dotcom)
122
+ * [GitHub](https://github.com/lolcommits/lolcommits-dotcom)
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 Dotcom"
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/dotcom"
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,5 @@
1
+ module Lolcommits
2
+ module Dotcom
3
+ VERSION = "0.0.1".freeze
4
+ end
5
+ end
@@ -0,0 +1,2 @@
1
+ require 'lolcommits/dotcom/version'
2
+ require 'lolcommits/plugin/dotcom'
@@ -0,0 +1,114 @@
1
+ require 'rest-client'
2
+ require 'lolcommits/plugin/base'
3
+
4
+ module Lolcommits
5
+ module Plugin
6
+ class Dotcom < Base
7
+
8
+ BASE_URL = 'http://lolcommits-dot-com.herokuapp.com'.freeze
9
+
10
+ ##
11
+ # Initialize plugin with runner, config and set all configurable options.
12
+ #
13
+ def initialize(runner: nil, config: nil)
14
+ super
15
+ options.concat(plugin_options)
16
+ end
17
+
18
+ ##
19
+ # Returns the name of the plugin to identify the plugin to lolcommits.
20
+ #
21
+ # @return [String] the plugin name
22
+ #
23
+ def self.name
24
+ 'dotcom'
25
+ end
26
+
27
+ ##
28
+ # Returns position(s) of when this plugin should run during the capture
29
+ # process. Uploading happens when a new capture is ready.
30
+ #
31
+ # @return [Array] the position(s) (:capture_ready)
32
+ #
33
+ def self.runner_order
34
+ [:capture_ready]
35
+ end
36
+
37
+ ##
38
+ # Returns true if the plugin has been configured.
39
+ #
40
+ # @return [Boolean] true/false indicating if plugin is configured
41
+ #
42
+ def configured?
43
+ !configuration.values.empty? &&
44
+ configuration.values.all? { |value| !value.nil? }
45
+ end
46
+
47
+ ##
48
+ # Returns true/false indicating if the plugin has been correctly
49
+ # configured. All options must be set with 32 character alphanumeric keys.
50
+ #
51
+ # @return [Boolean] true/false indicating if plugin is correctly
52
+ # configured
53
+ #
54
+ def valid_configuration?
55
+ plugin_options.all? do |option|
56
+ configuration[option] =~ /^([a-z]|[0-9]){32}$/
57
+ end
58
+ end
59
+
60
+ ##
61
+ # Post-capture hook, runs after lolcommits captures a snapshot. Uploads
62
+ # the lolcommit to the dot-com server with the following multi-part POST
63
+ # body params (JSON encoded):
64
+ #
65
+ # `t` - timestamp, seconds since epoch
66
+ # `token` - hex digest of `api_secret` from plugin config and timestamp
67
+ # `key` - `api_key` from plugin config
68
+ # `git_commit` - a hash with these params:
69
+ #
70
+ # `sha` - the commit sha
71
+ # `repo_external_id` - the `repo_id` from plugin config
72
+ # `image` - the lolcommit image file (processed)
73
+ # `raw` - the original captured camera image
74
+ #
75
+ # @return [HTTParty::Response] response object from POST request
76
+ # @return [Nil] if any error occurs
77
+ #
78
+ def run_capture_ready
79
+ debug "Posting capture to #{BASE_URL}"
80
+ t = Time.now.to_i.to_s
81
+
82
+ RestClient.post(
83
+ "#{BASE_URL}/git_commits.json",
84
+ {
85
+ git_commit: {
86
+ sha: runner.sha,
87
+ repo_external_id: configuration['repo_id'],
88
+ image: File.open(runner.main_image),
89
+ raw: File.open(runner.snapshot_loc)
90
+ },
91
+ key: configuration['api_key'],
92
+ t: t,
93
+ token: Digest::SHA1.hexdigest(configuration['api_secret'] + t)
94
+ }
95
+ )
96
+ rescue => e
97
+ log_error(e, "ERROR: HTTParty POST FAILED #{e.class} - #{e.message}")
98
+ return nil
99
+ end
100
+
101
+
102
+ private
103
+
104
+ ##
105
+ # Returns all configuration options available for this plugin.
106
+ #
107
+ # @return [Array] the option names
108
+ #
109
+ def plugin_options
110
+ %w(api_key api_secret repo_id)
111
+ end
112
+ end
113
+ end
114
+ end
@@ -0,0 +1,47 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'lolcommits/dotcom/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "lolcommits-dotcom"
8
+ spec.version = Lolcommits::Dotcom::VERSION
9
+ spec.authors = ["Matthew Hutchinson"]
10
+ spec.email = ["matt@hiddenloop.com"]
11
+ spec.summary = %q{Uploads lolcommits to a remote server}
12
+
13
+ spec.description = <<-EOF
14
+ Uploads lolcommits to a remote server, with optional key or HTTP based
15
+ authentication.
16
+ EOF
17
+
18
+ spec.homepage = "https://github.com/lolcommits/lolcommits-dotcom"
19
+ spec.license = "LGPL-3"
20
+
21
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
22
+ # to allow pushing to a single host or delete this section to allow pushing to any host.
23
+ if spec.respond_to?(:metadata)
24
+ spec.metadata['allowed_push_host'] = "https://rubygems.org"
25
+ else
26
+ raise "RubyGems 2.0 or newer is required to protect against " \
27
+ "public gem pushes."
28
+ end
29
+
30
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(assets|test|features)/}) }
31
+ spec.test_files = `git ls-files -- {test,features}/*`.split("\n")
32
+ spec.bindir = "bin"
33
+ spec.executables = []
34
+ spec.require_paths = ["lib"]
35
+
36
+ spec.required_ruby_version = ">= 2.0.0"
37
+
38
+ spec.add_runtime_dependency "rest-client"
39
+
40
+ spec.add_development_dependency "lolcommits", ">= 0.9.5"
41
+ spec.add_development_dependency "bundler"
42
+ spec.add_development_dependency "webmock"
43
+ spec.add_development_dependency "pry"
44
+ spec.add_development_dependency "rake"
45
+ spec.add_development_dependency "minitest"
46
+ spec.add_development_dependency "simplecov"
47
+ end
@@ -0,0 +1,150 @@
1
+ require "test_helper"
2
+ require 'webmock/minitest'
3
+
4
+ describe Lolcommits::Plugin::Dotcom do
5
+
6
+ include Lolcommits::TestHelpers::GitRepo
7
+ include Lolcommits::TestHelpers::FakeIO
8
+
9
+ def plugin_name
10
+ "dotcom"
11
+ end
12
+
13
+ it "should have a name" do
14
+ ::Lolcommits::Plugin::Dotcom.name.must_equal plugin_name
15
+ end
16
+
17
+ it "should run on capture ready" do
18
+ ::Lolcommits::Plugin::Dotcom.runner_order.must_equal [:capture_ready]
19
+ end
20
+
21
+ describe "with a runner" do
22
+ def runner
23
+ # a simple lolcommits runner with an empty configuration Hash
24
+ @runner ||= Lolcommits::Runner.new(
25
+ main_image: Tempfile.new('main_image.jpg'),
26
+ snapshot_loc: Tempfile.new('snapshot_loc.jpg'),
27
+ config: OpenStruct.new(
28
+ read_configuration: {},
29
+ loldir: File.expand_path("#{__dir__}../../../images")
30
+ )
31
+ )
32
+ end
33
+
34
+ def plugin
35
+ @plugin ||= Lolcommits::Plugin::Dotcom.new(runner: runner)
36
+ end
37
+
38
+ def valid_enabled_config
39
+ @config ||= OpenStruct.new(
40
+ read_configuration: {
41
+ "dotcom" => {
42
+ "enabled" => true,
43
+ "api_key" => 'aaa8e2404ef6013556db5a9828apikey',
44
+ 'api_secret' => 'aaa8e2404ef6013556db5a9apisecret',
45
+ "repo_id" => "aaa8e2404ef6013556db5a9828repoid"
46
+ }
47
+ }
48
+ )
49
+ end
50
+
51
+ describe "initalizing" do
52
+ it "assigns runner and all plugin options" do
53
+ plugin.runner.must_equal runner
54
+ plugin.options.must_equal %w(
55
+ enabled
56
+ api_key
57
+ api_secret
58
+ repo_id
59
+ )
60
+ end
61
+ end
62
+
63
+ describe "#enabled?" do
64
+ it "is false by default" do
65
+ plugin.enabled?.must_equal false
66
+ end
67
+
68
+ it "is true when configured" do
69
+ plugin.config = valid_enabled_config
70
+ plugin.enabled?.must_equal true
71
+ end
72
+ end
73
+
74
+ describe "run_capture_ready" do
75
+ before { commit_repo_with_message("first commit!") }
76
+ after { teardown_repo }
77
+
78
+ it "uploads lolcommits to dot com server endpoint" do
79
+ in_repo do
80
+ plugin.config = valid_enabled_config
81
+ stub_request(:post, /^http\:\/\/lolcommits-dot-com.herokuapp.com/).to_return(status: 200)
82
+
83
+ plugin.run_capture_ready
84
+
85
+ assert_requested :post,
86
+ "http://lolcommits-dot-com.herokuapp.com/git_commits.json",
87
+ times: 1,
88
+ headers: {'Content-Type' => /multipart\/form-data/ } do |req|
89
+ req.body.must_match 'name="git_commit[sha]"'
90
+ req.body.must_match 'name="git_commit[repo_external_id]"'
91
+ req.body.must_match /Content-Disposition: form-data;.+name="git_commit\[image\]"; filename="main_image.jpg.+"/
92
+ req.body.must_match /Content-Disposition: form-data;.+name="git_commit\[raw\]"; filename="snapshot_loc.jpg.+"/
93
+ req.body.must_match 'name="key"'
94
+ req.body.must_match 'name="t"'
95
+ req.body.must_match 'name="token"'
96
+ req.body.must_match 'aaa8e2404ef6013556db5a9828apikey'
97
+ req.body.must_match 'aaa8e2404ef6013556db5a9828repoid'
98
+ end
99
+ end
100
+ end
101
+ end
102
+
103
+ describe "configuration" do
104
+ it "returns false when not configured" do
105
+ plugin.configured?.must_equal false
106
+ end
107
+
108
+ it "returns true when configured" do
109
+ plugin.config = valid_enabled_config
110
+ plugin.configured?.must_equal true
111
+ end
112
+
113
+ it "allows plugin options to be configured" do
114
+ # enabled, api_key, api_secret repo_id
115
+ inputs = %w(
116
+ true
117
+ aaa8e2404ef6013556db5a9828apikey
118
+ aaa8e2404ef6013556db5a9apisecret
119
+ aaa8e2404ef6013556db5a9828repoid
120
+ )
121
+ configured_plugin_options = {}
122
+
123
+ fake_io_capture(inputs: inputs) do
124
+ configured_plugin_options = plugin.configure_options!
125
+ end
126
+
127
+ configured_plugin_options.must_equal({
128
+ "enabled" => true,
129
+ "api_key" => "aaa8e2404ef6013556db5a9828apikey",
130
+ "api_secret" => "aaa8e2404ef6013556db5a9apisecret",
131
+ "repo_id" => "aaa8e2404ef6013556db5a9828repoid"
132
+ })
133
+ end
134
+
135
+ describe "#valid_configuration?" do
136
+ it "returns false for an invalid configuration" do
137
+ plugin.config = OpenStruct.new(read_configuration: {
138
+ "dotcom" => { "repo_id" => "gibberish" }
139
+ })
140
+ plugin.valid_configuration?.must_equal false
141
+ end
142
+
143
+ it "returns true with a valid configuration" do
144
+ plugin.config = valid_enabled_config
145
+ plugin.valid_configuration?.must_equal true
146
+ end
147
+ end
148
+ end
149
+ end
150
+ 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/dotcom'
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,179 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: lolcommits-dotcom
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-09-17 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: |2
126
+ Uploads lolcommits to a remote server, with optional key or HTTP based
127
+ authentication.
128
+ email:
129
+ - matt@hiddenloop.com
130
+ executables: []
131
+ extensions: []
132
+ extra_rdoc_files: []
133
+ files:
134
+ - ".gitignore"
135
+ - ".simplecov"
136
+ - ".travis.yml"
137
+ - CODE_OF_CONDUCT.md
138
+ - CONTRIBUTING.md
139
+ - Gemfile
140
+ - LICENSE
141
+ - README.md
142
+ - Rakefile
143
+ - bin/console
144
+ - bin/setup
145
+ - lib/lolcommits/dotcom.rb
146
+ - lib/lolcommits/dotcom/version.rb
147
+ - lib/lolcommits/plugin/dotcom.rb
148
+ - lolcommits-dotcom.gemspec
149
+ - test/lolcommits/plugin/dotcom_test.rb
150
+ - test/test_helper.rb
151
+ - vendor/fonts/Impact.ttf
152
+ homepage: https://github.com/lolcommits/lolcommits-dotcom
153
+ licenses:
154
+ - LGPL-3
155
+ metadata:
156
+ allowed_push_host: https://rubygems.org
157
+ post_install_message:
158
+ rdoc_options: []
159
+ require_paths:
160
+ - lib
161
+ required_ruby_version: !ruby/object:Gem::Requirement
162
+ requirements:
163
+ - - ">="
164
+ - !ruby/object:Gem::Version
165
+ version: 2.0.0
166
+ required_rubygems_version: !ruby/object:Gem::Requirement
167
+ requirements:
168
+ - - ">="
169
+ - !ruby/object:Gem::Version
170
+ version: '0'
171
+ requirements: []
172
+ rubyforge_project:
173
+ rubygems_version: 2.6.13
174
+ signing_key:
175
+ specification_version: 4
176
+ summary: Uploads lolcommits to a remote server
177
+ test_files:
178
+ - test/lolcommits/plugin/dotcom_test.rb
179
+ - test/test_helper.rb