lolcommits-lolsrv 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e50c83486cf5146e9f9c96e853e934aa90da4af3
-  data.tar.gz: 02a923be72368002ec890aeb83211a7e580d343d
+  metadata.gz: 331ae4bed89222c2ed6c6987a550c087f722ee9f
+  data.tar.gz: ed0f42d81741114b3d346bf985f1333285427d81
 SHA512:
-  metadata.gz: f9f54506b3ed4a07f69ff448272bc09bcdd75cacdbafe4a3fb9cb5377863a89bde24bcadc4c62c6fc88e7577b4acb3462b870f2aeda7ac67ac20118c3fcae968
-  data.tar.gz: eb8d7672a36f12d0dcf8230e28412a0a82f09503f9a385ba5a09eaa18dd98ef0456cbc73d2e1cdd3f2e8990b313662ac3cf0727263ae8c4ffbb4ad18ddb7dbb3
+  metadata.gz: 5766e45c68caa163fab9edcefa683fe235809469c4c5a8906e47c4f78c26ea548137a4408f2db9a30cfbee3ce988ef4ad3b3c3dcad09928bc8b14bd7e72e00cc
+  data.tar.gz: acd9396d02f088c4facf10136f7d18bb5e068cfb2952da0980748863500df2469f1f23c8efcb20f4b599e827af86da21bf4d6a5c5330f6a78526fd9ebdedb826

data/README.md

@@ -16,11 +16,16 @@ you've already captured. Syncing is then performed after each commit, only
 uploading images that have not already been synced.
 
 You configure the plugin by setting the base url of the remote server. The
-server must respond to these requests.
+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).
 
 **POST /uplol**
 
-These params are submitted as `multipart/form-data`.
+The following upload params are `multipart/form-data` encoded:
 
 * `lol`  - captured lolcommit image file
 * `url`  - remote repository URL (with commit SHA appended)
@@ -28,11 +33,6 @@ These params are submitted as `multipart/form-data`.
 * `date` - UTC date time for the commit (ISO8601)
 * `sha`  - commit SHA
 
-**GET /lols**
-
-Should return a JSON array of all lolcommits already synced. The commit `sha` is the
-only required JSON attribute (used to identify the already synced image).
-
 ## Requirements
 
 * Ruby >= 2.0.0

data/lib/lolcommits/lolsrv/version.rb

@@ -1,5 +1,5 @@
 module Lolcommits
   module Lolsrv
-    VERSION = "0.0.3".freeze
+    VERSION = "0.0.4".freeze
   end
 end

data/lib/lolcommits/plugin/lolsrv.rb

@@ -47,7 +47,7 @@ module Lolcommits
           print "server: "
           options.merge!('server' => parse_user_input(gets.strip))
           puts '---------------------------------------------------------------'
-          puts '  Lolsrv - Upload and sync lolcommits to a remote server'
+          puts '  Lolsrv - Sync lolcommits to a remote server'
           puts ''
           puts '  Handle POST /uplol with these request params'
           puts ''
@@ -82,67 +82,56 @@ module Lolcommits
 
       private
 
-      ##
-      # Message to show if syncing fails
-      #
-      # @return [String] message text
-      #
-      def fail_message
-        "failed :( (try again with --debug)\n"
-      end
-
       ##
       #
       # Syncs lolcommmit images to the remote server
       #
-      # Fetches from /lols and iterates over objects 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
+      # Fetches from /lols and iterates over shas in the JSON array. Then 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.
       #
-      # Upload requests that fail are skipped.
+      # Upload requests that fail abort the sync
       #
       def sync
-        print "Syncing with lolsrv ... "
-        existing = existing_lols
-
-        # abort sync when invalid response or error from lols_endpoint
-        unless existing
-          print fail_message; return
-        end
+        print "Syncing lols ... "
+        raise 'failed fetching existing lols' unless existing_shas
 
         Dir[runner.config.loldir + '/*.{jpg,gif}'].each do |image|
           sha = File.basename(image, '.*')
-          response = upload(image, sha) unless existing.include?(sha) || sha == 'tmp_snapshot'
-          unless response
-            print fail_message; return
+          unless existing_shas.include?(sha) || sha == 'tmp_snapshot'
+            response = upload(image, sha)
+            raise "failed uploading #{image}" if response.nil?
           end
         end
 
         print "done!\n"
+      rescue RuntimeError => e
+        print "#{e.message} (try again with --debug)\n"
       end
 
       ##
       #
       # Fetch and parse JSON response from `server/lols`, returning an array of
-      # commit SHA's. Logs error and returns nil on NET/HTTP and JSON parsing
-      # errors.
+      # 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
       #
-      def existing_lols
-        lols = JSON.parse(RestClient.get(lols_endpoint))
-        lols.map { |lol| lol['sha'] }
-      rescue JSON::ParserError, SocketError, RestClient::RequestFailed => e
-        log_error(e, "ERROR: existing lols could not be retrieved #{e.class} - #{e.message}")
-        return nil
+      def existing_shas
+        @existing_shas ||= begin
+          lols = JSON.parse(RestClient.get(lols_endpoint))
+          lols.map { |lol| lol['sha'] }
+        rescue JSON::ParserError, SocketError, RestClient::RequestFailed => e
+          log_error(e, "ERROR: existing lols could not be retrieved #{e.class} - #{e.message}")
+          return nil
+        end
       end
 
       ##
       #
       # Upload the lolcommit image to `server/uplol` with commit params. Logs
-      # error and returns nil on NET/HTTP errors.
+      # and returns nil on NET/HTTP errors.
       #
       # @return [RestClient::Response] response object from POST request
       #

data/test/lolcommits/plugin/lolsrv_test.rb

@@ -64,7 +64,10 @@ describe Lolcommits::Plugin::Lolsrv do
     end
 
     describe "run_capture_ready" do
-      before { commit_repo_with_message }
+      before do
+        commit_repo_with_message
+      end
+
       after { teardown_repo }
 
       it "syncs lolcommits" do
@@ -77,8 +80,11 @@ describe Lolcommits::Plugin::Lolsrv do
 
           stub_request(:post, "https://lolsrv.com/uplol").to_return(status: 200)
 
-          fake_io_capture { plugin.run_capture_ready(do_fork: false) }
+          output = fake_io_capture do
+            plugin.run_capture_ready(do_fork: false)
+          end
 
+          assert_equal output, "Syncing lols ... done!\n"
           assert_requested :get, "https://lolsrv.com/lols", times: 1
           assert_requested :post, "https://lolsrv.com/uplol", times: 1,
             headers: {'Content-Type' => /multipart\/form-data/ } do |req|
@@ -88,6 +94,20 @@ describe Lolcommits::Plugin::Lolsrv do
           end
         end
       end
+
+      it "shows error and aborts on failed lols endpoint" do
+        in_repo do
+          plugin.config = valid_enabled_config
+          stub_request(:get, "https://lolsrv.com/lols").to_return(status: 404)
+
+          output = fake_io_capture do
+            plugin.run_capture_ready(do_fork: false)
+          end
+
+          assert_equal output, "Syncing lols ... failed fetching existing lols (try again with --debug)\n"
+          assert_not_requested :post, "https://lolsrv.com/uplol"
+        end
+      end
     end
 
     describe "configuration" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lolcommits-lolsrv
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Matthew Hutchinson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-15 00:00:00.000000000 Z
+date: 2017-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client