tcocca-etsy4r 0.1.0 → 0.2.0

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :patch: 0
 :major: 0
-:minor: 1
+:minor: 2

data/examples/etsy.rb

@@ -6,7 +6,8 @@ require 'yaml'
 
 
 # Initialize a new Etsy API Client
-client = Etsy4r::Client.new('your_api_key')
+#client = Etsy4r::Client.new('your_api_key')
+client = Etsy4r::Client.new('dacmw5zgq4x82z95ben5em6v')
 
 
 # Initialize a ServerCommands object
@@ -32,7 +33,6 @@ if res.success?
   puts res.body .to_yaml    # Return the full body response of the call
   puts res.results.to_yaml  # Return the results (the actual deta) in an array of hashes
   puts res.count            # Count of all pieces of data that the Query returned (note: this is a total count not the count returned)
-  puts res.limit            # The max number of records returned in the API call
   puts res.type             # The type of result passed back
   puts res.params           # The params passed in to the query  
 else
@@ -85,9 +85,13 @@ res = shop.get_featured_sellers
 
 # Returns all listings for a "shop" (or user)
 # Takes either a user_id or a user_name
-# Also takes :detail_level, :limit and :offset optional params
-res = shop.get_listings(5565464)
-res = shop.get_listings('maymaydesigns')
+# Optional Params
+#   :detail_level, :limit, :offset, 
+#   :sort_order   enum(up, down)
+#   :sort_on      enum(created, price)
+#   section_id    int
+res = shop.get_shop_listings(5565464)
+res = shop.get_shop_listings('maymaydesigns')
 
 # Search for shops be a name
 # The name params is required
@@ -116,6 +120,19 @@ res = tag.get_child_tags('bags and purses')
 res = tag.get_child_tags('bags_and_purses')
 
 
+# Initialize a CategoryCommands object
+tag = Etsy4r::CategoryCommands.new(client)
+
+# Returns the top level categories, no params
+res = tag.get_top_categories
+
+# Returns the child categories of a category
+# Spaces and dashes get converted to underscores
+res = tag.get_child_categories('bags-and-purses')
+res = tag.get_child_categories('bags and purses')
+res = tag.get_child_categories('bags_and_purses')
+
+
 # Initialiaze a ListingCommands object
 listing = Etsy4r::ListingCommands.new(client)
 
@@ -149,6 +166,41 @@ res = listing.get_listings_by_keywords(['bags and purses', 'art', 'shoulder bag'
 res = listing.get_front_featured_listings
 res = listing.get_front_featured_listings(:detail_level => 'medium', :limit => '45')
 
+# Returns all listings
+# No required params
+# Optional params
+#  :detail_level, :limit, :offset, :sort_on, :sort_order
+res = listing.get_all_listings
+res = listing.get_all_listings(:detail_level => 'medium', :limit => 45, :offset => 45, :sort_on => 'ending', :sort_order => 'down')
+
+# Returns all listings in a category
+# category is required
+# Optional params
+#  :detail_level, :limit, :offset, :sort_on, :sort_order
+res = listing.get_listings_by_category('bags_and_purses')
+res = listing.get_listings_by_category('bags_and_purses', :detail_level => 'medium', :limit => 15, :offset => 15, :sort_on => 'price', :sort_order => 'down')
+
+# Returns all listings matching a color
+# color is required
+# HSV color as an array (0;0;0 through 360;100;100) or an RGB color in web notation (#000000 through #FFFFFF.) 
+#  NOTE: The Etsy API uses HSV colors internally, and the conversion from RGB to HSV is not 100% accurate.
+#  (RGB colors are converted to HSV internally, which may result in small rounding errors.  They may omit the leading "#", or use the three-digit form.)
+# Optional params
+#  :wiggle  default => 5, type => int
+#  :detail_level, :limit, :offset
+res = listing.get_listings_by_color('FFFFFF')
+res = listing.get_listings_by_color('#FFFFFF')
+res = listing.get_listings_by_color('360;100;100', :detail_level => 'medium', :limit => 15, :offset => 15, :wiggle => 10)
+
+# Returns all listings matching a color and search terms
+# color is required (HSV or RGB)
+# an array of search terms is required
+# Optional params
+#  :detail_level, :limit, :offset, :wiggle
+res = listing.get_listings_by_color_and_keywords('FFFFFF', ['bags', 'bracelets'])
+res = listing.get_listings_by_color_and_keywords('#FFFFFF', ['bags', 'bracelets'])
+res = listing.get_listings_by_color_and_keywords('360;100;100', ['bags', 'bracelets'], :detail_level => 'medium', :wiggle => 10)
+
 
 # Initialize a FavoriteCommands object
 favorite = Etsy4r::FavoriteCommands.new(client)
@@ -157,8 +209,8 @@ favorite = Etsy4r::FavoriteCommands.new(client)
 # Takes either a user_id or user_name
 # Optional params
 #  :detail_level, :limit, :offset
-res = favorite.get_favorers_of_user(5565464)
-res = favorite.get_favorers_of_user(5565464, :detail_level => 'high', :limit => 5, :offset => 5)
+res = favorite.get_favorers_of_shop(5565464)
+res = favorite.get_favorers_of_shop(5565464, :detail_level => 'high', :limit => 5, :offset => 5)
 
 # Returns the users who favorited the listing passed in
 # Takes a listing_id
@@ -182,6 +234,41 @@ res = favorite.get_favorite_listings_of_user(5565464)
 res = favorite.get_favorite_listings_of_user(5565464, :detail_level => 'high', :limit => 5, :offset => 5)
 
 
+# Initialize a FeedbackCommands object
+feedback = Etsy4r::FeedbackCommands.new(client)
+
+# Returns the top level tags, no params
+res = feedback.get_feedback(17331973)
+
+# Returns all feedback for a user
+# Takes either a user_id or user_name
+# Optional params
+#  :limit, :offset
+res = feedback.get_feedback_for_user(5565464)
+res = feedback.get_feedback_for_user('maymaydesigns')
+
+# Returns all feedback where the user was the buyer
+# Takes either a user_id or user_name
+# Optional params
+#  :limit, :offset
+res = feedback.get_feedback_as_buyer(5565464)
+res = feedback.get_feedback_as_buyer('maymaydesigns')
+
+# Returns all feedback where the user left feedback
+# Takes either a user_id or user_name
+# Optional params
+#  :limit, :offset
+res = feedback.get_feedback_for_others(5565464)
+res = feedback.get_feedback_for_others('maymaydesigns')
+
+# Returns all feedback where the user was the seller
+# Takes either a user_id or user_name
+# Optional params
+#  :limit, :offset
+res = feedback.get_feedback_as_seller(5565464)
+res = feedback.get_feedback_as_seller('maymaydesigns')
+
+
 # Initialize an ImageParser object
 # This takes a single parameter which is the id of an Etsy listing
 image_parser = Etsy4r::ImageParser.new(19781773)

data/lib/etsy4r.rb

@@ -11,4 +11,6 @@ require File.dirname(__FILE__) + '/etsy4r/shop_commands'
 require File.dirname(__FILE__) + '/etsy4r/listing_commands'
 require File.dirname(__FILE__) + '/etsy4r/tag_commands'
 require File.dirname(__FILE__) + '/etsy4r/favorite_commands'
+require File.dirname(__FILE__) + '/etsy4r/category_commands'
+require File.dirname(__FILE__) + '/etsy4r/feedback_commands'
 require File.dirname(__FILE__) + '/etsy4r/image_parser'

data/lib/etsy4r/favorite_commands.rb

@@ -2,7 +2,13 @@ module Etsy4r
   class FavoriteCommands < Etsy4r::Commands
     
     def get_favorers_of_user(user_id, optional_params = {})
-      @client.process("/users/#{user_id}/favorers", optional_params)
+      warn "[DEPRECATION] get_favorers_of_user is deprecated. " <<
+       "Use get_favorers_of_shop instead."
+      get_favorers_of_shop(user_id, optional_params = {})
+    end
+    
+    def get_favorers_of_shop(user_id, optional_params = {})
+      @client.process("/shops/#{user_id}/favorers", optional_params)
     end
     
     def get_favorers_of_listing(listing_id, optional_params = {})

data/lib/etsy4r/tag_commands.rb

@@ -2,7 +2,7 @@ module Etsy4r
   class TagCommands < Etsy4r::Commands
     
     def get_top_tags
-      @client.process("/tags/top")
+      @client.process("/tags")
     end
     
     def get_child_tags(tag)

data/spec/etsy4r/favorite_commands_spec.rb

@@ -31,6 +31,22 @@ describe Etsy4r::FavoriteCommands do
     end
   end
   
+  describe 'get_favorers_of_shop' do
+    it 'should return users who favor the shop' do
+      @res = @favorite_commands.get_favorers_of_shop(5565464)
+      @res.should be_success
+      @res.results.should_not be_nil
+      @res.error_message.should be_blank
+    end
+    
+    it 'should accept the optional params' do
+      @res = @favorite_commands.get_favorers_of_shop(5565464, :detail_level => 'high', :limit => 5, :offset => 5)
+      @res.should be_success
+      @res.results.should_not be_nil
+      @res.error_message.should be_blank
+    end
+  end
+  
   describe 'get_favorers_of_listing' do
     it 'should return users who favor the user' do
       @res = @favorite_commands.get_favorers_of_listing(19749826)

data/spec/spec.opts

@@ -1 +1 @@
---colour
+--colour

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tcocca-etsy4r
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Tom Cocca
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-01 00:00:00 -08:00
+date: 2009-03-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency