afterbuy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd4ef2553526d4db9632a8dae402be8d27019eb7
+  data.tar.gz: b6d383481f3035453d0dc1613eca028b05e8130c
+SHA512:
+  metadata.gz: 18f4a5af38b82cf65c532a032f59812f90abf087b30b086ae19d9fe74f73255378ea1596eb7cba19a72ba84cfd86f7bdbab82c3eff07174b32ffc637f4df7f19
+  data.tar.gz: 439c55836afad19dd9442c163950dacf2f7aee0d8ebac894d8f6fc385237b2f263c942da77bb4a32ff11a8225ab461a4350eb12d3bb8d4ef67da02c685a25be5

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in afterbuy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Salim Hbeiliny
+
+MIT License
+
+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,47 @@
+# Afterbuy
+
+This is a wrapper for the afterbuy API.
+API's definition is documented here: http://xmldoku.afterbuy.de/dokued/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'afterbuy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install afterbuy
+
+## Usage
+
+    Afterbuy.configure do |config|
+      config.partner_id = 'valid_partner_id'
+      config.partner_password = 'valid_partner_password'
+      config.user_id = 'valid_user_id'
+      config.user_password = 'valid_user_password'
+    end
+
+    afterbuy = Afterbuy::API.new
+    afterbuy.call('GetAfterbuyTime')
+    => #<Afterbuy::TimeResponse
+          call_status="Success",
+          call_name="GetAfterbuyTime",
+          version_id="8",
+          result=#<Afterbuy::Result
+            afterbuy_timestamp="01.04.2015 16:52:35",
+            afterbuy_universal_timestamp="01.04.2015 14:52:35">>
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/afterbuy/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/afterbuy.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'afterbuy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "afterbuy"
+  spec.version       = Afterbuy::VERSION
+  spec.authors       = ["Salim Hbeiliny"]
+  spec.email         = ["salim@railslove.com"]
+  spec.summary       = %q{A wrapper for the Afterbuy API}
+  spec.description   = %q{This is a wrapper for the Afterbuy API documented here: http://xmldoku.afterbuy.de/dokued/}
+  spec.homepage      = 'https://github.com/railslove/afterbuy'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport', '~> 4.2'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'roar'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'pry'
+end

data/lib/afterbuy.rb

@@ -0,0 +1,43 @@
+require 'active_support/configurable'
+require 'active_support/inflector'
+require 'faraday'
+require 'ostruct'
+require 'roar/decorator'
+require 'roar/xml'
+
+require 'afterbuy/version'
+require 'afterbuy/errors'
+
+require 'afterbuy/middleware/error_detector'
+
+require 'afterbuy/representer/global_representer'
+require 'afterbuy/representer/request_representer'
+
+require 'afterbuy/representer/error_representer'
+require 'afterbuy/representer/warning_representer'
+require 'afterbuy/representer/result_representer'
+require 'afterbuy/representer/response_representer'
+require 'afterbuy/representer/time_response_representer'
+
+require 'afterbuy/representer/catalog_representer'
+require 'afterbuy/representer/product_picture_representer'
+require 'afterbuy/representer/attribute_representer'
+require 'afterbuy/representer/product_representer'
+require 'afterbuy/representer/update_shop_products_request_representer'
+require 'afterbuy/representer/update_shop_products_response_representer'
+require 'afterbuy/representer/shop_interface_line_item_representer'
+require 'afterbuy/representer/shop_interface_request_representer'
+require 'afterbuy/representer/shop_interface_response_representer'
+
+require 'afterbuy/api'
+
+module Afterbuy
+  include ActiveSupport::Configurable
+
+  config_accessor(:partner_id)
+  config_accessor(:partner_password)
+  config_accessor(:user_id)
+  config_accessor(:user_password)
+  config_accessor(:afterbuy_api_url) { 'https://api.afterbuy.de/afterbuy/ABInterface.aspx' }
+  config_accessor(:afterbuy_shop_interface_url) { 'https://api.afterbuy.de/afterbuy/ShopInterfaceUTF8.aspx' }
+end

data/lib/afterbuy/api.rb

@@ -0,0 +1,101 @@
+module Afterbuy
+  class API
+
+    METHOD_REQUEST_MAPPING = {
+      'GetAfterbuyTime' => '',
+      'UpdateShopProducts' => 'UpdateShopProducts'
+    }
+
+    METHOD_RESPONSE_MAPPING = {
+      'GetAfterbuyTime' => 'Time',
+      'UpdateShopProducts' => 'UpdateShopProducts'
+    }
+
+    attr_accessor :debug_info
+
+    def initialize(partner_id: nil, partner_password: nil, user_id: nil, user_password: nil)
+      raise ConfigMissingPartnerIDError, 'You must provide an Afterbuy partner_id'             unless Afterbuy.config.partner_id || partner_id
+      raise ConfigMissingPartnerPasswordError, 'You must provide an Afterbuy partner_password' unless Afterbuy.config.partner_password || partner_password
+      raise ConfigMissingUserIDError, 'You must provide an Afterbuy user_id'                   unless Afterbuy.config.user_id || user_id
+      raise ConfigMissingUserPasswordError, 'You must provide an Afterbuy user_password'       unless Afterbuy.config.user_password || user_password
+
+      @partner_id         = Afterbuy.config.partner_id || partner_id
+      @partner_password   = Afterbuy.config.partner_password || partner_password
+      @user_id            = Afterbuy.config.user_id || user_id
+      @user_password      = Afterbuy.config.user_password || user_password
+      @api_url            = Afterbuy.config.afterbuy_api_url
+      @shop_interface_url = Afterbuy.config.afterbuy_shop_interface_url
+    end
+
+    def call(method_name, global_params: {}, payload: {})
+      self.debug_info = { request_params: request_params(method_name, global_params, payload) }
+
+      response = connection.post do |req|
+        req.body = request_params(method_name, global_params, payload)
+      end
+
+      self.debug_info[:response_body] = response.body
+
+      "Afterbuy::Representer::#{METHOD_RESPONSE_MAPPING[method_name]}ResponseRepresenter".constantize.new("Afterbuy::#{METHOD_RESPONSE_MAPPING[method_name]}Response".constantize.new).from_xml(response.body)
+    end
+
+    def shop_interface_call(global_params: {}, request: Afterbuy::ShopInterfaceRequest.new)
+      self.debug_info = { request_params: shop_interface_request_params(global_params, request).to_hash }
+
+      response = shop_interface_connection.post do |req|
+        req.body = shop_interface_request_params(global_params, request).to_hash
+      end
+
+      self.debug_info[:response_body] = response.body
+
+      Afterbuy::Representer::ShopInterfaceResponseRepresenter.new(Afterbuy::ShopInterfaceResponse.new).from_xml(response.body)
+    end
+
+    def connection
+      @connection ||= Faraday.new(url: @api_url) do |faraday|
+        faraday.headers['Content-Type'] = 'application/xml'
+        faraday.adapter Faraday.default_adapter
+        faraday.use Afterbuy::Middleware::ErrorDetector
+      end
+    end
+
+    def shop_interface_connection
+      @shop_interface_connection ||= Faraday.new(url: @shop_interface_url) do |faraday|
+        faraday.request  :url_encoded
+        faraday.adapter Faraday.default_adapter
+        faraday.use Afterbuy::Middleware::ErrorDetector
+      end
+    end
+
+    private
+
+      def request_params(method_name, global_params={}, payload={})
+        request_params = payload.merge({
+          afterbuy_global: Global.new(
+            global_params.merge({
+              partner_id: @partner_id,
+              partner_password: @partner_password,
+              user_id: @user_id,
+              user_password: @user_password,
+              call_name: method_name,
+              detail_level: 0,
+              error_language: 'EN'
+            })
+          )
+        })
+
+        "Afterbuy::Representer::#{METHOD_REQUEST_MAPPING[method_name]}RequestRepresenter".constantize.new(
+          "Afterbuy::#{METHOD_REQUEST_MAPPING[method_name]}Request".constantize.new(request_params)
+        ).to_xml
+      end
+
+      def shop_interface_request_params(global_params={}, request=Afterbuy::ShopInterfaceRequest.new)
+        request.partner_id = global_params[:partner_id] || @partner_id
+        request.partner_pass = global_params[:partner_pass] || @partner_password
+        request.user_id = global_params[:user_id] || @user_id
+
+        Afterbuy::Representer::ShopInterfaceRequestRepresenter.new request
+      end
+
+  end
+end

data/lib/afterbuy/errors.rb

@@ -0,0 +1,21 @@
+module Afterbuy
+
+  class APIError < StandardError
+  end
+
+  class ConfigError < StandardError
+  end
+
+  class ConfigMissingPartnerIDError < ConfigError
+  end
+
+  class ConfigMissingPartnerPasswordError < ConfigError
+  end
+
+  class ConfigMissingUserIDError < ConfigError
+  end
+
+  class ConfigMissingUserPasswordError < ConfigError
+  end
+
+end

data/lib/afterbuy/middleware/error_detector.rb

@@ -0,0 +1,15 @@
+module Afterbuy
+  module Middleware
+    class ErrorDetector < Faraday::Middleware
+
+      def call(env)
+        @app.call(env).on_complete do |env|
+          unless (200..299).include? env[:status]
+            raise APIError, env[:body]
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/afterbuy/representer/attribute_representer.rb

@@ -0,0 +1,18 @@
+module Afterbuy
+  class Attribute < OpenStruct
+  end
+
+  module Representer
+    module AttributeRepresenter
+      include Roar::XML
+
+      self.representation_wrap = :Attribut # german ftw
+
+      property :name, as: :AttributName
+      property :value, as: :AttributValue
+      property :type, as: :AttributTyp
+      property :position, as: :AttributPosition
+      property :required, as: :AttributRequired
+    end
+  end
+end

data/lib/afterbuy/representer/catalog_representer.rb

@@ -0,0 +1,16 @@
+module Afterbuy
+  class Catalog < OpenStruct
+  end
+
+  module Representer
+    module CatalogRepresenter
+      include Roar::XML
+
+      self.representation_wrap = :Catalog
+
+      property :id, as: :CatalogID
+      property :name, as: :CatalogName
+      property :level, as: :CatalogLevel
+    end
+  end
+end

data/lib/afterbuy/representer/error_representer.rb

@@ -0,0 +1,16 @@
+module Afterbuy
+  class Error < OpenStruct
+  end
+
+  module Representer
+    class ErrorRepresenter < Roar::Decorator
+      include Roar::XML
+
+      self.representation_wrap = :Error
+
+      property :code, as: :ErrorCode
+      property :description, as: :ErrorDescription
+      property :long_description, as: :ErrorLongDescription
+    end
+  end
+end

data/lib/afterbuy/representer/global_representer.rb

@@ -0,0 +1,20 @@
+module Afterbuy
+  class Global < OpenStruct
+  end
+
+  module Representer
+    class GlobalRepresenter < Roar::Decorator
+      include Roar::XML
+
+      self.representation_wrap = :AfterbuyGlobal
+
+      property :partner_id, as: :PartnerID
+      property :partner_password, as: :PartnerPassword
+      property :user_id, as: :UserID
+      property :user_password, as: :UserPassword
+      property :call_name, as: :CallName
+      property :detail_level, as: :DetailLevel
+      property :error_language, as: :ErrorLanguage
+    end
+  end
+end

data/lib/afterbuy/representer/product_picture_representer.rb

@@ -0,0 +1,18 @@
+module Afterbuy
+  class ProductPicture < OpenStruct
+  end
+
+  module Representer
+    class ProductPictureRepresenter < Roar::Decorator
+      include Roar::XML
+
+      self.representation_wrap = :ProductPicture
+
+      property :nr, as: :Nr
+      property :url, as: :Url
+      property :alt_text, as: :AltText
+      property :type, as: :Typ # used only in the children collection
+      collection :children, as: :ProductPicture, wrap: :Childs, extend: ProductPictureRepresenter, class: ProductPicture
+    end
+  end
+end

data/lib/afterbuy/representer/product_representer.rb

@@ -0,0 +1,134 @@
+module Afterbuy
+  class Product < OpenStruct
+  end
+
+  module Representer
+    class ProductRepresenter < Roar::Decorator
+      include Roar::XML
+
+      self.representation_wrap = :Product
+
+      # properties sent with UpdateShopProducts Request
+      property :product_ident, as: :ProductIdent do
+        self.representation_wrap = :ProductIdent
+
+        property :product_insert,    as: :ProductInsert
+        property :base_product_type, as: :BaseProductType
+        property :user_product_id,   as: :UserProductID
+        property :product_id,        as: :ProductID
+        property :anr,               as: :Anr
+        property :ean,               as: :EAN
+      end
+
+      # properties returned with UpdateShopProducts Response
+      property :product_id,                             as: :ProductID
+      property :product_id_requested,                   as: :ProductIDRequested
+      property :anr_requested,                          as: :AnrRequested
+      property :ean_requested,                          as: :EANRequested
+      property :user_product_id,                        as: :UserProductID
+
+      # other properties
+      property :anr,                                    as: :Anr
+      property :ean,                                    as: :EAN
+      property :footer_id,                              as: :FooterID
+      property :header_id,                              as: :HeaderID
+      property :name,                                   as: :Name
+      property :manufacturer_part_number,               as: :ManufacturerPartNumber
+      property :short_description,                      as: :ShortDescription
+      property :memo,                                   as: :Memo
+      property :description,                            as: :Description
+      property :keywords,                               as: :Keywords
+      property :quantity,                               as: :Quantity
+      property :auction_quantity,                       as: :AuctionQuantity
+      property :stock,                                  as: :Stock
+      property :discontinued,                           as: :Discontinued
+      property :merge_stock,                            as: :MergeStock
+      property :unit_of_quantity,                       as: :UnitOfQuantity
+      property :baseprice_factor,                       as: :BasepriceFactor
+      property :minimum_stock,                          as: :MinimumStock
+      property :selling_price,                          as: :SellingPrice
+      property :buying_price,                           as: :BuyingPrice
+      property :dealer_price,                           as: :DealerPrice
+      property :level,                                  as: :Level
+      property :position,                               as: :Position
+      property :title_replace,                          as: :TitleReplace
+      property :tax_rate,                               as: :TaxRate
+      property :weight,                                 as: :Weight
+      property :stocklocation_1,                        as: :Stocklocation_1
+      property :stocklocation_2,                        as: :Stocklocation_2
+      property :stocklocation_3,                        as: :Stocklocation_3
+      property :stocklocation_4,                        as: :Stocklocation_4
+      property :search_alias,                           as: :SearchAlias
+      property :froogle,                                as: :Froogle
+      property :kelkoo,                                 as: :Kelkoo
+      property :shipping_group,                         as: :ShippingGroup
+      property :shop_shipping_group,                    as: :ShopShippingGroup
+      property :cross_catalog_id,                       as: :CrossCatalogID
+      property :free_value_1,                           as: :FreeValue1
+      property :free_value_2,                           as: :FreeValue2
+      property :free_value_3,                           as: :FreeValue3
+      property :free_value_4,                           as: :FreeValue4
+      property :free_value_5,                           as: :FreeValue5
+      property :free_value_6,                           as: :FreeValue6
+      property :free_value_7,                           as: :FreeValue7
+      property :free_value_8,                           as: :FreeValue8
+      property :free_value_9,                           as: :FreeValue9
+      property :free_value_10,                          as: :FreeValue10
+      property :delivery_time,                          as: :DeliveryTime
+      property :image_small_url,                        as: :ImageSmallURL
+      property :image_large_url,                        as: :ImageLargeURL
+      property :image_name,                             as: :ImageName
+      property :image_source,                           as: :ImageSource
+      property :manufacturer_standard_product_id_type,  as: :ManufacturerStandardProductIDType
+      property :manufacturer_standard_product_id_value, as: :ManufacturerStandardProductIDValue
+      property :product_brand,                          as: :ProductBrand
+      property :google_product_category,                as: :GoogleProductCategory
+      property :condition,                              as: :Condition
+      property :age_group,                              as: :AgeGroup
+      property :gender,                                 as: :Gender
+
+      # Using a property here instead of a collection because collections don't allow
+      # adding a property at the beginning of the collection as shown below
+      #
+      # <AddCatalogs>
+      #   <UpdateAction>1</UpdateAction>  <======= (this is the intruder here)
+      #   <AddCatalog>
+      #     <CatalogID>1</CatalogID>
+      #     <CatalogName>First Category</CatalogName>
+      #   </AddCatalog>
+      #   <AddCatalog>
+      #     <CatalogID>2</CatalogID>
+      #     <CatalogName>Second Category</CatalogName>
+      #   </AddCatalog>
+      # </AddCatalogs>
+      property :add_catalogs do
+        self.representation_wrap = :AddCatalogs
+        property :update_action, as: :UpdateAction
+        collection :add_catalogs do
+          include CatalogRepresenter
+          self.representation_wrap = :AddCatalog
+        end
+      end
+
+      property :skus do
+        self.representation_wrap = :Skus
+        property :update_action, as: :UpdateAction
+        collection :skus do
+          self.representation_wrap = :Sku
+          property :sku_number, content: true
+        end
+      end
+
+      property :add_attributes do
+        self.representation_wrap = :AddAttributes
+        property :update_action, as: :UpdateAction
+        collection :add_catalogs do
+          include AttributeRepresenter
+          self.representation_wrap = :AddAttribut
+        end
+      end
+
+      collection :product_pictures, as: :ProductPicture, wrap: :ProductPictures, extend: ProductPictureRepresenter, class: ProductPicture
+    end
+  end
+end