rs.ge 0.1.0.rc1 → 0.1.0.rc2

data/README.md

@@ -1,6 +1,28 @@
 # RS.GE web services
 
-This is a tiny API for working with [rs.ge](http://eservices.rs.ge) web-services from Ruby.
+This is a tiny API for working with [rs.ge](http://eservices.rs.ge) web-services in Ruby.
+
+## Configuration
+
+Configuration is done using `RS.config` object.
+You can predefine `su` and `sp` parameters (*service user* name and password),
+which are required in almost every API call for authentication:
+
+```ruby
+# configure service
+RS.config.su = 'my_service_username'
+RS.config.sp = 'my_service_password'
+```
+
+There is one more option, which can be used for configuration. Namely, `validate_remote` flag,
+which indicates if TIN numbers are validated remotely when a waybill is validated.
+
+```ruby
+# validate remotes (the default is false)
+RS.config.validate_remote = true
+```
+
+It's recommended to have this flag on `true`, unless performance considerations require the oposite.
 
 ## System methods
 
@@ -18,7 +40,7 @@ Before you can work with main API functions, you need to create a special user
 created = RS.sys.create_user(username: 'your_rs.ge_username', password: 'secret', ip: 'access_ip', name: 'name_of_this_user/ip_pair', su: 'new_user', sp: 'new_password'))
 ```
 
-All parameters in the example above are required. The method return `true` if the user creation was successfull.
+All parameters in the example above are required. The method returns `true` if the user creation was successfull.
 
 When you need to update your user (including password change), `update_user` method should be used:
 
@@ -40,4 +62,33 @@ If the username/passowrd pair is correct, the following hash is returned:
 
 where `payer` is the unique ID of the payer, whom this user belongs to, and  `user` gives ID of the user itself.
 
-Payer ID is very important for futher processing.
+## Dictionary Calls
+
+You can get *units* using `units` method on dictionary object:
+
+```ruby
+units = RS.dict.units(su: su, sp: sp) # => returns {id: name} hash of units
+```
+
+*Transport* and *waybill types* can be obtained in the same way:
+
+```ruby
+transport_types = RS.dict.transport_types(su: su, sp: sp) # => {id: name}
+waybill_types   = RS.dict.waybill_types(su: su, sp: sp)   # => {id: name}
+```
+
+It should be noted, that transport and waybill types can be obtained without calling
+those remote method, by simply taking `RS::TRANSPORT_TYPES` and `RS::WAYBILL_TYPES`
+constants. This constants represent the current (relativly unchanged) set of
+transport and waybill types and may be changed by Revenue Service in the future.
+We'll try to update them accordingly, but there is no guarantee on exact match.
+
+The last method of `RS.dict` method is usefull for obtaining name of the
+person/organization by its TIN-number:
+
+```ruby
+name = RS.dict.get_name_from_tin(tin: '02001000490') # => 'დიმიტრი ყურაშვილი'
+```
+
+> Note, that we didn't used `su` and `sp` parameters in the last method call,
+> while we suppose they were predefined in `RS.config` object (see configuration section).

data/lib/rs/version.rb

@@ -1,4 +1,4 @@
 # -*- encoding : utf-8 -*-
 module RS
-  VERSION = '0.1.0.rc1'
+  VERSION = '0.1.0.rc2'
 end

data/rs.gemspec

@@ -19,8 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency 'rspec', '~> 2'
-  s.add_runtime_dependency 'savon', '0.9.9'
-  s.add_runtime_dependency 'httpi'
+  s.add_runtime_dependency 'savon', '~> 1.0'
   s.add_runtime_dependency 'prawn', '~>0.12'
   s.add_runtime_dependency 'c12-commons', '~> 0.0.5'
 end

data/spec/spec_helper.rb

@@ -5,7 +5,9 @@
 require 'savon'
 
 HTTPI.log = false
-Savon.log = false
+Savon.configure do |config|
+  config.log = false
+end
 
 # RSpec
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rs.ge
 version: !ruby/object:Gem::Version
-  version: 0.1.0.rc1
+  version: 0.1.0.rc2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-11 00:00:00.000000000 Z
+date: 2012-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -32,33 +32,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.9.9
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.9.9
-- !ruby/object:Gem::Dependency
-  name: httpi
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: prawn
   requirement: !ruby/object:Gem::Requirement
@@ -140,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: rs
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: rs.ge web services