ya-api-direct 0.2.6 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8f3c62a4147b06184b0d5bab7cc3fa342b8a89eb
-  data.tar.gz: 27f6fc767137703e4845175105a6a05aba8bfa57
+SHA256:
+  metadata.gz: c3834e0a678f9eb91e7523dbca830f99d72660940079dfcc9340082d64ab2ec7
+  data.tar.gz: bf72e62469f98178a4a1ee62fe1c27849d8f23826db06c07354b87aaec6c9b47
 SHA512:
-  metadata.gz: 7484bd472a1cddb7ec2b6e949b53fab93626dd228a42c668f26201ad803455e7d9bb4096c5032e0a0800cd9fee9f4748cb304f3533b051bc9c7035eb95bb6ef1
-  data.tar.gz: 9233ece009e06fc3ce269f35d1b2369517f4e10ab32a1c68d3ab3e99104042024f1ee596b49caa3f67ebf726725d262e57b474ed89d3940d8fba8cb543c05a13
+  metadata.gz: fbd2d4b2b37ef73cf0b8269de00dd00a91b289948dea5285ca43172a26e5a3570664aa78b907f985c75962e617f6c5e08dd6812492ad261506e49e53151f9e45
+  data.tar.gz: c56f376feb05d6b7ccdc3d5d54e78e46773ba8defa047484a6a82b860bcfd7d184672c46a34b636527b13854087ec20da0f239de0956f31c2024b8ce7bf422d6

data/Gemfile

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 
 gem 'jruby-openssl', platforms: :jruby
-gem 'rake'
+gem 'rake', '>= 12.3.3'
 gem 'yard'
 #gem 'tsv'
 
@@ -16,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

@@ -3,38 +3,83 @@ module Ya
     module Direct
       API_V5 = {
         "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"
+          "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"
         ],

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
 
@@ -57,4 +72,4 @@ module Ya::API::Direct
       body
     end
   end
-end
+end

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

@@ -1,6 +1,6 @@
 require "json"
 
-require "ya/api/direct/exception"
+require "ya/api/direct/exceptions"
 
 
 module Ya::API::Direct
@@ -10,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
@@ -50,7 +50,7 @@ module Ya::API::Direct
   	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)
@@ -66,7 +66,7 @@ module Ya::API::Direct
     private
 
     def self.parse_data(response, ver)
-      if response["Content-Type"] == "application/json; charset=utf-8"
+      if response["Content-Type"].start_with?("application/json")
         response_body = JSON.parse(response.body)
         validate_response! response_body
         result = { data: response_body }
@@ -81,15 +81,14 @@ module Ya::API::Direct
 
     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 - 1
+      rows = response_body.match(/rows:(.+?)\n/)[1].to_i
       values = []
       rows.times do |row|
         hash_values = {}
@@ -101,4 +100,4 @@ module Ya::API::Direct
       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.6"
+      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        = '2018-04-19'
+  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

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: ya-api-direct
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.10
 platform: ruby
 authors:
 - Rikki Mongoose
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-19 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
@@ -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
@@ -91,15 +91,14 @@ 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.5.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