ruby-ares 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 50972475ce973dc631c0dc3ecd6f1dfac01f2e25
+  data.tar.gz: fc170ac8e02fc2c9275535636241efca524df9d0
+SHA512:
+  metadata.gz: f63f5c44c5e7b5527ca65513a0c0240e2ee7ec8bc753317e7f0cb1f4e22f86f8a87441d6135123beab6419257b267d1371d13114b5c6935217855579e3f3b196
+  data.tar.gz: 5adb94c1f6ba5734f22e57120599dd27c8f3e4ce3288a01860c4560e910cec3b22ed2d831c803fc0286cf28471ae337004d76f4f93d7b1c9455578eef40ce505

data/README.md

@@ -1,24 +1,46 @@
+# ruby-ares
+
+Gem for accesing business information from ARES database.
+
+ARES is the Czech business database maintained by Ministry of Finance of the Czech Republic.
+This gem helps to retrieve data provided by this database. Currently ruby-ares supports only retrieval of basic information and addresses for business contacts by IČ (Czech business contact identification number).
+
+## Installation and Requirements
+
+Install the gem and require it:
+```
+$ gem install ruby-ares
+```
+```ruby
+require 'ruby-ares'
+```
+
+This will need libxml2 (with header files) installed. On Fedora:
+
+```
+su -c 'yum install libxml2-devel'
+```
+
 ## Usage
 
-subject = ARES::Subject.get ic
+To get an ARES subjet/party by IČ:
+```ruby
+subject = RubyARES::Subject.get(74948440)
+```
+And then:
+```ruby
+subject => #<RubyARES::Subject:0x007fc691a77470 @ico="74948440", @ic="74948440", @dic=nil, @name="Josef Stříbný", @company=nil, @status="A", @addresses=[#<RubyARES::Address:0x007fc691a776a0 @id="10731009", @street="Nádražní", @postcode="74727", @city="Kobeřice", @city_part="Kobeřice", @house_number="721", @house_number_type="1", @orientational_number=nil>], @updated_at="2009-08-25">
+subject.name => Josef Stříbný
+subject.ic => 74948440
+subject.address => #<RubyARES::Address:0x007fc691a776a0 @id="10731009", @street="Nádražní", @postcode="74727", @city="Kobeřice", @city_part="Kobeřice", @house_number="721", @house_number_type="1", @orientational_number=nil>
+```
+
+### Exceptions
 
-puts subject
-puts subject.name
-puts subject.ic
-puts subject.address # same as puts subject.addresses[0].to_str
+ruby-ares will raise either `RubyARES::Parser::ARESDatabaseError` or `RubyARES::Parser::ParseError` if the ARES database responds with an error or the XML doesn't contain the information you are looking for.
 
-#require './lib/ares.rb'
-require 'xml'
-require 'libxml'
-require 'net/http'
-require './lib/ares/subject.rb'
-require './lib/ares/address.rb'
-require './lib/ares/parser.rb'
-require './lib/ares/http.rb'
+If the connection to the ARES database can't be established ruby-ares raises `RubyARES::HTTP::ConnectionError`.
 
-subject = ARES::Subject.get(74948440)
+## License
 
-puts subject.name
-puts subject.ic
-puts subject.dic
-puts subject.address
+See LICENSE

data/Rakefile

@@ -2,23 +2,28 @@ require 'rubygems/package_task'
 require 'rake'
 require 'rake/testtask'
 
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+require 'ruby-ares'
+
 gemspec = Gem::Specification.new do |s|
-  s.name     = "ruby-ares"
-  s.version  = "0.0.1"
+  s.name     = 'ruby-ares'
+  s.version  = RubyARES::VERSION
   s.platform = Gem::Platform::RUBY
-  s.summary     = "Gem for accesing business information from ARES database."
+  s.summary     = 'Gem for accesing business information from ARES database.'
   s.description = <<-EOF
                     ARES is the Czech business database maintained by Ministry of Finance of the Czech Republic.
                     This gem helps to retrieve data provided by this database.
                   EOF
-  s.licenses = ["GPLv3"]
-  s.author   = "Josef Strzibny"
-  s.email    = "strzibny@strzibny.name"
-  s.homepage = "http://github.com/strzibny/ares"
-  s.required_ruby_version     = ">= 1.8.7"
-  s.required_rubygems_version = ">= 1.8.0"
-  s.files = FileList["README.md", "Rakefile",
-                      "lib/**/*.rb", "test/**/test*.rb"]
+  s.licenses = ['GPLv3']
+  s.author   = 'Josef Strzibny'
+  s.email    = 'strzibny@strzibny.name'
+  s.homepage = 'http://github.com/strzibny/ruby-ares'
+  s.required_ruby_version     = '>= 1.8.7'
+  s.required_rubygems_version = '>= 1.8.0'
+  s.files = FileList['README.md', 'Rakefile',
+                      'lib/**/*.rb', 'test/**/test*.rb']
+  s.add_runtime_dependency 'libxml-ruby'
+  s.requirements << 'libxml2'
 end
 
 Gem::PackageTask.new gemspec do |pkg|
@@ -28,4 +33,4 @@ Rake::TestTask.new('test') do |t|
   t.libs << 'test'
   t.pattern = 'test/**/test*.rb'
   t.verbose = true
-end
+end

data/lib/ruby-ares.rb

@@ -5,4 +5,8 @@ require 'libxml'
 require 'net/http'
 require 'ruby-ares/subject'
 require 'ruby-ares/address'
-require 'ruby-ares/parser'
+require 'ruby-ares/parser'
+
+module RubyARES
+  VERSION = '0.0.2'
+end

data/lib/ruby-ares/address.rb

@@ -10,7 +10,7 @@ module RubyARES
                 :house_number_type,     # Typ_cislo_domovni
                 :orientational_number,  # Cislo_orientacni
                 :postcode               # PSC
-                
+
     def initialize(id, street, postcode, city, city_part,
                    house_number, house_number_type, orientational_number)
       @id = id
@@ -22,7 +22,7 @@ module RubyARES
       @house_number_type = house_number_type
       @orientational_number = orientational_number
     end
-                
+
     def to_str
       @city_part = '' if @city == @city_part
 <<EOF
@@ -31,7 +31,7 @@ module RubyARES
 #{self.city_part}
 EOF
     end
-    
+
     def street_number
       unless @orientational_number
         @house_number
@@ -39,13 +39,13 @@ EOF
         "#{@orientational_number}/#{@house_number}"
       end
     end
-    
+
     def street_line
       "#{@street} #{street_number}"
     end
-    
+
     def city_line
       "#{@postcode} #{@city}"
     end
   end
-end
+end

data/lib/ruby-ares/http.rb

@@ -4,9 +4,9 @@ require 'net/http'
 
 module RubyARES
   class HTTP
-    
+
     class ConnectionError < StandardError; end
-    
+
     def self.fetch_subject_xml(ic)
       # Get a subject info from ARES[http://wwwinfo.mfcr.cz/ares/]
       uri = URI('http://wwwinfo.mfcr.cz/cgi-bin/ares/darv_rzp.cgi')
@@ -22,4 +22,4 @@ module RubyARES
       end
     end
   end
-end
+end

data/lib/ruby-ares/parser.rb

@@ -6,18 +6,18 @@ require 'ruby-ares/subject'
 
 module RubyARES
   class Parser
-    
+
     class ARESDatabaseError < StandardError; end
     class ParseError < StandardError; end
-    
+
     def self.get_subject(xml)
       begin
         doc = self.parse_document xml
-      
+
         # Basic info
         doc.find('//dtt:Zakladni_udaje').each do |node|
           attrs = node.children()
-        
+
           # Attributes of the subject
           @status = node.find('dtt:Stav').to_a[0].content unless node.find('dtt:Stav') == 0
           @updated_at = node.find('dtt:Datum_zmeny').to_a[0].content unless node.find('dtt:Datum_zmeny').to_a.size == 0
@@ -25,26 +25,26 @@ module RubyARES
           @dic = node.find('dtt:DIC').to_a[0].content unless node.find('dtt:DIC').to_a.size == 0
           @name = node.find('dtt:Obchodni_firma').to_a[0].content unless node.find('dtt:Obchodni_firma').to_a.size == 0
         end
-      
+
         # Corresponding addresses
-        @addresses = self.find_addresses doc    
+        @addresses = self.find_addresses doc
       rescue
         raise ParseError, "Can't parse the given document."
       end
-      
+
       if doc.find('//dtt:Error').to_a.size > 0
         raise ARESDatabaseError, 'ARES returned an error.'
       end
-      
+
       # Create and return subject
       return RubyARES::Subject.new(@ic, @dic, @name, @status, @addresses, @updated_at)
     end
-    
+
     protected
-    
+
       def self.find_addresses(doc)
         @addresses = []
-      
+
         doc.find('//dtt:Adresa').each do |node|
           id = node.find('dtt:ID_adresy').to_a[0].content
           street = node.find('dtt:Nazev_ulice').to_a[0].content unless node.find('dtt:Nazev_ulice').to_a.size == 0
@@ -54,17 +54,17 @@ module RubyARES
           house_number = node.find('dtt:Cislo_domovni').to_a[0].content unless node.find('dtt:Cislo_domovni').to_a.size == 0
           house_number_type = node.find('dtt:Typ_cislo_domovni').to_a[0].content unless node.find('dtt:Typ_cislo_domovni').to_a.size == 0
           orientational_number = node.find('dtt:Cislo_orientacni').to_a[0].content unless node.find('dtt:Cislo_orientacni').to_a.size == 0
-        
+
           @addresses << RubyARES::Address.new(id, street, postcode, city, city_part,
                                           house_number, house_number_type, orientational_number)
         end
-      
+
         return @addresses
       end
-    
+
       def self.parse_document(xml)
         parser = XML::Parser.string xml
         parser.parse
       end
   end
-end
+end

data/lib/ruby-ares/subject.rb

@@ -4,7 +4,7 @@ require 'ruby-ares/parser'
 require 'ruby-ares/http'
 
 module RubyARES
-  class Subject  
+  class Subject
     attr_reader :ico,       # ICO
                 :ic,        # alias for ic
                 :dic,       # DIC
@@ -13,12 +13,12 @@ module RubyARES
                 :status,    # Stav
                 :addresses,
                 :updated_at # Datum_zmeny
-    
+
     def self.get(ic)
       xml = RubyARES::HTTP.fetch_subject_xml ic
       RubyARES::Parser.get_subject xml
     end
-    
+
     def initialize(ic, dic, name, status, addresses, updated_at)
       @ic, @ico = ic, ic
       @dic = dic
@@ -27,9 +27,9 @@ module RubyARES
       @addresses = addresses
       @updated_at = updated_at
     end
-    
+
     def address
       @addresses[0]
     end
   end
-end
+end

data/test/test_ares.rb

@@ -8,28 +8,28 @@ class RubyARESTest < Test::Unit::TestCase
   def setup
     @subject = RubyARES::Parser.get_subject RubyARESTestHelper.subject_xml
   end
-	
-	def test_subject_address_house_number
+
+  def test_subject_address_house_number
     assert_equal '2178 1', "#{@subject.addresses[0].house_number} #{@subject.addresses[0].house_number_type}"
   end
-  
+
   def test_subject_address_street
     assert_equal 'Podvinný mlýn 6/2178', "#{@subject.addresses[0].street} #{@subject.addresses[0].street_number}"
   end
-  
+
   def test_subject_address_city
     assert_equal 'Praha Libeň', "#{@subject.addresses[0].city} #{@subject.addresses[0].city_part}"
-	end
-  
+  end
+
   def test_subject_address_postcode
     assert_equal '19000', @subject.addresses[0].postcode
-	end
-	
-	def test_subject_name
+  end
+
+  def test_subject_name
     assert_equal 'Asseco Central Europe, a.s.', @subject.name
-	end
-	
-	def test_number_of_subject_addresses
-	  assert_equal 1, @subject.addresses.size
-	end
-end
+  end
+
+  def test_number_of_subject_addresses
+    assert_equal 1, @subject.addresses.size
+  end
+end

data/test/test_ares_address.rb

@@ -4,20 +4,20 @@ require 'test/unit'
 require 'ruby-ares/address'
 
 class RubyARESAddressTest < Test::Unit::TestCase
-  
+
   def setup
     @address = RubyARES::Address.new(1, 'Kunzova', '10010', 'Brno', 'Královo pole', 1, 1, nil)
   end
-  
-  def test_address_to_string    
+
+  def test_address_to_string
     assert_equal "Kunzova 1\n10010 Brno\nKrálovo pole\n", @address.to_str
   end
-  
+
   def test_address_street_line
     assert_equal "Kunzova 1", @address.street_line
   end
-  
+
   def test_address_city_line
     assert_equal "10010 Brno", @address.city_line
   end
-end
+end

data/test/test_ares_http.rb

@@ -5,4 +5,4 @@ require 'ruby-ares/http'
 
 class RubyARESHTTPTest < Test::Unit::TestCase
 
-end
+end

data/test/test_ares_parser.rb

@@ -5,10 +5,10 @@ require 'helper'
 require 'ruby-ares/parser'
 
 class RubyARESParserTest < Test::Unit::TestCase
-	
-	def test_parser_should_fail  
-	  assert_raise(RubyARES::Parser::ARESDatabaseError) {
-	    RubyARES::Parser.get_subject(RubyARESTestHelper.error_responce_xml)
-	  }
-	end
-end
+
+  def test_parser_should_fail
+    assert_raise(RubyARES::Parser::ARESDatabaseError) {
+      RubyARES::Parser.get_subject(RubyARESTestHelper.error_responce_xml)
+    }
+  end
+end

data/test/test_ares_subject.rb

@@ -5,4 +5,4 @@ require 'ruby-ares/subject'
 
 class RubyARESSubjectTest < Test::Unit::TestCase
 
-end
+end

metadata

@@ -1,19 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: ruby-ares
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
 - Josef Strzibny
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-02 00:00:00.000000000Z
-dependencies: []
-description: ! "                    ARES is the Czech business database maintained
-  by Ministry of Finance of the Czech Republic.\n                    This gem helps
-  to retrieve data provided by this database.\n"
+date: 2014-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: libxml-ruby
+  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: |2
+                      ARES is the Czech business database maintained by Ministry of Finance of the Czech Republic.
+                      This gem helps to retrieve data provided by this database.
 email: strzibny@strzibny.name
 executables: []
 extensions: []
@@ -31,29 +44,29 @@ files:
 - test/test_ares_http.rb
 - test/test_ares_parser.rb
 - test/test_ares_subject.rb
-homepage: http://github.com/strzibny/ares
+homepage: http://github.com/strzibny/ruby-ares
 licenses:
 - GPLv3
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.8.0
-requirements: []
+requirements:
+- libxml2
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Gem for accesing business information from ARES database.
 test_files: []