etsy 0.1.0

data/lib/etsy/response.rb

@@ -0,0 +1,30 @@
+module Etsy
+  
+  # = Response
+  # 
+  # Basic wrapper around the Etsy JSON response data
+  #
+  class Response
+    
+    # Create a new response based on the raw JSON
+    def initialize(data)
+      @data = data
+    end
+    
+    # Convert the raw JSON data to a hash
+    def to_hash
+      @hash ||= JSON.parse(@data)
+    end
+    
+    # Number of records in the response results
+    def count
+      to_hash['count']
+    end
+    
+    # Results of the API request
+    def result
+      count == 1 ? to_hash['results'].first : to_hash['results']
+    end
+    
+  end
+end

data/lib/etsy/shop.rb

@@ -0,0 +1,50 @@
+module Etsy
+  
+  # = Shop
+  #
+  # Represents a single Etsy shop.  Users may or may not have an associated shop - 
+  # check the result of User#seller? to find out.
+  #
+  # A shop has the following attributes:
+  #
+  # [name] The shop's name
+  # [title] A brief heading for the shop's main page
+  # [announcement] An announcement to buyers (displays on the shop's home page)
+  # [message] The message sent to users who buy from this shop
+  # [banner_image_url] The full URL to the shops's banner image
+  # [listing_count] The total number of active listings contained in this shop
+  #
+  class Shop
+    
+    include Etsy::Model
+
+    finder :one, '/shops/:user_id'
+    
+    attribute :name, :from => :shop_name
+    attribute :updated, :from => :last_updated_epoch
+    attribute :created, :from => :creation_epoch
+    attribute :message, :from => :sale_message
+
+    attributes :banner_image_url, :listing_count, :title, :announcement, :user_id
+   
+    # Time that this shop was created
+    #
+    def created_at
+      Time.at(created)
+    end
+    
+    # Time that this shop was last updated
+    #
+    def updated_at
+      Time.at(updated)
+    end
+    
+    # A collection of listings in this user's shop. See Etsy::Listing for
+    # more information
+    #
+    def listings
+      Listing.find_all_by_user_id(user_id)
+    end
+    
+  end
+end

data/lib/etsy/user.rb

@@ -0,0 +1,54 @@
+module Etsy
+  
+  # = User
+  #
+  # Represents a single Etsy user - has the following attributes:
+  #
+  # [id] The unique identifier for this user
+  # [username] This user's username
+  # [url] The full URL to this user's profile page / shop (if seller)
+  # [city] The user's city / state (optional)
+  # [gender] The user's gender
+  # [bio] User's biography
+  #
+  class User
+    
+    include Etsy::Model
+    
+    finder :one, '/users/:username'
+    
+    attribute :username, :from => :user_name
+    attribute :id, :from => :user_id
+    attribute :joined, :from => :join_epoch
+    attribute :seller, :from => :is_seller
+    attribute :last_login, :from => :last_login_epoch
+
+    attributes :url, :city, :gender, :bio
+    
+    # This user's shop, returns nil if user is not a seller. See Etsy::Shop
+    # for more information.
+    #
+    def shop
+      Shop.find_by_user_id(id) if seller?
+    end
+    
+    # Is this user a seller?
+    #
+    def seller?
+      seller
+    end
+    
+    # Time that this user joined the site
+    #
+    def joined_at
+      Time.at(joined)
+    end
+    
+    # Time that this user last logged in
+    #
+    def last_login_at
+      Time.at(last_login)
+    end
+    
+  end
+end

data/lib/etsy/version.rb

@@ -0,0 +1,13 @@
+module Etsy
+  module Version
+    
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+    
+    def self.to_s # :nodoc:
+      [MAJOR, MINOR, TINY].join('.')
+    end
+    
+  end
+end

data/test/fixtures/getShopDetails.json

@@ -0,0 +1,70 @@
+{
+    "count": 1,
+    "results": [{
+        "user_name": "littletjane",
+        "user_id": 5327518,
+        "url": "http:\/\/www.etsy.com\/shop.php?user_id=5327518",
+        "image_url_25x25": "http:\/\/ny-image3.etsy.com\/iusa_25x25.5874999.jpg",
+        "image_url_30x30": "http:\/\/ny-image3.etsy.com\/iusa_30x30.5874999.jpg",
+        "image_url_50x50": "http:\/\/ny-image3.etsy.com\/iusa_50x50.5874999.jpg",
+        "image_url_75x75": "http:\/\/ny-image3.etsy.com\/iusa_75x75.5874999.jpg",
+        "join_epoch": 1191381757.93,
+        "city": "Washington, DC",
+        "gender": "female",
+        "lat": null,
+        "lon": null,
+        "transaction_buy_count": 199,
+        "transaction_sold_count": 0,
+        "is_seller": true,
+        "was_featured_seller": false,
+        "materials": ["paper", "pen_and_pencil", "crayon_and_coloring_books", "ink_and_stamps", "collage", "decoupage_medium", "paint_and_canvas", "stickers", "magnets", "fabric_and_plush", "toys", "vintage_and_found_objects", "ecofriendly_and_recycled_goods"],
+        "last_login_epoch": 1239797927.39,
+        "feedback_count": "171",
+        "feedback_percent_positive": "100",
+        "referred_user_count": 1,
+        "birth_day": "20",
+        "birth_month": "3",
+        "bio": "hello! :D \r\n\r\n:about me:\r\n\r\nBA, dance \r\ncertified massage therapist\r\nwife & stay-at-home mama to 3 little ones\r\n\r\n:love love love:\r\n\r\nmy family\r\nmy children's drawings\r\nmy dear friends\r\nmusic \r\ndance!\r\nyoga\r\narts & craftiness...etsy!\r\nbaking\r\nmy mac\r\ndreaming\r\nlaughing\r\nplaying\r\nreading\r\ncute happy things\r\n=^..^=\r\n\r\nhttp:\/\/littletjane.com\r\nplease say hi!\r\n\r\ni'm flip...hip...zappy zowie zip!",
+        "banner_image_url": "http:\/\/ny-image0.etsy.com\/iusb_760x100.6158980.jpg",
+        "last_updated_epoch": 1239717723.36,
+        "creation_epoch": 1237430331.15,
+        "listing_count": 13,
+        "shop_name": "littletjane",
+        "title": "title text",
+        "sale_message": "message text",
+        "announcement": "announcement text",
+        "is_vacation": "",
+        "vacation_message": "",
+        "currency_code": "USD",
+        "policy_welcome": "oh hi! i'm so glad you've come by my shop! thank you so much for swinging in and taking a peek around :D\r\n\r\nwell, here are the 'ol policy-os. please do read carefully:",
+        "policy_payment": "payment method accepted: \r\npaypal (hooray!)\r\n\r\nterms: \r\nsubmit payment promptly. payment is due 3 days after purchase of the item. \r\n\r\nupon receipt of payment, the order will be shipped within 1 week.",
+        "policy_shipping": "method: usps first-class mail.\r\n \r\nplease feel free to contact me for rates on expedited shipping. \r\n\r\ni am not responsible for taxes or duties for your country.",
+        "policy_refunds": "oh help!\r\nif you are not happy with your item, please let me know. we can work this out! i will try my best to replace the item or refund your money, as the goal of my shop is to create and share in crafty happiness. right on!",
+        "policy_additional": "ok. well, that's about it! mostly, just be good, nice, honest, and fair, and this will return to you tenfold.\r\n\r\nif you have any questions, please don't hesitate to ask me.\r\n\r\nthanks a bunch, you! cheers!",
+        "sections": [{
+            "section_id": 6008529,
+            "title": "matchboxes",
+            "listing_count": 3
+        },
+        {
+            "section_id": 6008530,
+            "title": "original paintings",
+            "listing_count": 3
+        },
+        {
+            "section_id": 6059955,
+            "title": "sachets",
+            "listing_count": 5
+        },
+        {
+            "section_id": 6061498,
+            "title": "hand carved stamps",
+            "listing_count": 2
+        }]
+    }],
+    "params": {
+        "user_id": 5327518,
+        "detail_level": "high"
+    },
+    "type": "shop"
+}

data/test/fixtures/getShopListings.json

@@ -0,0 +1,135 @@
+{
+    "count": 2,
+    "results": [{
+        "listing_id": 24165902,
+        "state": "active",
+        "title": "hanging with the bad boys matchbox",
+        "url": "http:\/\/www.etsy.com\/view_listing.php?listing_id=24165902",
+        "image_url_25x25": "http:\/\/ny-image2.etsy.com\/il_25x25.67765346.jpg",
+        "image_url_50x50": "http:\/\/ny-image2.etsy.com\/il_50x50.67765346.jpg",
+        "image_url_75x75": "http:\/\/ny-image2.etsy.com\/il_75x75.67765346.jpg",
+        "image_url_155x125": "http:\/\/ny-image2.etsy.com\/il_155x125.67765346.jpg",
+        "image_url_200x200": "http:\/\/ny-image2.etsy.com\/il_200x200.67765346.jpg",
+        "image_url_430xN": "http:\/\/ny-image2.etsy.com\/il_430xN.67765346.jpg",
+        "creation_epoch": 1240673494.49,
+        "views": 18,
+        "tags": ["accessories", "matchbox"],
+        "materials": ["standard_matchbox", "notebook_paper"],
+        "price": 3,
+        "currency_code": "USD",
+        "ending_epoch": 1251214294.49,
+        "hsv_color": "0;0;100",
+        "rgb_color": "#FFFFFF",
+        "user_id": 5327518,
+        "user_name": "littletjane",
+        "quantity": 1,
+        "description": "standard size matchbox ...",
+        "section_id": 6008529,
+        "section_title": "matchboxes",
+        "lat": null,
+        "lon": null,
+        "user_image_id": 5874999,
+        "city": "Washington, DC",
+        "all_images": [{
+            "image_url_25x25": "http:\/\/ny-image2.etsy.com\/il_25x25.67765346.jpg",
+            "image_url_50x50": "http:\/\/ny-image2.etsy.com\/il_50x50.67765346.jpg",
+            "image_url_75x75": "http:\/\/ny-image2.etsy.com\/il_75x75.67765346.jpg",
+            "image_url_155x125": "http:\/\/ny-image2.etsy.com\/il_155x125.67765346.jpg",
+            "image_url_200x200": "http:\/\/ny-image2.etsy.com\/il_200x200.67765346.jpg",
+            "image_url_430xN": "http:\/\/ny-image2.etsy.com\/il_430xN.67765346.jpg",
+            "hsv_color": "0;0;100",
+            "rgb_color": "#FFFFFF"
+        },
+        {
+            "image_url_25x25": "http:\/\/ny-image2.etsy.com\/il_25x25.67765298.jpg",
+            "image_url_50x50": "http:\/\/ny-image2.etsy.com\/il_50x50.67765298.jpg",
+            "image_url_75x75": "http:\/\/ny-image2.etsy.com\/il_75x75.67765298.jpg",
+            "image_url_155x125": "http:\/\/ny-image2.etsy.com\/il_155x125.67765298.jpg",
+            "image_url_200x200": "http:\/\/ny-image2.etsy.com\/il_200x200.67765298.jpg",
+            "image_url_430xN": "http:\/\/ny-image2.etsy.com\/il_430xN.67765298.jpg",
+            "hsv_color": "0;0;100",
+            "rgb_color": "#FFFFFF"
+        }]
+    },
+    {
+        "listing_id": 23555714,
+        "state": "active",
+        "title": "little t jane head hand carved stamp",
+        "url": "http:\/\/www.etsy.com\/view_listing.php?listing_id=23555714",
+        "image_url_25x25": "http:\/\/ny-image1.etsy.com\/il_25x25.65719221.jpg",
+        "image_url_50x50": "http:\/\/ny-image1.etsy.com\/il_50x50.65719221.jpg",
+        "image_url_75x75": "http:\/\/ny-image1.etsy.com\/il_75x75.65719221.jpg",
+        "image_url_155x125": "http:\/\/ny-image1.etsy.com\/il_155x125.65719221.jpg",
+        "image_url_200x200": "http:\/\/ny-image1.etsy.com\/il_200x200.65719221.jpg",
+        "image_url_430xN": "http:\/\/ny-image1.etsy.com\/il_430xN.65719221.jpg",
+        "creation_epoch": 1239482599.57,
+        "views": 42,
+        "tags": ["supplies", "handmade", "handcarved", "rubber_stamp", "embellishment", "scrapbooking", "ink", "paper_goods", "illustration", "happy", "smile", "littletjane", "cute", "funny"],
+        "materials": ["lino_cutters", "speedball_speedy_carve_block", "xacto_knife", "tracing_papers", "pencil", "ink", "wood", "foam_mounting_medium"],
+        "price": 7,
+        "currency_code": "USD",
+        "ending_epoch": 1250023399.57,
+        "hsv_color": "0;0;100",
+        "rgb_color": "#FFFFFF",
+        "user_id": 5327518,
+        "user_name": "littletjane",
+        "quantity": 1,
+        "description": "why, hello! a happy little head to stamp on all your papers.\r\n\r\nhand carved stamp lovingly carved on a highly durable, pink color eraser-like material that will not crack or crumble.\r\n\r\nfoam mounted on an approx. 1 x 1 inch wooden square. \r\n\r\n",
+        "section_id": 6061498,
+        "section_title": "hand carved stamps",
+        "lat": null,
+        "lon": null,
+        "user_image_id": 5874999,
+        "city": "Washington, DC",
+        "all_images": [{
+            "image_url_25x25": "http:\/\/ny-image1.etsy.com\/il_25x25.65719221.jpg",
+            "image_url_50x50": "http:\/\/ny-image1.etsy.com\/il_50x50.65719221.jpg",
+            "image_url_75x75": "http:\/\/ny-image1.etsy.com\/il_75x75.65719221.jpg",
+            "image_url_155x125": "http:\/\/ny-image1.etsy.com\/il_155x125.65719221.jpg",
+            "image_url_200x200": "http:\/\/ny-image1.etsy.com\/il_200x200.65719221.jpg",
+            "image_url_430xN": "http:\/\/ny-image1.etsy.com\/il_430xN.65719221.jpg",
+            "hsv_color": "0;0;100",
+            "rgb_color": "#FFFFFF"
+        },
+        {
+            "image_url_25x25": "http:\/\/ny-image1.etsy.com\/il_25x25.65719189.jpg",
+            "image_url_50x50": "http:\/\/ny-image1.etsy.com\/il_50x50.65719189.jpg",
+            "image_url_75x75": "http:\/\/ny-image1.etsy.com\/il_75x75.65719189.jpg",
+            "image_url_155x125": "http:\/\/ny-image1.etsy.com\/il_155x125.65719189.jpg",
+            "image_url_200x200": "http:\/\/ny-image1.etsy.com\/il_200x200.65719189.jpg",
+            "image_url_430xN": "http:\/\/ny-image1.etsy.com\/il_430xN.65719189.jpg",
+            "hsv_color": "0;0;100",
+            "rgb_color": "#FFFFFF"
+        },
+        {
+            "image_url_25x25": "http:\/\/ny-image1.etsy.com\/il_25x25.65719273.jpg",
+            "image_url_50x50": "http:\/\/ny-image1.etsy.com\/il_50x50.65719273.jpg",
+            "image_url_75x75": "http:\/\/ny-image1.etsy.com\/il_75x75.65719273.jpg",
+            "image_url_155x125": "http:\/\/ny-image1.etsy.com\/il_155x125.65719273.jpg",
+            "image_url_200x200": "http:\/\/ny-image1.etsy.com\/il_200x200.65719273.jpg",
+            "image_url_430xN": "http:\/\/ny-image1.etsy.com\/il_430xN.65719273.jpg",
+            "hsv_color": "0;0;100",
+            "rgb_color": "#FFFFFF"
+        },
+        {
+            "image_url_25x25": "http:\/\/ny-image0.etsy.com\/il_25x25.65719252.jpg",
+            "image_url_50x50": "http:\/\/ny-image0.etsy.com\/il_50x50.65719252.jpg",
+            "image_url_75x75": "http:\/\/ny-image0.etsy.com\/il_75x75.65719252.jpg",
+            "image_url_155x125": "http:\/\/ny-image0.etsy.com\/il_155x125.65719252.jpg",
+            "image_url_200x200": "http:\/\/ny-image0.etsy.com\/il_200x200.65719252.jpg",
+            "image_url_430xN": "http:\/\/ny-image0.etsy.com\/il_430xN.65719252.jpg",
+            "hsv_color": "0;0;100",
+            "rgb_color": "#FFFFFF"
+        }]
+    }],
+    "params": {
+        "user_id": 5327518,
+        "sort_on": "created",
+        "sort_order": "down",
+        "section_id": null,
+        "offset": 0,
+        "limit": 10,
+        "detail_level": "high"
+    },
+    "type": "listing"
+}

data/test/fixtures/getUserDetails.json

@@ -0,0 +1,34 @@
+{
+    "count": 1,
+    "results": [{
+        "user_name": "littletjane",
+        "user_id": 5327518,
+        "url": "http:\/\/www.etsy.com\/shop.php?user_id=5327518",
+        "image_url_25x25": "http:\/\/ny-image3.etsy.com\/iusa_25x25.5874999.jpg",
+        "image_url_30x30": "http:\/\/ny-image3.etsy.com\/iusa_30x30.5874999.jpg",
+        "image_url_50x50": "http:\/\/ny-image3.etsy.com\/iusa_50x50.5874999.jpg",
+        "image_url_75x75": "http:\/\/ny-image3.etsy.com\/iusa_75x75.5874999.jpg",
+        "join_epoch": 1191381757.93,
+        "city": "Washington, DC",
+        "gender": "female",
+        "lat": null,
+        "lon": null,
+        "transaction_buy_count": 199,
+        "transaction_sold_count": 0,
+        "is_seller": true,
+        "was_featured_seller": false,
+        "materials": ["paper", "pen_and_pencil", "crayon_and_coloring_books", "ink_and_stamps", "collage", "decoupage_medium", "paint_and_canvas", "stickers", "magnets", "fabric_and_plush", "toys", "vintage_and_found_objects", "ecofriendly_and_recycled_goods"],
+        "last_login_epoch": 1239797927.39,
+        "feedback_count": "171",
+        "feedback_percent_positive": "100",
+        "referred_user_count": 1,
+        "birth_day": "20",
+        "birth_month": "3",
+        "bio": "hello!"
+    }],
+    "params": {
+        "user_id": 5327518,
+        "detail_level": "high"
+    },
+    "type": "user"
+}

data/test/test_helper.rb

@@ -0,0 +1,54 @@
+# http://sneaq.net/textmate-wtf
+$:.reject! { |e| e.include? 'TextMate' }
+
+require 'rubygems'
+require 'throat_punch'
+
+require File.dirname(__FILE__) + '/../lib/etsy'
+
+class Test::Unit::TestCase
+  
+  def self.read_fixture(method_name)
+    file = File.dirname(__FILE__) + "/fixtures/#{method_name}.json"
+    JSON.parse(File.read(file))['results']
+  end
+  
+  def read_fixture(method_name)
+    self.class.read_fixture(method_name)
+  end
+  
+  def mock_request_cycle(options)
+    response = Etsy::Response.new(stub())
+    
+    data = read_fixture(options[:data])
+    data = data.first if data.size == 1
+    
+    response.stubs(:result).with().returns(data)
+    
+    Etsy::Request.stubs(:get).with(options[:for]).returns(response)
+    
+    response
+  end
+  
+  def self.when_populating(klass, options, &block)
+    data = options[:from].is_a?(String) ? read_fixture(options[:from])[0] : options[:from].call
+    
+    class_eval do
+      define_method "setup_for_population" do
+        @object = klass.new(data)
+      end
+    end
+    
+    block.call
+  end
+
+  def self.value_for(method_name, options)
+    class_eval do
+      it "should have a value for :#{method_name}" do
+        setup_for_population
+        @object.send(method_name).should == options[:is]
+      end
+    end
+  end
+  
+end