ghost-backup 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc4061b469cecc705d4778038378fb28d280d4dd
+  data.tar.gz: f6bf6f78cf4a3f84d0e37993951d937df7eef8c5
+SHA512:
+  metadata.gz: 70f52837c26735267a5618fe138628cf102dd070c5aa349c5dfd8a4d599af28f4eb8be59055163fd9bc39f446c3c590c2847b4e3236b026c652589317144c198
+  data.tar.gz: 3a5fe36c990bfba123e7d322d1bd8f189fb3cb009a8e3afaaea30c1a6368c39ce6ae38f82edb3f58bdbdb50eabefcd9ea137c3e48f5f688990ef2621689c216f

data/.gitignore

@@ -0,0 +1,40 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+Gemfile.lock
+*.yml
+*.json
+contents

data/LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2015, Min RK
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of ghost-backup nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/README.md

@@ -0,0 +1,69 @@
+# ghost-backup
+
+Backup [ghost](https://ghost.org/) blog data.
+
+This does two things:
+
+1. Download the JSON export of the ghost post database
+2. Make a copy of the ghost content directory (image assets, etc.)
+
+Part 2 is only run
+
+## Install
+
+    gem install ghost-backup
+
+## Usage
+
+### Config
+
+The first step is to generate `ghost-backup.yml`:
+
+    $> ghost-backup config
+    Writing config to ghost-backup.yml
+
+The edit this file:
+
+```yaml
+---
+username: 
+backup_dir: ghost-backup/%Y-%m-%d-%H%M%S
+ghost_dir: /var/www/ghost
+refresh_token: 
+base_url: https://localhost
+```
+
+- **username:** the username you use to login to the ghost server (optional)
+- **backup_dir:** where backups should go. This passed to `strftime` at expor time
+- **ghost_dir:** where on the local filesystem ghost is installed. If this location does not exist,
+  local assets will not be backed up, only the post database.
+- **refresh_token:** ignore; this will be populated by the program when you login.
+- **base_url:** the base URL of your ghost instance, e.g. `https://myblog.plumbing`
+
+### Login
+
+Once you have your `ghost-backup.yml`, you can login to ghost:
+
+    $> ghost-backup login
+    Logging in to https://my.blog/ghost/api/v0.1/authentication/token
+    Need username, password to generate new token (only used once, not stored).
+    Username: |you@email.com| 
+    Password (not stored): *****
+    Writing config to ghost-backup.yml
+
+Ghost tokens expire after a week, so to keep them alive you have to login at least once a week:
+
+    $> ghost-backup login
+    Logging in to https://my.blog/ghost/api/v0.1/authentication/token
+
+Unless your token expires, logins after the first will not require a username or password.
+
+### Backup
+
+Now you can run a backup:
+
+    $> ghost-backup
+    Backing up 'https://my.blog' to '/backup/ghost-backup-2015-09-15-1306'
+    Copying /var/www/ghost/content → /backup/ghost-backup-2015-09-15-1306/content
+    Downloading ghost database https://blog.jupyter.org/ghost/api/v0.1/db/
+    Backing up database to '/backup/ghost-backup-2015-09-15-1306/ghost-db.json'

data/bin/ghost-backup

@@ -0,0 +1,224 @@
+#!/usr/bin/env ruby
+
+# Copyright (c) Min RK.
+# Distributed under the terms of the Modified BSD License.
+
+require 'date'
+require 'json'
+require 'yaml'
+
+# gems
+require 'rest-client'
+require 'commander/import'
+require 'highline/import'
+
+program :version, '0.0.1'
+program :description, 'Backup ghost blog data'
+
+class GhostBackup
+  CONFIG_KEYS = [
+    'username',
+    'backup_dir',
+    'ghost_dir',
+    'refresh_token',
+    'base_url',
+  ]
+  
+  API_VERSION = 'v0.1'
+  
+  def initialize(config_file: "ghost-backup.yml")
+    @dirty = false
+    if config_file.nil?
+      @config_file = "ghost-backup.yml"
+    else
+      @config_file = config_file
+    end
+    @username = nil
+    # backup_dir is passed to strftime
+    @backup_dir = 'ghost-backup/%Y-%m-%d-%H%M%S'
+    @ghost_dir = "/var/www/ghost"
+    @base_url = 'https://localhost'
+    @refresh_token = nil
+    load_config
+    unless @base_url.include? '://'
+      @base_url = 'https://' + @base_url
+    end
+  end
+  
+  attr_accessor :config_file
+  
+  # gen config as a hash
+  def cfg
+    Hash[
+      CONFIG_KEYS.map { |key|
+        [key, self.instance_variable_get("@#{key}")]
+      }
+    ]
+  end
+  
+  # load yaml config file
+  def load_config
+    if not File.exists? @config_file
+      @dirty = true
+      return
+    end
+    d = YAML.load_file @config_file
+    if not d
+      return
+    end
+    if not d.instance_of? Hash
+      throw Error("Bad config: #{config_file}")
+    end
+    d.each_pair do |key, value|
+      self.instance_variable_set("@#{key}", value)
+    end
+  end
+  
+  # save yaml config file, if there have been changes
+  def save_config
+    return unless @dirty
+    puts "Writing config to #{@config_file}"
+    File.open(@config_file, 'w') do |f|
+      f.write(YAML.dump(cfg))
+    end
+    @dirty = false
+  end
+  
+  # the base API url
+  def api_url
+    "#{@base_url}/ghost/api/#{API_VERSION}"
+  end
+  
+  # the url for getting a new token
+  def token_url
+    "#{api_url}/authentication/token"
+  end
+  
+  # the url for downloading the database as JSON
+  def db_url
+    "#{api_url}/db/"
+  end
+  
+  # generate a new token with username/password via API request
+  def new_token(username, password)
+    reply = JSON.parse RestClient.post token_url, {
+      :grant_type => 'password',
+      :username => username,
+      :password => password,
+      :client_id => 'ghost-admin',
+    }
+    @refresh_token = reply['refresh_token']
+    @access_token = reply['access_token']
+    @dirty = true
+  end
+  
+  # refresh authorization token
+  def refresh
+    reply = JSON.parse RestClient.post token_url, {
+      :grant_type => 'refresh_token',
+      :refresh_token => @refresh_token,
+      :client_id => 'ghost-admin',
+    }
+    @access_token = reply['access_token']
+  end
+  
+  # ensure we are logged in
+  # refreshes token if we are,
+  # prompts for user/password if we are not
+  def authorize
+    if @refresh_token
+      begin
+        refresh
+      rescue RestClient::Exception
+        STDERR.puts "refresh token expired"
+        @refresh_token = nil
+      end
+    end
+    
+    if @refresh_token.nil?
+      puts "Need username, password to generate new token (only used once, not stored)."
+      username = @username = ask("Username: ") do |q|
+        q.default = @username
+        q.validate = /\S+/
+      end
+      password = ask("Password (not stored): ") { |q| q.echo = '*' }
+      new_token(username, password)
+      puts "Login success!"
+    end
+  end
+  
+  # backup methods
+  
+  # download the JSON dump of the database
+  def download_db
+    puts "Downloading ghost database #{db_url}"
+    if @access_token.nil?
+      authorize
+    end
+    RestClient.get db_url, {:params => {:access_token => @access_token}}
+  end
+  
+  # run a real backup
+  def backup
+    now = DateTime.now
+    dest_root = now.strftime(@backup_dir)
+    puts "Backing up '#{@base_url}' to '#{dest_root}'"
+    FileUtils.mkdir_p(dest_root)
+    if File.exists? @ghost_dir
+      from = File.join(@ghost_dir, 'content')
+      to = File.join(dest_root, 'content')
+      puts "Copying #{from} → #{to}"
+      FileUtils.cp_r(from, to)
+    else
+      STDERR.puts "Ghost directory '#{@ghost_dir}' doesn't exist, not backing up assets."
+    end
+    db_dest = File.join(dest_root, "ghost-db.json")
+    db = download_db
+    puts "Backing up database to '#{db_dest}'"
+    File.open(db_dest, 'w') { |f| f.write(db) }
+  end
+end
+
+global_option('-f', '--config-file CONFIG_FILE', 'Specify config file to use')
+
+
+command :login do |c|
+  c.syntax = 'ghost-backup login'
+  c.summary = 'Login to the ghost server'
+  c.description = 'Login to the ghost server and generate an auth token.
+  On first run, requires a username and password,
+  and records the refresh token in the config file.
+  Must be run at least once a week to keep the token active
+  and avoid re-entering username and password.'
+  c.action do |args, options|
+    gb = GhostBackup.new(:config_file => options.config_file)
+    puts "Logging in to #{gb.token_url}"
+    gb.authorize
+    gb.save_config
+  end
+end
+
+
+command :backup do |c|
+  c.syntax = 'ghost-backup backup'
+  c.summary = 'backup a ghost blog instance'
+  c.description = 'Downloads the post database and, if available, copies the local assets directory.'
+  c.action do |args, options|
+    gb = GhostBackup.new(:config_file => options.config_file)
+    gb.backup
+    gb.save_config
+  end
+end
+
+
+command :config do |c|
+  c.syntax = 'ghost-backup config'
+  c.summary = 'Generate default ghost-backup.yml'
+  c.description = 'Generate default ghost-backup.yml. Edit this file to configure the backup.'
+  c.action do |args, options|
+    gb = GhostBackup.new(:config_file => options.config_file)
+    gb.save_config
+  end
+end
+
+default_command :backup

data/ghost-backup.gemspec

@@ -0,0 +1,19 @@
+require 'date'
+
+Gem::Specification.new do |s|
+  s.name        = 'ghost-backup'
+  s.version     = '0.0.1'
+  s.date        = Date.today.to_s
+  s.summary     = 'Backup ghost blog data'
+  s.description = 'Dump ghost database and assets to local disk'
+  s.authors     = ['Min RK']
+  s.email       = 'benjaminrk@gmail.com'
+  s.homepage    = 'http://github.com/minrk/ghost-backup'
+  s.license     = 'BSD'
+  s.executables = ['ghost-backup']
+  s.files       = `git ls-files`.split($/)
+  s.require_paths = ['.']
+  s.add_runtime_dependency 'commander', '~> 4.3'
+  s.add_runtime_dependency 'highline', '~> 1.7'
+  s.add_runtime_dependency 'rest-client', '~> 1.8'
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: ghost-backup
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Min RK
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: Dump ghost database and assets to local disk
+email: benjaminrk@gmail.com
+executables:
+- ghost-backup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- bin/ghost-backup
+- ghost-backup.gemspec
+homepage: http://github.com/minrk/ghost-backup
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- "."
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Backup ghost blog data
+test_files: []
+has_rdoc: