cra.ge 0.1.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+*.pem

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Dimitri Kurashvili
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# CRA.ge
+
+`cra.ge` is a gem for working with Georgian Civil Registry Agency web-services.
+
+## Configure
+
+First of all you need to configure the gem. You need a PEM certificate file for this:
+
+```ruby
+CRA.config.pem_file = '/home/dimakura/certificates/my-company.pem'
+```
+
+## Getting person information by private number
+
+If you have person's private number (11 digits code), then you can get the last entry in CRA database,
+like this:
+
+```ruby
+private_number = '02001000490'
+person_info = CRA.serv.by_personal_id(private_number) # CRA::PassportInfo
+```
+
+## Getting full documentation for the person
+
+If you have first/last names of the person and know their birthdate, then it's easy to get
+full list of documentation for this person:
+
+```ruby
+fname = 'დიმიტრი'
+lname = 'ყურაშვილი'
+year, month, day = 1979, 4, 4
+docs = CRA.serv.list_by_name_and_dob(lname, fname, year, month, day) # array of CRA::PassportInfo
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/cra.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cra/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "cra.ge"
+  gem.version       = CRA::VERSION
+  gem.authors       = ["Dimitri Kurashvili"]
+  gem.email         = ["dimitri@c12.ge"]
+  gem.description   = %q{CRA services}
+  gem.summary       = %q{Ruby client for C(ivil)R(egistry)A(gency) services}
+  gem.homepage      = "http://github.com/dimakura/cra.ge"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rspec', '~> 2.11'
+  gem.add_runtime_dependency 'savon', '~> 1.2'
+end

data/lib/cra.rb

@@ -0,0 +1,33 @@
+# -*- encoding : utf-8 -*-
+require 'savon'
+require 'cra/version'
+
+require 'cra/config'
+
+module CRA
+  BASE_URL = 'http://stateinstitution.cra.ge'
+  WSDL_URL = 'https://stateinstitutions.cra.ge/Service.asmx?WSDL'
+
+  MALE = 1
+  FEMALE = 2
+
+  class Base
+
+    def get_client
+      Savon::Client.new WSDL_URL do 
+        http.auth.ssl.cert_file = CRA.config.pem_file
+        http.auth.ssl.cert_key_file = CRA.config.pem_file
+        http.auth.ssl.verify_mode = :peer 
+      end
+    end
+
+    def soap_action(name)
+      "#{BASE_URL}/#{name}"
+    end
+
+  end
+
+end
+
+require 'cra/pasport_info'
+require 'cra/services'

data/lib/cra/config.rb

@@ -0,0 +1,17 @@
+# -*- encoding : utf-8 -*-
+require 'singleton'
+
+module CRA
+
+  class Config
+    include Singleton
+    attr_accessor :pem_file
+  end
+
+  class << self
+    def config
+      CRA::Config.instance
+    end
+  end
+
+end

data/lib/cra/pasport_info.rb

@@ -0,0 +1,92 @@
+# -*- encoding : utf-8 -*-
+require 'base64'
+
+class CRA::PasportInfo
+
+  attr_accessor :doc_id, :doc_type, :doc_description, :doc_status, :doc_status_text
+  attr_accessor :is_id_card, :id_card_serial, :id_card_number, :id_card_issuer, :id_card_issue_date, :id_card_valid_date
+  attr_accessor :pasport_number, :passport_issuer, :passport_issue_date, :passport_valid_date
+  attr_accessor :person_id, :social_id, :private_number
+  attr_accessor :first_name, :last_name, :middle_name
+  attr_accessor :birth_date, :birth_place
+  attr_accessor :gender
+  attr_accessor :citizenship, :citizenship_code, :second_citizenship, :second_citizenship_code
+  attr_accessor :living_place_id, :living_place, :living_place_registration, :living_place_registration_end, :actual_living_place
+  attr_accessor :region_id, :region_name
+  attr_accessor :response_id, :response_code
+  attr_accessor :is_person_dead, :is_document_lost
+  attr_accessor :photos
+
+  def self.init_with_hash(hash)
+    passport = CRA::PasportInfo.new
+    passport.doc_id = hash[:document_id].to_i
+    passport.doc_type = hash[:document_type_id].to_i
+    passport.doc_description = hash[:document_description]    
+    passport.doc_status = hash[:document_status_enum]
+    passport.doc_status_text = hash[:document_status_str]
+    passport.is_id_card = hash[:is_id_card]
+    passport.id_card_serial = hash[:id_card_serial]
+    passport.id_card_number = hash[:id_card_number]
+    passport.id_card_issuer = hash[:id_card_issuer]
+    passport.id_card_issue_date = hash[:id_card_issue_date]
+    passport.id_card_valid_date = hash[:id_card_valid_date]
+    passport.pasport_number = hash[:pasport_number]
+    passport.passport_issuer = hash[:passport_issuer]
+    passport.passport_issue_date = hash[:passport_issue_date]
+    passport.passport_valid_date = hash[:passport_valid_date]
+    passport.person_id = hash[:person_id].to_i
+    passport.social_id = hash[:social_id].to_i
+    passport.private_number = hash[:private_number]
+    passport.first_name = hash[:first_name]
+    passport.last_name = hash[:last_name]
+    passport.middle_name = hash[:middle_name]
+    passport.birth_date = hash[:birth_date]
+    passport.birth_place = hash[:birth_place]
+    passport.gender = hash[:gender].to_i
+    passport.citizenship = hash[:citizenship]
+    passport.citizenship_code = hash[:citizenship_code]
+    passport.second_citizenship = hash[:double_citizenship]
+    passport.second_citizenship_code = hash[:double_citizenship_code]
+    passport.living_place_id = hash[:living_place_id].to_i
+    passport.living_place = hash[:living_place]
+    passport.actual_living_place = hash[:fa_living_place]
+    passport.living_place = passport.living_place.split(' ').join(' ') if passport.living_place
+    passport.actual_living_place = passport.actual_living_place.split(' ').join(' ') if passport.actual_living_place
+    passport.living_place_registration = hash[:living_place_reg_date]
+    passport.living_place_registration_end = hash[:living_place_reg_end_date]
+    passport.region_id = hash[:region_id].to_i
+    passport.region_name = hash[:region_str_]
+    passport.response_id = hash[:response_id].to_i
+    passport.is_person_dead = hash[:is_person_dead]
+    passport.is_document_lost = hash[:is_document_lost]
+    passport.photos = []
+    if hash[:photos].is_a?(Array)
+      hash[:photos].each do |photo|
+        passport.photos.push(photo[:base64_binary])
+      end
+    else
+      passport.photos.push(hash[:photos][:base64_binary])
+    end
+    passport
+  end
+
+  def full_name(opts = {})
+    if opts[:with_middle_name]
+      "#{first_name} #{last_name} #{middle_name}"
+    else
+      "#{first_name} #{last_name}"
+    end
+  end
+
+  # Returns binary content of the photo.
+  def binary(index)
+    Base64.decode64(self.photos[index])
+  end
+
+  def write_photo(index, file = nil)
+    File.open(file || 'photo', 'wb') do |file|
+      file.write self.binary(index)
+    end
+  end
+
+end

data/lib/cra/services.rb

@@ -0,0 +1,83 @@
+# -*- encoding : utf-8 -*-
+require 'singleton'
+
+module CRA
+
+  class Services < CRA::Base
+    include Singleton
+
+    # Get service consumer UPN.
+    def my_upn
+      action_name = 'GetMyUPN'
+      soap_action = self.soap_action(action_name)
+      response = get_client.request action_name do
+        http.headers['SOAPAction'] = soap_action
+      end      
+      response.to_hash[:get_my_upn_response][:get_my_upn_result]
+    end
+
+    # Getting personal information by personal number.
+    def by_personal_id(personal_number)
+      raise ArgumentError('personal_number required') if personal_number.blank?
+      action_name = 'GetDataUsingPrivateNumber'
+      soap_action = self.soap_action(action_name)
+      response = get_client.request action_name do
+        http.headers['SOAPAction'] = soap_action
+        soap.body = { 'privateNumber' => personal_number }
+      end      
+      CRA::PasportInfo.init_with_hash(response.to_hash[:get_data_using_private_number_response][:get_data_using_private_number_result])
+    end
+
+    # Getting personal information by ID card information.
+    def by_id_card(serial, number)
+      raise ArgumentError('id card serial required') if serial.blank?
+      raise ArgumentError('id card number required') if serial.blank?
+      action_name = 'PersonInfoByDocumentNumber'
+      soap_action = self.soap_action(action_name)
+      response = get_client.request action_name do
+        http.headers['SOAPAction'] = soap_action
+        soap.body = { 'idCardSerial' => serial, 'idCardNumber' => number }
+      end      
+      CRA::PasportInfo.init_with_hash(response.to_hash[:person_info_by_document_number_response][:person_info_by_document_number_result])
+    end
+
+    # Getting documents by name and date of birth.
+    def list_by_name_and_dob(last_name, first_name, year, month, day)
+      raise ArgumentError('first_name required') if first_name.blank?
+      raise ArgumentError('last_name required') if last_name.blank?
+      raise ArgumentError('year required') if year.blank?
+      raise ArgumentError('month required') if month.blank?
+      raise ArgumentError('day required') if day.blank?
+      action_name = 'GetDataUsingCriteria'
+      soap_action = self.soap_action(action_name)
+      response = get_client.request action_name do
+        http.headers['SOAPAction'] = soap_action
+        soap.body = { 'lastName' => last_name, 'firstName' => first_name, 'year' => year, 'month' => month, 'day' => day }
+      end
+      data = response.to_hash[:get_data_using_criteria_response][:get_data_using_criteria_result][:person_info]
+      documents = []
+      data.each do |row|
+        documents << CRA::PasportInfo.init_with_hash(row)
+      end
+      documents
+    end
+
+    def test_service
+      action_name = 'PersonInfoByDocumentNumber'
+      soap_action = self.soap_action(action_name)
+      response = get_client.request action_name do
+        http.headers['SOAPAction'] = soap_action
+        soap.body = { 'idCardSerial' => 'გ', 'idCardNumber' => '1355876' }
+      end      
+      puts response.to_hash
+    end
+
+  end
+
+  class << self
+    def serv
+      CRA::Services.instance
+    end
+  end
+
+end

data/lib/cra/version.rb

@@ -0,0 +1,4 @@
+# -*- encoding : utf-8 -*-
+module CRA
+  VERSION = "0.1.0"
+end

data/spec/config_spec.rb

@@ -0,0 +1,6 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+describe 'configure CRA gem' do
+  specify { CRA.config.pem_file.should == 'spec/data/telasi.pem' }
+end

data/spec/service_spec.rb

@@ -0,0 +1,79 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+require 'cra'
+
+describe 'my UPN' do
+  before(:all) do
+    @upn = CRA.serv.my_upn
+  end
+  subject { @upn }
+  it { should == 'CRA\telasi' }
+end
+
+describe 'get person info by id' do
+  before(:all) do
+    @person_info = CRA.serv.by_personal_id('02001000490')
+  end
+  subject { @person_info }
+  its(:doc_id) { should > 0 }
+  its(:doc_type) { should == 1 }
+  its(:doc_description) { should == 'პირადობის მოწმობა' }
+  its(:doc_status) { should == 'Active' }
+  its(:doc_status_text) { should == 'აქტიური' }
+  its(:is_id_card) { should == true }
+  its(:id_card_serial) { should == 'გ' }
+  its(:id_card_number) { should == '1355876' }
+  its(:id_card_issuer) { should == 'სამოქალაქო რეესტრის სააგენტოს მთაწმინდა-კრწანისის სამსახური' }
+  its(:id_card_issue_date) { should_not be_nil }
+  its(:id_card_valid_date) { should_not be_nil }
+  its(:pasport_number) { should be_nil }
+  its(:passport_issuer) { should be_nil }
+  its(:passport_issue_date) { should be_nil }
+  its(:passport_valid_date) { should be_nil }
+  its(:person_id) { should == 969036 }
+  its(:private_number) { should == '02001000490' }
+  its(:first_name) { should == 'დიმიტრი' }
+  its(:last_name) { should == 'ყურაშვილი' }
+  its(:middle_name) { should == 'ალბერტი' }
+  its(:birth_date) { should_not be_nil }
+  its(:birth_place) { should == 'საქართველო, აბაშა' }
+  its(:gender) { should == CRA::MALE }
+  its(:citizenship) { should == 'საქართველო' }
+  its(:citizenship_code) { should == 'GEO' }
+  its(:second_citizenship) { should be_nil }
+  its(:second_citizenship_code) { should be_nil }
+  its(:living_place_id) { should == 920434 }
+  its(:living_place) { should == 'თბილისი მისამართის გარეშე' }
+  its(:living_place_registration) { should_not be_nil }
+  its(:living_place_registration_end) { should be_nil }
+  its(:actual_living_place) { should == 'თბილისი აკ.ხორავას ჩიხი N 8' }
+  its(:is_person_dead) { should == false }
+  its(:is_document_lost) { should == false }
+  its(:photos) { should_not be_empty }
+end
+
+describe 'get person info by id card' do
+  before(:all) do
+    @person_info = CRA.serv.by_id_card('გ', '1355876')
+  end
+  subject { @person_info }
+  its(:doc_id) { should > 0 }
+  its(:first_name) { should == 'დიმიტრი' }
+  its(:last_name) { should == 'ყურაშვილი' }
+  its(:private_number) { should == '02001000490' }
+end
+
+describe 'find person documents by name and dob' do
+  before(:all) do
+    @documents = CRA.serv.list_by_name_and_dob('ყურაშვილი', 'დიმიტრი', 1979, 4, 4)
+  end
+  context do
+    subject { @documents }
+    its(:size) { should == 5 }
+  end
+  context do
+    subject { @documents.first }
+    its(:person_id) { should == 969036 }
+    its(:private_number) { should == '02001000490' }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# -*- encoding : utf-8 -*-
+
+# Savon
+
+require 'savon'
+
+HTTPI.log = false
+Savon.configure do |config|
+  config.log = false
+end
+
+# RSpec
+
+require 'rspec'
+
+RSpec.configure do |config|
+  config.include(RSpec::Matchers)
+end
+
+# Test options.
+
+require 'cra'
+
+CRA.config.pem_file = 'spec/data/telasi.pem'

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: cra.ge
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dimitri Kurashvili
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-10-26 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.11"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: savon
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.2"
+  type: :runtime
+  version_requirements: *id002
+description: CRA services
+email: 
+- dimitri@c12.ge
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .DS_Store
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cra.gemspec
+- lib/cra.rb
+- lib/cra/config.rb
+- lib/cra/pasport_info.rb
+- lib/cra/services.rb
+- lib/cra/version.rb
+- spec/config_spec.rb
+- spec/service_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/dimakura/cra.ge
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby client for C(ivil)R(egistry)A(gency) services
+test_files: 
+- spec/config_spec.rb
+- spec/service_spec.rb
+- spec/spec_helper.rb