jekyll-ftp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0016314453e927b4cb42a3542ad62e29fa39f54e
+  data.tar.gz: 1c55c25f8fe13f539d6899349b02fc2f53615471
+SHA512:
+  metadata.gz: 535502ea3b71c933cd992c977b691380c06a94294791850e536890e08a87d55c172b14f6c57ab01acf787b2af586dcb606fbb3fd0ccafe5f288e7ef68863cb79
+  data.tar.gz: 0b46d02e68da8662e59b2768b97c03af99d6ea4b5a7377fefbebc63e6b9dc51e69f4e15730c62699ca8b1a192c262555f2b89122c7f720c221ddbaf5dd26daec

data/.gitignore

@@ -0,0 +1,2 @@
+test/
+*.gem

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Jesse Herrick
+
+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,19 @@
+# Jekyll-FTP
+
+## Commands
+* `jekyll-ftp deploy` - Deploy your site via FTP with the preconfigured settings.
+* `jekyll-ftp clean` - Remove all the files from the preconfigured `remote_dir`.
+
+## Configuring your `_config.yml` File
+Since [Jekyll](https://github.com/mojombo/jekyll) uses `_config.yml`, Jekyll-FTP uses this too. To configure Jekyll-FTP needs 3 configuration settings.
+* `username` - Your FTP server username.
+* `server_url` - The URL for your FTP server (can also be an FTP).
+* `remote_dir` - The remote directory where your site is to be deployed.
+
+```yaml
+username: UserName
+server_url: ftp.myserver.com
+remote_dir: /public_html
+```
+
+If you still don't get it, [here's an example](https://gist.github.com/JesseHerrick/6965950).

data/bin/jekyll-ftp

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+$: << File.expand_path(File.dirname(__FILE__) + "/../lib")
+
+require 'rubygems'
+require 'commander/import'
+require 'jekyll-ftp.rb'
+
+program :version, Jekyll_FTP::VERSION
+program :description, 'Jekyll deployment made easy.'
+ 
+command :deploy do |c|
+    c.syntax = 'jekyll-ftp deploy'
+    c.summary = 'Deploy your site via FTP with the preconfigured server settings.'
+    c.description = 'Deploy your site via FTP.'
+    c.action do |args, options|
+        Jekyll_FTP::Command.deploy
+    end
+end
+
+command :clean do |c|
+    c.syntax = 'jekyll-ftp clean'
+    c.summary = 'Just remove all files in the given remote directory.'
+    c.description = c.summary
+    c.example 'Remove the files in the preconfigured directory.', 'jekyll-ftp clean'
+    c.action do |args, options|
+        Jekyll_FTP::Command.deploy(false)
+    end
+end
+

data/jekyll-ftp.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll-ftp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-ftp"
+  spec.version       = Jekyll_FTP::VERSION
+  spec.authors       = ["Jesse Herrick"]
+  spec.email         = ["jessegrantherrick@gmail.com"]
+  spec.description   = %q{Jekyll deployment made easy.}
+  spec.summary       = %q{Deploy your Jekyll site to FTP with one simple command!}
+  spec.homepage      = "https://github.com/JesseHerrick/jekyll-ftp"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency('colorize')
+  spec.add_dependency('commander')
+end

data/lib/jekyll-ftp/clean.rb

@@ -0,0 +1,26 @@
+module Jekyll_FTP
+	class SubCommand
+		def self.clean(ftp)
+			ftp.nlst.each do |file|
+				next if ['.', '..'].include?(file)
+				if directory?(ftp, file)
+					ftp.chdir file
+					clean(ftp)
+					ftp.chdir '..'
+					puts "Deleting directory: ".red + ftp.pwd + "/" + file + "/"
+					ftp.rmdir(file)
+				else
+					puts "Deleting: ".red + ftp.pwd + "/" + file
+					ftp.delete(file)
+				end
+			end
+		end
+		def self.directory?(ftp, filename)
+			ftp.chdir(filename)
+			ftp.chdir('..')
+			return true
+			rescue
+			return false
+		end
+	end
+end

data/lib/jekyll-ftp/deploy.rb

@@ -0,0 +1,69 @@
+require 'yaml'
+require 'net/ftp'
+
+module Jekyll_FTP
+	class Command
+		def self.deploy(deploy_now = true)
+			if File.exists?("_config.yml")
+				# The file is there and will now be parsed.
+				$config = YAML.load_file("_config.yml")
+
+				# Create variables from the config hash.
+				server = $config["server_url"]
+				username = $config["username"]
+				remote_dir = $config["remote_dir"]
+
+				# If the server or username is missing...
+				if server.nil? || username.nil? || remote_dir.nil?
+					# Make a new array for the missing configuration.
+					missing = Array.new
+					# If server doesn't exist add it to the array of missing stuff.
+					if server.nil?
+						missing.push("server_url")
+					end
+					# If username doesn't exist add it to the array of missing stuff.
+					if username.nil?
+						missing.push("username")
+					end
+					# If remote_dir doesn't exist add it to the array of missing stuff.
+					if remote_dir.nil?
+						missing.push("remote_dir")
+					end
+
+					# Pass the missing array to 'config_error'.
+					Jekyll_FTP::Error.config_error(missing)
+				end
+
+				# Give some info about the FTP server.
+				say "      FTP Server: ".blue + server
+				say "        Username: ".blue + username
+				say "Remote Directory: ".blue + remote_dir
+
+				# Error handling over...
+				# Now deploy!
+				ftp = Net::FTP.new(server)
+				ftp.login(username, password)
+				ftp.chdir(remote_dir)
+				say "\nDeploying...".yellow unless deploy_now == false
+
+				# Delete old files.
+				if File.directory?("_site")
+					Jekyll_FTP::SubCommand.clean(ftp)
+				else
+					say "ERROR: _site directory does not exist."
+					abort "Have you tried `jekyll build`?".yellow
+				end
+
+				# Deploy the site... unless not supposed to deploy.
+				unless deploy_now == false
+					Dir.chdir("_site")
+					path = Dir.getwd
+					Jekyll_FTP::SubCommand.send(ftp, path)
+				end
+			else
+				# The file is missing!
+				Jekyll_FTP::Error.file_missing("_config.yml")
+			end
+		end
+	end
+end

data/lib/jekyll-ftp/error.rb

@@ -0,0 +1,17 @@
+module Jekyll_FTP
+	class Error
+		def self.file_missing(filename)
+			abort("ERROR:".red + " #{filename} does not exist.\n" + "Make sure you're in your site's root directory.".yellow)
+		end
+
+		def self.config_error(missing)
+			unless missing.empty?
+				say "ERROR:".red + " Config file not set up properly."
+				missing.each do |missed|
+					say "  Missing:".yellow + " #{missed}"
+				end
+				abort
+			end
+		end
+	end
+end

data/lib/jekyll-ftp/send.rb

@@ -0,0 +1,23 @@
+module Jekyll_FTP
+	class SubCommand
+		def self.send(ftp, path, init_path = nil)
+			init_path ||= path
+  			Dir.entries(path).each do |file|
+    			next if ['.', '..'].include? file
+    
+    			file_path = path + '/' + file
+    			short_file_path = file_path[init_path.length, file_path.length]
+    			if File.directory?(file_path)
+      				ftp.mkdir(file) unless ftp.nlst.index(file)
+      				ftp.chdir(file)
+      				send(ftp, file_path, init_path)
+      				ftp.chdir('..')
+    			else
+      				puts "Deploying: ".green + short_file_path
+      				puts "       To: ".yellow + ftp.pwd + '/' + file
+    			  	ftp.putbinaryfile(path + '/' + file, file)
+    			end
+			end
+		end
+	end
+end

data/lib/jekyll-ftp/version.rb

@@ -0,0 +1,3 @@
+module Jekyll_FTP
+	VERSION = "0.1.0"
+end

data/lib/jekyll-ftp.rb

@@ -0,0 +1,9 @@
+# 3rd Party
+require 'colorize'
+
+# Local
+require 'jekyll-ftp/clean'
+require 'jekyll-ftp/deploy'
+require 'jekyll-ftp/error'
+require 'jekyll-ftp/send'
+require 'jekyll-ftp/version'

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-ftp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jesse Herrick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Jekyll deployment made easy.
+email:
+- jessegrantherrick@gmail.com
+executables:
+- jekyll-ftp
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- LICENSE
+- README.md
+- bin/jekyll-ftp
+- jekyll-ftp.gemspec
+- lib/jekyll-ftp.rb
+- lib/jekyll-ftp/clean.rb
+- lib/jekyll-ftp/deploy.rb
+- lib/jekyll-ftp/error.rb
+- lib/jekyll-ftp/send.rb
+- lib/jekyll-ftp/version.rb
+homepage: https://github.com/JesseHerrick/jekyll-ftp
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.8
+signing_key: 
+specification_version: 4
+summary: Deploy your Jekyll site to FTP with one simple command!
+test_files: []