rs.ge 0.1.0.beta2 → 0.1.0.rc1

data/lib/rs/requests/{base_request.rb → base.rb}

@@ -7,6 +7,12 @@ class RS::BaseRequest
   # Waybill service WSDL location.
   WAYBILL_SERVICE_URL = 'http://services.rs.ge/WayBillService/WayBillService.asmx?WSDL'
 
+  # Defaults
+  DEFAULTS = {su: 'dimitri1979', sp: '123456'}
+
+  # Last error code.
+  attr_accessor :last_error_code
+
   # Getting Savon client.
   def waybill_client
     Savon::Client.new { wsdl.document = WAYBILL_SERVICE_URL }
@@ -14,6 +20,13 @@ class RS::BaseRequest
 
   # Validates presence of specified keys in the #{params} hash.
   def validate_presence_of(params, *keys)
+    # XXX: do we always need this replacement???
+    [:su, :sp].each do |sym|
+      if keys.include?(sym) and params[sym].blank?
+        params[sym] = RS.config.send(sym)
+      end
+    end
+    # <-- XXX
     diff = keys - params.keys
     raise ArgumentError, "The following parameter(s) not specified: #{diff.to_s[1..-2]}" unless diff.empty?
   end

data/lib/rs/requests/config.rb

@@ -0,0 +1,19 @@
+# -*- encoding : utf-8 -*-
+require 'singleton'
+
+module RS
+
+  # RS configuration.
+  class Config
+    include Singleton
+
+    attr_accessor :sp, :su, :validate_remote
+  end
+
+  class << self
+    def config
+      RS::Config.instance
+    end
+  end
+
+end

data/lib/rs/requests/dict.rb

@@ -0,0 +1,111 @@
+# -*- encoding : utf-8 -*-
+require 'singleton'
+
+module RS
+  # Unit, which cannot be found in main list.
+  UNIT_OTHERS = 99
+
+  WAYBILL_TYPE_INNER = 1
+  WAYBILL_TYPE_TRANS = 2
+  WAYBILL_TYPE_WITHOUT_TRANS = 3
+  WAYBILL_TYPE_DISTR = 4
+  WAYBILL_TYPE_RETRN = 5
+  WAYBILL_TYPE_SUBWB = 6
+
+  WAYBILL_TYPES = {
+    WAYBILL_TYPE_INNER => 'შიდა გადაზიდვა',
+    WAYBILL_TYPE_TRANS => 'ტრანსპორტირებით',
+    WAYBILL_TYPE_WITHOUT_TRANS => 'ტრანსპორტირების გარეშე',
+    WAYBILL_TYPE_DISTR => 'დისტრიბუცია',
+    WAYBILL_TYPE_RETRN => 'უკან დაბრუნება',
+    WAYBILL_TYPE_SUBWB => 'ქვე-ზედნადები'
+  }
+
+  TRANS_VEHICLE = 1
+  TRANS_RAILWAY = 2
+  TRANS_AIR     = 3
+  TRANS_OTHER   = 4
+  TRANS_VEHICLE_FRGN = 6
+
+  TRANSPORT_TYPES = {
+    TRANS_VEHICLE => 'საავტომობილო',
+    TRANS_RAILWAY => 'სარკინიგზო',
+    TRANS_AIR     => 'საავიაციო',
+    TRANS_OTHER   => 'სხვა',
+    TRANS_VEHICLE_FRGN => 'საავტომობილო - უცხო ქვეყნის'
+  }
+
+  class DictionaryRequest < BaseRequest
+
+    include Singleton
+
+    # Returns RS.GE units.
+    def units(opts = {})
+      validate_presence_of(opts, :su, :sp)
+      response = waybill_client.request 'get_waybill_units' do
+        soap.body = { 'su' => opts[:su], 'sp' => opts[:sp] }
+      end
+      resp = response.to_hash[:get_waybill_units_response][:get_waybill_units_result][:waybill_units][:waybill_unit]
+      units = {}
+      resp.each do |unit|
+        units[unit[:id].to_i] = unit[:name]
+      end
+      units
+    end
+
+    # Returns RS.GE waybill types.
+    def waybill_types(opts = {})
+      validate_presence_of(opts, :su, :sp)
+      response = waybill_client.request 'get_waybill_types' do
+        soap.body = { 'su' => opts[:su], 'sp' => opts[:sp] }
+      end
+      resp = response.to_hash[:get_waybill_types_response][:get_waybill_types_result][:waybill_types][:waybill_type]
+      types = {}
+      resp.each do |type|
+        types[type[:id].to_i] = type[:name]
+      end
+      types
+    end
+
+    # Returns RS.GE transport types.
+    def transport_types(opts = {})
+      validate_presence_of(opts, :su, :sp)
+      response = waybill_client.request 'get_trans_types' do
+        soap.body = { 'su' => opts[:su], 'sp' => opts[:sp] }
+      end
+      resp = response.to_hash[:get_trans_types_response][:get_trans_types_result][:transport_types][:transport_type]
+      types = {}
+      resp.each do |type|
+        types[type[:id].to_i] = type[:name]
+      end
+      types
+    end
+
+    # Returns name by given TIN number.
+    def get_name_from_tin(params = {})
+      validate_presence_of(params, :su, :sp, :tin)
+      response = waybill_client.request 'get_name_from_tin' do
+        soap.body = params
+      end
+      response.to_hash[:get_name_from_tin_response][:get_name_from_tin_result]
+    end
+
+    # Checks whether given argument is a correct personal TIN.
+    def personal_tin?(tin)
+      tin =~ /^[0-9]{11}$/
+    end
+
+    # Checks whether given argument is a correct corporate TIN.
+    def corporate_tin?(tin)
+      tin =~ /^[0-9]{9}$/
+    end
+
+  end
+
+  class << self
+    def dict
+      RS::DictionaryRequest.instance
+    end
+  end
+
+end

data/lib/rs/requests/sys.rb

@@ -0,0 +1,92 @@
+# -*- encoding : utf-8 -*-
+require 'singleton'
+
+module RS
+  # System administration related methods.
+  class SysRequest < BaseRequest
+    include Singleton
+
+    # Get your outside IP address.
+    def what_is_my_ip
+      response = waybill_client.request 'what_is_my_ip'
+      response.to_hash[:what_is_my_ip_response][:what_is_my_ip_result].strip
+    end
+
+    # Create service user.
+    #
+    # * `username` -- login for the main user
+    # * `password` -- password for the main user
+    # * `ip` -- your IP address
+    # * `name` -- some name for this user/ip configuration
+    # * `su` -- new user login
+    # * `sp` -- new user password
+    def create_user(opts)
+      validate_presence_of(opts, :username, :password, :ip, :name, :su, :sp)
+      response = waybill_client.request 'create_service_user' do
+        soap.body = {'user_name' => opts[:username], 'user_password' => opts[:password], 'ip' => opts[:ip], 'name' => opts[:name], 'su' => opts[:su], 'sp' => opts[:sp]}
+      end
+      response.to_hash[:create_service_user_response][:create_service_user_result]
+    end
+
+    # Update service user.
+    #
+    # * `username` -- login for the main user
+    # * `password` -- password for the main user
+    # * `ip` -- your IP address
+    # * `name` -- some name for this user/ip configuration
+    # * `su` -- user login
+    # * `sp` -- user's passwrod
+    def update_user(opts)
+      validate_presence_of(opts, :username, :password, :ip, :name, :su, :sp)
+      response = waybill_client.request 'update_service_user' do
+        soap.body = {'user_name' => opts[:username], 'user_password' => opts[:password], 'ip' => opts[:ip], 'name' => opts[:name], 'su' => opts[:su], 'sp' => opts[:sp]}
+      end
+      response.to_hash[:update_service_user_response][:update_service_user_result]
+    end
+
+    # Check service user. Also used for getting user's ID and payer's ID.
+    #
+    # possible parameters:
+    #
+    # `su` -- service username
+    # `sp` -- service password
+    # 
+    # Returns hash with the following structure:
+    #
+    # ```
+    # {payer: 'payer unique ID', user: 'user unique ID'}
+    # ```
+    def check_user(opts)
+      validate_presence_of(opts, :su, :sp)
+      response = waybill_client.request 'chek_service_user' do
+        soap.body = {'su' => opts[:su], 'sp' => opts[:sp] }
+      end
+      if response[:chek_service_user_response][:chek_service_user_result]
+        payer_id = response[:chek_service_user_response][:un_id]
+        user_id  = response[:chek_service_user_response][:s_user_id]
+        {payer: payer_id, user: user_id}
+      end
+    end
+
+    # Returns error codes.
+    def error_codes(opts = {})
+      validate_presence_of(opts, :su, :sp)
+      response = waybill_client.request 'get_error_codes' do
+        soap.body = {'su' => opts[:su], 'sp' => opts[:sp] }
+      end
+      errors = {}
+      response[:get_error_codes_response][:get_error_codes_result][:error_codes][:error_code].each do |el|
+        errors[el[:id].to_i] = el[:text]
+      end
+      errors
+    end
+
+  end
+
+  class << self
+    def sys
+      RS::SysRequest.instance
+    end
+  end
+
+end

data/lib/rs/requests/waybill.rb

@@ -0,0 +1,123 @@
+# -*- encoding : utf-8 -*-
+require 'singleton'
+
+module RS
+
+  class WaybillRequest < BaseRequest
+    include Singleton
+
+    # Save given waybill.
+    def save_waybill(waybill, opts = {})
+      validate_presence_of(opts, :su, :sp)
+      response = waybill_client.request 'save_waybill' do |soap|
+        soap.body do |xml|
+          xml.ins0 :su, opts[:su]
+          xml.ins0 :sp, opts[:sp]
+          xml.ins0 :waybill do |b|
+            waybill.to_xml b
+          end
+        end
+      end
+      hash_results = response.to_hash[:save_waybill_response][:save_waybill_result][:result]
+      if hash_results[:status].to_i == 0
+        waybill.id = hash_results[:id].to_i == 0 ? nil : hash_results[:id].to_i
+        waybill.error_code = 0
+        items_hash = hash_results[:goods_list][:goods]
+        items_hash = [items_hash] if items_hash.instance_of? Hash
+        (0..items_hash.size-1).each do |i|
+          waybill.items[i].id = items_hash[i][:id].to_i
+          #waybill.items[i].error_code = items_hash[i][:error].to_i
+        end
+      else
+       waybill.error_code = hash_results[:status].to_i
+      end
+    end
+
+    # Get saved waybill.
+    def get_waybill(opts)
+      validate_presence_of(opts, :id, :su, :sp)
+      response = waybill_client.request 'get_waybill' do
+        soap.body = {'su' => opts[:su], 'sp' => opts[:sp], 'waybill_id' => opts[:id]}
+      end
+      wb = RS::Waybill.new
+      #puts response.to_hash
+      wb.init_from_hash(response.to_hash[:get_waybill_response][:get_waybill_result][:waybill])
+    end
+
+    # Activate waybill.
+    def activate_waybill(opts)
+      validate_presence_of(opts, :id, :su, :sp)
+      if opts[:date]
+        response = waybill_client.request 'send_waybil_vd' do
+          soap.body = { 'su' => opts[:su], 'sp' => opts[:sp], 'begin_date' => opts[:date].strftime('%Y-%m-%dT%H:%M:%S'), 'waybill_id' => opts[:id] }
+        end
+        response.to_hash[:send_waybil_vd_response][:send_waybil_vd_result]
+      else
+        response = waybill_client.request 'send_waybill' do
+          soap.body = { 'su' => opts[:su], 'sp' => opts[:sp], 'waybill_id' => opts[:id] }
+        end
+        response.to_hash[:send_waybill_response][:send_waybill_result]
+      end
+    end
+
+    # Close waybill.
+    def close_waybill(opts)
+      validate_presence_of(opts, :su, :sp, :id)
+      if opts[:date]
+        response = waybill_client.request 'close_waybill_vd' do
+          soap.body = { 'su' => opts[:su], 'sp' => opts[:sp], 'delivery_date' => opts[:date].strftime('%Y-%m-%dT%H:%M:%S'), 'waybill_id' => opts[:id] }
+        end
+        response.to_hash[:close_waybill_vd_response][:close_waybill_vd_result].to_i == 1
+      else
+        response = waybill_client.request 'close_waybill' do
+          soap.body = { 'su' => opts[:su], 'sp' => opts[:sp], 'waybill_id' => opts[:id] }
+        end
+        response.to_hash[:close_waybill_response][:close_waybill_result].to_i == 1
+      end
+    end
+
+    # Delete waybill.
+    # This operation is permitted only for waybill with RS::Waybill::STATUS_SAVED status.
+    def delete_waybill(opts)
+      validate_presence_of(opts, :id, :su, :sp)
+      response = waybill_client.request 'del_waybill' do |soap|
+        soap.body = {'su' => opts[:su], 'sp' => opts[:sp], 'waybill_id' => opts[:id]}
+      end
+      response.to_hash[:del_waybill_response][:del_waybill_result].to_i == 1
+    end
+
+    # Deactivate waybill.
+    # This operation is permitted only for waybill with RS::Waybill::STATUS_ACTIVE or RS::Waybill::STATUS_CLOSED statuses.
+    def deactivate_waybill(opts)
+      validate_presence_of(opts, :id, :su, :sp)
+      response = waybill_client.request 'ref_waybill' do |soap|
+        soap.body = {'su' => opts[:su], 'sp' => opts[:sp], 'waybill_id' => opts[:id]}
+      end
+      response.to_hash[:ref_waybill_response][:ref_waybill_result].to_i == 1
+    end
+
+    # Save this waybill as invoice, related to this waybill.
+    # Returns invoice ID (or `nil` if the save operation was unsuccessfull).
+    def save_invoice(opts)
+      validate_presence_of(opts, :id, :su, :sp)
+      response = waybill_client.request 'save_invoice' do |soap|
+        soap.body = {'su' => opts[:su], 'sp' => opts[:sp], 'waybill_id' => opts[:id], 'in_inv_id' => (opts[:invoice_id] || 0)}
+      end
+      resp = response.to_hash[:save_invoice_response][:save_invoice_result].to_i
+      if resp == 1
+        response.to_hash[:save_invoice_response][:out_inv_id].to_i
+      else
+        self.last_error_code = resp
+        nil
+      end
+    end
+
+  end
+
+  class << self
+    def wb
+      RS::WaybillRequest.instance
+    end
+  end
+
+end

data/lib/rs/version.rb

@@ -1,4 +1,4 @@
 # -*- encoding : utf-8 -*-
 module RS
-  VERSION = '0.1.0.beta2'
+  VERSION = '0.1.0.rc1'
 end

data/rs.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency 'rspec', '~> 2'
-  s.add_runtime_dependency 'savon'
+  s.add_runtime_dependency 'savon', '0.9.9'
   s.add_runtime_dependency 'httpi'
   s.add_runtime_dependency 'prawn', '~>0.12'
   s.add_runtime_dependency 'c12-commons', '~> 0.0.5'

data/spec/helpers.rb

@@ -0,0 +1,41 @@
+# -*- encoding : utf-8 -*-
+
+ORG_01 = {id: 731937, tin: '206322102', name: 'სატესტო კოდი'}
+ORG_02 = {id: -1, tin: '12345678910', name: 'სატესტო სატესტო'}
+USER01 = {id: 46362, username: 'tbilisi', password: '123456', payer: ORG_01[:id], payer_tin: ORG_01[:tin], payer_name: ORG_01[:name]}
+
+def create_waybill(opts = {})
+  RS::Waybill.new(id: opts[:id] || 0,
+    type: opts[:type] || RS::WAYBILL_TYPE_TRANS,
+    status: opts[:status] || RS::Waybill::STATUS_SAVED,
+    seller_id: USER01[:payer], seller_tin: USER01[:payer_tin], seller_name: USER01[:payer_name],
+    buyer_tin: opts[:buyer_tin] || ORG_02[:tin],
+    buyer_name: opts[:buyer_name] || ORG_02[:name],
+    check_buyer_tin: true,
+    seller_info: opts[:seller_info], buyer_info: opts[:buyer_info],
+    driver_tin: opts[:dirver_tin] || '02001000490',
+    driver_name: opts[:dirver_name] || 'დიმიტრი ყურაშვილი',
+    check_driver_tin: true,
+    start_address: opts[:start_address] || 'ქ. აბაშა, კაჭარავას 35',
+    end_address: opts[:end_address] || 'ქ. სენაკი, თავისუფლების 10',
+    transportation_cost: opts[:transportation_cost] || 0,
+    transportation_cost_payer: opts[:transportation_cost_payer] || 1,
+    transport_type_id: opts[:transport_type_id] || RS::TRANS_VEHICLE,
+    car_number: opts[:car_number] || 'wdw842',
+    comment: opts[:comment], user_id: USER01[:id],
+    items: opts[:items]
+  )
+end
+
+def create_item(opts = {})
+  RS::WaybillItem.new(id: opts[:id] || 0,
+    bar_code: opts[:bar_code] || '001',
+    prod_name: opts[:prod_name] || 'Tomato',
+    unit_id: opts[:unit_id] || RS::UNIT_OTHERS,
+    unit_name: opts[:unit_name] || 'kg',
+    quantity: opts[:quantity] || 1,
+    price: opts[:price] || 1,
+    vat_type: opts[:vat_type] || RS::VAT_COMMON,
+    delete: false
+  )
+end

data/spec/models/waybill_spec.rb

@@ -0,0 +1,99 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+RSpec::Matchers.define :have_error_field do |fld|
+  match { |obj| !obj.errors[fld].blank? }
+end
+
+describe 'WaybillItem validation' do
+  before(:all) do
+    @item = RS::WaybillItem.new
+    @item.validate
+  end
+  subject { @item }
+  it { should have_error_field :bar_code }
+  it { should have_error_field :prod_name }
+  it { should have_error_field :unit_id }
+  it { should_not have_error_field :unit_name }
+  it { should have_error_field :quantity }
+  it { should have_error_field :price }
+  context 'define bar-code' do
+    before(:all) do
+      @item.bar_code = '001'
+      @item.validate
+    end
+    subject { @item }
+    it { should_not have_error_field :bar_code }
+  end
+  context 'define production-name' do
+    before(:all) do
+      @item.prod_name = 'tomato'
+      @item.validate
+    end
+    subject { @item }
+    it { should_not have_error_field :prod_name }
+  end
+  context 'define unit = 99' do
+    before(:all) do
+      @item.unit_id = RS::UNIT_OTHERS
+      @item.validate
+    end
+    subject { @item }
+    it { should_not have_error_field :unit_id }
+    it { should have_error_field :unit_name }
+    context('add unit-name') do
+      before(:all) do
+        @item.unit_name = 'kg'
+        @item.validate
+      end
+      subject { @item }
+      it { should_not have_error_field :unit_id }
+      it { should_not have_error_field :unit_name }
+    end
+  end
+  context 'define q < 0' do
+    before(:all) do
+      @item.quantity = -100
+      @item.validate
+    end
+    subject { @item }
+    it { should have_error_field :quantity }
+  end
+  context 'define q > 0' do
+    before(:all) do
+      @item.quantity = +100
+      @item.validate
+    end
+    subject { @item }
+    it { should_not have_error_field :quantity }
+  end
+  context 'define p < 0' do
+    before(:all) do
+      @item.price = -10
+      @item.validate
+    end
+    subject { @item }
+    it { should have_error_field :price }
+  end
+  context 'define p >0' do
+    before(:all) do
+      @item.price = +10
+      @item.validate
+    end
+    subject { @item }
+    it { should_not have_error_field :price }
+  end
+end
+
+describe 'Waybill validation' do
+  before(:all) do
+    @waybill = RS::Waybill.new
+    @waybill.validate
+  end
+  subject { @waybill }
+  it { should have_error_field :buyer_tin }
+  it { should_not have_error_field :buyer_name }
+  it { should have_error_field :start_address }
+  it { should have_error_field :end_address }
+  
+end