dellin_info_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8acb30e84ca701ed30db08571b4132b4b6a32a9b
+  data.tar.gz: fa7be481254d32bf362d75786fbe6f0a2f2752ce
+SHA512:
+  metadata.gz: 87781cfa612de089eacb717507329e0d10e375dee58cb7ecc9a61a3c1af216627aabd61738552ce5c39d6ce5402836a678a0f51acaf69ccbc8e19987ce756a46
+  data.tar.gz: 30aa73d6309cada45f87475bc756d47d9f506185774ec055cd3fb3ee52317a5ddc32c0e3cba9215128f48be24021af3746c8eff215afc70d11842c324e1520aa

data/README.txt

@@ -0,0 +1,45 @@
+gem для взаимодействия с ресурсом dellin.ru.
+Поиск накладной по неполным данным
+Поиск накладной по номеру
+Подписка к накладной по номеру и получения изменения по накладной
+Расчет стоимости
+Хранения бызы адресов (страна, город, населенный пункт, улица)
+
+============================================================================================
+
+DellinInfo::API.find_oders
+
+
+на выходе получиться объект DellinInfo::API::OrderCollection
+
+Пример:
+
+oders = DellinInfo::API.find_oders(params)
+
+oders.each {|oder| puts oder.docNumber}
+
+============================================================================================
+
+
+DellinInfo::API.status_oder
+
+Спомощью этого метода можно получить статус накладной по номеру, возвращается объетк класса DellinInfo::API::OrderStatus
+
+пример
+p DellinInfo::API.status_oder('16-00011096893')
+
+
+============================================================================================
+
+DellinInfo::API.reference
+
+Метод для получения ссылки на данные справочников с сайта Деловые Линии
+http://dev.dellin.ru/api/public/tables/
+
+p DellinInfo::API.reference('countries')
+
+Возвможные параметры:
+countries
+cities
+places
+streets

data/lib/dellin_info.rb

@@ -0,0 +1,78 @@
+require 'yaml'
+require 'active_support/all'
+require 'date'
+require_relative 'dellininfo/valide_data'
+require_relative 'dellininfo/client'
+require_relative 'dellininfo/reference'
+require_relative 'dellininfo/order_collection'
+require_relative 'dellininfo/reference'
+require_relative 'dellininfo/order_status'
+module DellinInfo
+  module API
+
+    # Приложение можно сконфигурировать, для конфикурации необходимо указать в константе DellinInfo::API::PATH путь до файла yml
+    # где ключ - название класса в snakecase, а значение - пара (параметр - значение)
+    PATH = 'path to config.yml'
+
+
+
+    # Все основные настройки хранятся в отдельном файле, данный метод рализует конфигурацию всех классов модуля
+    def self.configure!
+
+      YAML.load_file(PATH).each_pair do |config_class, params|
+        params.each_pair do |param, value|
+          "DellinInfo::API::#{config_class.camelize}".constantize.config[param] = value
+        end
+      end
+    end
+
+
+    # Данный метод получает ссылку на csv с данными справочников Деловых линиях
+    # http://dev.dellin.ru/api/public/tables/
+    # и хэш, по которому можно отследить актуальность данных
+    # возвращается объект класса DellinInfo::API::Reference
+    def self.reference(type)
+      type = type.to_sym
+      url_type = Reference::TYPE[type]
+      data = client_request(url_type)
+
+      Reference.new(data)
+    end
+
+    # метод поиска накладных по неполным данным
+    def self.find_oders(params = {})
+      if params[:date_start].nil?
+        set_time!
+        params[:date_start] = @start_date
+        params[:date_end] = @end_day
+      end
+      data = client_request(OrderCollection, params)
+      OrderCollection.new data
+      
+    end
+
+    # метод проверяющий статусы накладной по номеру
+    def self.status_oder(id_oder)
+      data = client_request(OrderStatus, docid: id_oder)
+      DellinInfo::API::OrderStatus.new data
+      
+    end
+
+    def self.client_request(dellin_class, params = {})
+      client = Client.new()
+      data = client.request(dellin_class.config['partial_url'], params).body
+      JSON.parse data
+      
+    end
+
+    def self.set_time!
+      
+      @start_date  = 6.day.ago.strftime('%Y-%m-%d')
+      @end_day     = Time.now.strftime('%Y-%m-%d')
+      
+      
+    end
+
+
+  end
+end

data/lib/dellininfo/client.rb

@@ -0,0 +1,36 @@
+require 'httparty'
+require 'json'
+
+module DellinInfo
+  module API
+    class Client
+      include ActiveSupport::Configurable
+
+      # в проекте используется только публичные API, поэтому данный метод в годе больше не затронут,
+      # но оставлен для возможности расширить функционал
+      def auth(options = {})       
+        response = HTTParty.post('https://api.dellin.ru/v1/customers/login.json', 
+          :body => {:login => options[:username], :password => options[:password], :appKey => @app_key}.to_json,
+          :headers => {'Content-Type' => 'application/json'})
+        print response
+        response['sessionID']
+      end
+
+      def request(op, params = {})
+        params[:appKey] = @app_key
+        response = HTTParty.post("https://api.dellin.ru/v1/#{op}.json",
+          :body => params.to_json,
+          :headers => {'Content-Type' => 'application/json'})
+        response
+      end
+
+      private
+
+      def initialize()
+        raise "No app key given" unless config['app_key']
+        @app_key = config['app_key']
+      end
+
+    end
+  end
+end

data/lib/dellininfo/order.rb

@@ -0,0 +1,65 @@
+require 'date'
+module DellinInfo
+  module API
+    class Order
+      include ValideData
+      ATTRIBUTES = [
+        :availableAD,
+        :estimatedDeliveryDate,
+        :terminalSender,
+        :unvailableSfRequestReason,
+        :isSfRequestOrdered,
+        :availableSfRequest,
+        :opf,
+        :terminalReceiver,
+        :docNumber,
+        :comment,
+        :sizedWeight,
+        :ordNum,
+        :sizedVolume,
+        :docDate,
+        :sqlUuid,
+        :height,
+        :width,
+        :length,
+        :aviaDeliveryType,
+        :numAvia,
+        :giveoutDate,
+        :conditionAvia,
+        :oversizedVolume,
+        :oversizedWeight,
+      ]
+      
+      attr_accessor :state, :city_sender, :city_receiver, *ATTRIBUTES
+
+      def to_s
+        "накладная № #{@docNumber} от #{Date.parse docDate}\nОтправление из города #{@city_sender} в город #{@city_receiver}\nстатус: #{@state}\n#{'-'*10}\n"
+                                   
+      end                           
+
+
+
+
+
+
+      private
+      def initialize(hash_track)
+        data = parse_hash_response(hash_track, 'order')
+
+        ATTRIBUTES.each do |attribute|
+
+          self.send(set_attr_method(attribute), data[attribute])
+
+        end
+
+        @state = 'не установлен'
+        
+      end
+      
+      
+    end
+  end
+end
+
+
+

data/lib/dellininfo/order_collection.rb

@@ -0,0 +1,56 @@
+require_relative 'order.rb'
+module DellinInfo
+  module API
+    class OrderCollection
+      include Enumerable
+      include ValideData
+      include ActiveSupport::Configurable
+
+      config['partial_url'] = 'public/tracker_advanced'
+
+
+      attr_reader :errors, :orders, :cash
+
+      def each 
+        @orders.each {|oder| yield oder} 
+        
+      end
+
+
+
+      private
+      def initialize(oders_hash)
+        @errors = oders_hash['errormsg']
+        @orders = []
+        @cash = there_tracks(oders_hash)
+
+        unless @cash.nil?
+          @cash.each do |track|
+            @orders << Order.new(track)
+          end  
+        end
+
+        determine_state!
+
+      end
+
+      def determine_state!
+
+        @orders.each do |order|
+          id_oder = order.docNumber
+          status = DellinInfo::API.status_oder(id_oder)
+          order.state = status.state
+          order.city_sender = status.receive['city']
+          order.city_receiver = status.giveout['city']
+        end
+
+        self
+        
+      end
+
+
+      
+      
+    end
+  end
+end

data/lib/dellininfo/order_status.rb

@@ -0,0 +1,33 @@
+module DellinInfo
+  module API
+    class OrderStatus
+      include ValideData
+      include ActiveSupport::Configurable
+
+      config['partial_url'] = 'public/tracker'
+
+      ATTRIBUTES = [:errors, :estimatedDeliveryDate, :state, :giveout, :availableSfRequest, :receive]
+
+      attr_accessor *ATTRIBUTES
+
+      def to_s
+        "Отправление из города: #{@receive['city']} в город #{@giveout['city']}\nСтатус: #{@state}\nОжидаемая дата прихода #{@estimatedDeliveryDate}\nТерминал прибытия: #{@giveout['terminal']}"
+        
+      end
+
+      private
+      def initialize(hash_status)
+        valid_hash = delete_spase_key(hash_status)
+
+        ATTRIBUTES.each do |attribute|
+
+          self.send(set_attr_method(attribute), valid_hash[attribute.to_s])
+
+        end
+
+      end
+      
+      
+    end
+  end
+end

data/lib/dellininfo/reference.rb

@@ -0,0 +1,26 @@
+module DellinInfo
+  module API
+    class Reference
+      attr_reader :hash, :url
+
+      TYPE = {
+        countries: 'public/countries',
+        cities:    'public/cities',
+        places:    'public/places',
+        streets:   'public/streets'
+      }
+
+
+
+
+      private
+      def initialize(hash)
+        @hash = hash['hash']
+        @url  = hash['url']
+        self
+      end
+      
+      
+    end
+  end
+end

data/lib/dellininfo/valide_data.rb

@@ -0,0 +1,47 @@
+module DellinInfo
+  module API
+    module ValideData
+
+      def there_tracks (oders_hash)
+        if oders_hash['orders'].empty?
+          p errors
+          nil
+        else
+          oders_hash.dig('orders', 'tracker')
+        end
+        
+      end
+
+
+      def parse_hash_response(track, key_is_hash)
+
+        simple_hash = {}
+
+        track.each_pair do |param, val|
+          unless param.to_s == key_is_hash.to_s
+            simple_hash[param.to_sym] = val
+          else
+            val.each_pair { |key, val_oder| simple_hash[key.to_sym] = val_oder  }
+          end
+        end
+
+        simple_hash
+
+      end 
+
+      def set_attr_method(attr_sym)
+        atr = attr_sym.to_s + '='
+        atr.to_sym
+        
+      end
+
+      def delete_spase_key(hash)
+        valid_hash = {}
+        hash.each_pair { |key, val| valid_hash[key.strip] = val  }
+        valid_hash
+            
+      end    
+      
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: dellin_info_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexander Shvaykin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+description: Gem implements the methods of public api dellin.ru site
+email: skiline.alex@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- "./README.txt"
+- lib/dellin_info.rb
+- lib/dellininfo/client.rb
+- lib/dellininfo/order.rb
+- lib/dellininfo/order_collection.rb
+- lib/dellininfo/order_status.rb
+- lib/dellininfo/reference.rb
+- lib/dellininfo/valide_data.rb
+homepage: https://github.com/AlexanderShvaykin/dellininfo/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- Internet connection
+- A good mood
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Search shipments by incomplete data and check the status of sending in a
+  transport company
+test_files: []
+has_rdoc: