Class: ShopifyAPI::Base

Inherits:

ActiveResource::Base

• Object
• ActiveResource::Base
• ShopifyAPI::Base

Extended by:

Countable

Defined in:

lib/shopify_api/resources/base.rb

Direct Known Subclasses

Address, Announcement, ApplicationCharge, Article, Asset, BillingAddress, Blog, CarrierService, Cart, Checkout, Collect, Comment, Country, CustomCollection, Customer, CustomerSavedSearch, Event, Fulfillment, FulfillmentEvent, FulfillmentService, GiftCard, Image, LineItem, LineItem::Property, Location, Metafield, NoteAttribute, OAuth, Option, Order, Order::ClientDetails, OrderRisk, Page, PaymentDetails, Policy, Product, Province, Receipt, RecurringApplicationCharge, Redirect, Rule, ScriptTag, ShippingAddress, ShippingLine, ShippingZone, Shop, SmartCollection, TaxLine, Theme, Transaction, Variant, Webhook

Defined Under Namespace

Classes: InvalidSessionError

Class Method Summary

• .activate_session(session) ⇒ Object
• .clear_session ⇒ Object
• .init_prefix(resource) ⇒ Object
• .init_prefix_explicit(resource_type, resource_id) ⇒ Object

Instance Method Summary

• #as_json(options = nil) ⇒ Object
• #encode(options = {}) ⇒ Object
• #headers ⇒ Object
• #persisted? ⇒ Boolean

Methods included from Countable

count

Methods inherited from ActiveResource::Base

delete, headers

Class Method Details

.activate_session(session) ⇒ Object

Raises:

• (InvalidSessionError)

# File 'lib/shopify_api/resources/base.rb', line 52

def activate_session(session)
  raise InvalidSessionError.new("Session cannot be nil") if session.nil?
  self.site = session.site
  self.headers.merge!('X-Shopify-Access-Token' => session.token)
end

.clear_session ⇒ Object

# File 'lib/shopify_api/resources/base.rb', line 58

def clear_session
  self.site = nil
  self.headers.delete('X-Shopify-Access-Token')
end

.init_prefix(resource) ⇒ Object

# File 'lib/shopify_api/resources/base.rb', line 63

def init_prefix(resource)
  init_prefix_explicit(resource.to_s.pluralize, "#{resource}_id")
end

.init_prefix_explicit(resource_type, resource_id) ⇒ Object

# File 'lib/shopify_api/resources/base.rb', line 67

def init_prefix_explicit(resource_type, resource_id)
  self.prefix = "/admin/#{resource_type}/:#{resource_id}/"

  define_method resource_id.to_sym do
    @prefix_options[resource_id]
  end
end

Instance Method Details

#as_json(options = nil) ⇒ Object

# File 'lib/shopify_api/resources/base.rb', line 19

def as_json(options = nil)
  root = options[:root] if options.try(:key?, :root)
  if include_root_in_json
    root = self.class.model_name.element if root == true
    { root => serializable_hash(options) }
  else
    serializable_hash(options)
  end
end

#encode(options = {}) ⇒ Object

# File 'lib/shopify_api/resources/base.rb', line 12

def encode(options = {})
  same = dup
  same.attributes = {self.class.element_name => same.attributes} if self.class.format.extension == 'json'

  same.send("to_#{self.class.format.extension}", options)
end

#headers ⇒ Object

# File 'lib/shopify_api/resources/base.rb', line 31

def headers
  if _headers_defined?
    _headers
  elsif superclass != Object && superclass.headers
    superclass.headers
  else
    _headers ||= {}
  end
end

#persisted? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/shopify_api/resources/base.rb', line 76

def persisted?
  !id.nil?
end