voog-kit 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1c88db6b03fc5e1e036dd8ed3df13bb2f5cb1b2
-  data.tar.gz: eb9caf57e75c716860c4c2b719d5f283a8cd090a
+  metadata.gz: ac0a57de7355211889a4cec2cd4c62b405e5f2ac
+  data.tar.gz: 524285b8c42a5f49aa0bfbbdd6e5bb46172e5a82
 SHA512:
-  metadata.gz: 621fd03b7e3dfdbd2801bff9df93337cdbaf93b329de9b71fcc99579b4cb329bca156746ac41c39be6fc3a56a0a5b73adec06b78852084cb3daf18b2fabd75a4
-  data.tar.gz: 2771bf3cad4702850652021296b9e3fa1253bf090b125206885e6954b29fdbb4de6459d3a42cd2bf3ba94fe57b2d0fbda98111681d15e9c24b3373c719af1ecd
+  metadata.gz: b47f316dc4afa5877e979e46363c2497047ccb04a9b4beba5694c182466b8967c54d558842ba9f7563c1808aa7efa31b869d757cf202bb7eeba308fd61f7706c
+  data.tar.gz: 2b18928b4acf862ab8857094c1eb007dacd1cea452d19280907edbc298aab3d947ad0bcc9edb4d1fff2de631639062e033169554443eedb00af1af1476aedf5d

data/README.markdown

@@ -1,9 +1,9 @@
 # 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.
+The Voog Designer Toolkit is a simple command-line tool that simplifies the editing
+of [Voog](http://www.voog.com) sites. It allows you to pull the layout files to your
+own computer and push them back online after you've finished. There are also other
+utility commands, described below.
 
 ## Installation
 
@@ -16,16 +16,56 @@ $ 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
+### API token
+To use the toolkit, you have to generate your API token from your profile settings 
+page (http://yoursite.voog.com/admin/people/profile). 
+![generating the API token](https://dl.dropboxusercontent.com/u/10145790/generating_api_token.png)
+
+You should see something like this:
+
+![API token is generated](https://dl.dropboxusercontent.com/u/10145790/api_token_generated.png)
+
+Without this token, *kit* will not allow you to access or change your layout files.
+
+## Basic usage
+
+The most straightforward usage for `kit` is to synchronize layout files between the
+live site and your local machine.
+
+After following the voog-kit installation instruction, you set up `kit` and  also generated an API token: `0809d0c93c53438d435b2073d2cf2d22` for your customisite
+at `mysite.voog.com`. This is essentially all you need to get started.
+
+### Downloading the layout
+
+Let's start.
+
+`kit pull -h mysite.voog.com -t 0809d0c93c53438d435b2073d2cf2d22` downloads the layout files
+from *mysite.voog.com* using the API token *0809d0c93c53438d435b2073d2cf2d22*. This creates 
+the necessary folders to hold the files, so the file structure stays the same as in the 
+online code editor.
+
+The current folder structure should be something like this:
 ```
+./
+    assets/
+    components/
+    images/
+    javascripts/
+    layouts/
+    stylesheets/
+```
+
+As you can see, kit also generated a *manifest.json* file to hold the metadata to along with
+the layout files. This is later used when checking for missing files and uploading everything back up.
+
+There's also a *.voog* file that holds your hostname and API token so you don't have to provide them
+every time:
+
+
+### Uploading the changes
 
-## Basic commands
+## 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
@@ -37,7 +77,7 @@ $ rake install
 
 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
+flags, e.g `kit pull -t 0809d0c93c53438d435b2073d2cf2d22 -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.
@@ -47,7 +87,7 @@ Example `.voog` file:
 ```
 [site1]
   host=mysite.voog.com
-  api_token=afcf30182aecfc8155d390d7d4552d14
+  api_token=0809d0c93c53438d435b2073d2cf2d22
 [site2]
   host=site2.customdomain.co
   api_token=5d390d7d4552d14afcf30182aecfc815
@@ -69,7 +109,7 @@ To enable overwriting for all commands, you can add it to the site's configurati
 ```
 [site1]
   host=mysite.voog.com
-  api_token=afcf30182aecfc8155d390d7d4552d14
+  api_token=0809d0c93c53438d435b2073d2cf2d22
   overwrite=true
 ```
 
@@ -146,6 +186,15 @@ options and commands with a brief description. `kit help <command>` shows inform
     manifest.json
 ```
 
+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
+```
+
 ## Contributing
 
 1. Fork it

data/bin/kit

@@ -193,11 +193,12 @@ pre do |global, command, options, args|
   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
+  if host && api_token
     Voog::Dtk.write_config({
       host: host,
       api_token: api_token,
-      block: @config_block,
+      overwrite: overwrite,
+      block: @config_block || host,
       overwrite: overwrite
     })
   end

data/lib/voog/dtk.rb

@@ -50,13 +50,14 @@ module Voog
         host = opts.fetch(:host, '')
         api_token = opts.fetch(:api_token, '')
         silent = opts.fetch(:silent, false)
+        overwrite = opts.fetch(:overwrite, false)
 
         @file = if config_exists?
           CONFIG_FILENAME
         elsif global_config_exists?
           [ENV['HOME'], CONFIG_FILENAME].join('/')
         else
-          File.new(CONFIG_FILENAME)
+          File.new(CONFIG_FILENAME, 'w+')
           CONFIG_FILENAME
         end
 

data/lib/voog/dtk/version.rb

@@ -1,5 +1,5 @@
 module Voog
   module Dtk
-    VERSION = '0.2.0'
+    VERSION = '0.2.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: voog-kit
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Mikk Pristavka
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-29 00:00:00.000000000 Z
+date: 2014-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -219,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Voog Developer Toolkit