yard-sftp 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a532899b4dc8c6831ad3c996b0299d9113bacf9
-  data.tar.gz: e4df2c6aa42689df9c079ecaf8053bda05a8062f
+  metadata.gz: 374d10d47e1269d06b96f8b4d8974159567aa3f7
+  data.tar.gz: fa22ce24200815406771c182fdc691f4e25e7db1
 SHA512:
-  metadata.gz: ad0eb191e483d66be03f70113a62adf2b412d30b8de1c4617da97bced12578e310b4334d03ab1c9d4fcd210474249ad502f5e8d76e09359b1b643d9382b0fb6b
-  data.tar.gz: 636d717244d4005dc9ededb82d2ef253e4c39fd8af36742dbc1f945e4ea70473616bc04bcfb0158cd9bbf97caf746681c2dcd09b9deae4b7e127060d10146714
+  metadata.gz: dd658d85251d41ee2da9ad07c1c29bac12d9cd6357ff17b93718d7b839faea2b7d0de17be477d552260b50bd7fd078a50c01b298d5ea56ac522ff369b6fdb53d
+  data.tar.gz: 46b8664f4c46d375d7682e91c616d756d27ac499749095e1226efc47fa25269a06f58d3dcedb9bfc4484a5e8a893be0a914dfaec72bd3681d464897b75316a57

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/README.md

@@ -1,5 +1,6 @@
-# yard-sftp
+[![Code Climate](https://codeclimate.com/github/jonathanchrisp/yard-sftp.png)](https://codeclimate.com/github/jonathanchrisp/yard-sftp)
 
+# yard-sftp
 Move your new shiny yard documentation to a remote location with SFTP!
 
 ## Getting Started

data/lib/yard-sftp/version.rb

@@ -1,3 +1,3 @@
 module YARDSFTP
-  VERSION = '1.0.3'
+  VERSION = '1.1.0'
 end

data/lib/yard/core_ext/file.rb

@@ -2,7 +2,6 @@ require 'fileutils'
 require 'colored'
 require 'yaml'
 require 'net/sftp'
-YAML::ENGINE.yamler = 'psych'
 
 class File
 
@@ -15,8 +14,7 @@ class File
     FileUtils.mkdir_p(dir) unless directory?(dir)
     open(file, *args, &block)
 
-    # Create base directory, file directories and upload file via sftp
-    sftp_create_base_directory
+    sftp_create_path("#{BASE_DIR}")
     sftp_file(file)
   end
 
@@ -24,86 +22,106 @@ class File
   #
   # @return [Hash] opts Hash
   def self.sftp_config
-    begin
       opts = YAML.load_file('.yardsftp')
     rescue Psych::SyntaxError
       abort 'Your .yardsftp file did not parse as expected!'.red.underline
     rescue Errno::ENOENT
       abort 'Your .yardsftp file is missing!'.red.underline
-    end
-
-    return opts
   end
 
   # Creates or returns sftp instance
   #
   # @return [Object] sftp instance
   def self.sftp
-    sftp ||= Net::SFTP.start(HOST, USER, :password => PWD)
+      tries ||= 3
+      connection ||= Net::SFTP.start(HOST, USER, :password => PWD)
+    rescue Errno::EADDRINUSE
+      log.progress('SSH Connection Error - retrying', nil)
+      retry unless (tries -= 1).zero?
   end
 
   # Uploads file
+  #
+  # @param opts [String] file_path path of the file
   def self.sftp_file(file_path)
-    directories = sftp_split_all(file_path)
-    directories.pop #removes actual file from array
+    paths = sftp_split_all(file_path)
+    paths.pop
+    return if paths.include?(".yardoc")
 
-    unless directories.empty?
-      sftp_build_directories(directories)
+    unless paths.empty?
+      sftp_create_paths(paths)
     end
 
-    sftp.upload!(file_path, "#{BASE_PATH}/#{BASE_FOLDER}/#{file_path}")
+    log.progress("Uploading #{file_path}", nil)
+    sftp.upload!(file_path, "#{BASE_DIR}/#{file_path}")
   end
 
-  # Creates directories
+  # Creates paths relevant for file
   #
-  # @param opts [Array] directories Array of directory names
-  def self.sftp_build_directories(directories)
-    directories.each.with_index do |dir, i|
-      if i == 0
-        path = "#{BASE_PATH}/#{BASE_FOLDER}/#{dir}"
-      elsif i == 1
-        path = "#{BASE_PATH}/#{BASE_FOLDER}/#{directories[0]}/#{dir}"
-      else
-        path = "#{BASE_PATH}/#{BASE_FOLDER}/#{directories.take(i).join('/')}/#{dir}"
+  # @param opts [Array] paths Array of paths
+  def self.sftp_create_paths(paths)
+    # Check if path doesn't already exists
+    if sftp_path_exists?("#{BASE_DIR}/#{paths.join('/')}")
+      sftp_clean_path("#{BASE_DIR}/#{paths.join('/')}")
+    else
+      # Iterate through each path and create
+      paths.each.with_index do |p, i|
+        case i
+        when 0
+          sftp_create_path("#{BASE_DIR}/#{p}")
+        when 1
+          sftp_create_path("#{BASE_DIR}/#{paths[0]}/#{p}")
+        else
+          sftp_create_path("#{BASE_DIR}/#{paths.take(i).join('/')}/#{p}")
+        end
       end
-
-      sftp_create_directory(path)
     end
   end
 
-  # Creates base directory
-  def self.sftp_create_base_directory
-    unless sftp_directory_exists?("#{BASE_PATH}/#{BASE_FOLDER}")
-      sftp_create_directory("#{BASE_PATH}/#{BASE_FOLDER}")
+  # Creates path if it doesn't exist
+  #
+  # @param opts [String] path the path of directory
+  def self.sftp_create_path(path)
+    unless sftp_path_exists?(path)
+      log.progress("Creating directory: #{path}", nil)
+      sftp.mkdir!(path)
     end
   end
 
-  # Creates base directory
+  # Removes files from path if older than upload time
   #
   # @param opts [String] path the path of directory
-  def self.sftp_create_directory(path)
-    unless sftp_directory_exists?(path)
-      sftp.mkdir(path).wait
+  def self.sftp_clean_path(path)
+   sftp.dir.foreach(path) do |f|
+      if !File.extname("#{path}/#{f.name}").empty? && f.attributes.mtime < UPLOAD_TIME
+        sftp_remove_path("#{path}/#{f.name}")
+      end
     end
   end
 
-  # Checks if the directory exists
+  # Checks if the path exists
   #
   # @param opts [String] path the path of directory
-  def self.sftp_directory_exists?(path)
-    begin
+  # @return [Boolean] returns boolean of result
+  def self.sftp_path_exists?(path)
       sftp.stat!(path)
-    rescue
+    rescue Net::SFTP::StatusException
       return false
     else
       return true
-    end
   end
 
-  # Splits file path
+  # Removes file
   #
-  # @param opts [String] path the path of directory
-  # @return [Array] returns array of directories
+  # @param opts [String] path the path of file
+  def self.sftp_remove_path(path)
+    sftp.remove!(path)
+  end
+
+  # Splits path
+  #
+  # @param opts [String] path the path of file
+  # @return [Array] returns array of file path
   def self.sftp_split_all(path)
     head, tail = File.split(path)
     return [tail] if head == '.' || tail == '/'
@@ -116,6 +134,6 @@ class File
   HOST        = OPTS['yard-sftp']['host']
   USER        = OPTS['yard-sftp']['username']
   PWD         = OPTS['yard-sftp']['password']
-  BASE_PATH   = OPTS['yard-sftp']['base_path']
-  BASE_FOLDER = OPTS['yard-sftp']['base_folder']
+  BASE_DIR    = OPTS['yard-sftp']['base_path'] + '/' + OPTS['yard-sftp']['base_folder']
+  UPLOAD_TIME = Time.now.to_i
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-sftp
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Jonathan Chrisp
@@ -87,6 +87,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .ruby-version
 - .travis.yml
 - Gemfile
 - LICENCE.md