vat_payer_cz 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed8bef1efb56884b487e065a94a10dcedbf2925f
-  data.tar.gz: 39a9d18232a6dbdc1f1ccd24871ffb47ac74b36a
+  metadata.gz: 807e334a32d9d296115c356a28f12aa21aec3397
+  data.tar.gz: f5420d9d49965329a2a97941de66d19f01ac85e8
 SHA512:
-  metadata.gz: aca716327fe729a78d29e5c535b99a0eaaaa2f491204294e58f77ccaee4af95d3c26c366a4ec0323a430f97ea684bef72d02e82c83e8ec3e0bd7631711cec0e9
-  data.tar.gz: e21edc47d2841f1f598be25c7b7a885b2a03fcb3208b762052788c5d5d096ab7c5bf5df5d1e12aa60e063b94fe97041d48157908e9c2394b721c86eda140bfe4
+  metadata.gz: a9407c571506ee198838e31d539dda02d2cb5139efccb54670040021ac4764f4bacb8ba25b151c9632f1c737bae6e4aff18bb383716b3f9af1aa68f2926d2aca
+  data.tar.gz: 7730a090a5cc510c1de40ea11eecc719ff19b4a16a80433b45e9b286b3d124060afc5ccbe7bdc32fdb6c6bcdc0ab16b25472e6b4dafad870cad6b9ec6e9dfb98

data/Gemfile

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

data/README.md

@@ -6,18 +6,33 @@ This is Ruby wrapper for [web service for "searching information about reliabili
 
 ## Usage
 The web service has the following three end-points:
-- standard VAT payer info
-- extended VAT payer info
-- list of unreliable VAT payers
+- [standard VAT payer info](#standard)
+- [extended VAT payer info](#extended)
+- list of unreliable VAT payers (not implemented)
 
-This gem currently implements 'standard VAT payer info'.
+This gem currently implements **standard VAT payer info** and **extended VAT payer info**.
 
-# Standard VAT payer info
+## <a name="standard">Standard VAT payer info</a>
 ```ruby
+require 'vat_info'
+
 vat_ids = %w(CZ27169278 CZ26168685)
 VatInfo.unreliable_payer(*vat_ids)
 ```
-You should see something like this:
+## <a name="extended">Extended VAT payer info</a>
+Compared to Standard VAT payer info, the response is enriched by other VAT payer data, such as name and address.
+The library normalizes some of the VAT payer attributes which are supplied in capitals (company name and address attributes).
+```ruby
+require 'vat_info'
+
+vat_ids = %w(CZ27169278 CZ26168685)
+VatInfo.unreliable_payer_extended(*vat_ids)
+```
+
+## Response
+Object `VatInfo::Response`
+
+#### Example
 ```shell
 => #<VatInfo::Response:0x0000000001ff61e8
  @body=
@@ -33,24 +48,26 @@ You should see something like this:
         {:predcisli=>nil, :cislo=>"2400915487", :kod_banky=>"2010", :iban=>nil, :datum_zverejneni=>"2016-05-05"}]},
 ...
 ```
-## Response
-Object `VatInfo::Response`
-### status_code
+### .status_code
 `VatInfo::Response.status_code => String`
 200 - OK: Valid response was received.
 408 - Request Timeout: the web service timed out.
 503 - Service Unavailable: there was another error fetching the response.
 
-### body
+### .body
 Empty attributes have `nil` value.
 
 `VatInfo::Response.body => Hash`
 ```ruby
 {
   status: { Status }
-  platci: [ { Payer }, .. ]
+  platci: [ { Payer | PayerExtended }, .. ]
 }
 ```
+
+### .raw
+Raw data returned by the web service.
+
 #### Status
 See official docs for explanation.
 ```ruby
@@ -70,6 +87,24 @@ See official docs for explanation.
   ucty: [ { Account }, .. ]
 }
 ```
+#### PayerExtended
+```ruby
+{
+  nespolehlivy_platce: String, # "ANO" | "NE" | "NENALEZEN"
+  datum_zverejneni: String, # ISO 8601 Date
+  dic: String,
+  cislo_fu: String,
+  ucty: [ { Account }, .. ]
+  
+  #Extended info
+  nazev_subjektu: String,
+  ulice_cislo: String,
+  cast_obce: String,
+  mesto: String,
+  psc: String,
+  stat: String
+}
+```
 #### Account
 ```ruby
 {

data/lib/vat_info/models/vat_payer_extended.rb

@@ -0,0 +1,26 @@
+module VatInfo
+  module Models
+    class VatPayerExtended < VatPayer
+      def initialize(params)
+        super(params)
+
+        @data[:nazev_subjektu]      = normalize(params[:nazev_subjektu])
+
+        address                     = params.fetch(:adresa, {})
+        @data[:ulice_cislo]         = normalize(address[:ulice_cislo])
+        @data[:cast_obce]           = normalize(address[:cast_obce])
+        @data[:mesto]               = normalize(address[:mesto])
+        @data[:psc]                 = normalize(address[:psc])
+        @data[:stat]                = address[:stat]
+      rescue KeyError => e
+        raise InvalidStructure, "Response XML is missing required attributes.\n" \
+                                "Input params were: #{params}\n" \
+                                "Rescued error: #{e}"
+      end
+
+      def normalize(string)
+        VatInfo::Utils.normalize(string)
+      end
+    end
+  end
+end

data/lib/vat_info/models/vat_payers.rb

@@ -3,13 +3,13 @@ module VatInfo
     class VatPayers
       attr_accessor :data
 
-      def initialize(params = {})
+      def initialize(model, params = {})
         @data          = {}
-        @data[:platci] = create_vat_payers(params)
+        @data[:platci] = create_vat_payers(model, params)
       end
 
-      def create_vat_payers(payers)
-        payers.map { |payer| VatInfo::Models::VatPayer.new(payer).data }
+      def create_vat_payers(model, payers)
+        payers.map { |payer| model.new(payer).data }
       end
     end
   end

data/lib/vat_info/models.rb

@@ -1,6 +1,7 @@
 require 'vat_info/models/status'
 require 'vat_info/models/vat_payers'
 require 'vat_info/models/vat_payer'
+require 'vat_info/models/vat_payer_extended'
 
 module VatInfo
   module Models

data/lib/vat_info/request/unreliable_payer_extended.rb

@@ -0,0 +1,19 @@
+module VatInfo
+  class Request
+    class UnreliablePayerExtended < VatInfo::Request
+      attr_accessor :vat_ids
+
+      def initialize(*vat_ids)
+        self.vat_ids = vat_ids
+      end
+
+      def body
+        Nokogiri::XML::Builder.new('encoding' => 'UTF-8') do |xml|
+          xml.StatusNespolehlivyPlatceRozsirenyRequest(xmlns: 'http://adis.mfcr.cz/rozhraniCRPDPH/') do
+            vat_ids.each { |vat_id| xml.dic(vat_id) }
+          end
+        end.doc
+      end
+    end
+  end
+end

data/lib/vat_info/request.rb

@@ -1,5 +1,6 @@
 require 'nokogiri'
 require 'vat_info/request/unreliable_payer'
+require 'vat_info/request/unreliable_payer_extended'
 
 module VatInfo
   class Request

data/lib/vat_info/utils.rb

@@ -1,7 +1,38 @@
 module VatInfo
   module Utils
+    COMPANY_TYPES = ['a.s.', 's.r.o.', 'v.o.s.', 'k.s.', 'z.s.'].freeze
+    SPECIAL_CHARS = [
+      %w(Á á), %w(Č č), %w(Ď ď), %w(É é), %w(Ě ě), %w(Í í), %w(Ň ń), %w(Ó ó),
+      %w(Ř ř), %w(Š š), %w(Ť ť), %w(Ú ú), %w(Ů ů), %w(Ž ž), %w(Ý ý)
+    ].freeze
+
     def self.wrap_in_array(content)
       content.is_a?(Array) ? content : [content]
     end
+
+    def self.normalize(string)
+      return unless string
+      replace_exceptions(string).strip.split(' ').map do |word|
+        format_this word
+      end.join(' ')
+    end
+
+    def self.replace_special_chars(string)
+      sub_string = string[1..-1]
+      SPECIAL_CHARS.each do |pattern|
+        sub_string = sub_string.gsub(/#{pattern[0]}/i, pattern[1])
+      end
+      string[0].concat(sub_string)
+    end
+
+    def self.replace_exceptions(string)
+      string.gsub(/,.+spol\.+ s r.o./i, ' s.r.o.')
+    end
+
+    def self.format_this(string)
+      return string.downcase if string.size == 1
+      return string.downcase if COMPANY_TYPES.include? string.downcase
+      replace_special_chars(string.capitalize)
+    end
   end
 end

data/lib/vat_info/version.rb

@@ -1,3 +1,3 @@
 module VatInfo
-  VERSION = '0.0.1'
+  VERSION = '0.0.3'
 end

data/lib/vat_info.rb

@@ -7,6 +7,8 @@ require 'vat_info/models'
 
 module VatInfo
   def self.unreliable_payer(*vat_ids)
+    raise ArgumentError, 'Supply at least one id for query' if vat_ids.blank?
+
     request  = VatInfo::Request::UnreliablePayer.new(*vat_ids).to_xml
     response = VatInfo::Query.call(request, :get_status_nespolehlivy_platce)
 
@@ -15,16 +17,29 @@ module VatInfo
       status        = VatInfo::Models::Status.new(status_raw).data
 
       payers_raw    = VatInfo::Utils.wrap_in_array(response.raw[:status_nespolehlivy_platce_response][:status_platce_dph])
-      payers        = VatInfo::Models::VatPayers.new(payers_raw).data
+      payers        = VatInfo::Models::VatPayers.new(VatInfo::Models::VatPayer, payers_raw).data
 
       response.body = status.merge(payers)
     end
     response
   end
 
-  def self.unreliable_payer_extended
-    # :get_status_nespolehlivy_platce_rozsireny
-    raise NotImplementedError
+  def self.unreliable_payer_extended(*vat_ids)
+    raise ArgumentError, 'Supply at least one id for query' if vat_ids.blank?
+
+    request  = VatInfo::Request::UnreliablePayerExtended.new(*vat_ids).to_xml
+    response = VatInfo::Query.call(request, :get_status_nespolehlivy_platce_rozsireny)
+
+    if response.ok?
+      status_raw    = response.raw[:status_nespolehlivy_platce_rozsireny_response][:status]
+      status        = VatInfo::Models::Status.new(status_raw).data
+
+      payers_raw    = VatInfo::Utils.wrap_in_array(response.raw[:status_nespolehlivy_platce_rozsireny_response][:status_platce_dph])
+      payers        = VatInfo::Models::VatPayers.new(VatInfo::Models::VatPayerExtended, payers_raw).data
+
+      response.body = status.merge(payers)
+    end
+    response
   end
 
   def self.unreliable_payer_list

data/vat_info.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'vat_info/version'
 
@@ -13,7 +13,6 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/ucetnictvi-on-line/vat_payer_cz'
   spec.license       = 'MIT'
 
-
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
@@ -27,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry', '~> 0.11'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'vcr', '~> 4.0'
   spec.add_development_dependency 'webmock', '~> 3.3'
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vat_payer_cz
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Tomas Landovsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-08 00:00:00.000000000 Z
+date: 2018-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -135,10 +149,12 @@ files:
 - lib/vat_info/models.rb
 - lib/vat_info/models/status.rb
 - lib/vat_info/models/vat_payer.rb
+- lib/vat_info/models/vat_payer_extended.rb
 - lib/vat_info/models/vat_payers.rb
 - lib/vat_info/query.rb
 - lib/vat_info/request.rb
 - lib/vat_info/request/unreliable_payer.rb
+- lib/vat_info/request/unreliable_payer_extended.rb
 - lib/vat_info/response.rb
 - lib/vat_info/utils.rb
 - lib/vat_info/version.rb
@@ -163,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for web service providing info about Czech VAT payers.