yandex_uslugi_wrapper 0.1.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+gem "activeresource", ">= 3.0.10"
+
+group :development, :test do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem 'rspec', ">= 2.6.0"
+end

data/Gemfile.lock

@@ -0,0 +1,39 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.1.1)
+      activesupport (= 3.1.1)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activeresource (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+    activesupport (3.1.1)
+      multi_json (~> 1.0)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    i18n (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    multi_json (1.0.3)
+    rake (0.9.2)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.0)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activeresource (>= 3.0.10)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rspec (>= 2.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Idris
+
+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.rdoc

@@ -0,0 +1,55 @@
+= yandex_uslugi_wrapper
+
+Данный Gem является оберткой над {API Яндекс Услуг}[http://api.yandex.ru/uslugi/doc/banks-dg/concepts/about.xml].
+Предоставляет основные функции поиска по id и по параметрам для банковских услуг.
+
+== Зависимости
+* ruby 1.8.7 -p352
+* activeresource (>= 3.0.10), возможно будет работать на ранних версиях
+* rspec 2.7.0 для тестов
+
+== Установка
+  gem install yandex_uslugi_wrapper
+
+== Использование
+  require 'rubygems'
+  require 'yandex_uslugi_wrapper'
+
+  # Задание Api Key и Referer
+  YandexUslugiWrapper.api_key = "YOUR API KEY"
+  YandexUslugiWrapper.referer = "YOUR REFERER"
+
+  # Поиск всех банков из Уфы
+  ufa_banks = YandexUslugiWrapper::Bank.all :region => "Уфа"
+  # Получение первого элемента из массива
+  ufa_bank_first = ufa_banks.first
+  # Вывод имени сайта первого банка
+  puts ufa_bank_first.name #=> Имя первого банка
+  puts ufa_bank_first.link #=> Ссылки для первого банка
+
+
+  # Поиск банка с id = 90 из Уфы
+  id = 90
+  YandexUslugiWrapper::Bank.find id, :region => "Уфа"
+
+  # Возвращает информацию о вкладах, доступных в указанном регионе и соответствующих параметрам запроса
+  YandexUslugiWrapper::Deposit.search :region => "Уфа", :currency => "RUB", :sum => 55555, :period => "3 years"
+
+  # В качестве параметров хэша для метода search можно передать всё то, что указано в документации к API Яндекс Услуг
+  YandexUslugiWrapper::Autocredit.search :region => "Уфа", :currency => "RUB", :sum => 55555, :period => "3 years"
+
+  id = 8230
+  YandexUslugiWrapper::Autocredit.find id
+  YandexUslugiWrapper::Deposit.find id
+
+
+
+== Тестирование:
+
+Необходимо добавить свои Api key и Referer в spec/api_and_referer.rb
+
+== Copyright
+
+Copyright (c) 2011. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "yandex_uslugi_wrapper"
+  gem.homepage = "http://github.com/sld/yandex_uslugi_wrapper"
+  gem.license = "MIT"
+  gem.summary = "Yandex Uslugi Api Wrapper"
+  gem.description = "Yandex Uslugi Api Wrapper on Ruby.\n
+                     More info about Api on http://api.yandex.ru/uslugi/doc/banks-dg/concepts/about.xml"
+  gem.email = "sld7700@gmail.com"
+  gem.authors = ["sld7700"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "yandex_uslugi #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1,2 @@
+0.1.1
+

data/lib/yandex_uslugi_wrapper.rb

@@ -0,0 +1,29 @@
+module YandexUslugiWrapper
+  dir = "yandex_uslugi_wrapper"
+  require "#{dir}/yandex_usluga"
+  require "#{dir}/hash"
+  require "#{dir}/bank"
+  require "#{dir}/bank_product"
+  require "#{dir}/credit"
+  require "#{dir}/deposit"
+  require "#{dir}/mortgage"
+  require "#{dir}/autocredit"
+
+  def self.api_key=(key)
+    YandexUsluga.api_key = key
+  end
+
+  def self.api_key
+    YandexUsluga.api_key
+  end
+
+  def self.referer
+    YandexUsluga.referer
+  end
+
+  def self.referer=(referer_site)
+    YandexUsluga.referer = referer_site
+  end
+
+end
+

data/lib/yandex_uslugi_wrapper/autocredit.rb

@@ -0,0 +1,5 @@
+module YandexUslugiWrapper
+  class Autocredit < BankProduct
+  end
+end
+

data/lib/yandex_uslugi_wrapper/bank.rb

@@ -0,0 +1,32 @@
+module YandexUslugiWrapper
+  # Класс реализует доступ к спискам банков и определенному банку
+  # Запрос осуществляется так:
+  # Для нахождения всех банков из Уфы -- Bank.find :all, :params => {:region => "Уфа"}
+  # Обязательным, при запросе Банков, является использование region
+  class Bank < YandexUsluga
+    # Поиск всех банков из региона
+    # === Example
+    #  Bank.all :region => "Уфа"
+    #  Bank.all :params => { :region => "Уфа" }
+    def self.all region
+      unless region[:params]
+        super :params => region
+      else
+        super
+      end
+    end
+
+    # Поиск банка с определенным id
+    # === Example
+    #  Bank.find 90, :region => "Уфа"
+    #  Bank.find 90, :params => { :region => "Уфа" }
+    def self.find id, region
+      unless region[:params]
+        super id, :params => region
+      else
+        super
+      end
+    end
+  end
+end
+

data/lib/yandex_uslugi_wrapper/bank_product.rb

@@ -0,0 +1,19 @@
+
+module YandexUslugiWrapper
+  # Абстрактный класс который используется только в подклассах, например Autocredit, Deposit ...
+  class BankProduct < YandexUsluga
+    self.prefix += 'banks/'
+
+    # Поиск по банковским продуктам - есть 4 обязательных параметра => :region(Уфа), :currency(RUB),
+    # :sum(3000), :period(5 years) и множество дополнительных
+    # Данный метод можно использовать только в дочерних классах. Т.е по банкам поиска нету
+    def self.search( options = {} )
+      require_options = [options[:region], options[:currency], options[:sum], options[:period]]
+      if require_options.compact.include?(nil) || require_options.compact.empty?
+        puts "Один из обязательных параметров поиска( :region, :currency. :sum, :period ) не задан"
+      end
+      find :all, :from => "#{prefix}#{collection_name}/search", :params => options
+    end
+  end
+end
+

data/lib/yandex_uslugi_wrapper/credit.rb

@@ -0,0 +1,5 @@
+module YandexUslugiWrapper
+  class Credit < BankProduct
+  end
+end
+

data/lib/yandex_uslugi_wrapper/deposit.rb

@@ -0,0 +1,6 @@
+module YandexUslugiWrapper
+  # Класс реализует работу с вкладами Яндекс Услуг
+  class Deposit < BankProduct
+  end
+end
+

data/lib/yandex_uslugi_wrapper/hash.rb

@@ -0,0 +1,18 @@
+# Evil hack для исправления ошибки с `collect!
+# Ошибка возникает при вызове Bank.all, search
+# https://github.com/rails/rails/issues/2318
+class Hash
+  def collect!(&block)
+    ret = []
+    self.each {|key,val|
+      if val.kind_of? Array
+        val.collect!{|subval|
+          block.call subval
+        }
+        ret = val
+      end
+    }
+    return ret
+  end
+end
+

data/lib/yandex_uslugi_wrapper/mortgage.rb

@@ -0,0 +1,5 @@
+module YandexUslugiWrapper
+  class Mortgage < BankProduct
+  end
+end
+

data/lib/yandex_uslugi_wrapper/yandex_usluga.rb

@@ -0,0 +1,77 @@
+require 'active_resource'
+require 'yandex_uslugi_wrapper/hash'
+
+module YandexUslugiWrapper
+  # Класс является базовым для Яндекс Услуг
+  # Здесь задаются api ключ, основной url для запроса, referer
+  # Также реализуется наследование headers и методы генерирующие url
+  class YandexUsluga < ActiveResource::Base
+    API_SITE = URI::parse("http://api.uslugi.yandex.ru")
+    API_PREFIX = "/1.0/"
+
+    self.site = API_SITE
+    self.prefix = API_PREFIX
+    self.format = :xml
+
+    # Задание Api key и Referer'a. Необходимы для работы с Яндекс Услугами
+    @@api_key = ""
+    @@referer = ""
+
+    class << self
+      # Если headers не заданы в подклассе, то назначаем ему
+      # headers суперкласса
+      def headers
+        if defined?(@headers)
+          @headers
+        elsif superclass != Object && superclass.headers
+          superclass.headers
+        else
+          @headers ||= {}
+        end
+      end
+
+      def api_key
+        @@api_key
+      end
+
+      def api_key=(key)
+        @@api_key = key
+        use_api_key
+      end
+
+      def referer
+        @@referer
+      end
+
+      def referer=(referer_site)
+        @@referer = referer_site
+        use_referer_site
+      end
+
+      # Метод генерирует url для элемента, например /banks/{id}
+      # Удаляем из стандратного метода .#{format.extension}, чтобы в конце запроса не было .xml
+      def element_path(id, prefix_options = {}, query_options = nil)
+        prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+        "#{prefix(prefix_options)}#{collection_name}/#{id}#{query_string(query_options)}"
+      end
+
+      # Метод генерирует url для коллекции, например /banks
+      # Также удаляем .#{format.extension}
+      def collection_path(prefix_options = {}, query_options = nil)
+        prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+        "#{prefix(prefix_options)}#{collection_name}#{query_string(query_options)}"
+      end
+
+    end
+
+    private
+      def self.use_api_key
+        self.headers['Authorization'] = @@api_key
+      end
+
+      def self.use_referer_site
+        self.headers['Referer'] = @@referer
+      end
+  end
+end
+

data/spec/model/yandex_uslugi_api_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe "Yandex uslugi api base" do
+  it "should return that referer header is equal to setted referer" do
+    YandexUsluga.referer = REFERER
+    YandexUsluga.headers['Referer'].should == REFERER
+  end
+
+  it "should return some generated url with the api_key" do
+    pending
+  end
+
+  it "should set referer and api key and check his work in descendent class " do
+    referer_site = REFERER
+    api_key = API_KEY
+    YandexUsluga.referer = referer_site
+    YandexUsluga.api_key = api_key
+    YandexUsluga.headers['Authorization'].should == YandexUsluga.api_key
+    YandexUsluga.headers['Referer'].should == YandexUsluga.referer
+    YandexUsluga.headers['Authorization'].should == api_key
+    YandexUsluga.headers['Referer'].should == referer_site
+    Deposit.headers['Authorization'].should == YandexUsluga.api_key
+  end
+end
+

data/spec/model/yandex_uslugi_bank_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe "Yandex uslugi bank spec" do
+  before( :each ) do
+    @required_search_options = {:region => "Уфа", :currency => "RUB", :sum => 55555, :period => "3 years"}
+    YandexUslugiWrapper.api_key = API_KEY
+    YandexUslugiWrapper.referer = REFERER
+  end
+
+  it "should return that the yandex uslugi api header is equal to the bank header" do
+    Bank.headers.should == YandexUsluga.headers
+  end
+
+  it "should find some banks in the region Уфа" do
+    Bank.find :all, :params => {:region => "Уфа"}
+  end
+
+  it "should return bank with id = 99 in region Уфа" do
+    Bank.find 90, :params => {:region => "Уфа"}
+  end
+
+  it "should find all with redefined find function" do
+     Bank.all :region => "Уфа"
+  end
+
+  it "should find one bank with redefined find function" do
+    Bank.find 90, :region => "Уфа"
+  end
+
+  it "should succesfully return the deposit with id = 30470 for bank" do
+    Deposit.find 30470
+  end
+
+  it "should search some deposits with some required params" do
+    Deposit.search @required_search_options
+  end
+
+  it "should search some autocredits" do
+    sleep(1)
+    Autocredit.search @required_search_options
+  end
+
+  it "should search some mortgages" do
+    Mortgage.search @required_search_options
+  end
+
+  it "should search some credits" do
+    Credit.search @required_search_options
+  end
+
+end
+

data/spec/model/yandex_uslugi_wrapper_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe "Yandex uslugi wrapper test" do
+  before( :each ) do
+    @required_search_options = {:region => "Уфа", :currency => "RUB", :sum => 55555, :period => "3 years"}
+    YandexUslugiWrapper.api_key = API_KEY
+    YandexUslugiWrapper.referer = REFERER
+  end
+
+  it "should return the bank from the yandex_uslugi_wrapper" do
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'yandex_uslugi_wrapper'
+require 'api_and_referer'
+
+include YandexUslugiWrapper
+

data/yandex_uslugi_wrapper.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "yandex_uslugi_wrapper"
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["sld7700"]
+  s.date = "2011-10-25"
+  s.description = "Yandex Uslugi Api Wrapper on Ruby.\n\n                     More info about Api on http://api.yandex.ru/uslugi/doc/banks-dg/concepts/about.xml"
+  s.email = "sld7700@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/yandex_uslugi_wrapper.rb",
+    "lib/yandex_uslugi_wrapper/autocredit.rb",
+    "lib/yandex_uslugi_wrapper/bank.rb",
+    "lib/yandex_uslugi_wrapper/bank_product.rb",
+    "lib/yandex_uslugi_wrapper/credit.rb",
+    "lib/yandex_uslugi_wrapper/deposit.rb",
+    "lib/yandex_uslugi_wrapper/hash.rb",
+    "lib/yandex_uslugi_wrapper/mortgage.rb",
+    "lib/yandex_uslugi_wrapper/yandex_usluga.rb",
+    "spec/model/yandex_uslugi_api_spec.rb",
+    "spec/model/yandex_uslugi_bank_spec.rb",
+    "spec/model/yandex_uslugi_wrapper_spec.rb",
+    "spec/spec_helper.rb",
+    "yandex_uslugi_wrapper.gemspec"
+  ]
+  s.homepage = "http://github.com/sld/yandex_uslugi_wrapper"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Yandex Uslugi Api Wrapper"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activeresource>, [">= 3.0.10"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rspec>, [">= 2.6.0"])
+    else
+      s.add_dependency(%q<activeresource>, [">= 3.0.10"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rspec>, [">= 2.6.0"])
+    end
+  else
+    s.add_dependency(%q<activeresource>, [">= 3.0.10"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rspec>, [">= 2.6.0"])
+  end
+end
+

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification 
+name: yandex_uslugi_wrapper
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- sld7700
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-25 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 3
+        - 0
+        - 10
+        version: 3.0.10
+  version_requirements: *id001
+  name: activeresource
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  version_requirements: *id002
+  name: bundler
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  version_requirements: *id003
+  name: jeweler
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  version_requirements: *id004
+  name: rspec
+  prerelease: false
+  type: :development
+description: |-
+  Yandex Uslugi Api Wrapper on Ruby.
+  
+                       More info about Api on http://api.yandex.ru/uslugi/doc/banks-dg/concepts/about.xml
+email: sld7700@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/yandex_uslugi_wrapper.rb
+- lib/yandex_uslugi_wrapper/autocredit.rb
+- lib/yandex_uslugi_wrapper/bank.rb
+- lib/yandex_uslugi_wrapper/bank_product.rb
+- lib/yandex_uslugi_wrapper/credit.rb
+- lib/yandex_uslugi_wrapper/deposit.rb
+- lib/yandex_uslugi_wrapper/hash.rb
+- lib/yandex_uslugi_wrapper/mortgage.rb
+- lib/yandex_uslugi_wrapper/yandex_usluga.rb
+- spec/model/yandex_uslugi_api_spec.rb
+- spec/model/yandex_uslugi_bank_spec.rb
+- spec/model/yandex_uslugi_wrapper_spec.rb
+- spec/spec_helper.rb
+- yandex_uslugi_wrapper.gemspec
+homepage: http://github.com/sld/yandex_uslugi_wrapper
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Yandex Uslugi Api Wrapper
+test_files: []
+