russianpost 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47bbb1af0b21cfb7f4fb2caa809e2cf4f999deb8
-  data.tar.gz: 9d959970148f6bb4ddb7dc438433f0f2cb7fa580
+  metadata.gz: 5a33521adb8e7e20a979b5f101b9d47c87fa0e95
+  data.tar.gz: 71563d96c3fa637fd2c7dbbaca8f7e98f718ff1b
 SHA512:
-  metadata.gz: a4132cfbcb85e7d41cf74653cc0f70681e723432264508d2ebfe54a0bcbaa30a4761849dca92166d5b5b65df8fa09e2d7a291b71e0e841c1d1be7f06c41b70e8
-  data.tar.gz: 9bf5df8b9ad495761182fcee06d3ebdd3e9d0d80bbea77b4e195c0d97b5dba85a7a63fc48622536cac1295355c30cfdb99674ed4abecd191d93cbfde465a6eef
+  metadata.gz: 751bd6b261ef027001fbc32546b717ce23f767fd58b8b852abcf385b414410e8b252bb8abdf10a8d978df03aea762c17755e46d08cbbafee974a500c66eb91b4
+  data.tar.gz: 78b55dbd115fefc61be53b0c9a7a8ac98f19cbaf23648f9c714366d3b6539ddd978d021dd4b93bb3e0ec73c4906698945026c34e3b75fb290fbc3ed28509b995

data/README.md

@@ -14,20 +14,20 @@ To install gem stand-alone:
 
 To use gem in a Rails app, add the following to your `Gemfile`:
 
-    gem "russianpost", "~> 0.6.0"
+    gem 'russianpost', '~> 0.7.0'
 
 This gem uses [Savon](http://savonrb.com/), which in turn uses [HTTPI](https://github.com/savonrb/httpi) internally. HTTPI chooses the best HTTP library of those you have installed. For the fastest results add [Curb](https://github.com/taf2/curb) to your `Gemfile`:
 
-    gem "curb"
-    gem "russianpost"
+    gem 'curb'
+    gem 'russianpost'
 
-If you use RussianPost outside Rails, `require "curb"` before requiring RussianPost.
+If you use RussianPost outside Rails, `require 'curb'` before requiring RussianPost.
 
 ## Usage
 
 Initialize a parcel object, passing the package barcode to the constructor:
 
-    parcel = RussianPost::Parcel.new("EC123456789RU")
+    parcel = RussianPost::Parcel.new('EC123456789RU')
 
 Fetch operation history for the parcel:
 
@@ -54,6 +54,16 @@ RussianPost makes guesses about current state of the parcel.
     # Type
     parcel.type
 
+### Barcode validator
+
+You can use the included barcode validator separately. It not only validates the format of a barcode, but also calculates check digits and tests barcodes against them.
+
+    barcode = RussianPost::Barcode.new('EC123456789RU')
+    barcode.valid? #=> false
+
+    barcode = RussianPost::Barcode.new('RD025500807SE')
+    barcode.valid? #=> true
+
 ### Operations API
 
 Each `Operation` responds to the following methods. If there is no information, methods return `nil`. See the [wiki](https://github.com/artemshitov/russianpost/wiki) for a list of what else can be returned.

data/Rakefile

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

data/lib/russianpost.rb

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

data/lib/russianpost/barcode/base.rb

@@ -1,4 +1,4 @@
-require "forwardable"
+require 'forwardable'
 
 module RussianPost
   module Barcode
@@ -19,7 +19,7 @@ module RussianPost
       end
 
       def valid?
-        barcode =~ self.class.format && digits.last == checkdigit
+        (barcode =~ self.class.format || false) && digits.last == checkdigit
       end
 
       def to_s

data/lib/russianpost/barcode/international.rb

@@ -1,4 +1,5 @@
 require 'russianpost/barcode/base'
+require 'iso3166_ru'
 
 module RussianPost
   module Barcode
@@ -9,8 +10,16 @@ module RussianPost
         /\A([A-Z]{2}\d{9}[A-Z]{2})\Z/
       end
 
+      def valid?
+        super && country_exists?
+      end
+
       private
 
+      def country_exists?
+        !Iso3166Ru.find_by(alpha2: barcode[-2..-1]).nil?
+      end
+
       def checkdigit
         checksum < 11 ? checksum % 10 : 5
       end

data/lib/russianpost/client.rb

@@ -1,11 +1,14 @@
-require "savon"
+require 'savon'
+require 'singleton'
 
 module RussianPost
   class Client
+    include Singleton
+    
     attr_reader :savon, :endpoint, :namespace
 
-    ENDPOINT  = "http://voh.russianpost.ru:8080/niips-operationhistory-web/OperationHistory"
-    NAMESPACE = "http://russianpost.org/operationhistory/data"
+    ENDPOINT  = 'http://voh.russianpost.ru:8080/niips-operationhistory-web/OperationHistory'
+    NAMESPACE = 'http://russianpost.org/operationhistory/data'
     
     def initialize(opts = {})
       @savon = Savon.client(
@@ -16,8 +19,8 @@ module RussianPost
     end
 
     def call(opts = {barcode: nil})
-      message = { "wsdl:Barcode" => opts[:barcode], "wsdl:MessageType" => "0" }
-      response = savon.call("OperationHistoryRequest", message: message)
+      message = { 'wsdl:Barcode' => opts[:barcode], 'wsdl:MessageType' => '0' }
+      response = savon.call('OperationHistoryRequest', message: message)
       result = response.to_hash[:operation_history_data][:history_record]
 
       result.kind_of?(Array) ? result : [result].compact

data/lib/russianpost/country_factory.rb

@@ -1,10 +1,10 @@
-require "iso3166_ru"
-require "russianpost/operation"
+require 'iso3166_ru'
+require 'russianpost/operation'
 
 module RussianPost
   module CountryFactory
     def self.build(country_config, opts = {})
-      country_list = opts[:country_list] || Iso3166Ru::CountryList.new
+      country_list = opts[:country_list] || Iso3166Ru
       proxy        = country_list.find_by(iso: country_config[:id])
       
       RussianPost::Country.new(

data/lib/russianpost/operations_factory.rb

@@ -1,12 +1,12 @@
-require "iso3166_ru"
-require "russianpost/operation"
-require "russianpost/country_factory"
+require 'iso3166_ru'
+require 'russianpost/operation'
+require 'russianpost/country_factory'
 
 module RussianPost
   module OperationsFactory
     class << self
       def build(operations_hash)
-        @country_list = Iso3166Ru::CountryList.new
+        @country_list = Iso3166Ru
         operations_hash.map { |o| build_operation(o) }
       end
 

data/lib/russianpost/parcel.rb

@@ -1,6 +1,6 @@
-require "russianpost/client"
-require "russianpost/operations_factory"
-require "russianpost/barcode"
+require 'russianpost/client'
+require 'russianpost/operations_factory'
+require 'russianpost/barcode'
 
 module RussianPost
   class Parcel
@@ -8,7 +8,7 @@ module RussianPost
 
     def initialize(barcode, opts = {})
       @barcode = Barcode.new(barcode)
-      @client  = (opts[:client] || Client).new
+      @client  = (opts[:client] || Client).instance
     end
 
     def operations

data/lib/russianpost/version.rb

@@ -1,3 +1,3 @@
 module Russianpost
-  VERSION = "0.6.0"
+  VERSION = '0.7.0'
 end

data/russianpost.gemspec

@@ -4,25 +4,25 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'russianpost/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "russianpost"
+  spec.name          = 'russianpost'
   spec.version       = Russianpost::VERSION
-  spec.authors       = ["Artem Shitov"]
-  spec.email         = ["inbox@artemshitov.ru"]
+  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.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.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "webmock"
-  spec.add_development_dependency "vcr", "~> 2.4.0"
-  spec.add_development_dependency "minitest", "~> 5.0.0"
-  spec.add_dependency "savon", "~> 2.1.0"
-  spec.add_dependency "iso3166_ru", "~>0.1.2"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'vcr', '~> 2.4.0'
+  spec.add_development_dependency 'minitest', '~> 5.0.0'
+  spec.add_dependency 'savon', '~> 2.1.0'
+  spec.add_dependency 'iso3166_ru', '~> 0.2.0'
 end

data/test/russianpost/barcode_test.rb

@@ -1,19 +1,19 @@
-require "test_helper"
-require "russianpost/barcode"
+require 'test_helper'
+require 'russianpost/barcode'
 
 module RussianPost
   class BarcodeTest < Minitest::Test
     def test_implicitly_converts_to_string
-      barcode = Barcode.new("RD025500807SE")
-      assert_equal "bar RD025500807SE", "bar #{barcode}"
+      barcode = Barcode.new('RD025500807SE')
+      assert_equal 'bar RD025500807SE', "bar #{barcode}"
     end
 
     def test_validates_barcode
-      ["123", "RR123456789EE"].each do |barcode|
+      ['123', 'RR123456789EE', 'RD025500807SP'].each do |barcode|
         refute Barcode.new(barcode).valid?
       end
 
-      ["RD025500807SE", "62009147017544"].each do |barcode|
+      ['RD025500807SE', '62009147017544'].each do |barcode|
         assert Barcode.new(barcode).valid?
       end
     end

data/test/russianpost/client_test.rb

@@ -1,13 +1,13 @@
-require "test_helper"
-require "russianpost/client"
+require 'test_helper'
+require 'russianpost/client'
 
 class TestClient < Minitest::Test
   def setup
-    @client = RussianPost::Client.new
+    @client = RussianPost::Client.instance
   end
 
   def test_returns_array_of_hashes_on_existing_parcel
-    ["RD025500807SE", "LK035658376US"].each do |code|
+    ['RD025500807SE', 'LK035658376US'].each do |code|
       VCR.use_cassette(code) do
         response = @client.call(barcode: code)
         assert_kind_of Array, response
@@ -17,8 +17,8 @@ class TestClient < Minitest::Test
   end
 
   def test_returns_empty_array_on_nonexistent_parcel
-    VCR.use_cassette("RR123456789EE") do
-      response = @client.call(barcode: "RR123456789EE")
+    VCR.use_cassette('RR123456789EE') do
+      response = @client.call(barcode: 'RR123456789EE')
       assert_kind_of Array, response
       assert_empty response
     end

data/test/russianpost/parcel_test.rb

@@ -1,21 +1,21 @@
 # encoding: utf-8
 
-require "test_helper"
-require "russianpost/parcel"
+require 'test_helper'
+require 'russianpost/parcel'
 
 module RussianPost
   class ParcelTest < Minitest::Test
     def test_returns_array_of_operations
-      VCR.use_cassette("RD025500807SE") do
-        parcel = Parcel.new("RD025500807SE")
+      VCR.use_cassette('RD025500807SE') do
+        parcel = Parcel.new('RD025500807SE')
         assert_kind_of Array, parcel.operations
         assert_kind_of Operation, parcel.operations[0]
       end
     end
 
     def test_returns_empty_array_on_nonexistent_parcel
-      VCR.use_cassette("RR123456785EE") do
-        parcel = Parcel.new("RR123456785EE")
+      VCR.use_cassette('RR123456785EE') do
+        parcel = Parcel.new('RR123456785EE')
         assert_kind_of Array, parcel.operations
         assert parcel.operations.empty?
       end
@@ -23,7 +23,7 @@ module RussianPost
 
     def test_raises_error_on_invalid_barcode
       assert_raises InvalidBarcode do
-        Parcel.new("123").operations
+        Parcel.new('123').operations
       end
     end
   end
@@ -32,14 +32,14 @@ module RussianPost
     attr_reader :parcel
 
     def setup
-      VCR.use_cassette("RD025500807SE") do
-        @parcel = Parcel.new("RD025500807SE")
+      VCR.use_cassette('RD025500807SE') do
+        @parcel = Parcel.new('RD025500807SE')
         parcel.operations
       end
     end  
 
     def test_knows_current_location
-      location = Address.new("127576", "Москва 576")
+      location = Address.new('127576', 'Москва 576')
       assert_equal location, parcel.location
     end
 
@@ -48,22 +48,22 @@ module RussianPost
     end
 
     def test_knows_type
-      type = GenericOperationParameter.new(5, "Мелкий пакет")
+      type = GenericOperationParameter.new(5, 'Мелкий пакет')
       assert_equal type, parcel.type
     end
 
     def test_knows_rank
-      rank = GenericOperationParameter.new(0, "Без разряда")
+      rank = GenericOperationParameter.new(0, 'Без разряда')
       assert_equal rank, parcel.rank
     end
 
     def test_knows_recipient
-      assert_equal "ЕЛЕНА", parcel.recipient
+      assert_equal 'ЕЛЕНА', parcel.recipient
     end
 
     def test_meta_methods_dont_fail_when_no_operations
-      VCR.use_cassette("RR123456785EE") do
-        parcel = Parcel.new("RR123456785EE")
+      VCR.use_cassette('RR123456785EE') do
+        parcel = Parcel.new('RR123456785EE')
         [:location, :mass, :type, :rank, :recipient].each do |m|
           assert_nil parcel.send(m)
         end

data/test/test_helper.rb

@@ -1,5 +1,5 @@
-require "minitest/autorun"
-require "vcr"
+require 'minitest/autorun'
+require 'vcr'
 
 VCR.configure do |c|
   c.cassette_library_dir = 'test/fixtures/vcr_cassettes'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: russianpost
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Artem Shitov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-30 00:00:00.000000000 Z
+date: 2013-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.2.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.