siteleaf 0.9.23 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f81b5e2b0e30522c443b49419ddc93eaee2ce31
-  data.tar.gz: 5eb92f3d3bf0e6f555f7620f762462caac9fde80
+  metadata.gz: 75e7b85ae46ef7e9a4acb9f91e7cfa6aad12d461
+  data.tar.gz: f3fad5f5f09556a6d2e850300ea5f3a5ebb75483
 SHA512:
-  metadata.gz: ab5c786334310e8ff5def9532ee81c0dea9b2d29dbeacc5b8352820c6b16cea3770c777cd036ef02ee4c9c70420cf02a0fc3917262e12c24e31737bfdd15cf60
-  data.tar.gz: 27ac15f55218d9d7227ab0cfdf4fe8ce6c06ef43925c8a99bef7c071fb8bdbbe7ff60dd822ed593197181a9b1bbebd7be6bd15c07d7f859d71ac7b0454514aed
+  metadata.gz: ae362f7cba5c44002055e3eb7ac4110003738a34780af46f3e2f0509d33b780e6562f968ab8716e775a79aff119ca2849741aa8b60d4ecd88d7fef47bbb63e88
+  data.tar.gz: c19eace8a1bf47b3e4e079cbc2f021bc47e05eb26a8f3148234d75b7f37c30526ab7e774cb051a011f2516c48c9e56cce671dce34699bc340b30e4afecfd46f3

data/.gitignore

@@ -17,3 +17,6 @@ test/version_tmp
 tmp
 .ruby-version
 .DS_Store
+source/
+export/
+config.ru

data/.rbenv-vars

@@ -0,0 +1,2 @@
+EXCON_DEBUG=true
+DEBUG=true

data/README.md

@@ -2,12 +2,14 @@ Siteleaf Gem
 ============
 
 - [Installation](#installation)
-- [Testing sites locally](#testing-sites-locally)
+- [Using the CLI](#using-the-cli)
 - [Using this gem in your application](#using-this-gem-in-your-application)
 - [Using the API](#using-the-api)
+- [Exporting your site](#exporting-your-site)
 - [Troubleshooting](#troubleshooting)
 - [Contributing](#contributing)
 
+
 Installation
 ------------
 
@@ -16,8 +18,10 @@ The Siteleaf gem is available for installation on [Rubygems](https://rubygems.or
     gem install siteleaf
 
 
-Testing sites locally
----------------------
+Using the CLI
+-------------
+
+Important: if using a Gemfile, make sure to prepend all commands with bundle exec (e.g. bundle exec siteleaf auth).
 
 The Siteleaf gem allows you to test and develop your sites locally. If using [Pow](http://pow.cx) or [Anvil](http://anvilformac.com), your local website will be automatically set up and can be accessed at `http://yoursite.dev`.
 
@@ -86,6 +90,7 @@ To use this gem in your application, add the following to your Gemfile:
     gem 'siteleaf', :git => 'git://github.com/siteleaf/siteleaf-gem.git'
 
 
+
 Using the API
 -------------
 
@@ -166,6 +171,19 @@ post.delete
 Siteleaf::Page.delete('519719ddcc85910626000001')
 ```
 
+
+Exporting your site
+---------------------------------
+
+You can backup or export your Siteleaf content to Jekyll-compatible format by running the following command:
+
+    siteleaf export
+    
+You will be asked to enter your main posts path, this is typically `posts` (default) or `blog` (if your posts are located at `/blog/hello-world` for example). If your site does not have any posts, leave blank to use the default.
+
+All content including Pages, Posts, Site Metadata, and Assets will be exported to a sub-folder called `export`. Theme files are not included in the export.
+
+
 Troubleshooting
 ------------
 

data/bin/siteleaf

@@ -17,6 +17,7 @@ Commands:
   pull theme          Pulls theme files for configured site from Siteleaf
   push theme          Pushes all files in dir as theme to configured site
   publish             Publish website to hosting provider
+  export              Exports site content to Jekyll-compatible format
   help                Prints this help document
   version             Prints the siteleaf gem version
 
@@ -88,13 +89,13 @@ def get_theme_assets(site_id)
   if assets = Siteleaf::Theme.assets_by_site_id(site_id)
     updated_count = 0
     assets.each do |asset|
-      if File.exist?(asset.filename) && (asset.checksum == Digest::MD5.hexdigest(File.read(asset.filename)))
+      if File.exist?(asset.filename) && (asset.checksum == Digest::MD5.hexdigest(IO.binread(asset.filename)))
         # file is up to date
       else
         print "Downloading #{asset.filename}..."
-        file = open(asset.file['url'], /^1\.8/.match(RUBY_VERSION) ? 'r' : 'r:UTF-8') { |f| f.read }
+        file = open(asset.file['url'], 'r:UTF-8') { |f| f.read }
         FileUtils.mkdir_p(File.dirname(asset.filename))
-        File.open(asset.filename, /^1\.8/.match(RUBY_VERSION) ? 'w' : 'w:UTF-8') { |f| f.write(file) }
+        File.open(asset.filename, 'w:UTF-8') { |f| f.write(file) }
         updated_count += 1
         print "complete.\n"
       end
@@ -109,13 +110,13 @@ def put_theme_assets(site_id)
   updated_count = 0
   ignore_paths = ['config.ru', '.*']
   ignore_paths += File.read('.siteleafignore').split(/\r?\n/) if File.exists?('.siteleafignore')
-  
+
   # upload files
   paths = Dir.glob("**/*")
   paths.each do |path|
     if !File.directory?(path) && !ignore_paths.any?{|i| File.fnmatch?(i, path, File::FNM_CASEFOLD) || File.fnmatch?(i, File.basename(path), File::FNM_CASEFOLD) }
       asset = assets.find{|a| a.filename == path }
-      if asset.nil? || (asset && asset.checksum != Digest::MD5.hexdigest(File.read(path)))
+      if asset.nil? || (asset && asset.checksum != Digest::MD5.hexdigest(IO.binread(path)))
         print "Uploading #{path}..."
         asset.delete if asset
         if response = Siteleaf::Asset.create({:site_id => site_id, :theme_id => theme.id, :file => File.new(path), :filename => path})
@@ -128,10 +129,10 @@ def put_theme_assets(site_id)
       end
     end
   end
-  
+
   # check for old files
   missing_assets = []
-  assets.each do |asset| 
+  assets.each do |asset|
     missing_assets << asset if !paths.include?(asset.filename)
   end
   if missing_assets.empty?
@@ -171,6 +172,90 @@ def publish(site_id, quiet = true)
   end
 end
 
+def export(site_id, posts_path = "posts")
+  FileUtils.mkdir_p 'export'
+  posts_path = "posts" if posts_path == ""
+  
+  site = Siteleaf::Site.find(site_id)
+  site.posts_path = posts_path
+  
+  export_uploads(site)
+  export_content(site)
+  export_config(site)
+end
+
+def export_config(site)
+  filename = site.filename
+  print "Exporting #{filename}..."
+  
+  filename = File.join("export", filename)
+  open(filename, 'w:UTF-8') do |f|
+    f.puts site.to_file
+  end
+  
+  print "complete.\n"
+end
+
+def export_content(site)
+  pages = site.pages
+
+  pages.each do |page|
+    # export non-blank pages
+    unless page.body.to_s == "" and page.meta.empty?
+      filename = page.filename
+      print "Exporting #{filename}..."
+      
+      filename = File.join("export", filename)
+      FileUtils.mkdir_p File.dirname(filename)
+      open(filename, 'w:UTF-8') do |f|
+        f.puts page.to_file
+      end
+      
+      print "complete.\n"
+    end
+
+    page.posts.each do |post|
+      filename = post.filename(site.posts_path)
+      print "Exporting #{filename}..."
+      
+      filename = File.join("export", filename)
+      FileUtils.mkdir_p File.dirname(filename)
+      open(filename, 'w:UTF-8') do |f|
+        f.puts post.to_file
+      end
+      
+      print "complete.\n"
+    end
+  end
+end
+
+def export_uploads(site)
+  FileUtils::mkdir_p 'export/_uploads'
+
+  if assets = site.assets
+    assets.each do |asset|
+      filename = File.join("export", "_uploads", asset.filename)
+      arr_path = filename.split('/')
+
+      # Make subdirectories if needed
+      if arr_path.length > 3
+        subdir = arr_path[0..(arr_path.length - 2)].join('/')
+        FileUtils::mkdir_p subdir
+      end
+
+      if !File.exist?(filename) or (asset.checksum != Digest::MD5.hexdigest(IO.binread(filename)))
+        print "Exporting #{filename}..."
+        
+        file = open(asset.file['url'], 'r:UTF-8') { |f| f.read }
+        FileUtils.mkdir_p(File.dirname(filename))
+        File.open(filename, 'w:UTF-8') { |f| f.write(file) }
+
+        print "complete.\n"
+      end
+    end
+  end
+end
+
 case ARGV[0]
 when '-v', '--version', 'version'
   puts Siteleaf::VERSION
@@ -239,6 +324,16 @@ when 'publish'
       puts "Site not configured, run `siteleaf config yoursite.com`.\n"
     end
   end
+when 'export'
+  if auth != false
+    if site_id = get_site_id
+      print 'Enter your main posts path (default "posts"): '
+      posts_path = $stdin.gets.chomp
+      export(site_id, posts_path)
+    else
+      puts "Site not configured, run `siteleaf config yoursite.com`.\n"
+    end
+  end
 else
   puts "`#{ARGV[0]}` command not found.\n"
   puts help

data/lib/patches/time_with_zone_encode_with.rb

@@ -0,0 +1,12 @@
+class Time
+  def encode_with(coder)
+    label =
+      if utc?
+        usec.zero? ? '%Y-%m-%d %H:%M:%S Z' : '%Y-%m-%d %H:%M:%S.%9N Z'
+      else
+        usec.zero? ? '%Y-%m-%d %H:%M:%S %:z' : '%Y-%m-%d %H:%M:%S.%9N %:z'
+      end
+
+    coder.represent_scalar(nil, strftime(label))
+  end
+end

data/lib/siteleaf.rb

@@ -12,7 +12,10 @@ require 'siteleaf/server'
 require 'siteleaf/site'
 require 'siteleaf/theme'
 require 'siteleaf/user'
+require 'patches/time_with_zone_encode_with'
 require 'rbconfig'
+require 'uri'
+require 'yaml'
 
 module Siteleaf
 

data/lib/siteleaf/page.rb

@@ -31,5 +31,41 @@ module Siteleaf
       Page.find(self.parent_id) if self.parent_id
     end
     
+    def draft?
+      visibility == 'draft'
+    end
+    
+    def published?
+      visibility == 'visible'
+    end
+    
+    def filename
+      "#{url.sub('/','')}.markdown"
+    end
+    
+    def to_file
+      assets = Dir.glob("export/_uploads/**/*").each_with_object({}) { |var, hash| hash[var.sub('export/_uploads','/assets')] = var.sub('export/_uploads','/uploads') }
+      (frontmatter + "---\n\n".freeze + body.to_s).gsub(Regexp.union(assets.keys), assets)
+    end
+  
+    protected
+  
+    def frontmatter
+      attrs = {}
+      attrs['title'] = title
+      attrs['date'] = Time.parse(published_at).utc
+      attrs['published'] = false if !published?
+      
+      meta.each{|m| attrs[m['key']] = m['value'].to_s.gsub("\r\n","\n")} unless meta.nil?
+      
+      if defined?(taxonomy) && !taxonomy.nil?
+        taxonomy.each do |t| 
+          attrs[t['key']] = t['values'].map{|v| v['value']} unless t['values'].empty?
+        end 
+      end
+  
+      attrs.empty? ? "---\n".freeze : attrs.to_yaml
+    end
+    
   end
 end

data/lib/siteleaf/post.rb

@@ -16,5 +16,21 @@ module Siteleaf
       result.map { |r| Asset.new(r) } if result
     end
     
+    def filename(posts_path = 'posts')
+      paths = url.sub('/','').split('/')
+      basename = "#{paths.pop}.markdown"
+      path = paths.join('_')
+      if path == posts_path 
+        if draft?
+          path = 'drafts'
+        else
+          path = 'posts'
+          date = Time.parse(published_at).strftime('%Y-%m-%d')
+          basename = "#{date}-#{basename}"
+        end
+      end
+      "_#{path}/#{basename}"
+    end
+    
   end
 end

data/lib/siteleaf/site.rb

@@ -1,7 +1,7 @@
 module Siteleaf
   class Site < Entity
 
-    attr_accessor :title, :domain, :timezone, :meta
+    attr_accessor :title, :domain, :timezone, :meta, :posts_path
     attr_reader :id, :user_id, :created_at, :updated_at
     
     def self.find_by_domain(domain)
@@ -27,6 +27,11 @@ module Siteleaf
       result.map { |r| Page.new(r) } if result
     end
     
+    def posts
+      result = Client.get "sites/#{self.id}/posts"
+      result.map { |r| Post.new(r) } if result
+    end
+    
     def resolve(url = '/')
       Client.get "sites/#{self.id}/resolve", {"url" => url}
     end
@@ -40,5 +45,68 @@ module Siteleaf
       Job.new(id: result.parsed_response["job_id"]) if result
     end
     
+    def posts_path
+      @posts_path || 'posts'
+    end
+    
+    def filename
+      "_config.yml"
+    end
+    
+    def to_file
+      assets = Dir.glob("export/_uploads/**/*").each_with_object({}) { |var, hash| hash[var.sub('export/_uploads','/assets')] = var.sub('export/_uploads','/uploads') }
+      config.gsub(Regexp.union(assets.keys), assets)
+    end
+  
+    protected
+  
+    def config
+      attrs = {}
+      attrs['title'] = title
+      attrs['url'] = "http://#{domain}"
+      
+      meta.each{|m| attrs[m['key']] = m['value'].to_s.gsub("\r\n","\n")} unless meta.nil?
+      
+      attrs['timezone'] = timezone
+      attrs['permalink'] = 'pretty'
+      
+      # output uploads using v1 /assets path
+      attrs['collections'] = {
+        'uploads' => {
+          'title' => 'Uploads', 
+          'output' => true
+        }
+      }
+      
+      # use collections for any set of posts not called "posts"
+      pages.each do |page|
+        path = page.url.sub('/','').gsub('/','_')
+        if path != posts_path && page.posts.size > 0
+          attrs['collections'][path] = {'output' => true}
+          # output permalink for non-standard urls (e.g. posts inside sub-pages)
+          attrs['collections'][path]['permalink'] = "#{page.url}/:path" if path != page.slug
+        end
+      end
+      
+      # set permalink style for posts
+      attrs['defaults'] = {
+        'scope' => {
+          'path' => '', 
+          'type' => 'posts'
+        }, 
+        'values' => {
+          'permalink' => "/#{posts_path}/:title/" 
+        }
+      }
+      
+      # markdown defaults to match v1 rendering
+      attrs['markdown'] = 'redcarpet'
+      attrs['redcarpet'] = {
+        'extensions' => ['autolink', 'fenced_code_blocks', 'lax_spacing', 'strikethrough', 'superscript', 'tables', 'footnotes', 'highlight']
+      }
+   
+      attrs.empty? ? "---\n".freeze : attrs.to_yaml
+    end
+    
   end
 end

data/lib/siteleaf/version.rb

@@ -1,3 +1,3 @@
 module Siteleaf
-  VERSION = "0.9.23"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: siteleaf
 version: !ruby/object:Gem::Version
-  version: 0.9.23
+  version: 1.0.0
 platform: ruby
 authors:
 - Siteleaf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-24 00:00:00.000000000 Z
+date: 2015-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.13.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.13.3
 - !ruby/object:Gem::Dependency
   name: httmultiparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.13
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.13
 - !ruby/object:Gem::Dependency
   name: rack
   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: A Ruby interface and command line utility for the Siteleaf API.
@@ -60,12 +60,14 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rbenv-vars"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/siteleaf
+- lib/patches/time_with_zone_encode_with.rb
 - lib/siteleaf.rb
 - lib/siteleaf/asset.rb
 - lib/siteleaf/client.rb
@@ -89,12 +91,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []