russianpost 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90c9d9530331f51349587f14084ab6b1c28aa140
-  data.tar.gz: 674b6c39bcd65a111a059e02f1a722bd7260d897
+  metadata.gz: f25804582583d50312fcdabb61739ab523bb1a60
+  data.tar.gz: d884f42475e9c64231dc79608027d8378c71a3ec
 SHA512:
-  metadata.gz: 970d71fef77c20e95749f1edd22e6b583d2beaa6708f868320500c918d7f915d47da8bb580d5aacb03e78ea22a781de3a78b9aa43e52b049d26c7b89b5389ece
-  data.tar.gz: 966878c1fd633dece8e1edf8287c1a3fc5cefb6757d4fa6cafceafddbf58e6f369927011d830e1ea519eff6a72934bfa4636b5a53e7ba9794a854ce541b29761
+  metadata.gz: 423ce97c42a91b2f8f964d80457e98b1bd8287ea6af8c8f6aadcb962ca1e9cce25ac995dd270b0253dfc69f00995fe044369145222d4a265002e89c121f9912d
+  data.tar.gz: b8c07fa4a085b8fe7b0bb1e89ad38ba3a1ebe67045f9bae77298f68468791ca37940d7829892c7029c4dd22ed97092da342932a7b50a549cba15b45704587cfd

data/README.md

@@ -1,6 +1,6 @@
 # Russian Post API Client
 
-[![Build Status](https://travis-ci.org/artemshitov/russianpost.png?branch=master)](https://travis-ci.org/artemshitov/russianpost)
+[![Build Status](https://travis-ci.org/artemshitov/russianpost.png?branch=master)](https://travis-ci.org/artemshitov/russianpost) [![Code Climate](https://codeclimate.com/github/artemshitov/russianpost.png)](https://codeclimate.com/github/artemshitov/russianpost)
 
 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.
 
@@ -12,7 +12,7 @@ To install gem stand-alone:
 
 To use gem in a Rails app, add the following to your `Gemfile`:
 
-    gem "russianpost", "~> 0.3.0"
+    gem "russianpost", "~> 0.3.1"
 
 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, make sure you add [Curb](https://github.com/taf2/curb) to your `Gemfile`:
 

data/lib/russianpost/barcode.rb

@@ -0,0 +1,32 @@
+require "russianpost/barcode_validator"
+
+module RussianPost
+  class Barcode
+    extend Forwardable
+
+    def_delegator :barcode, :=~
+
+    attr_reader :barcode
+
+    def initialize(barcode)
+      @barcode = barcode.strip.upcase
+      raise InvalidBarcode unless valid?
+    end
+
+    def to_s
+      barcode
+    end
+
+    def digits
+      barcode[/\d+/].split("").map { |d| d.to_i }
+    end
+
+    private
+
+    def valid?
+      BarcodeValidator.validate(self)
+    end
+  end
+
+  class InvalidBarcode < ArgumentError; end
+end

data/lib/russianpost/barcode_validator.rb

@@ -0,0 +1,46 @@
+module RussianPost
+  class BarcodeValidator
+    attr_reader :barcode, :digits
+
+    INTERNATIONAL_FORMAT = /\A([A-Z]{2}\d{9}[A-Z]{2})\Z/
+    DOMESTIC_FORMAT      = /\A(\d{14})\Z/
+    WEIGHT_FACTORS       = [8, 6, 4, 2, 3, 5, 9, 7, 0]
+
+    def self.validate(barcode)
+      new(barcode).valid?
+    end
+
+    def initialize(barcode)
+      @barcode = barcode
+      @digits  = barcode.digits
+    end
+
+    def valid?
+      valid_international? || valid_domestic?
+    end
+
+
+    private
+
+    def valid_international?
+      barcode =~ INTERNATIONAL_FORMAT && digits.last == checkdigit
+    end
+
+    def valid_domestic?
+      barcode =~ DOMESTIC_FORMAT
+    end
+
+    def checkdigit
+      if (1..9).include? checksum
+        checksum
+      else 
+        checksum == 10 ? 0 : 5
+      end
+    end
+    
+    def checksum
+      product = digits.zip(WEIGHT_FACTORS)
+      (11 - product.map{|i| i.reduce(:*)}.reduce(:+)) % 11
+    end
+  end
+end

data/lib/russianpost/client.rb

@@ -3,11 +3,16 @@ require "savon"
 module RussianPost
   class Client
     attr_reader :savon, :endpoint, :namespace
+
+    ENDPOINT  = "http://voh.russianpost.ru:8080/niips-operationhistory-web/OperationHistory"
+    NAMESPACE = "http://russianpost.org/operationhistory/data"
     
-    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, log: false)
+    def initialize(opts = {})
+      @savon = Savon.client(
+        endpoint:     ENDPOINT,
+        namespace:    NAMESPACE,
+        open_timeout: opts[:timeout] || 10, # in seconds
+        log:          false)
     end
 
     def call(opts = {barcode: nil})

data/lib/russianpost/parcel.rb

@@ -1,15 +1,14 @@
 require "russianpost/client"
 require "russianpost/operations_factory"
+require "russianpost/barcode"
 
 module RussianPost
   class Parcel
     attr_reader :barcode, :client
 
     def initialize(barcode, opts = {})
-      @barcode = barcode.upcase
+      @barcode = Barcode.new(barcode)
       @client  = (opts[:client] || Client).new
-
-      raise InvalidBarcode unless barcode_is_valid?
     end
 
     def operations
@@ -21,11 +20,5 @@ module RussianPost
     def fetch_operations
       OperationsFactory.build(client.call(barcode: barcode))
     end
-
-    def barcode_is_valid?
-      barcode =~ /\A([A-Z]{2}\d{9}[A-Z]{2})|(\d{14})\z/
-    end
   end
-
-  class InvalidBarcode < ArgumentError; end
 end

data/lib/russianpost/version.rb

@@ -1,3 +1,3 @@
 module Russianpost
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/test/russianpost/barcode_test.rb

@@ -0,0 +1,23 @@
+require "test_helper"
+require "russianpost/barcode"
+
+class BarcodeTest < MiniTest::Unit::TestCase
+  def test_implicitly_converts_to_string
+    barcode = RussianPost::Barcode.new("RD025500807SE")
+    assert_equal "bar RD025500807SE", "bar #{barcode}"
+  end
+
+  def test_raises_on_invalid_barcode
+    ["123", "RR123456789EE"].each do |barcode|
+      assert_raises RussianPost::InvalidBarcode do
+        RussianPost::Barcode.new(barcode)
+      end
+    end
+  end
+
+  def test_doesnt_raise_on_valid_barcode
+    ["RD025500807SE", "12345678901234"].each do |barcode|
+        RussianPost::Barcode.new(barcode)
+    end
+  end
+end

data/test/russianpost/parcel_test.rb

@@ -12,7 +12,7 @@ class ParcelTest < MiniTest::Unit::TestCase
 
   def test_returns_empty_array_on_nonexistent_parcel
     VCR.use_cassette("nonexistent_parcel") do
-      parcel = RussianPost::Parcel.new("RR123456789EE")
+      parcel = RussianPost::Parcel.new("RR123456785EE")
       assert_kind_of Array, parcel.operations
       assert parcel.operations.empty?
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: russianpost
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Artem Shitov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-21 00:00:00.000000000 Z
+date: 2013-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,6 +96,8 @@ files:
 - README.md
 - Rakefile
 - lib/russianpost.rb
+- lib/russianpost/barcode.rb
+- lib/russianpost/barcode_validator.rb
 - lib/russianpost/client.rb
 - lib/russianpost/operation.rb
 - lib/russianpost/operations_factory.rb
@@ -104,6 +106,7 @@ files:
 - russianpost.gemspec
 - test/fixtures/vcr_cassettes/nonexistent_parcel.yml
 - test/fixtures/vcr_cassettes/valid_barcode.yml
+- test/russianpost/barcode_test.rb
 - test/russianpost/client_test.rb
 - test/russianpost/parcel_test.rb
 - test/test_helper.rb
@@ -134,6 +137,7 @@ summary: Russian Post package tracking API client
 test_files:
 - test/fixtures/vcr_cassettes/nonexistent_parcel.yml
 - test/fixtures/vcr_cassettes/valid_barcode.yml
+- test/russianpost/barcode_test.rb
 - test/russianpost/client_test.rb
 - test/russianpost/parcel_test.rb
 - test/test_helper.rb