tcocca-etsy4r 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Tom Cocca
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,51 @@
+etsy4r
+======
+
+etsy4r is a Ruby wrapper for the Etsy API.  It utilizes the amazing HTTParty gem by John Nunemaker.
+If you need to build an API wrapper that gem is an enourmous help, refer to the following:
+
+http://railstips.org/2008/7/29/it-s-an-httparty-and-everyone-is-invited
+
+etsy4r wraps all of the etsy api calls into 1 nice library.  Etsy's API is currenly in beta so this library will probably 
+be changing frequently.  Most likely their will only be additions.
+
+One thing that does not exist in the Etsy API is the ability to grab all the images for a listing so I have written a parser based on
+Hpricot.  This may dissapear when etsy releases a call to get all images to their API.
+
+
+Etsy API
+=========
+
+The Etsy api is currently in beta.  See this blog post for details:
+http://www.etsy.com/storque/etsy-news/tech-updates-handmade-code-etsys-beta-api-3055/
+
+You will need to email their development staff to get access to the API setion of the website before you can 
+register for an API key which you will need to do.
+
+
+USAGE
+==========
+
+See http://github.com/tcocca/etsy4r/tree/master/examples
+
+I have added example calls to all of the methods and object.
+
+
+INSTALATION
+==========
+
+sudo gem install tcocca-etsy4r -s http://gems.github.com
+
+
+QUESTION/CONCERNS/COMMENTS
+==========
+
+Send me an email through github or at tom dot cocca at gmail dot com
+Feel free to fork and submit changes
+There is a test suite built on rspec. 
+
+
+COPYRIGHT
+=========
+
+Copyright (c) 2008 Tom Cocca. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,60 @@
+require 'rake'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "etsy4r"
+    s.summary = %Q{Handcrafted API Wrapper}
+    s.email = "tom.cocca@gmail.com"
+    s.homepage = "http://github.com/tcocca/etsy4r"
+    s.description = "Handcrafted API Wrapper for Etsy utilizing httparty"
+    s.files = [
+      "README",
+      "LICENSE",
+      "Rakefile",
+      "VERSION.yml",
+      "lib/etsy4r.rb",
+      "lib/etsy4r/client.rb",
+      "lib/etsy4r/commands.rb",
+      "lib/etsy4r/favorite_commands.rb",
+      "lib/etsy4r/gift_guide_commands.rb",
+      "lib/etsy4r/image_parser.rb",
+      "lib/etsy4r/response.rb",
+      "lib/etsy4r/server_commands.rb",
+      "lib/etsy4r/tag_commands.rb",
+      "lib/etsy4r/user_commands.rb",
+      "spec/rcov.opts",
+      "spec/spec.opts",
+      "spec/spec_helper.rb",
+      "spec/fixtures/images.html",
+      "spec/etsy4r/client_spec.rb",
+      "spec/etsy4r/commands_spec.rb",
+      "spec/etsy4r/favorite_commands_spec.rb",
+      "spec/etsy4r/gift_guide_commands_spec.rb",
+      "spec/etsy4r/image_parser_spec.rb",
+      "spec/etsy4r/server_commands_spec.rb",
+      "spec/etsy4r/tag_commands_spec.rb",
+      "spec/etsy4r/user_commands_spec.rb",
+      "tasks/rspec.rake",
+      "examples/etsy.rb"
+    ]
+    s.authors = ["Tom Cocca"]
+    s.add_dependency 'httparty'
+    s.add_dependency 'hpricot'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'etsy4r'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+task :default => :spec

data/VERSION.yml

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

data/examples/etsy.rb

@@ -0,0 +1,192 @@
+require File.dirname(__FILE__) + '/../lib/etsy4r'
+require 'yaml'
+
+# Read the Etsy API Documentation
+# http://developer.etsy.com/docs
+
+
+# Initialize a new Etsy API Client
+client = Etsy4r::Client.new('your_api_key')
+
+
+# Initialize a ServerCommands object
+server = Etsy4r::ServerCommands.new(client)
+
+# Ping the server
+res = server.ping
+
+# Return a list of all available method calls
+res = server.get_method_table
+
+# Get the current time on the Etsy server in epoch
+res = server.get_server_epoch
+
+# Go from epoch time to ruby Time object
+puts Time.at(res.results.first)
+
+
+# Every call return a response object
+# Below are the following methods on that object
+# These methods are available on every single call except on the image parser object
+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
+  puts res.error_message  # If the call was not successful an error message is returned
+end
+
+
+# Initialize a GiftGuideCommands object
+gift_guide = Etsy4r::GiftGuideCommands.new(client)
+
+# Get a list of available GiftGuides
+res = gift_guide.get_gift_guides
+
+# Get the listings for a gift guide
+# The first params is the id of the gift guide
+# This method takes the following optional params
+#  :offset 	default = 0 type = int
+#  :limit 	  default = 10 type = int, max = 50
+#  :detail_level 	default = 'low' 	options = enum(low, medium, high)
+res = gift_guide.get_gift_guide_listings(61, {:detail_level => "high"})
+
+
+# Initialize a UserCommands object
+user = Etsy4r::UserCommands.new(client)
+
+# Return the details for a user
+# You can pass a user id:
+res = user.get_user_details(5565464)
+# Or a user_name
+res = user.get_user_details('maymaydesigns')
+# Also, this methods take the :detail_level optional param
+res = user.get_user_details('maymaydesigns', {:detail_level => 'high'})
+
+# Search for users by name
+# The search name is required
+# The method takes the :detail_level, :limit and :offset optional params
+res = user.get_users_by_name('amanda', {:detail_level => 'medium', :limit => 50})
+
+
+# Initialize a ShopCommands object
+shop = Etsy4r::ShopCommands.new(client)
+
+# Get shop details, this method takes either a user_id or user_name
+# Also takes the :detail_level optional params
+res = shop.get_shop_details(5565464)
+res = shop.get_shop_details('maymaydesigns')
+
+# Returns a list of featured selers, not params
+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')
+
+# Search for shops be a name
+# The name params is required
+# Take the following optional params
+#  :detail_level, :limit, :offset
+#  :sort_order   default => 'down'  enum (down, up)
+res = shop.get_shops_by_name('amanda')
+
+# Get a shops feauted listings
+# Takes either a user_id or user_name
+# Also taks the :detail_level optional_param
+res = shop.get_featured_details(5565464)
+res = shop.get_featured_details('maymaydesigns', :detail_level => 'high')
+
+
+# Initialize a TagCommands object
+tag = Etsy4r::TagCommands.new(client)
+
+# Returns the top level tags, no params
+res = tag.get_top_tags
+
+# Returns the child tags of a tag
+# Spaces and dashes get converted to underscores
+res = tag.get_child_tags('bags-and-purses')
+res = tag.get_child_tags('bags and purses')
+res = tag.get_child_tags('bags_and_purses')
+
+
+# Initialiaze a ListingCommands object
+listing = Etsy4r::ListingCommands.new(client)
+
+# Returns details for a specific listing
+# Takes the listing_id as a params and the optional :detail_level param
+res = listing.get_listing_details(19781773, :detail_level => 'high')
+
+# Returns listings that match the tags
+# Pass tags in as an array
+# Takes the following optional params
+#  :sort_on   default => 'created' 	enum(created, price)
+#  :sort_order   detfault => 'down' 	enum(up, down)
+#  :detail_level, :limit, :offset
+res = listing.get_listings_by_tags(['bags_and_purses', 'art', 'shoulder bag'])
+res = listing.get_listings_by_tags(['bags_and_purses', 'art', 'shoulder bag'], :sort_on => 'price', :sort_order => 'down')
+
+# Return listings that match keywords
+# Takes an array of keywords
+# Takes the following optional params
+#  :min_price 	default => NULL 	type = float
+#  :max_price 	default => NULL 	type = float
+#  :search_description 	default => false 	enum(true, false)
+#  :sort_order, :sort_on, :detail_level, :limit, :offset
+res = listing.get_listings_by_keywords(['bags and purses', 'art', 'shoulder bag'])
+res = listing.get_listings_by_keywords(['bags and purses', 'art', 'shoulder bag'], :min_price => 0, :max_price => 22.99)
+
+# Returns the list of listings featured on the etsy homepage
+# No required params
+# Optional params
+#  :detail_level, :limit, :offset
+res = listing.get_front_featured_listings
+res = listing.get_front_featured_listings(:detail_level => 'medium', :limit => '45')
+
+
+# Initialize a FavoriteCommands object
+favorite = Etsy4r::FavoriteCommands.new(client)
+
+# Returns the users who favorited the user passed in
+# 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)
+
+# Returns the users who favorited the listing passed in
+# Takes a listing_id
+# Optional params
+#  :detail_level, :limit, :offset
+res = favorite.get_favorers_of_listing(19749826)
+res = favorite.get_favorers_of_listing(19749826, :detail_level => 'high', :limit => 5, :offset => 5)
+
+# Returns the users who the user passed in favorited
+# Takes either a user_id or user_name
+# Optional params
+#  :detail_level, :limit, :offset
+res = favorite.get_favorite_shops_of_user(5565464)
+res = favorite.get_favorite_shops_of_user(5565464, :detail_level => 'high', :limit => 5, :offset => 5)
+
+# Returns the listings who the user passed in favorited
+# Takes either a user_id or user_name
+# Optional params
+#  :detail_level, :limit, :offset
+res = favorite.get_favorite_listings_of_user(5565464)
+res = favorite.get_favorite_listings_of_user(5565464, :detail_level => 'high', :limit => 5, :offset => 5)
+
+
+# Initialize an ImageParser object
+# This takes a single parameter which is the id of an Etsy listing
+image_parser = Etsy4r::ImageParser.new(19781773)
+
+# Calling images on the object return a hash of the images
+# The hash contains all the formatted URLs that Etsy returns 
+#  (for the single image they give for a listing)
+puts image_parser.images.to_yaml

data/lib/etsy4r/client.rb

@@ -0,0 +1,17 @@
+module Etsy4r
+  class Client
+    
+    include HTTParty
+    base_uri 'beta-api.etsy.com/v1'
+    format :json
+    
+    def initialize(apikey)
+      self.class.default_params :api_key => apikey
+    end
+    
+    def process(uri, optional_params = {})
+      Response.new(self.class.get(uri, :query => optional_params))
+    end
+    
+  end
+end

data/lib/etsy4r/commands.rb

@@ -0,0 +1,11 @@
+module Etsy4r
+  class Commands
+    
+    attr_accessor :client
+    
+    def initialize(client)
+      @client = client
+    end
+        
+  end
+end

data/lib/etsy4r/favorite_commands.rb

@@ -0,0 +1,21 @@
+module Etsy4r
+  class FavoriteCommands < Etsy4r::Commands
+    
+    def get_favorers_of_user(user_id, optional_params = {})
+      @client.process("/users/#{user_id}/favorers", optional_params)
+    end
+    
+    def get_favorers_of_listing(listing_id, optional_params = {})
+      @client.process("/listings/#{listing_id}/favorers", optional_params)
+    end
+    
+    def get_favorite_shops_of_user(user_id, optional_params = {})
+      @client.process("/users/#{user_id}/favorites/shops", optional_params)
+    end
+    
+    def get_favorite_listings_of_user(user_id, optional_params = {})
+      @client.process("/users/#{user_id}/favorites/listings", optional_params)
+    end
+    
+  end
+end

data/lib/etsy4r/gift_guide_commands.rb

@@ -0,0 +1,13 @@
+module Etsy4r
+  class GiftGuideCommands < Etsy4r::Commands
+    
+    def get_gift_guides
+      @client.process('/gift-guides')
+    end
+    
+    def get_gift_guide_listings(guide_id, optional_params = {})
+      @client.process("/gift-guides/#{guide_id}/listings", optional_params)
+    end
+    
+  end
+end

data/lib/etsy4r/image_parser.rb

@@ -0,0 +1,39 @@
+module Etsy4r
+  class ImageParser
+    
+    attr_accessor :listing_id, :parse_url, :images
+    
+    def initialize(listing_id)
+      @listing_id = listing_id
+      @parse_url = "http://www.etsy.com/view_listing.php?listing_id=#{@listing_id}"
+      @images = {}
+      get_images
+    end
+    
+    def get_images
+      require 'hpricot'
+      require 'open-uri'
+      
+      image_list = []
+      doc = open(parse_url) {|f| Hpricot(f)}
+      img_table = doc.search("/html/body/table/tr/td/table/tr[2]/td/table/tr[3]/td/table/tr[2]/td/table/tr/td[2]/table")
+      img_table.first.search('img').each do |img|
+        image_list << img.attributes['src']
+      end
+      image_list.each_with_index do |img_url, i|
+        img_dom = /\/\/(\S*)\//.match(img_url)[1]
+        img_id = /\.([\d]*)\./.match(img_url)[1]
+        @images["#{i}"] = {
+          "image_url_430xN" => "http://#{img_dom}/il_430xN.#{img_id}.jpg",
+          "image_url_200x200" => "http://#{img_dom}/il_200x200.#{img_id}.jpg",
+          "image_url_155x125" => "http://#{img_dom}/il_155x125.#{img_id}.jpg",
+          "image_url_75x75" => "http://#{img_dom}/il_75x75.#{img_id}.jpg",
+          "image_url_50x50" => "http://#{img_dom}/il_50x50.#{img_id}.jpg",
+          "image_url_25x25" => "http://#{img_dom}/il_25x25.#{img_id}.jpg"
+        }
+      end
+      return @images
+    end
+    
+  end
+end

data/lib/etsy4r/response.rb

@@ -0,0 +1,37 @@
+module Etsy4r
+  class Response
+    
+    attr_accessor :body
+    
+    def initialize(body)
+      @body = body
+    end
+    
+    def results
+      @body['results']
+    end
+    
+    def count
+      @body['count']
+    end
+    
+    def type
+      @body['type']
+    end
+    
+    def params
+      @body['params']
+    end
+    
+    def success?
+      results
+    end
+    
+    def error_message
+      if !success?
+        @body
+      end
+    end
+    
+  end
+end

data/lib/etsy4r/server_commands.rb

@@ -0,0 +1,17 @@
+module Etsy4r
+  class ServerCommands < Etsy4r::Commands
+    
+    def get_method_table
+      @client.process('/')
+    end
+    
+    def ping
+      @client.process('/server/ping')
+    end
+    
+    def get_server_epoch
+      @client.process('/server/epoch')
+    end
+    
+  end
+end

data/lib/etsy4r/tag_commands.rb

@@ -0,0 +1,14 @@
+module Etsy4r
+  class TagCommands < Etsy4r::Commands
+    
+    def get_top_tags
+      @client.process("/tags/top")
+    end
+    
+    def get_child_tags(tag)
+      tag_param = tag.gsub(/\s|\-/, "_")
+      @client.process("/tags/#{tag_param}/children")
+    end
+    
+  end
+end

data/lib/etsy4r/user_commands.rb

@@ -0,0 +1,14 @@
+module Etsy4r
+  class UserCommands < Etsy4r::Commands
+    
+    def get_user_details(user_id, optional_params = {})
+      @client.process("/users/#{user_id}", optional_params)
+    end
+    
+    def get_users_by_name(search_name, optional_params = {})
+      search_name_param = search_name.gsub(" ", "_")
+      @client.process("/users/keywords/#{search_name_param}", optional_params)
+    end
+    
+  end
+end

data/lib/etsy4r.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'httparty'
+
+require File.dirname(__FILE__) + '/etsy4r/client'
+require File.dirname(__FILE__) + '/etsy4r/commands'
+require File.dirname(__FILE__) + '/etsy4r/response'
+require File.dirname(__FILE__) + '/etsy4r/server_commands'
+require File.dirname(__FILE__) + '/etsy4r/gift_guide_commands'
+require File.dirname(__FILE__) + '/etsy4r/user_commands'
+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/image_parser'

data/spec/etsy4r/client_spec.rb

@@ -0,0 +1,22 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/../../lib/etsy4r'
+require File.dirname(__FILE__) + '/../../lib/etsy4r/client'
+
+describe Etsy4r::Client do
+  include Etsy4rSpecHelper
+  
+  describe 'initialize' do
+    before do
+      @client = etsy4r_client
+    end
+    
+    it 'sets the base_uri' do 
+      @client.class.base_uri.should == 'http://beta-api.etsy.com/v1'
+    end
+    
+    it 'sets default params to include the api key' do
+      @client.class.default_params.should == {:api_key => 'dacmw5zgq4x82z95ben5em6v'}
+    end
+  end
+  
+end

data/spec/etsy4r/commands_spec.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/../../lib/etsy4r'
+
+describe Etsy4r::Commands do
+  include Etsy4rSpecHelper
+  
+  before do
+    @client = etsy4r_client
+    @commands = Etsy4r::Commands.new(@client)
+  end
+    
+  describe 'initialize' do    
+    it 'set the client' do 
+      @commands.client.class.should == Etsy4r::Client
+    end
+  end
+  
+end

data/spec/etsy4r/favorite_commands_spec.rb

@@ -0,0 +1,81 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/../../lib/etsy4r'
+
+describe Etsy4r::FavoriteCommands do
+  include Etsy4rSpecHelper
+  
+  before do
+    @client = etsy4r_client
+    @favorite_commands = Etsy4r::FavoriteCommands.new(@client)
+  end
+    
+  describe 'initialize' do    
+    it 'set the client' do 
+      @favorite_commands.client.class.should == Etsy4r::Client
+    end
+  end
+  
+  describe 'get_favorers_of_user' do
+    it 'should return users who favor the user' do
+      @res = @favorite_commands.get_favorers_of_user(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_user(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)
+      @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_listing(19749826, :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_favorite_shops_of_user' do
+    it 'should return users who favor the user' do
+      @res = @favorite_commands.get_favorite_shops_of_user(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_favorite_shops_of_user(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_favorite_listings_of_user' do
+    it 'should return users who favor the user' do
+      @res = @favorite_commands.get_favorite_listings_of_user(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_favorite_listings_of_user(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
+end

data/spec/etsy4r/gift_guide_commands_spec.rb

@@ -0,0 +1,56 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/../../lib/etsy4r'
+
+describe Etsy4r::GiftGuideCommands do
+  include Etsy4rSpecHelper
+  
+  before do
+    @client = etsy4r_client
+    @gift_guide_commands = Etsy4r::GiftGuideCommands.new(@client)
+  end
+    
+  describe 'initialize' do    
+    it 'set the client' do 
+      @gift_guide_commands.client.class.should == Etsy4r::Client
+    end
+  end
+  
+  describe 'get_gift_guides' do
+    it 'should return all gift guides' do
+      @res = @gift_guide_commands.get_gift_guides
+      @res.should be_success
+      @res.results.should_not be_nil
+      @res.error_message.should be_blank
+    end
+  end
+  
+  describe 'get_gift_guide_listings' do
+    it 'should return the listing in a gift guide' do
+      @res = @gift_guide_commands.get_gift_guide_listings(100)
+      @res.should be_success
+      @res.results.should_not be_nil
+      @res.count.should_not == 0
+      @res.results.size.should == 10
+      @res.error_message.should be_blank
+    end
+    
+    it 'should not return listings when given a bad guide_id' do
+      @res = @gift_guide_commands.get_gift_guide_listings(1000)
+      @res.should be_success
+      @res.results.should_not be_nil
+      @res.results.should be_empty
+      @res.count.should == 0
+      @res.results.size.should == 0
+      @res.error_message.should be_blank
+    end
+    
+    it 'shoulde return the number of listings specified' do
+      @res = @gift_guide_commands.get_gift_guide_listings(100, {:limit => 40})
+      @res.should be_success
+      @res.results.should_not be_nil
+      @res.count.should_not == 0
+      @res.results.size.should <= 40
+      @res.error_message.should be_blank
+    end
+  end
+end

data/spec/etsy4r/image_parser_spec.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/../../lib/etsy4r'
+
+describe Etsy4r::ImageParser do
+  include Etsy4rSpecHelper
+  include Etsy4rImageParserSpecHelper
+  
+  before do
+    @image_parser = Etsy4r::ImageParser.new(19781773)
+    @image_parser.parse_url = File.dirname(__FILE__) + "/../fixtures/images.html"
+  end
+  
+  describe 'initialize' do
+    it 'should set the url for the page to parse' do
+      @image_parser.parse_url.should_not be_blank
+    end
+    
+    it 'should set the listing_id' do
+      @image_parser.listing_id.should == 19781773
+    end
+    
+    it 'should set the images hash' do
+      @image_parser.images.should_not be_nil
+    end
+  end
+  
+  describe 'get_images' do
+    it 'should set images as a hash' do
+      @image_parser.images.should == test_image_hash
+    end
+  end
+  
+end

data/spec/etsy4r/server_commands_spec.rb

@@ -0,0 +1,45 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/../../lib/etsy4r'
+
+describe Etsy4r::ServerCommands do
+  include Etsy4rSpecHelper
+  
+  before do
+    @client = etsy4r_client
+    @server_commands = Etsy4r::ServerCommands.new(@client)
+  end
+    
+  describe 'initialize' do    
+    it 'set the client' do 
+      @server_commands.client.class.should == Etsy4r::Client
+    end
+  end
+  
+  describe 'get_method_table' do
+    it 'should get all methods' do
+      @res = @server_commands.get_method_table
+      @res.should be_success
+      @res.results.should_not be_nil
+      @res.error_message.should be_blank
+    end
+  end
+  
+  describe 'ping' do
+    it 'should ping the server' do
+      @res = @server_commands.ping
+      @res.should be_success
+      @res.results.should_not be_nil
+      @res.error_message.should be_blank
+    end
+  end
+  
+  describe 'get_server_epoch' do
+    it 'should return the server time' do
+      @res = @server_commands.get_server_epoch
+      @res.should be_success
+      @res.results.should_not be_nil
+      @res.error_message.should be_blank
+    end
+  end
+  
+end

data/spec/etsy4r/tag_commands_spec.rb

@@ -0,0 +1,49 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/../../lib/etsy4r'
+
+describe Etsy4r::TagCommands do
+  include Etsy4rSpecHelper
+  
+  before do
+    @client = etsy4r_client
+    @tag_commands = Etsy4r::TagCommands.new(@client)
+  end
+    
+  describe 'initialize' do    
+    it 'set the client' do 
+      @tag_commands.client.class.should == Etsy4r::Client
+    end
+  end
+  
+  describe 'get_top_tags' do
+    it 'should return the top level tags' do
+      @res = @tag_commands.get_top_tags
+      @res.should be_success
+      @res.results.should_not be_nil
+      @res.error_message.should be_blank
+    end
+  end
+  
+  describe 'get_child_tags' do
+    it 'should return child tags when given a formatted tag' do
+      @res = @tag_commands.get_child_tags('bags_and_purses')
+      @res.should be_success
+      @res.results.should_not be_nil
+      @res.error_message.should be_blank
+    end
+    
+    it 'should return child tags when given a tag with spaces' do
+      @res = @tag_commands.get_child_tags('bags and purses')
+      @res.should be_success
+      @res.results.should_not be_nil
+      @res.error_message.should be_blank
+    end
+    it 'should return child tags when given a tag with dashes' do
+      @res = @tag_commands.get_child_tags('bags-and-purses')
+      @res.should be_success
+      @res.results.should_not be_nil
+      @res.error_message.should be_blank
+    end
+  end
+  
+end

data/spec/etsy4r/user_commands_spec.rb

@@ -0,0 +1,72 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/../../lib/etsy4r'
+
+describe Etsy4r::UserCommands do
+  include Etsy4rSpecHelper
+  
+  before do
+    @client = etsy4r_client
+    @user_commands = Etsy4r::UserCommands.new(@client)
+  end
+    
+  describe 'initialize' do    
+    it 'set the client' do 
+      @user_commands.client.class.should == Etsy4r::Client
+    end
+  end
+  
+  describe 'get_user_details' do
+    it 'should return details for a user when given a user_id' do
+      @res = @user_commands.get_user_details(5565464)
+      @res.should be_success
+      @res.results.should_not be_blank
+      @res.error_message.should be_blank
+    end
+    
+    it 'should return details for a user when given a user_name' do
+      @res = @user_commands.get_user_details('maymaydesigns')
+      @res.should be_success
+      @res.results.should_not be_nil
+      @res.error_message.should be_blank
+    end
+    
+    it 'should accept detail_level as an optional param' do
+      @res = @user_commands.get_user_details('maymaydesigns', {:detail_level => 'high'})
+      @res.should be_success
+      @res.results.should_not be_nil
+      @res.error_message.should be_blank
+    end
+  end
+  
+  describe 'get_users_by_name' do
+    it 'should find users by the search_name provided' do
+      @res = @user_commands.get_users_by_name('amanda')
+      @res.should be_success
+      @res.results.should_not be_nil
+      @res.error_message.should be_blank
+    end
+    
+    it 'should find users by the search_name provided with spaces' do
+      @res = @user_commands.get_users_by_name('amanda t')
+      @res.should be_success
+      @res.results.should_not be_nil
+      @res.error_message.should be_blank
+    end
+    
+    it 'should accept limit as an optional param' do
+      @res = @user_commands.get_users_by_name('amanda', {:limit => 15})
+      @res.should be_success
+      @res.results.should_not be_nil
+      @res.results.size.should <= 15
+      @res.error_message.should be_blank
+    end
+    
+    it 'should error on limit > 50' do
+      @res = @user_commands.get_users_by_name('amanda', {:limit => 150})
+      @res.should_not be_success
+      @res.results.should be_nil
+      @res.error_message.should_not be_blank
+    end
+  end
+  
+end

data/spec/rcov.opts

@@ -0,0 +1 @@
+--exclude "spec/*"

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,60 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'etsy4r'
+
+module Etsy4rSpecHelper
+  
+  def etsy4r_client
+    Etsy4r::Client.new('dacmw5zgq4x82z95ben5em6v')
+  end
+  
+end
+
+
+module Etsy4rImageParserSpecHelper
+  
+  def test_image_hash
+    {
+      "0" => {
+        "image_url_430xN" => "http://ny-image2.etsy.com/il_430xN.53071410.jpg",
+        "image_url_200x200" => "http://ny-image2.etsy.com/il_200x200.53071410.jpg",
+        "image_url_155x125" => "http://ny-image2.etsy.com/il_155x125.53071410.jpg",
+        "image_url_75x75" => "http://ny-image2.etsy.com/il_75x75.53071410.jpg",
+        "image_url_25x25" => "http://ny-image2.etsy.com/il_25x25.53071410.jpg",
+        "image_url_50x50" => "http://ny-image2.etsy.com/il_50x50.53071410.jpg"
+      },
+      "1" => {
+        "image_url_430xN" => "http://ny-image2.etsy.com/il_430xN.53071678.jpg",
+        "image_url_200x200" => "http://ny-image2.etsy.com/il_200x200.53071678.jpg",
+        "image_url_155x125" => "http://ny-image2.etsy.com/il_155x125.53071678.jpg",
+        "image_url_75x75" => "http://ny-image2.etsy.com/il_75x75.53071678.jpg",
+        "image_url_25x25" => "http://ny-image2.etsy.com/il_25x25.53071678.jpg",
+        "image_url_50x50" => "http://ny-image2.etsy.com/il_50x50.53071678.jpg"
+      },
+      "2" => {
+        "image_url_430xN" => "http://ny-image0.etsy.com/il_430xN.53498548.jpg",
+        "image_url_200x200" => "http://ny-image0.etsy.com/il_200x200.53498548.jpg",
+        "image_url_155x125" => "http://ny-image0.etsy.com/il_155x125.53498548.jpg",
+        "image_url_75x75" => "http://ny-image0.etsy.com/il_75x75.53498548.jpg",
+        "image_url_25x25" => "http://ny-image0.etsy.com/il_25x25.53498548.jpg",
+        "image_url_50x50" => "http://ny-image0.etsy.com/il_50x50.53498548.jpg"
+      },
+      "3" => {
+        "image_url_430xN" => "http://ny-image1.etsy.com/il_430xN.53498749.jpg",
+        "image_url_200x200" => "http://ny-image1.etsy.com/il_200x200.53498749.jpg",
+        "image_url_155x125" => "http://ny-image1.etsy.com/il_155x125.53498749.jpg",
+        "image_url_75x75" => "http://ny-image1.etsy.com/il_75x75.53498749.jpg",
+        "image_url_25x25" => "http://ny-image1.etsy.com/il_25x25.53498749.jpg",
+        "image_url_50x50" => "http://ny-image1.etsy.com/il_50x50.53498749.jpg"
+      }
+    }
+  end
+
+end  

data/tasks/rspec.rake

@@ -0,0 +1,33 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov (excluding plugin specs)"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "spec/spec.opts"]
+    t.spec_files = FileList['spec/**/*/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = lambda do
+      IO.readlines("spec/rcov.opts").map {|l| l.chomp.split " "}.flatten
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: tcocca-etsy4r
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tom Cocca
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-01 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Handcrafted API Wrapper for Etsy utilizing httparty
+email: tom.cocca@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- LICENSE
+- Rakefile
+- VERSION.yml
+- lib/etsy4r.rb
+- lib/etsy4r/client.rb
+- lib/etsy4r/commands.rb
+- lib/etsy4r/favorite_commands.rb
+- lib/etsy4r/gift_guide_commands.rb
+- lib/etsy4r/image_parser.rb
+- lib/etsy4r/response.rb
+- lib/etsy4r/server_commands.rb
+- lib/etsy4r/tag_commands.rb
+- lib/etsy4r/user_commands.rb
+- spec/rcov.opts
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/fixtures/images.html
+- spec/etsy4r/client_spec.rb
+- spec/etsy4r/commands_spec.rb
+- spec/etsy4r/favorite_commands_spec.rb
+- spec/etsy4r/gift_guide_commands_spec.rb
+- spec/etsy4r/image_parser_spec.rb
+- spec/etsy4r/server_commands_spec.rb
+- spec/etsy4r/tag_commands_spec.rb
+- spec/etsy4r/user_commands_spec.rb
+- tasks/rspec.rake
+- examples/etsy.rb
+has_rdoc: true
+homepage: http://github.com/tcocca/etsy4r
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Handcrafted API Wrapper
+test_files: []
+