etsy 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63b1728090ce087c6421fdb354545b5031206bdd
-  data.tar.gz: 720fd11d6f39fe99e5f414e54155db73c2bedce3
+  metadata.gz: dd7112229ce87257b5ea66ca6eddafe82d07bacc
+  data.tar.gz: e8f34ab7f54ee0675a26d387c77b337ca10ec2db
 SHA512:
-  metadata.gz: 2c7a7b67c5bb186cecfe0a61000dd6b2a6258d5e4bd915c67672e40d949af76d7c083bfd54ec7e96c7d0396665562c389deafd3a1422ca21e6a4553a47a1f5aa
-  data.tar.gz: 60c5ad5ef28a7f5104ffcbb9e6df25f292ab31292725e9a45dddfe8fe62a93ac22ce1d0ea22d18c98db91e37b7d66e4bbc676ad6d7f422a339b86b878edc7eb7
+  metadata.gz: ad057b670ae67786f6c4093218dfb615ede31d5c005b8e19c753f3a776fcb1b77e0cf3e1dbf5f7227ad303ab6320ae7d5c4d014be48684d2c8490279e1992a73
+  data.tar.gz: 50108ef28fcd663125db0787a1127d6a5ee8587f5b1c35cf7aee4776f6f503fb2995af90a595d8f1577b8a4e228c02c06adce626e45fa468629f49c395423f1c

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 rvm:
-  - 1.8.7
   - 1.9.3
-  - jruby-18mode
   - jruby-19mode
   - rbx-2
+  - 2.1.5

data/README.md

@@ -26,6 +26,32 @@ It will likely work with higher versions, but this is unproven.
 
 ## Usage
 
+In order to try this out you'll need to create an app on [etsy.com/your/apps](https://www.etsy.com/your/apps).
+
+This will give you an api key and secret.
+
+Paste the following into IRB, replacing the api key and secret with the ones you got on Etsy:
+
+```ruby
+require 'etsy'
+Etsy.protocol = "https"
+Etsy.api_key = 'YOUR API KEY'
+Etsy.api_secret = 'YOUR SECRET'
+request = Etsy.request_token
+Etsy.verification_url
+```
+
+Paste the verification URL into your browser, and authorize the application. That will give you a page
+with a code on it. Paste the following into IRB, replacing the code:
+
+```ruby
+access = Etsy.access_token(request.token, request.secret, 'CODE')
+Etsy.myself(access.token, access.secret)
+```
+
+If you've received a 401 unauthorized error, then you likely don't have a valid api key and secret, or
+perhaps the verification url timed out.
+
 ### Public Mode
 
 The Etsy API has two modes: public, and authenticated. Public mode only requires an
@@ -67,6 +93,11 @@ Authenticated calls can now be made by passing an access token and secret:
 
     Etsy.myself(access.token, access.secret)
 
+The key and secret have to be passed in for the authenticated calls.
+    
+    auth = {:access_token=>access.token, :access_secret=>access.secret}
+    Etsy::Transaction.find_all_by_shop_id(shop_id, auth.merge(options))
+
 ### Web Application
 
 The process for authenticating via a web application is similar, but requires the configuration of a callback URL:
@@ -278,16 +309,28 @@ I ask that you not submit patches that include changes to the version or gemspec
 These people have helped make the Etsy gem what it is today:
 
 * [Patrick Reagan](https://github.com/reagent)
-* [Katrina Owen](http://github.com/kytrinyx)
+* [Katrina Owen](https://github.com/kytrinyx)
+* [Trae Robrock](https://github.com/trobrock)
+* [Roger Smith](https://github.com/rogsmith)
+* [Jimmy Tang](https://github.com/jimmytang)
 * [Mak Nazečić-Andrlon](https://github.com/Muon)
+* [Daniel Szmulewicz](https://github.com/danielsz)
 * [Patrick Schless](https://github.com/plainlystated)
+* [Martin Popelak](https://github.com/pupca)
+* [Julio Santos](https://github.com/julio)
 * [Matt Fields](https://github.com/mfields106)
+* [Mike Taylor](https://github.com/sealabcore)
+* [Mason Stewart](https://github.com/masondesu)
+* [Sasha Gerrand](https://github.com/sgerrand)
 * [Jake Boxer](https://github.com/jakeboxer)
-* [Trae Robrock](https://github.com/trobrock)
-* [Jimmy Tang](https://github.com/jimmytang)
-* [Julio Santos](https://github.com/julio)
-* [Roger Smith](https://github.com/rogsmith)
-* [Daniel Szmulewicz](https://github.com/danielsz)
+* [Sunwoo Yang](https://github.com/sunwooz)
+* [Isaac Rosenberg](https://github.com/irosenb)
+* [Carson Gross](https://github.com/carsongross)
+* [John Amicangelo](https://github.com/JohnAmican)
+* [Max Gulyaev](https://github.com/maxilev)
+* [fbehrens](https://github.com/fbehrens)
+* [William Jeffries](https://github.com/williamcodes)
+* [Jack Guoyuan Zhao](https://github.com/zhaoguoyuan)
 
 ### Github Flow
 

data/lib/etsy.rb

@@ -27,6 +27,7 @@ require 'etsy/shipping_template'
 require 'etsy/section'
 require 'etsy/favorite_listing'
 require 'etsy/receipt'
+require 'etsy/variation/property_set'
 
 # = Etsy: A friendly Ruby interface to the Etsy API
 #

data/lib/etsy/image.rb

@@ -21,8 +21,8 @@ module Etsy
 
     # Fetch all images for a given listing.
     #
-    def self.find_all_by_listing_id(listing_id)
-      get_all("/listings/#{listing_id}/images")
+    def self.find_all_by_listing_id(listing_id, options = {})
+      get_all("/listings/#{listing_id}/images", options)
     end
 
     def self.create(listing, image_path, options = {})

data/lib/etsy/listing.rb

@@ -33,7 +33,7 @@ module Etsy
     include Etsy::Model
 
     STATES = %w(active removed sold_out expired alchemy)
-    VALID_STATES = [:active, :expired, :inactive, :sold, :featured]
+    VALID_STATES = [:active, :expired, :inactive, :sold, :featured, :draft, :sold_out]
 
     attribute :id, :from => :listing_id
     attribute :view_count, :from => :views
@@ -44,7 +44,8 @@ module Etsy
 
     attributes :title, :description, :state, :url, :price, :quantity,
                :tags, :materials, :hue, :saturation, :brightness, :is_black_and_white,
-               :featured_rank, :occasion, :num_favorers, :user_id
+               :featured_rank, :occasion, :num_favorers, :user_id,
+               :shipping_template_id, :who_made, :when_made
 
     association :image, :from => 'Images'
 
@@ -79,7 +80,7 @@ module Etsy
     # 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
+    # Available states are :active, :expired, :inactive, :sold, and :featured, :draft, :sold_out
     # where :featured is a subset of the others.
     #
     # options = {
@@ -123,7 +124,7 @@ module Etsy
     # The collection of images associated with this listing.
     #
     def images
-      @images ||= Image.find_all_by_listing_id(id)
+      @images ||= Image.find_all_by_listing_id(id, oauth)
     end
 
     # The primary image for this listing.
@@ -132,6 +133,53 @@ module Etsy
       images.first
     end
 
+    def variations
+      self.class.get_all("/listings/#{id}/variations")
+    end
+
+    # If these are your desired variations:
+    # - Dimensions: 1 x 2 inches
+    # - Dimensions: 2 x 4 inches
+    #
+    # Then you first have to find the property ID of the property you want to vary. Eg:
+    #   Etsy::Variation::PropertySet.find_property_by_name("Dimensions").fetch("property_id")
+    #
+    # Then you can decide which options you want to set for this property.
+    # Eg:
+    #   Etsy::Variation::PropertySet.qualifying_properties_for_property("Dimension")
+    # => [{
+    #      "param"=>"dimensions_scale",
+    #      "description"=>"Sizing Scale",
+    #      "options"=>{
+    #        "Inches" => 344,
+    #        "Centimeters" => 345,
+    #        "Other" => 346
+    #      }
+    #    }]
+    #
+    # Put it all together for a call to add_variations:
+
+    #  property_id = Etsy::Variation::PropertySet.find_property_by_name("Dimensions").fetch("property_id")
+    #  scale = Etsy::Variation::PropertySet.qualifying_properties_for_property("Dimensions").detect {|qp| qp.fetch("description") == "Sizing Scale"}
+    #  my_listing.add_variations(
+    #    :variations => [
+    #      {"property_id" => property_id, "value" => "1 x 2", "is_available" => true, "price" => 1.23},
+    #      {"property_id" => property_id, "value" => "2 x 4", "is_available" => true, "price" => 2.34}
+    #    ],
+    #    scale.fetch("param") => scale.fetch("options").fetch("Inches")
+    #  )
+    def add_variations(options)
+      options[:variations] = JSON.dump(options.delete(:variations))
+      options[:require_secure] = true
+      self.class.post("/listings/#{id}/variations", options)
+    end
+
+    def update_variations(options)
+      options[:variations] = JSON.dump(options.delete(:variations))
+      options[:require_secure] = true
+      self.class.put("/listings/#{id}/variations", options)
+    end
+
     def black_and_white?
       is_black_and_white
     end
@@ -169,6 +217,10 @@ module Etsy
       (user_ids.size > 0) ? Array(Etsy::User.find(user_ids, options)) : []
     end
 
+    def is_supply
+      !!@result.fetch("is_supply")
+    end
+
     private
 
     def self.valid?(state)
@@ -209,5 +261,10 @@ module Etsy
       (listing_ids.size > 0) ? Array(find(listing_ids, options)) : []
     end
 
+    private
+    
+    def oauth
+      oauth = (token && secret) ? {:access_token => token, :access_secret => secret} : {}
+    end
   end
 end

data/lib/etsy/receipt.rb

@@ -6,14 +6,14 @@ module Etsy
     attribute :buyer_id, :from => :buyer_user_id
 
     attributes :quantity, :listing_id, :name, :first_line, :second_line, :city, :state, :zip, :country_id,
-               :payment_email, :buyer_email, :created_tsz
+               :payment_email, :buyer_email, :creation_tsz
 
     def self.find_all_by_shop_id(shop_id, options = {})
       get_all("/shops/#{shop_id}/receipts", options)
     end
 
     def created_at
-      Time.at(created_tsz)
+      Time.at(creation_tsz)
     end
 
     def buyer
@@ -21,4 +21,4 @@ module Etsy
     end
 
   end
-end
+end

data/lib/etsy/secure_client.rb

@@ -107,7 +107,7 @@ module Etsy
         if value.respond_to?(:read)
           body << "Content-Disposition: form-data; name=\"#{esc_key}\"; filename=\"#{File.basename(value.path)}\"#{crlf}"
           body << "Content-Type: image/jpeg#{crlf*2}"
-          body << value.read
+          body << open(value.path, "rb") {|io| io.read}
         else
           body << "Content-Disposition: form-data; name=\"#{esc_key}\"#{crlf*2}#{value}"
         end

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.1"
 end

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/unit/etsy/image_test.rb

@@ -5,11 +5,19 @@ module Etsy
 
     context "The Image class" do
 
-      should "be able to find all images for a listing" do
-        images = mock_request('/listings/1/images', {}, 'Image', 'findAllListingImages.json')
-        Image.find_all_by_listing_id(1).should == images
+      context "without oauth" do
+        should "be able to find all images for a listing" do
+          images = mock_request('/listings/1/images', {}, 'Image', 'findAllListingImages.json')
+          Image.find_all_by_listing_id(1, {}).should == images
+        end
       end
 
+      context "with options" do
+        should "be able to find all images for a listing with options in request" do
+          images = mock_request('/listings/1/images', {foo: "bar"}, 'Image', 'findAllListingImages.json')
+          Image.find_all_by_listing_id(1, {foo: "bar"}).should == images
+        end
+      end
     end
 
     context "An instance of the Image class" do

data/test/unit/etsy/listing_test.rb

@@ -32,6 +32,16 @@ module Etsy
           Listing.find_all_by_shop_id(1, :state => :inactive).should == listings
         end
 
+        should "be able to find draft listings" do
+          listings = mock_request('/shops/1/listings/draft', {}, 'Listing', 'findAllShopListings.json')
+          Listing.find_all_by_shop_id(1, :state => :draft).should == listings
+        end
+
+        should "be able to find sold_out listings" do
+          listings = mock_request('/shops/1/listings/sold_out', {}, 'Listing', 'findAllShopListings.json')
+          Listing.find_all_by_shop_id(1, :state => :sold_out).should == listings
+        end
+
         should "be able to find featured listings" do
           listings = mock_request('/shops/1/listings/featured', {}, 'Listing', 'findAllShopListings.json')
           Listing.find_all_by_shop_id(1, :state => :featured).should == listings
@@ -196,15 +206,31 @@ module Etsy
         end
       end
 
-      should "have a collection of images" do
-        listing = Listing.new
-        listing.stubs(:id).with().returns(1)
+      context "with oauth" do
+        should "have a collection of images" do
+          listing = Listing.new
+          listing.stubs(:id).with().returns(1)
+          listing.stubs(:token).with().returns("token")
+          listing.stubs(:secret).with().returns("secret")
+
+          Image.stubs(:find_all_by_listing_id).with(1, {access_token: "token", access_secret: "secret"}).returns('images')
 
-        Image.stubs(:find_all_by_listing_id).with(1).returns('images')
+          listing.images.should == 'images'
+        end
+      end
+
+      context "without oauth" do
+        should "have a collection of images" do
+          listing = Listing.new
+          listing.stubs(:id).with().returns(1)
 
-        listing.images.should == 'images'
+          Image.stubs(:find_all_by_listing_id).with(1, {}).returns('images')
+
+          listing.images.should == 'images'
+        end
       end
 
+
       should "have a default image" do
         listing = Listing.new
         listing.stubs(:images).with().returns(%w(image_1 image_2))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: etsy
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Patrick Reagan
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-02 00:00:00.000000000 Z
+date: 2015-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -144,6 +144,7 @@ files:
 - lib/etsy/shop.rb
 - lib/etsy/transaction.rb
 - lib/etsy/user.rb
+- lib/etsy/variation/property_set.rb
 - lib/etsy/verification_request.rb
 - lib/etsy/version.rb
 - test/fixtures/address/getUserAddresses.json