webmaster 0.1.0

data/lib/webmaster/core_ext/string.rb

@@ -0,0 +1,9 @@
+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)
+end

data/lib/webmaster/errors.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+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

data/lib/webmaster/host.rb

@@ -0,0 +1,154 @@
+# encoding: utf-8
+
+require 'forwardable'
+
+module Webmaster
+  class Host < Base
+    extend Forwardable
+    include Virtus
+
+    attribute :href, String
+    attribute :name, String
+    attribute :virused, Boolean
+    attribute :last_access, DateTime
+    attribute :tcy, Integer
+
+    attribute :url_count, Integer
+    attribute :url_errors, Integer
+
+    attribute :index_count, Integer
+    attribute :last_week_index_urls, Array
+
+    attribute :internal_links_count, Integer
+    
+    attribute :links_count, Integer
+    attribute :last_week_links, Array
+
+    attr_reader :crawling
+
+    delegate :verified? => :verification
+
+    # 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.Market
+    # [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
+      @deleted = true if response.status.to_i == 405
+      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 [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)
+      @verification = nil if reload
+
+      if @verification.nil?        
+        self.validate_resource!(:verify_host)
+        self.verification = self.fetch_value(self.request(:get, self.resources[:verify_host]), :verification)
+      end
+
+      @verification
+    end
+
+    # Load stats for the host
+    # @return [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 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 [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 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 [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 incoming_links
+      self.validate_resource!(:incoming_links)
+
+      self.attributes = self.request(:get, self.resources[:incoming_links]).body
+      self
+    end
+
+  protected
+
+    def validate_resource!(resource)
+      unless self.resources.keys.include?(resource)
+        raise Webmaster::Errors::ResourceError.new("Resource '#{resource.to_s}' is not available for the host")
+      end
+    end
+
+  private
+
+    def verification=(value)      
+      @verification = value.is_a?(Webmaster::Hosts::Verification) ? value : Webmaster::Hosts::Verification.new(value)
+      @verification.host = self
+      @verification.configuration = self.configuration
+      @verification
+    end
+
+    def crawling=(value)      
+      @crawling = Webmaster::Hosts::Crawling.new(value)
+      @crawling.host = self
+      @crawling.configuration = self.configuration
+      @crawling
+    end
+
+  end
+end

data/lib/webmaster/hosts/crawling.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+module Webmaster
+  module Hosts
+    class Crawling < Base
+      include Virtus
+
+      STATES = [
+        'indexed',
+        'not_indexed',
+        'waiting'
+      ].freeze
+
+      attribute :state, String
+
+      attr_accessor :host
+
+      def state=(value)
+        value = value.downcase.underscore
+        @state = value if STATES.include?(value)
+      end
+    end
+  end
+end

data/lib/webmaster/hosts/verification.rb

@@ -0,0 +1,77 @@
+# encoding: utf-8
+
+require 'xml/libxml'
+
+module Webmaster
+  module Hosts
+    class Verification < Base
+      include Virtus
+
+      STATES = [
+        'in_progress',
+        'never_verified',
+        'verification_failed',
+        'verified',
+        'waiting'
+      ].freeze
+
+      CHECKABLE_TYPES = [        
+        'dns_record',
+        'html_file',        
+        'meta_tag',        
+        'txt_file',
+        'whois'
+      ].freeze
+
+      NON_CHECKABLE_TYPES = [
+        'auto',
+        'manual',        
+        'pdd',        
+        'pdd_external',
+        'delegation'        
+      ].freeze
+
+      TYPES = (CHECKABLE_TYPES + NON_CHECKABLE_TYPES).flatten.freeze
+
+      attribute :state, String
+      attribute :type, String
+      
+      attribute :possible_to_cancel, Boolean
+      attribute :date, Date
+      attribute :uin, String
+
+      attr_accessor :host
+
+      def initialize(attributes = {})
+        super(attributes)
+
+        self.state ||= 'never_verified'
+      end
+
+      # @return [Boolean]
+      # 
+      def verified?
+        self.state == 'verified'
+      end
+
+      def run(type)
+        raise ArgumentError if !CHECKABLE_TYPES.include?(type.underscore.downcase)
+
+        # data = XML::Document.string("<host><type>#{type.underscore.upcase}</type></host>").to_s
+        data = "<host><type>#{type.underscore.upcase}</type></host>"
+        response = self.request(:put, self.host.resources[:verify_host], :data => data)
+        # return true if response.status.to_i == 204
+      end
+
+      def state=(value)
+        value = value.downcase.underscore
+        @state = value if STATES.include?(value)
+      end
+
+      def type=(value)
+        value = value.downcase.underscore
+        @type = value if TYPES.include?(value)
+      end
+    end
+  end
+end

data/lib/webmaster/request/oauth2.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+require 'faraday'
+
+module Webmaster
+  module Request
+    class OAuth2 < Faraday::Middleware
+      
+      AUTH_HEADER = 'Authorization'.freeze
+
+      dependency 'oauth2'
+
+      def call(env)
+        env[:request_headers].merge!(AUTH_HEADER => "OAuth #{@token}") if @token.present?
+
+        @app.call env
+      end
+
+      def initialize(app, *args)
+        super app
+        @app = app
+        @token = args.shift
+      end
+    end
+  end
+end

data/lib/webmaster/response/hashify.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+require 'faraday'
+require 'xml/libxml'
+
+module Webmaster
+  class Response::Hashify < Faraday::Response::Middleware
+    def parse(body)      
+      self.from_xml(body) if body.present?
+    end
+
+    def from_xml(xml, strict = true) 
+      begin
+        XML.default_load_external_dtd = false
+        XML.default_pedantic_parser = strict
+        result = XML::Parser.string(xml).parse 
+        return xml_node_to_hash(result.root)
+      rescue Exception => e
+        # raise custom exception here      
+      end 
+    end
+
+    def xml_node_to_hash(node)             
+      if node.element? 
+        if node.children? || node.attributes?
+          result_hash = {} 
+
+          node.each_child do |child| 
+            result = xml_node_to_hash(child) 
+
+            if child.name == "text"
+              if !child.next? and !child.prev?
+                return result
+              end
+            elsif result_hash[child.name.underscore.to_sym]
+              if result_hash[child.name.underscore.to_sym].is_a?(Object::Array)
+                result_hash[child.name.underscore.to_sym] << result
+              else
+                result_hash[child.name.underscore.to_sym] = [result_hash[child.name.to_sym]] << result
+              end
+            else 
+              result_hash[child.name.underscore.to_sym] = result
+            end
+          end
+
+          node.each_attr do |attr|
+            result_hash[attr.name.underscore.to_sym] = attr.value
+          end
+
+          return result_hash 
+        else 
+          return nil 
+        end 
+      else 
+        return node.content.to_s 
+      end 
+    end
+  end
+end

data/lib/webmaster/version.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module Webmaster
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    BUILD = nil
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+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 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'webmaster'
+
+class Test::Unit::TestCase
+end

data/test/test_webmaster.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestWebmaster < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/webmaster.gemspec

@@ -0,0 +1,196 @@
+# 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 = "webmaster"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Igor Alexandrov"]
+  s.date = "2013-04-29"
+  s.email = "igor.alexandrov@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "lib/webmaster.rb",
+    "lib/webmaster/api/authorization.rb",
+    "lib/webmaster/api/connection.rb",
+    "lib/webmaster/api/request.rb",
+    "lib/webmaster/base.rb",
+    "lib/webmaster/client.rb",
+    "lib/webmaster/configuration.rb",
+    "lib/webmaster/core_ext/hash.rb",
+    "lib/webmaster/core_ext/object.rb",
+    "lib/webmaster/core_ext/string.rb",
+    "lib/webmaster/errors.rb",
+    "lib/webmaster/host.rb",
+    "lib/webmaster/hosts/crawling.rb",
+    "lib/webmaster/hosts/verification.rb",
+    "lib/webmaster/request/oauth2.rb",
+    "lib/webmaster/response/hashify.rb",
+    "lib/webmaster/version.rb",
+    "test/helper.rb",
+    "test/test_webmaster.rb",
+    "webmaster.gemspec"
+  ]
+  s.homepage = "http://github.com/igor-alexandrov/webmaster"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Ruby wrapper for Yandex.Webmaster API"
+
+  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<faraday>, [">= 0"])
+      s.add_runtime_dependency(%q<oauth2>, [">= 0"])
+      s.add_runtime_dependency(%q<libxml-ruby>, [">= 0"])
+      s.add_runtime_dependency(%q<virtus>, [">= 0"])
+      s.add_runtime_dependency(%q<webmaster>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<faraday>, [">= 0"])
+      s.add_dependency(%q<oauth2>, [">= 0"])
+      s.add_dependency(%q<libxml-ruby>, [">= 0"])
+      s.add_dependency(%q<virtus>, [">= 0"])
+      s.add_dependency(%q<webmaster>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<faraday>, [">= 0"])
+    s.add_dependency(%q<oauth2>, [">= 0"])
+    s.add_dependency(%q<libxml-ruby>, [">= 0"])
+    s.add_dependency(%q<virtus>, [">= 0"])
+    s.add_dependency(%q<webmaster>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+