etsy 0.3.0 → 0.3.4

data/lib/etsy/shipping_template.rb

@@ -19,7 +19,16 @@ module Etsy
       }
       get("/shipping/templates/#{id}", options)
     end
-
+    
+    def self.find_entries(id, credentials = {})
+      options = {
+        :access_token => credentials[:access_token],
+        :access_secret => credentials[:access_secret],
+        :require_secure => true
+      }
+      get("/shipping/templates/#{id}/entries", options)
+    end
+    
     def self.find_by_user(user, credentials = {})
       options = {
         :access_token => credentials[:access_token],

data/lib/etsy/shop.rb

@@ -30,6 +30,7 @@ module Etsy
     attribute :message, :from => :sale_message
     attribute :url, :from => :url
     attribute :favorers_count, :from => :num_favorers
+    attribute :icon_url, :from => 'icon_url_fullxfull'
 
     # Retrieve one or more shops by name or ID:
     #
@@ -75,6 +76,10 @@ module Etsy
       Section.find_by_shop(self)
     end
 
+    def about
+      About.find_by_shop(self)
+    end
+
     private
     def oauth
       oauth = (token && secret) ? {:access_token => token, :access_secret => secret} : {}

data/lib/etsy/transaction.rb

@@ -4,20 +4,70 @@ module Etsy
 
     attribute :id, :from => :transaction_id
     attribute :buyer_id, :from => :buyer_user_id
+    attribute :seller_id, :from => :seller_user_id
     attributes :quantity, :listing_id
 
+    attribute :created, :from => :creation_tsz
+    attribute :shipped, :from => :shipped_tsz
+    attribute :paid, :from => :paid_tsz
+
+    attributes :title, :description, :price, :currency_code, :quantity,
+               :tags, :materials, :image_listing_id, :receipt_id,
+               :is_digital, :file_data, :listing_id, :url, :product_data,
+               :variations, :transaction_type, :buyer_feedback_id,
+               :seller_feedback_id
+
+
     def self.find_all_by_shop_id(shop_id, options = {})
       get_all("/shops/#{shop_id}/transactions", options)
     end
 
+    def created_at
+      Time.at(created)
+    end
+
+    def shipped_at
+      Time.at(shipped)
+    end
+
+    def paid_at
+      Time.at(paid)
+    end
+
+    def self.find(*identifiers_and_options)
+      find_one_or_more('transactions', identifiers_and_options)
+    end
+
     #Find all Transactions by the buyer_id
     #
     def self.find_all_by_buyer_id(user_id, options = {})
       get_all("/users/#{user_id}/transactions", options)
     end
 
+    def self.find_all_by_listing_id(listing_id, options = {})
+      get_all("/listings/#{listing_id}/transactions", options)
+    end
+
+    def self.find_all_by_receipt_id(receipt_id, options = {})
+      get_all("/receipts/#{receipt_id}/transactions", options)
+    end
+
+    def receipt
+      @receipt ||= Receipt.find(receipt_id, oauth)
+    end
+
     def buyer
-      @buyer ||= User.find(buyer_id)
+      @buyer ||= User.find(buyer_id, oauth)
+    end
+
+    def listing
+      @listing ||= Listing.find(listing_id, oauth)
+    end
+
+    private
+
+    def oauth
+      oauth = (token && secret) ? {:access_token => token, :access_secret => secret} : {}
     end
 
   end

data/lib/etsy/user.rb

@@ -19,6 +19,8 @@ module Etsy
 
     association :profile, :from => 'Profile'
     association :shops, :from => 'Shops'
+    association :bill_charges, :from => 'BillCharges'
+    association :bill_payments, :from => 'BillPayments'
 
     # Retrieve one or more users by name or ID:
     #
@@ -81,6 +83,34 @@ module Etsy
       @shops
     end
 
+    def bill_charges
+      unless @bill_charges
+        if associated_bill_charges
+          @bill_charges = associated_bill_charges.map { |bill_charge| BillCharge.new(bill_charge) }
+        else
+          options = {:fields => 'user_id', :includes => 'BillCharges'}
+          options = options.merge(:access_token => token, :access_secret => secret) if (token && secret)
+          tmp = User.find(username, options)
+          @bill_charges = tmp.associated_bill_charges.map { |bill_charge| BillCharge.new(bill_charge) }
+        end
+      end
+      @bill_charges
+    end
+
+    def bill_payments
+      unless @bill_payments
+        if associated_bill_payments
+          @bill_payments = associated_bill_payments.map { |bill_payment| BillPayment.new(bill_payment) }
+        else
+          options = {:fields => 'user_id', :includes => 'BillPayments'}
+          options = options.merge(:access_token => token, :access_secret => secret) if (token && secret)
+          tmp = User.find(username, options)
+          @bill_payments = tmp.associated_bill_payments.map { |bill_payment| BillPayment.new(bill_payment) }
+        end
+      end
+      @bill_payments
+    end
+
     # Time that this user was created
     #
     def created_at

data/lib/etsy/variation/property_set.rb

@@ -0,0 +1,71 @@
+module Etsy
+  module Variation
+    class PropertySet
+      # Used to find properties which the seller can vary (eg Size, Color, etc), and options associated with those properties (eg Inches)
+      #
+      # The variations stuff is complex. See https://www.etsy.com/developers/documentation/getting_started/variations for more info.
+      #
+      # Probably the most useful method here is qualifying_properties_for_property. This method pulls in data from a few sources to get
+      # you everything you need to set up your variation options.
+      #
+      # Eg: I want to have a few Length options on my listings, and I want to use the unit Inches, then:
+      #   Etsy::Variation::PropertySet.qualifying_properties_for_property("Length")
+      #   => [{
+      #        "param"=>"sizing_scale",
+      #        "description"=>"Sizing Scale",
+      #        "options"=>{
+      #          "Alpha" => 301,
+      #          "Inches" => 327,
+      #          "Centimeters" => 328,
+      #          "Fluid Ounces" => 335,
+      #          "Millilitres" => 336,
+      #          "Litres" => 337,
+      #          "Other => 329
+      #        }
+      #      }]
+      #
+      #  This tells me I want to set the parameter sizing_scale to 327 when calling Etsy::Listing.add_variations.
+
+      include Etsy::Model
+
+
+      attributes :properties, :category_id, :options, :qualifiers,
+                 :qualifying_properties
+
+      def self.all
+        @all ||= get("/property_sets")
+      end
+
+      def self.find_property_by_name(name)
+        property = all.properties.detect {|prop_id, prop| prop["name"] == name}
+        if property
+          property_id, property_data = property
+          property_data
+        end
+      end
+
+      def self.qualifying_properties_for_property(name)
+        property = find_property_by_name(name)
+        return nil unless property
+        property_id = property["property_id"]
+
+        qualifiers = all.qualifiers[property_id.to_s]
+        return [] unless qualifiers
+
+        qualifiers.map do |qualifier|
+          qualifying_properties = all.qualifying_properties[qualifier.fetch("property_id").to_s]
+          options = qualifier.fetch("options").inject({}) do |acc, opt_id|
+            acc.merge({
+              all.options.fetch(opt_id.to_s) => opt_id
+            })
+          end
+          {
+            "param" => qualifying_properties.fetch("param"),
+            "description" => qualifying_properties.fetch("description"),
+            "options" => options
+          }
+        end
+      end
+    end
+  end
+end

data/lib/etsy/version.rb

@@ -1,3 +1,3 @@
 module Etsy
-  VERSION = "0.3.0"
+  VERSION = "0.3.4"
 end

data/lib/etsy.rb

@@ -15,8 +15,12 @@ require 'etsy/verification_request'
 require 'etsy/model'
 require 'etsy/user'
 require 'etsy/profile'
+require 'etsy/bill_charge'
+require 'etsy/bill_payment'
+require 'etsy/billing_overview'
 require 'etsy/shop'
 require 'etsy/listing'
+require 'etsy/attribute_value'
 require 'etsy/image'
 require 'etsy/transaction'
 require 'etsy/address'
@@ -24,9 +28,12 @@ require 'etsy/category'
 require 'etsy/payment_template'
 require 'etsy/country'
 require 'etsy/shipping_template'
+require 'etsy/shipping_info'
 require 'etsy/section'
 require 'etsy/favorite_listing'
 require 'etsy/receipt'
+require 'etsy/variation/property_set'
+require 'etsy/about'
 
 # = Etsy: A friendly Ruby interface to the Etsy API
 #
@@ -82,7 +89,7 @@ module Etsy
   def self.api_secret
     Thread.current[:etsy_api_secret] || @api_secret
   end
-  
+
   def self.api_secret=(secret)
     @api_secret ||= secret
     Thread.current[:etsy_api_secret] = secret
@@ -101,14 +108,14 @@ module Etsy
     @environment = environment
     @host = (environment == :sandbox) ? SANDBOX_HOST : PRODUCTION_HOST
   end
-  
+
   def self.protocol=(protocol)
     unless ["http", "https"].include?(protocol.to_s)
       raise(ArgumentError, "protocol must be set to either 'http' or 'https'")
     end
     @protocol = protocol.to_s
   end
-  
+
   # Allow throwing API errors
   #
   def self.silent_errors=(bool)

data/test/fixtures/about/getAbout.json

@@ -0,0 +1,16 @@
+{
+  "count":1,
+  "results":[
+    { "shop_id": 8740774,
+      "status": "active",
+      "story_headline": "A shop long in the making...",
+      "story_leading_paragraph": "This is the leading paragraph",
+      "story": "I grew up with strong women in my family who all had a love of creating. My mom and grandma always encouraged a lifelong love of creating  Working with glass, wire, and mineral components brings back my graduate school days, when I studied these items from a scientific point-of-view. Here's hoping I can create something that gives you a little sparkle in your life!",
+      "related_links": {
+        "link-0": {"title": "facebook", "url": "https://www.facebook.com/pebbleplusmetal/"},
+        "link-1": {"title": "pinterest", "url": "https://www.pinterest.com/PebblePlusMetal/pebble%2Bmetal/"}
+      },
+      "url": "https://www.etsy.com/shop/PebblePlusMetal/about"
+    }
+  ]
+}

data/test/fixtures/attribute_value/findAllListingPropertyValues.json

@@ -0,0 +1,44 @@
+
+{
+  "count":4,
+  "results":
+  [
+    {
+      "property_id": 200,
+      "property_name": "Primary color",
+      "scale_id": null,
+      "scale_name": null,
+      "value_ids": [1213],
+      "values": ["Beige"]
+    },
+    {
+      "property_id": 52047899002,
+      "property_name": "Secondary color",
+      "scale_id": null,
+      "scale_name": null,
+      "value_ids": [1],
+      "values": ["Black"]
+    },
+    {
+      "property_id": 47626759834,
+      "property_name": "Height",
+      "scale_id": 5,
+      "scale_name": "Inches",
+      "value_ids": [0],
+      "values": ["15"]
+    },
+    {
+      "property_id": 47626759898,
+      "property_name": "Width",
+      "scale_id": 5,
+      "scale_name": "Inches",
+      "value_ids": [0],
+      "values": ["25"]
+    }
+  ],
+  "params":
+  {
+    "listing_id":"59495892"
+  },
+  "type":"ListingPropertyValue"
+}

data/test/fixtures/bill_charge/getBillCharge.json

@@ -0,0 +1 @@
+{"count":1,"results":[{"bill_charge_id":212,"type":"listing_id","type_id":14888443,"amount":"3.00"}],"params":{"user_id":"212"},"type":"BillCharge","pagination":{}}

data/test/fixtures/bill_payment/getBillPayment.json

@@ -0,0 +1 @@
+{"count":1,"results":[{"bill_payment_id":212,"type":"listing_id","type_id":14888443,"amount":"3.00"}],"params":{"user_id":"212"},"type":"BillPayment","pagination":{}}

data/test/fixtures/billing_overview/getBillingOverview.json

@@ -0,0 +1 @@
+{"count":1,"results":[{"total_balance":1399,"balance_due":999}],"params":{"user_id":"212"},"type":"BillingOverview","pagination":{}}

data/test/fixtures/listing/findAllShopListings.json

@@ -23,7 +23,8 @@
         "brightness": 100,
         "is_black_and_white": false,
         "url": "http://www.etsy.com/listing/59495892/initials-carved-into-tree-love-stamp",
-        "views": 37
+        "views": 37,
+        "is_supply": "false"
     },
     {
         "listing_id": 59495804,
@@ -48,7 +49,8 @@
         "brightness": 100,
         "is_black_and_white": false,
         "url": "http://www.etsy.com/listing/59495804/faux-bois-heart-hand-carved-stamp",
-        "views": 78
+        "views": 78,
+        "is_supply": "true"
     }],
     "params": {
         "limit": "2",
@@ -66,4 +68,4 @@
         "category": null
     },
     "type": "Listing"
-}
+}

data/test/fixtures/listing/getListing.single.includeImages.json

@@ -0,0 +1 @@
+{"count":1,"results":[{"listing_id":59759273,"state":"active","user_id":7301949,"title":"Vinyl Wall Art Decal -- Multi-colored Flowers Set","description":"The listing is for a beautiful set of multi-colored flowers, colors as shown in the picture.\r\n\r\nExclusive design only from OrqueShaw's walldecors! you won't find this anywhere else on etsy!\r\n\r\nHeights of the 4 large flowers: 52in\/37in\/29in\/26in.\r\n\r\nAll of our decals are computer die-cut, there are no "edges" nor "backgrounds", all you will get is the lovely image! and after applying they will look like they are stenciled on with paint!\r\n\r\nuggested install areas: Walls, Mirrors, Metals, Woods, Plastic...Lightly textured surfaces would be just fine! \r\n\r\n\r\n\r\n\r\nABOUT US AND OUR BEAUTIFUL DECALS:\r\n\r\nWe want to transform your walls....and your lives.\r\nDid you know that you can save literally hundreds of dollars designing your own interior space? Seriously, got bored of painting walls,using stencils, applying borders, and putting up wallpapers?? Using our super convenient n' simply gorgeous wall art decals is a very cool and a great way to make a room shine (or to change a room) w\/out damaging your walls or the bank! great alternative to wall paper or a head board, and without any of the mess and hassle involved with painting. Especially nice if you rent and cannot paint your walls, You can even take your wall decals to work and redesign your office or cubical. Easy to apply even for the creative or somewhat domestically challenged . We carry a variety of colors, styles and themes which you could use to decorate every room for anyone in the family!\r\n\r\nOur wall art decals are hand made, they are easy and fun to install.These wall stickers affix on most smooth surfaces and can be removed without leaving any residues. Complete and simple step-by-step instructions are included with your order. \r\n\r\n\r\nSHIPPING:\r\n\r\n*We combine shipping for multiple purchases!\r\n\r\n*Orders usually ship within 2 business days after the clear of payment. \r\n\r\n*All of our shipments are packed in 3 ply spiral wound mailing tubes to ensure the maximum protection during deliveries.\r\n\r\n*Shipping rates: $9.75 for US and Canada $16.75 for other countries.\r\n\r\n*2-7 business days for shipping in Canada, 6-12 business days for shipping to US and other countries, we are not responsible for the delays caused by the custom clearance.\r\n\r\n*Faster delivery options are available upon request.\r\n\r\n*We ship worldwide except the following places: Africa, China, South & North Korea, Italy, Republic Of Serbia, Turkmenistan and Republic Of Montenegro.\r\n\r\n\r\nPAYMENT:\r\n\r\n*Please remit payment within 3 days. Your product will not be shipped until payment is received. Thank you!\r\n\r\n*If you are not 100% satisfied with your purchase, please return the item in its original condition(unopened) within 30 days of delivery of your shipment. Please note that we cannot accept the returns of opened items or items returned more than 30 days past delivery, shipping cost is not refundable and buyers are responsible for the return shipping fees at any case. \r\n","creation_tsz":1288738828,"ending_tsz":1299042000,"original_creation_tsz":1287867280,"last_modified_tsz":1288738828,"price":"42.00","currency_code":"USD","quantity":1,"tags":["children","wallpaper_graphic","nursery_playroom","red_orange_pink","green_lime_color","furniture","office_room","bedroom_bathroom","nature_garden","girl_boy_baby","everything_else","cheersandtears","front_page","soft_colors"],"materials":["self_adhesive_vinyl","decal_transfer_paper"],"shop_section_id":6489554,"featured_rank":null,"state_tsz":1288738828,"hue":0,"saturation":0,"brightness":100,"is_black_and_white":false,"url":"http:\/\/www.etsy.com\/listing\/59759273\/vinyl-wall-art-decal-multi-colored","views":178,"num_favorers":5,"Images":[{"listing_image_id":1132761, "hex_code":"6B6868", "red":107, "green":104, "blue":104, "hue":0, "saturation":2, "brightness":41, "is_black_and_white":false, "creation_tsz":1485797197, "listing_id":59759273, "rank":1, "url_75x75":"https://img0.etsystatic.com/176/0/12065520/il_75x75.1132761110_kggi.jpg", "url_170x135":"https://img0.etsystatic.com/176/0/12065520/il_170x135.1132761110_kggi.jpg", "url_570xN":"https://img0.etsystatic.com/176/0/12065520/il_570xN.1132761110_kggi.jpg", "url_fullxfull":"https://img0.etsystatic.com/176/0/12065520/il_fullxfull.1132761110_kggi.jpg", "full_height":540, "full_width":720}, {"listing_image_id":1179359, "hex_code":"6E6A6B", "red":110, "green":106, "blue":107, "hue":345, "saturation":3, "brightness":43, "is_black_and_white":false, "creation_tsz":1485797197, "listing_id":59759273, "rank":2, "url_75x75":"https://img1.etsystatic.com/155/0/12065520/il_75x75.1179359629_mhmc.jpg", "url_170x135":"https://img1.etsystatic.com/155/0/12065520/il_170x135.1179359629_mhmc.jpg", "url_570xN":"https://img1.etsystatic.com/155/0/12065520/il_570xN.1179359629_mhmc.jpg", "url_fullxfull":"https://img1.etsystatic.com/155/0/12065520/il_fullxfull.1179359629_mhmc.jpg", "full_height":540, "full_width":720}, {"listing_image_id":1179359, "hex_code":"6C6869", "red":108, "green":104, "blue":105, "hue":345, "saturation":3, "brightness":42, "is_black_and_white":false, "creation_tsz":1485797197, "listing_id":59759273, "rank":3, "url_75x75":"https://img1.etsystatic.com/144/0/12065520/il_75x75.1179359767_d5qd.jpg", "url_170x135":"https://img1.etsystatic.com/144/0/12065520/il_170x135.1179359767_d5qd.jpg", "url_570xN":"https://img1.etsystatic.com/144/0/12065520/il_570xN.1179359767_d5qd.jpg", "url_fullxfull":"https://img1.etsystatic.com/144/0/12065520/il_fullxfull.1179359767_d5qd.jpg", "full_height":540, "full_width":720}, {"listing_image_id":1132761, "hex_code":"6D6A6B", "red":109, "green":106, "blue":107, "hue":340, "saturation":2, "brightness":42, "is_black_and_white":false, "creation_tsz":1485797197, "listing_id":59759273, "rank":4, "url_75x75":"https://img0.etsystatic.com/169/0/12065520/il_75x75.1132761176_n7b7.jpg", "url_170x135":"https://img0.etsystatic.com/169/0/12065520/il_170x135.1132761176_n7b7.jpg", "url_570xN":"https://img0.etsystatic.com/169/0/12065520/il_570xN.1132761176_n7b7.jpg", "url_fullxfull":"https://img0.etsystatic.com/169/0/12065520/il_fullxfull.1132761176_n7b7.jpg", "full_height":540, "full_width":720}, {"listing_image_id":1179359, "hex_code":"6B6868", "red":107, "green":104, "blue":104, "hue":0, "saturation":2, "brightness":41, "is_black_and_white":false, "creation_tsz":1485797197, "listing_id":59759273, "rank":5, "url_75x75":"https://img1.etsystatic.com/169/0/12065520/il_75x75.1179359817_215n.jpg", "url_170x135":"https://img1.etsystatic.com/169/0/12065520/il_170x135.1179359817_215n.jpg", "url_570xN":"https://img1.etsystatic.com/169/0/12065520/il_570xN.1179359817_215n.jpg", "url_fullxfull":"https://img1.etsystatic.com/169/0/12065520/il_fullxfull.1179359817_215n.jpg", "full_height":540, "full_width":720}]}],"params":{"listing_id":"59759273", "includes":"Images"},"type":"Listing"}

data/test/fixtures/receipt/findAllShopReceipts.json

@@ -1,11 +1,11 @@
-{ 
+{
   "count":1,
   "results":
     [
       {
         "receipt_id":27230877,
         "buyer_user_id":12345,
-        "created_tsz":1412206858,
+        "creation_tsz":1412206858,
         "quantity":5,
         "listing_id":123456,
         "name":"Mike Taylor",
@@ -19,10 +19,10 @@
         "buyer_email":"bar@example.com"
       }
     ],
-  "params": { 
+  "params": {
               "shop_id":"5818087",
               "limit":25,
               "offset":0
             },
   "type":"Receipt"
-}
+}

data/test/fixtures/shipping_info/getShippingInfo.json

@@ -0,0 +1 @@
+{"count":1,"results":[{"shipping_info_id":212,"primary_cost":"$9.99","listing_id":14888443}],"params":{"shipping_template_id":"212"},"type":"ShippingTemplate","pagination":{}}