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]

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Model

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

Class Method Details

.create(options = {}) ⇒ Object 



51
52
53
54
 
# File 'lib/etsy/listing.rb', line 51

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

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



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

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])



74
75
76
 
# File 'lib/etsy/listing.rb', line 74

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)



118
119
120
121
 
# File 'lib/etsy/listing.rb', line 118

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


94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/etsy/listing.rb', line 94

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 



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

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

Instance Method Details

#admirers(options = {}) ⇒ Object

Return a list of users who have favorited this listing



165
166
167
168
169
170
 
# File 'lib/etsy/listing.rb', line 165

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) 


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

def black_and_white?
  is_black_and_white
end

#created_at ⇒ Object

Time that this listing was created



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

def created_at
  Time.at(created)
end

#ending_at ⇒ Object

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



159
160
161
 
# File 'lib/etsy/listing.rb', line 159

def ending_at
  Time.at(ending)
end

#image ⇒ Object

The primary image for this listing.



131
132
133
 
# File 'lib/etsy/listing.rb', line 131

def image
  images.first
end

#images ⇒ Object

The collection of images associated with this listing.



125
126
127
 
# File 'lib/etsy/listing.rb', line 125

def images
  @images ||= Image.find_all_by_listing_id(id)
end

#modified_at ⇒ Object

Time that this listing was last modified



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

def modified_at
  Time.at(modified)
end