axiomus_api 0.1.2 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad4f4f35b4f4b4e19262b1f7d25d6fee2c26de68
-  data.tar.gz: 87bfb90d97f8c2f159476b8db61c5aae963400b1
+  metadata.gz: 01b9bba2a5f6c2a80077adee2f7618cdb3012285
+  data.tar.gz: f0168adfc8ec11167ecf7b9762d493884774f479
 SHA512:
-  metadata.gz: 25f1d85d1a30a776041719c2f632695555bef952638174dc0a3907c9c35e871362a8373545db74569ab7f974ba89edd53cd232a8d5846bb54cde7e738785f717
-  data.tar.gz: 0cecac24317941a7014780a2a0d60e7ea50f62085a6beb1a14089bbac628baec19397be80cd4e0fc9987530a4bda4ed8aa48374f79fadb55cad2f3bb3189837f
+  metadata.gz: 1f2d713c2bbaf5c984198dcd53686ce7694842176c78e7308a7278833c1d3ea6d38b4d155abe2a68d44577840bf4c60470c4fa6bdf51d0f44c8c980fa66597f7
+  data.tar.gz: 76a55fe55d9b7dad0a4a9cb81c5e8036127d36523324e8694ed5a35a78079563fbadb26e985f85ea5a24ba781d4664c6ec51e7df22f274748b23642931cd9f9d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    axiomus_api (0.1.1)
+    axiomus_api (0.2)
       nokogiri (~> 1.6)
 
 GEM

data/README.md

@@ -96,13 +96,14 @@ You can also specify the Axiomus method as a symbol, using `AxiomusApi::Session#
   @response =  @session.send_order_request(:update_ems, @order)
 ```
 
-Most orders use `AxiomusApi::Item` as their item type, but some don't. To safely create an item of a proper type, use `#create_item` method of your order object:
+Most orders use `AxiomusApi::Item` as their item type, but some don't. To safely create an item of a proper type, use `#add_item` method of your order's `#items` field:
 
 ```ruby
   @order = AxiomusApi::EmsOrder.new
-  @my_item = @order.create_item
-  # set item properties
-  @order.items << @my_item
+  @my_item = @order.items.add_item
+  @my_item.name = 'My awesome product'
+  @my_item.weight = 0.3
+  # set other fields
 ```
 
 ### Getting order status

data/lib/axiomus_api/base.rb

@@ -13,7 +13,7 @@ class AxiomusApi::Base
     options = extract_options(args)
 
     options.keys.each do |k|
-      raise "Wrong attribute #{k}" if ![:xml_type, :xml_name, :optional, :type].include?(k)
+      raise "Wrong attribute #{k}" if ![:xml_type, :xml_name, :optional, :type, :array, :max_occurs].include?(k)
     end
 
     args.each do |attr_name|
@@ -29,6 +29,10 @@ class AxiomusApi::Base
     xml_field(*args)
   end
 
+  def self.xml_field_array(name, options = {})
+    xml_field(name, options.merge({array: true}))
+  end
+
   def self.attribute_meta
     res = superclass.respond_to?(:attribute_meta) ? superclass.attribute_meta  : {}
     res.merge(@attr_info || {})
@@ -60,7 +64,9 @@ class AxiomusApi::Base
 
   def initialize
     self.class.attribute_meta.each do |k, v|
-      if v[:type]
+      if v[:array]
+        self.send("#{k}=".to_sym, [])
+      elsif v[:type]
         self.send("#{k}=".to_sym, v[:type].new)
       end
     end

data/lib/axiomus_api/below.rb

@@ -0,0 +1,5 @@
+require_relative 'base'
+
+class AxiomusApi::Below < AxiomusApi::Base
+  xml_attribute :below_sum, :price
+end

data/lib/axiomus_api/delivset.rb

@@ -0,0 +1,13 @@
+require_relative 'base'
+require_relative 'below'
+
+class AxiomusApi::Delivset < AxiomusApi::Base
+  xml_attribute :return_price, :above_sum, :above_price
+  xml_field_array :below, type: AxiomusApi::Below, max_occurs: 3, optional: true
+
+  def add_below_element
+    new_below = AxiomusApi::Below.new
+    below << new_below
+    new_below
+  end
+end

data/lib/axiomus_api/item/item.rb

@@ -1,7 +1,5 @@
 require_relative '../base'
 
 class AxiomusApi::Item < AxiomusApi::Base
-  xml_element :item
-
   xml_attribute :name, :weight, :quantity, :price
 end

data/lib/axiomus_api/items/export_items.rb

@@ -0,0 +1,13 @@
+require_relative '../base'
+require_relative '../item/export_item'
+
+class AxiomusApi::ExportItems < AxiomusApi::Base
+
+  xml_field_array :item, type: AxiomusApi::ExportItem
+
+  def add_item
+    new_item = AxiomusApi::ExportItem.new
+    item << new_item
+    new_item
+  end
+end

data/lib/axiomus_api/items/items.rb

@@ -0,0 +1,14 @@
+require_relative '../base'
+require_relative '../item/item'
+
+class AxiomusApi::Items < AxiomusApi::Base
+
+  xml_field_array :item, type: AxiomusApi::Item
+
+  def add_item
+    new_item = AxiomusApi::Item.new
+    item << new_item
+    new_item
+  end
+
+end

data/lib/axiomus_api/order/base_order.rb

@@ -1,30 +1,23 @@
 require_relative '../base'
 require_relative '../services/services'
+require_relative '../items/items'
 
 class AxiomusApi::BaseOrder < AxiomusApi::Base
   xml_element :order
 
-  xml_field :contacts, :items
+  xml_field :contacts
+  xml_field :items, type: AxiomusApi::Items
   xml_field :description, optional: true
   xml_attribute :inner_id, :okey, optional: true
   xml_attribute :name, :places
   xml_field :services, type: AxiomusApi::Services
 
-  def initialize
-    super
-    @items = []
-  end
-
   def total_quantity
-    @items.inject(0){|sum, it| sum + it.quantity}
+    @items.item.inject(0){|sum, it| sum + it.quantity}
   end
 
   def checksum(uid)
-    Digest::MD5.hexdigest("#{uid}u#{@items.count}#{total_quantity}")
-  end
-
-  def create_item
-    AxiomusApi::Item.new
+    Digest::MD5.hexdigest("#{uid}u#{@items.item.count}#{total_quantity}")
   end
 
   def self.create_by_mode(mode)

data/lib/axiomus_api/order/carry_order.rb

@@ -1,7 +1,9 @@
 require_relative 'base_order'
+require_relative '../delivset'
 
 class AxiomusApi::CarryOrder < AxiomusApi::BaseOrder
 
   xml_attribute :office, :incl_deliv_sum, :sms_sender, :sms, optional: true
   xml_attribute :b_date, :e_date
+  xml_field :delivset, optional: true, type: AxiomusApi::Delivset
 end

data/lib/axiomus_api/order/export_order.rb

@@ -1,5 +1,5 @@
 require_relative 'base_order'
-require_relative '../item/export_item'
+require_relative '../items/export_items'
 require_relative '../services/export_services'
 
 class AxiomusApi::ExportOrder < AxiomusApi::BaseOrder
@@ -7,8 +7,6 @@ class AxiomusApi::ExportOrder < AxiomusApi::BaseOrder
   xml_attribute :from_mkad, :garden_ring, optional: true
   xml_attribute :export_quantity, :transit, :d_date, :b_time, :e_time, :address
   xml_field :services, type: AxiomusApi::ExportServices
+  xml_field :items, type: AxiomusApi::ExportItems
 
-  def create_item
-    AxiomusApi::ExportItem.new
-  end
 end

data/lib/axiomus_api/order/order.rb

@@ -1,8 +1,9 @@
 require_relative 'base_order'
+require_relative '../delivset'
 
 class AxiomusApi::Order < AxiomusApi::BaseOrder
 
   xml_attribute :address, :d_date, :b_time, :e_time, :city
   xml_attribute :incl_deliv_sum, :from_mkad, :garden_ring, :sms_sender, :sms, optional: true
-
+  xml_field :delivset, optional: true, type: AxiomusApi::Delivset
 end

data/lib/axiomus_api/order/self_export_order.rb

@@ -1,15 +1,18 @@
 require_relative 'base_order'
+require_relative '../items/export_items'
 
 class AxiomusApi::SelfExportOrder < AxiomusApi::BaseOrder
 
   xml_attribute :car, :d_date, :b_time, :e_time, :quantity
   xml_field :services, optional: true
+  xml_field :items, type: AxiomusApi::ExportItems
 
   def initialize
     super
-    services = nil
+    @services = nil
   end
 
   def services=(val); end
+
 end
 

data/lib/axiomus_api/serializable.rb

@@ -3,11 +3,7 @@ require 'nokogiri'
 module AxiomusApi::Serializable
   def to_xml(xml_header = false, tag_name = nil)
     serializable_fields = self.class.attribute_meta
-    attribute_fields = serializable_fields.select{|k,v| v[:xml_type] == :attribute}
-
-    attributes = Hash[attribute_fields.map do |k,v|
-      [v[:xml_name] || k, normalize_axiomus_xml(self.send(k).to_s)]
-    end].reject{|k,v| v.nil? || v.empty?}
+    attributes = extract_attributes(serializable_fields)
 
     builder = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
       xml.send(tag_name || self.tag_name, attributes) {
@@ -16,37 +12,41 @@ module AxiomusApi::Serializable
           xml_name = opt[:xml_name] || f
           xml_type = opt[:xml_type] || :element
           val = self.send(f)
-
           next if val.nil?
+          elements = opt[:array] ? val : [val]
 
-          case xml_type
-          when :element
-            obj_to_xml(xml, val, xml_name)
-          when :text
-            xml.text(val)
+          elements.each do |el|
+            create_by_type(xml, el, xml_type, xml_name)
           end
         end
       }
     end
 
-    xml = if xml_header
-      builder.to_xml
-    else
-      builder.doc.root.to_xml
-    end
-
+    xml = xml_header ? builder.to_xml : builder.doc.root.to_xml
     normalize_axiomus_xml(xml)
   end
 
   private
 
+  def extract_attributes(serializable_fields)
+    attribute_fields = serializable_fields.select{|k,v| v[:xml_type] == :attribute}
+    Hash[attribute_fields.map do |k,v|
+      [v[:xml_name] || k, normalize_axiomus_xml(self.send(k).to_s)]
+    end].reject{|k,v| v.nil? || v.empty?}
+  end
+
+  def create_by_type(xml, val, xml_type, xml_name)
+    case xml_type
+    when :element
+      obj_to_xml(xml, val, xml_name)
+    when :text
+      xml.text(val)
+    end
+  end
+
   def obj_to_xml(xml, obj, xml_name = nil)
     if obj.kind_of?(AxiomusApi::Base)
       xml << obj.to_xml(false, xml_name)
-    elsif obj.kind_of?(Array)
-      xml.send(xml_name) {
-        obj.each{|el| obj_to_xml(xml, el)}
-      }
     else
       xml.send(xml_name) {
         xml.text(normalize_axiomus_xml(obj.to_s))

data/lib/axiomus_api/validated.rb

@@ -21,12 +21,34 @@ module AxiomusApi::Validated
         @validation_errors << "Field #{field} is required"
       end
     else
-      if !(options[:type].nil? || value.is_a?(options[:type]))
-        @validation_errors << "Field #{field} must be of type #{options[:type]}"
-      elsif value.respond_to?(:valid?) && !value.valid?
-        @validation_errors += value.validation_errors.map{|ve| "#{field} -> #{ve}"}
+      if options[:array]
+        validate_array_field(field, value, options)
+      else
+        validate_present_field(field, value, options)
       end
     end
   end
 
+  def validate_array_field(field, value, options)
+    if value.is_a?(Array)
+      if !options[:max_occurs].nil? && (value.count > options[:max_occurs])
+        @validation_errors << "Field #{field} can have #{options[:max_occurs]} elements maximum"
+      end
+
+      value.each do |el, i|
+        validate_present_field("#{field}[#{i}]", el, options)
+      end
+    else
+      @validation_errors << "Element #{field} must be an array"
+    end
+  end
+
+  def validate_present_field(field, value, options)
+    if !(options[:type].nil? || value.is_a?(options[:type]))
+      @validation_errors << "Field #{field} must be of type #{options[:type]}"
+    elsif value.respond_to?(:valid?) && !value.valid?
+      @validation_errors += value.validation_errors.map{|ve| "#{field} -> #{ve}"}
+    end
+  end
+
 end

data/lib/axiomus_api/version.rb

@@ -1,3 +1,3 @@
 module AxiomusApi
-  VERSION = '0.1.2'
+  VERSION = '0.2'
 end

data/spec/factories.rb

@@ -13,6 +13,23 @@ FactoryGirl.define do
     ['yes', 'no'][rand(0..1)]
   end
 
+  factory :below, class: AxiomusApi::Below do
+    below_sum { rand(0.0..300.0)}
+    price { rand(100.0..500.0)}
+  end
+
+  factory :delivset, class: AxiomusApi::Delivset do
+    return_price {rand(100.0..300.0)}
+    above_sum {rand(100.0..1000.0)}
+    above_price {rand(100.0..1000.0)}
+
+    after(:build) do |ds|
+      rand(1..3).times do
+        ds.below << build(:below)
+      end
+    end
+  end
+
   factory :item, class: AxiomusApi::Item do
     name {"Product &quot;'\"Awesome\"'&quot; #{rand(1..1000)}"}
     weight {rand(0.1..10.0)}
@@ -24,6 +41,18 @@ FactoryGirl.define do
     oid {rand(10000..99999)}
   end
 
+  factory :items, class: AxiomusApi::Items do
+    after(:build) do |items|
+      items.item << build(:item)
+    end
+  end
+
+  factory :export_items, class: AxiomusApi::ExportItems do
+    after(:build) do |items|
+      items.item << build(:export_item)
+    end
+  end
+
   factory :services, class: AxiomusApi::Services do
     cash {generate :boolean}
     cheque {generate :boolean}
@@ -63,11 +92,7 @@ FactoryGirl.define do
     places {rand(1..2)}
     services {build(:services)}
 
-    after(:build) do |order|
-      rand(1..10).times do
-        order.items << build(:item)
-      end
-    end
+    items {build(:items)}
   end
 
   factory :post_address, class: AxiomusApi::PostAddress do
@@ -115,6 +140,7 @@ FactoryGirl.define do
     city 0
     garden_ring {generate :boolean}
     from_mkad {rand(1..2) == 2 && garden_ring !='yes' && city > 0 ? rand(1..40) : nil}
+    delivset nil
 
     trait :incl_deliv_sum do
       incl_deliv_sum rand(100.0..200.00)
@@ -123,6 +149,10 @@ FactoryGirl.define do
     trait :with_empty_address do
       address ''
     end
+
+    trait :with_delivset do
+      delivset {build(:delivset)}
+    end
   end
 
   factory :carry_order, class: AxiomusApi::CarryOrder, parent: :base_order do
@@ -130,6 +160,11 @@ FactoryGirl.define do
     office {[0, 1, nil][rand(0..2)]}
     b_date {Time.now + rand(5..10)*24*60*60}
     e_date {b_date + 7*24*60*60}
+    delivset nil
+
+    trait :with_delivset do
+      delivset {build(:delivset)}
+    end
   end
 
   factory :export_order, class: AxiomusApi::ExportOrder, parent: :base_order do
@@ -142,13 +177,7 @@ FactoryGirl.define do
     address 'Москва, Живописная, д4 корп1, кв 16'
     garden_ring {generate :boolean}
     from_mkad {garden_ring == 'yes' ? nil : rand(1..40)}
-
-    after(:build) do |order|
-      order.items = []
-      rand(1..10).times do
-        order.items << build(:export_item)
-      end
-    end
+    items {build(:export_items)}
   end
 
   factory :self_export_order, class: AxiomusApi::SelfExportOrder, parent: :base_order do
@@ -157,13 +186,7 @@ FactoryGirl.define do
     b_time {rand(10..19)}
     e_time {b_time + 3}
     quantity {rand(1..3)}
-
-    after(:build) do |order|
-      order.items = []
-      rand(1..10).times do
-        order.items << build(:export_item)
-      end
-    end
+    items {build(:export_items)}
   end
 
   factory :post_order, class: AxiomusApi::PostOrder, parent: :base_order do

data/spec/integration/{axiomus_api → lib/axiomus_api}/session_spec.rb

@@ -1,4 +1,4 @@
-require_relative '../../spec_helper'
+require_relative '../../../spec_helper'
 
 describe 'AxiomusApi::Sesion' do
   before(:all) do
@@ -24,6 +24,17 @@ describe 'AxiomusApi::Sesion' do
       expect(z.code).to eq 0
       z = @session.status(okey)
     end
+
+    it 'should support #delivset field' do
+      order = build(:order, :with_delivset)
+      z = @session.new(order)
+      expect(z.code).to eq 0
+      okey = z.okey
+      order.okey = okey
+      z = @session.update(order)
+      expect(z.code).to eq 0
+      z = @session.status(okey)
+    end
   end
 
   describe '#new_carry, #update_carry' do
@@ -37,6 +48,17 @@ describe 'AxiomusApi::Sesion' do
       expect(z.code).to eq 0
       z = @session.status(okey)
     end
+
+    it 'should support #delivset field' do
+      carry_order = build(:carry_order, :with_delivset)
+      z = @session.new_carry(carry_order)
+      expect(z.code).to eq 0
+      okey = z.okey
+      carry_order.okey = okey
+      z = @session.update_carry(carry_order)
+      expect(z.code).to eq 0
+      z = @session.status(okey)
+    end
   end
 
   describe '#new_export, #update_export' do

data/spec/lib/axiomus_api/delivest_spec.rb

@@ -0,0 +1,12 @@
+require_relative '../../spec_helper'
+
+describe 'AxiomusApi::Delivset' do
+
+  it 'should create below element' do
+    delivset = build(:delivset)
+
+    below = delivset.add_below_element
+  end
+
+
+end

data/spec/lib/axiomus_api/{base_order_spec.rb → order/base_order_spec.rb}

@@ -1,4 +1,4 @@
-require_relative '../../spec_helper'
+require_relative '../../../spec_helper'
 
 describe 'AxiomusApi::BaseOrder' do
 
@@ -11,9 +11,11 @@ describe 'AxiomusApi::BaseOrder' do
   it 'should create item' do
     ORDER_MODES.each do |mode|
       order = AxiomusApi::BaseOrder.create_by_mode(mode)
-      item = order.create_item
+      item = order.items.add_item
+      item.quantity = 21
+      expect(order.items.item.first.quantity).to eq(21)
 
-      if [:new_export, :update_export].include?(mode)
+      if [:new_export, :update_export, :new_self_export, :update_self_export].include?(mode)
         expect(item.is_a?(AxiomusApi::ExportItem)).to be_true
       else
         expect(item.is_a?(AxiomusApi::Item)).to be_true

data/spec/lib/axiomus_api/validated_spec.rb

@@ -33,4 +33,40 @@ describe 'AxiomusApi::Validated' do
     expect(order.validation_errors).to have(0).items
   end
 
+  it 'should validate array items' do
+    order = build(:order)
+    order.delivset = AxiomusApi::Delivset.new
+    order.delivset.below = 'Some arbitrary string'
+    order.delivset.return_price = 12
+    order.delivset.above_sum = 12
+    order.delivset.above_price = 12
+    expect(order).not_to be_valid
+    expect(order.validation_errors).to have(1).items
+  end
+
+  it 'should validate max occurs' do
+    order = build(:order)
+    order.delivset = AxiomusApi::Delivset.new
+    order.delivset.return_price = 12
+    order.delivset.above_sum = 12
+    order.delivset.above_price = 12
+
+    4.times do
+      order.delivset.below << build(:below)
+    end
+
+    expect(order).not_to be_valid
+    expect(order.validation_errors).to have(1).items
+  end
+
+  it 'should validate optional arrays' do
+    order = build(:order)
+    order.delivset = AxiomusApi::Delivset.new
+    order.delivset.return_price = 12
+    order.delivset.above_sum = 12
+    order.delivset.above_price = 12
+    order.delivset.below = []
+    expect(order).to be_valid
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: axiomus_api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: '0.2'
 platform: ruby
 authors:
 - Kinderly LTD
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-01 00:00:00.000000000 Z
+date: 2014-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -49,9 +49,13 @@ files:
 - lib/axiomus_api/address/region_pickup_address.rb
 - lib/axiomus_api/base.rb
 - lib/axiomus_api/base_auth.rb
+- lib/axiomus_api/below.rb
+- lib/axiomus_api/delivset.rb
 - lib/axiomus_api/errors.rb
 - lib/axiomus_api/item/export_item.rb
 - lib/axiomus_api/item/item.rb
+- lib/axiomus_api/items/export_items.rb
+- lib/axiomus_api/items/items.rb
 - lib/axiomus_api/order/base_order.rb
 - lib/axiomus_api/order/carry_order.rb
 - lib/axiomus_api/order/dpd_order.rb
@@ -79,9 +83,10 @@ files:
 - lib/axiomus_api/validated.rb
 - lib/axiomus_api/version.rb
 - spec/factories.rb
-- spec/integration/axiomus_api/session_spec.rb
-- spec/lib/axiomus_api/base_order_spec.rb
+- spec/integration/lib/axiomus_api/session_spec.rb
 - spec/lib/axiomus_api/base_spec.rb
+- spec/lib/axiomus_api/delivest_spec.rb
+- spec/lib/axiomus_api/order/base_order_spec.rb
 - spec/lib/axiomus_api/serializable_spec.rb
 - spec/lib/axiomus_api/session_spec.rb
 - spec/lib/axiomus_api/validated_spec.rb