etsy 0.3.0 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 63b1728090ce087c6421fdb354545b5031206bdd
-  data.tar.gz: 720fd11d6f39fe99e5f414e54155db73c2bedce3
+SHA256:
+  metadata.gz: 52e5bcc56a9eb4df1e1b2e732f296d82034b8b8fee77e17a7d4c567d70e8741e
+  data.tar.gz: bde90f57588f337c92a0a97b4c4f1c98757e6e3eff4d0372dcb9bbcd4d7b8103
 SHA512:
-  metadata.gz: 2c7a7b67c5bb186cecfe0a61000dd6b2a6258d5e4bd915c67672e40d949af76d7c083bfd54ec7e96c7d0396665562c389deafd3a1422ca21e6a4553a47a1f5aa
-  data.tar.gz: 60c5ad5ef28a7f5104ffcbb9e6df25f292ab31292725e9a45dddfe8fe62a93ac22ce1d0ea22d18c98db91e37b7d66e4bbc676ad6d7f422a339b86b878edc7eb7
+  metadata.gz: c974d38d7df6ee9be0df31072dc0cbadc59c762610b12039ad8132febea31273817c281dcd257e9b3334a3855677b8eb770df091caa58e77a5fb080214c0442b
+  data.tar.gz: 409997c87e75203d40037069af7deda3814954d33f88e3cc610c8976e7593fa9cad932fbe72025f79a82e1b4ea1a18b5c461ca1f782227d3479218c2e3ad9b1e

data/.travis.yml

@@ -1,7 +1,16 @@
 language: ruby
 rvm:
-  - 1.8.7
-  - 1.9.3
-  - jruby-18mode
-  - jruby-19mode
-  - rbx-2
+  - jruby
+  - 2.6.8
+  - 2.7.4
+  - 3.0.2
+
+dist: bionic
+
+before_install:
+  - gem install bundler
+  - sudo apt-get update && sudo apt-get install apt-transport-https ca-certificates -y && sudo update-ca-certificates
+
+matrix:
+  allow_failures:
+    - rvm: 3.0.2

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All changes to the Etsy gem are documented here.
+
+## [0.3.4] - November 3, 2021
+
+Getting the gem back to life and ready to migrate to Etsy API v3.
+
+### Added:
+- States for listings as per current documentation (Etsy API v2)
+- id attribute for Image class
+- Change log file is here!
+
+### Changed:
+- Cleaned up the dependencies and updated old gems
+- Updated ruby versions in Travis config

data/Gemfile

@@ -1,7 +1,3 @@
 source 'https://rubygems.org'
 
 gemspec
-
-if RUBY_VERSION < '1.9'
-  gem 'activesupport', '< 4.0'
-end

data/README.md

@@ -1,7 +1,6 @@
 # Etsy
 
 [![Build Status](https://secure.travis-ci.org/kytrinyx/etsy.png)](http://travis-ci.org/kytrinyx/etsy)
-[![Dependency Status](https://gemnasium.com/kytrinyx/etsy.png)](https://gemnasium.com/kytrinyx/etsy)
 
 ## Description
 
@@ -15,7 +14,7 @@ Installing the latest stable version is simple:
 
 If you want to be on the bleeding edge, install from GitHub:
 
-    $ git clone git://github.com/kytrinyx/etsy.git
+    $ git clone git://github.com/iamfmjk/etsy.git
     $ cd etsy
     $ rake install
 
@@ -26,6 +25,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 +92,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 +308,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/etsy.gemspec

@@ -2,8 +2,8 @@
 require File.expand_path('../lib/etsy/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Patrick Reagan", "Katrina Owen"]
-  gem.email         = ["reaganpr@gmail.com", "katrina.owen@gmail.com"]
+  gem.authors       = ["Iuliia Kolomiiets", "Patrick Reagan", "Katrina Owen"]
+  gem.email         = ["etsygeminfo@gmail.com, reaganpr@gmail.com", "katrina.owen@gmail.com" ]
   gem.description   = %q{A friendly Ruby interface to the Etsy API}
   gem.summary       = %q{Provides a friendly ruby-like wrapper for the Etsy API}
   gem.homepage      = "http://github.com/kytrinyx/etsy"
@@ -20,9 +20,9 @@ Gem::Specification.new do |gem|
   gem.rubygems_version = "1.8.10"
 
   gem.add_dependency "json", ">= 1.5.0"
-  gem.add_dependency "oauth", "~> 0.4.0"
+  gem.add_dependency "oauth", ">= 0.5.5"
 
-  gem.add_development_dependency "rake", "~> 10.0.4"
+  gem.add_development_dependency "rake", "~> 12.3.3"
   gem.add_development_dependency "jnunemaker-matchy", "~> 0.4.0"
   gem.add_development_dependency 'shoulda', "~> 3.4.0"
   gem.add_development_dependency 'mocha', "~> 0.13.3"
@@ -30,5 +30,5 @@ Gem::Specification.new do |gem|
   # on shoulda/context.rb:7
   # But then when you load active_support, shoulda-context decides
   # to load MiniTest
-  gem.add_development_dependency 'minitest', "=4.7.4"
+  gem.add_development_dependency 'test-unit', "~>3.5.0"
 end

data/lib/etsy/about.rb

@@ -0,0 +1,15 @@
+module Etsy
+  class About
+    include Etsy::Model
+
+    attributes :status, :story_headline, :story_leading_paragraph,
+               :story, :related_links, :url
+    attribute :id, :from => :shop_id
+    attribute :shop_id, :from => :shop_id
+
+    def self.find_by_shop(shop)
+      get("/shops/#{shop.id}/about")
+    end
+
+  end
+end

data/lib/etsy/attribute_value.rb

@@ -0,0 +1,46 @@
+module Etsy
+
+  # = AttributeValue
+  #
+  # An attribute of a listing according to its taxonomy.
+  #
+  # An attribute has the following attributes:
+  #
+  # [property_id]	  (INT)           The numeric ID of this property.
+  # [property_name] (STRING)	      The name of the property, in the requested locale language.
+  # [scale_id]      (INT)	          The numeric ID of the scale (if any).
+  # [scale_name]    (STRING)	      The label used to describe the chosen scale (if any).
+  # [value_ids]     (Array(INT))    The numeric IDs of the values.
+  # [values]        (Array(STRING)) The literal values of the value
+  class AttributeValue
+
+    include Etsy::Model
+
+    attribute :id, :from => :property_id
+    attributes :property_name, :scale_id, :scale_name, :value_ids,
+               :values
+
+    # Fetch all property_values for a given listing.
+    #
+    def self.find_all_by_listing_id(listing_id, options = {})
+      get_all("/listings/#{listing_id}/attributes", options)
+    end
+
+    # Adds a new attribute_value to the listing given
+    #
+    def self.create(listing, property_hash, options = {})
+      property_id = property_hash[:property_id]
+      options.merge!(:require_secure => true)
+      options.merge!(property_hash)
+      put("/listings/#{listing.id}/attributes/#{property_id}", options)
+    end
+
+    # Delete attribute_value from listing
+    #
+    def self.destroy(listing, property_value, options = {})
+      options.merge!(:require_secure => true)
+      delete("/listings/#{listing.id}/attributes/#{property_value.id}", options)
+    end
+  end
+end
+

data/lib/etsy/bill_charge.rb

@@ -0,0 +1,31 @@
+module Etsy
+
+  # = BillCharge
+  #
+  # Represents a charge to an Etsy member's account.
+  #
+  #
+  class BillCharge
+
+    include Etsy::Model
+
+    attribute :id, :from => :bill_charge_id
+    attribute :created, :from => :creation_tsz
+    attribute :last_modified, :from => :last_modified_tsz
+
+    attributes :type, :type_id, :user_id, :amount, :currency_code, :creation_month,
+               :creation_year
+
+    def self.find_all_by_user_id(user_id, options = {})
+      get_all("/users/#{user_id}/charges", options)
+    end
+
+    def created_at
+      Time.at(created)
+    end
+
+    def last_modified_at
+      Time.at(last_modified)
+    end
+  end
+end

data/lib/etsy/bill_payment.rb

@@ -0,0 +1,28 @@
+module Etsy
+
+  # = BillPayment
+  #
+  # Represents a user's Billing Payment.
+  #
+  #
+  class BillPayment
+
+    include Etsy::Model
+
+    attribute :id, :from => :bill_payment_id
+    attribute :created, :from => :creation_tsz
+
+    attributes :type, :type_id, :user_id, :amount, :currency_code, :creation_month,
+               :creation_year
+
+    def self.find_all_by_user_id(user_id, options = {})
+      get_all("/users/#{user_id}/payments", options)
+    end
+
+    # Time that this listing was created
+    #
+    def created_at
+      Time.at(created)
+    end
+  end
+end

data/lib/etsy/billing_overview.rb

@@ -0,0 +1,18 @@
+module Etsy
+
+  # = BillingOverview
+  #
+  # A user's account balance on Etsy.
+  #
+  class BillingOverview
+
+    include Etsy::Model
+
+    attributes :is_overdue, :overdue_balance, :balance_due, :total_balance, :currency_code, :date_due,
+               :creation_year
+
+    def self.find_all_by_user_id(user_id, options = {})
+      get_all("/users/#{user_id}/billing/overview", options)
+    end
+  end
+end

data/lib/etsy/image.rb

@@ -14,15 +14,18 @@ module Etsy
 
     include Etsy::Model
 
+    attribute :id, :from => :listing_image_id
     attribute :square, :from => :url_75x75
     attribute :small, :from => :url_170x135
     attribute :thumbnail, :from => :url_570xN
+    attribute :height, :from => :full_height
+    attribute :width, :from => :full_width
     attribute :full, :from => :url_fullxfull
 
     # 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

@@ -26,28 +26,45 @@ module Etsy
   # [removed?] Has this listing been removed?
   # [sold_out?] Is this listing sold out?
   # [expired?] Has this listing expired?
-  # [alchemy?] Is this listing an Alchemy item? (i.e. requested by an Etsy user)
+  # [edit?] Is this listing inactive?
+  # [draft?] Is this listing in draft mode / not yet published?
+  # [private?] Is this a private listing?
+  # [unavailable?] Has this listing been removed by Etsy admins?
+
   #
   class Listing
 
     include Etsy::Model
 
-    STATES = %w(active removed sold_out expired alchemy)
-    VALID_STATES = [:active, :expired, :inactive, :sold, :featured]
+    STATES = %w(active removed sold_out expired edit draft private unavailable)
+    #TODO: re-check valid states
+    VALID_STATES = [:active, :draft, :expired, :featured, :inactive, :sold, :sold_out]
 
     attribute :id, :from => :listing_id
     attribute :view_count, :from => :views
     attribute :created, :from => :creation_tsz
+    attribute :original_created, :from => :original_creation_tsz
     attribute :modified, :from => :last_modified_tsz
     attribute :currency, :from => :currency_code
     attribute :ending, :from => :ending_tsz
+    attribute :shop_section, :from => :shop_section_id
 
     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,
+               :style, :category_path, :taxonomy_id, :taxonomy_attributes
 
     association :image, :from => 'Images'
 
+    def transactions
+      @transactions ||= Transaction.find_all_by_listing_id(id, oauth)
+    end
+
+    def receipts
+      transactions.map{|t|t.receipt}
+    end
+
     def self.create(options = {})
       options.merge!(:require_secure => true)
       post("/listings", options)
@@ -57,7 +74,7 @@ module Etsy
       options.merge!(:require_secure => true)
       put("/listings/#{listing.id}", options)
     end
-    
+
     def self.destroy(listing, options = {})
       options.merge!(:require_secure => true)
       delete("/listings/#{listing.id}", options)
@@ -79,7 +96,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 +140,7 @@ module Etsy
     # The collection of images associated with this listing.
     #
     def images
-      @images ||= Image.find_all_by_listing_id(id)
+      @images ||= listing_images
     end
 
     # The primary image for this listing.
@@ -132,6 +149,68 @@ module Etsy
       images.first
     end
 
+    # Listing category name
+    #
+    def category
+      path = category_path.join('/')
+      @category ||= Category.find(path)
+    end
+
+    # Returns the taxonomy defined attributes for the listing
+    #
+    def taxonomy_attributes(options={})
+      options.merge!(:require_secure => true)
+      self.class.get_all("/listings/#{id}/attributes", oauth.merge(options))
+    end
+
+    def variations(options={})
+      options.merge!(:require_secure => true)
+      self.class.get_all("/listings/#{id}/variations", oauth.merge(options))
+    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
@@ -148,6 +227,11 @@ module Etsy
       Time.at(created)
     end
 
+    # Time that this listing was originally created
+    def original_created_at
+      Time.at(original_created)
+    end
+
     # Time that this listing was last modified
     #
     def modified_at
@@ -169,6 +253,10 @@ module Etsy
       (user_ids.size > 0) ? Array(Etsy::User.find(user_ids, options)) : []
     end
 
+    def is_supply
+      @result.fetch('is_supply') == 'true'
+    end
+
     private
 
     def self.valid?(state)
@@ -209,5 +297,18 @@ 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
+
+    def listing_images
+      if result && result["Images"]
+        result["Images"].map { |hash| Image.new(hash) }
+      else
+        Image.find_all_by_listing_id(id, oauth)
+      end
+    end
   end
 end

data/lib/etsy/model.rb

@@ -43,7 +43,7 @@ module Etsy
           if limit == :all
             response = Request.get(endpoint, options.merge(:limit => batch_size, :offset => initial_offset))
             result << response.result
-            limit = [response.count - batch_size - initial_offset, 0].max
+            limit = [response.total - batch_size - initial_offset, 0].max
             initial_offset += batch_size
           end
 
@@ -83,7 +83,7 @@ module Etsy
       def put(endpoint, options={})
         Request.put(endpoint, options)
       end
-      
+
       def delete(endpoint, options={})
         Request.delete(endpoint, options)
       end

data/lib/etsy/receipt.rb

@@ -5,20 +5,40 @@ module Etsy
     attribute :id, :from => :receipt_id
     attribute :buyer_id, :from => :buyer_user_id
 
+    attribute :created, :from => :creation_tsz
+    attribute :last_modified, :from => :last_modified_tsz
+
     attributes :quantity, :listing_id, :name, :first_line, :second_line, :city, :state, :zip, :country_id,
-               :payment_email, :buyer_email, :created_tsz
+               :payment_email, :buyer_email
+
+    def self.find(*identifiers_and_options)
+      find_one_or_more('receipts', identifiers_and_options)
+    end
 
     def self.find_all_by_shop_id(shop_id, options = {})
       get_all("/shops/#{shop_id}/receipts", options)
     end
 
+    def self.find_all_by_shop_id_and_status(shop_id, status, options = {})
+      get_all("/shops/#{shop_id}/receipts/#{status}", options)
+    end
+
     def created_at
-      Time.at(created_tsz)
+      Time.at(created)
     end
 
     def buyer
       @buyer ||= User.find(buyer_id)
     end
 
+    def transactions
+      unless @transactions
+        options = {}
+        options = options.merge(:access_token => token, :access_secret => secret) if (token && secret)
+        @transactions = Transaction.find_all_by_receipt_id(id, options)
+      end
+      @transactions
+    end
+
   end
-end
+end

data/lib/etsy/request.rb

@@ -22,13 +22,13 @@ module Etsy
       request = Request.new(resource_path, parameters)
       Response.new(request.put)
     end
-    
+
     def self.delete(resource_path, parameters = {})
       request = Request.new(resource_path, parameters)
       Response.new(request.delete)
     end
-    
-    
+
+
 
     # Create a new request for the resource with optional parameters
     def initialize(resource_path, parameters = {})
@@ -75,7 +75,7 @@ module Etsy
     def put
       client.put(endpoint_url)
     end
-    
+
     def delete
       client.delete(endpoint_url)
     end
@@ -104,7 +104,7 @@ module Etsy
           k.nil? || v.nil? || (k.respond_to?(:empty?) && k.empty?) || (v.respond_to?(:empty?) && v.empty?)
         }.map { |k, v| "#{to_url(k.to_s)}=#{to_url(v)}" }.join('&')
       else
-        URI.escape(val.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+        URI.encode_www_form_component(val.to_s)
       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/shipping_info.rb

@@ -0,0 +1,27 @@
+module Etsy
+  class ShippingInfo
+    include Etsy::Model
+
+    attribute :id, :from => :shipping_info_id
+
+    attributes :origin_country_id, :destination_country_id, :currency_code, :primary_cost, :secondary_cost, :listing_id, :region_id, :origin_country_name, :destination_country_name
+ 
+    def self.find(id, credentials = {})
+      options = {
+        :access_token => credentials[:access_token],
+        :access_secret => credentials[:access_secret],
+        :require_secure => true
+      }
+      get("/shipping/info/#{id}", options)
+    end
+        
+    def self.find_all_by_listing_id(listing_id, credentials = {})
+      options = {
+        :access_token => credentials[:access_token],
+        :access_secret => credentials[:access_secret],
+        :require_secure => true
+      }
+      get_all("/listings/#{listing_id}/shipping/info", options)
+    end
+  end
+end