kubicek-ares 0.1.0

data/README.rdoc

@@ -0,0 +1,30 @@
+== Ares
+
+Simple library for querying Ares system in Czech republic with translation of
+labels.
+
+  http://wwwinfo.mfcr.cz/ares/ares.html.cz
+
+== Usage
+
+Is simple as creating ares instance by finder and calling methods on it:
+
+  ares = Ares.find(:ico => '27386830')
+  ares.found? == true
+  ares.company_name == "GravaStar s.r.o."
+  ares.subject_type == "P"
+  ares.address == {
+    :city => "16000 Praha",
+    :street => "Charlese de Gaulla 800/3",
+    :country => "Česká republika"
+  }
+  ares = Ares.find(:ico => '666')
+  ares.found? == false
+
+It should be posible to find by company name, but is not tested. Also subject
+type F needs more testing (see rake test:rcov).
+
+== Dependencies
+
+Only active support for Hash.from_xml. Maybe it should be redone with something
+less fat.

data/Rakefile

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'rake'
+require 'ftools'
+require 'spec'
+require 'spec/rake/spectask'
+
+desc "Runs all specs as default"
+task :default => 'test:spec'
+
+namespace :test do
+  desc "Run all specs"
+  Spec::Rake::SpecTask.new do |t|
+    t.spec_files = FileList['spec/*_spec.rb']
+    t.spec_opts = ['-u']
+  end
+
+
+
+  desc "Run all examples with RCov"
+  Spec::Rake::SpecTask.new('rcov') do |t|
+    t.spec_files = FileList['spec/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec']
+  end
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ares"
+    gem.summary = %Q{Simple ruby wrapper for Czech Ares service}
+    gem.email = "pepe@gravastar.cz"
+    gem.homepage = "http://github.com/pepe/ares"
+    gem.authors = ["Josef Pospisil"]
+    gem.description = "Simple library for querying Ares system in Czech republic with translation of labels."
+    gem.add_dependency('activesupport', '>= 1.4.0')
+    IGNORE = [/\.gitignore$/, /VERSION$/]
+    gem.files.reject! { |f| IGNORE.any? { |re| f.match(re) } }
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end

data/lib/ares.rb

@@ -0,0 +1,77 @@
+require 'net/http'
+require 'active_support'
+class Ares
+  SERVICE_URL = "http://wwwinfo.mfcr.cz/cgi-bin/ares/darv_std.cgi?%s".freeze
+  attr_reader :options, :result
+
+  # class methods
+  class << self
+    # finds subject by any part on ares service
+    def find(options)
+      return new(options)
+    end
+  end
+
+  # initializes new ares object 
+  def initialize(options)
+    @options = options
+    @result = Hash.from_xml(Net::HTTP.get(URI.parse(SERVICE_URL % self.params)))
+    return self
+  end
+
+  # returns true if subject found on ares, otherwise false
+  def found?
+    @found ||= !(self.result["Ares_odpovedi"]["Odpoved"]["Pocet_zaznamu"] == '0' ||
+      self.result["Ares_odpovedi"]["Odpoved"]["error"])
+  end
+
+  # returns params like concatenated options
+  def params
+    @params ||= options.inject([]) do |res, pair|
+       res << "%s=%s" % [pair.first, pair.last]
+    end.join('&')
+  end
+
+  # returns just answer part
+  def answer
+    @answer ||= self.result["Ares_odpovedi"]["Odpoved"]["Zaznam"]
+  end
+
+  # returns company name
+  def company_name
+    @company_name ||= self.answer["Obchodni_firma"]
+  end
+
+  # returns ico
+  def ico
+    @company_name ||= self.answer["ICO"]
+  end
+
+  # returns subject type
+  def subject_type
+    @subject_type ||= if self.answer["Identifikace"]["Osoba"].nil?
+                        "P"
+                      else
+                        "F"
+                      end
+  end
+
+  # returns address
+  def address
+    @address ||= {
+      :city => self.raw_address['PSC'][0..0] == "1" ? self.raw_address['Nazev_mestske_casti'] : self.raw_address['Nazev_obce'],
+      :street => [self.raw_address["Nazev_ulice"], [self.raw_address['Cislo_domovni'],self.raw_address['Cislo_orientacni']].compact.join('/')].join(' '),
+      :zip => self.raw_address['PSC']
+       
+    }
+  end
+
+  # returns raw address
+  def raw_address
+    @raw_address ||= if self.subject_type == "P"
+                   self.answer["Identifikace"]["Adresa_ARES"]
+                 else
+                   self.answer["Identifikace"]["Osoba"]["Bydliste"]
+                 end
+  end
+end

data/spec/ares_spec.rb

@@ -0,0 +1,165 @@
+require 'rubygems'
+require 'spec'
+require 'lib/ares'
+
+SERVICE_URL = "http://wwwinfo.mfcr.cz/cgi-bin/ares/darv_std.cgi?%s".freeze
+describe "ares" do
+  # mocks net/http to return gravastar result
+  def mock_found
+    @test_xml = <<TEST_XML
+      <?xml version="1.0" encoding="UTF-8"?>
+      <are:Ares_odpovedi xmlns:are="http://wwwinfo.mfcr.cz/ares/xml_doc/schemas/ares/ares_answer/v_1.0.1" xmlns:dtt="http://wwwinfo.mfcr.cz/ares/xml_doc/schemas/ares/ares_datatypes/v_1.0.4" xmlns:udt="http://wwwinfo.mfcr.cz/ares/xml_doc/schemas/uvis_datatypes/v_1.0.1" odpoved_datum_cas="2009-08-07T10:55:41" odpoved_pocet="1" odpoved_typ="Standard" vystup_format="XML" xslt="klient" validation_XSLT="/ares/xml_doc/schemas/ares/ares_answer/v_1.0.0/ares_answer.xsl" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://wwwinfo.mfcr.cz/ares/xml_doc/schemas/ares/ares_answer/v_1.0.1 http://wwwinfo.mfcr.cz/ares/xml_doc/schemas/ares/ares_answer/v_1.0.1/ares_answer_v_1.0.1.xsd" Id="ares">
+      <are:Odpoved>
+      <are:Pocet_zaznamu>1</are:Pocet_zaznamu>
+      <are:Typ_vyhledani>FREE</are:Typ_vyhledani>
+      <are:Zaznam>
+      <are:Shoda_ICO>
+      <dtt:Kod>9</dtt:Kod>
+      </are:Shoda_ICO>
+      <are:Vyhledano_dle>ICO</are:Vyhledano_dle>
+      <are:Typ_registru>
+      <dtt:Kod>2</dtt:Kod>
+
+      <dtt:Text>OR</dtt:Text>
+      </are:Typ_registru>
+      <are:Datum_vzniku>2005-11-03</are:Datum_vzniku>
+      <are:Datum_platnosti>2009-08-07</are:Datum_platnosti>
+      <are:Pravni_forma>
+      <dtt:Kod_PF>112</dtt:Kod_PF>
+      </are:Pravni_forma>
+      <are:Obchodni_firma>GravaStar s.r.o.</are:Obchodni_firma>
+      <are:ICO>27386830</are:ICO>
+      <are:Identifikace>
+      <are:Adresa_ARES>
+
+      <dtt:ID_adresy>202396372</dtt:ID_adresy>
+      <dtt:Kod_statu>203</dtt:Kod_statu>
+      <dtt:Nazev_okresu>Hlavní město Praha</dtt:Nazev_okresu>
+      <dtt:Nazev_obce>Praha</dtt:Nazev_obce>
+      <dtt:Nazev_casti_obce>Bubeneč</dtt:Nazev_casti_obce>
+      <dtt:Nazev_mestske_casti>Praha 6</dtt:Nazev_mestske_casti>
+      <dtt:Nazev_ulice>Charlese de Gaulla</dtt:Nazev_ulice>
+      <dtt:Cislo_domovni>800</dtt:Cislo_domovni>
+      <dtt:Cislo_orientacni>3</dtt:Cislo_orientacni>
+
+      <dtt:PSC>16000</dtt:PSC>
+      <dtt:Adresa_UIR>
+      <udt:Kod_oblasti>19</udt:Kod_oblasti>
+      <udt:Kod_kraje>19</udt:Kod_kraje>
+      <udt:Kod_okresu>3100</udt:Kod_okresu>
+      <udt:Kod_obce>554782</udt:Kod_obce>
+      <udt:Kod_pobvod>60</udt:Kod_pobvod>
+      <udt:Kod_sobvod>60</udt:Kod_sobvod>
+      <udt:Kod_casti_obce>490024</udt:Kod_casti_obce>
+
+      <udt:Kod_mestske_casti>500178</udt:Kod_mestske_casti>
+      <udt:PSC>16000</udt:PSC>
+      <udt:Kod_ulice>470813</udt:Kod_ulice>
+      <udt:Cislo_domovni>800</udt:Cislo_domovni>
+      <udt:Typ_cislo_domovni>1</udt:Typ_cislo_domovni>
+      <udt:Cislo_orientacni>3</udt:Cislo_orientacni>
+      <udt:Kod_adresy>22182616</udt:Kod_adresy>
+      <udt:Kod_objektu>22099042</udt:Kod_objektu>
+      <udt:PCD>2495506</udt:PCD>
+
+      </dtt:Adresa_UIR>
+      </are:Adresa_ARES>
+      </are:Identifikace>
+      <are:Kod_FU>6</are:Kod_FU>
+      <are:Priznaky_subjektu>NAAANANNNNNNNNNNNNNNNNNNNNNNNN</are:Priznaky_subjektu>
+      </are:Zaznam>
+      </are:Odpoved>
+      </are:Ares_odpovedi>
+TEST_XML
+    Net::HTTP.stub!(:get).and_return(@test_xml)
+  end
+
+  # mocks net/http to return empty result
+  def mock_not_found
+    @test_xml = <<TEST_XML
+      <?xml version="1.0" encoding="UTF-8"?>
+      <are:Ares_odpovedi xmlns:are="http://wwwinfo.mfcr.cz/ares/xml_doc/schemas/ares/ares_answer/v_1.0.1" xmlns:dtt="http://wwwinfo.mfcr.cz/ares/xml_doc/schemas/ares/ares_datatypes/v_1.0.4" xmlns:udt="http://wwwinfo.mfcr.cz/ares/xml_doc/schemas/uvis_datatypes/v_1.0.1" odpoved_datum_cas="2009-08-07T10:49:40" odpoved_pocet="1" odpoved_typ="Standard" vystup_format="XML" xslt="klient" validation_XSLT="/ares/xml_doc/schemas/ares/ares_answer/v_1.0.0/ares_answer.xsl" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://wwwinfo.mfcr.cz/ares/xml_doc/schemas/ares/ares_answer/v_1.0.1 http://wwwinfo.mfcr.cz/ares/xml_doc/schemas/ares/ares_answer/v_1.0.1/ares_answer_v_1.0.1.xsd" Id="ares">
+      <are:Odpoved>
+      <are:Pocet_zaznamu>0</are:Pocet_zaznamu>
+      <are:Typ_vyhledani>FREE</are:Typ_vyhledani>
+      </are:Odpoved>
+      </are:Ares_odpovedi>
+TEST_XML
+    Net::HTTP.stub!(:get).and_return(@test_xml)
+  end
+
+  describe "initialization and basic methods" do
+    before(:each) do
+      mock_not_found
+    end
+
+    it "should be created by finder" do
+      ares = Ares.find(:ico => '666')
+      ares.should_not be_nil
+      ares.class.should == Ares
+    end
+
+    it "should store options" do
+      ares = Ares.find(:ico => '666')
+      ares.options.should == {:ico => '666'}
+    end
+
+    it "should have params with equal sign concatenated options" do
+      ares = Ares.find(:ico => '27386830')
+      ares.params.should == "ico=27386830" 
+      ares = Ares.find(:ico => '27386830', :obchodni_firma => 'Grava')
+      ares.params.should == "ico=27386830&obchodni_firma=Grava" 
+    end
+
+    it "should have result with hash from xml" do
+      ares = Ares.find(:ico => '27386830')
+      ares.result.class.should == Hash
+    end
+  end
+
+  describe "founding" do
+    it "should not find not existing subject on ares" do
+      mock_not_found
+      ares = Ares.find(:ico => '666')
+      ares.found?.should be_false
+    end
+
+    it "should find existing subject on ares" do
+      mock_found
+      ares = Ares.find(:ico => '27386830')
+      ares.found?.should be_true
+    end
+  end
+
+  describe "parser" do
+    it "should parse company_name" do
+      mock_found
+      ares = Ares.find(:ico => '27386830')
+      ares.company_name.should == "GravaStar s.r.o."
+    end
+
+    it "should parse ico" do
+      mock_found
+      ares = Ares.find(:ico => '27386830')
+      ares.ico.should == '27386830'
+    end
+
+    it "should parse subject type" do
+      mock_found
+      ares = Ares.find(:ico => '27386830')
+      ares.subject_type.should == 'P'
+    end
+
+    it "should parse address" do
+      mock_found
+      ares = Ares.find(:ico => '27386830')
+      ares.address.is_a?(Hash).should be_true
+      ares.address.should == {
+        :city => "Praha 6",
+        :street => "Charlese de Gaulla 800/3",
+        :zip => '16000'
+      }
+    end
+  end
+end
+

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: kubicek-ares
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Josef Pospisil
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-07 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.0
+    version: 
+description: Simple library for querying Ares system in Czech republic with translation of labels.
+email: pepe@gravastar.cz
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- lib/ares.rb
+- spec/ares_spec.rb
+has_rdoc: true
+homepage: http://github.com/pepe/ares
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Simple ruby wrapper for Czech Ares service
+test_files: 
+- spec/ares_spec.rb