Class: ShopifyAPI::Asset

Inherits:
Base
  • Object
show all
Includes:
DisablePrefixCheck
Defined in:
lib/shopify_api/resources/asset.rb

Overview

Assets represent the files that comprise your theme. There are different buckets which hold different kinds of assets, each corresponding to one of the folders within a theme's zip file: “layout”, “templates”, “snippets”, “assets”, and “config”. The full key of an asset always starts with the bucket name, and the path separator is a forward slash, like layout/theme.liquid or assets/bg-body.gif.

Initialize with a key:

asset = ShopifyAPI::Asset.new(key: 'assets/special.css', theme_id: 12345)

Find by key:

asset = ShopifyAPI::Asset.find('assets/image.png', params: {theme_id: 12345})

Get the text or binary value:

asset.value # decodes from attachment attribute if necessary

You can provide new data for assets in a few different ways:

* assign text data for the value directly:
    asset.value = "div.special {color:red;}"

* provide binary data for the value:
    asset.attach(File.read('image.png'))

* set a URL from which Shopify will fetch the value:
    asset.src = "http://mysite.com/image.png"

* set a source key of another of your assets from which
  the value will be copied:
    asset.source_key = "assets/another_image.png"

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

activate_session, api_version, api_version=, #as_json, clear_session, early_july_pagination?, #encode, headers, init_prefix, init_prefix_explicit, #persisted?, prefix, prefix=, prefix_source, resource_prefix, resource_prefix=, version_validation!

Methods included from Countable

#count

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method_symbol, *arguments) ⇒ Object

:nodoc:


85
86
87
88
89
90
 
# File 'lib/shopify_api/resources/asset.rb', line 85

def method_missing(method_symbol, *arguments) #:nodoc:
  if %w{value= attachment= src= source_key=}.include?(method_symbol)
    wipe_value_attributes
  end
  super
end

Class Method Details

.element_path(_id, prefix_options = {}, query_options = nil) ⇒ Object

:nodoc:


41
42
43
44
 
# File 'lib/shopify_api/resources/asset.rb', line 41

def self.element_path(_id, prefix_options = {}, query_options = nil) #:nodoc:
  prefix_options, query_options = split_options(prefix_options) if query_options.nil?
  "#{prefix(prefix_options)}#{collection_name}.#{format.extension}#{query_string(query_options)}"
end

.find(*args) ⇒ Object

find an asset by key:

ShopifyAPI::Asset.find('layout/theme.liquid', params: { theme_id: 99 })


48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/shopify_api/resources/asset.rb', line 48

def self.find(*args)
  if args[0].is_a?(Symbol)
    super
  else
    params = { asset: { key: args[0] } }
    params = params.merge(args[1][:params]) if args[1] && args[1][:params]
    path_prefix = params[:theme_id] ? "themes/#{params[:theme_id]}/" : ""
    resource = find(
      :one,
      from: api_version.construct_api_path("#{path_prefix}assets.#{format.extension}"),
      params: params
    )
    resource.prefix_options[:theme_id] = params[:theme_id] if resource && params[:theme_id]
    resource
  end
end

Instance Method Details

#attach(data) ⇒ Object 


73
74
75
 
# File 'lib/shopify_api/resources/asset.rb', line 73

def attach(data)
  self.attachment = Base64.encode64(data)
end

#destroy ⇒ Object 


77
78
79
 
# File 'lib/shopify_api/resources/asset.rb', line 77

def destroy
  connection.delete(element_path(prefix_options.merge(asset: { key: key })), self.class.headers)
end

#new? ⇒ Boolean

Returns:

  • (Boolean) 

81
82
83
 
# File 'lib/shopify_api/resources/asset.rb', line 81

def new?
  false
end

#value ⇒ Object

For text assets, Shopify returns the data in the 'value' attribute. For binary assets, the data is base-64-encoded and returned in the 'attachment' attribute. This accessor returns the data in both cases.


68
69
70
71
 
# File 'lib/shopify_api/resources/asset.rb', line 68

def value
  attributes['value'] ||
  (attributes['attachment'] ? Base64.decode64(attributes['attachment']) : nil)
end