yandex-webmaster 0.1.1

data/lib/yandex-webmaster/core_ext/nil_class.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+class NilClass
+  def try(*args)
+    nil
+  end
+end

data/lib/yandex-webmaster/core_ext/object.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+class Object
+  def blank?
+    !self     
+  end unless method_defined? :blank?
+
+  def present?
+    !blank?
+  end unless method_defined? :present?
+
+  def try(*a, &b)
+    if a.empty? && block_given?
+      yield self
+    else
+      __send__(*a, &b)
+    end
+  end unless method_defined? :try?
+end

data/lib/yandex-webmaster/core_ext/string.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+class String # :nodoc:
+  def underscore
+    self.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+  end unless method_defined?(:underscore)
+
+  def camelize
+    self.split(/[^a-z0-9]/i).map{|w| w.capitalize}.join
+  end unless method_defined?(:camelize)
+
+  def demodulize
+    if i = self.rindex('::')
+      self[(i+2)..-1]
+    else
+      self
+    end
+  end unless method_defined?(:demodulize)
+end

data/lib/yandex-webmaster/errors.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module Yandex
+  module Webmaster
+    module Errors
+      class WebmasterError < StandardError
+        attr_reader :data
+
+        def initialize(data)
+          @data = data
+          super
+        end
+      end
+
+      class UnauthorizedError      < WebmasterError; end
+      class GeneralError           < WebmasterError; end
+      class AccessDeniedError      < WebmasterError; end
+      class NoTokenError           < WebmasterError; end
+      class NotFoundError          < WebmasterError; end
+      class ResourceError          < WebmasterError; end
+    end
+  end
+end

data/lib/yandex-webmaster/host.rb

@@ -0,0 +1,220 @@
+# encoding: utf-8
+
+require 'forwardable'
+
+module Yandex
+  module Webmaster
+    class Host < Base
+      extend Forwardable
+      
+      define_attributes :as => 'api_attributes' do
+        attr :href, String, :writer => :protected
+        attr :name, String, :writer => :protected
+        attr :virused, Boolean, :writer => :protected
+        attr :last_access, DateTime, :writer => :protected
+        attr :tcy, Integer, :writer => :protected
+
+        attr :url_count, Integer, :writer => :protected
+        attr :url_errors, Integer, :writer => :protected
+
+        attr :index_count, Integer, :writer => :protected
+        attr :last_week_index_urls, Array, :writer => :protected
+
+        attr :internal_links_count, Integer, :writer => :protected
+
+        attr :links_count, Integer, :writer => :protected
+        attr :last_week_links, Array, :writer => :protected
+
+        attr :total_shows_count, Integer, :writer => :protected
+        attr :top_shows_percent, Float, :writer => :protected
+        attr :top_shows, Array, :writer => :protected
+
+        attr :total_clicks_count, Integer, :writer => :protected
+        attr :top_clicks_percent, Float, :writer => :protected
+        attr :top_clicks, Array, :writer => :protected
+
+        attr :verification, Yandex::Webmaster::Hosts::Verification, :writer => :protected
+        attr :crawling, Yandex::Webmaster::Hosts::Crawling, :writer => :protected
+
+        attr :sitemaps, Array, :writer => :protected
+      end
+
+      delegate :verified? => :verification
+
+      def self.create(name, factory)
+        xml = "<host><name>#{name}</name></host>"
+        response = factory.request(:post, '/hosts', xml)
+        if response.status.to_i == 201
+          self.new({
+            :href => response.headers['Location'],
+            :configuration => factory.configuration
+          })          
+        end
+      end
+
+      # Id of the host
+      # @return [Integer]
+      #
+      def id
+        return @id if defined?(@id)
+        @id = self.href.match(/\/(\d+)\z/)[1].to_i
+      end
+
+      # Load information about resources that are available for the host
+      # @return [Hash]
+      # 
+      def resources
+        return @resources if defined?(@resources)
+
+        @resources = self.fetch_value(self.request(:get, self.href), :link).inject({}) do |h, resource|
+          h[resource[:rel].underscore.to_sym] = resource[:href]; h        
+        end
+      end
+
+      # Delete information about the host from Yandex.Webmaster
+      # [RU] http://api.yandex.ru/webmaster/doc/dg/reference/hosts-delete.xml
+      # [EN] http://api.yandex.com/webmaster/doc/dg/reference/hosts-delete.xml
+      # 
+      def delete            
+        response = self.request(:delete, self.href)
+        @deleted = true if response.status.to_i == 204        
+        self
+      end
+
+      # @return [Boolean]
+      # 
+      def deleted?
+        !!@deleted
+      end
+
+      # Load information about verification for the host
+      #
+      def verify(type)
+        self.validate_resource!(:verify_host)
+
+        status = self.verification.run(type)
+        @verification = nil
+
+        status
+      end
+
+      # Information about verification for the host
+      # @return [Yandex::Webmaster::Hosts::Verification]
+      # [RU] http://api.yandex.ru/webmaster/doc/dg/reference/hosts-verify.xml
+      # [EN] http://api.yandex.com/webmaster/doc/dg/reference/hosts-verify.xml
+      def verification(reload = false)
+        self.load_verification if reload || @verification.nil?
+        @verification
+      end
+
+      def load_verification
+        self.validate_resource!(:verify_host)
+
+        self.verification = self.fetch_value(self.request(:get, self.resources[:verify_host]), :verification)
+        self
+      end
+
+      # Load stats for the host
+      # @return [Yandex::Webmaster::Host]
+      # [RU] http://api.yandex.ru/webmaster/doc/dg/reference/hosts-stats.xml
+      # [EN] http://api.yandex.com/webmaster/doc/dg/reference/hosts-stats.xml
+      #
+      def load_stats
+        self.validate_resource!(:host_information)
+
+        self.attributes = self.request(:get, self.resources[:host_information]).body
+        self
+      end
+
+      # Load information about indexed urls for the host
+      # @return [Yandex::Webmaster::Host]
+      # [RU] http://api.yandex.ru/webmaster/doc/dg/reference/hosts-indexed.xml
+      # [EN] http://api.yandex.com/webmaster/doc/dg/reference/hosts-indexed.xml
+      #
+      def load_indexed_urls
+        self.validate_resource!(:indexed_urls)
+
+        self.attributes = self.request(:get, self.resources[:indexed_urls]).body
+        self
+      end
+
+      # Load information about incoming links for the host
+      # @return [Yandex::Webmaster::Host]
+      # [RU] http://api.yandex.ru/webmaster/doc/dg/reference/host-links.xml
+      # [EN] http://api.yandex.com/webmaster/doc/dg/reference/host-links.xml
+      #
+      def load_incoming_links
+        self.validate_resource!(:incoming_links)
+
+        self.attributes = self.request(:get, self.resources[:incoming_links]).body
+        self
+      end
+
+      # Load information about top queries for the host
+      # @return [Yandex::Webmaster::Host]
+      # [RU] http://api.yandex.ru/webmaster/doc/dg/reference/host-tops.xml
+      # [EN] http://api.yandex.com/webmaster/doc/dg/reference/host-tops.xml
+      #
+      def load_top_queries
+        self.validate_resource!(:top_queries)
+
+        self.attributes = self.fetch_value(self.request(:get, self.resources[:top_queries]), :top_queries)
+        self        
+      end
+
+      # Get(load) list of sitemap files for the host
+      # @return [Yandex::Webmaster::Host]
+      # [RU] http://api.yandex.ru/webmaster/doc/dg/reference/sitemaps.xml
+      # [EN] http://api.yandex.com/webmaster/doc/dg/reference/sitemaps.xml
+      #
+      def sitemaps(reload = false)        
+        self.load_sitemaps if reload || @sitemaps.nil?
+        @sitemaps        
+      end
+
+      def load_sitemaps
+        self.validate_resource!(:sitemaps)
+        
+        self.sitemaps = self.fetch_value(self.request(:get, self.resources[:sitemaps]), :sitemap)
+        self
+      end
+
+    protected
+
+      def validate_resource!(resource)
+        unless self.resources.keys.include?(resource)
+          raise Yandex::Webmaster::Errors::ResourceError.new("Resource '#{resource.to_s}' is not available for the host")
+        end
+      end
+
+      def verification=(value)      
+        @verification = value.is_a?(Yandex::Webmaster::Hosts::Verification) ? value : Yandex::Webmaster::Hosts::Verification.new(value)
+        @verification.host = self
+        @verification.configuration = self.configuration
+        @verification
+      end
+
+      def crawling=(value)      
+        @crawling = Yandex::Webmaster::Hosts::Crawling.new(value)
+        @crawling.host = self
+        @crawling.configuration = self.configuration
+        @crawling
+      end
+
+      def top_shows=(value)
+        array = value.is_a?(Hash) ? value[:top_info] : value
+        @top_shows = self.objects_from_array(Yandex::Webmaster::Hosts::TopInfo, array)
+      end
+
+      def top_clicks=(value)
+        array = value.is_a?(Hash) ? value[:top_info] : value
+        @top_clicks = self.objects_from_array(Yandex::Webmaster::Hosts::TopInfo, array)
+      end
+
+      def sitemaps=(value)
+        array = Array.wrap(value).flatten
+        @sitemaps = self.objects_from_array(Yandex::Webmaster::Hosts::Sitemap, array)
+      end
+    end
+  end
+end

data/lib/yandex-webmaster/hosts/crawling.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+module Yandex
+  module Webmaster
+    module Hosts
+      class Crawling < Base
+        STATES = [
+          'indexed',
+          'not_indexed',
+          'waiting'
+        ].freeze
+
+        define_attributes :as => 'api_attributes' do        
+          attr :state, String, :writer => :protected      
+        end
+
+        attr_accessor :host
+
+        def state=(value)
+          value = value.downcase.underscore
+          @state = value if STATES.include?(value)
+        end
+      end
+    end
+  end
+end

data/lib/yandex-webmaster/hosts/sitemap.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+
+module Yandex
+  module Webmaster
+    module Hosts
+      class Sitemap < Base
+        
+        define_attributes :as => 'api_attributes' do                  
+          attr :href, String, :writer => :protected
+
+          attr :latest_info, SitemapInfo, :writer => :protected
+          attr :in_search_info, SitemapInfo, :writer => :protected
+        end
+
+        attr_accessor :host
+
+        def resources
+          @resources ||= {}
+        end
+
+        # Load detailed information about the sitemap
+        # [RU] http://api.yandex.ru/webmaster/doc/dg/reference/sitemap-id.xml
+        # [EN] http://api.yandex.com/webmaster/doc/dg/reference/sitemap-id.xml
+        # 
+        def load_details          
+          self.attributes = self.request(:get, self.href).body
+          self
+        end
+
+        # Delete information about the sitemap from Yandex.Webmaster
+        # [RU] http://api.yandex.ru/webmaster/doc/dg/reference/sitemap-delete.xml
+        # [EN] http://api.yandex.com/webmaster/doc/dg/reference/sitemap-delete.xml
+        # 
+        def delete            
+          response = self.request(:delete, self.href)
+          @deleted = true if response.status.to_i == 204        
+          self
+        end
+
+        # @return [Boolean]
+        # 
+        def deleted?
+          !!@deleted
+        end
+
+      protected
+
+        def link=(value)          
+          raise ArgumentError unless value.is_a?(Array)
+
+          value.each do |link|
+            link[:rel] == 'self' ? self.href = link[:href] : self.resources[link[:rel].underscore.to_sym] = link[:href]
+          end
+        end
+
+        def info=(value)
+          raise ArgumentError unless value.is_a?(Array)
+
+          value.each do |info|
+            if info[:type].present? && self.respond_to?("#{info[:type].downcase.underscore}_info=")
+              self.send("#{info[:type].downcase.underscore}_info=", info.merge({
+                  :host => self.host,
+                  :configuration => self.configuration
+                })
+              )                                          
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/yandex-webmaster/hosts/sitemap_info.rb

@@ -0,0 +1,55 @@
+module Yandex
+  module Webmaster
+    module Hosts
+      class SitemapInfo < Base        
+
+        ADDED_BY = [
+          'user',
+          'robot_txt'          
+        ].freeze
+
+        FORMATS = [
+          'XML',
+          'RSS',
+          'TEXT'
+        ].freeze
+
+        TYPES = [
+          'SITEMAP',
+          'SITEMAPINDX'
+        ].freeze
+
+        define_attributes :as => 'api_attributes' do        
+          attr :url_count, Integer, :writer => :protected
+          attr :url_error_count, Integer, :writer => :protected
+          attr :error_count, Integer, :writer => :protected
+          attr :submitted_on, DateTime, :writer => :protected
+          attr :added_by, Array, :writer => :protected
+          attr :processed_on, DateTime, :writer => :protected
+          attr :real_processed_on, DateTime, :writer => :protected
+          attr :format, String, :writer => :protected
+          attr :type, String, :writer => :protected    
+        end
+
+        attr_accessor :host
+
+      protected
+
+        def added_by=(value)
+          @added_by = Array.wrap(value).flatten.map{ |v| v.downcase.underscore }.select{ |v| ADDED_BY.include?(v) }           
+        end
+
+        def format=(value)
+          value = value.upcase
+          @format = value if FORMATS.include?(value)
+        end
+
+        def type=(value)
+          value = value.upcase
+          @type = value if TYPES.include?(value)
+        end
+ 
+      end
+    end
+  end
+end