direct_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df6294498951193b3284ba81e703628276ace4b6
+  data.tar.gz: 931fa14348cc45587ed9bc88342488af1adbfa2b
+SHA512:
+  metadata.gz: 337fc7adfbe1b359b815202200d0adaeb6f08510ca344e858ffd2ed3fb1f1753643c2f36b7781c2005cabb70b327fb7f4a94ad0317f8d3519657dbe9687cf66f
+  data.tar.gz: 03e2aa833a032bb8b719f8cd121f824069f1b4b3afb52786a39d373db4a2f3a7b81929dca547e631822aa90ee7539ca785d3132bfc06c5f94d0bcef979a18490

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in direct_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    direct_api (0.0.1)
+      json (~> 2.0, >= 2.0.0)
+      rest-client (~> 2.0, >= 2.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    domain_name (0.5.20170404)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    json (2.1.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    netrc (0.11.0)
+    rake (12.3.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  direct_api!
+  rake (~> 12.3.0, >= 12.3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Eugeniy Belyaev
+
+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,25 @@
+# Yandex Direct API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'direct_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install direct_api
+
+## Usage
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/direct_api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'

data/direct_api.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'direct_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'direct_api'
+  spec.version       = DirectApi::VERSION
+  spec.authors       = ['Gennady Novoselov']
+  spec.email         = ['gennady@novoselov.biz']
+  spec.summary       = 'Yandex Direct api via oauth2'
+  spec.description   = 'Yandex Direct api via oauth2'
+  spec.homepage      = 'https://github.com/gnovoselov/direct-api'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir['**/*']
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'json', '~> 2.0', '>= 2.0.0'
+  spec.add_runtime_dependency 'rest-client', '~> 2.0', '>= 2.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 12.3.0', '>= 12.3.0'
+end

data/lib/direct_api.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'restclient'
+require 'json'
+require 'direct_api/adapters/campaigns_adapter'
+require 'direct_api/adapters/adgroups_adapter'
+require 'direct_api/adapters/ads_adapter'
+
+# Yandex Direct API module
+module DirectApi
+
+  autoload :Response, 'direct_api/response'
+  autoload :Request, 'direct_api/request'
+  autoload :Session, 'direct_api/session'
+
+  autoload :ConnectionError,  'direct_api/errors/connection_error'
+  autoload :RequestError,     'direct_api/errors/request_error'
+
+end

data/lib/direct_api/adapters/adgroups_adapter.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module DirectApi
+  # AdGroups methods
+  class AdgroupsAdapter
+
+    ADGROUP_FIELD_NAMES = %w[Id CampaignId Status Name RegionIds
+                             NegativeKeywords TrackingParams Type].freeze
+    MOBILE_APP_ADGROUP_FIELD_NAMES = %w[StoreUrl TargetDeviceType TargetCarrier
+                                        TargetOperatingSystemVersion AppIconModeration
+                                        AppAvailabilityStatus AppOperatingSystemType].freeze
+    DYNAMIC_TEXT_ADGROUP_FIELD_NAMES = %w[DomainUrl].freeze
+
+    def build_request(client_settings, params = {})
+      [:adgroups, build(params).merge(client_settings)]
+    end
+
+    private
+
+    def build(options = {})
+      {
+        method: :get,
+        params: {
+          SelectionCriteria: options[:params],
+          FieldNames: options.fetch(:field_names, ADGROUP_FIELD_NAMES),
+          MobileAppAdGroupFieldNames: options.fetch(:mobile_app_adgroup_field_names,
+                                                    MOBILE_APP_ADGROUP_FIELD_NAMES),
+          DynamicTextAdGroupFieldNames: options.fetch(:dynamic_text_adgroup_field_names,
+                                                      DYNAMIC_TEXT_ADGROUP_FIELD_NAMES)
+        }
+      }
+    end
+
+  end
+end

data/lib/direct_api/adapters/ads_adapter.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module DirectApi
+  # Ads methods
+  class AdsAdapter
+
+    AD_FIELD_NAMES = %w[AdCategories AgeLabel AdGroupId CampaignId Id State Status
+                        StatusClarification Type Subtype].freeze
+    TEXT_AD_FIELD_NAMES = %w[Title Text Href Mobile DisplayDomain DisplayUrlPath
+                             DisplayUrlPathModeration VCardId VCardModeration SitelinkSetId
+                             SitelinksModeration AdImageHash AdImageModeration AdExtensions].freeze
+    MOBILE_APP_AD_FIELD_NAMES = %w[Title Text Features Action AdImageHash
+                                   AdImageModeration TrackingUrl].freeze
+    DYNAMIC_TEXT_AD_FIELD_NAMES = %w[Text VCardId VCardModeration SitelinkSetId SitelinksModeration
+                                     AdImageHash AdImageModeration AdExtensions].freeze
+    TEXT_IMAGE_AD_FIELD_NAMES = %w[AdImageHash Href].freeze
+    MOBILE_APP_IMAGE_AD_FIELD_NAMES = %w[AdImageHash TrackingUrl].freeze
+
+    def build_request(client_settings, params = {})
+      [:ads, build(params).merge(client_settings)]
+    end
+
+    private
+
+    def build(options = {})
+      {
+        method: :get,
+        params: extract_options(options)
+      }
+    end
+
+    def extract_options(p)
+      {
+        SelectionCriteria: p[:params],
+        FieldNames: p.fetch(:field_names, AD_FIELD_NAMES),
+        TextAdFieldNames: p.fetch(:text_ad_field_names, TEXT_AD_FIELD_NAMES),
+        MobileAppAdFieldNames: p.fetch(:mobile_app_ad_field_names, MOBILE_APP_AD_FIELD_NAMES),
+        DynamicTextAdFieldNames: p.fetch(:dynamic_text_ad_field_names, DYNAMIC_TEXT_AD_FIELD_NAMES),
+        TextImageAdFieldNames: p.fetch(:text_image_ad_field_names, TEXT_IMAGE_AD_FIELD_NAMES),
+        MobileAppImageAdFieldNames:
+          p.fetch(:mobile_app_image_ad_field_names, MOBILE_APP_IMAGE_AD_FIELD_NAMES)
+      }
+    end
+
+  end
+end

data/lib/direct_api/adapters/campaigns_adapter.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module DirectApi
+  # Campaigns methods
+  class CampaignsAdapter
+
+    CAMPAIGN_FIELD_NAMES = %w[BlockedIps ExcludedSites Currency DailyBudget Notification EndDate
+                              Funds ClientInfo Id Name NegativeKeywords RepresentedBy StartDate
+                              Statistics State Status StatusPayment StatusClarification SourceId
+                              TimeTargeting TimeZone Type].freeze
+    TEXT_CAMPAIGN_FIELD_NAMES = %w[CounterIds RelevantKeywords Settings BiddingStrategy].freeze
+    MOBILE_APP_CAMPAIGN_FIELD_NAMES = %w[Settings BiddingStrategy].freeze
+    DYNAMIC_TEXT_CAMPAIGN_FIELD_NAMES = %w[CounterIds Settings BiddingStrategy].freeze
+
+    def build_request(client_settings, params = {})
+      [:campaigns, build(params).merge(client_settings)]
+    end
+
+    private
+
+    def build(options = {})
+      {
+        method: :get,
+        params: extract_options(options)
+      }
+    end
+
+    def extract_options(p)
+      {
+        SelectionCriteria: p[:params],
+        FieldNames: p.fetch(:field_names, CAMPAIGN_FIELD_NAMES),
+        TextCampaignFieldNames: p.fetch(:text_campaign_field_names, TEXT_CAMPAIGN_FIELD_NAMES),
+        MobileAppCampaignFieldNames:
+          p.fetch(:mobile_app_campaign_field_names, MOBILE_APP_CAMPAIGN_FIELD_NAMES),
+        DynamicTextCampaignFieldNames:
+          p.fetch(:dynamic_text_campaign_field_names, DYNAMIC_TEXT_CAMPAIGN_FIELD_NAMES)
+      }
+    end
+
+  end
+end

data/lib/direct_api/errors/connection_error.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module DirectApi
+  # Connection Error
+  class ConnectionError < StandardError
+
+    def initialize(e)
+      @exception = e
+    end
+
+    def message
+      @exception.message
+    end
+
+  end
+end

data/lib/direct_api/errors/request_error.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module DirectApi
+  # Request Error
+  class RequestError < StandardError
+
+    def initialize(e)
+      super build_message e
+    end
+
+    private
+
+    def build_message(e)
+      body = JSON.parse e.response
+      if body['error']
+        "#{body['error']} : #{body['error_description']}"
+      else
+        body.map { |field, error| "#{field}: #{error}" }.join(', ')
+      end
+    rescue
+      e.response
+    end
+
+  end
+end

data/lib/direct_api/request.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module DirectApi
+  # Yandex Direct request module
+  module Request
+
+    API_URI = 'https://api.direct.yandex.com/json/v5/'
+    SANDBOX_API_URI = 'https://api-sandbox.direct.yandex.com/json/v5/'
+
+    module_function
+
+    def process(path, params = {})
+      response_parser.parse(
+        make_request(path, params).to_s
+      )
+    end
+
+    def make_request(path, params = {})
+
+      RestClient.post(*build(path, params))
+    rescue RestClient::Unauthorized,
+           RestClient::Forbidden,
+           RestClient::BadRequest,
+           RestClient::ResourceNotFound => e
+      raise DirectApi::RequestError, e.message
+    rescue SocketError => e
+      raise DirectApi::ConnectionError, e.message
+
+    end
+
+    def build(path, params)
+      headers = {}
+      path = get_uri(params.delete(:sandbox)) + path.to_s
+
+      headers['Accept-Language'] = params.delete(:locale)
+      headers['Client-Login'] = params.delete(:client_login)
+      headers['Authorization'] = "Bearer #{params.delete(:token)}"
+
+      [path, params.to_json, headers]
+    end
+
+    def get_uri(sandbox)
+      sandbox ? SANDBOX_API_URI : API_URI
+    end
+
+    def response_parser
+      Response
+    end
+
+  end
+end

data/lib/direct_api/response.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module DirectApi
+  # Yandex Direct response parser
+  module Response
+
+    module_function
+
+    def parse(response)
+      if response.is_a?(Hash)
+        lower_keys(response)
+      elsif response.is_a?(Array)
+        response.map { |r| parse(r) }
+      elsif response.is_a?(String)
+        parse(json_parse(response))
+      else
+        response
+      end
+    rescue JSON::ParserError
+      response
+    end
+
+    def json_parse(response)
+      JSON.parse(response)
+    end
+
+    def lower_keys(h)
+      h.each_with_object({}) do |(key, value), memo|
+        memo[key.underscore] = parse(value)
+      end
+    end
+
+  end
+end

data/lib/direct_api/session.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module DirectApi
+  # Direct Api session object
+  class Session
+
+    def initialize(api_data)
+      @api_data = api_data
+    end
+
+    def campaigns(token, client_login, params = {})
+      process_request(token, client_login, campaigns_adapter, params)
+    end
+
+    def adgroups(token, client_login, params = {})
+      process_request(token, client_login, adgroups_adapter, params)
+    end
+
+    def ads(token, client_login, params = {})
+      process_request(token, client_login, ads_adapter, params)
+    end
+
+    private
+
+    attr_reader :api_data
+
+    def process_request(token, client_login, adapter, params)
+      requester.process(*adapter.build_request(client_settings(token, client_login), params))
+    end
+
+    def client_settings(token, client_login)
+      {
+        token: token,
+        client_login: client_login,
+        sandbox: api_data[:sandbox],
+        locale: api_data[:locale]
+      }
+    end
+
+    def campaigns_adapter
+      @campaigns_adapter ||= CampaignsAdapter.new
+    end
+
+    def adgroups_adapter
+      @adgroups_adapter ||= AdgroupsAdapter.new
+    end
+
+    def ads_adapter
+      @ads_adapter ||= AdsAdapter.new
+    end
+
+    def requester
+      Request
+    end
+
+  end
+end

data/lib/direct_api/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module DirectApi
+
+  VERSION = '0.0.1'
+
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: direct_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gennady Novoselov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+description: Yandex Direct api via oauth2
+email:
+- gennady@novoselov.biz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- direct_api.gemspec
+- lib/direct_api.rb
+- lib/direct_api/adapters/adgroups_adapter.rb
+- lib/direct_api/adapters/ads_adapter.rb
+- lib/direct_api/adapters/campaigns_adapter.rb
+- lib/direct_api/errors/connection_error.rb
+- lib/direct_api/errors/request_error.rb
+- lib/direct_api/request.rb
+- lib/direct_api/response.rb
+- lib/direct_api/session.rb
+- lib/direct_api/version.rb
+homepage: https://github.com/gnovoselov/direct-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Yandex Direct api via oauth2
+test_files: []