cardmagic-etsy 0.3.2

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_by_listing_id(listing_id, credentials = {})
+      options = {
+        :access_token => credentials[:access_token],
+        :access_secret => credentials[:access_secret],
+        :require_secure => true
+      }
+      get("/listings/#{listing_id}/shipping/info", options)
+    end
+  end
+end

data/lib/etsy/shipping_template.rb

@@ -0,0 +1,41 @@
+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_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],
+        :access_secret => credentials[:access_secret],
+        :require_secure => true
+      }
+      get("/users/#{user.id}/shipping/templates", options)
+    end
+  end
+end

data/lib/etsy/shop.rb

@@ -0,0 +1,88 @@
+module Etsy
+
+  # = Shop
+  #
+  # Represents a single Etsy shop.  Users may or may not have an associated shop.
+  #
+  # A shop has the following attributes:
+  #
+  # [name] The shop's name
+  # [title] A brief heading for the shop's main page
+  # [announcement] An announcement to buyers (displays on the shop's home page)
+  # [message] The message sent to users who buy from this shop
+  # [image_url] The full URL to the shops's banner image
+  # [active_listings_count] The number of active listings present in this shop
+  # [url] The full URL to the shop on Etsy
+  # [favorers_count] Number of favorers
+
+  class Shop
+
+    include Etsy::Model
+
+    attributes :title, :announcement, :user_id
+
+    attribute :id, :from => :shop_id
+    attribute :image_url, :from => 'image_url_760x100'
+    attribute :active_listings_count, :from => 'listing_active_count'
+    attribute :updated, :from => :last_updated_tsz
+    attribute :created, :from => :creation_tsz
+    attribute :name, :from => :shop_name
+    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:
+    #
+    #   Etsy::Shop.find('reagent')
+    #
+    # You can find multiple shops by passing an array of identifiers:
+    #
+    #   Etsy::Shop.find(['reagent', 'littletjane'])
+    #
+    def self.find(*identifiers_and_options)
+      self.find_one_or_more('shops', identifiers_and_options)
+    end
+
+    # Retrieve a list of all shops.  By default it fetches 25 at a time, but that can
+    # be configured by passing the :limit and :offset parameters:
+    #
+    #   Etsy::Shop.all(:limit => 100, :offset => 100)
+    #
+    def self.all(options = {})
+      self.get_all("/shops", options)
+    end
+
+    # Time that this shop was created
+    #
+    def created_at
+      Time.at(created)
+    end
+
+    # Time that this shop was last updated
+    #
+    def updated_at
+      Time.at(updated)
+    end
+
+    # The collection of listings associated with this shop
+    #
+    def listings(state = nil, options = {})
+      state = state ? {:state => state} : {}
+      Listing.find_all_by_shop_id(id, state.merge(options).merge(oauth))
+    end
+
+    def sections
+      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} : {}
+    end
+  end
+end

data/lib/etsy/transaction.rb

@@ -0,0 +1,29 @@
+module Etsy
+  class Transaction
+    include Model
+
+    attribute :id, :from => :transaction_id
+    attribute :buyer_id, :from => :buyer_user_id
+    attributes :quantity, :listing_id
+
+    def self.find_all_by_shop_id(shop_id, options = {})
+      get_all("/shops/#{shop_id}/transactions", 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_receipt_id(receipt_id, options = {})
+      get_all("/receipts/#{receipt_id}/transactions", options)
+    end
+
+
+    def buyer
+      @buyer ||= User.find(buyer_id)
+    end
+
+  end
+end

data/lib/etsy/user.rb

@@ -0,0 +1,109 @@
+module Etsy
+
+  # = User
+  #
+  # Represents a single Etsy user - has the following attributes:
+  #
+  # [id] The unique identifier for this user
+  # [username] This user's username
+  # [email] This user's email address (authenticated calls only)
+  #
+  class User
+
+    include Etsy::Model
+
+    attribute :id, :from => :user_id
+    attribute :username, :from => :login_name
+    attribute :email, :from => :primary_email
+    attribute :created, :from => :creation_tsz
+
+    association :profile, :from => 'Profile'
+    association :shops, :from => 'Shops'
+
+    # Retrieve one or more users by name or ID:
+    #
+    #   Etsy::User.find('reagent')
+    #
+    # You can find multiple users by passing an array of identifiers:
+    #
+    #   Etsy::User.find(['reagent', 'littletjane'])
+    #
+    def self.find(*identifiers_and_options)
+      find_one_or_more('users', identifiers_and_options)
+    end
+
+    # Retrieve the currently authenticated user.
+    #
+    def self.myself(token, secret, options = {})
+      find('__SELF__', {:access_token => token, :access_secret => secret}.merge(options))
+    end
+
+    # The shop associated with this user.
+    #
+    def shop
+      @shop ||= shops.first
+    end
+
+    # The addresses associated with this user.
+    #
+    def addresses
+      options = (token && secret) ? {:access_token => token, :access_secret => secret} : {}
+      @addresses ||= Address.find(username, options)
+    end
+
+    # The profile associated with this user.
+    #
+    def profile
+      unless @profile
+        if associated_profile
+          @profile = Profile.new(associated_profile)
+        else
+          options = {:fields => 'user_id', :includes => 'Profile'}
+          options = options.merge(:access_token => token, :access_secret => secret) if (token && secret)
+          tmp = User.find(username, options)
+          @profile = Profile.new(tmp.associated_profile)
+        end
+      end
+      @profile
+    end
+
+    def shops
+      unless @shops
+        if associated_shops
+          @shops = associated_shops.map { |shop| Shop.new(shop) }
+        else
+          options = {:fields => 'user_id', :includes => 'Shops'}
+          options = options.merge(:access_token => token, :access_secret => secret) if (token && secret)
+          tmp = User.find(username, options)
+          @shops = tmp.associated_shops.map { |shop| Shop.new(shop) }
+        end
+      end
+      @shops
+    end
+
+    # Time that this user was created
+    #
+    def created_at
+      Time.at(created)
+    end
+
+    # Retrieve list of favorited items for this user
+    #
+    def favorites
+      unless @favorites
+        @favorites = Listing.find_all_user_favorite_listings(id, {:access_token => token, :access_secret => secret})
+      end
+      @favorites
+    end
+
+    #Return a set of listings that have been bought
+    #
+    def bought_listings
+      unless @bought_listings
+        @bought_listings = Listing.bought_listings(id, {:access_token => token, :access_secret => secret})
+      end
+      @bought_listings
+    end
+
+  end
+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/verification_request.rb

@@ -0,0 +1,17 @@
+module Etsy
+  class VerificationRequest # :nodoc:all
+
+    def client
+      @client ||= SecureClient.new
+    end
+
+    def url
+      request_token.params[:login_url]
+    end
+
+    def request_token
+      @request_token ||= client.request_token
+    end
+
+  end
+end

data/lib/etsy/version.rb

@@ -0,0 +1,3 @@
+module Etsy
+  VERSION = "0.3.2"
+end

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/address/getUserAddresses.json

@@ -0,0 +1,12 @@
+{
+  "count":2,
+  "results":[
+    {"user_address_id":123,"user_id":9876,"name":"Tinker Bell","first_line":"123 Fake St.","second_line":null,"city":"BigCity","state":"XX","zip":"12345","country_id":209,"country_name":"United States"},
+    {"user_address_id":234,"user_id":9876,"name":"LittleCorp, Inc.","first_line":"123 Fake St.","second_line":null,"city":"BigCity","state":"XX","zip":"12345","country_id":209,"country_name":"United States"}
+  ],
+  "params": {
+    "user_id":"PaisleyAnnHome","limit":25,"offset":0
+  },
+  "type":"UserAddress"
+}
+

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"
+}