module ShopifyTheme

Constants

EXTENSIONS
LAST_KNOWN_STABLE
NOOPParser
PERMIT_LOWER_LIMIT
TIMBER_ZIP
TIMER_RESET
VERSION

Public Class Methods

api_usage() click to toggle source
# File lib/shopify_theme.rb, line 46
def self.api_usage
  "[API Limit: #{@@current_api_call_count || "??"}/#{@@total_api_calls || "??"}]"
end
asset_list() click to toggle source
# File lib/shopify_theme.rb, line 51
def self.asset_list
  # HTTParty parser chokes on assest listing, have it noop
  # and then use a rel JSON parser.
  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
check_config() click to toggle source
# File lib/shopify_theme.rb, line 132
def self.check_config
  shopify.get(path).code == 200
end
config() click to toggle source
# File lib/shopify_theme.rb, line 98
def self.config
  @config ||= if File.exist? 'config.yml'
    config = YAML.load(File.read('config.yml'))
    config
  else
    puts "config.yml does not exist!" unless test?
    {}
  end
end
config=(config) click to toggle source
# File lib/shopify_theme.rb, line 108
def self.config=(config)
  @config = config
end
configureMimeMagic() click to toggle source
# File lib/shopify_theme/cli.rb, line 21
def self.configureMimeMagic
  ShopifyTheme::EXTENSIONS.each do |extension|
    MimeMagic.add(extension.delete(:mimetype), extension)
  end
end
critical_permits?() click to toggle source
# File lib/shopify_theme.rb, line 23
def self.critical_permits?
  @@total_api_calls.to_i - @@current_api_call_count.to_i < PERMIT_LOWER_LIMIT
end
delete_asset(asset) click to toggle source
# File lib/shopify_theme.rb, line 77
def self.delete_asset(asset)
  response = shopify.delete(path, :body =>{:asset => {:key => asset}})
  manage_timer(response)
  response
end
delta_seconds() click to toggle source
# File lib/shopify_theme.rb, line 31
def self.delta_seconds
  Time.now.to_i - @@current_timer.to_i
end
get_asset(asset) click to toggle source
# File lib/shopify_theme.rb, line 61
def self.get_asset(asset)
  response = shopify.get(path, :query =>{:asset => {:key => asset}}, :parser => NOOPParser)
  manage_timer(response)

  # HTTParty json parsing is broken?
  asset = response.code == 200 ? JSON.parse(response.body)["asset"] : {}
  asset['response'] = response
  asset
end
ignore_files() click to toggle source
# File lib/shopify_theme.rb, line 116
def self.ignore_files
  (config[:ignore_files] || []).compact.map { |r| Regexp.new(r) }
end
is_binary_data?(string) click to toggle source
# File lib/shopify_theme.rb, line 124
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
manage_timer(response) click to toggle source
# File lib/shopify_theme.rb, line 17
def self.manage_timer(response)
  return unless response.headers['x-shopify-shop-api-call-limit']
  @@current_api_call_count, @@total_api_calls = response.headers['x-shopify-shop-api-call-limit'].split('/')
  @@current_timer = Time.now if @current_timer.nil?
end
needs_sleep?() click to toggle source
# File lib/shopify_theme.rb, line 35
def self.needs_sleep?
  critical_permits? && !passed_api_refresh?
end
passed_api_refresh?() click to toggle source
# File lib/shopify_theme.rb, line 27
def self.passed_api_refresh?
  delta_seconds > TIMER_RESET
end
path() click to toggle source
# File lib/shopify_theme.rb, line 112
def self.path
  @path ||= config[:theme_id] ? "/admin/themes/#{config[:theme_id]}/assets.json" : "/admin/assets.json"
end
send_asset(data) click to toggle source
# File lib/shopify_theme.rb, line 71
def self.send_asset(data)
  response = shopify.put(path, :body =>{:asset => data})
  manage_timer(response)
  response
end
sleep() click to toggle source
# File lib/shopify_theme.rb, line 39
def self.sleep
  if needs_sleep?
    Kernel.sleep(TIMER_RESET - delta_seconds)
    @current_timer = nil
  end
end
test?() click to toggle source
# File lib/shopify_theme.rb, line 13
def self.test?
  ENV['test']
end
upload_timber(name, master) click to toggle source
# File lib/shopify_theme.rb, line 83
def self.upload_timber(name, master)
  source = TIMBER_ZIP % (master ? 'master' : LAST_KNOWN_STABLE)
  puts master ? "Using latest build from shopify" : "Using last known stable build -- #{LAST_KNOWN_STABLE}"
  response = shopify.post("/admin/themes.json", :body => {:theme => {:name => name, :src => source, :role => 'unpublished'}})
  manage_timer(response)
  body = JSON.parse(response.body)
  if theme = body['theme']
    watch_until_processing_complete(theme)
  else
    puts "Could not download theme!"
    puts body
    exit 1
  end
end
whitelist_files() click to toggle source
# File lib/shopify_theme.rb, line 120
def self.whitelist_files
  (config[:whitelist_files] || []).compact
end

Private Class Methods

shopify() click to toggle source
# File lib/shopify_theme.rb, line 137
def self.shopify
  basic_auth config[:api_key], config[:password]
  # TODO: switch back to https
  # base_uri "https://#{config[:store]}"
  base_uri "http://#{config[:store]}"
  ShopifyTheme
end
watch_until_processing_complete(theme) click to toggle source
# File lib/shopify_theme.rb, line 145
def self.watch_until_processing_complete(theme)
  count = 0
  while true do
    Kernel.sleep(count)
    response = shopify.get("/admin/themes/#{theme['id']}.json")
    theme = JSON.parse(response.body)['theme']
    return theme if theme['previewable']
    count += 5
  end
end