russianpost 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3c78f24b94f6b559a0392383eb33071f10ad954
+  data.tar.gz: b8e33c4b2002fd880b387dbd9f7f2d89ca68d894
+SHA512:
+  metadata.gz: 6d72fb4308001eb0fedbccb05d6ef7d17785b7ea24cb5c4b3defeec541027391b58933aec3a91347462961a09e1c7435d87b6bba0b0c97907f93246499ba29db
+  data.tar.gz: de9013ea5ff2b270ad4fbf9b66b30c82feddec6d7d2c44558f7a906b45a8a52c307fd96e95befa7e3bc0f6b684f567824ab186a5a8a0fb0769464f5705939d8e

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Artem Shitov
+
+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,107 @@
+# Russian Post API Client
+
+Thin wrapper around Russian Post package tracking SOAP API. Works on a per-package basis (contrary to the bulk ticket-based API). Use it at your own risk, since the API may appear unstable and require authorization in future.
+
+## Usage
+
+Initialize a parcel object, passing the package barcode to the constructor:
+
+    parcel = RussianPost::Parcel.new("EC123456789RU")
+
+Fetch operation history for the parcel:
+
+    parcel.operations
+
+The `operations` method returns an `Array` of `Operation` structs.
+
+### Operations API
+
+Each `Operation` responds to the following methods. If there is no information, methods return `nil`. More thorough documentation coming soon.
+
+#### Address parameters
+
+    destination_address              #=> RussianPost::Address (Struct)
+    destination_address.index        #=> String
+    destination_address.description  #=> String
+
+    operation_address                #=> RussianPost::Address (Struct)
+    operation_address.index          #=> String
+    operation_address.description    #=> String
+
+    mail_direct                      #=> RussianPost::Country (Struct)
+    mail_direct.id                   #=> Fixnum
+    mail_direct.code_2a              #=> String
+    mail_direct.code_3a              #=> String
+    mail_direct.name_ru              #=> String
+    mail_direct.name_en              #=> String
+
+    country_from                     #=> RussianPost::Country (Struct)
+    country_from.id                  #=> Fixnum
+    country_from.code_2a             #=> String
+    country_from.code_3a             #=> String
+    country_from.name_ru             #=> String
+    country_from.name_en             #=> String
+    
+    country_oper                     #=> RussianPost::Country (Struct)
+    country_oper.id                  #=> Fixnum
+    country_oper.code_2a             #=> String
+    country_oper.code_3a             #=> String
+    country_oper.name_ru             #=> String
+    country_oper.name_en             #=> String
+    
+#### Finance parameters          
+    
+    payment                          #=> Fixnum
+    value                            #=> Fixnum
+    mass_rate                        #=> Fixnum
+    insr_rate                        #=> Fixnum
+    air_rate                         #=> Fixnum
+    rate                             #=> Fixnum
+    
+#### Item parameters          
+
+    barcode                          #=> String
+    internum                         #=> String
+    valid_ru_type                    #=> Boolean
+    valid_en_type                    #=> Boolean
+    complex_item_name                #=> String
+    
+    mail_rank                        #=> RussianPost::GenericOperationParameter (Struct)
+    mail_rank.id                     #=> Fixnum
+    mail_rank.name                   #=> String
+
+    post_mark                        #=> RussianPost::GenericOperationParameter (Struct)
+    mail_rank.id                     #=> Fixnum
+    mail_rank.name                   #=> String
+    
+    mail_type                        #=> RussianPost::GenericOperationParameter (Struct)
+    mail_type.id                     #=> Fixnum
+    mail_type.name                   #=> String
+    
+    mail_ctg                         #=> RussianPost::GenericOperationParameter (Struct)
+    mail_ctg.id                      #=> Fixnum
+    mail_ctg.name                    #=> String
+    
+    mass                             #=> Fixnum
+    max_mass_ru                      #=> Fixnum
+    max_mass_en                      #=> Fixnum
+
+#### Operation parameters          
+
+    oper_type                        #=> RussianPost::GenericOperationParameter (Struct)
+    oper_type.id                     #=> Fixnum
+    oper_type.name                   #=> String
+
+    oper_attr                        #=> RussianPost::GenericOperationParameter (Struct)
+    oper_attr.id                     #=> Fixnum
+    oper_attr.name                   #=> String
+
+    oper_date                        #=> DateTime
+
+#### User parameters          
+    send_ctg                         #=> RussianPost::GenericOperationParameter (Struct)
+    send_ctg.id                      #=> Fixnum
+    send_ctg.name                    #=> String
+
+    sndr                             #=> String
+    rcpn                             #=> String

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task default: :test
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['spec/*_spec.rb']
+end

data/lib/russianpost.rb

@@ -0,0 +1,5 @@
+require "russianpost/version"
+require "russianpost/parcel"
+
+module Russianpost
+end

data/lib/russianpost/client.rb

@@ -0,0 +1,20 @@
+require "savon"
+
+module RussianPost
+  class Client
+    attr_reader :savon, :endpoint, :namespace
+    
+    def initialize
+      @endpoint  = "http://voh.russianpost.ru:8080/niips-operationhistory-web/OperationHistory"
+      @namespace = "http://russianpost.org/operationhistory/data"
+      @savon     = Savon.client(endpoint: endpoint, namespace: namespace)
+    end
+
+    def call(barcode: nil)
+      message = { "wsdl:Barcode" => barcode, "wsdl:MessageType" => "0" }
+      response = savon.call("OperationHistoryRequest", message: message)
+
+      response.to_hash[:operation_history_data][:history_record]
+    end
+  end
+end

data/lib/russianpost/operation.rb

@@ -0,0 +1,56 @@
+module RussianPost
+  Operation = Struct.new(
+    # address parameters
+    :destination_address,   # Address
+    :operation_address,     # Address
+    :mail_direct,           # Country
+    :country_from,          # Country
+    :country_oper,          # Country
+
+    # finance parameters
+    :payment,               # Fixnum
+    :value,                 # Fixnum
+    :mass_rate,             # Fixnum
+    :insr_rate,             # Fixnum
+    :air_rate,              # Fixnum
+    :rate,                  # Fixnum
+
+    # item parameters
+    :barcode,               # String
+    :internum,              # String
+    :valid_ru_type,         # Boolean
+    :valid_en_type,         # Boolean
+    :complex_item_name,     # String
+    :mail_rank,             # GenericOperationParameter
+    :post_mark,             # GenericOperationParameter
+    :mail_type,             # GenericOperationParameter
+    :mail_ctg,              # GenericOperationParameter
+    :mass,                  # Fixnum
+    :max_mass_ru,           # Fixnum
+    :max_mass_en,           # Fixnum
+
+    # operation parameters
+    :oper_type,             # GenericOperationParameter
+    :oper_attr,             # GenericOperationParameter
+    :oper_date,             # DateTime
+
+    # user parameters
+    :send_ctg,              # GenericOperationParameter
+    :sndr,                  # String
+    :rcpn)                  # String
+
+  Country = Struct.new(
+    :id,                    # Fixnum
+    :code_2a,               # String
+    :code_3a,               # String
+    :name_ru,               # String
+    :name_en)               # String
+
+  GenericOperationParameter = Struct.new(
+    :id,                    # Fixnum
+    :name)                  # String
+
+  Address = Struct.new(
+    :index,                 # String
+    :description)           # String
+end

data/lib/russianpost/operations_factory.rb

@@ -0,0 +1,71 @@
+require "russianpost/operation"
+
+module RussianPost
+  module OperationsFactory
+    class << self
+      def build(operations_hash)
+        operations_hash.map { |o| build_operation(o) }
+      end
+
+      def build_operation(operation_hash)
+        operation = RussianPost::Operation.new
+        ungroup_parameters(operation_hash).each do |key, value|
+          operation[key] = process_param(key, value)
+        end
+
+        operation
+      end
+
+
+      private
+
+      # Initially all parameters are grouped (address parameters, finance
+      # parameters, etc.). This method flattens the structure a bit      
+      def ungroup_parameters(operation_hash)
+        operation_hash.values.compact.reduce(Hash.new){ |acc, el| acc.merge(el) }
+      end
+
+      # Methods below convert certain parameters into proper data structures
+      def process_param(key, value)
+        process_fixnum(key, value) ||
+        process_address(key, value) ||
+        process_country(key, value) ||
+        process_generic_param(key, value) ||
+        value
+      end
+
+      def process_fixnum(key, value)
+        if %i(payment value mass_rate insr_rate air_rate rate mass max_mass_ru max_mass_en).include? key
+          value.to_i
+        end
+      end
+
+      def process_address(key, value)
+        if %i(destination_address operation_address).include? key
+          RussianPost::Address.new(
+            value[:index],
+            value[:description])
+        end
+      end
+
+      def process_country(key, value)
+        if %i(mail_direct country_from country_oper).include? key
+          RussianPost::Country.new(
+            value[:id] ? value[:id].to_i : nil,
+            value[:code_2a],
+            value[:code_3a],
+            value[:name_ru],
+            value[:name_en])
+        end
+      end
+
+      def process_generic_param(key, value)
+        if value.kind_of? Hash
+          RussianPost::GenericOperationParameter.new(
+            value[:id] ? value[:id].to_i : nil,
+            value[:name])
+        end
+      end
+    end
+  end
+end

data/lib/russianpost/parcel.rb

@@ -0,0 +1,23 @@
+require "russianpost/client"
+require "russianpost/operations_factory"
+
+module RussianPost
+  class Parcel
+    attr_reader :barcode, :client
+
+    def initialize(barcode, client: Client)
+      @barcode = barcode
+      @client  = client.new
+    end
+
+    def operations
+      @operations ||= fetch_operations
+    end
+
+    private
+
+    def fetch_operations
+      OperationsFactory.build(client.call(barcode: barcode))
+    end
+  end
+end

data/lib/russianpost/version.rb

@@ -0,0 +1,3 @@
+module Russianpost
+  VERSION = "0.1.0"
+end

data/russianpost.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'russianpost/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "russianpost"
+  spec.version       = Russianpost::VERSION
+  spec.authors       = ["Artem Shitov"]
+  spec.email         = ["inbox@artemshitov.ru"]
+  spec.description   = %q{Thin wrapper around Russian Post package tracking SOAP API. Works on a per-package basis (contrary to the bulk ticket-based API). Use it at your own risk, since the API may appear unstable and require authorization in future.}
+  spec.summary       = %q{Russian Post package tracking API client}
+  spec.homepage      = "https://github.com/artemshitov/russianpost"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "savon"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: russianpost
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Artem Shitov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Thin wrapper around Russian Post package tracking SOAP API. Works on
+  a per-package basis (contrary to the bulk ticket-based API). Use it at your own
+  risk, since the API may appear unstable and require authorization in future.
+email:
+- inbox@artemshitov.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/russianpost.rb
+- lib/russianpost/client.rb
+- lib/russianpost/operation.rb
+- lib/russianpost/operations_factory.rb
+- lib/russianpost/parcel.rb
+- lib/russianpost/version.rb
+- russianpost.gemspec
+homepage: https://github.com/artemshitov/russianpost
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Russian Post package tracking API client
+test_files: []