squarespace-sync 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 838bce92e3947380a1d4d6dd6bce462d44045411
+  data.tar.gz: cb6553212cf083cc00a2f429f3a0a3bf841226bc
+SHA512:
+  metadata.gz: 1a3a966314f615054ba75ddb49da18afb0cec9102de10896ce2f05bceb18659bd4c969417b186a448666ecf36c6e0c476621ea1e8c274a17105efd9cdb2f29e8
+  data.tar.gz: 48f38a1f0e91108fb6244d55871294de834ed64fb6e1eaee3f72894a71c3fd4a42abf19ba358d8d4b0a0dc617f934d9f7c57c6963abc3fcd92b0f43c3383d375

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+squarespace-sync

data/.ruby-version

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 jordanandree
+
+MIT License
+
+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,48 @@
+# Squarespace::Sync
+
+Sync files to and from a [Squarespace Developer](http://developers.squarespace.com) site over SFTP.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'squarespace-sync'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install squarespace-sync
+
+## Usage
+
+Setup the configuration YAML file for your Squarespace Developer account SFTP settings:
+
+```
+$ squarespace setup
+```
+
+Update `squarespace.yaml` with your account settings, and then you can run either of these commands:
+
+Pull files from Squarespace. Warns if there are conflicts
+
+```
+$ squarespace pull
+```
+
+Push files to Squarespace, overwriting existing
+
+```
+$ squarespace push
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/squarespace

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'squarespace/sync'
+Squarespace::Sync::Cli.start

data/lib/squarespace/sync.rb

@@ -0,0 +1,30 @@
+require "thor"
+require "thor/group"
+require "thor/actions"
+require "yaml"
+require "fileutils"
+require "squarespace/sync/version"
+require "squarespace/sync/connection"
+require "squarespace/sync/cli"
+
+module Squarespace
+  module Sync
+    def self.local_path
+      Dir.pwd
+    end
+
+    def self.config
+      File.join(local_path, "squarespace.yaml")
+    end
+
+    def self.options
+      if File.exists? config
+        options = YAML.load_file( config )
+        options["ignore"] << "squarespace.yaml"
+        Thor::CoreExt::HashWithIndifferentAccess.new( options )
+      else
+        abort "No config exists. Run `squarespace setup` to create it."
+      end
+    end
+  end
+end

data/lib/squarespace/sync/cli.rb

@@ -0,0 +1,45 @@
+module Squarespace
+  module Sync
+    class Cli < Thor
+      include Thor::Actions
+
+      desc "version", "Show the version"
+      def version
+        say Squarespace::Sync::VERSION
+      end
+
+      desc "setup", "Sets up squarespace.yaml for configuring your account"
+      def setup
+        output_file = File.join(Squarespace::Sync.local_path, "squarespace.yaml")
+        template_file = "squarespace.tt"
+        options = {
+          host: "dev.squarespace.com",
+          username: "you@example.com",
+          password: "\"\"",
+          directory: "your-site",
+          port: 2030,
+          ignore: %w{.gitignore Gemfile Gemfile.lock}
+        }
+        template( template_file, output_file, options )
+      end
+
+      desc "push", "Push files to Squarespace"
+      def push
+        Connection.new do |sftp, options, connection|
+          connection.push_tree( sftp, options[:directory] )
+        end
+      end
+
+      desc "pull", "Pull files from Squarespace"
+      def pull
+        Connection.new do |sftp, options, connection|
+          connection.pull_tree( sftp, options[:directory] )
+        end
+      end
+
+      def self.source_root
+        File.dirname(__FILE__)
+      end
+    end
+  end
+end

data/lib/squarespace/sync/connection.rb

@@ -0,0 +1,64 @@
+require "net/sftp"
+
+module Squarespace
+  module Sync
+    class Connection < Thor
+
+      def initialize(&block)
+        options = Squarespace::Sync.options
+
+        Net::SFTP.start(options[:host], options[:username], password: options[:password], port: options[:port]) do |sftp|
+          block.call( sftp, options, self )
+        end
+      end
+
+      no_commands do
+
+        def pull_tree( sftp, directory )
+          sftp.dir[directory, "**/*"].each do |entry|
+            remote_file = File.join(directory, entry.name)
+            local_file = File.join(Squarespace::Sync.local_path, entry.name)
+
+            if sftp.file.directory?( remote_file )
+              FileUtils.mkdir_p( local_file )
+            else
+              if File.exists?( local_file )
+                overwrite = ask("#{entry.name} already exists. Overwrite it?", :yellow, limited_to: %w{y n})
+                if overwrite == "y"
+                  sftp.download!(remote_file, local_file)
+                end
+              else
+                say("Downloading #{entry.name}", :green)
+                sftp.download!(remote_file, local_file)
+              end
+            end
+          end
+        end
+
+        def push_tree( sftp, directory )
+          Dir[File.join(Squarespace::Sync.local_path, "**/*")].each do |file|
+            remote_file = file.gsub(Squarespace::Sync.local_path + "/", "")
+            real_path = File.join(directory, remote_file)
+            next if Squarespace::Sync.options[:ignore].include?( remote_file.split("/").first )
+
+            if File.directory?( file )
+              sftp.mkdir!( real_path ) unless sftp.file.directory?( real_path )
+            else
+              say("Uploading #{remote_file}", :green)
+
+              begin
+                sftp.upload!( file, real_path )
+              rescue Net::SFTP::StatusException => code
+                sftp.remove!( real_path ) do
+                  sftp.upload!( file, real_path )
+                end if code == 11
+              end
+            end
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/squarespace/sync/squarespace.tt

@@ -0,0 +1,7 @@
+host: <%= config[:host] %>
+port: <%= config[:port] %>
+username: <%= config[:username] %>
+password: <%= config[:password] %>
+directory: <%= config[:directory] %>
+ignore:<% config[:ignore].each do |i| %>
+<%= "  - #{i}" %><% end %>

data/lib/squarespace/sync/version.rb

@@ -0,0 +1,5 @@
+module Squarespace
+  module Sync
+    VERSION = "0.0.1"
+  end
+end

data/spec/cli_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe Squarespace::Sync::Cli do
+
+  describe "#version" do
+    it "should return the version number" do
+      expect( shell("version") ).to eq "#{Squarespace::Sync::VERSION}\n"
+    end
+  end
+
+  describe "#setup" do
+    it "shoud create the file" do
+      expect( shell("setup", clean: false) ).to match %r{[create squarespace\.yaml]}
+      expect( File.exists?("tmp/squarespace.yaml") ).to eq true
+    end
+
+    it "should have default contents" do
+      contents = YAML.load_file("tmp/squarespace.yaml")
+      expect( contents.size ).to eq 6
+    end
+  end
+
+  describe "#push" do
+    it "is implemented but waiting" do
+      pending "needs a mock sftp connection"
+    end
+  end
+
+  describe "#pull" do
+    it "is implemented but waiting" do
+      pending "needs a mock sftp connection"
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+require "rspec"
+require File.expand_path("lib/squarespace/sync.rb", File.dirname(File.dirname(__FILE__)))
+
+$:.unshift File.expand_path("bin", File.dirname(File.dirname(__FILE__)))
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+
+  # reject should matchers, keep our specs consistent
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  module Helpers
+    def default_options
+      {
+        clean: true,
+        args: []
+      }
+    end
+
+    def shell(command, options={})
+      options = default_options.merge(options)
+      `cd #{File.join(Dir.pwd, "tmp")} && ../bin/squarespace #{command} #{options[:args].join}`
+    ensure
+      Dir[File.join(Dir.pwd, "tmp", "*")].each do |file|
+        FileUtils.rm_f(file)
+      end if options[:clean]
+    end
+  end
+
+  config.include Helpers
+end

data/squarespace-sync.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'squarespace/sync/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "squarespace-sync"
+  spec.version       = Squarespace::Sync::VERSION
+  spec.authors       = ["jordanandree"]
+  spec.email         = ["jordanandree@gmail.com"]
+  spec.description   = %q{Sync files to and from a Squarespace Developer site over SFTP}
+  spec.summary       = %q{Sync files to and from a Squarespace Developer site}
+  spec.homepage      = "http://github.com/jordanandree/squarespace-sync"
+  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 "thor", "~> 0.18.1"
+  spec.add_dependency "net-sftp", "~> 2.1.2"
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: squarespace-sync
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- jordanandree
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sync files to and from a Squarespace Developer site over SFTP
+email:
+- jordanandree@gmail.com
+executables:
+- squarespace
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/squarespace
+- lib/squarespace/sync.rb
+- lib/squarespace/sync/cli.rb
+- lib/squarespace/sync/connection.rb
+- lib/squarespace/sync/squarespace.tt
+- lib/squarespace/sync/version.rb
+- spec/cli_spec.rb
+- spec/spec_helper.rb
+- squarespace-sync.gemspec
+homepage: http://github.com/jordanandree/squarespace-sync
+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.0.7
+signing_key: 
+specification_version: 4
+summary: Sync files to and from a Squarespace Developer site
+test_files:
+- spec/cli_spec.rb
+- spec/spec_helper.rb