Module: ShopifyTheme

Includes:
HTTParty
Defined in:
lib/shopify_theme.rb,
lib/shopify_theme/cli.rb,
lib/shopify_theme/version.rb

Defined Under Namespace

Classes: Cli

Constant Summary collapse

NOOPParser = 
Proc.new {|data, format| {} }
TIMER_RESET = 
5 * 60 + 5
PERMIT_LOWER_LIMIT = 
10
VERSION = 
"0.0.13"

Class Method Summary collapse

Class Method Details

.asset_list ⇒ Object 



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

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 



106
107
108
 
# File 'lib/shopify_theme.rb', line 106

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

.config ⇒ Object 



75
76
77
78
79
80
81
82
83
84
 
# File 'lib/shopify_theme.rb', line 75

def self.config
  @config ||= if File.exist? 'config.yml'
    config = YAML.load(File.read('config.yml'))
    puts ":ignore_files: is deprecated for a white list, use :whitelist_files: instead" if config[:ignore_files] && !test?
    config
  else
    puts "config.yml does not exist!" unless test?
    {}
  end
end

.critical_permits? ⇒ Boolean

Returns:

  • (Boolean) 


18
19
20
 
# File 'lib/shopify_theme.rb', line 18

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

.delete_asset(asset) ⇒ Object 



69
70
71
72
73
 
# File 'lib/shopify_theme.rb', line 69

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

.delta_seconds ⇒ Object 



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

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

.get_asset(asset) ⇒ Object 



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

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



90
91
92
 
# File 'lib/shopify_theme.rb', line 90

def self.ignore_files
  @ignore_files ||= (config[:ignore_files] || []).compact.map { |r| Regexp.new(r) }
end

.is_binary_data?(string) ⇒ Boolean

Returns:

  • (Boolean) 


98
99
100
101
102
103
104
 
# File 'lib/shopify_theme.rb', line 98

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 



13
14
15
16
 
# File 'lib/shopify_theme.rb', line 13

def self.manage_timer(response)
  @@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) 


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

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

.passed_api_refresh? ⇒ Boolean

Returns:

  • (Boolean) 


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

def self.passed_api_refresh?
  delta_seconds > TIMER_RESET
end

.path ⇒ Object 



86
87
88
 
# File 'lib/shopify_theme.rb', line 86

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

.send_asset(data) ⇒ Object 



63
64
65
66
67
 
# File 'lib/shopify_theme.rb', line 63

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

.sleep ⇒ Object 



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

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

.test? ⇒ Boolean

Returns:

  • (Boolean) 


9
10
11
 
# File 'lib/shopify_theme.rb', line 9

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

.whitelist_files ⇒ Object 



94
95
96
 
# File 'lib/shopify_theme.rb', line 94

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