dpd_api 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ffa837bb809c1d46862490d923d3d4543cf2591
-  data.tar.gz: 88a31b5250ee6a8cfc3d7f10dc61a09846bd4594
+  metadata.gz: dff86941663dc1c52bef9bd8222aee681c9a40c2
+  data.tar.gz: 52c87d029d27a4098b7292c0ee3af213aee63da5
 SHA512:
-  metadata.gz: 79e3ac96bff1fb10d51ec69b4f4e59b1f44a2eefd4d85eadad9b4f75bcf9424d34f05e78a7af949512d1d7a4ee88e9d5986201dd3eb1dfa4542b4ab3174946b5
-  data.tar.gz: 378cbf3c5335192b3ebad252e219cae5e931bf5baea4afeb73a68f7809f28158ccb04685177bfc56e5d40220fb5d0e1243845d640eaf2ff7f84d9ef78d7d483d
+  metadata.gz: 2168ed713fbf898ae4a58a1513f9f9dd82d15a0b7dd13c0cc22d97c5d68cf7a11536e53e2e141e956fd1b51170c49993a7c7ecef938c15386d66489c69396223
+  data.tar.gz: 2ab6385547d664e4760b176452a217cf84e85b8d9807c93900b494c6a720b6e32568187f1b36e048574e3d3250cc3bfe8c1cd640b49bbb3593168cfeba269062

data/.travis.yml

@@ -0,0 +1,8 @@
+before_install:
+  - gem install bundler
+rvm:
+ - 1.9.3
+ - 2.0.0
+ - 2.1.1
+ - 2.1.2
+ - 2.1.3

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in dpd_api.gemspec
 gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/README.md

@@ -3,6 +3,11 @@ DpdApi
 
 :small_red_triangle_down: Ruby implementation for [DPD](http://dpd.ru)'s SOAP API
 
+[![Gem Version](https://badge.fury.io/rb/dpd_api.svg)](http://badge.fury.io/rb/dpd_api)
+[![Build Status](https://travis-ci.org/itsNikolay/dpd_api.svg)](https://travis-ci.org/itsNikolay/dpd_api)
+[![Code Climate](https://codeclimate.com/github/itsNikolay/dpd_api/badges/gpa.svg)](https://codeclimate.com/github/itsNikolay/dpd_api)
+[![Test Coverage](https://codeclimate.com/github/itsNikolay/dpd_api/badges/coverage.svg)](https://codeclimate.com/github/itsNikolay/dpd_api)
+
 Installation
 ------------
 
@@ -16,7 +21,6 @@ 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'
@@ -51,6 +55,40 @@ 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"}, . . .]
 ```
 
+Table of content
+----------------
+* [NOTES](#notes)
+* [DpdApi::Geography](#dpdapigeography)
+  * [.cities_cash_pay](#cities_cash_pay)
+  * [.terminals_self_delivery](#terminals_self_delivery)
+  * [.parcel_shops](#parcel_shops)
+* [DpdApi::Calculator](#dpdapicalculator)
+  * [.service_cost](#service_cost)
+  * [.service_cost_by_parcels](#service_cost_by_parcels)
+* [DpdApi::Order](#dpdapiorder)
+  * [.create_order](#create_order)
+  * [.order_status](#order_status)
+  * [.create_address](#create_address)
+  * [.update_address](#update_address)
+  * [.cancel_order](#cancel_order)
+  * [.add_parcels](#add_parcels)
+  * [.remove_parcels](#remove_parcels)
+  * [.invoice_file](#invoice_file)
+* [DpdApi::Tracing](#dpdapitracing)
+  * [.states_by_client_order](#states_by_client_order)
+  * [.states_by_client_parcel](#states_by_client_parcel)
+  * [.states_by_dpd_order](#states_by_dpd_order)
+* [DpdApi::Nl](#dpdapinl)
+  * [.nl_amount](#nl_amount)
+  * [.nl_invoice](#nl_invoice)
+* [DpdApi::LabelPrint](#dpdapilabelprint)
+  * [.create_label_file](#create_label_file)
+
+Notes
+-----
+1. The gem is based on gem [savon](https://github.com/savonrb/savon) v.2
+2. Naming: java's `#getOrderStatus` becomes ruby's `#order_status`
+
 Getting started
 ---------------
 
@@ -466,3 +504,50 @@ params = {
 DpdApi::Tracing.states_by_dpd_order(params)
 
 ```
+
+
+### DpdApi::Nl
+matches `/services/nl?wsdl` in DPD SOAP API
+
+####.nl_amount
+matches `getNLAmount`
+```ruby
+params = {
+            date_from: Time.now - 1.days,
+            date_to:   Time.now + 1 days,
+          }
+
+DpdApi::Tracing.nl_amount(params)
+
+```
+####.nl_invoice
+matches `getNLInvoice`
+```ruby
+params = {
+            date_from: Time.now - 1.days,
+            date_to:   Time.now + 1 days,
+          }
+
+DpdApi::Tracing.nl_invoice(params)
+
+```
+
+
+### DpdApi::LabelPrint
+matches `/services/label-print?wsdl` in DPD SOAP API
+
+####.create_label_file
+matches `createLabelFile`
+```ruby
+params = {
+          file_format: 'PDF',
+          page_size: 'A5',
+          order: [
+            order_num: '10160002MOW',
+            parcels_number: '2',
+          ],
+        }
+
+DpdApi::Tracing.create_label_file(params)
+
+```

data/Rakefile

@@ -1,2 +1,21 @@
+# encoding: UTF-8
+
 require "bundler/gem_tasks"
+require 'rubygems'
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec)
 
+task :default => [:spec]

data/lib/dpd_api/base.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+require "dpd_api/client/response"
+
 module DpdApi
   class Base
     class << self
@@ -8,28 +11,11 @@ module DpdApi
     protected
 
       def client
-        Savon.client(wsdl: self.url)
+        Client::Response.new(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
+      def response(method, params = {}, options = {})
+        client.response(method, params, options)
       end
     end
   end

data/lib/dpd_api/calculator.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module DpdApi
   class Calculator < Base
     class << self

data/lib/dpd_api/client/response.rb

@@ -0,0 +1,52 @@
+require "savon"
+
+module DpdApi
+  module Client
+    class Response
+      def initialize(url)
+        @url    = url
+        @client = Savon.client(wsdl: @url)
+      end
+
+      def response(method, params = {}, options = {})
+        builder = ResourceBuilder.new(@client, method, params, options)
+        builder.resources
+      rescue Savon::SOAPFault => error
+        { errors: error.to_s }
+      end
+
+      private
+
+      class ResourceBuilder
+        def initialize(client, method, params, options = {})
+          @client  = client
+          @method  = method
+          @namespace = options.delete(:namespace)
+          @merged_params = merge_auth_params(params)
+        end
+
+        def resources
+          namespace = "#{@method}_response".to_sym
+          resources = response.body[namespace][:return]
+          resources.is_a?(Array) ? resources : [] << resources
+        end
+
+        private
+
+        def merge_auth_params(params)
+          auth_params = DpdApi.configuration.auth_params.clone
+          auth_params.deep_merge!(params)
+        end
+
+        def response
+          @client.call(@method, message: request)
+        end
+
+        def request
+          namespace = @namespace || :request
+          @merged_params.blank? ? @merged_params : { namespace => @merged_params  }
+        end
+      end
+    end
+  end
+end

data/lib/dpd_api/configuration.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module DpdApi
   class << self
     attr_accessor :configuration

data/lib/dpd_api/geography.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module DpdApi
   class Geography < Base
     class << self

data/lib/dpd_api/label_print.rb

@@ -1,25 +1,14 @@
+# encoding: utf-8
+
 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)
+        response(:create_label_file, params, namespace: :get_label_file)
       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]
+        response(:create_label, params, namespace: :get_label)
       end
 
       protected

data/lib/dpd_api/nl.rb

@@ -1,25 +1,14 @@
+# encoding: utf-8
+
 module DpdApi
   class Nl < Base
-    # TODO: Implement namespace
     class << self
-      def get_nl_amount(params = {})
-        method = :get_nl_amount
-        namespace = :arg0
-        response(method, params, namespace: namespace)
-      end
-
-      def get_nl_invoice(params = {})
-        method = :get_nl_invoice
-        namespace = :arg0
-        response(method, params, namespace: namespace)
+      def nl_amount(params = {})
+        response(:get_nl_amount, params, namespace: :arg0)
       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]
+      def nl_invoice(params = {})
+        response(:get_nl_invoice, params, namespace: :arg0)
       end
 
       protected

data/lib/dpd_api/order.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module DpdApi
   class Order < Base
     class << self

data/lib/dpd_api/tracing.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module DpdApi
   class Tracing < Base
     class << self

data/lib/dpd_api/version.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module DpdApi
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/dpd_api.rb

@@ -1,6 +1,6 @@
-require "dpd_api/version"
+# encoding: utf-8
 
-require "savon"
+require "dpd_api/version"
 
 require 'dpd_api/configuration'
 require 'dpd_api/base'

data/spec/lib/dpd_api/calculator_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require "spec_helper"
 
 describe DpdApi::Calculator do

data/spec/lib/dpd_api/configuration_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'spec_helper'
 
 describe DpdApi do

data/spec/lib/dpd_api/geography_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require "spec_helper"
 
 describe DpdApi::Geography do

data/spec/lib/dpd_api/order_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require "spec_helper"
 
 describe DpdApi::Order do

data/spec/lib/dpd_api/tracing_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require "spec_helper"
 
 describe DpdApi::Order do

data/spec/spec_helper.rb

@@ -1,3 +1,8 @@
+# encoding: utf-8
+
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 require 'dpd_api'
 require "savon/mock/spec_helper"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dpd_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Ponomarev Nikolay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-11 00:00:00.000000000 Z
+date: 2014-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -83,6 +84,7 @@ files:
 - lib/dpd_api.rb
 - lib/dpd_api/base.rb
 - lib/dpd_api/calculator.rb
+- lib/dpd_api/client/response.rb
 - lib/dpd_api/configuration.rb
 - lib/dpd_api/geography.rb
 - lib/dpd_api/label_print.rb