cadooz 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab2ddfaf51e4f3d4a9738c44d67e5f27613c4f94
+  data.tar.gz: 9cdf595ef7b41eb4e65859c89a7d3413034aaa8e
+SHA512:
+  metadata.gz: a9a1ddef2d7d4aa5baadc7d73721f3addcf6e6d0b25b85446762bb913cb1e35dfc82fda25875c722d423dfb608ec5b71b6efc33679dc0a232f464ab9e01b5c18
+  data.tar.gz: c4a0cb0b900188cace244816f618f9a19d8b923792acc1fc911406cf907c20ae9dee4d3d11718d77b4c477f799380e5e7dabb5ef5afd9fb3b4adfe1f47891cf2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Smartly, Inc. 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,2 @@
+# cadooz
+Ruby Wrapper for the cadooz SOAP Business Order web service

data/Rakefile

@@ -0,0 +1,23 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'cadooz'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks

data/lib/cadooz.rb

@@ -0,0 +1,55 @@
+require 'json'
+require 'money'
+require 'ostruct'
+require 'pry'
+require 'savon'
+
+module Cadooz
+  class Configuration
+    attr_accessor :username, :password, :wsdl, :generation_profile
+
+    WSDL = 'https://webservices.cadooz.com/services/businessorder/1.5.2/BusinessOrderService/BusinessOrder?wsdl'
+    TEST_USERNAME = 'cadooz'
+    TEST_PASSWORD = 'Cadooz2015'
+
+    def initialize(username, password, generation_profile)
+      self.username = username || TEST_USERNAME
+      self.password = password || TEST_PASSWORD
+      self.wsdl = WSDL
+      self.generation_profile = generation_profile
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new(nil, nil, nil)
+  end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+
+  module Immutable end
+  module Mutable end
+end
+
+require_relative 'mixins'
+require_relative 'cadooz/models/immutable/address'
+require_relative 'cadooz/models/immutable/attributes'
+require_relative 'cadooz/models/immutable/catalog'
+require_relative 'cadooz/models/immutable/catalog_product'
+require_relative 'cadooz/models/immutable/catalog_product_variation'
+require_relative 'cadooz/models/immutable/generation_profile_product'
+require_relative 'cadooz/models/immutable/greeting_card'
+require_relative 'cadooz/models/immutable/invoice_information'
+require_relative 'cadooz/models/immutable/order'
+require_relative 'cadooz/models/immutable/order_position'
+require_relative 'cadooz/models/immutable/order_status'
+require_relative 'cadooz/models/immutable/payment'
+require_relative 'cadooz/models/immutable/product_category'
+require_relative 'cadooz/models/immutable/voucher'
+require_relative 'cadooz/models/mutable/address'
+require_relative 'cadooz/models/mutable/greeting_card'
+require_relative 'cadooz/models/mutable/invoice_information'
+require_relative 'cadooz/models/mutable/order'
+require_relative 'cadooz/models/mutable/order_position'
+require_relative 'cadooz/services/business_order_service'

data/lib/cadooz/models/immutable/address.rb

@@ -0,0 +1,25 @@
+class Cadooz::Immutable::Address
+  include Mixins
+
+  attr_reader :city, :company, :country, :department, :email, :firstname,
+              :lastname, :phone, :salutation, :state, :street,
+              :street_add_on, :zip_code
+
+  def initialize(open_struct)
+    @city = open_struct&.city
+    @company =open_struct&.company
+    @country = open_struct&.country
+    @department = open_struct&.department
+    @email = open_struct&.email
+    @firstname = open_struct&.firstname
+    @lastname = open_struct&.lastname
+    @phone = open_struct&.phone
+    @salutation = open_struct&.salutation
+    @state = open_struct&.state
+    @street = open_struct&.street
+    @street_add_on = open_struct&.street_add_on
+    @zip_code = open_struct&.zipcode
+
+    self.freeze
+  end
+end

data/lib/cadooz/models/immutable/attributes.rb

@@ -0,0 +1,15 @@
+class Cadooz::Immutable::Attributes
+  include Mixins
+
+  attr_reader :attribute, :values
+
+  def initialize(open_struct)
+    @attribute = open_struct&.attribute
+    @values = open_struct&.values
+                         &.map_entries
+                         &.elements
+                         &.inject({}) { |hash, element| hash.merge(element.key.to_sym => element.value) }
+
+    self.freeze
+  end
+end

data/lib/cadooz/models/immutable/catalog.rb

@@ -0,0 +1,14 @@
+class Cadooz::Immutable::Catalog
+  include Mixins
+
+  attr_reader :id, :name, :description, :products
+
+  def initialize(open_struct)
+    @id = open_struct&.id
+    @name = open_struct&.name
+    @description = open_struct&.description
+    @products = Array(open_struct&.products)&.each_with_object([]) { |p, arr| arr << Cadooz::Immutable::CatalogProduct.new(p) }
+
+    self.freeze
+  end
+end

data/lib/cadooz/models/immutable/catalog_product.rb

@@ -0,0 +1,19 @@
+class Cadooz::Immutable::CatalogProduct
+  include Mixins
+
+  attr_reader :attributes, :categories, :mobile_shippable, :name, :number, :offline_shippable, :online_shippable, :type, :variations
+
+  def initialize(open_struct)
+    @attributes = Array(open_struct&.attributes)&.each_with_object([]) { |a, arr| arr << Cadooz::Immutable::Attributes.new(a) }
+    @categories = Array(open_struct&.categories)&.each_with_object([]) { |c, arr| arr << Cadooz::Immutable::ProductCategory.new(c) }
+    @mobile_shippable = open_struct&.mobile_shippable
+    @name = open_struct&.name
+    @number = open_struct&.number
+    @offline_shippable = open_struct&.offline_shippable
+    @online_shippable = open_struct&.online_shippable
+    @type = open_struct&.type
+    @variations = Array(open_struct&.variations)&.each_with_object([]) { |v, arr| arr << Cadooz::Immutable::CatalogProductVariation.new(v) }
+
+    self.freeze
+  end
+end

data/lib/cadooz/models/immutable/catalog_product_variation.rb

@@ -0,0 +1,14 @@
+class Cadooz::Immutable::CatalogProductVariation
+  include Mixins
+
+  attr_reader :currency, :name, :number, :value
+
+  def initialize(open_struct)
+    @currency = open_struct&.currency
+    @name = open_struct&.name
+    @number = open_struct&.number
+    @value = Money.new((open_struct&.value.to_f * 100) || 0, @currency || 'USD')
+
+    self.freeze
+  end
+end

data/lib/cadooz/models/immutable/generation_profile_product.rb

@@ -0,0 +1,14 @@
+class Cadooz::Immutable::GenerationProfileProduct
+  include Mixins
+
+  attr_reader :cadooz_product_number, :custom_value, :external_product_number, :value
+
+  def initialize(open_struct)
+    @cadooz_product_number = open_struct&.cadooz_product_number
+    @custom_value = open_struct&.custom_value
+    @external_product_number = open_struct&.external_product_number
+    @value = open_struct&.value
+
+    self.freeze
+  end
+end

data/lib/cadooz/models/immutable/greeting_card.rb

@@ -0,0 +1,12 @@
+class Cadooz::Immutable::GreetingCard
+  include Mixins
+
+  attr_reader :subject, :text
+
+  def initialize(open_struct)
+    @subject = open_struct&.subject
+    @text = open_struct&.text
+
+    self.freeze
+  end
+end

data/lib/cadooz/models/immutable/invoice_information.rb

@@ -0,0 +1,12 @@
+class Cadooz::Immutable::InvoiceInformation
+  include Mixins
+
+  attr_reader :debitor_number, :value
+
+  def initialize(open_struct)
+    @debitor_number = open_struct&.debitor_number
+    @value = open_struct&.value
+
+    self.freeze
+  end
+end

data/lib/cadooz/models/immutable/order.rb

@@ -0,0 +1,34 @@
+class Cadooz::Immutable::Order
+  include Mixins
+
+  attr_reader :client, :commission, :cost_owner, :cost_unit, :credit_or_number,
+              :customer_reference_number, :delivery_address, :generation_profile,
+              :greeting_card, :invoice_address, :invoice_information, :language,
+              :order_attributes, :order_description, :order_positions, :payment_informations,
+              :queue, :send_mail, :test, :website
+
+  def initialize(open_struct)
+    @client = open_struct&.client
+    @commission = open_struct&.commission
+    @cost_owner = open_struct&.cost_owner
+    @cost_unit = open_struct&.cost_unit
+    @credit_or_number = open_struct&.credit_or_number
+    @customer_reference_number = open_struct&.customer_reference_number
+    @delivery_address = Cadooz::Immutable::Address.new(open_struct&.delivery_address)
+    @generation_profile = open_struct&.generation_profile
+    @greeting_card = Cadooz::Immutable::GreetingCard.new(open_struct&.greeting_card)
+    @invoice_address = Cadooz::Immutable::Address.new(open_struct&.invoice_address)
+    @invoice_information = Array(open_struct&.invoice_information)&.each_with_object([]) { |i, arr| arr << Cadooz::Immutable::InvoiceInformation.new(i) }
+    @language = open_struct&.language
+    @order_attributes = open_struct&.order_attributes&.inject({}) { |hash, element| hash.merge(element.key.to_sym => element.value) }
+    @order_description = open_struct&.order_description
+    @order_positions = Array(open_struct&.order_positions)&.each_with_object([]) { |o, arr| arr << Cadooz::Immutable::OrderPosition.new(o) }
+    @payment_informations = open_struct&.payment_informations
+    @queue = open_struct&.queue
+    @send_mail = open_struct&.send_mail
+    @test = open_struct&.test
+    @website = open_struct&.website
+
+    self.freeze
+  end
+end

data/lib/cadooz/models/immutable/order_position.rb

@@ -0,0 +1,24 @@
+class Cadooz::Immutable::OrderPosition
+  include Mixins
+
+  attr_reader :amount, :attributes, :cadooz_product_number, :currency,
+              :delivery_address, :external_reference_number, :greeting_card,
+              :value, :voucher_address, :voucher_address_editable,
+              :voucher_address_preset
+
+  def initialize(open_struct)
+    @amount = open_struct&.amount
+    @attributes = open_struct&.attributes&.inject({}) { |hash, element| hash.merge(element.key.to_sym => element.value) }
+    @cadooz_product_number = open_struct&.cadooz_product_number
+    @currency = open_struct&.currency
+    @delivery_address = open_struct&.delivery_address
+    @external_reference_number = open_struct&.external_reference_number
+    @greeting_card = open_struct&.greeting_card
+    @value = open_struct&.value
+    @voucher_address = open_struct&.voucher_address
+    @voucher_address_editable = open_struct&.voucher_address_editable
+    @voucher_address_preset = open_struct&.voucher_address_preset
+
+    self.freeze
+  end
+end

data/lib/cadooz/models/immutable/order_status.rb

@@ -0,0 +1,18 @@
+class Cadooz::Immutable::OrderStatus
+  include Mixins
+
+  attr_reader :delivery_state, :message, :order_number, :order_state,
+              :packet_number, :return_reason, :shipping_provider
+
+  def initialize(open_struct)
+    @delivery_state = open_struct&.delivery_state
+    @message = open_struct&.message
+    @order_number = open_struct&.order_number
+    @order_state = open_struct&.order_state
+    @packet_number = open_struct&.packet_number
+    @return_reason = open_struct&.return_reason
+    @shipping_provider = open_struct&.shipping_provider
+
+    self.freeze
+  end
+end

data/lib/cadooz/models/immutable/payment.rb

@@ -0,0 +1,19 @@
+class Cadooz::Immutable::Payment
+  include Mixins
+
+  attr_reader :attributes, :description, :paid, :type, :value, :verified
+
+  def initialize(open_struct)
+    @attributes = open_struct&.attributes
+                             &.map_entries
+                             &.elements
+                             &.inject({}) { |hash, element| hash.merge(element.key.to_sym => element.value) }
+    @description = open_struct&.description
+    @paid = open_struct&.paid
+    @type = open_struct&.type
+    @value = open_struct&.value
+    @verified = open_struct&.verified
+
+    self.freeze
+  end
+end

data/lib/cadooz/models/immutable/product_category.rb

@@ -0,0 +1,17 @@
+class Cadooz::Immutable::ProductCategory
+  include Mixins
+
+  attr_reader :id, :description, :internal_name, :shop_name
+
+  def initialize(open_struct)
+    @id = open_struct&.id
+    @description = open_struct&.description
+    @internal_name = open_struct&.internal_name
+    @shop_name = open_struct&.shop_name
+                            &.map_entries
+                            &.elements
+                            &.inject({}) { |hash, element| hash.merge(element.key.to_sym => element.value) }
+
+    self.freeze
+  end
+end

data/lib/cadooz/models/immutable/voucher.rb

@@ -0,0 +1,23 @@
+class Cadooz::Immutable::Voucher
+  include Mixins
+
+  attr_reader :address, :code, :ecard_link, :evoucher_link,
+              :pin, :product_name, :product_number,
+              :product_variation_number, :serial_number, :value
+
+  def initialize(open_struct)
+    @address = Cadooz::Immutable::Address.new(open_struct&.address)
+    @code = open_struct&.code
+    @currency = open_struct&.currency
+    @ecard_link = open_struct&.ecard_link
+    @evoucher_link = open_struct&.evoucher_link
+    @pin = open_struct&.pin
+    @product_name = open_struct&.product_name
+    @product_number = open_struct&.product_number
+    @product_variation_number = open_struct&.product_variation_number
+    @serial_number = open_struct&.serial_number
+    @value = Money.new((open_struct&.value.to_f * 100) || 0, @currency || 'USD')
+
+    self.freeze
+  end
+end

data/lib/cadooz/models/mutable/address.rb

@@ -0,0 +1,22 @@
+class Cadooz::Mutable::Address
+  include Mixins
+
+  attr_accessor :city, :company, :country, :department, :email, :firstname,
+                :lastname, :phone, :salutation, :state, :street,
+                :street_add_on, :zipcode
+
+  def initialize
+    @company = nil
+    @country = nil
+    @department = nil
+    @email = nil
+    @firstname = nil
+    @lastname = nil
+    @phone = nil
+    @salutation = nil
+    @state = nil
+    @street = nil
+    @street_add_on = nil
+    @zipcode = nil
+  end
+end

data/lib/cadooz/models/mutable/greeting_card.rb

@@ -0,0 +1,10 @@
+class Cadooz::Mutable::GreetingCard
+  include Mixins
+
+  attr_accessor :subject, :text
+
+  def initialize
+    @subject = nil
+    @text = nil
+  end
+end

data/lib/cadooz/models/mutable/invoice_information.rb

@@ -0,0 +1,10 @@
+class Cadooz::Mutable::InvoiceInformation
+  include Mixins
+
+  attr_accessor :debitor_number, :value
+
+  def initialize
+    @debitor_number = nil
+    @value = nil
+  end
+end

data/lib/cadooz/models/mutable/order.rb

@@ -0,0 +1,32 @@
+class Cadooz::Mutable::Order
+  include ::Mixins
+
+  attr_accessor :client, :commission, :cost_owner, :cost_unit, :credit_or_number,
+                :customer_reference_number, :delivery_address, :generation_profile,
+                :greeting_card, :invoice_address, :invoice_information, :language,
+                :order_attributes, :order_description, :order_positions, :payment_informations,
+                :queue, :send_mail, :test, :website
+
+  def initialize
+    @client = nil
+    @commission = nil
+    @cost_owner = nil
+    @cost_unit = nil
+    @credit_or_number = nil
+    @customer_reference_number = nil
+    @delivery_address = Cadooz::Mutable::Address.new
+    @generation_profile = nil
+    @greeting_card = Cadooz::Mutable::GreetingCard.new
+    @invoice_address = Cadooz::Mutable::Address.new
+    @invoice_information = [] # Cadooz::InvoiceInformation
+    @language = nil
+    @order_attributes = nil
+    @order_description = nil
+    @order_positions = [] # Cadooz::OrderPosition
+    @payment_informations = nil
+    @queue = nil
+    @send_mail = nil
+    @test = nil
+    @website = nil
+  end
+end

data/lib/cadooz/models/mutable/order_position.rb

@@ -0,0 +1,22 @@
+class Cadooz::Mutable::OrderPosition
+  include Mixins
+
+  attr_accessor :amount, :attributes, :cadooz_product_number, :currency,
+                :delivery_address, :external_reference_number, :greeting_card,
+                :value, :voucher_address, :voucher_address_editable,
+                :voucher_address_preset
+
+  def initialize
+    @amount = nil
+    @attributes = nil
+    @cadooz_product_number = nil
+    @currency = nil
+    @delivery_address = nil
+    @external_reference_number = nil
+    @greeting_card = nil
+    @value = nil
+    @voucher_address = nil
+    @voucher_address_editable = nil
+    @voucher_address_preset = nil
+  end
+end

data/lib/cadooz/services/business_order_service.rb

@@ -0,0 +1,137 @@
+class Cadooz::BusinessOrderService
+  DEFAULT_TIMEOUT = 10
+  DEFAULT_GENERATION_PROFILE = 'XML Schnittstelle (Test)'
+
+  def initialize(open_timeout = DEFAULT_TIMEOUT, read_timeout = DEFAULT_TIMEOUT)
+    @client = Savon.client(
+      wsdl: Cadooz.configuration.wsdl,
+      basic_auth: [
+          Cadooz.configuration.username,
+          Cadooz.configuration.password
+      ],
+      headers: { 'SOAPAction' => '' },
+      open_timeout: open_timeout,
+      read_timeout: read_timeout
+    )
+
+    @call = -> o, m { m ? @client.call(o, message: m) : @client.call(o) }
+  end
+
+  # Creates an order in the cadooz system based on the information given in Order. You should always create an order with a given customer reference number to avoid multiple orders of on order. The customer reference number should be unique over all your orders you do and you should save it on your site.
+  # Returns:
+  # The order result object contains informations about the created order.
+  #
+  ### IMPORTANT ###
+  # The minimum set of information that is needed in the Order object is a unique customer_reference_number, a delivery_address and a product_number.
+  #################
+  def create_order(order)
+    response_class = Cadooz::Immutable::OrderStatus
+
+    deserialize(@call.(__callee__, order.serialize), response_class, __callee__)
+  end
+
+  # Returns informations about an order.
+  # Returns:
+  # The order result object contains informations about the created order.
+  def get_order_status(order_number)
+    response_class = Cadooz::Immutable::OrderStatus
+
+    deserialize(@call.(__callee__, {order_number: order_number}), response_class, __callee__)
+  end
+
+  # Returns informations about an order based on the customer order reference number given during createOrder(Order) in the field CustomerReferenceNumber.
+  # Returns:
+  # The order result object contains informations about the created order.
+  def get_order_status_by_customer_reference_number(customer_reference_number)
+    response_class = Cadooz::Immutable::OrderStatus
+
+    deserialize(@call.(__callee__, {customer_reference_number: customer_reference_number}), response_class, __callee__)
+  end
+
+  # Returns informations about changes in one of the created order since the lastCheckTime. You should use this task to get changes in orders. Use the lastCheckTime to reduce the data size and the response time for the needed informations. For example: You have created an order on 01.01.2013. In the best situation you will get between 1-3 days later new change states because the order is delivered. If the order returns after a week, you will receive a new change state. Be aware, that you store your "lastCheckTime" on first request and use it next time. All changes since that time are returned.
+  # Returns:
+  # A list of of order result object containing informations about changed orders.
+  def get_changed_orders(last_check_time)
+    response_class = Cadooz::Immutable::OrderStatus
+
+    deserialize(@call.(__callee__, {last_check_time: last_check_time}), response_class, __callee__)
+  end
+
+  # Order getOrder(java.lang.String orderNumber)
+  # Returns all known data about an order identified by the cadooz order number. Be aware that not all information that we received (invoice informations etc) can be returned. Only the "necessary" informations like what is orders are stored on the order number.
+  # Returns:
+  # The order object or null if no order was found.
+  def get_order(order_number)
+    response_class = Cadooz::Immutable::Order
+
+    deserialize(@call.(__callee__, {order_number: order_number}), response_class, __callee__)
+  end
+
+  # Returns a list of catalog's for the authenticated user. If an error occurs or the user is not allowed to query any catalog, an empty list will be returned.
+  # Parameters:
+  # includeExtraContent - If true, then some extra content is not included (like attributes and categories)
+  # Returns:
+  # A list of all available catalog id's for context-principal or an empty List.
+  def get_available_catalogs(include_extra_content = false)
+    response_class = Cadooz::Immutable::Catalog
+
+    deserialize(@call.(__callee__, {include_extra_content: include_extra_content }), response_class, __callee__)
+  end
+
+  # Returns a List of ProductCategory models for CatalogProduct models or an empty list if an error occurs.
+  # Returns:
+  # A list of all categories or an empty list.z
+  def get_available_categories
+    response_class = Cadooz::Immutable::ProductCategory
+
+    deserialize(@call.(__callee__, nil), response_class, __callee__)
+  end
+
+  # Returns a list of products that can be used within a order. This is specific for a generation profile and should not be mixed up with the merchant catalog getAvailableCatalogs(boolean).
+  # Parameters:
+  # generationProfile - a name of a generation profile defined by cadooz
+  # Returns:
+  # A list of generation profile products that can be used for an order inside createOrder(Order)
+  def get_available_products(generation_profile = DEFAULT_GENERATION_PROFILE)
+    response_class = Cadooz::Immutable::GenerationProfileProduct
+
+    deserialize(@call.(__callee__, {generation_profile: generation_profile }), response_class, __callee__)
+  end
+
+  # Returns a VoucherInformation Object. The status of the response can be determined using the method VoucherInformation.getResponseState().
+  # If one of the passed arguments is empty the status will be VoucherInformationState.INCORRECT_USAGE.
+  # If passed name of the generation profile is unknown the status will be VoucherInformationState.UNKNOWN_GENERAION_PROFILE.
+  # If passed order number is not existent or does not match the generation profile name or the authenticated user is not allow to query the order informations the status will be VoucherInformationState.ORDER_NOT_FOUND.
+  # Successful queries will have the status VoucherInformationState.SUCCESS.
+  # Parameters:
+  # generationProfileName - The name of the generation profile used to create the order.
+  # orderNumber - The number of the order.
+  # Returns:
+  # A VoucherInformation object. Never null.
+  def get_vouchers_for_order(generation_profile_name = DEFAULT_GENERATION_PROFILE, order_number)
+    response_class = Cadooz::Immutable::Voucher
+
+    deserialize(@call.(__callee__, {generation_profile_name: generation_profile_name, order_number: order_number }), response_class, __callee__)
+  end
+
+  private
+
+  def deserialize(response, response_class, operation)
+    key = (operation.to_s + '_response').to_sym
+    body = response.body[key][:return]
+
+    if body.blank?
+      object = OpenStruct.new
+    else
+      object = JSON.parse(body.to_json, object_class: OpenStruct)
+    end
+
+    if object.class == Array
+      object.each_with_object([]) { |o, arr| arr << Object::const_get(response_class.to_s).new(o) }
+    elsif object.class == OpenStruct
+      Object::const_get(response_class.to_s).new(object)
+    else
+      # TODO handle exception
+    end
+  end
+end

data/lib/cadooz/version.rb

@@ -0,0 +1,3 @@
+module Cadooz
+  VERSION = '1.0.0'
+end

data/lib/mixins.rb

@@ -0,0 +1,51 @@
+module Mixins
+  def serialize(data_only = false)
+    class_name = self.class.to_s.gsub(/Cadooz::[a-z]*::/i, '').underscore
+    result = data_only ? {} : { class_name.to_sym => {} }
+
+    hash_assign = ->name, value { data_only ? result[name] = value : result[class_name.to_sym][name] = value }
+
+    self.instance_variables.each do |var|
+      name = var.to_s.gsub('@', '').to_sym
+      value = self.instance_variable_get(var)
+
+      if value.class.method_defined? :serialize
+        hash_assign.(name, value.serialize(true)) unless instance_variables_empty?(value)
+      elsif value.class == Array
+        arr = []
+        value.each do |val|
+          arr << val.serialize(true) unless instance_variables_empty?(val)
+        end
+        hash_assign.(name, arr) unless arr.blank?
+      elsif !cadooz_class(value.class)
+        hash_assign.(name, value) unless value.blank?
+      end
+    end
+
+    result
+  end
+
+  def instance_variables_empty?(instance)
+    instance.instance_variables.each do |var|
+      return false unless instance.instance_variable_get(var).blank?
+    end
+
+    true
+  end
+
+  def cadooz_class(klass)
+    klass = klass.name.split('::').last.to_sym
+
+    Cadooz.constants.include?(klass)
+  end
+end
+
+class String
+  def underscore
+    self.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: cadooz
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andrew Brown
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.24.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.24.0
+description: cadooz is a world leader in incentive marketing and distribution of digital
+  rewards, including gift cards, e-vouchers, etc. This gem wraps cadooz's BusinessOrderService
+  SOAP API (http://business.cadooz.com/api/businessorder/v1.5.2/com/cadooz/webservice/businessorder/v152/package-summary.html)
+email:
+- andrew@bonus.ly
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/cadooz.rb
+- lib/cadooz/models/immutable/address.rb
+- lib/cadooz/models/immutable/attributes.rb
+- lib/cadooz/models/immutable/catalog.rb
+- lib/cadooz/models/immutable/catalog_product.rb
+- lib/cadooz/models/immutable/catalog_product_variation.rb
+- lib/cadooz/models/immutable/generation_profile_product.rb
+- lib/cadooz/models/immutable/greeting_card.rb
+- lib/cadooz/models/immutable/invoice_information.rb
+- lib/cadooz/models/immutable/order.rb
+- lib/cadooz/models/immutable/order_position.rb
+- lib/cadooz/models/immutable/order_status.rb
+- lib/cadooz/models/immutable/payment.rb
+- lib/cadooz/models/immutable/product_category.rb
+- lib/cadooz/models/immutable/voucher.rb
+- lib/cadooz/models/mutable/address.rb
+- lib/cadooz/models/mutable/greeting_card.rb
+- lib/cadooz/models/mutable/invoice_information.rb
+- lib/cadooz/models/mutable/order.rb
+- lib/cadooz/models/mutable/order_position.rb
+- lib/cadooz/services/business_order_service.rb
+- lib/cadooz/version.rb
+- lib/mixins.rb
+homepage: http://bonus.ly
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby Wrapper for cadooz SOAP API
+test_files: []