yandex-webmaster 0.1.1

data/.document

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

data/Gemfile

@@ -0,0 +1,23 @@
+source "http://rubygems.org"
+
+gem 'faraday'
+gem 'oauth2'
+gem 'libxml-ruby'
+
+group :development do
+  gem "shoulda"
+  gem "rdoc"
+  gem "bundler"
+  gem "jeweler"
+end
+
+group :documentation do
+  gem "yard"
+end
+
+group :test do
+  gem 'vcr'
+  gem 'webmock'
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    yandex-webmaster (0.1.1)
+      faraday
+      libxml-ruby
+      oauth2
+      yandex-webmaster
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    addressable (2.3.4)
+    crack (0.3.2)
+    faraday (0.8.7)
+      multipart-post (~> 1.1)
+    git (1.2.5)
+    httpauth (0.2.0)
+    i18n (0.6.1)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.7)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    libxml-ruby (2.6.0)
+    multi_json (1.7.3)
+    multi_xml (0.5.3)
+    multipart-post (1.2.0)
+    oauth2 (0.9.1)
+      faraday (~> 0.8)
+      httpauth (~> 0.1)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.0.4)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.1)
+    shoulda-matchers (2.1.0)
+      activesupport (>= 3.0.0)
+    vcr (2.4.0)
+    webmock (1.11.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+    yard (0.8.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  faraday
+  jeweler
+  libxml-ruby
+  oauth2
+  rdoc
+  shoulda
+  vcr
+  webmock
+  yandex-webmaster!
+  yard

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Igor Alexandrov
+
+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,259 @@
+[![Dependency Status](https://gemnasium.com/igor-alexandrov/yandex-webmaster.png)](https://gemnasium.com/igor-alexandrov/yandex-webmaster)
+[![Code Climate](https://codeclimate.com/github/igor-alexandrov/yandex-webmaster.png)](https://codeclimate.com/github/igor-alexandrov/yandex-webmaster)
+
+# Yandex::Webmaster
+
+Wrapper for Yandex.Webmaster API. 
+
+**About Yandex.Webmaster**
+
+* [Russian](http://webmaster.yandex.ru/)
+* [English](http://webmaster.yandex.com/)
+
+**API Documentation**
+
+* [Russian](http://api.yandex.ru/webmaster/)
+* [English](http://api.yandex.com/webmaster/)
+
+## Installation
+
+    [sudo] gem install yandex-webmaster
+
+## Usage
+
+### Authentication
+
+Yandex's API uses OAuth for authentication. Luckily, the Yandex::Webmaster gem hides most of the details from you.
+
+If you have never used Webmaster API or you want to change your authentication credentials or your authorization token expired, then you should create new one:
+
+```ruby    
+require 'rubygems'
+require 'yandex-webmaster'
+
+# Get your API credentials at https://oauth.yandex.ru/
+webmaster = Yandex::Webmaster.new(:app_id => 'your_app_id', :app_password => 'your_app_password')
+  => #<Yandex::Webmaster::Client>
+
+# Follow the authorization url, you will be redirected to the callback url, specified in your application settings.
+webmaster.authorize_url
+  => "https://oauth.yandex.ru/authorize?response_type=code&client_id=your_app_id"
+
+# Use authorization code from params to get authorization token
+webmaster.authenticate(params[:code])
+  => #<Yandex::Webmaster::Client>
+
+# If no error is raised then you are free to use any API method
+# Too see what token is now used call for client configuration
+token = webmaster.configuration.oauth_token	
+  => "82af4af2a42e4019bd59a325da0f31d8"
+```
+
+If you want to restore previously used token, it can be easily done too:
+
+```ruby
+require 'rubygems'
+require 'yandex-webmaster'
+
+# get your API credentials at https://oauth.yandex.ru/
+webmaster = Yandex::Webmaster.new(:oauth_token => 'token')
+  => #<Yandex::Webmaster::Client>
+```    
+
+To check whether you client is authenticated or not, use `authenticated?` method.
+
+```ruby
+# We have already initialized client before.
+webmaster.authenticated?
+  => true
+```    
+
+### Operations with the list of sites
+
+**Get list of sites**
+
+Most of Yandex::Webmaster loading methods are lazy, data will be actually loaded only when you really will need it.
+
+```ruby
+webmaster.hosts
+  => #<Yandex::Webmaster::ApiFactory>  
+webmaster.hosts.all  
+  => #<Array[Yandex::Webmaster::Host]>
+# this does not really makes a query to API, list if hosts is cached.
+webmaster.hosts.first  
+  => #<Yandex::Webmaster::Host>
+```   
+
+To reload list of hosts, call `#host` method with explicitly passed `reload` parameter.
+
+```ruby
+# makes call to API and caches list of hosts
+webmaster.hosts(true).all  
+  => #<Array[Yandex::Webmaster::Host]>
+# clears cache and makes call to API again.
+webmaster.hosts(true).first  
+  => #<Yandex::Webmaster::Host>
+```   
+
+**Create site**
+```ruby
+webmaster.hosts.create('hostname')
+  => #<Yandex::Webmaster::Host>
+```   
+
+### Operations with a site
+
+**Getting site resources**
+
+You can easily find out what API methods are available for selected host.
+
+```ruby
+h = webmaster.hosts.last
+  => #<Yandex::Webmaster::Host>
+  
+h.resources
+  => {:host_information => "https://webmaster.yandex.ru/api/v2/hosts/<host_id>/stats", :verify_host => "https://webmaster.yandex.ru/api/v2/hosts/<host_id>/verify" ... :excluded_urls_history => "https://webmaster.yandex.ru/api/v2/hosts/<host_id>/history/excluded-urls"}	  
+```   
+ 
+**Deleting a site**
+
+```ruby
+h = webmaster.hosts.last
+  => #<Yandex::Webmaster::Host>
+  
+h.delete
+  => #<Yandex::Webmaster::Host>
+
+h.deleted?
+  => true  	
+```
+
+### Operations with site statistics
+
+Request refreshes following fields in Host:
+ * `#name`
+ * `#verification`
+ * `#crawling`
+ * `#virused`
+ * `#last_access`
+ * `#tic`
+ * `#url_count`
+ * `#index_count`
+ 
+Also request populates the following fields:
+ * `#url_errors`
+ * `#internal_links_count`
+ * `#links_count`
+
+```ruby
+h = webmaster.hosts.last
+  => #<Yandex::Webmaster::Host>
+
+# Populates host instance with statistics information
+h.load_stats
+  => #<Yandex::Webmaster::Host>
+
+h.url_errors
+  => 379843
+h.internal_links_count
+  => 52367    
+h.links_count
+  => 943
+ ```
+
+### Operations with Sitemap files
+
+**Getting a list of Sitemap files**
+
+```ruby
+# makes call to API and caches list of sitemaps for the host
+webmaster.hosts.first.sitemaps
+  => #<Array[Yandex::Webmaster::Hosts::Sitemap]>
+```
+
+To reload list of sitemaps for the host, call `#host` method with explicitly passed `reload` parameter.
+
+```ruby
+webmaster.hosts.first.sitemaps(true)
+  => #<Array[Yandex::Webmaster::Hosts::Sitemap]>  
+```  
+
+**Getting information about a site's Sitemap file**
+
+To load detailed information about Sitemap file use `#load_details` method.
+
+```ruby
+sitemap = webmaster.hosts.first.sitemaps.first
+  => #<Yandex::Webmaster::Hosts::Sitemap>
+sitemap.load_details
+  => #<Yandex::Webmaster::Hosts::Sitemap>  
+```
+
+When details are loaded you can see Sitemap info.
+
+```ruby
+sitemap.latest_info
+  => #<Yandex::Webmaster::Hosts::SitemapInfo>
+sitemap.in_search_info
+  => #<Yandex::Webmaster::Hosts::SitemapInfo>
+```
+
+**Removing a Sitemap**
+
+```ruby
+sitemap = webmaster.hosts.first.sitemaps.first
+  => #<Yandex::Webmaster::Hosts::Sitemap>
+sitemap.delete
+  => #<Yandex::Webmaster::Host>
+sitemap.deleted?
+  => true  	
+```
+
+
+
+### Operations with site verification
+
+Basic verification information is loaded with Host load.
+
+For verified sites:
+
+```ruby
+h = webmaster.hosts.last
+  => #<Yandex::Webmaster::Host>
+h.verification
+  #<Yandex::Webmaster::Hosts::Verification state: "verified">	
+```  
+
+And for not verified sites:
+
+```ruby
+h = webmaster.hosts.create('http://www.tver.ru')
+h.verification
+ => #<Yandex::Webmaster::Hosts::Verification state: "never_verified">
+```
+
+
+## Note on Patches / Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Credits
+
+![JetRockets](http://www.jetrockets.ru/public/logo.png)
+
+Webmaster is maintained by [JetRockets](http://www.jetrockets.ru/en).
+
+Contributors:
+
+* [Igor Alexandrov](http://igor-alexandrov.github.com/)
+
+## License
+
+It is free software, and may be redistributed under the terms specified in the LICENSE file.

data/Rakefile

@@ -0,0 +1,46 @@
+# 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'
+require './lib/yandex-webmaster/version.rb'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "yandex-webmaster"
+  gem.homepage = "http://github.com/igor-alexandrov/yandex-webmaster"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby wrapper for Yandex.Webmaster API}
+  gem.email = "igor.alexandrov@gmail.com"
+  gem.authors = ["Igor Alexandrov"]
+  gem.version = Yandex::Webmaster::Version::STRING
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :install
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|  
+  version = Yandex::Webmaster::Version::STRING
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "yandex-webmaster #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/yandex-webmaster.rb

@@ -0,0 +1,80 @@
+require 'yandex-webmaster/version'
+require 'yandex-webmaster/configuration'
+require 'yandex-webmaster/errors'
+
+require 'yandex-webmaster/core_ext/array'
+require 'yandex-webmaster/core_ext/class'
+require 'yandex-webmaster/core_ext/date'
+require 'yandex-webmaster/core_ext/date_time'
+require 'yandex-webmaster/core_ext/hash'
+require 'yandex-webmaster/core_ext/nil_class'
+require 'yandex-webmaster/core_ext/object'
+require 'yandex-webmaster/core_ext/string'
+
+
+module Yandex
+  module Webmaster
+    class << self
+      # Alias for Yandex::Webmaster::Client.new
+      #
+      # @return [Yandex::Webmaster::Client]
+      def new(options = {}, &block)
+        Yandex::Webmaster::Client.new(:configuration => options, &block)
+      end
+
+      # Delegate to Yandex::Webmaster::Client
+      #
+      def method_missing(method, *args, &block)
+        return super unless new.respond_to?(method)
+        new.send(method, *args, &block)
+      end
+
+      def respond_to?(method, include_private = false)
+        new.respond_to?(method, include_private) || super(method, include_private)
+      end
+
+      # config/initializers/webmaster.rb (for instance)
+      #
+      # Yandex::Webmaster.configure do |config|
+      #   config.application_id = 'application_id'
+      #   config.application_password = 'application_password'    
+      # end
+      #
+      # elsewhere
+      #
+      # client = Yandex::Webmaster::Client.new
+
+      def configure
+        yield self
+        true
+      end
+    end
+
+    autoload :Base, 'yandex-webmaster/base'
+    autoload :ApiFactory, 'yandex-webmaster/api_factory'
+    autoload :Client, 'yandex-webmaster/client'  
+
+    autoload :Host, 'yandex-webmaster/host'
+    
+    module Hosts
+      autoload :Crawling, 'yandex-webmaster/hosts/crawling'
+      autoload :Sitemap, 'yandex-webmaster/hosts/sitemap'
+      autoload :SitemapInfo, 'yandex-webmaster/hosts/sitemap_info'
+      autoload :TopInfo, 'yandex-webmaster/hosts/top_info'
+      autoload :Verification, 'yandex-webmaster/hosts/verification'
+    end
+
+    module Request
+      autoload :OAuth2, 'yandex-webmaster/request/oauth2'  
+    end
+
+    module Response
+      autoload :Hashify, 'yandex-webmaster/response/hashify'  
+    end
+
+    module Api
+      autoload :AttributesBuilder, 'yandex-webmaster/api/attributes_builder'
+      autoload :Attributes, 'yandex-webmaster/api/attributes' 
+    end
+  end
+end