insup

Insup

Description

Insup Insales theme uploader.

Installation

gem install insup

Usage

Preparing

Enter the directory you want to sync with the remote service. Then type insup init to initialize your working directory with .insup file that holds all neccessary Insup configuration.

Open .insup file with your favourite text editor and modify the configuration according to your needs.

Configuration

.insup file is a YAML file. Here's a list of the configuration options.

• track section is an array of directories which you want to track for changes. Specify locations relative to the working directory
• ignore section specifies an array of patterns that are used to ignore files. Files that match ignore patterns will be neither tracked nor uploaded. The patterns must be specified in Git ignore format relative to the working directory.
• tracker section specifies the tracker to use as well as its configuration. The tracker class is specified by the class option.
• uploader section specifies the uploader to use as well as its configuration. The uploader class is specified by the class option.
• insales secion holds information for connecting to Insales shop. To use insales features you should specify subdomain, api_key and password parameters.
• log section sets logging parameters. Use file to specify a log file path, level to set log level (unknown, debug, error, fatal, info, unknown and warn), and pattern to specify log message pattern using %{timestamp}, %{level}, %{message}, and %{backtrace} substitutions.
• options section specifies miscellaneous options. Currently only force_polling option is implemented.

Trackers

Currently there are two trackers available:

• Git tracker finds changes in the working directory using Git index. This tracker will operate only if the working dir is a Git repository. Select this tracker by specifying Insup::Tracker::GitTracker or git in the class section of the tracker configuration.
• Simple tracker will always consider all files in the working directory modified (except the ignored ones). Specify Insup::Tracker::SimpleTracker or simple ins the class section.

Uploaders

Currently there are two uploaders available:

• Insales uploader will upload files to the specified Insales theme. Specify Insup::Uploader::InsalesUploader or insales in the class section of the uploader configuration. Insales uploader also requires theme_id to be specified. Working directory should include 3 subfolders media, snippets and templates. The same 3 folders should be specified in the track sectio of .insup file.

• Dummy uploader will only print its operations to the console without actually uploading anything. It can be used for testing the configuration. Use by specifying dummy or Insup::Uploader::DummyUploader in the class section.

Operation modes

Listen mode

In this mode Insup will continuously listen to the changes in tracked locations and upload the changes immidiately. It will use the specified uploader, but the tracker is ignored. Listen mode will only watch files that do not match ignore patterns.

Activate listen mode by typing

insup listen

or just

insup

in your working directory.

Track mode

In this mode you can periodically check for changes and upload changed files to the remote storage. Tracker specified in the .insup file is used to detect changes.

Print working directory status accroding to the selected tracker

insup status

Upload changes

insup commit

You can also specify particlular files with the commit command:

insup commit [file1 [file2 [file3 [...]]]]

In this case tracking info is ignored and each file specified is treated as modified or deleted (if it doesn't actually exist).

Other commands

List all themes in the Insales shop if insales section is given in the .insup file:

insup insales list-themes

Download all Insales theme files into the working directory:

insup insales download [-f] [-t theme-id]

Specify -f flag to overwrite any existing file. If no theme ID is specified Insup will download theme specified in the .insup file.

List files under tracked locations:

insup list-files [--all|--ignored]

Use --all option to list all files, and --ignored to list only ignored files. Calling this command without options will result in a list of tracked files only.

Getting help

To see a full list of commands available, type:

insup --help

To see help message on the specific command, type:

insup <command> --help

##Troubleshooting

Mac OsX users

For a reason yet unknown sometimes on a newer versions of Mac OsX Insup will only listen to changes that take place under the last folder listed in track settings.

Current workaround is to fall back to filesystem polling by adding the following lines to the configuration:

options:
  force_polling: true

Filesystem polling may increase the CPU usage and decrease performance. Use this only if Insup doesn't work otherwise.

Windows users

There was an issue report from Windows users concerning wrong file encoding upon uploading UTF-8 files to Insales. If you are experiencing encoding problems when running Insup on Windows, please use the following workaround until the problem is investigated and solved.

Before running any insup command exectute the following:

chcp 65001

This will change the econding of your Windows console to UTF-8 and allow you to avoid most encoding problems.