afterbuy 0.0.1

data/lib/afterbuy/representer/request_representer.rb

@@ -0,0 +1,14 @@
+module Afterbuy
+  class Request < OpenStruct
+  end
+
+  module Representer
+    class RequestRepresenter < Roar::Decorator
+      include Roar::XML
+
+      self.representation_wrap = :Request
+
+      property :afterbuy_global, as: :AfterbuyGlobal, extend: GlobalRepresenter, class: Global
+    end
+  end
+end

data/lib/afterbuy/representer/response_representer.rb

@@ -0,0 +1,17 @@
+module Afterbuy
+  class Response < OpenStruct
+  end
+
+  module Representer
+    class ResponseRepresenter < Roar::Decorator
+      include Roar::XML
+
+      self.representation_wrap = :Afterbuy
+
+      property :call_status, as: :CallStatus
+      property :call_name, as: :CallName
+      property :version_id, as: :VersionID
+      property :result, as: :Result, extend: ResultRepresenter, class: Result
+    end
+  end
+end

data/lib/afterbuy/representer/result_representer.rb

@@ -0,0 +1,15 @@
+module Afterbuy
+  class Result < OpenStruct
+  end
+
+  module Representer
+    module ResultRepresenter
+      include Roar::XML
+
+      self.representation_wrap = :Result
+
+      collection :errors, as: :Error, wrap: :ErrorList, extend: ErrorRepresenter, class: Error
+      collection :warnings, as: :Warning, wrap: :WarningList, extend: WarningRepresenter, class: Warning
+    end
+  end
+end

data/lib/afterbuy/representer/shop_interface_line_item_representer.rb

@@ -0,0 +1,22 @@
+module Afterbuy
+  class ShopInterfaceLineItem < OpenStruct
+  end
+
+  module Representer
+    class ShopInterfaceLineItemRepresenter < Roar::Decorator
+      include Representable::Hash
+
+      property :artikel_nr,            as: :Artikelnr
+      property :altern_artikel_nr1,    as: :AlternArtikelNr1
+      property :altern_artikel_nr2,    as: :AlternArtikelNr2
+      property :artikel_name,          as: :Artikelname
+      property :artikel_e_preis,       as: :ArtikelEpreis
+      property :artikel_mwst,          as: :ArtikelMwSt
+      property :artikel_menge,         as: :ArtikelMenge
+      property :artikel_gewicht,       as: :ArtikelGewicht
+      property :artikel_link,          as: :ArtikelLink
+      property :attribute,             as: :Attribute
+      property :artikel_stamm_id,      as: :ArtikelStammID
+    end
+  end
+end

data/lib/afterbuy/representer/shop_interface_request_representer.rb

@@ -0,0 +1,97 @@
+module Afterbuy
+  class ShopInterfaceRequest < OpenStruct
+  end
+
+  module Representer
+    class ShopInterfaceRequestRepresenter < Roar::Decorator
+      include Representable::Hash
+
+      property :action,                  as: :Action
+      property :partner_id,              as: :PartnerID
+      property :partner_pass,            as: :PartnerPass
+      property :user_id,                 as: :UserID
+      property :pos_anz,                 as: :PosAnz
+      property :k_benutzername,          as: :Kbenutzername
+      property :k_anrede,                as: :Kanrede
+      property :k_firma,                 as: :KFirma
+      property :k_vorname,               as: :KVorname
+      property :k_nachname,              as: :KNachname
+      property :k_strasse,               as: :KStrasse
+      property :k_strasse2,              as: :KStrasse2
+      property :k_plz,                   as: :KPLZ
+      property :k_ort,                   as: :KOrt
+      property :k_bundesland,            as: :KBundesland
+      property :k_telefon,               as: :Ktelefon
+      property :k_fax,                   as: :Kfax
+      property :k_email,                 as: :Kemail
+      property :k_land,                  as: :KLand
+      property :k_birthday,              as: :KBirthday
+      property :lieferanschrift,         as: :Lieferanschrift
+      property :kl_firma,                as: :KLFirma
+      property :kl_vorname,              as: :KLVorname
+      property :kl_nachname,             as: :KLNachname
+      property :kl_strasse,              as: :KLStrasse
+      property :kl_strasse2,             as: :KLStrasse2
+      property :kl_plz,                  as: :KLPLZ
+      property :kl_ort,                  as: :KLOrt
+      property :kl_land,                 as: :KLLand
+      property :kl_telefon,              as: :KLTelefon
+      property :haendler,                as: :Haendler
+      property :kommentar,               as: :Kommentar
+      property :use_compl_weight,        as: :UseComplWeight
+      property :buy_date,                as: :BuyDate
+      property :bestandart,              as: :Bestandart
+      property :versandart,              as: :Versandart
+      property :versandkosten,           as: :Versandkosten
+      property :zahlarten_aufschlag,     as: :ZahlartenAufschlag
+      property :zahlart,                 as: :Zahlart
+      property :z_funktions_id,          as: :ZFunktionsID
+      property :bankname,                as: :Bankname
+      property :blz,                     as: :BLZ
+      property :kontonummer,             as: :Kontonummer
+      property :kontoinhaber,            as: :Kontoinhaber
+      property :usst_id,                 as: :UsStID
+      property :no_feedback,             as: :NoFeedback
+      property :no_versand_calc,         as: :NoVersandCalc
+      property :versandgruppe,           as: :Versandgruppe
+      property :mwst_nicht_ausweisen,    as: :MwStNichtAusweisen
+      property :markierung_id,           as: :MarkierungID
+      property :e_kunden_nr,             as: :EKundenNr
+      property :kunden_erkennung,        as: :Kundenerkennung
+      property :no_ebay_name_aktu,       as: :NoeBayNameAktu
+      property :artikel_erkennung,       as: :Artikelerkennung
+      property :v_memo,                  as: :VMemo
+      property :vid,                     as: :VID
+      property :sold_currency,           as: :SoldCurrency
+      property :set_pay,                 as: :SetPay
+      property :pay_date,                as: :PayDate
+      property :check_vid,               as: :CheckVID
+      property :check_packstation,       as: :CheckPackstation
+      property :override_mark_id,        as: :OverrideMarkID
+      property :billsafe_transaction_id, as: :BillsafeTransactionID
+      property :billsafe_ordernumber,    as: :BillsafeOrdernumber
+      property :bic,                     as: :BIC
+      property :iban,                    as: :IBAN
+      property :reference,               as: :reference
+      property :payment_status,          as: :PaymentStatus
+      property :payment_transaction_id,  as: :PaymentTransactionId
+
+      collection :line_items, extend: ShopInterfaceLineItemRepresenter, class: ShopInterfaceLineItem
+
+      def to_hash
+        super.tap do |hash|
+          if hash.has_key? 'line_items'
+            hash['PosAnz'] = hash['line_items'].count
+
+            hash.delete('line_items').each.with_index do |line_item, index|
+              line_item.map do |k, v|
+                hash["#{k}_#{index+1}"] = v
+              end
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/afterbuy/representer/shop_interface_response_representer.rb

@@ -0,0 +1,33 @@
+module Afterbuy
+  class ShopInterfaceResponse < OpenStruct
+  end
+
+  module Representer
+    class ShopInterfaceResponseRepresenter < Roar::Decorator
+      include Roar::XML
+
+      self.representation_wrap = :result
+
+      property :success
+      property :action, as: :Action
+
+      nested :errorlist do
+        collection :errors, as: :error
+        property :order_id, as: :OrderID
+        property :vid,      as: :VID
+      end
+
+      nested :data do
+        # data receive when action is CheckUserId
+        property :user_id,     as: :UserID
+
+        # data receive when action is new
+        property :aid,         as: :AID
+        property :uid,         as: :UID
+        property :kunden_nr,   as: :KundenNr
+        property :e_kunden_nr, as: :EKundenNr
+        property :coupon_used, as: :CouponUsed
+      end
+    end
+  end
+end

data/lib/afterbuy/representer/time_response_representer.rb

@@ -0,0 +1,15 @@
+module Afterbuy
+  class TimeResponse < OpenStruct
+  end
+
+  module Representer
+    class TimeResponseRepresenter < ResponseRepresenter
+      property :result, as: :Result, class: Result do
+        include ResultRepresenter
+
+        property :afterbuy_timestamp, as: :AfterbuyTimeStamp
+        property :afterbuy_universal_timestamp, as: :AfterbuyUniversalTimeStamp
+      end
+    end
+  end
+end

data/lib/afterbuy/representer/update_shop_products_request_representer.rb

@@ -0,0 +1,10 @@
+module Afterbuy
+  class UpdateShopProductsRequest < OpenStruct
+  end
+
+  module Representer
+    class UpdateShopProductsRequestRepresenter < RequestRepresenter
+      collection :products, as: :Product, wrap: :Products, extend: ProductRepresenter, class: Product
+    end
+  end
+end

data/lib/afterbuy/representer/update_shop_products_response_representer.rb

@@ -0,0 +1,16 @@
+module Afterbuy
+  class UpdateShopProductsResponse < OpenStruct
+  end
+
+  module Representer
+    class UpdateShopProductsResponseRepresenter < ResponseRepresenter
+      property :result, as: :Result, class: Result do
+        include ResultRepresenter
+
+        property   :parts_found,  as: :PartsFound
+        property   :skus_found,   as: :SkusFound
+        collection :new_products, as: :NewProduct, wrap: :NewProducts, extend: ProductRepresenter, class: Product
+      end
+    end
+  end
+end

data/lib/afterbuy/representer/warning_representer.rb

@@ -0,0 +1,16 @@
+module Afterbuy
+  class Warning < OpenStruct
+  end
+
+  module Representer
+    class WarningRepresenter < Roar::Decorator
+      include Roar::XML
+
+      self.representation_wrap = :Warning
+
+      property :code, as: :WarningCode
+      property :description, as: :WarningDescription
+      property :long_description, as: :WarningLongDescription
+    end
+  end
+end

data/lib/afterbuy/version.rb

@@ -0,0 +1,3 @@
+module Afterbuy
+  VERSION = "0.0.1"
+end

data/spec/api_spec.rb

@@ -0,0 +1,184 @@
+require 'spec_helper'
+
+describe Afterbuy::API do
+
+  describe 'missing configuration' do
+    before(:all) do
+      Afterbuy.configure do |c|
+        c.partner_id = nil
+        c.partner_password = nil
+        c.user_id = nil
+        c.user_password = nil
+      end
+    end
+    specify do
+      expect{ described_class.new }.to raise_error Afterbuy::ConfigMissingPartnerIDError
+      expect{ described_class.new(partner_id: 'valid_partner_id') }.to raise_error Afterbuy::ConfigMissingPartnerPasswordError
+      expect{ described_class.new(partner_id: 'valid_partner_id', partner_password: 'valid_partner_password') }.to raise_error Afterbuy::ConfigMissingUserIDError
+      expect{ described_class.new(partner_id: 'valid_partner_id', partner_password: 'valid_partner_password', user_id: 'valid_user_id') }.to raise_error Afterbuy::ConfigMissingUserPasswordError
+    end
+
+    it 'allows to supply credentials via initialize' do
+      expect{ described_class.new(partner_id: 'valid_partner_id', partner_password: 'valid_partner_password', user_id: 'valid_user_id', user_password: 'valid_user_password') }.not_to raise_error
+    end
+
+    it 'sets credentials from parameters' do
+      api = described_class.new(partner_id: 'valid_partner_id', partner_password: 'valid_partner_password', user_id: 'valid_user_id', user_password: 'valid_user_password')
+      expect(api.instance_variable_get(:@partner_id)).to eq 'valid_partner_id'
+      expect(api.instance_variable_get(:@partner_password)).to eq 'valid_partner_password'
+      expect(api.instance_variable_get(:@user_id)).to eq 'valid_user_id'
+      expect(api.instance_variable_get(:@user_password)).to eq 'valid_user_password'
+    end
+  end
+
+  describe 'valid configuration' do
+    before(:all) do
+      Afterbuy.configure do |c|
+        c.partner_id = 'valid_partner_id'
+        c.partner_password = 'valid_partner_password'
+        c.user_id = 'valid_user_id'
+        c.user_password = 'valid_user_password'
+      end
+    end
+
+    describe '#initialize' do
+      it 'initializes correctly' do
+        expect{ subject }.not_to raise_error
+        expect(subject).to be_kind_of Afterbuy::API
+      end
+
+      it 'sets instance variables' do
+        expect(subject.instance_variable_get(:@partner_id)).to eq 'valid_partner_id'
+        expect(subject.instance_variable_get(:@partner_password)).to eq 'valid_partner_password'
+        expect(subject.instance_variable_get(:@user_id)).to eq 'valid_user_id'
+        expect(subject.instance_variable_get(:@user_password)).to eq 'valid_user_password'
+        expect(subject.instance_variable_get(:@api_url)).to eq Afterbuy.afterbuy_api_url
+      end
+    end
+
+    describe '#call', :vcr do
+      context 'invalid method call' do
+        specify 'responds with a call not found error' do
+          response = subject.call('DoSomething')
+          expect(response.call_status).to eql 'Error'
+          expect(response.result.errors).to_not be_empty
+          expect(response.result.errors.first.description).to eql 'Unsupported CallName.'
+        end
+      end
+
+      context 'GetAfterbuyTime' do
+        specify 'responds with timestamps' do
+          response = subject.call('GetAfterbuyTime')
+          expect(response.call_status).to eql 'Success'
+          expect(response.result.errors).to be_nil
+          expect(response.result.afterbuy_timestamp).to_not be_nil
+          expect(response.result.afterbuy_universal_timestamp).to_not be_nil
+        end
+      end
+    end
+
+    describe '#shop_interface_call', :vcr do
+      context 'invalid parameters' do
+        specify 'fails with error' do
+          response = subject.shop_interface_call(request: Afterbuy::ShopInterfaceRequest.new(action: 'new'))
+          expect(response.success).to eql '0'
+          expect(response.errors).to_not be_empty
+        end
+      end
+
+      context 'valid parameters with action CheckUserId' do
+        specify 'succeeds and returns the user_id' do
+          response = subject.shop_interface_call(request: Afterbuy::ShopInterfaceRequest.new(action: 'CheckUserId'))
+          expect(response.success).to eql '1'
+          expect(response.user_id).to eql '123456'
+        end
+      end
+
+      context 'valid parameters with action new' do
+        specify 'succeeds' do
+          request = Afterbuy::ShopInterfaceRequest.new({
+            action: 'new',
+            k_benutzername: 'carl_client',
+            k_email: 'client@mail.de',
+            k_vorname: 'Carl',
+            k_nachname: 'Client',
+            k_strasse: 'Clientstr. 4',
+            k_plz: '12345',
+            k_ort: 'Carlhausen',
+            k_land: 'D',
+            line_items: [
+              Afterbuy::ShopInterfaceLineItem.new(
+                artikel_nr: 1,
+                artikel_name: 'Product 1',
+                artikel_mwst: 19,
+                artikel_menge: 1,
+                artikel_e_preis: '9,99'
+              ),
+              Afterbuy::ShopInterfaceLineItem.new(
+                artikel_nr: 2,
+                artikel_name: 'Product 2',
+                artikel_mwst: 19,
+                artikel_menge: 2,
+                artikel_e_preis: '6,99'
+              )
+            ]
+          })
+          response = subject.shop_interface_call(request: request)
+          expect(response.success).to eql '1'
+          expect(response.aid).to_not be_nil
+          expect(response.uid).to_not be_nil
+          expect(response.kunden_nr).to_not be_nil
+          expect(response.e_kunden_nr).to_not be_nil
+          expect(response.coupon_used).to_not be_nil
+        end
+      end
+    end
+
+    describe '#request_params' do
+      context 'without a payload' do
+        specify do
+          expect(subject.send(:request_params, 'DoSomething')).to eql %q|<Request>
+  <AfterbuyGlobal>
+    <PartnerID>valid_partner_id</PartnerID>
+    <PartnerPassword>valid_partner_password</PartnerPassword>
+    <UserID>valid_user_id</UserID>
+    <UserPassword>valid_user_password</UserPassword>
+    <CallName>DoSomething</CallName>
+    <DetailLevel>0</DetailLevel>
+    <ErrorLanguage>EN</ErrorLanguage>
+  </AfterbuyGlobal>
+</Request>|
+        end
+      end
+
+      context 'with extra global_params and payload' do
+        specify do
+          payload = { products: [] }
+          payload[:products] << Afterbuy::Product.new({
+            product_ident: OpenStruct.new(product_id: 123),
+            name: "a product"
+          })
+          expect(subject.send(:request_params, 'UpdateShopProducts', { error_language: 'DE'}, payload)).to eql %q|<Request>
+  <AfterbuyGlobal>
+    <PartnerID>valid_partner_id</PartnerID>
+    <PartnerPassword>valid_partner_password</PartnerPassword>
+    <UserID>valid_user_id</UserID>
+    <UserPassword>valid_user_password</UserPassword>
+    <CallName>UpdateShopProducts</CallName>
+    <DetailLevel>0</DetailLevel>
+    <ErrorLanguage>EN</ErrorLanguage>
+  </AfterbuyGlobal>
+  <Products>
+    <Product>
+      <ProductIdent>
+        <ProductID>123</ProductID>
+      </ProductIdent>
+      <Name>a product</Name>
+    </Product>
+  </Products>
+</Request>|
+        end
+      end
+    end
+  end
+end