channeladvisor 0.1.0

data/lib/channeladvisor/client.rb

@@ -0,0 +1,3 @@
+module ChannelAdvisor
+	class Client < Savon::Client; end
+end

data/lib/channeladvisor/configuration.rb

@@ -0,0 +1,11 @@
+module ChannelAdvisor
+	class Configuration
+		attr_accessor :account_id, :developer_key, :password
+
+		def initialize
+			@account_id = nil
+			@developer_key = nil
+			@password = nil
+		end
+	end
+end

data/lib/channeladvisor/error.rb

@@ -0,0 +1,30 @@
+module ChannelAdvisor
+  class Error < StandardError; end
+
+  class SOAPFault < Error
+    attr_reader :code
+
+    def initialize(fault_obj)
+      fault = fault_obj.to_hash[:fault]
+      @code = fault[:faultcode]
+      message = fault[:faultstring]
+
+      super(message)
+    end
+  end
+
+  class HTTPError < Error
+    attr_reader :code
+
+    def initialize(error_obj)
+      error = error_obj.to_hash
+      @code = error[:code]
+      message = "Failed with HTTP error #{@code}"
+
+      super(message)
+    end
+  end
+
+  class ServiceFailure < Error; end
+end
+

data/lib/channeladvisor/line_item.rb

@@ -0,0 +1,38 @@
+module ChannelAdvisor
+  class LineItem
+    attr_accessor :id, :type, :sku, :title, :unit_price, :quantity, :allow_negative_quantity, :sale_source, :buyer_user_id,
+      :buyer_feedback_rating, :sales_source_id, :vat_rate, :tax_cost, :shipping_cost, :shipping_tax_cost, :gift_wrap_cost,
+      :gift_wrap_tax_cost, :gift_message, :gift_wrap_level, :recycling_fee, :unit_weight, :unit_of_measure, :warehouse_location,
+      :user_name, :distribution_center, :is_fba, :promo_code
+
+    def initialize(attrs={})
+      @id                       = attrs[:line_item_id]
+      @type                     = attrs[:line_item_type]
+      @sku                      = attrs[:sku]
+      @title                    = attrs[:title]
+      @unit_price               = attrs[:unit_price].to_f
+      @quantity                 = attrs[:quantity].to_i
+      @allow_negative_quantity  = attrs[:allow_negative_quantity]
+      @sale_source              = attrs[:item_sale_source]
+      @buyer_user_id            = attrs[:buyer_user_id]
+      @buyer_feedback_rating    = attrs[:buyer_feedback_rating]
+      @sales_source_id          = attrs[:sales_source_id]
+      @vat_rate                 = attrs[:vat_rate].to_f
+      @tax_cost                 = attrs[:tax_cost].to_f
+      @shipping_cost            = attrs[:shipping_cost].to_f
+      @shipping_tax_cost        = attrs[:shipping_tax_cost].to_f
+      @gift_wrap_cost           = attrs[:gift_wrap_cost].to_f
+      @gift_wrap_tax_cost       = attrs[:gift_wrap_tax_cost].to_f
+      @gift_message             = attrs[:gift_message]
+      @gift_wrap_level          = attrs[:gift_wrap_level]
+      @recycling_fee            = attrs[:recycling_fee].to_f
+      @unit_weight              = attrs[:unit_weight].to_f
+      @unit_of_measure          = attrs[:unit_of_measure]
+      @warehouse_location       = attrs[:warehouse_location]
+      @user_name                = attrs[:user_name]
+      @distribution_center      = attrs[:distribution_center_code]
+      @is_fba                   = attrs[:is_fba]
+      @promo_code               = attrs[:promo_code]
+    end # initialize
+  end # LineItem
+end # ChannelAdvisor

data/lib/channeladvisor/order.rb

@@ -0,0 +1,179 @@
+module ChannelAdvisor
+  class Order < Base
+    attr_accessor :id, :client_id, :seller_id, :state, :created_at, :updated_at, :total, :cancelled_on, :flag_description,
+    :reseller_id, :buyer_email, :buyer_ip_address, :email_opt_in, :shipping_instructions, :delivery_date, :estimated_ship_date,
+    :transaction_notes, :status, :billing_address, :shipping_address, :payment, :shipments, :shopping_cart, :custom_values
+
+    def initialize(attrs={})
+      @id                 = attrs[:order_id].to_i
+      @client_id          = attrs[:client_order_identifier]
+      @seller_id          = attrs[:seller_order_id]
+      @state              = attrs[:order_state]
+      @created_at         = attrs[:order_time_gmt]
+      @updated_at         = attrs[:last_update_date]
+      @cancelled_on       = attrs[:date_cancelled_gmt]
+      @total              = attrs[:total_order_amount].to_f
+      @reseller_id        = attrs[:reseller_id]
+      @flag_description   = attrs[:flag_description]
+      @buyer_email        = attrs[:buyer_email_address]
+      @email_opt_in       = attrs[:email_opt_in]
+      @buyer_ip_address   = attrs[:buyer_ip_address]
+      @transaction_notes  = attrs[:transaction_notes]
+      @custom_values      = attrs[:custom_value_list]
+      @status             = OrderStatus.new(attrs[:order_status])   if attrs[:order_status]
+      @payment            = Payment.new(attrs[:payment_info])       if attrs[:payment_info]
+      @billing_address    = Address.new(attrs[:billing_info])       if attrs[:billing_info]
+      @shipping_address   = Address.new(attrs[:shipping_info])      if attrs[:shipping_info]
+      @shopping_cart      = ShoppingCart.new(attrs[:shopping_cart]) if attrs[:shopping_cart]
+
+      if shipping_info = attrs[:shipping_info]
+        @shipping_instructions  = shipping_info[:shipping_instructions]
+        @estimated_ship_date    = shipping_info[:estimated_ship_date]
+        @delivery_date          = shipping_info[:delivery_date]
+
+        if shipment_list = shipping_info[:shipment_list]
+          @shipments = arrayify(shipment_list[:shipment]).map { |s| Shipment.new(s) }
+        end
+      end
+    end # initialize
+
+    # Set the export status for a given order instance
+    #
+    # @param [Boolean] mark_as_exported `true` (`Exported`) or `false` (`NotExported`)
+    #
+    # @raise [ServiceFailure] If the service returns a Failure status
+    # @raise [SOAPFault] If the service responds with a SOAP fault
+    # @raise [HTTPError] If the service responds with an HTTP error
+    #
+    # @return [Boolean] Returns the boolean result for changing the export status
+    def set_export_status(mark_as_exported)
+      handle_errors do
+        response = Services::OrderService.set_orders_export_status([@client_id], mark_as_exported)
+        result = response[:set_orders_export_status_response][:set_orders_export_status_result]
+        check_status_of result
+        return result[:result_data][:boolean]
+      end
+    end # set_export_status
+
+    def total_ship_cost
+      invoice_ship_cost || items_ship_cost
+    end
+
+    def invoice_ship_cost
+      shopping_cart.invoices.select { |i| i.type == "Shipping" }.first.unit_price.nonzero?
+    end
+
+    def items_ship_cost
+      shopping_cart.items.collect { |i| i.shipping_cost }.inject(:+)
+    end
+
+    class << self
+      # Check authorization for and availability of the order service
+      #
+      # @raise [ServiceFailure] If the service returns a Failure status
+      # @raise [SOAPFault] If the service responds with a SOAP fault
+      # @raise [HTTPError] If the service responds with an HTTP error
+      #
+      # @return [Boolean] Returns `true` if SOAP response status is `Success`
+      def ping
+        handle_errors do
+          response = Services::OrderService.ping
+          result = response[:ping_response][:ping_result]
+          check_status_of result
+        end
+      end # ping
+
+      # Retrieve a list of orders, restricted by the provided criteria
+      #
+      # @example List orders created between 11/11/2011 and 11/15/2011
+      # 	ChannelAdvisor::Order.list(:created_between => DateTime.new(2011,11,11)..DateTime.new(2011,11,15))
+      #
+      # @param [Hash] criteria Criteria used to filter the order list
+      # @option criteria [Range<DateTime>] :created_between Range of order creation date-times in UTC (instead of `created_from` and `created_to`)
+      # @option criteria [Range<DateTime>] :updated_between Range of order update date-times in UTC (instead of `updated_from` and `updated_to`)
+      # @option criteria [DateTime] :created_from Order creation begin time in UTC
+      # @option criteria [DateTime] :created_to Order creation end time in UTC
+      # @option criteria [DateTime] :updated_from Order update begin time in UTC
+      # @option criteria [DateTime] :updated_to Order update end time in UTC
+      # @option criteria [Boolean] :join_dates `true` indicates that orders can satisfy either
+      # 	the created date range or the updated date range
+      # @option criteria [String] :detail_level `Low`, `Medium`, `High` or `Complete`
+      # @option criteria [String] :export_state `Unknown`, `NotExported` or `Exported`
+      # @option criteria [Array<Integer>] :order_ids Array of order IDs
+      # @option criteria [Array<String>] :client_order_ids Array of client order IDs
+      # @option criteria [String] :state `Active`, `Archived`, or `Cancelled`
+      # @option criteria [String] :payment_status `NoChange`, `NotSubmitted`, `Cleared`, `Submitted`, `Failed`, or `Deposited`
+      # @option criteria [String] :checkout_status `NoChange`, `NotVisited`, `Completed`, `Visited`, `Cancelled`, `CompletedOffline`, or `OnHold`
+      # @option criteria [String] :shipping_status `NoChange`, `Unshipped`, `PendingShipment`, `PartiallyShipped`, or `Shipped`
+      # @option criteria [String] :refund_status `NoRefunds`, `OrderLevel`, `LineItemLevel`, `OrderAndLineItemLevel`, or `FailedAttemptsOnly`
+      # @option criteria [String] :distribution_center Only orders containing at least one item from the specified distribution center
+      # @option criteria [Integer] :page_number Page number of result set
+      # @option criteria [Integer] :page_size Size of each page in result set
+      #
+      # @raise [ServiceFailure] If the service returns a Failure status
+      # @raise [SOAPFault] If the service responds with a SOAP fault
+      # @raise [HTTPError] If the service responds with an HTTP error
+      #
+      # @return [Array<Order>] Returns an array of {Order} objects or an empty array
+      def list(criteria = {})
+        handle_errors do
+          if created_between = criteria.delete(:created_between)
+            criteria[:created_from]  = created_between.first
+            criteria[:created_to]    = created_between.last
+          end
+
+          if updated_between = criteria.delete(:updated_between)
+            criteria[:updated_from]  = updated_between.first
+            criteria[:updated_to]    = updated_between.last
+          end
+
+          response = Services::OrderService.get_order_list(criteria)
+          result = response[:get_order_list_response][:get_order_list_result]
+          check_status_of result
+          orders = []
+
+          if data = result[:result_data]
+            arrayify(data[:order_response_item]).each { |o| orders << new(o) }
+          end
+
+          return orders
+        end
+      end # list
+
+      # Set the export status for the provided client order identifiers
+      #
+      # @param client_order_ids [String, Array<String>] An client order ID or array of client order IDs
+      # @param mark_as_exported [boolean] `true` (`Exported`) or `false` (`NotExported`)
+      #
+      # @raise [ServiceFailure] If the service returns a Failure status
+      # @raise [SOAPFault] If the service responds with a SOAP fault
+      # @raise [HTTPError] If the service responds with an HTTP error
+      #
+      # @return [boolean, Hash] Returns a boolean result or hash of client order IDs and their corresponding boolean results
+      def set_export_status(client_order_ids, mark_as_exported)
+        handle_errors do
+          client_order_id_list = arrayify client_order_ids
+          response = Services::OrderService.set_orders_export_status(client_order_id_list, mark_as_exported)
+          result = response[:set_orders_export_status_response][:set_orders_export_status_result]
+          check_status_of result
+
+          bools = arrayify result[:result_data][:boolean]
+
+          if bools.count == 1
+            return bools.first
+          else
+            result_hash = {}
+
+            bools.each do |bool|
+              client_order_ids.each do |client_order_id|
+                result_hash[client_order_id] = bool
+              end
+            end
+
+            return result_hash
+          end
+        end
+      end # set_export_status
+    end # self
+  end # Order
+end # ChannelAdvisor

data/lib/channeladvisor/order_status.rb

@@ -0,0 +1,14 @@
+module ChannelAdvisor
+  class OrderStatus
+    attr_accessor :checkout, :payment, :shipping, :refund
+
+    def initialize(attrs={})
+      unless attrs.nil?
+        @checkout = [attrs[:checkout_status], attrs[:checkout_date_gmt]]
+        @payment  = [attrs[:payment], attrs[:payment_date_gmt]]
+        @shipping = [attrs[:shipping], attrs[:shipping_date_gmt]]
+        @refund   = attrs[:order_refund_status]
+      end
+    end
+  end
+end

data/lib/channeladvisor/payment.rb

@@ -0,0 +1,15 @@
+module ChannelAdvisor
+  class Payment
+    attr_accessor :type, :credit_card_number, :paypal_id, :merchant_reference_number, :transaction_id
+
+    def initialize(attrs={})
+      unless attrs.nil?
+        @type                       = attrs[:payment_type]
+        @credit_card_number         = attrs[:credit_card_last4]  
+        @paypal_id                  = attrs[:pay_pal_id]
+        @merchant_reference_number  = attrs[:merchant_reference_number]
+        @transaction_id             = attrs[:payment_transaction_id]
+      end
+    end
+  end
+end

data/lib/channeladvisor/services.rb

@@ -0,0 +1,11 @@
+require 'channeladvisor/services/base_service'
+require 'channeladvisor/services/admin_service'
+require 'channeladvisor/services/order_service'
+require 'channeladvisor/services/shipping_service'
+require 'channeladvisor/services/inventory_service'
+
+module ChannelAdvisor
+  module Services
+    
+  end
+end

data/lib/channeladvisor/services/admin_service.rb

@@ -0,0 +1,47 @@
+module ChannelAdvisor
+  module Services
+    class AdminService < BaseService
+      document "https://api.channeladvisor.com/ChannelAdvisorAPI/v6/AdminService.asmx?WSDL"
+
+      class << self
+        # Check authorization for and availability of the admin service
+        #
+        # @return [HTTPI::Response] HTTP response object containing the SOAP XML response
+        def ping
+          soap_response = client.request :ping do
+            soap.header = soap_header
+          end
+
+          @last_request = client.http
+          @last_response = soap_response
+        end # ping
+
+        # Request access to a ChannelAdvisor account
+        #
+        # @return [HTTPI::Response] HTTP response object containing the SOAP XML response
+        def request_access(local_id)
+          soap_response = client.request :request_access do
+            soap.header = soap_header
+            soap.body = {"localID" => local_id}
+          end
+
+          @last_request = client.http
+          @last_response = soap_response
+        end # request_access
+
+        # Retrieve a list of account authorizations for the given developer key
+        #
+        # @return [HTTPI::Response] HTTP response object containing the SOAP XML response
+        def get_authorization_list(local_id=nil)
+          soap_response = client.request :get_authorization_list do
+            soap.header = soap_header
+            soap.body = {"localID" => local_id} if local_id
+          end
+
+          @last_request = client.http
+          @last_response = soap_response
+        end # get_authorization_list
+      end # self
+    end # AdminService
+  end # Services
+end # ChannelAdvisor

data/lib/channeladvisor/services/base_service.rb

@@ -0,0 +1,26 @@
+module ChannelAdvisor
+  module Services
+    class BaseService
+      extend Savon::Model
+
+      class << self
+        attr_reader :last_request, :last_response
+
+      private
+
+        def soap_header
+          {
+            "ins0:APICredentials" => {
+              "ins0:DeveloperKey" => creds(:developer_key),
+              "ins0:Password"     => creds(:password)
+            }
+          }
+        end
+
+        def creds(attribute)
+          ChannelAdvisor.configuration.send(attribute.to_sym)
+        end
+      end # self
+    end # BaseService
+  end # Services
+end # ChannelAdvisor

data/lib/channeladvisor/services/inventory_service.rb

@@ -0,0 +1,90 @@
+module ChannelAdvisor
+  module Services
+    class InventoryService < BaseService
+      document "https://api.channeladvisor.com/ChannelAdvisorAPI/v6/InventoryService.asmx?WSDL"
+
+      class << self
+        def ping
+          client.request :ping do
+            soap.header = soap_header
+          end
+        end # ping
+
+        def update_inventory_item_quantity_and_price(sku, quantity_and_price_info)
+          soap_body = {
+            "ins0:accountID" => creds(:account_id),
+            "ins0:itemQuantityAndPrice" => {
+              "ins0:Sku" => sku
+            }
+          }
+
+          item_quantity_and_price = soap_body["ins0:itemQuantityAndPrice"]
+
+          if quantity_info = quantity_and_price_info[:quantity_info]
+            item_quantity_and_price["ins0:QuantityInfo"] = {
+              "ins0:UpdateType" => quantity_info[:update_type],
+              "ins0:Total"      => quantity_info[:total]
+            }
+          end
+
+          if price_info = quantity_and_price_info[:price_info]
+            item_quantity_and_price["ins0:PriceInfo"] = {
+              "ins0:Cost"                   => price_info[:cost],
+              "ins0:RetailPrice"            => price_info[:retail_price],
+              "ins0:StartingPrice"          => price_info[:starting_price],
+              "ins0:ReservePrice"           => price_info[:reserve_price],
+              "ins0:TakeItPrice"            => price_info[:take_it_price],
+              "ins0:SecondChanceOfferPrice" => price_info[:second_chance_offer_price],
+              "ins0:StorePrice"             => price_info[:store_price]
+            }
+          end
+
+          client.request :update_inventory_item_quantity_and_price do
+            soap.header = soap_header
+            soap.body = soap_body
+          end
+        end # update_inventory_item_quantity_and_price
+
+        def update_inventory_item_quantity_and_price_list(quantity_and_price_list)
+          soap_body = {
+            "ins0:accountID" => creds(:account_id),
+            "ins0:itemQuantityAndPriceList" => {
+              "ins0:InventoryItemQuantityAndPrice" => []
+            }
+          }
+
+          quantity_and_price_list.each do |item|
+            item_quantity_and_price = {"ins0:Sku" => item[:sku]}
+
+            if quantity_info = item[:quantity_info]
+              item_quantity_and_price["ins0:QuantityInfo"] = {
+                "ins0:UpdateType" => item[:quantity_info][:update_type],
+                "ins0:Total"      => item[:quantity_info][:total]
+              }
+            end
+
+            if price_info = item[:price_info]
+              item_quantity_and_price["ins0:PriceInfo"] = {
+                "ins0:Cost"                   => price_info[:cost],
+                "ins0:RetailPrice"            => price_info[:retail_price],
+                "ins0:StartingPrice"          => price_info[:starting_price],
+                "ins0:ReservePrice"           => price_info[:reserve_price],
+                "ins0:TakeItPrice"            => price_info[:take_it_price],
+                "ins0:SecondChanceOfferPrice" => price_info[:second_chance_offer_price],
+                "ins0:StorePrice"             => price_info[:store_price]
+              }
+            end
+
+            soap_body["ins0:itemQuantityAndPriceList"]["ins0:InventoryItemQuantityAndPrice"] << item_quantity_and_price
+          end
+
+
+          client.request :update_inventory_item_quantity_and_price_list do
+            soap.header = soap_header
+            soap.body = soap_body
+          end
+        end # update_inventory_item_quantity_and_price_list
+      end # self
+    end # InventoryService
+  end # Services
+end # ChannelAdvisor