axiomus_api 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b6d53d6c8cf127838ed4317dc3b09fd527018f9
+  data.tar.gz: 56ea79ee658e40db0392160837f9beaa4116b90c
+SHA512:
+  metadata.gz: 89295abdd43eee1f1fc84c3b784ac798b2ff14f32919bd7b2c2776ccee0b176061d83b9a840b09975b40dfa91e097c97cf28548b07ad8095ea249653f50576d3
+  data.tar.gz: f071141c39d1a008c4fd907f8cc07a5902905e97bcc700293b6c731b82ded1c9e48125015e0e8fe7d54bfd953ada873c545c9f02978e83d891f8e4e3c0d724ed

data/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+*.sublime*
+/vendor/bundle
+/coverage

data/.rspec

@@ -0,0 +1,3 @@
+--default-path spec/lib
+--color
+-fd

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 1.9.3
+install: "bundle install --path vendor/bundle"
+cache:
+  directories:
+  - vendor/bundle
+script: "CODECLIMATE_REPO_TOKEN=93631233647d94015cf8e05386117a48a1a23106c2b990e19c96f0f462992e14 bundle exec rspec"
+

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'coveralls'
+  gem 'codeclimate-test-reporter', require: nil
+  gem 'factory_girl', '~> 4.0'
+end

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    axiomus_api (0.1)
+      nokogiri (~> 1.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.4)
+      i18n (~> 0.6, >= 0.6.9)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.16)
+    codeclimate-test-reporter (0.3.0)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    diff-lcs (1.2.5)
+    docile (1.1.3)
+    factory_girl (4.4.0)
+      activesupport (>= 3.0.0)
+    i18n (0.6.9)
+    mime-types (2.2)
+    mini_portile (0.5.3)
+    minitest (4.7.5)
+    multi_json (1.9.2)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.1)
+      atomic (>= 1.1.7, < 2)
+    tins (1.0.1)
+    tzinfo (0.3.39)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  axiomus_api!
+  codeclimate-test-reporter
+  coveralls
+  factory_girl (~> 4.0)
+  rspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Kinderly LTD
+
+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,119 @@
+# Axiomus API
+
+[![Build Status](https://travis-ci.org/kinderly/axiomus_api.svg)](https://travis-ci.org/kinderly/axiomus_api)
+[![Coverage Status](https://coveralls.io/repos/kinderly/axiomus_api/badge.png)](https://coveralls.io/r/kinderly/axiomus_api)
+[![Code Climate](https://codeclimate.com/github/kinderly/axiomus_api.png)](https://codeclimate.com/github/kinderly/axiomus_api)
+[![Dependency Status](https://gemnasium.com/kinderly/axiomus_api.svg)](https://gemnasium.com/kinderly/axiomus_api)
+
+## Description
+
+This is a Ruby wrapper over [Axiomus](http://www.axiomus.ru "axiomus.ru") delivery service public [API](http://www.axiomus.ru/customers/api/ "Axiomus API").
+
+All methods exposed by the API by 2014-03-30 are implemented.
+
+## Installation
+
+To install this gem type the following in your command line:
+```bash
+  gem install axiomus_api
+```
+If you are using Bundler add the following line to your Gemfile:
+```ruby
+  gem 'axiomus_api'
+```
+
+If you prefer to install the most up-to-date development version, add
+
+```ruby
+  gem 'axiomus_api', git: 'git@github.com:kinderly/axiomus_api.git', branch: 'master'
+```
+## Usage
+
+To access Axiomus API you have to know two values: **oid** and **ukey**.
+
+`AxiomusApi::Session` is a main class to communicate with API.
+
+```ruby
+  @uid = '92' # your uid goes here
+  @ukey = 'XXcd208495d565ef66e7dff9f98764XX' # your ukey goes here
+  @test = true # use test API?
+  @session = AxiomusApi::Session.new(@uid, @ukey, @test)
+```
+
+You can construct a test session easily (using test credentials provided by Axiomus):
+```ruby
+  @session = AxiomusApi.test_session
+```
+
+Names of methods of `AxiomusApi::Session` are the same as those described in the [API documentation](http://www.axiomus.ru/customers/api/ "Axiomus API").
+
+### Getting regions info
+```ruby
+  @region_info = @session.get_regions()
+```
+
+### Creating and updating an order
+
+To create an order you'll have to construct an order object and fill all its fields according to the documentation. Please note, that different requests use different order types.
+
+```ruby
+  # Simple delivery order ('new' and 'update' methods)
+
+  @order = AxiomusApi::Order.new
+  # fill order fields
+  @response = @session.new(@order)
+  #update some order fields
+  @response = @session.update(@order)
+
+  # Pickup order ('new_carry' and 'update_carry' methods)
+  @order = AxiomusApi::CarryOrder.new
+  # fill order fields
+  @response = @session.new_carry(@order)
+  #update some order fields
+  @response = @session.update_carry(@order)
+```
+
+Here's a list of session methods and their corresponding order types:
+* `new`, `update` => `AxiomusApi::Order`
+* `new_carry`, `update_carry` => `AxiomusApi::CarryOrder`
+* `new_export`, `update_export` => `AxiomusApi::ExportOrder`
+* `new_self_export`, `update_self_export` => `AxiomusApi::SelfExportOrder`
+* `new_post`, `update_post` => `AxiomusApi::PostOrder`
+* `new_dpd`, `update_dpd` => `AxiomusApi::DpdOrder`
+* `new_ems`, `update_ems` => `AxiomusApi::EmsOrder`
+* `new_region_courier`, `update_region_courier` => `AxiomusApi::RegionCourierOrder`
+* `new_region_pickup`, `update_region_pickup` => `AxiomusApi::RegionPickupOrder`
+
+You can also specify the Axiomus method as a symbol, using `AxiomusApi::Session#send_order_request` method
+
+```ruby
+  # EMS order ('new_ems' and 'update_ems' methods)
+  @order = AxiomusApi::EmsOrder.new
+  # fill order fields
+  @response =  @session.send_order_request(:new_ems, @order)
+  #update some order fields
+  @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:
+
+```ruby
+  @order = AxiomusApi::EmsOrder.new
+  @my_item = @order.create_item
+  # set item properties
+  @order.items << @my_item
+```
+
+### Getting order status
+```ruby
+  @okey = '642d208495dtgu8906e7dff9f98764da' # your okey goes here
+  @status = @session.status(@okey)
+```
+
+### Error handling
+
+Before sending a request, the library will validate your order object to check for missing fields or wrong type of parameters. If there are errors, it will raise an `AxiomusApi::Errors::ValidationError` exception. List of errors can be accessed via the order's `#validation_errors` method. Please note that passing validation doesn't neccesary means the order will be accepted by Axiomus.
+
+If any kind of order request returns with an Axiomus status other than 0, the session will raise an `AxiomusApi::Errors::RequestError` exception.
+
+

data/axiomus_api.gemspec

@@ -0,0 +1,19 @@
+require File.expand_path("../lib/axiomus_api/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = "axiomus_api"
+  s.version = ::AxiomusApi::VERSION
+  s.authors = ["Kinderly LTD"]
+  s.email = ["nuinuhin@gmail.com"]
+  s.homepage = "https://github.com/kinderly/axiomus_api"
+
+  s.summary = %q{A wrapper for Axiomus API}
+  s.description = %q{This gem provides a Ruby wrapper over Axiomus API.}
+  s.license = "MIT"
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency('nokogiri', '~>1.6')
+end

data/lib/axiomus_api/actions.rb

@@ -0,0 +1,32 @@
+require_relative('request/request')
+require_relative('request/order_request')
+require_relative('request/status_request')
+
+module AxiomusApi::Actions
+  ACTIONS = {
+    new: AxiomusApi::OrderRequest,
+    update: AxiomusApi::OrderRequest,
+    new_carry: AxiomusApi::OrderRequest,
+    update_carry: AxiomusApi::OrderRequest,
+    new_export: AxiomusApi::OrderRequest,
+    update_export: AxiomusApi::OrderRequest,
+    new_self_export: AxiomusApi::OrderRequest,
+    update_self_export: AxiomusApi::OrderRequest,
+    new_post: AxiomusApi::OrderRequest,
+    update_post: AxiomusApi::OrderRequest,
+    new_dpd: AxiomusApi::OrderRequest,
+    update_dpd: AxiomusApi::OrderRequest,
+    new_ems: AxiomusApi::OrderRequest,
+    update_ems: AxiomusApi::OrderRequest,
+    get_regions: AxiomusApi::Request,
+    new_region_courier: AxiomusApi::OrderRequest,
+    update_region_courier: AxiomusApi::OrderRequest,
+    new_region_pickup: AxiomusApi::OrderRequest,
+    update_region_pickup: AxiomusApi::OrderRequest,
+    status: AxiomusApi::StatusRequest
+  }
+
+  def create_request(mode)
+    ACTIONS[mode].new.tap{|req| req.mode = mode}
+  end
+end

data/lib/axiomus_api/address/dpd_address.rb

@@ -0,0 +1,8 @@
+require_relative 'ems_address'
+
+class AxiomusApi::DpdAddress < AxiomusApi::EmsAddress
+
+  xml_attribute :region
+  xml_attribute :carrymode, optional: true
+
+end

data/lib/axiomus_api/address/ems_address.rb

@@ -0,0 +1,8 @@
+require_relative '../base'
+
+class AxiomusApi::EmsAddress < AxiomusApi::Base
+
+  xml_attribute :index, :area, :street, :house
+  xml_attribute :building, :apartment, optional: true
+
+end

data/lib/axiomus_api/address/post_address.rb

@@ -0,0 +1,7 @@
+require_relative '../base'
+
+class AxiomusApi::PostAddress < AxiomusApi::Base
+
+  xml_attribute :index, :region, :area, :p_address
+
+end

data/lib/axiomus_api/address/region_courier_address.rb

@@ -0,0 +1,8 @@
+require_relative '../base'
+
+class AxiomusApi::RegionCourierAddress < AxiomusApi::Base
+
+  xml_attribute :region_code, :city_code, :index, :street, :house
+  xml_attribute :building, :apartment, optional: true
+
+end

data/lib/axiomus_api/address/region_pickup_address.rb

@@ -0,0 +1,7 @@
+require_relative '../base'
+
+class AxiomusApi::RegionPickupAddress < AxiomusApi::Base
+
+  xml_attribute :office_code
+
+end

data/lib/axiomus_api/base.rb

@@ -0,0 +1,69 @@
+require_relative('serializable')
+require_relative('validated')
+
+class AxiomusApi::Base
+  include AxiomusApi::Serializable
+  include AxiomusApi::Validated
+
+  def self.xml_element(element_name)
+    @xml_element = element_name
+  end
+
+  def self.xml_field(*args)
+    options = extract_options(args)
+
+    options.keys.each do |k|
+      raise "Wrong attribute #{k}" if ![:xml_type, :xml_name, :optional, :type].include?(k)
+    end
+
+    args.each do |attr_name|
+      @attr_info ||= {}
+      @attr_info[attr_name] = options
+      attr_accessor attr_name
+    end
+  end
+
+  def self.xml_attribute(*args)
+    options = extract_options(args)
+    args << options.merge({xml_type: :attribute})
+    xml_field(*args)
+  end
+
+  def self.attribute_meta
+    res = superclass.respond_to?(:attribute_meta) ? superclass.attribute_meta  : {}
+    res.merge(@attr_info || {})
+  end
+
+  def self.tag_name
+    if @xml_element.nil?
+      if superclass.respond_to?(:tag_name)
+        superclass.tag_name
+      else
+        raise 'xml_element not specified'
+      end
+    else
+      @xml_element
+    end
+  end
+
+  def tag_name
+    self.class.tag_name
+  end
+
+  def self.extract_options(args)
+    if args.last.is_a?(Hash) && args.last.instance_of?(Hash)
+      args.pop
+    else
+      {}
+    end
+  end
+
+  def initialize
+    self.class.attribute_meta.each do |k, v|
+      if v[:type]
+        self.send("#{k}=".to_sym, v[:type].new)
+      end
+    end
+  end
+
+end

data/lib/axiomus_api/base_auth.rb

@@ -0,0 +1,9 @@
+require_relative 'base'
+
+class AxiomusApi::BaseAuth < AxiomusApi::Base
+  xml_attribute :ukey
+end
+
+class AxiomusApi::Auth < AxiomusApi::BaseAuth
+  xml_attribute :checksum
+end

data/lib/axiomus_api/errors.rb

@@ -0,0 +1,14 @@
+module AxiomusApi::Errors
+  Error = Class.new(StandardError)
+
+  class RequestError < Error
+    attr_accessor :error_code
+
+    def initialize(code)
+      @error_code = code
+    end
+  end
+
+  ValidationError = Class.new(Error)
+
+end

data/lib/axiomus_api/item/export_item.rb

@@ -0,0 +1,5 @@
+require_relative 'item'
+
+class AxiomusApi::ExportItem < AxiomusApi::Item
+  xml_attribute :oid
+end

data/lib/axiomus_api/item/item.rb

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

data/lib/axiomus_api/order/base_order.rb

@@ -0,0 +1,53 @@
+require_relative '../base'
+require_relative '../services/services'
+
+class AxiomusApi::BaseOrder < AxiomusApi::Base
+  xml_element :order
+
+  xml_field :contacts, :items
+  xml_field :description
+  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}
+  end
+
+  def checksum(uid)
+    Digest::MD5.hexdigest("#{uid}u#{@items.count}#{total_quantity}")
+  end
+
+  def create_item
+    AxiomusApi::Item.new
+  end
+
+  def self.create_by_mode(mode)
+    {
+      new: AxiomusApi::Order,
+      update: AxiomusApi::Order,
+      new_carry: AxiomusApi::CarryOrder,
+      update_carry: AxiomusApi::CarryOrder,
+      new_export: AxiomusApi::ExportOrder,
+      update_export: AxiomusApi::ExportOrder,
+      new_self_export: AxiomusApi::SelfExportOrder,
+      update_self_export: AxiomusApi::SelfExportOrder,
+      new_post: AxiomusApi::PostOrder,
+      update_post: AxiomusApi::PostOrder,
+      new_dpd: AxiomusApi::DpdOrder,
+      update_dpd: AxiomusApi::DpdOrder,
+      new_ems: AxiomusApi::EmsOrder,
+      update_ems: AxiomusApi::EmsOrder,
+      new_region_courier: AxiomusApi::RegionCourierOrder,
+      update_region_courier: AxiomusApi::RegionCourierOrder,
+      new_region_pickup: AxiomusApi::RegionPickupOrder,
+      update_region_pickup: AxiomusApi::RegionPickupOrder
+    }[mode].new
+  end
+
+end

data/lib/axiomus_api/order/carry_order.rb

@@ -0,0 +1,7 @@
+require_relative 'base_order'
+
+class AxiomusApi::CarryOrder < AxiomusApi::BaseOrder
+
+  xml_attribute :office, :incl_delivery_sum, :sms_sender, :sms, optional: true
+  xml_attribute :b_date, :e_date
+end

data/lib/axiomus_api/order/dpd_order.rb

@@ -0,0 +1,11 @@
+require_relative('base_order')
+require_relative('../address/dpd_address')
+require_relative('../services/post_services')
+
+class AxiomusApi::DpdOrder < AxiomusApi::BaseOrder
+
+  xml_attribute :d_date, :b_time, :e_time, :post_type
+  xml_field :services, type: AxiomusApi::PostServices
+  xml_attribute :address, type: AxiomusApi::DpdAddress
+
+end

data/lib/axiomus_api/order/ems_order.rb

@@ -0,0 +1,12 @@
+require_relative 'base_order'
+require_relative '../address/ems_address'
+require_relative '../services/post_services'
+
+class AxiomusApi::EmsOrder < AxiomusApi::BaseOrder
+
+  xml_attribute :d_date
+  xml_attribute :incl_delivery_sum, optional: true
+  xml_field :address, type: AxiomusApi::EmsAddress
+  xml_field :services, type: AxiomusApi::PostServices
+
+end

data/lib/axiomus_api/order/export_order.rb

@@ -0,0 +1,14 @@
+require_relative 'base_order'
+require_relative '../item/export_item'
+require_relative '../services/export_services'
+
+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
+
+  def create_item
+    AxiomusApi::ExportItem.new
+  end
+end

data/lib/axiomus_api/order/order.rb

@@ -0,0 +1,8 @@
+require_relative 'base_order'
+
+class AxiomusApi::Order < AxiomusApi::BaseOrder
+
+  xml_attribute :address, :d_date, :b_time, :e_time, :city
+  xml_attribute :incl_delivery_sum, :from_mkad, :garden_ring, :sms_sender, :sms, optional: true
+
+end

data/lib/axiomus_api/order/post_order.rb

@@ -0,0 +1,12 @@
+require_relative 'base_order'
+require_relative '../address/post_address'
+require_relative '../services/post_services'
+
+class AxiomusApi::PostOrder < AxiomusApi::BaseOrder
+  #уточнить
+  xml_attribute :d_date, :post_type
+  xml_attribute :incl_delivery_sum, optional: true
+  xml_field :address, type: AxiomusApi::PostAddress
+  xml_field :services, type: AxiomusApi::PostServices
+
+end

data/lib/axiomus_api/order/region_courier_order.rb

@@ -0,0 +1,8 @@
+require_relative 'region_order'
+require_relative '../address/region_courier_address'
+
+class AxiomusApi::RegionCourierOrder < AxiomusApi::RegionOrder
+
+  xml_field :address, type: AxiomusApi::RegionCourierAddress
+
+end

data/lib/axiomus_api/order/region_order.rb

@@ -0,0 +1,8 @@
+require_relative 'base_order'
+require_relative '../services/region_services'
+
+class AxiomusApi::RegionOrder < AxiomusApi::BaseOrder
+  xml_attribute :d_date, :b_time, :e_time
+  xml_attribute :incl_deliv_sum, optional: true
+  xml_field :services, type: AxiomusApi::RegionServices
+end

data/lib/axiomus_api/order/region_pickup_order.rb

@@ -0,0 +1,8 @@
+require_relative 'region_order'
+require_relative '../address/region_pickup_address'
+
+class AxiomusApi::RegionPickupOrder < AxiomusApi::RegionOrder
+
+  xml_field :address, type: AxiomusApi::RegionPickupAddress
+
+end

data/lib/axiomus_api/order/self_export_order.rb

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

data/lib/axiomus_api/request/order_request.rb

@@ -0,0 +1,17 @@
+require_relative 'request'
+require_relative '../base_auth'
+
+class AxiomusApi::OrderRequest < AxiomusApi::Request
+  xml_field :order
+
+  def prepare_checksum(uid)
+    if !auth.nil? && !order.nil?
+      auth.checksum = order.checksum(uid)
+    end
+  end
+
+  def initialize
+    @auth = AxiomusApi::Auth.new
+  end
+
+end

data/lib/axiomus_api/request/request.rb

@@ -0,0 +1,10 @@
+require_relative '../base'
+require_relative '../base_auth'
+
+class AxiomusApi::Request < AxiomusApi::Base
+
+  xml_element :singleorder
+  xml_field :mode
+  xml_field :auth, type: AxiomusApi::BaseAuth
+
+end