yandex-api 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yandex-api.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Evgeniy Shurmin
+
+MIT License
+
+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,55 @@
+# Yandex::API
+
+Позволяет работать с сервисами Яндекс доступными через API 
+
+Доступные модули:
+*   Direct - Автоматизация рекламных кампаний в Яндекс.Директе (http://direct.yandex.ru/)
+
+## Установка
+
+Добавить в Gemfile эту строчку:
+
+    gem 'yandex-api'
+
+Выполнить команду:
+
+    $ bundle
+
+Или уставновить через gem:
+
+    $ gem install yandex-api
+
+## в Ruby:
+
+Создать конфигурационный файл yandex_direct.yml
+
+    token: "token"
+    application_id: "id"
+    login: "login"
+    locale: "ru"
+    debug: true
+
+Пример работы с gem-ом:
+
+    require 'yandex-api'
+    Yandex::API::Direct.load "yandex_direct.yml"
+
+	campaign = Yandex::API::Direct::CampaignInfo.list.first
+
+	puts campaign.inspect
+	puts campaign.banners.first.inspect
+
+## в Ruby On Rails:
+
+Создать конфигурационный файл yandex_direct.yml
+
+    development:
+	    token: "token"
+	    application_id: "id"
+	    login: "login"
+	    locale: "ru"
+	    debug: true
+
+Добавить в initializers файл yandex_direct.rb
+
+    Yandex::API::Direct.load File.join(Rails.root,"config","yandex_direct.yml"), Rails.env

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/yandex-api.rb

@@ -0,0 +1,12 @@
+require "yandex-api/version"
+require "yandex-api/direct"
+require "yandex-api/direct/base"
+require "yandex-api/direct/banner_info"
+require "yandex-api/direct/campaign_info"
+
+module Yandex
+  module API
+    class RuntimeError < RuntimeError ; end
+    class NotFound < RuntimeError ; end
+  end
+end

data/lib/yandex-api/direct.rb

@@ -0,0 +1,69 @@
+require 'net/http'
+require 'json'
+require 'yaml'
+require 'uri'
+
+module Yandex
+  module API
+    module Direct
+      URL_API = "https://soap.direct.yandex.ru/json-api/v4/"
+      
+      def self.configuration
+        if defined? @enviroment
+          raise RuntimeError.new("not configured Yandex.Direct for #{@enviroment} enviroment") unless @configuration
+        else
+          raise RuntimeError.new("not configured Yandex.Direct") unless @configuration
+        end
+        @configuration
+      end
+      
+      def self.load file, env = nil
+        @enviroment = env if env
+        config = YAML.load_file(file)
+        @configuration = defined?(@enviroment) ? config[@enviroment] : config
+      end
+      
+      def self.request method, params = {}
+        body = {
+          :locale => configuration["locale"],
+          :login => configuration["login"],
+          :application_id => configuration["application_id"],
+          :token => configuration["token"],
+          :method => method
+        }
+        
+        body.merge!({:param => params}) unless params.empty?
+        url = URI.parse(URL_API)
+
+        if configuration["debug"]
+          puts "\t\033[32mURL: \033[0m#{URL_API}"
+          puts "\t\033[32mMethod: \033[0m#{method}"
+          puts "\t\033[32mParams: \033[0m#{params.inspect}"  
+        end
+
+        http = Net::HTTP.new(url.host, url.port)
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        response = http.post(url.path,JSON.generate(body))
+
+        raise Yandex::API::RuntimeError.new("#{response.code} - #{response.message}") unless response.code.to_i == 200
+
+        json = {}
+        
+        begin
+          json = JSON.parse(response.body)
+        rescue => e
+          raise RuntimeError.new "#{e.message} in response"
+        end
+
+        if json.has_key?("error_code")
+          code = json["error_code"].to_i
+          error = json.has_key?("error_detail") ? json["error_detail"] : json["error_str"]
+          raise RuntimeError.new "#{code} - #{error}"
+        end
+        
+        return json["data"]
+      end
+    end
+  end
+end

data/lib/yandex-api/direct/banner_info.rb

@@ -0,0 +1,83 @@
+#
+# Взаимодействие с API Яндекс.Директа в формате JSON.
+# http://api.yandex.ru/direct/doc/concepts/JSON.xml
+#
+# (c) Copyright 2012 Евгений Шурмин. All Rights Reserved. 
+#
+
+module Yandex::API
+  module Direct
+    #
+    # = PhraseUserParams
+    #
+    class PhraseUserParams < Base
+      direct_attributes :Param1, :Param2
+    end
+    #
+    # = Phrases
+    #
+    class BannerPhraseInfo < Base
+      direct_attributes :PhraseID, :Phrase, :IsRubric, :Price, :AutoBudgetPriority, :ContextPrice, :AutoBroker
+      direct_objects [:UserParams, PhraseUserParams]
+    end
+    
+    #
+    # = Sitelink
+    #
+    class Sitelink < Base
+      direct_attributes :Title, :Href
+    end
+    
+    #
+    # = MapPoint
+    #
+    class MapPoint < Base
+      direct_attributes :x, :y, :x1, :y1, :x2, :y2
+    end
+    
+    #
+    # = ContactInfo
+    #
+    class ContactInfo < Base
+      direct_attributes :CompanyName, :ContactPerson, :Country, :CountryCode, :City, :Street, :House, :Build,
+        :Apart, :CityCode, :Phone, :PhoneExt, :IMClient, :IMLogin, :ExtraMessage, :ContactEmail, :WorkTime, :OGRN
+      direct_objects [:PointOnMap, MapPoint]
+    end
+    
+    #
+    # = Banner
+    #
+    class BannerInfo < Base
+      direct_attributes :BannerID, :CampaignID, :Title, :Text, :Href, :Geo, :MinusKeywords
+      direct_arrays [:Phrases, BannerPhraseInfo], [:Sitelinks, Sitelink]
+      direct_objects [:ContactInfo, ContactInfo]
+      def self.find id
+        result = Direct::request("GetBanners", {:BannerIDS => [id]})
+        raise Yandex::NotFound.new("not found banner where id = #{id}") unless result.any?
+        banner = new(result.first)
+      end
+      def save
+        Direct::request("CreateOrUpdateBanners", [self.to_hash]).first
+      end
+
+      def archive
+        Direct::request("ArchiveBanners", {:CampaignID => self.CampaignID, :BannerIDS => [self.BannerID]})
+      end
+      def unarchive
+        Direct::request("UnArchiveCampaign", {:CampaignID => self.CampaignID, :BannerIDS => [self.BannerID]})
+      end
+      def moderate
+        Direct::request("ModerateBanners", {:CampaignID => self.CampaignID, :BannerIDS => [self.BannerID]})
+      end
+      def resume
+        Direct::request("ResumeBanners", {:CampaignID => self.CampaignID, :BannerIDS => [self.BannerID]})
+      end
+      def stop
+        Direct::request("StopBanners", {:CampaignID => self.CampaignID, :BannerIDS => [self.BannerID]})
+      end
+      def delete
+        Direct::request("DeleteBanners", {:CampaignID => self.CampaignID, :BannerIDS => [self.BannerID]})
+      end
+    end
+  end
+end

data/lib/yandex-api/direct/base.rb

@@ -0,0 +1,69 @@
+module Yandex::API::Direct
+  class Base
+    def self.attributes ; @attributes || [] ; end 
+    def self.direct_attributes *args
+      @attributes = []
+      args.each do |arg|
+        @attributes << arg
+        self.class_eval("def #{arg};@#{arg};end")
+        self.class_eval("def #{arg}=(val);@#{arg}=val;end")          
+      end
+    end
+    def self.objects ; @objects || [] ; end 
+    def self.direct_objects *args
+      @objects = []
+      args.each do |object,type|
+        @objects << [object,type]
+        self.class_eval("def #{object};@#{object};end")
+        self.class_eval("def #{object}=(val);@#{object}=val;end")          
+      end
+    end
+    def self.arrays ; @arrays || [] ; end 
+    def self.direct_arrays *args
+      @arrays = []
+      args.each do |array,type|
+        @arrays << [array,type]
+        self.class_eval("def #{array};@#{array};end")
+        self.class_eval("def #{array}=(val);@#{array}=val;end")          
+      end
+    end
+    def to_hash
+      result = {}
+      # build hash of attributes
+      self.class.attributes.each do |attribute|
+        value = send(attribute)
+        next unless value.present?
+        result[attribute] = value
+      end
+      # build hash of arrays
+      self.class.arrays.each do |array,type|
+        data_array = send(array)|| []
+        next if data_array.empty?
+        result[array] = []
+        data_array.each do |data|
+          result[array] << data.to_hash
+        end
+      end
+      # build hash of objects
+      self.class.objects.each do |object,type|
+        value_hash = send(object).try(:to_hash) || {}
+        next if value_hash.empty?
+        result[object] = value_hash
+      end
+      result
+    end
+    def initialize(params = {})
+      params.each do |key, value|
+        object = self.class.objects.find{|s| s.first.to_sym == key.to_sym}
+        array = self.class.arrays.find{|s| s.first.to_sym == key.to_sym}
+        if object
+          send("#{key}=", object.last.new(value))
+        elsif array
+          send("#{key}=", value.collect {|element| array.last.new(element)})
+        else
+          send("#{key}=", value) if respond_to? "#{key}="
+        end
+      end
+    end
+  end
+end

data/lib/yandex-api/direct/campaign_info.rb

@@ -0,0 +1,92 @@
+#
+# Взаимодействие с API Яндекс.Директа в формате JSON.
+# http://api.yandex.ru/direct/doc/concepts/JSON.xml
+#
+# (c) Copyright 2012 Евгений Шурмин. All Rights Reserved. 
+#
+
+module Yandex::API
+  module Direct
+    #
+    # = CampaignStrategy
+    #
+    class CampaignStrategy < Base
+      direct_attributes :StrategyName, :MaxPrice, :AveragePrice, :WeeklySumLimit, :ClicksPerWeek
+    end
+    
+    #
+    # = SmsNotification
+    #
+    class SmsNotification < Base
+      direct_attributes :MetricaSms, :ModerateResultSms, :MoneyInSms, :MoneyOutSms, :SmsTimeFrom, :SmsTimeTo
+    end
+    
+    #
+    # = EmailNotification
+    #
+    class EmailNotification < Base
+      direct_attributes :Email, :WarnPlaceInterval, :MoneyWarningValue, :SendAccNews, :SendWarn
+    end
+    
+    #
+    # = TimeTargetInfo
+    #
+    class TimeTarget < Base
+      direct_attributes :ShowOnHolidays, :HolidayShowFrom, :HolidayShowTo, :DaysHours, :TimeZone  
+    end
+
+    #
+    # = TimeTargetItem
+    #
+    class TimeTargetItem < Base
+      direct_attributes :Days, :Hours  
+    end
+    #
+    # = CampaignInfo
+    #
+    class CampaignInfo < Base
+      direct_attributes :Login, :CampaignID, :Name, :FIO, :StartDate, :StatusBehavior, :StatusContextStop, :ContextLimit, :ContextLimitSum, :ContextPricePercent,
+              :AutoOptimization, :StatusMetricaControl, :DisabledDomains, :DisabledIps, :StatusOpenStat, :ConsiderTimeTarget, :MinusKeywords, :AddRelevantPhrases,
+              :RelevantPhrasesBudgetLimit
+      direct_objects [:Strategy, CampaignStrategy], [:SmsNotification, SmsNotification], [:EmailNotification, EmailNotification], [:TimeTarget, TimeTarget]
+      
+      def banners
+        banners = []
+        Direct::request("GetBanners", {:CampaignIDS => [self.CampaignID]}).each do |banner|
+          banners << BannerInfo.new(banner)
+        end
+        banners
+      end
+      def save
+        Direct::request("CreateOrUpdateCampaign", self.to_hash)
+      end
+      def archive
+        Direct::request("ArchiveCampaign", {:CampaignID => self.CampaignID})
+      end
+      def unarchive
+        Direct::request("UnArchiveCampaign", {:CampaignID => self.CampaignID})
+      end
+      def resume
+        Direct::request("ResumeCampaign", {:CampaignID => self.CampaignID})
+      end
+      def stop
+        Direct::request("StopCampaign", {:CampaignID => self.CampaignID})
+      end
+      def delete
+        Direct::request("DeleteCampaign", {:CampaignID => self.CampaignID})
+      end
+      def self.find id
+        result = Direct::request("GetCampaignParams", {:CampaignID => id})
+        raise Yandex::NotFound.new("not found campaign where CampaignID = #{id}") if result.empty?
+        new(result)
+      end
+      def self.list
+        campaigs = []
+        Direct::request("GetCampaignsList").each do |campaig|
+          campaigs << new(campaig)
+        end
+        campaigs 
+      end
+    end
+  end
+end

data/lib/yandex-api/version.rb

@@ -0,0 +1,5 @@
+module Yandex
+  module API
+    VERSION = "0.0.2"
+  end
+end

data/yandex-api.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/yandex-api/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Evgeniy Shurmin"]
+  gem.email         = ["eshurmin@gmail.com"]
+  gem.description   = %q{Yandex.API integration}
+  gem.summary       = %q{Yandex.API integration}
+  gem.homepage      = "https://github.com/jpascal/yandex-api"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "yandex-api"
+  gem.require_paths = ["lib"]
+  gem.version       = Yandex::API::VERSION
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: yandex-api
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Evgeniy Shurmin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-08 00:00:00.000000000 Z
+dependencies: []
+description: Yandex.API integration
+email:
+- eshurmin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/yandex-api.rb
+- lib/yandex-api/direct.rb
+- lib/yandex-api/direct/banner_info.rb
+- lib/yandex-api/direct/base.rb
+- lib/yandex-api/direct/campaign_info.rb
+- lib/yandex-api/version.rb
+- yandex-api.gemspec
+homepage: https://github.com/jpascal/yandex-api
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Yandex.API integration
+test_files: []