shopify_theme_multi_shop 0.0.8

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Shopify
+
+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,47 @@
+# Requirements
+
+Ruby 1.9
+
+# Installation
+
+````
+gem install shopify_theme [optional_theme_id]
+````
+
+# Usage
+
+Generate the config file. Go get a valid api_key and password for your store head to https://[your store].myshopify.com/admin/api and generate a private application. Default it adds the main theme, if you want to edit one of your other themes, add the theme_id.
+
+````
+theme configure api_key password store_url
+````
+
+Download all the theme files
+
+````
+theme download --env=staging
+````
+
+Upload a theme file
+
+````
+theme upload assets/layout.liquid --env=staging
+````
+
+Remove a theme file
+
+````
+theme remove assets/layout.liquid --env=staging
+````
+
+Completely replace shop theme assets with the local assets
+
+````
+theme replace --env=staging
+````
+
+Watch the theme directory and upload any files as they change
+
+````
+theme watch --env=staging
+````

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/theme

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+# This allows shopify_them 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 'shopify_theme'
+  require 'shopify_theme/cli'
+end
+
+ShopifyTheme::Cli.start(ARGV)

data/lib/shopify_theme.rb

@@ -0,0 +1,57 @@
+require 'httparty'
+module ShopifyTheme
+  include HTTParty
+
+  NOOPParser = Proc.new {|data, format| {} }
+
+  def self.asset_list(env)
+    # HTTParty parser chokes on assest listing, have it noop
+    # and then use a rel JSON parser.
+    response = shopify(env).get(path(env), :parser => NOOPParser)
+    assets = JSON.parse(response.body)["assets"].collect {|a| a['key'] }
+    # Remove any .css files if a .css.liquid file exists
+    assets.reject{|a| assets.include?("#{a}.liquid") }
+  end
+
+  def self.get_asset(asset, env)
+    response = shopify(env).get(path(env), :query =>{:asset => {:key => asset}}, :parser => NOOPParser)
+    # HTTParty json parsing is broken?
+    JSON.parse(response.body)["asset"]
+  end
+
+  def self.send_asset(data, env)
+    shopify(env).put(path(env), :body =>{:asset => data})
+  end
+
+  def self.delete_asset(asset, env)
+    shopify(env).delete(path(env), :body =>{:asset => {:key => asset}})
+  end
+
+  def self.config
+    @config ||= YAML.load(File.read('config.yml'))
+  end
+
+  def self.path(env)
+    @path ||= config[:"#{env}"][:theme_id] ? "/admin/themes/#{config[:"#{env}"][:theme_id]}/assets.json" : "/admin/assets.json" 
+  end
+
+  def self.ignore_files(env)
+    files_array = config[:"#{env}"][:ignore_files] || config[:ignore_files] || []
+    @ignore_files ||= files_array.compact.collect { |r| Regexp.new(r) }
+  end
+
+  def self.is_binary_data?(string)
+    if string.respond_to?(:encoding)
+      string.encoding == "US-ASCII"
+    else
+      ( string.count( "^ -~", "^\r\n" ).fdiv(string.size) > 0.3 || string.index( "\x00" ) ) unless string.empty?
+    end
+  end
+
+  private
+  def self.shopify(env)
+    basic_auth config[:"#{env}"][:api_key], config[:"#{env}"][:password]
+    base_uri "http://#{config[:"#{env}"][:store]}"
+    ShopifyTheme
+  end
+end

data/lib/shopify_theme/cli.rb

@@ -0,0 +1,151 @@
+require 'thor'
+require 'yaml'
+YAML::ENGINE.yamler = 'syck'
+require 'abbrev'
+require 'base64'
+require 'fileutils'
+require 'json'
+require 'listen'
+
+module ShopifyTheme
+  class Cli < Thor
+    include Thor::Actions
+
+    BINARY_EXTENSIONS = %w(png gif jpg jpeg eot svg ttf woff swf)
+    IGNORE = %w(config.yml)
+
+    tasks.keys.abbrev.each do |shortcut, command|
+      map shortcut => command.to_sym
+    end
+
+    desc "configure API_KEY PASSWORD STORE THEME_ID", "generate a config file for the store to connect to"
+    def configure(api_key=nil, password=nil, store=nil, theme_id=nil, env='development')
+      config = {:"#{env}" => {:api_key => api_key, :password => password, :store => store, :theme_id => theme_id, :ignore_files => ["README"]}}
+      create_file('config.yml', config.to_yaml)
+    end
+
+    desc "download FILE", "download the shops current theme assets"
+    method_option :quiet, :type => :boolean, :default => false
+    method_option :env, :type => :string, :default => 'development'
+    def download(*keys)
+      assets = keys.empty? ? ShopifyTheme.asset_list(env) : keys
+
+      assets.each do |asset|
+        download_asset(asset, options['env'])
+        say("Downloaded: #{asset}", :green) unless options['quiet']
+      end
+      say("Done.", :green) unless options['quiet']
+    end
+
+    desc "upload FILE", "upload all theme assets to shop"
+    method_option :quiet, :type => :boolean, :default => false
+    method_option :env, :type => :string, :default => 'development'
+    def upload(*keys)
+      assets = keys.empty? ? local_assets_list(options['env']) : keys
+      assets.each do |asset|
+        send_asset(asset, options['quiet'], options['env'])
+      end
+      say("Done.", :green) unless options['quiet']
+    end
+
+    desc "replace FILE", "completely replace shop theme assets with local theme assets"
+    method_option :quiet, :type => :boolean, :default => false
+    method_option :env, :type => :string, :default => 'development'
+    def replace(*keys)
+      say("Are you sure you want to completely replace your shop theme assets? This is not undoable.", :yellow)
+      if ask("Continue? (Y/N): ") == "Y"
+        remote_assets = keys.empty? ? ShopifyTheme.asset_list(options['env']) : keys
+        remote_assets.each do |asset|
+          delete_asset(asset, options['quiet'], options['env'])
+        end
+        local_assets = keys.empty? ? local_assets_list(options['env']) : keys
+        local_assets.each do |asset|
+          send_asset(asset, options['quiet'], options['env'])
+        end
+        say("Done.", :green) unless options['quiet']
+      end
+    end
+
+    desc "remove FILE", "remove theme asset"
+    method_option :quiet, :type => :boolean, :default => false
+    method_option :env, :type => :string, :default => 'development'
+    def remove(*keys)
+      keys.each do |key|
+        delete_asset(key, options['quiet'], options['env'])
+      end
+      say("Done.", :green) unless options['quiet']
+    end
+
+    desc "watch", "upload and delete individual theme assets as they change, use the --keep_files flag to disable remote file deletion"
+    method_option :quiet, :type => :boolean, :default => false
+    method_option :keep_files, :type => :boolean, :default => false
+    method_option :env, :type => :string, :default => 'development'
+    def watch
+      puts "Watching current folder:"
+      Listen.to('',:relative_paths => true) do |modified, added, removed|
+        modified.each do |filePath|
+          send_asset(filePath, options['quiet'], options['env']) if local_assets_list(options['env']).include?(filePath)
+        end
+        added.each do |filePath|
+          send_asset(filePath, options['quiet'], options['env']) if local_assets_list(options['env']).include?(filePath)
+        end
+        if !options['keep_files']
+          removed.each do |filePath|
+            delete_asset(filePath, options['quiet'], options['env']) if local_assets_list(options['env']).include?(relative)
+          end
+        end
+      end
+    end
+
+    private
+
+    def local_assets_list(env)
+      Dir.glob(File.join("**", "*")).reject do |p|
+        File.directory?(p) || IGNORE.include?(p) || ShopifyTheme.ignore_files(env).any? do |i|
+          i =~ p
+        end
+      end
+    end
+
+    def download_asset(key, env)
+      asset = ShopifyTheme.get_asset(key, env)
+      if asset['value']
+        # For CRLF line endings
+        content = asset['value'].gsub("\r", "")
+      elsif asset['attachment']
+        content = Base64.decode64(asset['attachment'])
+      end
+
+      FileUtils.mkdir_p(File.dirname(key))
+      File.open(key, "w") {|f| f.write content} if content
+    end
+
+    def send_asset(asset, quiet=false, env)
+      data = {:key => asset}
+      content = File.read(asset)
+      if ShopifyTheme.is_binary_data?(content) || BINARY_EXTENSIONS.include?(File.extname(asset).gsub('.',''))
+        data.merge!(:attachment => Base64.encode64(content))
+      else
+        data.merge!(:value => content)
+      end
+
+      if (response = ShopifyTheme.send_asset(data, env)).success?
+        say("Uploaded: #{asset}", :green) unless quiet
+      else
+        say("Error: Could not upload #{asset}. #{errors_from_response(response)}", :red)
+      end
+    end
+
+    def delete_asset(key, quiet=false, env)
+      if (response = ShopifyTheme.delete_asset(key, env)).success?
+        say("Removed: #{key}", :green) unless quiet
+      else
+        say("Error: Could not remove #{key}. #{errors_from_response(response)}", :red)
+      end
+    end
+
+    def errors_from_response(response)
+      response.parsed_response["errors"] ? response.parsed_response["errors"].values.join(", ") : ""
+    end
+  end
+end

data/lib/shopify_theme/version.rb

@@ -0,0 +1,3 @@
+module ShopifyTheme
+  VERSION = "0.0.8"
+end

data/shopify_theme.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "shopify_theme/version"
+
+Gem::Specification.new do |s|
+  s.name        = "shopify_theme_multi_shop"
+  s.version     = ShopifyTheme::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Chris Hale", "John Duff"]
+  s.email       = ["design@chrishale.co.uk", "john.duff@shopify.com"]
+  s.homepage    = "https://github.com/chrishale/shopify_theme"
+  s.summary     = %q{Command line tool for deploying Shopify themes to multiple enviroments. Forked from github.com/shopify/shopify_theme}
+  s.description = %q{Command line tool to help with developing Shopify 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. github.com/shopify/shopify_theme with the ability to deploy to multitple shops.}
+
+  # s.rubyforge_project = "shopify_theme"
+  s.add_dependency("thor", [">= 0.14.4"])
+  s.add_dependency("httparty", [">= 0.8.0"])
+  s.add_dependency("json")
+  s.add_dependency("listen")
+
+  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

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: shopify_theme_multi_shop
+version: !ruby/object:Gem::Version
+  version: 0.0.8
+  prerelease: 
+platform: ruby
+authors:
+- Chris Hale
+- John Duff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-10 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70269633824960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.14.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *70269633824960
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70269633856940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70269633856940
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70269633856560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70269633856560
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: &70269633856100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70269633856100
+description: Command line tool to help with developing Shopify 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. github.com/shopify/shopify_theme
+  with the ability to deploy to multitple shops.
+email:
+- design@chrishale.co.uk
+- john.duff@shopify.com
+executables:
+- theme
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/theme
+- lib/shopify_theme.rb
+- lib/shopify_theme/cli.rb
+- lib/shopify_theme/version.rb
+- shopify_theme.gemspec
+homepage: https://github.com/chrishale/shopify_theme
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Command line tool for deploying Shopify themes to multiple enviroments. Forked
+  from github.com/shopify/shopify_theme
+test_files: []