yard-sftp 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a0bd955f7b7c987b198f861beac206f61462d4aa
+  data.tar.gz: 767e6b2a0a990733ae2a3525e72eda395894bb31
+SHA512:
+  metadata.gz: 74336a21fa830857f6f7a32aee44db1b212b3c340a74546d5a4567ed1d7f69b2b9fa619f4de72b25e216223b9fe2744e26948d2629df53bcb5353f5cbbcdc658
+  data.tar.gz: 324fa2a117abaa1483c33627988162aa740557ae95bf2d1b7475b0bf3c010010a5bf333a51d3e243dfa97e9f21b292f0db609a2c1d92a5df81c3b46a2bf55e84

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+Gemfile.lock
+report.html
+
+# YARD artifacts
+.yardoc
+_yardoc
+.yardsftp
+doc/

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gem 'bundler', '~> 1.3.4'
+gem "coveralls", "~> 0.6.7", require: false
+
+gemspec

data/LICENCE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Jonathan Chrisp
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,26 @@
+# yard-sftp
+
+Move your new shiny yard documentation to a remote location with SFTP!
+
+## Getting Started
+
+In order to move your yard documentation to a remote location using SFTP you need to setup a local `.yardsftp` config file in your projects base directory. Please see the example below:
+
+    --- !ruby/hash:SymbolHash
+    :yard-sftp:
+     host: 'example.com'
+     base_path: '/home/public_html'
+     base_folder: 'project_one/'
+     username: 'username'
+     password: 'password'
+     
+Once this is all setup hit `yard` at your command line as you normally would and each file will uploaded via SFTP as they are created. Please note that both the `.yardopts` and `doc` directories are uploaded!
+
+### `.yardsftp` config file? Why?
+I've added a new `.yardsftp` so different projects can be uploaded to custom remote locations. I did attempt to add these to the global `.yard/config` file but there was no way to distinguish custom remote file paths between different projects! Please email if you have a good suggestion!
+
+## Tests
+There are a no tests at present, this project was a proof of concept but these will be done at some point.
+
+## Feedback
+I would be more than happy to recieve feedback, please email me at: jonathan.chrisp@gmail.com

data/lib/yard-sftp.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/yard/core_ext/file.rb"

data/lib/yard-sftp/version.rb

@@ -0,0 +1,3 @@
+module YARDSFTP
+  VERSION = '1.0.0'
+end

data/lib/yard/core_ext/file.rb

@@ -0,0 +1,122 @@
+require 'fileutils'
+require 'pry'
+require 'colored'
+require 'yaml'
+require 'net/sftp'
+YAML::ENGINE.yamler = 'psych'
+
+class File
+
+  # @group Reading Files
+  # Forces opening a file (for writing) by first creating the file's directory
+  # @param [String] file the filename to open
+  # @since 0.5.2
+  def self.open!(file, *args, &block)
+    dir = dirname(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_file(file)
+  end
+
+  # Sets config from local .yardsftp 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)
+  end
+
+  # Uploads file
+  def self.sftp_file(file_path)
+    directories = sftp_split_all(file_path)
+    directories.pop #removes actual file from array
+
+    unless directories.empty?
+      sftp_build_directories(directories)
+    end
+
+    sftp.upload!(file_path, "#{BASE_PATH}/#{BASE_FOLDER}/#{file_path}")
+  end
+
+  # Creates directories
+  #
+  # @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-1).join('/')}/#{dir}"
+      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}")
+    end
+  end
+
+  # Creates base directory
+  #
+  # @param opts [String] path the path of directory
+  def self.sftp_create_directory(path)
+    unless sftp_directory_exists?(path)
+      sftp.mkdir(path).wait
+    end
+  end
+
+  # Checks if the directory exists
+  #
+  # @param opts [String] path the path of directory
+  def self.sftp_directory_exists?(path)
+    begin
+      sftp.stat!(path)
+    rescue
+      return false
+    else
+      return true
+    end
+  end
+
+  # Splits file path
+  #
+  # @param opts [String] path the path of directory
+  # @return [Array] returns array of directories
+  def self.sftp_split_all(path)
+    head, tail = File.split(path)
+    return [tail] if head == '.' || tail == '/'
+    return [head, tail] if head == '/'
+    return sftp_split_all(head) + [tail]
+  end
+
+  # Set configuration options
+  OPTS        = sftp_config
+  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']
+end

data/yard-sftp.gemspec

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + "/lib/yard-sftp/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'yard-sftp'
+  s.version     = YARDSFTP::VERSION
+  s.date        = '2013-07-15'
+  s.summary     = 'yard-sftp - securely transfer your yard documentation'
+  s.description = 'Move you new shiny documentation to a remote location with SFTP'
+  s.author      = 'Jonathan Chrisp'
+  s.email       = 'jonathan.chrisp@gmail.com'
+  s.license     = 'MIT'
+  s.homepage    = 'https://github.com/jonathanchrisp/yard-sftp'
+  s.required_ruby_version = ">= 1.9.2"
+
+  s.add_development_dependency 'rspec', '~> 2.13.0'
+  s.add_development_dependency 'pry', '~> 0.9.12.2'
+
+  s.add_runtime_dependency 'colored', '~> 1.2'
+  s.add_runtime_dependency 'yard', '~> 0.8.6.2'
+
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: yard-sftp
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonathan Chrisp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12.2
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.6.2
+description: Move you new shiny documentation to a remote location with SFTP
+email: jonathan.chrisp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENCE.md
+- README.md
+- lib/yard-sftp.rb
+- lib/yard-sftp/version.rb
+- lib/yard/core_ext/file.rb
+- yard-sftp.gemspec
+homepage: https://github.com/jonathanchrisp/yard-sftp
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: yard-sftp - securely transfer your yard documentation
+test_files: []
+has_rdoc: