zanox_publisher 0.1.0

data/lib/zanox_publisher/incentive.rb

@@ -0,0 +1,135 @@
+module ZanoxPublisher
+  # Incentives - Get coupons and other incentives
+  #
+  # The Zanox API cannot retrieve both exclusive and non-exclusive incentives, so each has its own class.
+  class Incentive < IncentiveBase
+    RESOURCE_PATH = '/incentives'
+
+    # Set the exclusive attribute
+    @@exclusive = false
+
+    class << self
+      # Retrieves all incentive's dependent on search parameters.
+      #
+      # This is equivalent to the Zanox API method SearchIncentives.
+      # The method documentation can be found under {https://developer.zanox.com/web/guest/publisher-api-2011/get-incentives}.
+      #
+      # Authentication: Requires connect ID.
+      #
+      # This can require multiple requests, as internally every page is pulled.
+      # The ZanoxPublisher::AdMedium.page function can be used to better control the requests made.
+      #
+      # @param program [Program, Integer] limits results to a particular program ID.
+      # @param adspace [AdSpace, Integer] limits results to incentives that have tracking links associated with this AdSpace.
+      # @param incentive_type [String] limits results to one of the following incentive types (API equivalent is incentiveType).
+      # @param incentiveType [String] limits results to one of the following incentive types (API name).
+      # @param region [String] limits results to a region.
+      #
+      # @return [Array<Incentive>]
+      def all(options = {})
+        retval = []
+        current_page = 0
+        options.merge!({ per_page: maximum_per_page })
+
+        begin
+          retval       += self.page(current_page, options)
+          current_page += 1
+        end while Incentive.total > retval.size
+
+        retval
+      end
+
+      # Retrieves a list of publicly available, non-exclusive incentiveItems dependent on search parameter.
+      #
+      # This is equivalent to the Zanox API method SearchIncentives.
+      # The method documentation can be found under {https://developer.zanox.com/web/guest/publisher-api-2011/get-incentives}.
+      #
+      # Authentication: Requires connect ID.
+      #
+      # @param page [Integer] the page position.
+      # @param per_page [Integer] number of items in the result set (API equivalent is items).
+      # @param items [Integer] number of items in the result set (API name).
+      # @param program [Program, Integer] limits results to a particular program ID.
+      # @param adspace [AdSpace, Integer] limits results to incentives that have tracking links associated with this AdSpace.
+      # @param incentive_type [String] limits results to one of the following incentive types (API equivalent is incentiveType).
+      # @param incentiveType [String] limits results to one of the following incentive types (API name).
+      # @param region [String] limits results to a region.
+      #
+      # @return [Array<Incentive>]
+      def page(page = 0, options = {})
+        params = { query: { page: page } }
+
+        per_page = nil
+        per_page = options[:per_page] if per_page.nil?
+        per_page = options[:items]    if per_page.nil?
+        per_page = AdMedium.per_page  if per_page.nil?
+        params[:query].merge!({ items: per_page })
+
+        program = options[:program]
+        program = program.to_i        unless program.nil?
+
+        adspace = options[:adspace]
+        adspace = adspace.to_i        unless adspace.nil?
+
+        incentive_type = options[:incentive_type]
+        incentive_type = options[:incentiveType]  if incentive_type.nil?
+        incentive_type = nil unless @@incentive_types.include? incentive_type
+
+        region = options[:region]
+
+        # Build the query on hand of the options received
+        params[:query].merge!({ program: program })               unless program.nil?
+        params[:query].merge!({ adspace: adspace })               unless adspace.nil?
+        params[:query].merge!({ incentiveType: incentive_type })  unless incentive_type.nil?
+        params[:query].merge!({ region: region })                 unless region.nil?
+
+        retval = []
+
+        response = self.connection.get(RESOURCE_PATH, params)
+
+        Incentive.total = response.fetch('total')
+
+        incentives = []
+        incentives = response.fetch('incentiveItems', {}).fetch('incentiveItem', []) if Incentive.total > 0
+        incentives = [incentives] unless incentives.is_a? Array
+
+        incentives.each do |incentive|
+          retval << Incentive.new(incentive, @@exclusive)
+        end
+
+        retval
+      end
+
+      # Returns a single incentiveItem, as queried by its ID.
+      #
+      # This is equivalent to the Zanox API method GetIncentive.
+      # The method documentation can be found under {https://developer.zanox.com/web/guest/publisher-api-2011/get-incentives-incentive}.
+      #
+      # Authentication: Requires connect ID.
+      #
+      # @param id [Integer] the ID of the adspace you want to get.
+      # @param adspace [AdSpace, Integer] if you would like tracking links for only one of your publisher ad spaces, pass its ID in this parameter.
+      #
+      # @return [<Incentive>]
+      def find(id, options = {})
+        params  = {}
+
+        adspace = options[:adspace]
+        adspace = adspace.to_i unless adspace.nil?
+
+        params  = { query: { adspace: adspace } } unless adspace.nil?
+
+        response = self.connection.get(RESOURCE_PATH + "/incentive/#{id.to_i}", params)
+
+        Incentive.new(response.fetch('incentiveItem'), @@exclusive)
+      end
+
+      # A connection instance with Incentives' relative_path
+      #
+      # @return [Connection]
+      def connection
+        @connection ||= Connection.new(RESOURCE_PATH)
+      end
+    end
+  end
+end

data/lib/zanox_publisher/incentive_base.rb

@@ -0,0 +1,89 @@
+module ZanoxPublisher
+  # Base class to hold the incentive attributes
+  #
+  # @attr [Integer]         id                    The incentiveItem's identifer from Zanox
+  # @attr [String]          name                  The name for the incentive
+  # @attr [Program]         program               The program to which the incentive belongs
+  # @attr [Array<AdMedium>] admedium              The ad medium that can be used for the incentive
+  # @attr [String]          incentive_type        The type of incentive
+  # @attr [Array<String>]   regions               The regions for the incentive
+  # @attr [DateTime]        created_at            The date the incentive is created at
+  # @attr [DateTime]        modified_at           The date the incentive is modified at
+  # @attr [DateTime]        start_date            The date the incentive will start
+  # @attr [DateTime]        end_date              The date the incentive will end
+  # @attr [String]          info_for_publisher    The information for the publisher
+  # @attr [String]          info_for_customer     The information for the customer
+  # @attr [String]          coupon_code           The coupon code assigned to the incentive
+  # @attr [Fixnum]          total                 The total amount saved through the incentive
+  # @attr [String]          currency              The currency of money amounts
+  # @attr [Fixnum]          percentage            The rebate percentage given through the incentive
+  # @attr [String]          restrictions          Any restrictions associated with the incentive
+  # @attr [Boolean]         new_customer_only     States if the incentive is only for new customers
+  # @attr [Fixnum]          minimum_basket_value  The minimum basket value to trigger the incentive
+  # @attr [Array<Prize>]    prizes                The prizes given during the incentive
+  class IncentiveBase < Base
+    @@incentive_types = %w(coupons samples bargains freeProducts noShippingCosts lotteries)
+
+    # Returns the Zanox API incentiveTypeEnum datatype
+    #
+    # @return [Array<String>]
+    def self.incentive_types
+      @@incentive_types
+    end
+
+    def initialize(data = {}, exclusive = false)
+      @id                   = data.fetch('@id')
+      @name                 = data.fetch('name')
+      @program              = Program.new(data.fetch('program'))
+      @admedium             = AdMedium.new(data.fetch('admedia').fetch('admediumItem'))
+      @incentive_type       = data.fetch('incentiveType')
+      @regions              = data.fetch('regions', []).first
+      @regions              = @regions.fetch('region') unless @regions.nil?
+      @regions              = [@regions] if @regions.is_a? String
+      @created_at           = data.fetch('createDate')
+      @modified_at          = data.fetch('modifiedDate')
+      @start_date           = data.fetch('startDate')
+      @end_date             = data.fetch('endDate', nil)
+      @info_for_publisher   = data.fetch('info4publisher', nil)
+      @info_for_customer    = data.fetch('info4customer')
+      @coupon_code          = data.fetch('couponCode', nil)
+      @total                = data.fetch('total', nil)
+      @currency             = data.fetch('currency', nil)
+      @percentage           = data.fetch('percentage', nil)
+      @restrictions         = data.fetch('restrictions', nil)
+      @new_customer_only    = data.fetch('newCustomerOnly')
+      @minimum_basket_value = data.fetch('minimumBasketValue', nil)
+      @prizes               = data.fetch('prizes', '')
+      @prizes               = nil if @prizes == ''
+      @prizes               = @prizes.fetch('prize') unless @prizes.nil?
+      @prizes               = @prizes.map{ |hash| Prize.new(hash) } unless @prizes.nil?
+      @exclusive            = exclusive
+    end
+
+    # Returns the incentiveItems' ID as integer representation
+    #
+    # @return [Integer]
+    def to_i
+      @id
+    end
+
+    attr_accessor :id, :name, :program, :admedium, :incentive_type,
+                  :regions, :created_at, :modified_at, :start_date,
+                  :end_date, :info_for_publisher, :info_for_customer,
+                  :coupon_code, :total, :currency, :percentage, :restrictions,
+                  :new_customer_only, :minimum_basket_value, :prizes, :exclusive
+
+    # make API names available
+    alias admedia admedium
+    alias incentiveType incentive_type
+    alias createDate created_at
+    alias modifiedDate modified_at
+    alias startDate start_date
+    alias endDate end_date
+    alias info4publisher info_for_publisher
+    alias info4customer info_for_customer
+    alias couponCode coupon_code
+    alias newCustomerOnly new_customer_only
+    alias minimumBasketValue minimum_basket_value
+  end
+end

data/lib/zanox_publisher/policy.rb

@@ -0,0 +1,42 @@
+module ZanoxPublisher
+  class Policy
+    class << self
+      def fetch(data = nil)
+        # To support API of picking categories of hash with [] notation
+        return nil if data.nil?
+
+        # Try to fetch policy else make data it an array
+        policies = data.fetch('policy', nil)
+        policies = [data]     if policies.nil?
+        policies = [policies] if policies.is_a? Hash
+
+        # Build the return value
+        retval = []
+
+        policies.each do |policy|
+          retval << Policy.new(policy)
+        end
+
+        retval
+      end
+    end
+
+    attr_reader :id, :name
+
+    def initialize(data = {})
+      @id   = data.fetch('@id').to_i
+      @name = data.fetch('$', nil)
+    end
+
+    def to_s
+      @name
+    end
+
+    # Returns the policy ID as integer representation
+    #
+    # @return [Integer]
+    def to_i
+      @id
+    end
+  end
+end

data/lib/zanox_publisher/prize.rb

@@ -0,0 +1,18 @@
+module ZanoxPublisher
+  # Wrapper for the prizes response from Zanox API
+  class Prize
+    attr_reader :id, :name, :description, :count, :rank
+
+    def initialize(data = {})
+      @id           = data.fetch('@id')
+      @name         = data.fetch('name')
+      @description  = data.fetch('description')
+      @count        = data.fetch('count')
+      @rank         = data.fetch('rank')
+    end
+
+    def to_i
+      @id
+    end
+  end
+end

data/lib/zanox_publisher/product.rb

@@ -0,0 +1,263 @@
+module ZanoxPublisher
+  # Products
+  #
+  # Get products, including their tracking links
+  #
+  # @attr [String]              id                    The productItem's identifer from Zanox
+  # @attr [String]              name                  The name for the product
+  # @attr [DateTime]            modified_at           The date the incentive is modified at
+  # @attr [Program]             program               The program to which the product belongs
+  # @attr [Fixnum]              price                 The price of the product
+  # @attr [String]              currency              The currency of the price
+  # @attr [Array<TrackingLink>] tracking_links        The tracking links of the product for each ad space
+  # @attr [String]              description           The product description
+  # @attr [String]              description_long      The long version of the product description
+  # @attr [String]              manufacturer          The products' manufacturer
+  # @attr [String]              ean                   The products' EAN
+  # @attr [String]              delivery_time         The delivery time for the product
+  # @attr [String]              terms                 The terms and conditions of the product
+  # @attr [Category]            category              The advertisers' given category to the product
+  # @attr [Hash]                image                 The product image's
+  # @attr [Fixnum]              price_old             The old price of the product
+  # @attr [String]              shipping_costs        The shipping costs for the product
+  # @attr [String]              shipping              The shipping costs for the product
+  # @attr [String]              merchant_category     The merchants' category for the product
+  # @attr [String]              merchant_product_id   The merchants' product ID
+  class Product < Base
+    RESOURCE_PATH = '/products'
+
+    class << self
+      # Retrieves all products dependent on search parameters.
+      #
+      # This is equivalent to the Zanox API method SearchProducts.
+      # The method documentation can be found under {https://developer.zanox.com/web/guest/publisher-api-2011/get-products}.
+      #
+      # Authentication: Requires connect ID.
+      #
+      # This can require multiple requests, as internally every page is pulled.
+      # The ZanoxPublisher::Product.page function can be used to better control the requests made.
+      #
+      # @param query [String] Limits results to programs associated with this search string (API equivalent is q).
+      # @param q [String] Limits results to programs associated with this search string (API name).
+      # @param region [String] Limits results to a particular region.
+      # @param minimum_price [Integer] Limits results to products with a minimum, currency-independent price (API equivalent is minprice).
+      # @param minprice [Integer] Limits results to products with a minimum, currency-independent price (API name).
+      # @param maximum_price [Integer] Limits results to products with a maximum, currency-independent price (API equivalent is maxprice).
+      # @param maxprice [Integer] Limits results to products with a maximum, currency-independent price (API name).
+      # @param programs [Program, Integer, Array<Program>, Array<Integer>] Limits results to particular program ID(s).
+      # @param has_images [Boolean] Limits results to products with images (API equivalent is hasimages).
+      # @param hasimages [Boolean] Limits results to products with images (API name).
+      # @param adspace [AdSpace, Integer] limits results to incentives that have tracking links associated with this AdSpace.
+      # @param partnership [String] Enables search in all product data regardless of whether you are confirmed by the advertiser or not.
+      # @param ean [Integer, String] Limit on hand of the international article number.
+      # @param merchant_category [String, Array<String>] Limits results to the specified merchant category/categories.
+      # @param merchantcategory [String, Array<String>] Limits results to the specified merchant category/categories.
+      #
+      # @return [Array<Product>]
+      def all(options = {})
+        retval = []
+        current_page = 0
+        options.merge!({ per_page: maximum_per_page })
+
+        begin
+          retval       += self.page(current_page, options)
+          current_page += 1
+        end while Product.total > retval.size
+
+        retval
+      end
+
+      # Retrieves the requested page of product items dependent on search parameters.
+      #
+      # This is equivalent to the Zanox API method SearchProducts.
+      # The method documentation can be found under {https://developer.zanox.com/web/guest/publisher-api-2011/get-products}.
+      #
+      # Authentication: Requires connect ID.
+      #
+      # @param page [Integer] the page position
+      # @param per_page [Integer] number of items in the result set (API equivalent is items)
+      # @param items [Integer] number of items in the result set (API name)
+      # @param query [String] Limits results to programs associated with this search string (API equivalent is q).
+      # @param q [String] Limits results to programs associated with this search string (API name).
+      # @param region [String] Limits results to a particular region.
+      # @param minimum_price [Integer] Limits results to products with a minimum, currency-independent price (API equivalent is minprice).
+      # @param minprice [Integer] Limits results to products with a minimum, currency-independent price (API name).
+      # @param maximum_price [Integer] Limits results to products with a maximum, currency-independent price (API equivalent is maxprice).
+      # @param maxprice [Integer] Limits results to products with a maximum, currency-independent price (API name).
+      # @param programs [Program, Integer, Array<Program>, Array<Integer>] Limits results to particular program ID(s).
+      # @param has_images [Boolean] Limits results to products with images (API equivalent is hasimages).
+      # @param hasimages [Boolean] Limits results to products with images (API name).
+      # @param adspace [AdSpace, Integer] limits results to incentives that have tracking links associated with this AdSpace.
+      # @param partnership [String] Enables search in all product data regardless of whether you are confirmed by the advertiser or not.
+      # @param ean [Integer, String] Limit on hand of the international article number.
+      # @param merchant_category [String, Array<String>] Limits results to the specified merchant category/categories.
+      # @param merchantcategory [String, Array<String>] Limits results to the specified merchant category/categories.
+      #
+      # @return [Array<Product>]
+      def page(page = 0, options = {})
+        params = { query: { page: page } }
+
+        per_page = nil
+        per_page = options[:per_page] if per_page.nil?
+        per_page = options[:items]    if per_page.nil?
+        per_page = Product.per_page  if per_page.nil?
+        params[:query].merge!({ items: per_page })
+
+        query = options[:query]
+        query = options[:q]       if query.nil?
+
+        if not query.nil?
+          if query.length <= 25
+            searchtype = 'phrase'
+          else
+            searchtype = 'contextual'
+          end
+        end
+
+        region = options[:region]
+
+        minimum_price = options[:minimum_price]
+        minimum_price = options[:minprice]      if minimum_price.nil?
+        minimum_price = minimum_price.to_i      unless minimum_price.nil?
+
+        maximum_price = options[:maximum_price]
+        maximum_price = options[:maxprice]      if maximum_price.nil?
+        maximum_price = maximum_price.to_i      unless maximum_price.nil?
+
+        programs = options[:programs]
+
+        unless programs.nil?
+          programs = programs.map(&:to_i).join(',') if programs.is_a? Array
+          programs = programs.to_i                  if programs.is_a? Program or programs.is_a? Integer
+        end
+
+        has_images = options[:has_images]
+        has_images = options[:hasimages]  if has_images.nil?
+
+        adspace = options[:adspace]
+        adspace = adspace.to_i unless adspace.nil?
+
+        partnership = options[:partnership]
+        partnership = nil unless ['all', 'confirmed'].include? partnership
+
+        ean = options[:ean]
+
+        merchant_category = options[:merchant_category]
+        merchant_category = options[:merchantcategory]  if merchant_category.nil?
+
+        unless merchant_category.nil?
+          if merchant_category.is_a? Array
+            merchant_category.each { |category| params[:query].merge!({ merchantcategory: category }) }
+          else
+            params[:query].merge!({ merchantcategory: merchant_category })
+          end
+        end
+
+        params[:query].merge!({ q: query })                       unless query.nil?
+        params[:query].merge!({ searchtype: searchtype })         unless query.nil?
+        params[:query].merge!({ region: region })                 unless region.nil?
+        params[:query].merge!({ minprice: minimum_price })        unless minimum_price.nil?
+        params[:query].merge!({ maxprice: maximum_price })        unless maximum_price.nil?
+        params[:query].merge!({ programs: programs })             unless programs.nil?
+        params[:query].merge!({ hasimages: has_images })          unless has_images.nil?
+        params[:query].merge!({ adspace: adspace })               unless adspace.nil?
+        params[:query].merge!({ partnership: partnership })       unless partnership.nil?
+        params[:query].merge!({ ean: ean })                       unless ean.nil?
+
+        retval = []
+
+        response = self.connection.get(RESOURCE_PATH, params)
+
+        Product.total = response.fetch('total')
+
+        products = []
+        products = response.fetch('productItems', {}) if Product.total > 0
+        products = {} unless products.is_a? Hash
+        products = products.fetch('productItem', [])
+
+        products.each do |product|
+          retval << Product.new(product)
+        end
+
+        retval
+      end
+
+      # Returns a single productItem, as queried by its ID.
+      #
+      # This is equivalent to the Zanox API method GetProduct.
+      # The method documentation can be found under {https://developer.zanox.com/web/guest/publisher-api-2011/get-products-product}.
+      #
+      # Authentication: Requires connect ID.
+      #
+      # @param id [Integer] the ID of the adspace you want to get.
+      # @param adspace [AdSpace, Integer] if you would like tracking links for only one of your publisher ad spaces, pass its ID in this parameter.
+      #
+      # @return [<Product>]
+      def find(id, options = {})
+        params  = {}
+
+        adspace = options[:adspace]
+        adspace = adspace.to_i unless adspace.nil?
+
+        params  = { query: { adspace: adspace } } unless adspace.nil?
+
+        response = self.connection.get(RESOURCE_PATH + "/product/#{id.to_i}", params)
+
+        Product.new(response.fetch('productItem').first)
+      end
+
+      # A connection instance with Products' relative_path
+      #
+      # @return [Connection]
+      def connection
+        @connection ||= Connection.new(RESOURCE_PATH)
+      end
+    end
+
+    def initialize(data = {})
+      @id                   = data.fetch('@id')
+      @name                 = data.fetch('name')
+      @modified_at          = data.fetch('modified')
+      @program              = Program.new(data.fetch('program'))
+      @price                = data.fetch('price')
+      @currency             = data.fetch('currency')
+      @tracking_links       = TrackingLink.fetch(data.fetch('trackingLinks', {})['trackingLink'])
+      @description          = data.fetch('description', nil)
+      @description_long     = data.fetch('descriptionLong', nil)
+      @manufacturer         = data.fetch('manufacturer', nil)
+      @ean                  = data.fetch('ean', nil)
+      @delivery_time        = data.fetch('deliveryTime', nil)
+      @terms                = data.fetch('terms', nil)
+      @category             = data.fetch('category', nil)
+      @category             = Category.new(@category) unless @category.nil?
+      @image                = data.fetch('image', nil)
+      @price_old            = data.fetch('priceOld', nil)
+      @shipping_costs       = data.fetch('shippingCosts', nil)
+      @shipping             = data.fetch('shipping', nil)
+      @merchant_category    = data.fetch('merchantCategory', nil)
+      @merchant_product_id  = data.fetch('merchantProductId', nil)
+    end
+
+    # Returns the productItems' ID as integer representation
+    #
+    # @return [Integer]
+    def to_i
+      @id
+    end
+
+    attr_accessor :id, :name, :modified_at, :program, :price, :currency, :tracking_links,
+                  :description, :description_long, :manufacturer, :ean, :delivery_time,
+                  :terms, :category, :image, :price_old, :shipping_costs, :shipping,
+                  :merchant_category, :merchant_product_id
+
+    # make API names available
+    alias modified modified_at
+    alias trackingLinks tracking_links
+    alias descriptionLong description_long
+    alias deliveryTime delivery_time
+    alias priceOld price_old
+    alias shippingCosts shipping_costs
+    alias merchantCategory merchant_category
+    alias merchantProductId merchant_product_id
+  end
+end

data/lib/zanox_publisher/profile.rb

@@ -0,0 +1,123 @@
+module ZanoxPublisher
+  # Profile information
+  #
+  # Get and update your profile information
+  #
+  # @attr [Integer] id              The profileItem's identifer from Zanox
+  # @attr [Fixnum]  adrank          The adrank
+  # @attr [String]  first_name      The first name of the profile holder
+  # @attr [String]  last_name       The last name of the profile holder
+  # @attr [String]  email           The email address of the profile
+  # @attr [String]  country         The country of the profile
+  # @attr [String]  street1         The first adress line
+  # @attr [String]  city            The city of the profile
+  # @attr [String]  zipcode         The zip code of the profile
+  # @attr [String]  login_name      The login name of the profile
+  # @attr [String]  user_name       The user name of the profile
+  # @attr [String]  title           The title of the profile holder
+  # @attr [String]  currency        The currency of the account
+  # @attr [String]  language        The language setting of the account
+  # @attr [String]  fax             The fax number of the profile holder
+  # @attr [String]  mobile          The mobile number of the profile holder
+  # @attr [String]  phone           The phone number of the profile holder
+  # @attr [String]  street2         The second adress line
+  # @attr [String]  company         The company to which the profile belongs
+  # @attr [Boolean] is_advertiser   The account is an advertiser account
+  # @attr [Boolean] is_sublogin     The account is a sublogin of a main account
+  class Profile
+    RESOURCE_PATH = '/profiles'
+
+    class << self
+      # Get all profiles associated to the connect ID.
+      #
+      # This is equivalent to the Zanox API method getProfiles.
+      # The method documentation can be found under {https://developer.zanox.com/web/guest/publisher-api-2011/get-profiles}.
+      #
+      # Authentication: Requires signature.
+      #
+      # @return [Array<Profile>]
+      #
+      # @example
+      #           profiles = ZanoxPublisher::Profile.all #=> [#<Profile ...>]
+      #           profile  = profiles.first #=> #<Profile ...>
+      def all
+        response = self.connection.signature_get()
+        data = response.fetch('profileItem')
+        profiles = []
+
+        data.each do |profile|
+          profiles << Profile.new(profile)
+        end
+
+        profiles
+      end
+
+      # Get the first profiles' information.
+      #
+      # This gives convenient access to your main profile,
+      # as often the Zanox API getProfiles method will only return
+      # one profileItem.
+      #
+      # @return [Profile]
+      #
+      # @example
+      #           my_profile = ZanoxPublisher::Profile.first #=> #<Profile ...>
+      def first
+        Profile.all.first
+      end
+
+      # A connection instance with Profiles' relative_path
+      #
+      # @return [Connection]
+      def connection
+        @connection ||= Connection.new(RESOURCE_PATH)
+      end
+    end
+
+    # TODO: PUT {https://developer.zanox.com/web/guest/publisher-api-2011/put-profiles}
+    #
+    def initialize(data = {})
+      @id           = data.fetch('@id').to_i
+      @adrank       = data.fetch('adrank')
+      @firstName    = data.fetch('firstName')
+      @lastName     = data.fetch('lastName')
+      @email        = data.fetch('email')
+      @country      = data.fetch('country')
+      @street1      = data.fetch('street1')
+      @city         = data.fetch('city')
+      @zipcode      = data.fetch('zipcode')
+      @loginName    = data.fetch('loginName')
+      @userName     = data.fetch('userName')
+      @isAdvertiser = data.fetch('isAdvertiser')
+      @isSublogin   = data.fetch('isSublogin')
+      # Optionally returned data
+      @title        = data.fetch('title', nil)
+      @currency     = data.fetch('currency', nil)
+      @language     = data.fetch('language', nil)
+      @fax          = data.fetch('fax', nil)
+      @mobile       = data.fetch('mobile', nil)
+      @phone        = data.fetch('phone', nil)
+      @street2      = data.fetch('street2', nil)
+      @company      = data.fetch('company', nil)
+    end
+
+    # Returns the profileItems' ID as integer representation
+    #
+    # @return [Integer]
+    def to_i
+      @id
+    end
+
+    attr_accessor :id, :adrank, :first_name, :last_name, :email, :country, :street1, :city,
+      :zipcode, :login_name, :user_name, :is_advertiser, :is_sublogin,
+      :title, :currency, :language, :fax, :mobile, :phone, :street2, :company
+
+    # make API names available
+    alias firstName first_name
+    alias lastName last_name
+    alias loginName login_name
+    alias userName user_name
+    alias isAdvertiser is_advertiser
+    alias isSublogin is_sublogin
+  end
+end