voog-kit 0.1.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e6be6c5d6e0b104cd4adefae47899ece91bad8b
+  data.tar.gz: 08cc5e8d94edff48ea1ce71bcec8b38ef004fca3
+SHA512:
+  metadata.gz: 313f9abe7994f98dc7056742bb9f918f5144550c7fc25f61619e6a76fce810db231ffa221da6f7134517d53ea81edb56fcb259216914403d1cc2ecae34001de4
+  data.tar.gz: fd80df3755d5e201a4df59ce73f5290ee63b822ac831b7d5e19809b357411ff6c54f528f894ed40a70d0b4abb7fed94fb15bce50b6a87bfe7c0a2dd95d511130

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,3 @@
+--color
+--format documentation
+--fail-fast

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in voog-kit.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Priit Haamer
+
+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.markdown

@@ -0,0 +1,142 @@
+# Voog Developer Toolkit
+
+The Voog Designer Toolkit is a simple Ruby script that simplifies the editing
+of [Voog site](http://www.voog.com) templates. It acts as a push-pull mechanism that allows you to
+fetch all layout files, work on them locally and upload them without having to 
+use the browser-based code editor.
+
+## Installation
+
+Install the Voog toolkit gem:
+
+```bash
+$ gem install voog-kit
+```
+
+This installs the main tool, `kit`, which is added to your system's $PATH, which
+means it can be run from anywhere in your system.
+
+If you want to explicitly use latest version of the [Voog API client](https://github.com/Edicy/voog.rb):
+
+```bash
+$ git pull https://github.com/Edicy/voog.rb voog-api
+$ cd voog-api
+$ bundle install
+$ rake install
+```
+
+## Basic commands
+
+* `init`     - Initializes the local folder structure and files for a site
+* `manifest` - Generates a `manifest.json` file from the site's layout and asset files
+* `check`    - Cross-checks the generated manifest to your local files to see if anything is missing
+* `pull`     - Fetches the layout and layout asset files for the given site
+* `push`     - Synchronizes your local changes with Voog
+* `watch`    - Watches for file changes in the current directory
+* `help`     - Shows a list of commands or help for one command
+
+Most commands need to know your site's URL and you personal API token to properly authorize all
+requests. For this you can either provide them with `--token/-t` and `--host/-h` 
+flags, e.g `kit pull -t afcf30182aecfc8155d390d7d4552d14 -h mysite.voog.com`. If there's a '.voog' file
+present in the current folder, it takes the options from there.
+
+There's also a `--site/-s` argument that is used to choose a configuration block from the `.voog` file.
+
+Example `.voog` file:
+
+```
+[site1]
+  host=mysite.voog.com
+  api_token=afcf30182aecfc8155d390d7d4552d14
+[site2]
+  host=site2.customdomain.co
+  api_token=5d390d7d4552d14afcf30182aecfc815
+```
+
+To choose the second block, you can simply use `kit pull -s site2` or `kit pull --site=site2`.
+If the site is not provided, **kit** will use the first block defined in the file.
+When you provide the host, token and block name, it is then written to the configuration file, overwriting
+any identically named blocks or creating a new one, if necessary.
+
+If the configuration file isn't present and you provide the token, hostname and site name manually when invoking a
+command, the file is then generated and the options are stored within so you don't have to provide them
+later.
+
+### init
+
+This command either initializes an empty folder structure via `kit init empty`, clones the file and folder
+structure of the Pripyat design (essentially a design boilerplate) via `kit init new` or uses the provided
+hostname and API token to download existing layout files from the given site via just `kit init`.
+
+### manifest
+
+The manifest file is probably the most important file in the layout file structure. It holds metadata for each
+and every file which ensures that all layout names and asset types are correct when pushing or pulling files.
+`kit manifest` on its own generates a manifest from all current local files. As this is done purely from file
+names, some generated data might be incorrect and, as such, may need manual correction.
+
+If you're generating a 
+manifest for a site that already has layout files, it would be better to use the `--remote` flag to use remote
+data instead. This takes the layout titles and asset content types that are already saved in Voog and mirrors 
+them in the manifest. 
+
+### pull
+
+`kit pull` downloads all files from the site provided via the hostname and api_token options (or from the .voog 
+file). This overwrites all existing identically named local files.
+
+By giving filenames or layout/component titles as arguments to `kit pull`, it instead downloads only those (and, 
+again, overwrites current local files). For example, `kit pull shadow.png MainMenu` would download the file *images/shadow.png*
+and the *MainMenu* component.
+
+### push
+
+`kit push` is the counterpart to `pull`. This takes the provided files or folders and uploads them to the provided
+site, overwriting existing files. Although `pull` searches by filename, `push` arguments need to be local file paths.
+For example, `kit push images/shadow.png layouts/mainmenu.tpl` works, `kit push shadow.png MainMenu` does not.
+
+### watch
+
+This command starts a watcher that monitors the current folder and its subfolders and triggers `kit push` every time
+a file changes. This is most useful for styling your site as all style changes are instantly uploaded and visible in
+the browser.
+
+`watch` also looks for newly created files and file removals, updates the manifest accordingly and triggers `kit push`.
+
+### help
+
+This command shows helpful information about the tool or its subcommands. Invoking `kit help` shows a list of possible
+options and commands with a brief description. `kit help <command>` shows information about that command.
+
+### Sample local folder structure
+
+```
+./
+    assets/
+        custom_font.woff
+    components/
+        mainmenu.tpl
+        sidebar.tpl
+        footer.tpl
+    images/
+        background.jpg
+    javascripts/
+        custom_script.js
+        spinner.js
+    layouts/
+        front_page.tpl
+        blog.tpl
+        products.tpl
+    stylesheets/
+        style.css
+    .voog
+    manifest.json
+```
+
+## 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/kit

@@ -0,0 +1,212 @@
+#!/usr/bin/env ruby
+
+# TODO: Not needed after bundled as gem
+require 'guard'
+require 'gli'
+
+$LOAD_PATH << File.expand_path('../lib', File.dirname(__FILE__))
+require 'json'
+
+require 'voog/dtk'
+require 'voog/dtk/guard'
+require 'voog/dtk/filemanager'
+require 'voog/dtk/notifier'
+require 'voog_api'
+
+include GLI::App
+
+sort_help :manually
+
+program_desc 'A tool that manages uploading and downloading Voog layout files'
+
+debug_args = [:debug, { negatable: false, default_value: false, desc: 'Show additional information on exceptions' }]
+verbose_args = [:verbose, { negatable: false, default_value: false, desc: 'Show additional information while running' }]
+silent_args = [:silent, { default_value: false, negatable: false, desc: 'Hide all information text while running' }]
+hostname_args = [:h, :host, :hostname, { desc: 'Provide a hostname', arg_name: :HOST }]
+api_token_args = [:t, :token, :api_token, { desc: 'Provide an API token', arg_name: :API_TOKEN }]
+site_args = [:s, :site, { arg_name: :SITE, default_value: nil, desc: 'Specify which site block to use when parsing the .voog file' }]
+
+flag *hostname_args
+flag *api_token_args
+flag *site_args
+
+switch *debug_args
+switch *verbose_args
+switch *silent_args
+version Voog::Dtk::VERSION
+
+desc 'Initializes the local folder structure and files for a site'
+long_desc "The init command takes a hostname and an api token
+          as arguments, fetches the structure of the site and
+          recreates it locally in the same folder the command
+          was evoked in.\n
+          If the hostname and/or api-token aren't provided via command-line
+          arguments, the tool looks for a .voog file in the current working
+          directory that has those. See the readme for more information
+          (http://github.com/Edicy/voog-kit)"
+command :init do |c|
+  c.switch *debug_args
+  c.switch *verbose_args
+  c.switch *silent_args
+  c.flag *hostname_args
+  c.flag *api_token_args
+  c.flag *site_args
+  c.action do |global_options, options, args|
+    @filemanager.create_folders
+    @filemanager.create_files
+  end
+
+  c.command :empty do |e|
+    e.action do |e|
+      Voog::Dtk.write_config('','',false)
+      @filemanager.create_folders
+    end
+  end
+
+  c.command :new do |n|
+    n.action do |n|
+      @filemanager.fetch_boilerplate
+    end
+  end
+end
+
+desc 'Looks for missing files and folders'
+command :check do |c|
+  c.switch *debug_args
+  c.switch *verbose_args
+  c.switch *silent_args
+  c.flag *hostname_args
+  c.flag *api_token_args
+  c.flag *site_args
+  c.action do |global_options, options, args|
+    @filemanager.check
+  end
+end
+
+desc 'Fetches the layout and layout asset files for the given site'
+long_desc 'If no arguments are provided, the \'pull\' command fetches all
+          layout files and layout assets and (re-)generates a manifest file.
+          If filenames are provided, it fetches only those and updates the
+          manifest with only those files. The provided names can be either
+          filenames or layout/component titles.'
+command :pull do |c|
+  c.switch *debug_args
+  c.switch *verbose_args
+  c.switch *silent_args
+  c.flag *hostname_args
+  c.flag *api_token_args
+  c.flag *site_args
+  c.action do |global_options, options, args|
+    unless args.empty? # if filenames are given, pull specified files and generate new manifest
+      @filemanager.pull_files(args)
+    else # otherwise pull everything and generate new manifest
+      @filemanager.create_folders
+      @filemanager.create_files
+      @filemanager.generate_remote_manifest
+    end
+  end
+end
+
+desc 'Updates remote files with local changes'
+long_desc "The 'push' command takes the space-separated list of filenames and 
+          uploads them, if possible, to Voog. When uploading layout files (layouts
+          or components), the command looks for the manifest.json file to find which
+          files correspond to which remote layouts."
+command :push do |c|
+  c.switch *debug_args
+  c.switch *verbose_args
+  c.switch *silent_args
+  c.flag *hostname_args
+  c.flag *api_token_args
+  c.flag *site_args
+  c.action do |global_options, options, args|
+    @filemanager.upload_files args
+  end
+end
+
+desc "Generates a manifest.json file from the site's layout and asset files."
+long_desc "This looks through the current directory's subdirectories and files
+          within them to compile a 'manifest.json' file. This is used for keeping
+          metadata about layout files that can't easily be attached to files 
+          themselves. When creating the manifest, you might have to manually 
+          edit it to correspond to possible remote differences. When invoking the
+          command with the --remote flag, the manifest is instead generated from
+          remote files which, again, might not correspond to your local file structure."
+command :manifest do |c|
+  c.switch *debug_args
+  c.switch *verbose_args
+  c.switch *silent_args
+  c.flag *hostname_args
+  c.flag *api_token_args
+  c.flag *site_args
+  c.switch(
+    [:r, :remote],
+    default_value: false,
+    negatable: false,
+    desc: 'generate manifest from remote files'
+  )
+  c.action do |global_options, options, args|
+    if options.fetch(:remote, @config[:remote])
+      @filemanager.generate_remote_manifest
+    else
+      @filemanager.generate_local_manifest
+    end
+  end
+end
+
+desc 'Watches for file changes and pushes them automatically'
+command :watch do |c|
+  c.switch *debug_args
+  c.switch *verbose_args
+  c.switch *silent_args
+  c.flag *hostname_args
+  c.flag *api_token_args
+  c.flag *site_args
+  c.action do |global_options, options, args|
+    Voog::Dtk::Guuard.new(@filemanager).run
+    sleep 0.5 while ::Guard.running
+  end
+end
+
+pre do |global, command, options, args|
+  @config_block = global.fetch(:site, nil) || options.fetch(:site, nil)
+  @debug = global.fetch(:debug, false) || options.fetch(:debug, false)
+
+  silent = global.fetch(:silent, false) || options.fetch(:silent, false)
+  verbose = global.fetch(:verbose, false) || options.fetch(:verbose, false)
+
+  @notifier = Voog::Dtk::Notifier.new($stderr, silent)
+
+  host = global.fetch(:host, nil) || options.fetch(:host, nil)
+  api_token = global.fetch(:token, nil) || options.fetch(:token, nil)
+
+  if host && api_token && @config_block
+    Voog::Dtk.write_config(host, api_token, @config_block)
+  end
+
+  @config = Voog::Dtk.read_config @config_block
+
+  if Voog::Dtk::config_exists? || Voog::Dtk::global_config_exists?
+    unless [:new, :empty, :check].include? command.name
+      fail 'Hostname not found from arguments or from configuration file'.red unless host || @config[:host]
+      fail 'API token not found from arguments or from configuration file'.red unless api_token || @config[:api_token]
+    end
+  else
+    unless [:new, :empty, :check].include? command.name
+      fail 'Configuration file not found!'.red unless host && api_token
+    end
+  end
+
+  host ||= @config[:host]
+  api_token ||= @config[:api_token]
+
+  client = Voog::Client.new(host, api_token)
+  @filemanager = Voog::Dtk::FileManager.new(client, verbose, silent)
+end
+
+on_error do |exception|
+  Voog::Dtk.handle_exception(exception, @debug, @notifier)
+  false
+end
+
+exit run(ARGV)