Project

yandex_xml

0.0
No commit activity in last 3 years
No release in over 3 years
Get data from Yandex.XML service by XML
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies
 Project Readme

gem 'yandex_xml'

Get data from Yandex.XML service by XML

Yandex.XML service: https://xml.yandex.ru/settings/

Installation

Add this line to your application's Gemfile:

gem 'yandex_xml'

And then execute:

$ bundle

Or install it yourself as:

gem install yandex_xml

Usage

YandexXml has settings: user, key, region, keyword

Usage 1: Get data from Yandex.XML and create Hash with result

Method: get(keyword)

require 'yandex_xml'

parser = YandexXml.new(user: 'your_yandex_login',
  key: 'your_yandex_xml_key',
  region: 'your_yandex_region')

p parser.get('ruby on rails')
# => Hash with data

Results has data:

  • position,
  • url,
  • domain:,
  • title,
  • modtime,
  • size,
  • charset,
  • passage, # TODO: not work
  • passages_type,
  • mime_type,
  • saved_copy_url,
  • headline,
  • turbo_cgi_url,
  • turbo_fallback,
  • turbo_link

Usage 2: Get 100 urls (Yandex Top-100) from result

Method: get_top100_urls(keyword)

require 'yandex_xml'

parser = YandexXml.new(user: 'your_yandex_login',
  key: 'your_yandex_xml_key',
  region: 'your_yandex_region')

p parser.get_top100_urls('ruby')
# => Array with urls

Results has data: Array with URLs

Usage 3: Get position in Yandex Top-100 for site by keyword

Method: get_position(keyword, my_domain)

require 'yandex_xml'

parser = YandexXml.new(user: 'your_yandex_login',
  key: 'your_yandex_xml_key',
  region: 'your_yandex_region')

p parser.get_position('ruby on rails', 'rusrails.ru')
# => Position number or 0 if site not found in TOP-100 (Integer)

Results has data: Position number or 0 if site not found in TOP-100 (Integer)

Links and how get real data

Real data for your_yandex_login and your_yandex_xml_key remove and add from page https://xml.yandex.ru/settings/

Yandex regions: https://tech.yandex.ru/xml/doc/dg/reference/regions-docpage/