quickdraw 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a8bd5091dd77c46a587472cf5655c812767927b
-  data.tar.gz: 85f9157dc564dd8144bcde74136b4745556baa85
+  metadata.gz: df5b795af0421fe99f0dff6b95e98c966c50f902
+  data.tar.gz: bcb1b8d1b9f20693f925fcad431dbade546606ce
 SHA512:
-  metadata.gz: 8e558f6021374c82ed89b8531a5ffa8d4dc05e28f9867570435939040df3b5bd1e83848c3ec06f66fb9f72087097ebc5b232073a2f9ea2573efd2d5b2657b581
-  data.tar.gz: 609f01b571d75d0c81aaad16536ba9c0079c4be175dddf21f081a249fbb7f391c265595b61550dae3928fb4e44002c19903063096c9a0e66979520c873f7103b
+  metadata.gz: ddec59e718913624a38977ba8a1320de0c3931438f83d22c61e8697cb1f772aa9d2103b1f92efba15732ffd833d8e2317160c4de002c1ac4c7330d9b2bd6feb9
+  data.tar.gz: c1f685f5aa1c0630fad2c5637cb29c077f4050f496f1b64096d063899b46f0947f63b78b77e4e2e73501e016ca7ac427f70eae2c311dea922700e5a1c1a2ef47

data/README.md

@@ -4,7 +4,7 @@ The idea for Quickdraw comes from the 'shopify_theme' gem. I use a lot of code f
 
 ### Features
 
-- MUCH faster downloads and uploads. Quickdraw can download your files as much as 10x faster or more!
+- MUCH faster downloads and uploads. Unfortunately, Shopify API call limits will slow you down. But in short bursts (10-20 files), Quickdraw is as much as 10x faster or more!
 
 ## Installation
 

data/lib/quickdraw/cli.rb

@@ -8,6 +8,8 @@ require 'thor'
 require 'listen'
 #require 'launchy'
 require 'benchmark'
+require 'pathname'
+require 'filepath'
 
 module Quickdraw
 	class Cli < Thor
@@ -18,74 +20,213 @@ module Quickdraw
 		DEFAULT_WHITELIST = %w(layout/ assets/ config/ snippets/ templates/)
 		TIMEFORMAT = "%H:%M:%S"
 
-		desc "download FILE", "download the shops current theme assets"
-		#method_option :quiet, :type => :boolean, :default => false
-		def download(filter)
+		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)
+			config = {:api_key => api_key, :password => password, :store => store, :theme_id => theme_id}
+			create_file('config.yml', config.to_yaml)
+		end
 
-			asset_list = Celluloid::Actor[:shopify_connector].get_asset_list
+		desc "upload FILES", "upload all theme assets to shop"
+		def upload(filter=nil)
 
-			if filter.empty?
-				assets = asset_list
+			if filter
+				assets = (FilePath.getwd / 'theme').files(true).select{ |i|
+					i.relative_to(Quickdraw.theme_dir).to_s[/^#{filter.gsub(/[^a-z0-9A-Z\/]/, '')}/]
+				}
 			else
-				assets = asset_list.select{ |i| i[/^#{filter}/] }
+				assets = (FilePath.getwd / 'theme').files(true)
 			end
 
 			futures = []
+			assets.each do |asset|
+				futures << Celluloid::Actor[:shopify_connector].future.upload_asset(asset)
+			end
+			futures.each do |future|
+				asset, response = future.value
+				if response.success?
+					say("Uploaded: #{asset.relative_to(Quickdraw.getwd)}", :green)
+				else
+					say("[" + Time.now.strftime(TIMEFORMAT) + "] Error: Could not upload #{asset.relative_to(Quickdraw.getwd)}. #{errors_from_response(response)}\n", :red)
+				end
+			end
 
+			say("Done.", :green)
+		end
+
+		desc "download FILES", "download the shops current theme assets"
+		def download(filter=nil)
+			asset_list = Celluloid::Actor[:shopify_connector].get_asset_list
+
+			if filter
+				assets = asset_list.select{ |i| i[/^#{filter.gsub(/[^a-z0-9A-Z\/]/, '')}/] }.map{|a| FilePath.getwd / 'theme' / a }
+			else
+				assets = asset_list.map{|a| FilePath.getwd / 'theme' / a }
+			end
+
+			futures = []
 			assets.each do |asset|
 				futures << Celluloid::Actor[:shopify_connector].future.download_asset(asset)
 			end
-
 			futures.each do |future|
-				say("Downloaded: #{future.value}", :green)
+				asset, response = future.value
+				if response.success?
+					say("Downloaded: #{asset.relative_to(Quickdraw.getwd)}", :green)
+				else
+					say("[" + Time.now.strftime(TIMEFORMAT) + "] Error: Could not download #{asset.relative_to(Quickdraw.getwd)}. #{errors_from_response(response)}\n", :red)
+				end
 			end
+			say("Done.", :green)
+		end
+
+		desc "replace FILES", "completely replace shop theme assets with local theme assets"
+		def replace(filter=nil)
+			say("Are you sure you want to completely replace your shop theme assets? This is not undoable.", :yellow)
+			if ask("Continue? (y/n): ") == "y"
+				# only delete files on remote that are not present locally
+				# files present on remote and present locally get overridden anyway
+				asset_list = Celluloid::Actor[:shopify_connector].get_asset_list
+
+				if filter
+					remote_assets = asset_list.select{ |i| i[/^#{filter.gsub(/[^a-z0-9A-Z\/]/, '')}/] }.map{|a| (FilePath.getwd / 'theme' / a) }
+				else
+					remote_assets = asset_list.map{|a| (FilePath.getwd / 'theme' / a) }
+				end
+
+				if filter
+					local_assets = (FilePath.getwd / 'theme').files(true).select{ |i| i.relative_to(Quickdraw.theme_dir).to_s[/^#{filter.gsub(/[^a-z0-9A-Z\/]/, '')}/] }
+				else
+					local_assets = (FilePath.getwd / 'theme').files(true)
+				end
 
+				remote_only_assets = remote_assets.to_a.map{|p| p.to_s} - local_assets.to_a.map{|p| p.to_s}
+
+				futures = []
+				remote_only_assets.each do |asset|
+					futures << Celluloid::Actor[:shopify_connector].future.remove_asset(asset.as_path)
+				end
+				local_assets.each do |asset|
+					futures << Celluloid::Actor[:shopify_connector].future.upload_asset(asset)
+				end
+				futures.each do |future|
+					asset, response = future.value
+					if response.success?
+						if response.request.http_method.to_s == "Net::HTTP::Put"
+							say("Uploaded: #{asset.relative_to(Quickdraw.getwd)}", :green)
+						else
+							say("Removed: #{asset.relative_to(Quickdraw.getwd)}", :green)
+						end
+					else
+						say("[" + Time.now.strftime(TIMEFORMAT) + "] Error: Could not download #{asset.relative_to(Quickdraw.getwd)}. #{errors_from_response(response)}\n", :red)
+					end
+				end
+				say("Done.", :green) unless options['quiet']
+			end
+		end
+
+		desc "remove FILES", "remove theme asset"
+		def remove(filter=nil)
+			asset_list = Celluloid::Actor[:shopify_connector].get_asset_list
+
+			if filter
+				assets = asset_list.select{ |i| i[/^#{filter.gsub(/[^a-z0-9A-Z\/]/, '')}/] }.map{|a| FilePath.getwd / 'theme' / a }
+			else
+				assets = asset_list.map{|a| FilePath.getwd / 'theme' / a }
+			end
+
+			futures = []
+			assets.each do |asset|
+				futures << Celluloid::Actor[:shopify_connector].future.remove_asset(asset)
+			end
+			futures.each do |future|
+				asset, response = future.value
+				if response.success?
+					say("Deleted: #{asset.relative_to(Quickdraw.getwd)}", :green)
+				else
+					say("[" + Time.now.strftime(TIMEFORMAT) + "] Error: Could not remove #{asset.relative_to(Quickdraw.getwd)}. #{errors_from_response(response)}\n", :red)
+				end
+			end
 			say("Done.", :green) unless options['quiet']
 		end
 
-		desc "watch", "compile then 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
+		desc "watch", "compile then upload or delete individual theme assets as they change."
 		def watch
 			puts "Watching current folder: #{Dir.pwd}"
-			listener = Listen.to(@path + '/src', :force_polling => true) do |modified, added, removed|
-				modified.each do |filePath|
-					filePath.slice!(Dir.pwd + "/")
-					send_asset(filePath, options['quiet']) if local_assets_list.include?(filePath)
+
+			futures = []
+
+			listener = Listen.to((Quickdraw.getwd/'theme').to_s, (Quickdraw.getwd/'src').to_s, :force_polling => true, :latency => 0.2 ) do |modified, added, removed|
+				modified.each do |asset|
+					asset = asset.as_path
+					say("MODIFIED: #{asset.relative_to(Quickdraw.getwd)}", :green)
+					if theme_file?(asset)
+						futures << Celluloid::Actor[:shopify_connector].future.upload_asset(asset)
+					elsif src_file?(asset)
+						futures << Celluloid::Actor[:shopify_connector].future.compile_asset(asset)
+					end
 				end
-				added.each do |filePath|
-					filePath.slice!(Dir.pwd + "/")
-					send_asset(filePath, options['quiet']) if local_assets_list.include?(filePath)
+				added.each do |asset|
+					asset = asset.as_path
+					say("ADDED: #{asset}", :green)
+					if theme_file?(asset)
+						futures << Celluloid::Actor[:shopify_connector].future.upload_asset(asset)
+					else
+					end
 				end
-				unless options['keep_files']
-					removed.each do |filePath|
-						filePath.slice!(Dir.pwd + "/")
-						delete_asset(filePath, options['quiet']) if !local_assets_list.include?(filePath)
+				removed.each do |asset|
+					asset = asset.as_path
+					say("REMOVED: #{asset}", :green)
+					if theme_file?(asset)
+						futures << Celluloid::Actor[:shopify_connector].future.remove_asset(asset)
+					else
 					end
 				end
 			end
 			listener.start
-			sleep
+
+			loop do
+
+				futures.each do |future|
+					asset, response = future.value
+					if response
+						unless response.success?
+							say("[" + Time.now.strftime(TIMEFORMAT) + "] Error: #{asset.relative_to(Quickdraw.getwd)} Failed", :red)
+						end
+					else
+						say("Compiled: #{asset.relative_to(Quickdraw.getwd)}")
+					end
+					futures.delete(future)
+				end
+
+				sleep 0.2
+			end
+
 		rescue
 			puts "exiting...."
 		end
 
 		private
 
-		def download_asset(key)
-			#notify_and_sleep("Approaching limit of API permits. Naptime until more permits become available!") if ShopifyTheme.needs_sleep?
-			asset = ShopifyTheme.get_asset(key)
-			if asset['value']
-				# For CRLF line endings
-				content = asset['value'].gsub("\r", "")
-				format = "w"
-			elsif asset['attachment']
-				content = Base64.decode64(asset['attachment'])
-				format = "w+b"
+		def errors_from_response(response)
+			return unless response.parsed_response
+
+			errors = response.parsed_response["errors"]
+
+			case errors
+				when NilClass
+					''
+				when String
+					errors
+				else
+					errors.values.join(", ")
 			end
+		end
+
+		def theme_file?(asset)
+			asset.as_path.relative_to(Quickdraw.getwd).to_s[/^theme\//]
+		end
 
-			FileUtils.mkdir_p(File.dirname(key))
-			File.open(key, format) {|f| f.write content} if content
+		def src_file?(asset)
+			asset.as_path.relative_to(Quickdraw.getwd).to_s[/^src\//]
 		end
 
 	end

data/lib/quickdraw/shopify_connector.rb

@@ -2,29 +2,26 @@
 require 'httparty'
 require 'celluloid'
 require 'pathname'
+require 'filepath'
 
 module Quickdraw
 	class ShopifyConnector
 		include Celluloid
 
 		NOOPParser = Proc.new {|data, format| {} }
+		BINARY_EXTENSIONS = %w(png gif jpg jpeg eot svg ttf woff otf swf ico)
+		IGNORE = %w(config.yml)
+		DEFAULT_WHITELIST = %w(layout/ assets/ config/ snippets/ templates/)
+		TIMEFORMAT = "%H:%M:%S"
 
 		def initialize
 			@config = Quickdraw.config
-			@auth = {:username => @config[:username], :password => @config[:password]}
-		end
-
-		def get(path, options={})
-			options.merge!({:basic_auth => @auth})
-
-			response = Celluloid::Actor[:shopify_connector_pool].get(path, options)
-
-			return response
+			@auth = {:username => @config[:api_key], :password => @config[:password]}
 		end
 
 		def get_asset_list(options={})
 			options.merge!({:parser => NOOPParser})
-			response = get("https://#{@config[:store]}/admin/themes/#{@config[:theme_id]}/assets.json", options)
+			response = Celluloid::Actor[:shopify_connector_pool].request(:get, "https://#{@config[:store]}/admin/themes/#{@config[:theme_id]}/assets.json", options)
 
 			if JSON.parse(response.body)["assets"]
 				return JSON.parse(response.body)["assets"].collect {|a| a['key'] }
@@ -33,31 +30,75 @@ module Quickdraw
 			return nil
 		end
 
-		def download_asset(assetpath, options={})
-			options.merge!({:query => {:asset => {:key => assetpath}}, :parser => NOOPParser})
+		def upload_asset(asset)
+			time = Time.now
+			data = {:key => asset.relative_to(Quickdraw.theme_dir).to_s}
+
+			content = File.read(asset)
+			if BINARY_EXTENSIONS.include?(File.extname(asset).gsub('.','')) || is_binary_data?(content)
+				content = File.open(asset, "rb") { |io| io.read }
+				data.merge!(:attachment => Base64.encode64(content))
+			else
+				data.merge!(:value => content)
+			end
+
+			data = {:body => {:asset => data}}
+
+			response = Celluloid::Actor[:shopify_connector_pool].request(:put, "https://#{@config[:store]}/admin/themes/#{@config[:theme_id]}/assets.json", data)
+
+			return [asset, response]
+		end
+
+		def download_asset(asset, options={})
+			options.merge!({:query => {:asset => {:key => asset.relative_to(Quickdraw.theme_dir).to_s}}, :parser => NOOPParser})
 
-			response = get("https://#{@config[:store]}/admin/themes/#{@config[:theme_id]}/assets.json", options)
+			response = Celluloid::Actor[:shopify_connector_pool].request(:get, "https://#{@config[:store]}/admin/themes/#{@config[:theme_id]}/assets.json", options)
 
 			# HTTParty json parsing is broken?
-			asset = response.code == 200 ? JSON.parse(response.body)["asset"] : {}
-			asset['response'] = response
+			data = response.code == 200 ? JSON.parse(response.body)["asset"] : {}
+			data['response'] = response
 
-			if asset['value']
+			if data['value']
 				# For CRLF line endings
-				content = asset['value'].gsub("\r", "")
+				content = data['value'].gsub("\r", "")
 				format = "w"
-			elsif asset['attachment']
-				content = Base64.decode64(asset['attachment'])
+			elsif data['attachment']
+				content = Base64.decode64(data['attachment'])
 				format = "w+b"
 			end
 
-			save_path = "theme/"+assetpath
+			FileUtils.mkdir_p(File.dirname(asset))
+			File.open(asset, format) {|f| f.write content} if content
 
-			FileUtils.mkdir_p(File.dirname(save_path))
-			File.open(save_path, format) {|f| f.write content} if content
+			return [asset, response]
+		end
+
+		def remove_asset(asset, options={})
+			options.merge!({:body => {:asset => {:key => asset.relative_to(Quickdraw.theme_dir).to_s}}})
+
+			response = Celluloid::Actor[:shopify_connector_pool].request(:delete, "https://#{@config[:store]}/admin/themes/#{@config[:theme_id]}/assets.json", options)
 
-			return assetpath
+			return [asset, response]
+		end
+
+		def 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
+
+		def compile_asset(asset)
+			if File.exists?(asset.to_s)
+				target_asset = "theme/#{asset.relative_to(Quickdraw.src_dir).to_s.gsub('.erb', '')}"
+				template = ERB.new(File.read(asset))
+				File.write("#{target_asset}", template.result)
+			end
+
+			return [asset, nil]
+		end
+
 	end
 
 	ShopifyConnector.supervise_as(:shopify_connector)

data/lib/quickdraw/shopify_connector_pool.rb

@@ -1,18 +1,25 @@
 
 require 'httparty'
 require 'celluloid'
+require 'filepath'
 
 module Quickdraw
 	class ShopifyConnectorPool
 		include HTTParty
 		include Celluloid
 
-		def get(path, options = {})
+		def initialize
+			@config = Quickdraw.config
+			@auth = {:username => @config[:api_key], :password => @config[:password]}
+		end
+
+		def request(call_type, path, options)
+			options.merge!({:basic_auth => @auth})
 
 			begin
 				tries ||= 3
 
-				response = HTTParty.get(path, options)
+				response = HTTParty.send(call_type, path, options)
 
 				if response.code == 429
 					tries += 1
@@ -20,14 +27,22 @@ module Quickdraw
 					raise "Slow down!"
 				end
 
+				if response.code == 403
+					tries == 0
+					raise "Forbidden"
+				end
+
 				if response.code != 200
 					puts response.inspect
 					raise "Request Failed"
 				end
 
 			rescue => e
-				sleep 1
-				retry unless (tries -= 1).zero?
+				tries -= 1
+				if tries > 0
+					sleep 1
+					retry
+				end
 			end
 
 			return response
@@ -35,5 +50,5 @@ module Quickdraw
 
 	end
 
-	Celluloid::Actor[:shopify_connector_pool] = ShopifyConnectorPool.pool(:size => 16)
+	Celluloid::Actor[:shopify_connector_pool] = ShopifyConnectorPool.pool(:size => 24)
 end

data/lib/quickdraw/version.rb

@@ -1,3 +1,3 @@
 module Quickdraw
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/quickdraw.rb

@@ -1,4 +1,6 @@
 require "quickdraw/version"
+require 'pathname'
+require 'filepath'
 
 module Quickdraw
 
@@ -6,18 +8,6 @@ module Quickdraw
 	TIMER_RESET = 5 * 60 + 5
 	PERMIT_LOWER_LIMIT = 10
 
-	def self.asset_list
-		# HTTParty parser chokes on assest listing, have it noop
-		# and then use a rel JSON parser.
-		response = Celluloid::Actor[:shopify_connector]
-		response = shopify.get(path, :parser => NOOPParser)
-		#manage_timer(response)
-
-		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.config
 		@config ||= if File.exist? 'config.yml'
 			            config = YAML.load(File.read('config.yml'))
@@ -28,38 +18,16 @@ module Quickdraw
 			          end
 	end
 
-	def self.get()
-		puts "Waiting: #{@sleeptime}"
-		sleep @sleeptime
-
-		options.merge!({:basic_auth => @auth})
-		HTTParty.get(path, options)
-
-		begin
-			tries ||= 3
-			response = HTTParty.get(path, options)
-
-			puts response.inspect
-
-			if response.code != 200
-				raise "Request Failed"
-			end
-
-			@api_call_count, @total_api_calls = response.headers['x-shopify-shop-api-call-limit'].split('/')
-			@sleeptime = (5 / (@total_api_calls.to_f / @api_call_count.to_f))
-
-			puts "STATUS: #{@sleeptime} - #{@api_call_count} - #{@total_api_calls}"
-
-		rescue => e
-			puts e.inspect
-			puts "Failed: will retry #{tries} time(s)"
-			sleep 1
-			retry unless (tries -= 1).zero?
-		end
-
-		return response
+	def self.getwd
+		FilePath.getwd
+	end
 
+	def self.theme_dir
+		FilePath.getwd / 'theme'
 	end
 
+	def self.src_dir
+		FilePath.getwd / 'src'
+	end
 
 end

data/quickdraw.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "listen"
   spec.add_runtime_dependency "celluloid"
   spec.add_runtime_dependency "httparty"
+  spec.add_runtime_dependency "filepath"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quickdraw
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Bryan Morris
@@ -94,6 +94,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: filepath
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Quickly develop Shopify themes
 email:
 - bryan@internalfx.com
@@ -109,7 +123,6 @@ files:
 - README.md
 - Rakefile
 - bin/quickdraw
-- lib/auto_compile.rb
 - lib/quickdraw.rb
 - lib/quickdraw/cli.rb
 - lib/quickdraw/shopify_connector.rb

data/lib/auto_compile.rb

@@ -1,53 +0,0 @@
-require 'erb'
-require 'listen'
-require 'pathname'
-
-
-class Namespace
-	def initialize(hash={})
-		hash.each do |key, value|
-			singleton_class.send(:define_method, key) { value }
-		end
-	end
-
-	def get_binding
-		binding
-	end
-end
-
-@ns = Namespace.new()
-@path = Dir.pwd
-@watched_files = Pathname.glob("#{@path}/**/*.erb")
-
-def compile_file(filepath)
-	if File.exists?(filepath)
-		pathname = Pathname.new(filepath)
-		relapath = pathname.relative_path_from(Pathname.pwd)
-		targetpath = relapath.to_s.gsub(/^src/, 'theme').gsub('.erb', '')
-		template = ERB.new(File.read(filepath))
-		File.write("#{targetpath}", template.result(@ns.get_binding))
-	end
-end
-
-#Compile all files on startup
-puts "Compiling Files..."
-@watched_files.each do |filepath|
-	compile_file(filepath)
-end
-
-puts "Watching for changes..."
-listener = Listen.to(@path + '/src', :force_polling => true) do |modified, added, removed|
-	modified.each do |filepath|
-		puts "MODIFIED: #{filepath}"
-		compile_file(filepath)
-	end
-	added.each do |filepath|
-		puts "ADDED: #{filepath}"
-		compile_file(filepath)
-	end
-	removed.each do |filepath|
-		puts "REMOVED: #{filepath}"
-	end
-end
-listener.start
-sleep