b2b_center_api 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 694ccdd29ca008be6e32204bdc43d51da76d0cb3
-  data.tar.gz: 68838e4d378fa1b41fe998f02bbe72f50ac99d9f
+  metadata.gz: c01d388e69d03c7577e73443eb76e61709674a0e
+  data.tar.gz: 1fe96e984765447f9d45f4db55fdd577d71f906f
 SHA512:
-  metadata.gz: 4f58a155d2bc68c7c10f1497bdc8086ead2595c9072bd30c387bab4a6bfa662af70620b1501df97685cea545b5ff41034e923007ebba3dabd9b65f905427495d
-  data.tar.gz: efa817d70a9f13c340d22d6197a7036fbf6a6882db9c8b4f43e721935511caa20a50f86a5173b4c5642efe37e05f7aa7044bc7ebf1c86e303538b854f0df0b2c
+  metadata.gz: 8259a0e35dd79ecc5d02c6ecc4145a0cdca7c2da241bee710496a43584cfa43f8ef7215237bc609f37797c15565e25b43c3b87c8719979b8e2b838c0ed147210
+  data.tar.gz: 48108158f4e40b675df1e6ecaa91bbc9c4d4b250fb3a53a86e5cf068fb6f3fe9090856141e0ab24e83daa5c893aaf12af375950b5f85730dad4babf245489bbb

data/.rubocop.yml

@@ -6,3 +6,6 @@ PercentLiteralDelimiters:
 
 UnneededPercentQ:
   Enabled: false
+
+LineLength:
+  Max: 119

data/README.md

@@ -18,7 +18,35 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'b2b_center_api'
+
+B2bCenterApi::Settings.soap_configure(
+  wsdl: 'http://demo.b2b-center.ru/market/remote.html?wsdl',
+  proxy: 'http://login:pass@address:port',
+  env_namespace: 'SOAP-ENV',
+  filters: [:password],
+  pretty_print_xml: true,
+  log: false
+)
+
+B2bCenterApi::Settings.auth_configure(
+  auth: { login: 'login', password: 'pass' }
+)
+
+b2b = B2bCenterApi::Client.new
+
+ps = b2b.remote_auction.get_participants(18_501)
+
+puts 'participants:'
+puts ps
+puts 'offers for first participant:'
+puts ps[0].offers
+```
+
+## Documentation
+
+http://www.rubydoc.info/gems/b2b_center_api
 
 ## Contributing
 

data/b2b_center_api.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['archakov@gmail.com']
   spec.description   = %q{API for b2b-center.}
   spec.summary       = %q{B2B Center API}
-  spec.homepage      = ''
+  spec.homepage      = 'https://github.com/kodram/b2b_center_api'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($RS)

data/lib/b2b_center_api/client.rb

@@ -5,15 +5,20 @@ require 'b2b_center_api/remote_tender'
 require 'savon'
 
 module B2bCenterApi
-  # Soap Client
+  # Client for API
   class Client
-    attr_accessor :remote_auction,
-                  :remote_market,
-                  :remote_tender
+    # Методы класса RemoteAuction
+    # @return [RemoteAuction]
+    attr_accessor :remote_auction
+    # Методы класса RemoteMarket
+    # @return [RemoteMarket]
+    attr_accessor :remote_market
+    # Методы класса RemoteTender
+    # @return [RemoteTender]
+    attr_accessor :remote_tender
 
-    def initialize(options = nil)
-      options ||= Settings.soap_options
-      @client = Savon.client(options)
+    def initialize
+      @client = Savon.client(Settings.soap_options)
       @remote_auction = RemoteAuction.new(@client)
       @remote_market = RemoteMarket.new(@client)
       @remote_tender = RemoteTender.new(@client)

data/lib/b2b_center_api/remote_auction.rb

@@ -1,15 +1,32 @@
 require 'b2b_center_api/web_service'
 
 module B2bCenterApi
+  # Методы класса RemoteAuction
   class RemoteAuction
     def initialize(client)
       @client = client
       @client_web = WebService::RemoteAuction.new(client)
     end
 
+    # Получить список участников
+    # @param auction_id [Integer] Номер аукциона/объявления
+    # @return [WebService::Types::AuctionParticipant[]]
     def get_participants(auction_id)
       response = @client_web.command :get_participants, auction_id: auction_id
-      WebService::Types::AuctionParticipant.from_response(response, @client)
+      WebService::Types::AuctionParticipant.from_response(response, @client, auction_id)
+    end
+
+    # Получить предложение участника
+    # Метод возвращает информацию о предложении (альтернативном предложении) участника:
+    # последней ставке, имя файла с описанием предложения, информацию о том признан ли участник победителем.
+    # Возвращаемый методом файл доступен для скачивания из корневой FTP-папки организации.
+    # @param auction_id [Integer] Номер аукциона/объявления
+    # @param firm_id [Integer] ID организации (участник торговой процедуры)
+    # @param offer_num [Integer] = 0 — основное предложение = целое_число — альтернативное предложение №
+    # @return [WebService::Types::AuctionOffer]
+    def get_offer(auction_id, firm_id, offer_num)
+      response = @client_web.command :get_offer, auction_id: auction_id, firm_id: firm_id, offer_num: offer_num
+      WebService::Types::AuctionOffer.from_response(response, @client, auction_id, firm_id, offer_num)
     end
   end
 end

data/lib/b2b_center_api/remote_market.rb

@@ -8,9 +8,12 @@ module B2bCenterApi
       @client_web = WebService::RemoteMarket.new(client)
     end
 
+    # Получить информацию об организации
+    # @param firm_id [Integer] ID организации
+    # @return [WebService::Types::FirmInfo]
     def get_firm_info(firm_id)
       response = @client_web.command :get_firm_info, firm_id: firm_id
-      WebService::Types::FirmInfo.from_response(response, @client)
+      WebService::Types::FirmInfo.from_response(response, @client, firm_id)
     end
   end
 end

data/lib/b2b_center_api/remote_tender.rb

@@ -1,6 +1,7 @@
 require 'b2b_center_api/web_service'
 
 module B2bCenterApi
+  # Методы класса RemoteTender
   class RemoteTender
     def initialize(client)
       @client = client

data/lib/b2b_center_api/version.rb

@@ -1,3 +1,3 @@
 module B2bCenterApi
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/b2b_center_api/web_service/type_cast.rb

@@ -9,7 +9,8 @@ module B2bCenterApi
           return obj if obj.nil?
           case obj_type
           when :string then obj
-          when :integer then obj.to_s
+          when :integer then obj.to_i
+          when :float then obj.to_f
           when :date then Date.parse(obj)
           when :time then Time.parse(obj)
           when :boolean then to_boolean(obj)

data/lib/b2b_center_api/web_service/types.rb

@@ -1,2 +1,5 @@
 require 'b2b_center_api/web_service/types/auction_participant'
 require 'b2b_center_api/web_service/types/firm_info'
+require 'b2b_center_api/web_service/types/auction_offer'
+require 'b2b_center_api/web_service/types/b2b_file'
+require 'b2b_center_api/web_service/types/array_of_ids'

data/lib/b2b_center_api/web_service/types/array_of_ids.rb

@@ -0,0 +1,16 @@
+require 'b2b_center_api/web_service/types/base'
+
+module B2bCenterApi
+  module WebService
+    module Types
+      # Массив ID или других строк
+      class ArrayOfIds < Base
+        # @return [String[]]
+        def self.from_part_response(response)
+          return if response.nil?
+          to_array(response).map { |n| convert(n[:string], :string) }
+        end
+      end
+    end
+  end
+end

data/lib/b2b_center_api/web_service/types/auction_offer.rb

@@ -0,0 +1,47 @@
+require 'b2b_center_api/web_service/types/base'
+
+module B2bCenterApi
+  module WebService
+    module Types
+      # Предложение
+      class AuctionOffer < Base
+        # @return [Integer] Номер аукциона/объявления
+        attr_accessor :auction_id
+        # @return [Integer] ID организации (участник торговой процедуры)
+        attr_accessor :firm_id
+        # @return [Integer] = 0 — основное предложение = целое_число — альтернативное предложение №
+        attr_accessor :offer_num
+        # @return [Float] Последняя ставка. Формат значения DECIMAL(15,2)
+        attr_accessor :final_price
+        # @return [Float] Последняя ставка без НДС. Формат значения DECIMAL(15,2)
+        attr_accessor :final_price_notax
+        # @return [Time] Дата последней ставки.
+        attr_accessor :final_bet_date
+        # @return [Boolean] 1 — победитель, 0 — не победитель. Формат значения INT(1)
+        attr_accessor :winner
+        # @return [Integer] Количество ставок
+        attr_accessor :bets
+        # Файлы предложения. Поле содержит список записей типа file, в случае если у текущего
+        # пользователя нет доступа к файлу, то поле file.name — не заполняется.
+        # @return [B2bCenterApi::WebService::Types::File[]]
+        attr_accessor :files
+
+        # @return [AuctionOffer]
+        def self.from_response(response, client, auction_id, firm_id, offer_num)
+          return if response.result.nil?
+          r = response.result
+          t = AuctionOffer.new
+          t.soap_client = client
+          t.final_price = convert(r[:final_price], :float)
+          t.final_price_notax = convert(r[:final_price_notax], :float)
+          t.final_bet_date = convert(r[:final_bet_date], :time)
+          t.winner = convert(r[:winner], :boolean)
+          t.bets = convert(r[:bets], :integer)
+          t.files = B2bFile.from_part_response(r[:files])
+
+          t
+        end
+      end
+    end
+  end
+end

data/lib/b2b_center_api/web_service/types/auction_participant.rb

@@ -3,25 +3,45 @@ require 'b2b_center_api/web_service/types/base'
 module B2bCenterApi
   module WebService
     module Types
+      # Участник аукциона
       class AuctionParticipant < Base
-        attr_accessor :firm_id, :offers_nums
+        # @return [Integer] Номер аукциона/объявления
+        attr_accessor :auction_id
+        # @return [String] ID организации участника, если имена участников доступны,
+        #   либо строка вида "Participant N", где N — номер участника в списке участников, в противном случае.
+        attr_accessor :firm_id
+        # @return [Integer[]] Список отправленных заявок участником.
+        #   Возможные значения:
+        #   0 — основное предложение
+        #   целое_число — альтернативное предложение №
+        attr_accessor :offers_nums
 
-        def self.from_response(response, client)
+        # @return [Array] Массив {AuctionParticipant}
+        def self.from_response(response, client, auction_id)
+          return if response.result.nil?
           r = response.result
-          mas = r[:participant].map do |p|
+          mas = to_array(r[:participant]).map do |p|
             ap = AuctionParticipant.new
             ap.soap_client = client
-            ap.firm_id = convert(p[:firm_id], :integer)
-            ap.offers_nums = convert(p[:offers_nums][:string], :integer)
+            ap.auction_id = auction_id
+            ap.firm_id = convert(p[:firm_id], :string)
+            ap.offers_nums = ArrayOfIds.from_part_response(p[:offers_nums]).map(&:to_i)
             ap
           end
 
           mas
         end
 
+        # @return [FirmInfo] Информация об организации
         def firm
+          return firm_id if firm_id.include? 'Participant'
           remote_market.get_firm_info(firm_id)
         end
+
+        # @return [AuctionOffer[]] Массив предложений
+        def offers
+          offers_nums.map { |offer_num| remote_auction.get_offer(auction_id, firm_id, offer_num) }
+        end
       end
     end
   end

data/lib/b2b_center_api/web_service/types/b2b_file.rb

@@ -0,0 +1,34 @@
+require 'b2b_center_api/web_service/types/base'
+
+module B2bCenterApi
+  module WebService
+    module Types
+      # Файл
+      class B2bFile < Base
+        # @return [String] Наименование файла. Формат значения VARCHAR(255)
+        attr_accessor :title
+        # @return [String] Описание файла
+        attr_accessor :description
+        # Имя файла, например zayavka.doc.
+        # Файл расположен в корневой папке пользователя (доступ по FTP).
+        # Если пользователь не имеет прав для скачивания файла, то поле отсутствует.
+        # Формат значения VARCHAR(255)
+        # @return [String]
+        attr_accessor :name
+
+        # @return [B2bFile[]]
+        def self.from_part_response(response)
+          return if response.nil?
+          files = to_array(response[:file]).map do |f|
+            file = B2bFile.new
+            file.title = convert(f[:title], :string)
+            file.description = convert(f[:description], :string)
+            file.name = convert(f[:name], :string)
+            file
+          end
+          files
+        end
+      end
+    end
+  end
+end

data/lib/b2b_center_api/web_service/types/base.rb

@@ -34,6 +34,10 @@ module B2bCenterApi
         def remote_tender
           B2bCenterApi::RemoteTender.new(@soap_client)
         end
+
+        def self.to_array(obj)
+          obj.is_a?(Hash) ? [obj] : obj
+        end
       end
     end
   end

data/lib/b2b_center_api/web_service/types/firm_info.rb

@@ -3,36 +3,64 @@ require 'b2b_center_api/web_service/types/base'
 module B2bCenterApi
   module WebService
     module Types
+      # Информация об организации
       class FirmInfo < Base
-        attr_accessor :date_lastedit,
-                      :org_name,
-                      :org_name_short,
-                      :code_okpo,
-                      :bank_name,
-                      :bank_inn,
-                      :ogrn,
-                      :ogrn_given,
-                      :ogrn_date_given,
-                      :bank_kpp,
-                      :bank_bik,
-                      :bank_r_account,
-                      :bank_c_account,
-                      :bank_comments,
-                      :jury_address,
-                      :post_address,
-                      :fact_address,
-                      :site_url,
-                      :certification,
-                      :org_details,
-                      :bank_details,
-                      :country,
-                      # :bosses,
-                      :is_smb
+        # @return [Integer] ID организации
+        attr_accessor :firm_id
+        # @return [Time] Дата последнего изменения
+        attr_accessor :date_lastedit
+        # @return [String] Полное наименование организации. Формат значения VARCHAR(255)
+        attr_accessor :org_name
+        # @return [String] Краткое наименование организации. Формат значения VARCHAR(255)
+        attr_accessor :org_name_short
+        # @return [String] Код ОКПО. Формат значения VARCHAR (10)
+        attr_accessor :code_okpo
+        # @return [String] Название банка. Формат значения VARCHAR(255)
+        attr_accessor :bank_name
+        # @return [String] ИНН организации. Формат значения VARCHAR(30)
+        attr_accessor :bank_inn
+        # @return [String] ОГРН. Формат значения VARCHAR(15)
+        attr_accessor :ogrn
+        # @return [String] Кем выдан ОГРН. Формат значения VARCHAR(128)
+        attr_accessor :ogrn_given
+        # @return [Date] Дата выдачи ОГРН. Формат значения dd.mm.YYYY
+        attr_accessor :ogrn_date_given
+        # @return [String] КПП организации. Формат значения VARCHAR(12)
+        attr_accessor :bank_kpp
+        # @return [String] БИК. Формат значения VARCHAR(30)
+        attr_accessor :bank_bik
+        # @return [String] Расчетный счет. Формат значения VARCHAR(30)
+        attr_accessor :bank_r_account
+        # @return [String] Корреспондентский счет. Формат значения VARCHAR(30)
+        attr_accessor :bank_c_account
+        # @return [String] Комментарии к банковским реквизитам. Формат значения VARCHAR(255)
+        attr_accessor :bank_comments
+        # @return [String] Юридический адрес. Формат значения VARCHAR(255)
+        attr_accessor :jury_address
+        # @return [String] Почтовый адрес. Формат значения VARCHAR(255)
+        attr_accessor :post_address
+        # @return [String] Фактический адрес. Формат значения VARCHAR(255)
+        attr_accessor :fact_address
+        # @return [String] Адрес веб-сайта. Формат значения VARCHAR(255)
+        attr_accessor :site_url
+        # @return [String] Информация о сертификации продукции, работ и услуг
+        attr_accessor :certification
+        # @return [String] Регистрационные данные. Поле заполняется только для иностранных организаций.
+        attr_accessor :org_details
+        # @return [String] Банковские реквизиты. Поле заполняется только для иностранных организаций.
+        attr_accessor :bank_details
+        # @return [Integer] Код страны. Пример: код России = 643
+        attr_accessor :country
+        # @return [Boolean] Соответствует ли участник критериям СМП (среднего или малого предпринимательства)
+        attr_accessor :is_smb
 
-        def self.from_response(response, client)
+        # @return [FirmInfo]
+        def self.from_response(response, client, firm_id)
+          return if response.result.nil?
           r = response.result
           fi = FirmInfo.new
           fi.soap_client = client
+          fi.firm_id = firm_id
           fi.date_lastedit = convert(r[:date_lastedit], :time)
           fi.org_name = convert(r[:org_name], :string)
           fi.org_name_short = convert(r[:org_name_short], :string)
@@ -41,7 +69,7 @@ module B2bCenterApi
           fi.bank_inn = convert(r[:bank_inn], :string)
           fi.ogrn = convert(r[:ogrn], :string)
           fi.ogrn_given = convert(r[:ogrn_given], :string)
-          fi.ogrn_date_given = convert(r[:ogrn_date_given], :string)
+          fi.ogrn_date_given = convert(r[:ogrn_date_given], :date)
           fi.bank_kpp = convert(r[:bank_kpp], :string)
           fi.bank_bik = convert(r[:bank_bik], :string)
           fi.bank_r_account = convert(r[:bank_r_account], :string)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: b2b_center_api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Archakov Aleksandr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-06 00:00:00.000000000 Z
+date: 2015-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,13 +95,16 @@ files:
 - lib/b2b_center_api/web_service/response.rb
 - lib/b2b_center_api/web_service/type_cast.rb
 - lib/b2b_center_api/web_service/types.rb
+- lib/b2b_center_api/web_service/types/array_of_ids.rb
+- lib/b2b_center_api/web_service/types/auction_offer.rb
 - lib/b2b_center_api/web_service/types/auction_participant.rb
+- lib/b2b_center_api/web_service/types/b2b_file.rb
 - lib/b2b_center_api/web_service/types/base.rb
 - lib/b2b_center_api/web_service/types/firm_info.rb
 - spec/b2b_center_api_spec.rb
 - spec/spec_helper.rb
 - wsdl/demo.remote.xml
-homepage: ''
+homepage: https://github.com/kodram/b2b_center_api
 licenses:
 - MIT
 metadata: {}