cardmagic-etsy 0.3.2

data/lib/etsy.rb

@@ -0,0 +1,223 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'net/http'
+require 'json'
+require 'oauth'
+require 'uri'
+
+require 'etsy/request'
+require 'etsy/response'
+
+require 'etsy/basic_client'
+require 'etsy/secure_client'
+require 'etsy/verification_request'
+
+require 'etsy/model'
+require 'etsy/user'
+require 'etsy/profile'
+require 'etsy/shop'
+require 'etsy/listing'
+require 'etsy/attribute_value'
+require 'etsy/image'
+require 'etsy/transaction'
+require 'etsy/address'
+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
+#
+# == Quick Start
+#
+# Getting started is easy. First, you will need a valid API key from the Etsy
+# developer site (http://developer.etsy.com/).
+#
+# To start using the API, require the etsy gem and set it up to use your API key:
+#
+#     require 'rubygems'
+#     require 'etsy'
+#
+#     Etsy.api_key = 'itsasecret'
+#
+# Now you can make API calls that originate from an Etsy user:
+#
+#     # Find a user by username
+#     user = Etsy.user('littletjane')
+#
+#     # Grab that user's shop information
+#     user.shop
+#     user.shop.title
+#
+#     # ... and the listings in the shop
+#     listing = user.shop.listings.first
+#     listing.title
+#     listing.description
+#
+# To see what else is available for a user, check out the full documentation for
+# the Etsy::User class. Information about making authenticated calls is available
+# in the README.
+#
+module Etsy
+  class Error < RuntimeError; end
+
+  class << self
+    attr_writer :callback_url
+    attr_writer :permission_scopes
+  end
+
+  # Make Etsy.api_key and Etsy.api_secret global but also local to threads
+  #
+  def self.api_key
+    Thread.current[:etsy_api_key] || @api_key
+  end
+
+  def self.api_key=(key)
+    @api_key ||= key
+    Thread.current[:etsy_api_key] = key
+  end
+
+  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
+  end
+
+  SANDBOX_HOST = 'sandbox.openapi.etsy.com'
+  PRODUCTION_HOST = 'openapi.etsy.com'
+
+  # Set the environment, accepts either :sandbox or :production. Defaults to :sandbox
+  # and will raise an exception when set to an unrecognized environment.
+  #
+  def self.environment=(environment)
+    unless [:sandbox, :production].include?(environment)
+      raise(ArgumentError, "environment must be set to either :sandbox or :production")
+    end
+    @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)
+    unless [TrueClass, FalseClass].include?(bool.class)
+      raise(ArgumentError, "Silent errors must be set to either true or false'")
+    end
+    @silent_errors = bool
+  end
+
+  def self.protocol
+    @protocol || "https"
+  end
+
+  # The currently configured environment.
+  #
+  def self.environment
+    @environment || :production
+  end
+
+  # The default will change to false for a 1.0 release (breaking changes)
+  #
+  def self.silent_errors
+    @silent_errors.nil? ? true : @silent_errors
+  end
+
+  def self.host # :nodoc:
+    @host || PRODUCTION_HOST
+  end
+
+  # The configured callback URL or 'oob' if no callback URL is configured. This controls
+  # whether or not we need to pass the OAuth verifier by hand.
+  #
+  def self.callback_url
+    @callback_url || 'oob'
+  end
+
+  # OAuth permission scopes. Defines which private fields we can have access to.
+  #
+  def self.permission_scopes
+    @permission_scopes || []
+  end
+
+  # Find a user by username.  See Etsy::User for more information.
+  #
+  def self.user(username)
+    User.find(username)
+  end
+
+  # Convenience method for accessing the authenticated user's own user information. Requires
+  # authentication.
+  #
+  def self.myself(token, secret, options = {})
+    User.myself(token, secret, options)
+  end
+
+  # Generate a request token for authorization.
+  #
+  def self.request_token
+    clear_for_new_authorization
+    verification_request.request_token
+  end
+
+  # Generate an access token from the request token, secret, and verifier. The verifier can
+  # either be passed manually or from the params in the callback URL.
+  #
+  def self.access_token(request_token, request_secret, verifier)
+    @access_token = begin
+      client = Etsy::SecureClient.new({
+        :request_token  => request_token,
+        :request_secret => request_secret,
+        :verifier       => verifier
+      })
+      client.client
+    end
+  end
+
+  # Generate the URL to begin the verification process for a user.
+  #
+  def self.verification_url
+    verification_request.url
+  end
+
+  def self.single_user(access_token, access_secret)
+    @credentials = {
+      :access_token => access_token,
+      :access_secret => access_secret
+    }
+    nil
+  end
+
+  def self.credentials
+    @credentials || {}
+  end
+
+  private
+
+  def self.verification_request
+    @verification_request ||= VerificationRequest.new
+  end
+
+  def self.clear_for_new_authorization
+    @verification_request = nil
+  end
+
+  def self.deprecate(message)
+    puts "DEPRECATED: #{message}."
+  end
+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/address.rb

@@ -0,0 +1,47 @@
+module Etsy
+
+  # = Address
+  #
+  # Represents a single Etsy Address.  Users may or may not have associated addresses.
+  #
+  # An address has the following attributes:
+  #
+  # [first_line] Street address
+  # [second_line] Additional street information.
+  # [city]
+  # [state]
+  # [country]
+  # [country_id] The Etsy country id
+  #
+  class Address
+
+    include Etsy::Model
+
+    attributes :name, :first_line, :second_line, :city, :state, :zip, :country_id
+
+    attribute :id, :from => :user_address_id
+    attribute :country, :from => :country_name
+
+    # Retrieve all of a user's addresses by user name or ID:
+    #
+    #   Etsy::Address.find('reagent')
+    #
+    def self.find(*identifiers_and_options)
+      self.append_to_endpoint('addresses', identifiers_and_options)
+      self.find_one_or_more('users', identifiers_and_options)
+    end
+
+    private
+    def oauth
+      oauth = (token && secret) ? {:access_token => token, :access_secret => secret} : {}
+    end
+
+    def self.append_to_endpoint(suffix, arguments)
+      if arguments.last.class == Hash
+        arguments.last[:append_to_endpoint] = suffix
+      else
+        arguments << {:append_to_endpoint => suffix}
+      end
+    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/basic_client.rb

@@ -0,0 +1,32 @@
+module Etsy
+
+  # = BasicClient
+  #
+  # Used for calling public API methods.
+  #
+  class BasicClient
+
+    # Create a new client that will connect to the specified host
+    #
+    def initialize
+      @host = Etsy.host
+    end
+
+    def client # :nodoc:
+      if @client
+        return @client
+      else
+        @client = Net::HTTP.new(@host, Etsy.protocol == "http" ? 80 : 443)
+        @client.use_ssl = true if Etsy.protocol == "https"
+        return @client
+      end
+    end
+
+    # Fetch a raw response from the specified endpoint
+    #
+    def get(endpoint)
+      client.get(endpoint)
+    end
+
+  end
+end

data/lib/etsy/category.rb

@@ -0,0 +1,84 @@
+module Etsy
+
+  # = Category
+  #
+  # A category of listings for sale, formed from 1 to 3 tags.
+  #
+  # A category has the following attributes:
+  #
+  # [page_description] A short description of the category from the category's landing page
+  # [page_title] The title of the category's landing page
+  # [category_name] The category's string ID
+  # [short_name] A short display name for the category
+  # [long_name] A longer display name for the category
+  # [children_count] The number of subcategories below this one
+  #
+  class Category
+
+    include Etsy::Model
+
+    attribute :id, :from => :category_id
+    attribute :children_count, :from => :num_children
+    attributes :page_description, :page_title, :category_name, :short_name,
+               :long_name
+
+    # Retrieve one or more top-level categories by name:
+    #
+    #   Etsy::Category.find('accessories')
+    #
+    # You can find multiple top-level categories by passing an array of identifiers:
+    #
+    #   Etsy::Category.find(['accessories', 'art'])
+    #
+    def self.find_top(*identifiers_and_options)
+      self.find_one_or_more('categories', identifiers_and_options)
+    end
+
+    # Retrieve a list of all subcategories of the specified category.
+    #
+    #   Etsy::Category.find_all_subcategories('accessories')
+    #
+    # You can also find the subcategories of a subcategory.
+    #
+    #   Etsy::Category.find_all_subcategories('accessories/apron')
+    #
+    # Etsy categories only go three levels deep, so this will return nil past the third level.
+    #
+    #   Etsy::Category.find_all_subcategories('accessories/apron/women')
+    #   => nil
+    #
+    def self.find_all_subcategories(category, options = {})
+      valid?(category) ? self.get_all("/taxonomy/categories/#{category}", options) : nil
+    end
+
+    def self.find(tag)
+      get("/categories/#{tag}")
+    end
+
+    # Retrieve a list of all top-level categories.
+    #
+    #   Etsy::Category.all
+    #
+    def self.all_top(options = {})
+      self.get_all("/taxonomy/categories", options)
+    end
+
+    # The collection of active listings associated with this category.
+    #
+    def active_listings
+      @active_listings ||= Listing.find_all_active_by_category(category_name)
+    end
+
+    # The collection of subcategories associated with this category.
+    #
+    def subcategories
+      @subcategories ||= Category.find_all_subcategories(category_name)
+    end
+
+    private
+
+    def self.valid?(parent_category)
+      parent_category.count("/") < 2
+    end
+  end
+end