ya-api-direct 0.2.5 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dc5086aa88e50438f6a110d4c2cffdc090a5b3d6
-  data.tar.gz: b97cce9be358c5936070625f8a3c0662b0ecd42f
+SHA256:
+  metadata.gz: c3834e0a678f9eb91e7523dbca830f99d72660940079dfcc9340082d64ab2ec7
+  data.tar.gz: bf72e62469f98178a4a1ee62fe1c27849d8f23826db06c07354b87aaec6c9b47
 SHA512:
-  metadata.gz: 933afe225577e340ef49b21e6d47f94b3b6965c799bb3932c48196b1683407488e4fc11bedb967cb9c6a3bd12be90ad216150f252514b886e6d7952c721552bf
-  data.tar.gz: 2a7e97c13b7b0f046ba061b8dced54eec9c7539904f88a285d0e276ab75c102c1300c45146df2439eccd4dd8d06c371ca9bfc8896a217537c99d3778a35f5ec8
+  metadata.gz: fbd2d4b2b37ef73cf0b8269de00dd00a91b289948dea5285ca43172a26e5a3570664aa78b907f985c75962e617f6c5e08dd6812492ad261506e49e53151f9e45
+  data.tar.gz: c56f376feb05d6b7ccdc3d5d54e78e46773ba8defa047484a6a82b860bcfd7d184672c46a34b636527b13854087ec20da0f239de0956f31c2024b8ce7bf422d6

data/Gemfile

@@ -1,8 +1,9 @@
 source 'https://rubygems.org'
 
 gem 'jruby-openssl', platforms: :jruby
-gem 'rake'
+gem 'rake', '>= 12.3.3'
 gem 'yard'
+#gem 'tsv'
 
 group :development do
 	# reserved
@@ -15,4 +16,4 @@ group :test do
   gem 'yardstick'
 end
 
-gemspec
+gemspec

data/README.md

@@ -36,14 +36,14 @@ request = {
 
 options = { token: Token }
 @direct = Ya::API::Direct::Client.new(options)
-json = direct.campaigns.get request
+json = @direct.campaigns.get request
 ```
 
 Call methods from versions 4 and 4 Live:
 
 ```ruby
 @direct = Ya::API::Direct::Client.new({ token: Token })
-json = direct.v4.GetCampaignsList
+json = @direct.v4.GetCampaignsList
 ```
 
 All names of controllers and methods are equal to ones from Direct API help. 4 vs 4 Live is autodetected.

data/lib/ya/api/direct/client.rb

@@ -2,7 +2,7 @@ require "ya/api/direct/constants"
 require "ya/api/direct/gateway"
 require "ya/api/direct/direct_service_v4"
 require "ya/api/direct/direct_service_v5"
-require "ya/api/direct/exception"
+require "ya/api/direct/exceptions"
 
 require 'time'
 
@@ -14,7 +14,7 @@ module Ya::API::Direct
   class Client
     attr_reader :cache_timestamp, :units_data, :gateway,
                 :v4, :v5
-    
+
     # Initializes a new Client object
     #
     # @param config [Hash]
@@ -75,7 +75,7 @@ module Ya::API::Direct
     end
 
     private
-    
+
     def init_v4
       @v4 = DirectServiceV4.new self, (API_V4 + API_V4_LIVE)
     end
@@ -90,4 +90,4 @@ module Ya::API::Direct
       end
     end
   end
-end
+end

data/lib/ya/api/direct/constants.rb

@@ -2,44 +2,90 @@ module Ya
   module API
     module Direct
       API_V5 = {
-        "Campaigns" => [
-          "add", "update", "delete", "suspend", "resume", "archive", "unarchive", "get"
-        ],
         "AdGroups" => [
-        "add", "update", "delete", "get"
+           "add", "update", "delete", "get"
+        ],
+        "AgencyClients" => [
+           "add", "update", "get"
         ],
         "Ads" => [
           "add", "update", "delete", "suspend", "resume", "archive", "unarchive", "moderate", "get"
         ],
+        "AdExtensions" => [
+          "add", "delete", "get"
+        ],
+        "AdImages" => [
+          "add", "delete", "get"
+        ],
+        "AudienceTargets" => [
+          "add", "delete", "suspend", "resume", "get", "setBids"
+        ],
         "Bids" => [
           "set", "setAuto", "get"
         ],
         "BidModifiers" => [
-            "add", "delete", "get", "set", "toggle"
-          ],
+          "add", "delete", "get", "set", "toggle"
+        ],
+        "Businesses" => [
+          "get"
+        ],
         "Campaigns" => [
             "add", "update", "delete", "suspend", "resume", "archive", "unarchive", "get"
-          ],
+        ],
         "Changes" => [
             "checkDictionaries", "checkCampaigns", "check"
-          ],
+        ],
+        "Clients" => [
+          "get", "update"
+        ],
+        "Creatives" => [
+          "get"
+        ],
         "Dictionaries" => [
-            "get"
+          "get"
+        ],
+        "DynamicFeedAdTargets" => [
+          "add", "delete", "suspend", "resume", "get", "setBids"
         ],
         "DynamicTextAdTargets" => [
           "add", "delete", "suspend", "resume", "get", "setBids"
         ],
+        "Feeds" => [
+          "add", "delete", "get", "update"
+        ],
         "Keywords" => [
           "add", "update", "delete", "suspend", "resume", "get"
         ],
+        "KeywordBids" => [
+          "set", "setAuto", "get"
+        ],
+        "KeywordsResearch" => [
+          "hasSearchVolume", "deduplicate"
+        ],
+        "Leads" => [
+          "get"
+        ],
+        "NegativeKeywordSharedSets" => [
+          "add", "update", "delete", "get"
+        ],
+        "RetargetingLists" => [
+          "add", "update", "delete", "get"
+        ],
         "Sitelinks" => [
           "add", "get", "delete"
         ],
+        "SmartAdTargets" => [
+          "add", "update", "setBids", "delete", "suspend", "resume", "get"
+        ],
+        "TurboPages" => [
+          "get"
+        ],
         "VCards" => [
           "add", "get", "delete"
-        ]
+        ],
+        "Reports" => ["get"]
       }
-      
+
       API_V4 = [
         "GetBalance",
         "GetSummaryStat",
@@ -68,7 +114,7 @@ module Ya
         "GetSubClients",
         "GetClientInfo",
         "UpdateClientInfo",
-        
+
         "CreateNewSubclient",
         "GetClientsList",
 
@@ -86,6 +132,7 @@ module Ya
       API_V4_LIVE = [
         "CreateOrUpdateCampaign",
         "GetCampaignsList",
+        "GetSummaryStat",
         "GetCampaignsListFilter",
         "GetCampaignsParams",
         "DeleteCampaign",
@@ -133,4 +180,4 @@ module Ya
       ]
     end
   end
-end
+end

data/lib/ya/api/direct/exceptions.rb

@@ -0,0 +1,33 @@
+require "ya/api/direct/constants"
+
+module Ya::API::Direct
+  class Exception < StandardError
+    attr_reader :error
+
+    def initialize( error )
+      @error = error
+    end
+
+    def to_s
+      [ @error['error_code'], @error['error_string'], @error['error_detail'], @error['request_id'] ].join(' : ')
+    end
+  end
+
+  class RequestError < StandardError
+    attr_reader :method, :version, :request, :response
+
+    def initialize( method: , version: , request: , response: )
+      @method = method
+      @version = version
+      @request = request
+      @response = response
+    end
+
+    def to_s
+      if response.body && ['text/json', 'application/json'].include?( response["Content-Type"] ) && error = JSON.parse( response.body )['error']
+        err_msg = error.values_at('error_code', 'error_string', 'error_detail', 'request_id').reject(&:blank?).join(' : ')
+      end
+      [ ['HTTP ', response.code].join, err_msg ].compact.join(': ')
+    end
+  end
+end

data/lib/ya/api/direct/gateway.rb

@@ -4,10 +4,11 @@ require "json"
 
 require "ya/api/direct/constants"
 require "ya/api/direct/url_helper"
+require "ya/api/direct/exceptions"
 
 module Ya::API::Direct
   class Gateway
-    attr_reader :config
+    attr_reader :config, :response
     def initialize(config)
       @config = config
     end
@@ -23,11 +24,25 @@ module Ya::API::Direct
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
       http.verify_mode = @config[:ssl] ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE
-      response = http.request(request)
+
+      begin
+        response = http.request(request)
+        if (response.kind_of? Net::HTTPCreated) || (response.kind_of? Net::HTTPAccepted)
+          sleep response['retryIn'].to_i
+        end
+      end while(response.kind_of? Net::HTTPCreated) || (response.kind_of? Net::HTTPAccepted)
+
+      @response = response
+
       if response.kind_of? Net::HTTPSuccess
         UrlHelper.parse_data response, ver
       else
-        raise response.inspect
+        raise RequestError.new(
+          method: method,
+          version: ver,
+          request: request,
+          response: response
+        )
       end
     end
 
@@ -43,9 +58,10 @@ module Ya::API::Direct
     end
 
     def generate_body(method, params, ver)
+      params_key = [:v4, :v4live].include?(ver) ?  'param' : 'params'
       body = {
-          "method" => method,
-          "params" => params
+          'method' => method,
+          params_key => params
         }
       if [:v4, :v4live].include? ver
         body.merge!({
@@ -56,4 +72,4 @@ module Ya::API::Direct
       body
     end
   end
-end
+end

data/lib/ya/api/direct/url_helper.rb

@@ -1,6 +1,7 @@
 require "json"
 
-require "ya/api/direct/exception"
+require "ya/api/direct/exceptions"
+
 
 module Ya::API::Direct
   RegExUnits = Regexp.new /(\d+)\/(\d+)\/(\d+)/
@@ -9,7 +10,7 @@ module Ya::API::Direct
   # @author Rikki Mongoose
 	class UrlHelper
       # Generate Yandex Direct API url for a call
-      # 
+      #
       # @param mode [Symbol] Direct API mode, `:sandbox` or `:production`
       # @param mode [Symbol] Direct API version, `:v5` or `:v4` or `:v4live`
       # @param mode [Symbol] Direct API service to use
@@ -45,10 +46,11 @@ module Ya::API::Direct
           site: site,
           service: service
         }
+
   	end
 
     # Extract Yandex Direct API units values from responce HTTP header
-    # 
+    #
     # @param responce_header [Hash] Yandex Direct API response header
     # @return [Hash] Units data, extracted from header
     def self.extract_response_units(response_header)
@@ -64,20 +66,38 @@ module Ya::API::Direct
     private
 
     def self.parse_data(response, ver)
-      response_body = JSON.parse(response.body)
-      validate_response! response_body
-      result = { data: response_body }
-      if [:v5].include? ver
-        result.merge!({ units_data: self.extract_response_units(response) })
+      if response["Content-Type"].start_with?("application/json")
+        response_body = JSON.parse(response.body)
+        validate_response! response_body
+        result = { data: response_body }
+        if [:v5].include? ver
+          result.merge!({ units_data: self.extract_response_units(response) })
+        end
+        result
+      else
+        {data: from_tsv_to_json(response.body)}
       end
-      result
     end
 
     def self.validate_response!(response_body)
       if response_body.has_key? 'error'
-        response_error = response_body['error']
-        raise Exception.new(response_error['error_detail'], response_error['error_string'], response_error['error_code'])
+        raise Exception.new( response_body['error'] )
+      end
+    end
+
+    def self.from_tsv_to_json(response_body)
+      report_name = response_body.slice!(/^(.+?)\n/)
+      keys = response_body.slice!(/^(.+?)\n/).split("\t")
+      rows = response_body.match(/rows:(.+?)\n/)[1].to_i
+      values = []
+      rows.times do |row|
+        hash_values = {}
+        response_body.slice!(/^(.+?)\n/).split("\t").each_with_index do |value, index|
+          hash_values[keys[index].gsub("\n", "")] = value.gsub("\n", "")
+        end
+        values.push(hash_values)
       end
+      values
     end
 	end
-end
+end

data/lib/ya/api/direct/version.rb

@@ -1,7 +1,7 @@
 module Ya
   module Api
     module Direct
-      VERSION = "0.2.5"
+      VERSION = "0.2.10"
     end
   end
 end

data/lib/ya/api/direct.rb

@@ -1,3 +1,3 @@
 require "ya/api/direct/version"
 require "ya/api/direct/client"
-require "ya/api/direct/exception"
+require "ya/api/direct/exceptions"

data/ya-api-direct.gemspec

@@ -6,7 +6,7 @@ require 'ya/api/direct/version'
 Gem::Specification.new do |s|
   s.name        = 'ya-api-direct'
   s.version     = Ya::Api::Direct::VERSION
-  s.date        = '2016-10-02'
+  s.date        = '2021-12-12'
   s.summary     = "Yandex Direct API v5, v4 and v4 Live"
   s.description = "Ruby implementation for Yandex Direct API of versions 5, 4 and 4 Live"
   s.authors     = "Rikki Mongoose"
@@ -18,8 +18,9 @@ Gem::Specification.new do |s|
   s.bindir        = "exe"
   s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ["lib"]
+  s.required_ruby_version = ">= 2.5.0"
 
-  s.add_development_dependency "bundler", "~> 1.12"
-  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "bundler", ">= 2.2.33"
+  s.add_development_dependency "rake", ">= 12.3.3"
   s.add_development_dependency "minitest", "~> 5.0"
-end
+end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: ya-api-direct
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.10
 platform: ruby
 authors:
 - Rikki Mongoose
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-02 00:00:00.000000000 Z
+date: 2021-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: 2.2.33
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: 2.2.33
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
 description: Ruby implementation for Yandex Direct API of versions 5, 4 and 4 Live
@@ -58,9 +58,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
@@ -74,7 +74,7 @@ files:
 - lib/ya/api/direct/direct_service_base.rb
 - lib/ya/api/direct/direct_service_v4.rb
 - lib/ya/api/direct/direct_service_v5.rb
-- lib/ya/api/direct/exception.rb
+- lib/ya/api/direct/exceptions.rb
 - lib/ya/api/direct/gateway.rb
 - lib/ya/api/direct/url_helper.rb
 - lib/ya/api/direct/version.rb
@@ -89,17 +89,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Yandex Direct API v5, v4 and v4 Live

data/lib/ya/api/direct/exception.rb

@@ -1,17 +0,0 @@
-require "ya/api/direct/constants"
-
-module Ya::API::Direct
-  class Exception < StandardError
-    attr_reader :error_detail, :error_code, :error_str
-
-    def initialize(error_detail, error_str, error_code)
-      @error_detail = error_detail
-      @error_str = error_str
-      @error_code = error_code
-    end
-
-    def to_s
-      "#{@error_str} : #{@error_detail} : #{@error_code}"
-    end
-  end
-end