yandex-direct 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d241e8ace8881b19c05adb27746f97897fc97db2
+  data.tar.gz: eebaf1a1bad019b6cd9232c8f5e6a6de99a0aa6f
+SHA512:
+  metadata.gz: 1d722a0fd1940189c9a47099ef47f62b80ed611b7c2657fe640fa5f66887c71f13cdba2314586e1a84a0a0614e150097948dd87cae865542d749cf633442f9b0
+  data.tar.gz: b5766f27cbeea29bf764bee499dc5eb933016754008dd3c13dda8bf4cfc2623f85ad350ac0dfb61b6a9a6aa424f7c57c0e937ca03f6771af0247487e43aa3946

data/.gitignore

@@ -0,0 +1,4 @@
+/Gemfile.lock
+*.iml
+.idea
+/yandex_direct.yml

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Evgeniy Shurmin
+
+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,41 @@
+# Yandex::Direct
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/yandex/direct`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yandex-direct'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yandex-direct
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/yandex-direct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'yandex/direct'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/example/yandex_direct.yml

@@ -0,0 +1,15 @@
+development:
+    token: token
+    login: login
+    locale: ru
+    sandbox: true
+test:
+    token: token
+    login: login
+    locale: ru
+    sandbox: true
+production:
+    token: token
+    login: login
+    locale: ru
+    sandbox: true

data/lib/yandex/direct.rb

@@ -0,0 +1,37 @@
+require 'yandex/direct/version'
+
+module Yandex
+  module Direct
+
+    autoload :ActionResult, 'yandex/direct/action_result'
+    autoload :SelectionCriteria, 'yandex/direct/selection_criteria'
+    autoload :ExceptionNotification, 'yandex/direct/exception_notification'
+    autoload :Error, 'yandex/direct/error'
+    autoload :Base, 'yandex/direct/base'
+
+    autoload :Model, 'yandex/direct/model'
+
+    def self.configuration
+      if defined? @environment
+        raise "not configured Yandex.Direct for #{@environment} enviroment" unless @configuration
+      else
+        raise 'not configured Yandex.Direct' unless @configuration
+      end
+      @configuration
+    end
+
+    def self.load(file, env = nil)
+      @environment = env.to_s if env
+      config = YAML.load_file(file)
+      @configuration = defined?(@environment) ? config[@environment] : config
+      @configuration['sandbox'] ||= false
+    end
+
+    def self.connection
+      @connection ||= Faraday.new(url: (configuration['sandbox'] ? URL_API_SANDBOX : URL_API)) do |faraday|
+        faraday.use Faraday::Adapter::NetHttp
+      end
+    end
+
+  end
+end

data/lib/yandex/direct/action_result.rb

@@ -0,0 +1,17 @@
+module Yandex::Direct
+  class ActionResult
+    include ActiveModel::Model
+    attr_accessor :Id, :Warnings, :Errors
+    def initialize(*args)
+      super
+      self.Warnings = Array(self.Warnings).map{|attributes| ExceptionNotification.new(attributes)}
+      self.Errors = Array(self.Errors).map{|attributes| ExceptionNotification.new(attributes)}
+    end
+    def errors?
+      Array(self.Errors).compact.any?
+    end
+    def warnings?
+      Array(self.Warnings).compact.any?
+    end
+  end
+end

data/lib/yandex/direct/base.rb

@@ -0,0 +1,38 @@
+require 'active_model'
+
+module Yandex::Direct
+  class Base
+    include ActiveModel::Model
+    include ActiveModel::Serialization
+    include ActiveModel::Validations
+    class << self
+      def initialize(*args)
+        super
+      end
+      def create(attributes)
+        object = self.new(attributes)
+        object.save
+      end
+
+      delegate :call, :fields, :limit, :offset, :where, to: :selection_criteria
+      def path
+        self.name.demodulize.pluralize.downcase
+      end
+      protected
+      def selection_criteria
+        SelectionCriteria.new(self)
+      end
+    end
+
+    def to_param
+      self.serializable_hash(except: [:errors, :validation_context])
+    end
+
+    def save
+      if self.valid?
+        response = Direct.request('add', self.class.path, {'Campaigns' => [self.to_param]})
+        puts response.inspect
+      end
+    end
+  end
+end

data/lib/yandex/direct/error.rb

@@ -0,0 +1,14 @@
+module Yandex::Direct
+  class Error < RuntimeError
+    attr_accessor :request_id, :code, :text, :detail
+    def initialize(request_id, code, text, detail)
+      self.request_id = request_id
+      self.code = code
+      self.text = text
+      self.detail = detail
+    end
+    def message
+      "#{self.text} (#{self.code}): #{self.detail}"
+    end
+  end
+end

data/lib/yandex/direct/exception_notification.rb

@@ -0,0 +1,10 @@
+module Yandex
+  module API
+    module Direct
+      class ExceptionNotification
+        include ActiveModel::Model
+        attr_accessor :Message, :Details, :Code
+      end
+    end
+  end
+end

data/lib/yandex/direct/model.rb

@@ -0,0 +1,5 @@
+module Yandex::Direct
+  module Model
+
+  end
+end

data/lib/yandex/direct/model/campaign.rb

@@ -0,0 +1,74 @@
+module Yandex::Direct::Model
+  class Campaign < Base
+    ATTRIBUTES = :Id, :Name, :ClientInfo, :StartDate, :EndDate, :TimeTargeting, :TimeZone, :NegativeKeywords,
+        :BlockedIps, :ExcludedSites, :DailyBudget, :Notification, :Type, :Status, :State, :StatusPayment,
+        :StatusClarification, :SourceId, :Statistics, :Currency, :Funds, :RepresentedBy
+
+    attr_accessor *ATTRIBUTES
+
+    def attributes
+      {
+          :Id => nil,
+          :Name => nil
+      }
+    end
+
+    def self.get(selection_criteria)
+      response = Yandex::Direct.request('get', self.path, selection_criteria.fields(*ATTRIBUTES))
+      Yandex::Direct.parse(response, 'Campaigns',self)
+    end
+
+    def self.find(id)
+      self.where(Ids: Array(id)).call(:get).first
+    end
+
+    def self.archive(selection_criteria)
+      response = Yandex::Direct.request('archive', self.path, selection_criteria)
+      Yandex::Direct.parse(response, 'ArchiveResults', Yandex::Direct::ActionResult)
+    end
+
+    def archive
+      self.class.where(Ids: [self.Id]).call(:archive).first
+    end
+
+    def self.unarchive(selection_criteria)
+      response = Yandex::Direct.request('unarchive', self.path, selection_criteria)
+      Yandex::Direct.parse(response, 'UnarchiveResults', Yandex::Direct::ActionResult)
+    end
+
+    def unarchive
+      self.class.where(Ids: [self.Id]).call(:unarchive).first
+    end
+
+    def self.resume(selection_criteria)
+      response = Yandex::Direct.request('resume', self.path, selection_criteria)
+      Yandex::Direct.parse(response, 'ResumeResults', Yandex::Direct::ActionResult)
+    end
+
+    def resume
+      self.class.where(Ids: [self.Id]).call(:resume).first
+    end
+
+    def self.suspend(selection_criteria)
+      response = Yandex::Direct.request('suspend', self.path, selection_criteria)
+      Yandex::Direct.parse(response, 'SuspendResults', Yandex::Direct::ActionResult)
+    end
+
+    def suspend
+      self.class.where(Ids: [self.Id]).call(:suspend).first
+    end
+
+    def self.delete(selection_criteria)
+      response = Yandex::Direct.request('delete', self.path, selection_criteria)
+      Yandex::Direct.parse(response, 'DeleteResults', Yandex::Direct::ActionResult)
+    end
+
+    def delete
+      self.class.where(Ids: [self.Id]).call(:delete).first
+    end
+
+    # TODO: add, update
+    # TODO: TextCampaign, DynamicTextCampaign, MobileAppCampaign
+
+  end
+end

data/lib/yandex/direct/selection_criteria.rb

@@ -0,0 +1,41 @@
+module Yandex::Direct
+  class SelectionCriteria
+    protected
+    attr_accessor :selection_criteria, :field_names, :page_limit, :page_offset
+    public
+    attr_accessor :object
+    def initialize(object)
+      self.object = object
+      self.field_names = nil
+    end
+    def fields(*field_names)
+      self.field_names = Array(field_names)
+      self
+    end
+    def limit(value)
+      self.page_limit = value
+      self
+    end
+    def offset(value)
+      self.page_offset = value
+      self
+    end
+    def where(criteria = {})
+      (self.selection_criteria ||= {}).merge!(criteria)
+      self
+    end
+    def call(method, options = nil)
+      puts "[#{self.object.name}](#{method}): #{self.to_param}"
+      self.object.method(method).call(*[self, options].compact)
+    end
+    def to_param
+      params = {
+          'SelectionCriteria' => (self.selection_criteria.nil? ? {} : self.selection_criteria),
+      }
+      params.merge!({'FieldNames' => Array(self.field_names).flatten.uniq}) unless self.field_names.nil?
+      params.merge!({'Page' => {'Offset' => self.page_offset}}) if self.page_offset
+      params.merge!({'Page' => {'Limit' => self.page_limit}}) if self.page_limit
+      params
+    end
+  end
+end

data/lib/yandex/direct/version.rb

@@ -0,0 +1,5 @@
+module Yandex
+  module Direct
+    VERSION = '0.1.0'
+  end
+end

data/yandex-direct.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yandex/direct/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'yandex-direct'
+  spec.version       = Yandex::Direct::VERSION
+  spec.authors       = ['Evgeniy Shurmin']
+  spec.email         = ['eshurmin@gmail.com']
+
+  spec.description   = %q{Yandex.Direct integration}
+  spec.summary       = %q{Yandex.Direct integration}
+  spec.homepage      = 'https://github.com/jpascal/yandex-direct'
+
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'activemodel'
+  spec.add_dependency 'faraday'
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: yandex-direct
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Evgeniy Shurmin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Yandex.Direct integration
+email:
+- eshurmin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/yandex_direct.yml
+- lib/yandex/direct.rb
+- lib/yandex/direct/action_result.rb
+- lib/yandex/direct/base.rb
+- lib/yandex/direct/error.rb
+- lib/yandex/direct/exception_notification.rb
+- lib/yandex/direct/model.rb
+- lib/yandex/direct/model/campaign.rb
+- lib/yandex/direct/selection_criteria.rb
+- lib/yandex/direct/version.rb
+- yandex-direct.gemspec
+homepage: https://github.com/jpascal/yandex-direct
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Yandex.Direct integration
+test_files: []
+has_rdoc: