lolcommits-lolsrv 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97f1e3ad3c3a635858ee9d6dd61305363e6a3decbf8f16933e54ae3234fa3682
-  data.tar.gz: e966b7bb620479b861548dd96decabd9ad1933af9da1f28ca2143b9538a9aabc
+  metadata.gz: e484770b77744bf4d473e5acc417f44fe77f0b3d73c8b62fa03f6b331aa97a5b
+  data.tar.gz: 3bf0a9b9cf728e772f8f60e0d7d5a211931e5f046f80359fe96fb26182fc639f
 SHA512:
-  metadata.gz: a445b31f7b9fef6f16eaa28cf6ba003760ff1171450ad1a7b9fe5b6b5da591045aa183b6affdd1c82ffe8ebb8d447e20d015974e996ee93edf09af48222c9d1a
-  data.tar.gz: a2667b0723ec6c487a54d824cf076a4a8dba1732b62bd38a464b8a944fb145e08925f2e3aa815b462b9a04c1ae495164a6543198da809eef9f48e2c1ede90f36
+  metadata.gz: 756111ca246deffe418a4170e9421bd9bb4ce2e9dbfca831ba8b97119376576085137b3d1eef667027b2e24c6d719382a2e421a89cb8e78b38f12e96b61c7bd4
+  data.tar.gz: e208e42905eaf42a44a92799e812791d41b6f5889a5c1432c927a3cd9b13c530d732d83ef486a7b3eba7909ab9cf53c198879c17e67bdba43147185c82b023f9

data/CHANGELOG.md

@@ -2,13 +2,24 @@
 
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog][KeepAChangelog] and this project
-adheres to [Semantic Versioning][Semver].
+The format is based on [Keep a Changelog][KeepAChangelog] and this
+project adheres to [Semantic Versioning][Semver].
 
 ## [Unreleased]
 
 - Your contribution here!
 
+## [0.3.0] - 2019-05-19
+### Changed
+- lolcommits gem is a runtime dependency
+- Use `lolcommit_path` (instead of `main_image`)
+- Requires at least lolcommits >= `0.14.2`
+- Refactored test to use `TestConfiguration`
+- Updated README
+
+### Removed
+- Support for lolcommits < `0.14.2`
+
 ## [0.2.0] - 2019-04-24
 ### Removed
 - Support for Ruby < 2.3 (older rubies no longer supported)
@@ -61,7 +72,8 @@ adheres to [Semantic Versioning][Semver].
 ### Changed
 - Initial release
 
-[Unreleased]: https://github.com/lolcommits/lolcommits-lolsrv/compare/v0.2.0...HEAD
+[Unreleased]: https://github.com/lolcommits/lolcommits-lolsrv/compare/v0.3.0...HEAD
+[0.3.0]: https://github.com/lolcommits/lolcommits-lolsrv/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/lolcommits/lolcommits-lolsrv/compare/v0.1.1...v0.2.0
 [0.1.1]: https://github.com/lolcommits/lolcommits-lolsrv/compare/v0.1.0...v0.1.1
 [0.1.0]: https://github.com/lolcommits/lolcommits-lolsrv/compare/v0.0.7...v0.1.0

data/README.md

@@ -1,35 +1,36 @@
 # Lolcommits Lolsrv
 
 [![Gem](https://img.shields.io/gem/v/lolcommits-lolsrv.svg?style=flat)](http://rubygems.org/gems/lolcommits-lolsrv)
-[![Travis](https://travis-ci.org/lolcommits/lolcommits-lolsrv.svg?branch=master)](https://travis-ci.org/lolcommits/lolcommits-lolsrv)
+[![Travis](https://img.shields.io/travis/com/lolcommits/lolcommits-lolsrv/master.svg?style=flat)](https://travis-ci.com/lolcommits/lolcommits-lolsrv)
 [![Depfu](https://img.shields.io/depfu/lolcommits/lolcommits-lolsrv.svg?style=flat)](https://depfu.com/github/lolcommits/lolcommits-lolsrv)
 [![Maintainability](https://api.codeclimate.com/v1/badges/309c4d765a49dddebbc9/maintainability)](https://codeclimate.com/github/lolcommits/lolcommits-lolsrv/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/309c4d765a49dddebbc9/test_coverage)](https://codeclimate.com/github/lolcommits/lolcommits-lolsrv/test_coverage)
 
-[lolcommits](https://lolcommits.github.io/) takes a snapshot with your webcam
-every time you git commit code, and archives a lolcat style image with it. Git
-blame has never been so much fun!
+[lolcommits](https://lolcommits.github.io/) takes a snapshot with your
+webcam every time you git commit code, and archives a lolcat style image
+with it. Git blame has never been so much fun!
 
-This plugin syncs lolcommits to a remote server. After enabling, your next
-lolcommit will be uploaded, along with all existing lolcommits images that
-you've already captured. Syncing is then performed after each commit, only
-uploading images that have not already been synced.
+This plugin syncs lolcommits to a remote server. After enabling, your
+next lolcommit will be uploaded, along with all existing lolcommits that
+you've already captured. Syncing is then performed after each commit,
+only uploading files that have not already been synced.
 
-You configure the plugin by setting the base url of the remote server. The
-server must respond at these paths:
+You configure the plugin by setting the base url of the remote server.
+The server must respond at these paths:
 
 **GET /lols**
 
-Returns a JSON array of all lolcommits already synced. The commit `sha` is the
-only required JSON attribute (used to identify the already synced image).
+Returns a JSON array of all lolcommits already synced. The commit `sha`
+is the only required JSON attribute (used to identify the already synced
+lolcommit).
 
 **POST /uplol**
 
 The following upload params are `multipart/form-data` encoded:
 
-* `lol`  - captured lolcommit image file
+* `lol`  - captured lolcommit file
 * `url`  - remote repository URL (with commit SHA appended)
-* `repo` - repository name e.g. mroth/lolcommits
+* `repo` - repository name e.g. lolcommits/lolcommits
 * `date` - UTC date time for the commit (ISO8601)
 * `sha`  - commit SHA
 
@@ -52,20 +53,20 @@ Then configure to enable it and set the server url:
     # set enabled to `true`
     # set the server base url (must begin with http(s)://)
 
-That's it! Provided the endpoints are responding correctly, your lolcommits will
-be synced to the remote server. To disable use:
+That's it! Provided the endpoints are responding correctly, your
+lolcommits will be synced to the remote server. To disable use:
 
     $ lolcommits --config -p lolsrv
     # and set enabled to `false`
 
 ## Development
 
-Check out this repo and run `bin/setup`, this will install all dependencies and
-generate docs. Run `bundle exec rake` to run all tests and generate a coverage
-report.
+Check out this repo and run `bin/setup`, this will install all
+dependencies and generate docs. Run `bundle exec rake` to run all tests
+and generate a coverage report.
 
-You can also run `bin/console` for an interactive prompt that will allow you to
-experiment with the gem code.
+You can also run `bin/console` for an interactive prompt that will allow
+you to experiment with the gem code.
 
 ## Tests
 
@@ -87,20 +88,22 @@ a moment to check it hasn't been raised in the past (and possibly closed).
 
 ## Contributing
 
-Bug [reports](https://github.com/lolcommits/lolcommits-lolsrv/issues) and [pull
-requests](https://github.com/lolcommits/lolcommits-lolsrv/pulls) are welcome on
-GitHub.
+Bug [reports](https://github.com/lolcommits/lolcommits-lolsrv/issues)
+and [pull
+requests](https://github.com/lolcommits/lolcommits-lolsrv/pulls) are
+welcome on GitHub.
 
-When submitting pull requests, remember to add tests covering any new behaviour,
-and ensure all tests are passing on [Travis
-CI](https://travis-ci.org/lolcommits/lolcommits-lolsrv). Read the
+When submitting pull requests, remember to add tests covering any new
+behaviour, and ensure all tests are passing on [Travis
+CI](https://travis-ci.com/lolcommits/lolcommits-lolsrv). Read the
 [contributing
 guidelines](https://github.com/lolcommits/lolcommits-lolsrv/blob/master/CONTRIBUTING.md)
 for more details.
 
-This project is intended to be a safe, welcoming space for collaboration, and
-contributors are expected to adhere to the [Contributor
-Covenant](http://contributor-covenant.org) code of conduct. See
+This project is intended to be a safe, welcoming space for
+collaboration, and contributors are expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of conduct.
+See
 [here](https://github.com/lolcommits/lolcommits-lolsrv/blob/master/CODE_OF_CONDUCT.md)
 for more details.
 
@@ -111,7 +114,7 @@ The gem is available as open source under the terms of
 
 ## Links
 
-* [Travis CI](https://travis-ci.org/lolcommits/lolcommits-lolsrv)
+* [Travis CI](https://travis-ci.com/lolcommits/lolcommits-lolsrv)
 * [Code Climate](https://codeclimate.com/github/lolcommits/lolcommits-lolsrv)
 * [Test Coverage](https://codeclimate.com/github/lolcommits/lolcommits-lolsrv/coverage)
 * [RDoc](http://rdoc.info/projects/lolcommits/lolcommits-lolsrv)

data/lib/lolcommits/lolsrv/version.rb

@@ -2,6 +2,6 @@
 
 module Lolcommits
   module Lolsrv
-    VERSION = "0.2.0".freeze
+    VERSION = "0.3.0".freeze
   end
 end

data/lib/lolcommits/plugin/lolsrv.rb

@@ -9,8 +9,8 @@ module Lolcommits
 
       ##
       # Returns true/false indicating if the plugin has been correctly
-      # configured. The `server` option must be set with a URL beginning with
-      # http(s)://
+      # configured. The `server` option must be set with a URL beginning
+      # with http(s)://
       #
       # @return [Boolean] true/false indicating if plugin is correctly
       # configured
@@ -34,9 +34,9 @@ module Lolcommits
           puts ''
           puts '  Handle POST /uplol with these request params'
           puts ''
-          puts '    `lol`  - captured lolcommit image file'
+          puts '    `lol`  - captured lolcommit file'
           puts '    `url`  - remote repository URL (with commit SHA appended)'
-          puts '    `repo` - repository name e.g. mroth/lolcommits'
+          puts '    `repo` - repository name e.g. lolcommits/lolcommits'
           puts '    `date` - UTC date time for the commit (ISO8601)'
           puts '    `sha`  - commit SHA'
           puts ''
@@ -53,8 +53,7 @@ module Lolcommits
       ##
       #
       # Post-capture hook, runs after lolcommits captures a snapshot.
-      #
-      # Syncs lolcommit images to the remote server (forked and detached)
+      # Syncs lolcommits to the remote server (forked and detached)
       #
       # @return [Integer] forked process id
       #
@@ -72,12 +71,12 @@ module Lolcommits
 
       ##
       #
-      # Syncs lolcommmit images to the remote server
+      # Syncs lolcommmits to the remote server
       #
-      # Fetches from /lols and iterates over shas in the JSON array. For each
-      # image found in the local loldir folder, check if it has already been
-      # uploaded. If not, upload the image with a POST request and
-      # upload_params.
+      # Fetches from /lols and iterates over shas in the JSON array. For
+      # each file found in the local loldir folder, check if it has
+      # already been uploaded. If not, upload the file with a POST
+      # request and upload_params.
       #
       # Upload requests that fail abort the sync.
       #
@@ -85,11 +84,13 @@ module Lolcommits
         print "Syncing lols ... "
         raise 'failed fetching existing lols' unless existing_shas
 
-        Dir[runner.config.loldir + '/*.{jpg,gif}'].each do |image|
-          sha = File.basename(image, '.*')
-          unless existing_shas.include?(sha) || sha == 'tmp_snapshot'
-            response = upload(image, sha)
-            raise "failed uploading #{image}" if response.nil?
+        # puts runner.config.loldir
+
+        Dir[runner.config.loldir + '/*.{jpg,mp4,gif}'].each do |lolcommit|
+          sha = File.basename(lolcommit, '.*')
+          unless existing_shas.include?(sha)
+            response = upload(lolcommit, sha)
+            raise "failed uploading #{lolcommit}" if response.nil?
           end
         end
 
@@ -101,8 +102,9 @@ module Lolcommits
 
       ##
       #
-      # Fetch and parse JSON response from `server/lols`, returning an array of
-      # commit SHA's. Logs and returns nil on NET/HTTP and JSON parsing errors.
+      # Fetch and parse JSON response from `server/lols`, returning an
+      # array of commit SHA's. Logs and returns nil on NET/HTTP and JSON
+      # parsing errors.
       #
       # @return [Array] containing commit SHA's
       # @return [Nil] if an error occurred
@@ -119,13 +121,13 @@ module Lolcommits
 
       ##
       #
-      # Upload the lolcommit image to `server/uplol` with commit params. Logs
-      # and returns nil on NET/HTTP errors.
+      # Upload the lolcommit file to `server/uplol` with commit params.
+      # Logs and returns nil on NET/HTTP errors.
       #
       # @return [RestClient::Response] response object from POST request
       #
-      def upload(image, sha)
-        RestClient.post(upload_endpoint, upload_params_for(image, sha))
+      def upload(file, sha)
+        RestClient.post(upload_endpoint, upload_params_for(file, sha))
       rescue SocketError, RestClient::RequestFailed => e
         log_error(e, "ERROR: Upload of lol #{sha} to #{upload_endpoint} FAILED #{e.class} - #{e.message}")
         nil
@@ -133,20 +135,20 @@ module Lolcommits
 
       ##
       #
-      # Hash of params to send with lolcommit upload. Built from repositiory and
-      # commit info.
+      # Hash of params to send with lolcommit upload. Built from
+      # repositiory and commit info.
       #
-      # `lol`  - captured lolcommit image file
+      # `lol`  - captured lolcommit file
       # `url`  - remote repository URL (with commit SHA appended)
-      # `repo` - repository name e.g. mroth/lolcommits
+      # `repo` - repository name e.g. lolcommits/lolcommits
       # `date` - UTC date time for the commit (ISO8601)
       # `sha`  - commit SHA
       #
       # @return [Hash]
       #
-      def upload_params_for(image, sha)
+      def upload_params_for(file, sha)
         params = {
-          lol: File.new(image),
+          lol: File.new(file),
           repo: runner.vcs_info.repo,
           date: runner.vcs_info.commit_date.iso8601,
           sha: sha
@@ -171,9 +173,9 @@ module Lolcommits
 
       ##
       #
-      # Endpoint requested for GET-ing lolcommits. It must return a JSON array
-      # of all lols already uploaded, the commit `sha` is the only required JSON
-      # attribute.
+      # Endpoint requested for GET-ing lolcommits. It must return a JSON
+      # array of all lols already uploaded, the commit `sha` is the only
+      # required JSON attribute.
       #
       # @return [String] `server` config option + '/lols'
       #

data/lolcommits-lolsrv.gemspec

@@ -9,30 +9,23 @@ Gem::Specification.new do |spec|
   spec.email    = ["matt@hiddenloop.com"]
   spec.summary  = %q{Sync lolcommits to a remote server}
   spec.homepage = "https://github.com/lolcommits/lolcommits-lolsrv"
-  spec.license  = "LGPL-3"
+  spec.license  = "LGPL-3.0"
 
   spec.description = <<-DESC
-  Sync lolcommits to a remote server. After enabling, your next lolcommit will
-  be uploaded, along with all existing lolcommits images that you've already
-  captured. Each lolcommit is then sync'd after capturing.
+  Sync lolcommits to a remote server. After enabling, your next
+  lolcommit will be uploaded, along with all existing lolcommits images
+  that you've already captured. Each lolcommit is then sync'd after
+  capturing.
   DESC
 
   spec.metadata = {
-    "homepage_uri"    => "https://github.com/lolcommits/lolcommits-lolsrv",
-    "changelog_uri"   => "https://github.com/lolcommits/lolcommits-lolsrv/blob/master/CHANGELOG.md",
-    "source_code_uri" => "https://github.com/lolcommits/lolcommits-lolsrv",
-    "bug_tracker_uri" => "https://github.com/lolcommits/lolcommits-lolsrv/issues",
+    "homepage_uri"      => "https://github.com/lolcommits/lolcommits-lolsrv",
+    "changelog_uri"     => "https://github.com/lolcommits/lolcommits-lolsrv/blob/master/CHANGELOG.md",
+    "source_code_uri"   => "https://github.com/lolcommits/lolcommits-lolsrv",
+    "bug_tracker_uri"   => "https://github.com/lolcommits/lolcommits-lolsrv/issues",
+    "allowed_push_host" => "https://rubygems.org"
   }
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
-  end
-
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(assets|test|features)/}) }
   spec.test_files    = `git ls-files -- {test,features}/*`.split("\n")
   spec.bindir        = "bin"
@@ -42,8 +35,8 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.3"
 
   spec.add_runtime_dependency "rest-client"
+  spec.add_runtime_dependency "lolcommits", ">= 0.14.2"
 
-  spec.add_development_dependency "lolcommits", ">= 0.12.0"
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "webmock"
   spec.add_development_dependency "pry"

data/test/lolcommits/plugin/lolsrv_test.rb

@@ -12,10 +12,8 @@ describe Lolcommits::Plugin::Lolsrv do
     def runner
       # a simple lolcommits runner with an empty configuration Hash
       @runner ||= Lolcommits::Runner.new(
-        main_image: Tempfile.new('main_image.jpg'),
-        config: OpenStruct.new(
-          loldir: File.expand_path("#{__dir__}../../../images")
-        )
+        lolcommit_path: Tempfile.new('lolcommit.jpg'),
+        config: TestConfiguration.new(OpenStruct.new)
       )
     end
 
@@ -56,7 +54,8 @@ describe Lolcommits::Plugin::Lolsrv do
           stub_request(:get, "https://lolsrv.com/lols").
             to_return(status: 200, body: [{ sha: existing_sha }].to_json)
 
-          stub_request(:post, "https://lolsrv.com/uplol").to_return(status: 200)
+          stub_request(:post, "https://lolsrv.com/uplol").
+            to_return(status: 200)
 
           output = fake_io_capture do
             plugin.run_capture_ready(do_fork: false)
@@ -118,3 +117,9 @@ describe Lolcommits::Plugin::Lolsrv do
     end
   end
 end
+
+class TestConfiguration < Lolcommits::Configuration
+  def loldir
+    @loldir ||= File.expand_path("#{__dir__}../../../images")
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lolcommits-lolsrv
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Matthew Hutchinson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-24 00:00:00.000000000 Z
+date: 2019-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.0
-  type: :development
+        version: 0.14.2
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.14.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -123,9 +123,10 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: |2
-    Sync lolcommits to a remote server. After enabling, your next lolcommit will
-    be uploaded, along with all existing lolcommits images that you've already
-    captured. Each lolcommit is then sync'd after capturing.
+    Sync lolcommits to a remote server. After enabling, your next
+    lolcommit will be uploaded, along with all existing lolcommits images
+    that you've already captured. Each lolcommit is then sync'd after
+    capturing.
 email:
 - matt@hiddenloop.com
 executables: []
@@ -155,7 +156,7 @@ files:
 - test/test_helper.rb
 homepage: https://github.com/lolcommits/lolcommits-lolsrv
 licenses:
-- LGPL-3
+- LGPL-3.0
 metadata:
   homepage_uri: https://github.com/lolcommits/lolcommits-lolsrv
   changelog_uri: https://github.com/lolcommits/lolcommits-lolsrv/blob/master/CHANGELOG.md