Module: ShopifyTheme

Includes:
HTTParty
Defined in:
lib/shopify_theme.rb,
lib/shopify_theme/cli.rb,
lib/shopify_theme/version.rb,
lib/shopify_theme/releases.rb,
lib/shopify_theme/api_checker.rb,
lib/shopify_theme/file_filters.rb,
lib/shopify_theme/filters/blacklist.rb,
lib/shopify_theme/filters/whitelist.rb,
lib/shopify_theme/filters/command_input.rb

Defined Under Namespace

Modules: Filters Classes: APIChecker, Cli, FileFilters, Releases

Constant Summary collapse

REMOTE_CERT_FILE = 
'http://curl.haxx.se/ca/cacert.pem'
CA_CERT_FILE = 
File.expand_path(File.dirname(__FILE__) + '/certs/cacert.pem')
NOOPParser = 
Proc.new {|data, format| {} }
TIMER_RESET = 
10
PERMIT_LOWER_LIMIT = 
3
MAX_TIMBER_RETRY = 
5
EXTENSIONS = 
{mimetype: 'application/x-liquid', extensions: %w(liquid), parents: 'text/plain'},
{mimetype: 'application/json', extensions: %w(json), parents: 'text/plain'},
{mimetype: 'application/js', extensions: %w(map), parents: 'text/plain'},
{mimetype: 'application/vnd.ms-fontobject', extensions: %w(eot)},
{mimetype: 'image/svg+xml', extensions: %w(svg svgz)}
VERSION = 
"0.0.25"
FEED_URL = 
'https://github.com/Shopify/Timber/releases.atom'
ZIP_URL = 
'https://github.com/Shopify/Timber/archive/%s.zip'
@@current_api_call_count = 
0
@@total_api_calls = 
40

Class Method Summary collapse

Class Method Details

.api_usage ⇒ Object 



49
50
51
 
# File 'lib/shopify_theme.rb', line 49

def self.api_usage
  "[API Limit: #{@@current_api_call_count || "??"}/#{@@total_api_calls || "??"}]"
end

.asset_list ⇒ Object 



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/shopify_theme.rb', line 54

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 ⇒ Object 



138
139
140
 
# File 'lib/shopify_theme.rb', line 138

def self.check_config
  shopify.get(path).code == 200
end

.config ⇒ Object 



104
105
106
107
108
109
110
111
112
 
# File 'lib/shopify_theme.rb', line 104

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) ⇒ Object 



114
115
116
 
# File 'lib/shopify_theme.rb', line 114

def self.config=(config)
  @config = config
end

.configureMimeMagic ⇒ Object 



22
23
24
25
26
 
# File 'lib/shopify_theme/cli.rb', line 22

def self.configureMimeMagic
  ShopifyTheme::EXTENSIONS.each do |extension|
    MimeMagic.add(extension.delete(:mimetype), extension)
  end
end

.critical_permits? ⇒ Boolean

Returns:

  • (Boolean) 


26
27
28
 
# File 'lib/shopify_theme.rb', line 26

def self.critical_permits?
  @@total_api_calls.to_i - @@current_api_call_count.to_i < PERMIT_LOWER_LIMIT
end

.delete_asset(asset) ⇒ Object 



81
82
83
84
85
 
# File 'lib/shopify_theme.rb', line 81

def self.delete_asset(asset)
  response = shopify.delete(path, :body =>{:asset => {:key => asset}})
  manage_timer(response)
  response
end

.delta_seconds ⇒ Object 



34
35
36
 
# File 'lib/shopify_theme.rb', line 34

def self.delta_seconds
  Time.now.to_i - @@current_timer.to_i
end

.get_asset(asset) ⇒ Object 



65
66
67
68
69
70
71
72
73
 
# File 'lib/shopify_theme.rb', line 65

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

.get_index ⇒ Object 



142
143
144
 
# File 'lib/shopify_theme.rb', line 142

def self.get_index
  shopify.get(path)
end

.ignore_files ⇒ Object 



122
123
124
 
# File 'lib/shopify_theme.rb', line 122

def self.ignore_files
  (config[:ignore_files] || []).compact
end

.is_binary_data?(string) ⇒ Boolean

Returns:

  • (Boolean) 


130
131
132
133
134
135
136
 
# File 'lib/shopify_theme.rb', line 130

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) ⇒ Object 



20
21
22
23
24
 
# File 'lib/shopify_theme.rb', line 20

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? ⇒ Boolean

Returns:

  • (Boolean) 


38
39
40
 
# File 'lib/shopify_theme.rb', line 38

def self.needs_sleep?
  critical_permits? && !passed_api_refresh?
end

.passed_api_refresh? ⇒ Boolean

Returns:

  • (Boolean) 


30
31
32
 
# File 'lib/shopify_theme.rb', line 30

def self.passed_api_refresh?
  delta_seconds > TIMER_RESET
end

.path ⇒ Object 



118
119
120
 
# File 'lib/shopify_theme.rb', line 118

def self.path
  @path ||= config[:theme_id] ? "/admin/themes/#{config[:theme_id]}/assets.json" : "/admin/assets.json"
end

.send_asset(data) ⇒ Object 



75
76
77
78
79
 
# File 'lib/shopify_theme.rb', line 75

def self.send_asset(data)
  response = shopify.put(path, :body =>{:asset => data})
  manage_timer(response)
  response
end

.sleep ⇒ Object 



42
43
44
45
46
47
 
# File 'lib/shopify_theme.rb', line 42

def self.sleep
  if needs_sleep?
    Kernel.sleep(TIMER_RESET - delta_seconds)
    @current_timer = nil
  end
end

.test? ⇒ Boolean

Returns:

  • (Boolean) 


16
17
18
 
# File 'lib/shopify_theme.rb', line 16

def self.test?
  ENV['test']
end

.upload_timber(name, version, retries = 0) ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/shopify_theme.rb', line 87

def self.upload_timber(name, version, retries=0)
  release = Releases.new.find(version)
  response = shopify.post("/admin/themes.json", :body => {:theme => {:name => name, :src => release.zip_url, :role => 'unpublished'}})
  manage_timer(response)
  body = JSON.parse(response.body)
  if theme = body['theme']
    puts "Successfully created #{name} using Shopify Timber #{version}"
    watch_until_processing_complete(theme)
  elsif retries < MAX_TIMBER_RETRY
    upload_timber(name, version, retries + 1)
  else
    puts "Could not download theme!"
    puts body
    exit 1
  end
end

.whitelist_files ⇒ Object 



126
127
128
 
# File 'lib/shopify_theme.rb', line 126

def self.whitelist_files
  (config[:whitelist_files] || []).compact
end