tophatter-merchant 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c832485da45833a3609214742e3d25c2063997e3
-  data.tar.gz: 84e84519288868338281ec5b7814e3804be57142
+  metadata.gz: c091268959e81677d5a6ce347857d13caee1c405
+  data.tar.gz: 8d8572b11b67ff92b4bef05a4e35620911fe7590
 SHA512:
-  metadata.gz: 65e372bf3ff1d4c9027ede0e1fee567cf298dd52050cee34827f65e29cbe4648224b5027b2fac0592117cc1028076c9e6c883068c1b13376bc666de65e6efb78
-  data.tar.gz: ec19156f01994105448b45d9e489b1bac5ecce27b31f69f3046851e448dc6d50ec0772ea80174a11201f1c07232feb9d5457503bae5afdb5de0f939dd2221e2a
+  metadata.gz: c326161bedf60af88b1316e4a568435eed8e9cb1794c7a7277e52a3b2921d3518ed74cecfcd215a25d2320d1a9cb992cd98b19137170ea0373280cc6cf909bb5
+  data.tar.gz: 0e6d27b39759b3d0d44405699825b5fd7032eba74781520727c00ae2b8649fab36d0b83fa42544dbc2658ba2fbe1d5edbd08f9c7a4f0f0e5328437648355421d

data/.rubocop.yml

@@ -22,17 +22,14 @@ Metrics/ParameterLists:
 Lint/EndAlignment:
   Enabled: false
 
-Style/Documentation:
+Layout/IndentationWidth:
   Enabled: false
-Style/IndentationWidth:
+Layout/ElseAlignment:
   Enabled: false
-Style/ElseAlignment:
+
+Style/Documentation:
   Enabled: false
 Style/GuardClause:
   Enabled: false
 Style/NumericLiterals:
   Enabled: false
-
-# This is temporary - it can be remove after updating rubocop to the latest.
-Style/PercentLiteralDelimiters:
-  Enabled: false

data/Gemfile

@@ -5,12 +5,10 @@ group :development, :test do
   gem 'awesome_print'
   gem 'pry'
   gem 'rake'
-  gem 'rubocop', '0.47.1'
+  gem 'rubocop', '0.49.0'
 end
 
 group :test do
   gem 'coveralls', require: false
   gem 'rspec'
-  gem 'vcr'
-  gem 'webmock'
 end

data/README.md

@@ -24,11 +24,6 @@ TophatterMerchant.access_token = <YOUR ACCESS TOKEN>
 
 ### Products
 
-#### List the product definition.
-```ruby
-TophatterMerchant::Product.schema
-```
-
 #### List all of the products in your inventory.
 ```ruby
 TophatterMerchant::Product.all(page: 1, per_page: 100)

data/lib/tophatter_merchant.rb

@@ -1,6 +1,3 @@
-require 'active_model'
-require 'json'
-
 module TophatterMerchant
   class << self
     attr_accessor :api_path, :access_token, :logger
@@ -20,8 +17,6 @@ module TophatterMerchant
   end
 end
 
-require File.dirname(__FILE__) + '/tophatter_merchant/resource'
-require File.dirname(__FILE__) + '/tophatter_merchant/metadata'
-require File.dirname(__FILE__) + '/tophatter_merchant/order'
-require File.dirname(__FILE__) + '/tophatter_merchant/product'
-require File.dirname(__FILE__) + '/tophatter_merchant/variation'
+%w[resource metadata order product variation].each do |file|
+  require "#{File.dirname(__FILE__)}/tophatter_merchant/#{file}"
+end

data/lib/tophatter_merchant/metadata.rb

@@ -1,67 +1,54 @@
 module TophatterMerchant
   class Metadata < Resource
     class << self
-      # ap TophatterMerchant::Metadata.all
       def all
         get(url: "#{path}.json")
       end
 
-      # ap TophatterMerchant::Metadata.categories
       def categories
         get(url: "#{path}/categories.json")
       end
 
-      # ap TophatterMerchant::Metadata.conditions
       def conditions
         get(url: "#{path}/conditions.json")
       end
 
-      # ap TophatterMerchant::Metadata.brands
       def brands
         get(url: "#{path}/brands.json")
       end
 
-      # ap TophatterMerchant::Metadata.materials
       def materials
         get(url: "#{path}/materials.json")
       end
 
-      # ap TophatterMerchant::Metadata.sizes
       def sizes
         get(url: "#{path}/sizes.json")
       end
 
-      # ap TophatterMerchant::Metadata.colors
       def colors
         get(url: "#{path}/colors.json")
       end
 
-      # ap TophatterMerchant::Metadata.countries
       def countries
         get(url: "#{path}/countries.json")
       end
 
-      # ap TophatterMerchant::Metadata.country_codes
       def country_codes
         get(url: "#{path}/country_codes.json")
       end
 
-      # ap TophatterMerchant::Metadata.states
       def states
         get(url: "#{path}/states.json")
       end
 
-      # ap TophatterMerchant::Metadata.provinces
       def provinces
         get(url: "#{path}/provinces.json")
       end
 
-      # ap TophatterMerchant::Metadata.territories
       def territories
         get(url: "#{path}/territories.json")
       end
 
-      # ap TophatterMerchant::Metadata.carriers
       def carriers
         get(url: "#{path}/carriers.json")
       end

data/lib/tophatter_merchant/order.rb

@@ -1,49 +1,70 @@
 module TophatterMerchant
   class Order < Resource
-    attr_accessor :order_id, :status,
-                  :carrier, :tracking_number,
-                  :product_name, :product_identifier, :variation_identifier,
-                  :customer_id, :customer_name,
-                  :address1, :address2, :city, :state, :postal_code, :country,
-                  :available_refunds, :refund_amount, :line_items,
-                  :disbursement_amount, :seller_fees_amount, :seller_fees,
-                  :paid_at, :created_at
-
-    def id
-      created_at.present? ? identifier : nil
-    end
+    # http://merchant-api.tophatter.com/docs/order-schema
+    attr_accessor :order_id,
+                  :status,
+                  :carrier,
+                  :tracking_number,
+                  :product_name,
+                  :product_identifier,
+                  :variation_identifier,
+                  :annotation,
+                  :customer_id,
+                  :customer_name,
+                  :address1,
+                  :address2,
+                  :city,
+                  :state,
+                  :postal_code,
+                  :country,
+                  :available_refunds,
+                  :refund_amount,
+                  :disbursement_amount,
+                  :seller_fees_amount,
+                  :seller_fees,
+                  :paid_at,
+                  :created_at
 
     class << self
-      # ap TophatterMerchant::Order.schema
-      def schema
-        get(url: "#{path}/schema.json")
-      end
-
-      # ap TophatterMerchant::Order.all.map(&:to_h)
-      # ap TophatterMerchant::Order.all(filter: 'unfulfilled').map(&:to_h)
-      # ap TophatterMerchant::Order.all(filter: 'fulfilled').map(&:to_h)
+      # http://merchant-api.tophatter.com/docs/order-list
+      # TophatterMerchant::Order.all(filter: 'unfulfilled')
       def all(filter: nil, page: 1, per_page: 50)
         get(url: "#{path}.json", params: { filter: filter, page: page, per_page: per_page }).map do |hash|
           Order.new(hash)
         end
       end
 
-      # ap TophatterMerchant::Order.retrieve(681195262).to_h
+      # http://merchant-api.tophatter.com/docs/order-retrieve
+      # TophatterMerchant::Order.retrieve(60150685)
       def retrieve(id)
         Order.new get(url: "#{path}/retrieve.json", params: { order_id: id })
       end
 
-      # ap TophatterMerchant::Order.fulfill(417953232, carrier: 'other', tracking_number: 'ABC123').to_h
+      # http://merchant-api.tophatter.com/docs/order-acknowledge
+      # TophatterMerchant::Order.acknowledge(60150685).status
+      def acknowledge(id)
+        Order.new get(url: "#{path}/acknowledge.json", params: { order_id: id })
+      end
+
+      # http://merchant-api.tophatter.com/docs/order-fulfill
+      # TophatterMerchant::Order.fulfill(417953232, carrier: 'other', tracking_number: 'ABC123')
       def fulfill(id, carrier:, tracking_number:)
         Order.new post(url: "#{path}/fulfill.json", params: { order_id: id, carrier: carrier, tracking_number: tracking_number })
       end
 
-      # ap TophatterMerchant::Order.refund(417953232, type: 'full', reason: 'delay_in_shipping').to_h
-      # ap TophatterMerchant::Order.refund(417953232, type: 'partial', reason: 'other', fees: ['shipping_fee']).to_h
+      # http://merchant-api.tophatter.com/docs/order-refund
+      # TophatterMerchant::Order.refund(417953232, type: 'full', reason: 'delay_in_shipping')
+      # TophatterMerchant::Order.refund(417953232, type: 'partial', reason: 'other', fees: ['shipping_fee'])
       def refund(id, type:, reason:, fees: [])
         Order.new post(url: "#{path}/refund.json", params: { order_id: id, type: type, reason: reason, fees: fees })
       end
 
+      # http://merchant-api.tophatter.com/docs/order-annotate
+      # TophatterMerchant::Order.annotate(60157972, 'Testing...').annotation
+      def annotate(id, annotation)
+        Order.new post(url: "#{path}/annotate.json", params: { order_id: id, annotation: annotation })
+      end
+
       protected
 
       def path

data/lib/tophatter_merchant/product.rb

@@ -1,73 +1,44 @@
 module TophatterMerchant
   class Product < Resource
+    # http://merchant-api.tophatter.com/docs/product-schema
     attr_accessor :identifier,
-                  :category, :title, :description, # Basics
-                  :condition, :brand, :material, # Facets
-                  :available_quantity, :variations, # Variations
-                  :starting_bid, :buy_now_price, :retail_price, :cost_basis, # Pricing
-                  :shipping_price, :days_to_deliver, # Shipping
-                  :expedited_shipping_price, :expedited_days_to_deliver, # Shipping (Expedited)
-                  :days_to_fulfill, :shipping_origin, :weight, # Shipping (Handling)
-                  :buy_one_get_one_price, :accessory_price, :accessory_description, # Upsells
-                  :primary_image, :extra_images, :all_images, # Images
-                  :ratings_average, :ratings_count, # Ratings
-                  :created_at, :updated_at, :disabled_at, :deleted_at, # Timestamps
-                  :catalog_only_at, :in_review_at, :approved_at, :refused_at, :held_at, # SKU Lifecycle
-                  :internal_id, :slug, # Admin
-                  :admin_banned_at, :admin_hold_at, :admin_hold_responded_at, :admin_reason,
-                  :success_fee_bid_enabled, :success_fee_bid,
-                  :health_status, :health_reason
-
-    def id
-      created_at.present? ? identifier : nil
-    end
-
-    # Available: thumbnail, square, medium, large, original.
-    def images(size: 'square')
-      if persisted?
-        all_images.collect { |image| image[size] }
-      else
-        ([primary_image] + extra_images.to_s.split('|')).compact
-      end
-    end
-
-    def copy
-      hash = to_h
-
-      # Delete the keys that shouldn't be copied.
-      %w(identifier primary_image extra_images all_images ratings_average ratings_count created_at updated_at disabled_at deleted_at catalog_only_at in_review_at approved_at refused_at held_at blacklisted_at slug admin_hold_at).each do |key|
-        hash.delete(key)
-        hash['variations'].each { |variation| variation.delete(key) }
-      end
-
-      Product.new(hash)
-    end
-
-    def to_param
-      slug || identifier
-    end
+                  :internal_id,
+                  :category,
+                  :title,
+                  :description,
+                  :condition,
+                  :brand,
+                  :material,
+                  :available_quantity,
+                  :variations,
+                  :buy_now_price,
+                  :retail_price,
+                  :cost_basis,
+                  :shipping_price,
+                  :shipping_origin,
+                  :weight,
+                  :days_to_deliver,
+                  :days_to_fulfill,
+                  :expedited_shipping_price,
+                  :expedited_days_to_deliver,
+                  :buy_one_get_one_price,
+                  :primary_image,
+                  :extra_images,
+                  :all_images,
+                  :ratings_count,
+                  :ratings_average,
+                  :created_at,
+                  :updated_at,
+                  :disabled_at,
+                  :deleted_at
 
     class << self
-      # ap TophatterMerchant::Product.schema
-      def schema
-        get(url: "#{path}/schema.json")
-      end
-
-      # ap TophatterMerchant::Product.all.map(&:to_h)
+      # http://merchant-api.tophatter.com/docs/product-list
+      # TophatterMerchant::Product.all(status: 'in_stock')
       def all(status: nil, category: nil, health_status: nil, page: 1, per_page: 50, pagination: nil, sort: nil)
-        params = {
-          status: status,
-          category: category,
-          health_status: health_status,
-          page: page,
-          per_page: per_page,
-          pagination: pagination,
-          sort: sort
-        }
-
-        result = get(url: "#{path}.json", params: params)
+        result = get(url: "#{path}.json", params: { status: status, category: category, health_status: health_status, page: page, per_page: per_page, pagination: pagination, sort: sort }.reject { |_k, v| v.nil? })
 
-        if pagination.present?
+        if pagination
           result['results'] = result['results'].map { |hash| Product.new(hash) }
         else
           result = result.map { |hash| Product.new(hash) }
@@ -76,10 +47,12 @@ module TophatterMerchant
         result
       end
 
+      # http://merchant-api.tophatter.com/docs/product-search
+      # TophatterMerchant::Product.search(query: 'Kindle')
       def search(query:, page: 1, per_page: 50, pagination: nil)
         result = get(url: "#{path}/search.json", params: { query: query, page: page, per_page: per_page, pagination: pagination })
 
-        if pagination.present?
+        if pagination
           result['results'] = result['results'].map { |hash| Product.new(hash) }
         else
           result = result.map { |hash| Product.new(hash) }
@@ -88,41 +61,35 @@ module TophatterMerchant
         result
       end
 
+      # http://merchant-api.tophatter.com/docs/product-retrieve
+      # TophatterMerchant::Product.retrieve('amazon-fire-7')
       def retrieve(id)
         Product.new get(url: "#{path}/retrieve.json", params: { identifier: id })
       end
 
-      # ap TophatterMerchant::Product.create(TophatterMerchant::Product.new({}).fill!.to_h).to_h
+      # http://merchant-api.tophatter.com/docs/product-create
       def create(data)
         Product.new post(url: "#{path}.json", params: data)
       end
 
-      # ap TophatterMerchant::Product.update('FOOBAR', buy_now_price: 11).to_h
+      # http://merchant-api.tophatter.com/docs/product-update
+      # TophatterMerchant::Product.update('amazon-fire-7', brand: 'Amazon').brand
       def update(id, data)
         Product.new post(url: "#{path}/update.json", params: data.merge(identifier: id))
       end
 
-      # ap TophatterMerchant::Product.disable('FOOBAR').to_h
+      # http://merchant-api.tophatter.com/docs/product-disable
+      # TophatterMerchant::Product.disable('amazon-fire-7').disabled_at
       def disable(id)
         Product.new post(url: "#{path}/disable.json", params: { identifier: id })
       end
 
-      # ap TophatterMerchant::Product.enable('FOOBAR').to_h
+      # http://merchant-api.tophatter.com/docs/product-enable
+      # TophatterMerchant::Product.enable('amazon-fire-7').disabled_at
       def enable(id)
         Product.new post(url: "#{path}/enable.json", params: { identifier: id })
       end
 
-      # ap TophatterMerchant::Product.enable_catalog_only('FOOBAR').to_h
-      def enable_catalog_only(id)
-        Product.new post(url: "#{path}/enable_catalog_only.json", params: { identifier: id })
-      end
-
-      # ap TophatterMerchant::Product.delete('FOOBAR').to_h
-      # NOT DOCUMENTED
-      def delete(id)
-        Product.new post(url: "#{path}/delete.json", params: { identifier: id })
-      end
-
       protected
 
       def path

data/lib/tophatter_merchant/resource.rb

@@ -1,24 +1,13 @@
 module TophatterMerchant
-  class BaseException < StandardError; end
+  class BaseException           < StandardError; end
   class BadContentTypeException < BaseException; end
-  class UnauthorizedException < BaseException; end
-  class BadRequestException < BaseException; end
-  class NotFoundException < BaseException; end
-  class ServerErrorException < BaseException; end
+  class UnauthorizedException   < BaseException; end
+  class BadRequestException     < BaseException; end
+  class NotFoundException       < BaseException; end
+  class ServerErrorException    < BaseException; end
 
   class Resource
-    include ActiveModel::Model
-
     def initialize(hash)
-      self.attributes = hash
-    end
-
-    def attributes
-      self.class.attributes
-    end
-
-    def attributes=(hash)
-      # Only honor valid attributes.
       hash.each do |key, value|
         if respond_to?("#{key}=")
           send("#{key}=", value)
@@ -28,26 +17,22 @@ module TophatterMerchant
       end
     end
 
-    def persisted?
-      id.present? # @TODO: Should this be internal_id?
-    end
+    def to_hash
+      instance_variables.map do |instance_variable|
+        key   = instance_variable.to_s.delete('@')
+        value = instance_variable_get(instance_variable)
+
+        if value.is_a?(Array) && value.all? { |element| element.respond_to?(:to_hash) }
+          value = value.map(&:to_hash)
+        elsif value.respond_to?(:to_hash)
+          value = value.to_hash
+        end
 
-    def to_h
-      self.class.attributes.map { |key| [key, send(key)] }.to_h
+        value ? [key, value] : nil
+      end.compact.to_h
     end
 
     class << self
-      def attr_accessor(*vars)
-        @attributes ||= {}
-        vars.each { |var| @attributes[var.to_s] = true }
-        super(*vars)
-      end
-
-      def attributes
-        @attributes ||= {}
-        @attributes.keys
-      end
-
       protected
 
       def get(url:, params: {})
@@ -58,14 +43,6 @@ module TophatterMerchant
         execute request(method: :post, url: url, params: params)
       end
 
-      def put(url:, params: {})
-        execute request(method: :put, url: url, params: params)
-      end
-
-      def delete(url:, params: {})
-        execute request(method: :delete, url: url, params: params)
-      end
-
       def execute(request)
         TophatterMerchant.logger.debug "#{request.method.upcase} #{request.url} #{request.payload.inspect}"
         response = request.execute
@@ -86,13 +63,12 @@ module TophatterMerchant
       end
 
       def request(method:, url:, params:)
-        payload = if TophatterMerchant.access_token.present?
-          params.merge(access_token: TophatterMerchant.access_token)
-        else
-          params
-        end
-
-        RestClient::Request.new(method: method, url: url, payload: payload, accept: :json)
+        RestClient::Request.new(
+          method: method,
+          url: url,
+          payload: TophatterMerchant.access_token.empty? ? params : params.merge(access_token: TophatterMerchant.access_token),
+          headers: { accept: :json, content_type: :json }
+        )
       end
 
       def path