haravan_theme 0.0.25

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 958bc1d2190cb079a934924bf3a28df2b88a8dd0
+  data.tar.gz: e6c7f14ca99cc56521c65f485b66cb277f456c28
+SHA512:
+  metadata.gz: 2f047b5aafdf57fc35c877541ee68de77e8cf4d072644c464509ea865e3ba56d23e7dafca101fe5614bb50765ada2f47dfc2a7dc12c1aed998171d8a2605ae08
+  data.tar.gz: 35e6176b440366968a70eb6338ba67d0703bc065fefdda17546d603a1545c3783a9597424d400267fc0f595c20ade30858b60cf53f7da86ca83c43d9de6ec5f7

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.project
+.idea

data/.travis.yml

@@ -0,0 +1,7 @@
+langauge: ruby
+sudo: false
+rvm:
+  - 1.9.3
+  - 2.0.0
+env:
+  - VERIFY_CERT=true

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+# v0.0.23 (Unreleased)
+
+* Adds support for OAuth access token based authentication -- gavinballard
+
+# v0.0.22
+
+* Parsing of Timber release feed to always retrieve latest release
+* Minor documentation improvements
+
+# v0.0.21
+
+* Adds Locale support
+* Running `theme replace` no longer deletes unwatched files if they are found on Haravan
+
+# v0.0.20
+
+* Fixes issue with unknown types raising exceptions -- csaunders
+
+# v0.0.19
+
+* Fixes issue with incorrectly detecting binary assets -- csaunders
+* Properly handle unknown event types -- 
+
+# v0.0.12
+
+* Fixes issue where app tried uploading directories
+
+# v0.0.11
+
+* Locks JSON api version which fixed an issue with downloading large binary files -- Tyler Ball
+* Respect API limits when downloading theme assets from Haravan API -- Chris Saunders

data/CONTRIBUTING

@@ -0,0 +1,6 @@
+- If the issue doesn't exist, open one to start a discussion
+- If the issue is fine (it probably is) start working on your patch
+- Create a Pull Request
+  - Be sure to update CHANGELOG.md to include the details of your fix
+- Go through code review
+- Get it merged

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Haravan
+
+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.md

@@ -0,0 +1,171 @@
+
+# Edit Your Haravan Theme Locally
+[![Gem Version](https://badge.fury.io/rb/haravan_theme.svg)](http://badge.fury.io/rb/haravan_theme)
+
+![Haravan theme gem](https://dl.dropboxusercontent.com/u/669627/terminalreadme.png)
+
+The Haravan theme gem is a command line tool that allows you to manage and edit theme files directly on your computer. This allows you to use your preferred code editing software opposed to the built in code editor available in the “Edit HTML/CSS” page of your store. Files can be manually or automatically uploaded, downloaded, and synced. Depending on how you develop themes and your personal preference, this can allow for a more enjoyable and streamlined workflow.  If the command line is scary for you, check out the [Desktop Theme Editor app](http://apps.haravan.com/desktop-theme-editor).
+
+
+## Requirements
+This gem works with OS X or Windows with Ruby 1.9.
+
+First time installing Ruby on Windows? Try [Rubyinstaller](http://rubyinstaller.org/).
+
+
+## Configuration
+### Setting up Haravan Theme
+
+First, you will need to set up a new private app to generate an API key and password. Go to **your_store.com**/admin/apps/private in your web browser.
+
+Click on “Create a Private App” to generate the credentials for a new app. You will need the API key and the password of this newly generated app:
+
+![api-key-and-password](doc/API-key-and-password.jpg)
+
+Navigate to the directory where you theme files live, or where you'd like them to be, and execute the following command:
+
+`theme configure api_key password store_domain`
+
+**Important:** enter the `store_domain` with no `http://`.
+
+In your directory you should see a file named config.yml with your credentials. If you want, you may also edit the config.yml file directly and paste your API Key and Password in the appropriate area.
+
+
+### The config.yml File
+The config.yml file contains the information needed for Haravan to authenticate requests and edit/update the theme files in the manner specified. Here is an example of what the contents in a typical `config.yml` file would look like:
+
+```yaml
+---
+:api_key: 7a8da86d3dd730b67a357dedabaac5d6
+:password: 552338ce0d3aba7fc501dcf99bc57a81
+:store: little-plastics.myharavan.com
+:theme_id:
+:whitelist_files:
+- directoryToUpload/
+- importantFile.txt
+:ignore_files:
+- config/settings.html
+```
+
+
+#### Here is a Breakdown of the Fields:
+
+`api_key`
+
+The API key generated in your private app.
+
+`password`
+
+The password generated in your private app.
+
+`store`
+
+The address of your store (note there is no leading http:// or https://)
+
+`theme_id`
+
+The theme id of the theme that should be responding to commands. If no theme id is specified, the currently active theme will be modified.
+
+`whitelist_files`
+
+Specifies which files and directories should be responding to changes. If nothing is specified, the  `assets/, config/, layout/, snippets/, templates/ and locales/` directories will be modified according to commands entered.
+
+`ignore_files`
+
+Specifies which files should be explicitly ignored and not affected by any commands entered.
+
+### Alternative OAuth configuration (for advanced users)
+As of v0.0.23, you can use a Haravan application's OAuth access token to authenticate with a store and manipulate theme files.
+
+Once your application has obtained an access token through Haravan's regular OAuth authentication flow, run the following command to configure the gem:
+
+`theme configure_oauth access_token store_domain`
+
+The gem can then be used in exactly the same way as if you were authenticating via a Private App.
+
+Note that the access token your Application has obtained ***must*** be valid for the `write_themes` scope in order to use the theme gem in this way.
+
+
+## Commands
+
+`theme download`
+
+Downloads the theme files from your store to your computer.
+
+`theme upload path/to/file`
+
+Uploads a single file to your store. You can also upload directories by using the wildcard character. The command `theme upload assets/*` will upload all files in the assets directory.
+
+`theme remove path/to/file`
+
+Remove a single file from your store. You can also remove directories by using the wildcard character, similar to the theme upload command. The command theme `remove assets/*` will remove all files in the assets directory.  
+`theme replace`
+
+**This command can be destructive so it should be used with caution.**
+
+This command replaces all store files with local files; it ensures the store theme files mirrors the files locally.  If you are familiar with FTP or SFTP to upload files to a server, this is similar but not exactly the same. In addition to transferring files, it will delete any theme files in your store that are not present locally.
+
+`theme watch`
+
+Once this command is entered, it continuously monitors files for changes. If a change is detected, it automatically uploads that file to your store. This is similar to [grunt watch](https://github.com/gruntjs/grunt-contrib-watch). To stop theme watch press CRTL + C.  
+`theme open`
+
+This command opens your store in the default browser specified on your computer.
+
+`theme bootstrap api_key password store theme_name --version=[version]`
+
+This command is useful if you are starting a brand new theme. It automatically populates your store with a fresh copy of the [Haravan Timber framework](http://haravan.github.io/Timber/).  If you haven’t heard of Timber, it is a theme framework designed for specifically for Haravan themes, made by Haravan. If you enjoy using frameworks like [Bootstrap](http://getbootstrap.com/) or [Foundation](http://foundation.zurb.com/) for your projects, you’ll certainly find Timber useful.
+
+The bootstrap command requires several parameters:
+
+`api_key`
+
+The same API key used in your config.yml file
+
+`password`
+
+The same password used in your config.yml file
+
+`store`
+
+The same store used in your config.yml file
+
+`theme_name`
+
+The name of the theme that will house the Timber framework files. A directory will be created with this name and all theme assets will be copied into it.
+
+**Options**
+
+`--version=[latest]`
+
+This is the only option that you can provide. You can choose any [Timber release](https://github.com/Haravan/Timber/releases) by simply specifying it (i.e. `v2.0.2`). There are two special versions you can use, `master` and `latest`.
+
+- `master` will download the latest build on the Timber master branch.
+- `latest` will figure out what the most recent release is and use it.
+
+## Tips and Tricks
+### Edit and Preview Inactive Themes
+In many cases you may want to work on a theme behind the scenes while your current theme is still active. To accomplish this there are two steps:
+
+* Utilize the theme preview option in your Haravan store. This is a built in feature of Haravan outside the scope of Haravan theme. 
+You can find your theme ID by looking at the URL:
+
+![themes/THEME_ID/settings](doc/how_to_find_theme_id.png)
+
+## Common Problems
+### SocketError or SSL Certificate Validation Error on Windows
+If you receive a SocketError or SSL certificate validation error when you try to run any theme command, your install may not have any valid SSL certificates.
+
+In short, you can solve this problem by downloading [this file](http://curl.haxx.se/ca/cacert.pem) and placing it in `C:\RailsInstaller\`. The file should retain the name cacert.pem. Once this is done, run `set SSL_CERT_FILE=C:\RailsInstaller\cacert.pem`.  The Haravan theme commands should be working now. This technique will need to be repeated each time your computer boots up. For a more detailed and permanent solution check out these resources:
+
+* [setting a the SSL_CERT_FILE environment variable on your system](http://www.computerhope.com/issues/ch000549.htm)
+* [Download a cacert.pem file for RailsInstaller](https://gist.github.com/fnichol/867550)
+* [Certificate failed after update](https://github.com/Haravan/haravan_theme/issues/103)
+
+
+## Important Notes
+### Prevent Resetting of Theme Settings
+In some cases you may want to add `config/settings_json.js` to the `ignore_files` list in your config.yml file. When you save your the theme settings for your store, Haravan stores the current values in this file. If you upload your local copy of config/settings_json.js your current settings may be reset to default values if it does not contain the current settings data.
+
+### Sass Compilation
+There is no need to compile your .scss files locally when using Haravan theme.  They are automatically compiled upon upload and available as .css files on the web page, retaining the same filename.

data/Rakefile

@@ -0,0 +1,28 @@
+require 'bundler'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'haravan_theme'
+
+task :default => [:spec]
+
+Rake::TestTask.new 'spec' do |t|
+  ENV['test'] = 'true'
+  t.libs = ['lib', 'spec']
+  t.ruby_opts << '-rubygems'
+  t.verbose = true
+  t.test_files = FileList['spec/**/*_spec.rb']
+end
+
+desc "Update the built-in CA root certificate file"
+task :update_cert_file do
+  require 'net/http'
+  require 'uri'
+  cert_uri = URI(HaravanTheme::REMOTE_CERT_FILE)
+  response = Net::HTTP.get_response(cert_uri)
+  if response.code == '200'
+    File.open(HaravanTheme::CA_CERT_FILE, 'wb') { |cert_file| cert_file << response.body }
+  else
+    fail "Could not download certificate bundle from #{cert_uri}"
+  end
+end
+

data/bin/theme

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+# This allows haravan_theme to run easily from a git checkout without install.
+# Hat tip to chriseppstein of Compass fame for the code for this
+def fallback_load_path(path)
+  retried = false
+  begin
+    yield
+  rescue LoadError
+    unless retried
+      $: << path
+      retried = true
+      retry
+    end
+    raise
+  end
+end
+
+fallback_load_path(File.join(File.dirname(__FILE__), '..', 'lib')) do
+  require 'haravan_theme'
+  require 'haravan_theme/cli'
+  require 'haravan_theme/releases'
+  require 'haravan_theme/api_checker'
+end
+
+HaravanTheme::Cli.start(ARGV)

data/haravan_theme.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "haravan_theme/version"
+
+Gem::Specification.new do |s|
+  s.name        = "haravan_theme"
+  s.version     = HaravanTheme::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["John Duff"]
+  s.email       = ["john.duff@shopify.com"]
+  s.homepage    = "https://github.com/Haravan/haravan_theme"
+  s.summary     = %q{Command line tool for developing themes}
+  s.description = %q{Command line tool to help with developing Haravan themes. Provides simple commands to download, upload and delete files from a theme. Also includes the watch command to watch a directory and upload files as they change.}
+  s.license     = 'MIT'
+
+  s.rubyforge_project = "haravan_theme"
+  s.add_dependency('thor', '>= 0.14.4')
+  s.add_dependency('httparty', '~> 0.13.0')
+  s.add_dependency('json', '~> 1.8.0')
+  s.add_dependency('mimemagic')
+  s.add_dependency('filewatcher')
+  s.add_dependency('launchy')
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'minitest', '>= 5.0.0'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'vcr'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+end