Class: Etsy::Listing

Inherits:
Object
  • Object
show all
Includes:
Model
Defined in:
lib/etsy/listing.rb

Overview

Listing

Represents a single Etsy listing. Has the following attributes:

id

The unique identifier for this listing

title

The title of this listing

description

This listing’s full description

view_count

The number of times this listing has been viewed

url

The full URL to this listing’s detail page

price

The price of this listing item

currency

The currency that the seller is using for this listing item

quantity

The number of items available for sale

tags

An array of tags that the seller has used for this listing

materials

Any array of materials that was used in the production of this item

state

The current state of the item

hue

The hue of the listing’s primary image (HSV color).

saturation

The saturation of the listing’s primary image (HSV color).

brightness

The value of the listing’s primary image (HSV color).

black_and_white?

True if the listing’s primary image is in black & white.

Additionally, the following queries on this item are available:

active?

Is this listing active?

removed?

Has this listing been removed?

sold_out?

Is this listing sold out?

expired?

Has this listing expired?

alchemy?

Is this listing an Alchemy item? (i.e. requested by an Etsy user)

Constant Summary collapse

STATES = 
%w(active removed sold_out expired alchemy)
VALID_STATES = 
[:active, :expired, :inactive, :sold, :featured, :draft, :sold_out]

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Model

included, #initialize, #result, #secret, #token

Class Method Details

.create(options = {}) ⇒ Object 



55
56
57
58
 
# File 'lib/etsy/listing.rb', line 55

def self.create(options = {})
  options.merge!(:require_secure => true)
  post("/listings", options)
end

.destroy(listing, options = {}) ⇒ Object 



65
66
67
68
 
# File 'lib/etsy/listing.rb', line 65

def self.destroy(listing, options = {})
  options.merge!(:require_secure => true)
  delete("/listings/#{listing.id}", options)
end

.find(*identifiers_and_options) ⇒ Object

Retrieve one or more listings by ID:

Etsy::Listing.find(123)

You can find multiple listings by passing an array of identifiers:

Etsy::Listing.find([123, 456])



78
79
80
 
# File 'lib/etsy/listing.rb', line 78

def self.find(*identifiers_and_options)
  find_one_or_more('listings', identifiers_and_options)
end

.find_all_active_by_category(category, options = {}) ⇒ Object

Retrieve active listings for a given category. By default, pulls back the first 25 active listings. Defaults can be overridden using :limit, :offset, and :state

options = 

:limit => 25,
:offset => 100,
:token => 'toke',
:secret => 'secret'

Etsy::Listing.find_all_active_by_category(“accessories”, options)



122
123
124
125
 
# File 'lib/etsy/listing.rb', line 122

def self.find_all_active_by_category(category, options = {})
  options[:category] = category
  get_all("/listings/active", options)
end

.find_all_by_shop_id(shop_id, options = {}) ⇒ Object

Retrieve listings for a given shop. By default, pulls back the first 25 active listings. Defaults can be overridden using :limit, :offset, and :state

Available states are :active, :expired, :inactive, :sold, and :featured, :draft, :sold_out where :featured is a subset of the others.

options = 

:state => :expired,
:limit => 100,
:offset => 100,
:token => 'toke',
:secret => 'secret'

Etsy::Listing.find_all_by_shop_id(123, options)

Raises:

  • (ArgumentError) 


98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/etsy/listing.rb', line 98

def self.find_all_by_shop_id(shop_id, options = {})
  state = options.delete(:state) || :active

  raise(ArgumentError, self.invalid_state_message(state)) unless valid?(state)

  if state == :sold
    sold_listings(shop_id, options)
  else
    get_all("/shops/#{shop_id}/listings/#{state}", options)
  end
end

.update(listing, options = {}) ⇒ Object 



60
61
62
63
 
# File 'lib/etsy/listing.rb', line 60

def self.update(listing, options = {})
  options.merge!(:require_secure => true)
  put("/listings/#{listing.id}", options)
end

Instance Method Details

#add_variations(options) ⇒ Object

property_id = Etsy::Variation::PropertySet.find_property_by_name(“Dimensions”).fetch(“property_id”)

scale = Etsy::Variation::PropertySet.qualifying_properties_for_property("Dimensions").detect {|qp| qp.fetch("description") == "Sizing Scale"}
my_listing.add_variations(
  :variations => [
    {"property_id" => property_id, "value" => "1 x 2", "is_available" => true, "price" => 1.23},
    {"property_id" => property_id, "value" => "2 x 4", "is_available" => true, "price" => 2.34}
  ],
  scale.fetch("param") => scale.fetch("options").fetch("Inches")
)



189
190
191
192
193
 
# File 'lib/etsy/listing.rb', line 189

def add_variations(options)
  options[:variations] = JSON.dump(options.delete(:variations))
  options[:require_secure] = true
  self.class.post("/listings/#{id}/variations", options)
end

#admirers(options = {}) ⇒ Object

Return a list of users who have favorited this listing



231
232
233
234
235
236
 
# File 'lib/etsy/listing.rb', line 231

def admirers(options = {})
  options = options.merge(:access_token => token, :access_secret => secret) if (token && secret)
  favorite_listings = FavoriteListing.find_all_listings_favored_by(id, options)
  user_ids  = favorite_listings.map {|f| f.user_id }.uniq
  (user_ids.size > 0) ? Array(Etsy::User.find(user_ids, options)) : []
end

#black_and_white? ⇒ Boolean

Returns:

  • (Boolean) 


201
202
203
 
# File 'lib/etsy/listing.rb', line 201

def black_and_white?
  is_black_and_white
end

#category ⇒ Object

Listing category name



141
142
143
144
 
# File 'lib/etsy/listing.rb', line 141

def category
  path = category_path.join('/')
  @category ||= Category.find(path)
end

#created_at ⇒ Object

Time that this listing was created



213
214
215
 
# File 'lib/etsy/listing.rb', line 213

def created_at
  Time.at(created)
end

#ending_at ⇒ Object

Time that this listing is ending (will be removed from store)



225
226
227
 
# File 'lib/etsy/listing.rb', line 225

def ending_at
  Time.at(ending)
end

#image ⇒ Object

The primary image for this listing.



135
136
137
 
# File 'lib/etsy/listing.rb', line 135

def image
  images.first
end

#images ⇒ Object

The collection of images associated with this listing.



129
130
131
 
# File 'lib/etsy/listing.rb', line 129

def images
  @images ||= listing_images
end

#is_supply ⇒ Object 



238
239
240
 
# File 'lib/etsy/listing.rb', line 238

def is_supply
  !!@result.fetch("is_supply")
end

#modified_at ⇒ Object

Time that this listing was last modified



219
220
221
 
# File 'lib/etsy/listing.rb', line 219

def modified_at
  Time.at(modified)
end

#taxonomy_attributes(options = {}) ⇒ Object

Returns the taxonomy defined attributes for the listing



148
149
150
151
 
# File 'lib/etsy/listing.rb', line 148

def taxonomy_attributes(options={})
  options.merge!(:require_secure => true)
  self.class.get_all("/listings/#{id}/attributes", oauth.merge(options))
end

#update_variations(options) ⇒ Object 



195
196
197
198
199
 
# File 'lib/etsy/listing.rb', line 195

def update_variations(options)
  options[:variations] = JSON.dump(options.delete(:variations))
  options[:require_secure] = true
  self.class.put("/listings/#{id}/variations", options)
end

#variations(options = {}) ⇒ Object 



153
154
155
156
 
# File 'lib/etsy/listing.rb', line 153

def variations(options={})
  options.merge!(:require_secure => true)
  self.class.get_all("/listings/#{id}/variations", oauth.merge(options))
end