dpd_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ffa837bb809c1d46862490d923d3d4543cf2591
+  data.tar.gz: 88a31b5250ee6a8cfc3d7f10dc61a09846bd4594
+SHA512:
+  metadata.gz: 79e3ac96bff1fb10d51ec69b4f4e59b1f44a2eefd4d85eadad9b4f75bcf9424d34f05e78a7af949512d1d7a4ee88e9d5986201dd3eb1dfa4542b4ab3174946b5
+  data.tar.gz: 378cbf3c5335192b3ebad252e219cae5e931bf5baea4afeb73a68f7809f28158ccb04685177bfc56e5d40220fb5d0e1243845d640eaf2ff7f84d9ef78d7d483d

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dpd_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ponomarev Nikolay
+
+MIT License
+
+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,468 @@
+DpdApi
+======
+
+:small_red_triangle_down: Ruby implementation for [DPD](http://dpd.ru)'s SOAP API
+
+Installation
+------------
+
+### Rails
+
+```ruby
+# Gemfile
+gem 'dpd_api'
+```
+
+```ruby
+# config/initializers/dpd_api.rb
+DpdApi.configure do |config|
+  # your dpd's given client key and client number
+  config.client_key    = 'ASD7686ASD76786786786786AASD'
+  config.client_number = '123456789'
+  config.base_url = Rails.env.production? ? 'http://ws.dpd.ru' : 'http://wstest.dpd.ru'
+end
+```
+
+### Ruby
+```ruby
+gem install dpd_api
+```
+
+```ruby
+require 'dpd_api'
+
+client_key    = 'ASD7686ASD76786786786786AASD'
+client_number = '123456789'
+DpdApi.configure { |c| c.client_key = client_key; c.client_number = client_number; }
+```
+
+Quickstart
+----------
+
+```ruby
+params = { pickup:   { city_id: 195851995 },
+           delivery: { city_id: 48951627 },
+           self_pickup:   false,
+           self_delivery: false,
+           weight: 1, }
+
+DpdApi::Calculator.service_cost(params)
+
+#=> [{:service_code=>"TEN", :service_name=>"DPD 10:00", :cost=>"2228.67", :days=>"4"}, {:service_code=>"DPT", :service_name=>"DPD 13:00", :cost=>"1966.47", :days=>"4"}, . . .]
+```
+
+Getting started
+---------------
+
+### DpdApi::Geography
+matches `/services/geography?wsdl` in DPD SOAP API
+
+####.cities_cash_pay
+matches `getCitiesCashPay`
+```ruby
+DpdApi::Geography.cities_cash_pay
+
+# => [{
+        city_id:      "48951627",
+        country_code: "RU",
+        country_name: "Россия",
+        region_code:  "42",
+        region_name:  "Кемеровская",
+        city_name:    "Кемерово"
+      }, . . . ]
+
+```
+
+####.terminals_self_delivery
+matches `getTerminalsSelfDelivery2`
+```ruby
+DpdApi::Geography.terminals_self_delivery
+
+# => [{
+      terminal: {
+        terminal_code:    "ABA",
+        terminal_name:    "Абакан - терминал",
+        terminal_address: "655004, Хакасия респ., г. Абакан, ул. Игарская, д. 10",
+        geo_coordinates: {
+          geo_x: "53.710113",
+          geo_y: "91.392873"
+        },
+        working_time: {
+          week_days: "Пн,Вт,Ср,Чт,Пт,Сб,Вс",
+          work_time: "09:00 - 18:00"
+        }
+      },
+      city: {
+        city_id:      "195851995",
+        country_code: "RU",
+        country_name: "Россия",
+        region_code:  "19",
+        region_name:  "Хакасия",
+        city_code:    "19000001000",
+        city_name:    "Абакан"
+      }
+    }, . . . ]
+
+```
+
+####.parcel_shops
+matches `?` there's no method in documentation
+```ruby
+params = {} # or without
+DpdApi::Geography.parcel_shops(params)
+
+# => [{
+      code:             "01A",
+      parcel_shop_type: "ПВП",
+      address: {
+        country_code:   "RU",
+        region_code:    "61",
+        region_name:    "Ростовская",
+        city_code:      "61000001000",
+        city_name:      "Ростов-на-Дону",
+        address_string: "344038, Ростовская обл., г. Ростов-на-Дону, пр-т Ленина, д. 115"
+      },
+      geo_coordinates: {
+        geo_x: "47.249054",
+        geo_y: "39.722657"
+      },
+      limits: {
+        max_weight: "31",
+        max_length: "100",
+        max_width:  "100",
+        max_height: "100"
+      },
+      working_time: [
+        {
+          week_days: "Пн,Вт,Ср,Чт,Пт,Сб",
+          work_time: "09:00 - 20:00"
+        },
+        {
+          week_days: "Вс",
+          work_time: "выходной"
+        }
+      ]
+    }, . . . ]
+
+```
+
+### DpdApi::Calculator
+matches `/services/calculator2?wsdl` in DPD SOAP API
+
+####.service_cost
+matches `getSeviceCost2`
+```ruby
+params = { pickup:   { city_id: 195851995 },
+           delivery: { city_id: 48951627 },
+           self_pickup:   false,
+           self_delivery: false,
+           weight: 1, }
+
+DpdApi::Geography.service_cost(params)
+
+# => [{
+        service_code: "TEN",
+        service_name: "DPD 10:00",
+        cost:         "2228.67",
+        days:         "4"
+      }, . . . ]
+
+```
+
+####.service_cost_by_parcels
+matches `getServiceCostByParcels2`
+```ruby
+params = {
+            pickup:   { city_id: 195851995 },
+            delivery: { city_id: 48951627 },
+            self_pickup:   true,
+            self_delivery: true,
+            parcel: {
+                weight: 0.5,
+                length: 0.5,
+                width:  0.5,
+                height: 0.5,
+            },
+            parcel: {
+                weight: 1,
+                length: 1,
+                width:  1,
+                height: 1,
+            },
+         }
+
+DpdApi::Geography.service_cost_by_parcels(params)
+
+# => [{
+        service_code: "TEN",
+        service_name: "DPD 10:00",
+        cost:         "551.65",
+        days:         "4"
+     }, . . . ]
+
+```
+
+### DpdApi::Order
+matches `/services/order2?wsdl`
+
+####.create_order
+matches `createOrder`
+```ruby
+params = {
+            header: {
+                date_pickup: date,
+                sender_address: {
+                    name: fio,
+                    terminal_code: 'ABA',
+                    city: 'Москва',
+                    street: 'Ленина',
+                    street_abbr: 'ул',
+                    house: 1,
+                    contact_fio: fio,
+                    contact_phone: '+79211234567',
+                },
+            },
+            order: [
+                {
+                    order_number_internal: '1234567',
+                    service_code: 'TEN',
+                    service_variant: 'ТД',
+                    cargo_num_pack: '1',
+                    cargo_weight: '1',
+                    cargo_registered: false,
+                    cargo_category: 'Одежда',
+                    receiver_address: {
+                        name: fio,
+                        terminal_code: '',
+                        city: 'Воронеж',
+                        street: 'Красноармейская',
+                        street_abbr: 'ул',
+                        house: 1,
+                        contact_fio: fio,
+                        contact_phone: '+79211234567',
+                    },
+                    parcel: [
+                        {
+                            number: '123456789',
+                        },
+                    ],
+                },
+            ],
+        }
+
+DpdApi::Order.create_order(params)
+
+# => [{
+        order_number_internal: "1234567",
+        order_num: "10160002MOW",
+        status: "OK",
+        error_message:  nil,
+     }]
+
+```
+
+####.order_status
+matches `getOrderStatus`
+```ruby
+params = {
+            order: {
+                order_number_internal: '123456',
+            }
+         }
+
+
+DpdApi::Order.order_status(params)
+
+# => [{
+        order_number_internal: "123456",
+        order_num: "10160001MOW",
+        status: "OK",
+     }]
+
+
+```
+####.create_address
+matches `createAddress`
+```ruby
+params = {
+            client_address: {
+                code: '78',
+                name: fio,
+                city: 'Воронеж',
+                street: 'Красноармейская',
+                street_abbr: 'ул',
+                house: 1,
+                contact_fio: fio,
+                contact_phone: '+79211234567',
+            },
+         }
+
+
+
+DpdApi::Order.create_address(params)
+
+# => [{
+         code:   "78",
+         status: "OK",
+     }]
+
+
+```
+####.update_address
+matches `updateAddress`
+```ruby
+params = {
+            client_address: {
+                code: '78',
+                name: fio,
+                city: 'Воронеж',
+                street: 'Красноармейская',
+                street_abbr: 'ул',
+                house: 1,
+                contact_fio: fio,
+                contact_phone: '+79200000000',
+            },
+         }
+
+
+
+
+DpdApi::Order.update_address(params)
+
+# => [{
+         code:   "78",
+         status: "OK",
+     }]
+```
+
+####.cancel_order
+matches `cancelOrder`
+```ruby
+params = {
+            cancel: {
+                order_num: '10160001MOW',
+            },
+         }
+
+DpdApi::Order.cancel_order(params)
+
+# => [{
+        order_number_internal: "123456",
+        order_num: "10160001MOW",
+        status: "Canceled",
+     }]
+
+```
+
+####.add_parcels
+matches `addParcels`
+```ruby
+params = {
+            order_num: '10160001MOW',
+            cargo_num_pack: '2',
+            cargo_weight: '2',
+            cargo_category: 'Одежда',
+            parcel: [
+                { number: '987654321' },
+                { number: '5678' },
+            ],
+        }
+
+DpdApi::Order.add_parcels(params)
+
+# => {
+        order_num: "10160001MOW",
+        status:    "OK",
+        parcel_status: [
+            {
+                number: "987654321",
+                status: "OK",
+            },
+            {
+                number: "5678",
+                status: "OK"
+            }
+        ]
+     }
+
+```
+
+####.remove_parcels
+matches `removeParcels`
+```ruby
+params = {
+            order_num: '10160001MOW',
+            cargo_num_pack: '1',
+            cargo_weight: '1',
+            cargo_category: 'Одежда',
+            parcel: [
+                {
+                    number: '987654321',
+                },
+            ],
+         }
+
+
+DpdApi::Order.remove_parcels(params)
+
+# => {
+        order_num: "10160001MOW",
+        status: "OK",
+        parcel_status: {
+            number: "987654321",
+            status: "OK",
+        },
+     }
+
+
+```
+
+
+####.invoice_file
+matches `getInvoiceFile`
+```ruby
+params = { order_num: '10160002MOW' }
+
+DpdApi::Order.invoice_file(params)
+
+# => {
+        file: 'JVBERi0xLjQKJeLj . . .'
+     }
+```
+
+
+### DpdApi::Tracing
+matches `/services/tracing1-1?wsdl` in DPD SOAP API
+
+####.states_by_client_order
+matches `getStatesByClientOrder`
+```ruby
+params = {
+            client_order_nr: '12345',
+         }
+
+DpdApi::Tracing.states_by_client_order(params)
+
+```
+
+####.states_by_client_parcel
+matches `getStatesByClientParcel`
+```ruby
+params = {
+            client_parcel_nr: '987654321',
+         }
+
+DpdApi::Tracing.states_by_client_parcel(params)
+
+```
+
+####.states_by_dpd_order
+matches `getStatesByDpdOrder`
+```ruby
+params = {
+            client_parcel_nr: '987654321',
+         }
+
+DpdApi::Tracing.states_by_dpd_order(params)
+
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/dpd_api.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dpd_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dpd_api"
+  spec.version       = DpdApi::VERSION
+  spec.authors       = ["Ponomarev Nikolay"]
+  spec.email         = ["itsnikolay@gmail.com"]
+  spec.summary       = %q{Ruby API for Dpd delivery service}
+  spec.description   = %q{Ruby API for Dpd delivery service}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'savon', "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/dpd_api/base.rb

@@ -0,0 +1,36 @@
+module DpdApi
+  class Base
+    class << self
+      def operations
+        client.operations
+      end
+
+    protected
+
+      def client
+        Savon.client(wsdl: self.url)
+      end
+
+      def response(method, params = {})
+        begin
+          params    = DpdApi.configuration
+                            .auth_params
+                            .clone
+                            .deep_merge!(params)
+          request   = params.blank? ?  params : { request: params  }
+          response  = client.call(method, message: request)
+          namespace = "#{method}_response".to_sym
+          resources = response.body[namespace][:return]
+          resources = if resources.is_a?(Array)
+                        resources
+                      else
+                        [] << resources
+                      end
+          resources
+        rescue Savon::SOAPFault => error
+          { errors: error.to_s }
+        end
+      end
+    end
+  end
+end

data/lib/dpd_api/calculator.rb

@@ -0,0 +1,21 @@
+module DpdApi
+  class Calculator < Base
+    class << self
+      def service_cost(params = {})
+        method = :get_service_cost2
+        response(method, params)
+      end
+
+      def service_cost_by_parcels(params = {})
+        method = :get_service_cost_by_parcels2
+        response(method, params)
+      end
+
+      protected
+
+      def url
+        "#{DpdApi.configuration.base_url}/services/calculator2?wsdl"
+      end
+    end
+  end
+end

data/lib/dpd_api/configuration.rb

@@ -0,0 +1,33 @@
+module DpdApi
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :client_key,
+                  :client_number,
+                  :base_url
+
+    attr_reader :auth_params
+
+    def initialize
+      @client_key    = '123'
+      @client_number = '234'
+      @base_url      = 'http://wstest.dpd.ru'
+    end
+
+    def auth_params
+      {
+        auth: {
+          client_number: client_number,
+          client_key:    client_key,
+        }
+      }
+    end
+  end
+end

data/lib/dpd_api/geography.rb

@@ -0,0 +1,26 @@
+module DpdApi
+  class Geography < Base
+    class << self
+      def cities_cash_pay
+        method = :get_cities_cash_pay
+        response(method)
+      end
+
+      def terminals_self_delivery
+        method = :get_terminals_self_delivery2
+        response(method)
+      end
+
+      def parcel_shops(params = {})
+        method = :get_parcel_shops
+        response(method, params)
+      end
+
+      protected
+
+      def url
+        "#{DpdApi.configuration.base_url}/services/geography?wsdl"
+      end
+    end
+  end
+end

data/lib/dpd_api/label_print.rb

@@ -0,0 +1,32 @@
+module DpdApi
+  class LabelPrint < Base
+    # TODO: Implement namespace
+    class << self
+      def create_label_file(params = {})
+        method = :create_label_file
+        namespace = :get_label_file
+        response(method, params, namespace: namespace)
+      end
+
+      def create_label(params = {})
+        method = :create_label
+        namespace = :get_label
+        response(method, params, namespace: namespace)
+      end
+
+      def response(method, params = {}, namespace: nil)
+        params    = @auth_params.clone.deep_merge!(params)
+        request   = namespace ? { namespace => params } : params
+        response  = @client.call(method, message: request)
+        namespace = "#{method}_response".to_sym
+        response.body[namespace][:return]
+      end
+
+      protected
+
+      def url
+        "#{DpdApi.configuration.base_url}/services/label-print?wsdl"
+      end
+    end
+  end
+end