etsy 0.2.0 → 0.2.1

data/lib/etsy/payment_template.rb

@@ -0,0 +1,33 @@
+module Etsy
+  class PaymentTemplate
+    include Etsy::Model
+
+    attribute :id, :from => :payment_template_id
+    attributes :allow_check, :allow_mo, :allow_other, :allow_paypal, :allow_cc
+    attributes :paypal_email, :name, :first_line, :second_line, :city, :state
+    attributes :zip, :country_id
+
+    def self.create(options = {})
+      options.merge!(:require_secure => true)
+      post("/payments/templates", options)
+    end
+ 
+    def self.find(id, credentials = {})
+      options = {
+        :access_token => credentials[:access_token],
+        :access_secret => credentials[:access_secret],
+        :require_secure => true
+      }
+      get("/payments/templates/#{id}", options)
+    end
+
+    def self.find_by_user(user, credentials = {})
+      options = {
+        :access_token => credentials[:access_token],
+        :access_secret => credentials[:access_secret],
+        :require_secure => true
+      }
+      get("/users/#{user.id}/payments/templates", options)
+    end
+  end
+end

data/lib/etsy/profile.rb

@@ -0,0 +1,49 @@
+module Etsy
+
+  # = Profile
+  #
+  # Represents a profile resource of an Etsy user.
+  #
+  class Profile
+
+    include Etsy::Model
+
+    attribute :id, :from => :user_profile_id
+    attribute :user_id
+    attribute :bio
+    attribute :username, :from => :login_name
+    attribute :gender
+    attribute :birth_day
+    attribute :birth_month
+    attribute :birth_year
+    attribute :joined, :from => :join_tsz
+    attribute :favorite_materials, :from => :materials
+    attribute :country_id
+    attribute :city
+    attribute :location
+    attribute :region
+    attribute :avatar_id
+    attribute :image, :from => :image_url_75x75
+    attribute :lat
+    attribute :lon
+    attribute :transaction_buy_count
+    attribute :transaction_sold_count
+    attribute :is_seller
+    attribute :first_name
+    attribute :last_name
+
+    def materials
+      favorite_materials ? favorite_materials.split(',') : []
+    end
+
+    # Time that this user joined Etsy
+    #
+    def joined_at
+      Time.at(joined)
+    end
+
+    def seller?
+      is_seller
+    end
+  end
+end

data/lib/etsy/request.rb

@@ -6,10 +6,6 @@ module Etsy
   #
   class Request
 
-    def self.host # :nodoc:
-      'openapi.etsy.com'
-    end
-
     # Perform a GET request for the resource with optional parameters - returns
     # A Response object with the payload data
     def self.get(resource_path, parameters = {})
@@ -17,18 +13,42 @@ module Etsy
       Response.new(request.get)
     end
 
+    def self.post(resource_path, parameters = {})
+      request = Request.new(resource_path, parameters)
+      Response.new(request.post)
+    end
+
+    def self.put(resource_path, parameters = {})
+      request = Request.new(resource_path, parameters)
+      Response.new(request.put)
+    end
+
     # Create a new request for the resource with optional parameters
     def initialize(resource_path, parameters = {})
+      parameters = parameters.dup
+      @token = parameters.delete(:access_token) || Etsy.credentials[:access_token]
+      @secret = parameters.delete(:access_secret) || Etsy.credentials[:access_secret]
+      raise("Secure connection required. Please provide your OAuth credentials via :access_token and :access_secret in the parameters") if parameters.delete(:require_secure) && !secure?
+      @multipart_request = parameters.delete(:multipart)
       @resource_path = resource_path
-      @parameters    = parameters
+      @resources = parameters.delete(:includes)
+      if @resources.class == String
+        @resources = @resources.split(',').map {|r| {:resource => r}}
+      elsif @resources.class == Array
+        @resources = @resources.map do |r|
+          if r.class == String
+            {:resource => r}
+          else
+            r
+          end
+        end
+      end
+      parameters = parameters.merge(:api_key => Etsy.api_key) unless secure?
+      @parameters = parameters
     end
 
     def base_path # :nodoc:
-      parts = ['v2']
-      parts << 'sandbox' if Etsy.environment == :sandbox
-      parts << (secure? ? 'private' : 'public')
-
-      "/#{parts.join('/')}"
+      "/v2"
     end
 
     # Perform a GET request against the API endpoint and return the raw
@@ -37,34 +57,82 @@ module Etsy
       client.get(endpoint_url)
     end
 
+    def post
+      if multipart?
+        client.post_multipart(endpoint_url(:include_query => false), @parameters)
+      else
+        client.post(endpoint_url)
+      end
+    end
+
+    def put
+      client.put(endpoint_url)
+    end
+
     def client # :nodoc:
       @client ||= secure? ? secure_client : basic_client
     end
 
     def parameters # :nodoc:
-      @parameters.merge(:api_key => Etsy.api_key, :detail_level => 'high')
+      @parameters
+    end
+
+    def resources # :nodoc:
+      @resources
     end
 
     def query # :nodoc:
-      parameters.map {|k,v| "#{k}=#{v}"}.join('&')
+      to_url(parameters.merge(:includes => resources.to_a.map { |r| association(r) }))
+    end
+
+    def to_url(val)
+      if val.is_a? Array
+        to_url(val.join(','))
+      elsif val.is_a? Hash
+        val.reject { |k, v|
+          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}]"))
+      end
+    end
+
+    def association(options={}) # :nodoc:
+      s = options[:resource].dup
+
+      if options.include? :fields
+        s << "(#{[options[:fields]].flatten.join(',')})"
+      end
+
+      if options.include?(:limit) || options.include?(:offset)
+        s << ":#{options.fetch(:limit, 25)}:#{options.fetch(:offset, 0)}"
+      end
+
+      s
+    end
+
+    def endpoint_url(options = {}) # :nodoc:
+      url = "#{base_path}#{@resource_path}"
+      url += "?#{query}" if options.fetch(:include_query, true)
+      url
     end
 
-    def endpoint_url # :nodoc:
-      "#{base_path}#{@resource_path}?#{query}"
+    def multipart?
+      !!@multipart_request
     end
 
     private
 
     def secure_client
-      SecureClient.new(:access_token => @parameters[:access_token], :access_secret => @parameters[:access_secret])
+      SecureClient.new(:access_token => @token, :access_secret => @secret)
     end
 
     def basic_client
-      BasicClient.new(self.class.host)
+      BasicClient.new(Etsy.host)
     end
 
     def secure?
-      Etsy.access_mode == :read_write && !@parameters[:access_token].nil? && !@parameters[:access_secret].nil?
+      !@token.nil? && !@secret.nil?
     end
 
   end

data/lib/etsy/response.rb

@@ -1,5 +1,11 @@
 module Etsy
 
+  class OAuthTokenRevoked < StandardError; end
+  class MissingShopID < StandardError; end
+  class EtsyJSONInvalid < StandardError; end
+  class TemporaryIssue < StandardError; end
+  class InvalidUserID < StandardError; end
+
   # = Response
   #
   # Basic wrapper around the Etsy JSON response data
@@ -13,17 +19,43 @@ module Etsy
 
     # Convert the raw JSON data to a hash
     def to_hash
-      @hash ||= JSON.parse(data)
+      validate!
+      @hash ||= json
+    end
+
+    def body
+      @raw_response.body
+    end
+
+    def code
+      @raw_response.code
     end
 
     # Number of records in the response results
     def count
-      to_hash['count']
+      if paginated?
+        to_hash['results'].nil? ? 0 : to_hash['results'].size
+      else
+        to_hash['count']
+      end
     end
 
     # Results of the API request
     def result
-      count == 1 ? to_hash['results'].first : to_hash['results']
+      if success?
+        results = to_hash['results'] || []
+        count == 1 ? results.first : results
+      else
+        []
+      end
+    end
+
+    def success?
+      !!(code =~ /2\d\d/)
+    end
+
+    def paginated?
+      !!to_hash['pagination']
     end
 
     private
@@ -32,5 +64,49 @@ module Etsy
       @raw_response.body
     end
 
+    def json
+      @hash ||= JSON.parse(data)
+    end
+
+    def validate!
+      raise OAuthTokenRevoked         if token_revoked?
+      raise MissingShopID             if missing_shop_id?
+      raise InvalidUserID             if invalid_user_id?
+      raise TemporaryIssue            if temporary_etsy_issue? || resource_unavailable? || exceeded_rate_limit?
+      raise EtsyJSONInvalid.new(data) unless valid_json?
+      true
+    end
+
+    def valid_json?
+      json
+      return true
+    rescue JSON::ParserError
+      return false
+    end
+
+    def token_revoked?
+      data == "oauth_problem=token_revoked"
+    end
+
+    def missing_shop_id?
+      data =~ /Shop with PK shop_id/
+    end
+
+    def invalid_user_id?
+      data =~ /is not a valid user_id/
+    end
+
+    def temporary_etsy_issue?
+      data =~ /Temporary Etsy issue/
+    end
+
+    def resource_unavailable?
+      data =~ /Resource temporarily unavailable/
+    end
+
+    def exceeded_rate_limit?
+      data =~ /You have exceeded/
+    end
+
   end
-end
+end

data/lib/etsy/section.rb

@@ -0,0 +1,16 @@
+module Etsy
+  class Section
+    include Etsy::Model
+
+    attributes :title, :rank, :user_id, :active_listing_count
+    attribute :id, :from => :shop_section_id
+
+    def self.find_by_shop(shop)
+      get("/shops/#{shop.id}/sections")
+    end
+
+    def self.find(shop, id)
+      get("/shops/#{shop.id}/sections/#{id}")
+    end
+  end
+end

data/lib/etsy/secure_client.rb

@@ -22,11 +22,11 @@ module Etsy
     end
 
     def consumer # :nodoc:
+      path = '/v2/oauth/'
       @consumer ||= OAuth::Consumer.new(Etsy.api_key, Etsy.api_secret, {
-        :site               => 'http://openapi.etsy.com',
-        :request_token_path => '/v2/sandbox/oauth/request_token',
-        :access_token_path  => '/v2/sandbox/oauth/access_token',
-        :authorize_url      => 'https://www.etsy.com/oauth/signin'
+        :site               => "http://#{Etsy.host}",
+        :request_token_path => "#{path}request_token?scope=#{Etsy.permission_scopes.join('+')}",
+        :access_token_path  => "#{path}access_token"
       })
     end
 
@@ -69,8 +69,53 @@ module Etsy
       client.get(endpoint)
     end
 
+    def post(endpoint)
+      client.post(endpoint)
+    end
+
+    def put(endpoint)
+      client.put(endpoint)
+    end
+
+    def post_multipart(endpoint, params = {})
+      Net::HTTP.new(Etsy.host).start do |http|
+        req = Net::HTTP::Post.new(endpoint)
+        add_multipart_data(req, params)
+        add_oauth(req)
+        res = http.request(req)
+      end
+    end
+
     private
 
+    # Encodes the request as multipart
+    def add_multipart_data(req, params)
+      crlf = "\r\n"
+      boundary = Time.now.to_i.to_s(16)
+      req["Content-Type"] = "multipart/form-data; boundary=#{boundary}"
+      body = ""
+      params.each do |key,value|
+        esc_key = CGI.escape(key.to_s)
+        body << "--#{boundary}#{crlf}"
+        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
+        else
+          body << "Content-Disposition: form-data; name=\"#{esc_key}\"#{crlf*2}#{value}"
+        end
+        body << crlf
+      end
+      body << "--#{boundary}--#{crlf*2}"
+      req.body = body
+      req["Content-Length"] = req.body.size
+    end
+
+    # Uses the OAuth gem to add the signed Authorization header
+    def add_oauth(req)
+      client.sign!(req)
+    end
+
     def has_access_data?
       !@attributes[:access_token].nil? && !@attributes[:access_secret].nil?
     end

data/lib/etsy/shipping_template.rb

@@ -0,0 +1,32 @@
+module Etsy
+  class ShippingTemplate
+    include Etsy::Model
+
+    attribute :id, :from => :shipping_template_id
+
+    attributes :title, :user_id
+
+    def self.create(options = {})
+      options.merge!(:require_secure => true)
+      post("/shipping/templates", options)
+    end
+ 
+    def self.find(id, credentials = {})
+      options = {
+        :access_token => credentials[:access_token],
+        :access_secret => credentials[:access_secret],
+        :require_secure => true
+      }
+      get("/shipping/templates/#{id}", options)
+    end
+
+    def self.find_by_user(user, credentials = {})
+      options = {
+        :access_token => credentials[:access_token],
+        :access_secret => credentials[:access_secret],
+        :require_secure => true
+      }
+      get("/users/#{user.id}/shipping/templates", options)
+    end
+  end
+end