glynn 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+_site/*
+pkg/*
+*.kpf
+*.tmproj
+.DS_Store

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Damien MATHIEU
+ 
+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,47 @@
+Glynn
+=====
+
+Glynn offers you a bin to easily send a jekyll powered blog to your host through FTP.
+
+Installation
+------------
+
+Glynn comes as a gem. It has no dependencies other than the ruby default libraries.
+Install it with gem install.
+
+    gem install glynn --source http://gemcutter.org
+
+That's it ! You now have the Glynn executable on your machine.
+Go to your jekyll project, configure the host and distant directory where the files will be sent.
+For example, this is my _config.yml file :
+
+    markdown: rdiscount
+    pygments: true
+    auto: true
+    ftp_host: dmathieu.com
+    ftp_dir: /web/portfolio
+
+Glynn will connect itself to the host "dmathieu.com" and send every file to the FTP directory /web/portfolio.
+To do yo, you just need to be at the top of your jekyll project. And in a console, enter the following :
+
+    glynn
+
+Quite simple again. It'll connect to the remote host, ask you for login and password and send the files :)
+
+Contributing
+------------
+
+If you think Glynn is great but can be improved, feel free to contribute.
+To do so, you can :
+
+* [Fork](http://help.github.com/forking/) the project
+* Do your changes and commit them to your repository
+* Test your changes. We won't accept any untested contributions (except if they're not testable).
+* Create an [issue](http://github.com/dmathieu/glynn/issues) with a link to your commits.
+
+And that's it! I'll soon take a look at your issue and review your changes.
+
+Author
+------------------
+
+Damien MATHIEU :: 42 (AT|CHEZ) dmathieu.com

data/Rakefile

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'spec/rake/spectask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "glynn"
+    gemspec.summary = "Deploy a jekyll weblog through ftp"
+    gemspec.description = "Deploy a jekyll weblog through ftp"
+    gemspec.email = "42@dmathieu.com"
+    gemspec.homepage = "http://github.com/dmathieu/glynn"
+    gemspec.authors = ["Damien MATHIEU"]
+    gemspec.version = '0.0.1'
+    
+    gemspec.add_dependency('jekyll', '>= 0.5.4')
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with:"
+  puts "gem install jeweler"
+end
+
+#
+# The rspec tasks
+#
+task :default => :spec
+ 
+desc "Run all specs"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = FileList['spec/**/*.rb']
+  t.spec_opts = ['-cfs']
+end
+
+#
+# The sdoc generator
+#
+begin
+  require 'sdoc_helpers'
+rescue LoadError
+  puts "sdoc support not enabled. Please gem install sdoc-helpers."
+end

data/bin/glynn

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'jekyll'
+require 'glynn'
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+
+options = {}
+case ARGV.size
+  when 0
+  when 1
+    options['destination'] = ARGV[0]
+  when 2
+    options['source'] = ARGV[0]
+    options['destination'] = ARGV[1]
+end
+options = Jekyll.configuration(options)
+
+
+puts "Building site: #{options['source']} -> #{options['destination']}"
+jekyll = Glynn::Jekyll.new
+jekyll.build
+puts "Successfully generated site"
+
+puts "Sending site over FTP (host: #{options['ftp_host']})"
+begin
+  print "FTP Username: "
+  username = $stdin.gets.chomp
+  
+  print "FTP Password: "
+  # We hide the entered characters before to ask for the password
+  system "stty -echo"
+  password = $stdin.gets.chomp
+  system "stty echo"
+rescue NoMethodError, Interrupt
+  # When the process is exited, we display the characters again
+  # And we exit
+  system "stty echo"
+  exit
+end
+
+ftp = Glynn::Ftp.new(options['ftp_host'], 21, {:username => username, :password => password})
+puts "\r\nConnected to server. Sending site"
+ftp.sync(options['destination'], options['ftp_dir'])
+puts "Successfully sent site"

data/glynn.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{glynn}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Damien MATHIEU"]
+  s.date = %q{2009-12-16}
+  s.default_executable = %q{glynn}
+  s.description = %q{Deploy a jekyll weblog through ftp}
+  s.email = %q{42@dmathieu.com}
+  s.executables = ["glynn"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "bin/glynn",
+     "glynn.gemspec",
+     "lib/glynn.rb",
+     "lib/glynn/ftp.rb",
+     "lib/glynn/jekyll.rb",
+     "spec/lib/ftp.rb",
+     "spec/lib/jekyll.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/dmathieu/glynn}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Deploy a jekyll weblog through ftp}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/lib/jekyll.rb",
+     "spec/lib/ftp.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<jekyll>, [">= 0.5.4"])
+    else
+      s.add_dependency(%q<jekyll>, [">= 0.5.4"])
+    end
+  else
+    s.add_dependency(%q<jekyll>, [">= 0.5.4"])
+  end
+end
+

data/lib/glynn/ftp.rb

@@ -0,0 +1,54 @@
+require 'net/ftp'
+
+module Glynn
+  class Ftp
+    attr_reader :host, :port, :username, :password
+    
+    def initialize(host, port = 21, options = Hash.new)
+      options = {:username => nil, :password => nil}.merge(options)
+      @host, @port = host, port
+      @username, @password = options[:username], options[:password]
+    end
+    
+    def sync(local, distant)
+      connect do |ftp|
+        send_dir(ftp, local, distant)
+      end
+    end
+    
+    private
+    def connect
+      ftp = Net::FTP.new(host, username, password)
+      yield ftp
+      ftp.close
+    end
+    
+    def send_dir(ftp, local, distant)
+      begin
+        ftp.mkdir(distant)
+      rescue Net::FTPPermError
+        # We don't do anything. The directory already exists.
+        # TODO : this is also risen if we don't have write access. Then, we need to raise.
+      end
+      Dir.foreach(local) do |file_name|
+        # If the file/directory is hidden (first character is a dot), we ignore it
+        next if file_name =~ /^\./
+        
+        if File.stat(local + "/" + file_name).directory?
+          # It is a directory, we recursively send it
+          begin
+            ftp.mkdir(distant + "/" + file_name)
+          rescue Net::FTPPermError
+            # We don't do anything. The directory already exists.
+            # TODO : this is also risen if we don't have write access. Then, we need to raise.
+          end
+          send_dir(ftp, local + "/" + file_name, distant + "/" + file_name)
+        else
+           # It's a file, we just send it
+           ftp.puttextfile(local + "/" + file_name, distant + "/" + file_name)
+        end
+      end
+      
+    end
+  end
+end

data/lib/glynn/jekyll.rb

@@ -0,0 +1,18 @@
+require 'jekyll'
+
+module Glynn
+  class Jekyll
+    attr_reader :site
+    
+    def initialize(options = {})
+      @site = ::Jekyll::Site.new(::Jekyll.configuration(options))
+    end
+    
+    #
+    # Builds the website in the ./_site directory.
+    #
+    def build
+      site.process
+    end
+  end
+end

data/lib/glynn.rb

@@ -0,0 +1,5 @@
+$:.unshift File.dirname(__FILE__)     # For use/testing when no gem is installed
+require 'rubygems'
+
+require 'glynn/jekyll'
+require 'glynn/ftp'

data/spec/lib/ftp.rb

@@ -0,0 +1,53 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+ 
+describe "FTP Interface" do
+  before(:each) do
+    # We mock the FTP server
+    @mock = mock('Ftp server', :null_object => true)
+    
+    # And the puttextfile method
+    class Net::FTP
+      def puttextfile; true; end
+    end
+  end
+  
+  it 'should login to ftp server' do
+    Net::FTP.should_receive(:new).with('localhost', nil, nil).and_return(@mock)
+    Glynn::Ftp.new('localhost').send(:connect) do |ftp|
+      ftp.should eql(@mock)
+    end
+  end
+  
+  it 'should accept a username and password' do
+    Net::FTP.should_receive(:new).with('localhost', 'username', 'password').and_return(@mock)
+    Glynn::Ftp.new('localhost', 21, {:username => 'username', :password => 'password'}).send(:connect) do |ftp|
+      ftp.should eql(@mock)
+    end
+  end
+  
+  it 'should recursively send a directory' do
+    # We expect NET/FTP to create every file
+    @mock.should_receive(:puttextfile).with('/test/README', '/blah/README').and_return(true)
+    @mock.should_receive(:puttextfile).with('/test/subdir/README', '/blah/subdir/README').and_return(true)
+    FakeFS do
+      # We create the fake files and directories
+      Dir.mkdir('/test')
+      Dir.mkdir('/test/subdir')
+      File.open('/test/README', 'w') { |f| f.write 'N/A' }
+      File.open('/test/subdir/README', 'w') { |f| f.write 'N/A' }
+      
+      # And send them
+      Glynn::Ftp.new('localhost').send(:send_dir, @mock, '/test', '/blah')
+    end
+  end
+  
+  it 'should connect itself to the server and send the local file to distant directory' do
+    FakeFS do
+      interface = Glynn::Ftp.new('localhost')
+      Net::FTP.should_receive(:new).with('localhost', nil, nil).and_return(@mock)
+      interface.should_receive(:send_dir).with(@mock, '/test', '/blah')
+      
+      interface.sync '/test', '/blah'
+    end
+  end
+end

data/spec/lib/jekyll.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+ 
+describe "Relation between glynn and jekyll" do
+  before(:all) do
+    FakeFS.activate!
+    File.open('/_config.yml', 'w') { |f| f.write 'auto: true' }
+  end
+  after(:all) do
+    FakeFS.deactivate!
+  end
+  
+  it 'should create a new website' do
+    jekyll = Glynn::Jekyll.new({ 'source' => '/' })
+    jekyll.build
+  end
+  
+  it 'should accept the ftp host option' do
+    File.open('/_config.yml', 'w') { |f| f.write 'ftp_host: example.com' }
+    options = Jekyll.configuration({'source' => '/'})
+    options['ftp_host'].should eql('example.com')
+  end
+  
+  it 'should accept the fto dir option' do
+    File.open('/_config.yml', 'w') { |f| f.write 'ftp_dir: /home/glynn' }
+    options = Jekyll.configuration({'source' => '/'})
+    options['ftp_dir'].should eql('/home/glynn')
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'spec'
+require 'mocha'
+require 'spec/autorun'
+require 'spec/interop/test'
+require 'fakefs/safe'
+
+
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+require 'glynn'
+
+Spec::Runner.configure do |config|
+  
+  
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: glynn
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Damien MATHIEU
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-16 00:00:00 +01:00
+default_executable: glynn
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: jekyll
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.4
+    version: 
+description: Deploy a jekyll weblog through ftp
+email: 42@dmathieu.com
+executables: 
+- glynn
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- bin/glynn
+- glynn.gemspec
+- lib/glynn.rb
+- lib/glynn/ftp.rb
+- lib/glynn/jekyll.rb
+- spec/lib/ftp.rb
+- spec/lib/jekyll.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/dmathieu/glynn
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Deploy a jekyll weblog through ftp
+test_files: 
+- spec/spec_helper.rb
+- spec/lib/jekyll.rb
+- spec/lib/ftp.rb