yandex-direct 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d241e8ace8881b19c05adb27746f97897fc97db2
-  data.tar.gz: eebaf1a1bad019b6cd9232c8f5e6a6de99a0aa6f
+  metadata.gz: b0cec38936d361a0171b18dc978934f4dd823835
+  data.tar.gz: aaf0817a6842d9845e963a441ba0a9320fe69b5a
 SHA512:
-  metadata.gz: 1d722a0fd1940189c9a47099ef47f62b80ed611b7c2657fe640fa5f66887c71f13cdba2314586e1a84a0a0614e150097948dd87cae865542d749cf633442f9b0
-  data.tar.gz: b5766f27cbeea29bf764bee499dc5eb933016754008dd3c13dda8bf4cfc2623f85ad350ac0dfb61b6a9a6aa424f7c57c0e937ca03f6771af0247487e43aa3946
+  metadata.gz: 715f250adb7d2d04019b78ca052d4dbe1d274e6b5033a1524fc8ae421696043b406e54142c61a504d035242fd9a6c01dab8e860aaadc466511ab75b490714e4b
+  data.tar.gz: 9bd982d87357b40a829f138577c4183fdfafc8dce59f6254f61b3efc754adb0bac2f4de998af7c2eb68b5b2dd2b3b4b24423632bb298bec568f84376437845dc

data/README.md

@@ -1,14 +1,12 @@
 # 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
+Allow you work with any Yandex.Direct API
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
+```
 gem 'yandex-direct'
 ```
 
@@ -20,22 +18,59 @@ Or install it yourself as:
 
     $ gem install yandex-direct
 
-## Usage
+## Configuration
 
-TODO: Write usage instructions here
+### Ruby:
 
-## Development
+Create configuration file yandex_direct.yml
 
-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.
+    token: token
+    login: login
+    locale: ru
+    verbose: true
+    sandbox: true
 
-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).
+Load configuration
+    
+    Yandex::Direct.config "yandex_direct.yml"
 
-## Contributing
+### Ruby On Rails:
+
+Create configuration file config/yandex_direct.yml
+
+    development:
+        token: token
+        login: login
+        locale: ru
+        verbose: true
+        sandbox: true
+
+Create yandex_direct.rb in config/initializers
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/yandex-direct.
+    Yandex::Direct.config File.join(Rails.root, "config", "yandex_direct.yml"), Rails.env
 
+## Example:
 
-## License
+    require 'yandex-direct'
+    Yandex::Direct.load "yandex_direct.yml"
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+    campaign = Yandex::Direct::Campaign.where(Ids: [345545]).limit(1).call(:get).first
+    puts campaign.inspect
+
+    campaign = Yandex::Direct::Campaign.get(345545)
+    puts campaign.inspect
+
+## Todo list
+
+- write tests
+- add others Yandex.Direct model
+- add validations
+- add relations between models 
+
+## Contributing
 
+1. Fork it ( https://github.com/jpascal/yandex-direct/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

@@ -1 +1,6 @@
 require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/yandex/direct.rb

@@ -1,37 +1,16 @@
+require 'yaml'
 require 'yandex/direct/version'
+require 'yandex/direct/config'
+require 'yandex/direct/client'
+require 'yandex/direct/request'
+require 'yandex/direct/models'
 
 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/base.rb

@@ -1,4 +1,5 @@
 require 'active_model'
+require 'active_model/serializers/json'
 
 module Yandex::Direct
   class Base

data/lib/yandex/direct/client.rb

@@ -0,0 +1,13 @@
+require 'faraday'
+
+module Yandex
+  module Direct
+    URL_API = 'https://api.direct.yandex.com/json/v5'.freeze
+    URL_API_SANDBOX = 'https://api-sandbox.direct.yandex.com/json/v5'.freeze
+    def self.client
+      @client ||= 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/config.rb

@@ -0,0 +1,21 @@
+require 'yaml'
+
+module Yandex
+  module Direct
+    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.config(file, env = nil)
+      @environment = env.to_s if env
+      config = YAML.load_file(file)
+      @configuration = defined?(@environment) ? config[@environment] : config
+      @configuration['sandbox'] ||= false
+      @configuration
+    end
+  end
+end

data/lib/yandex/direct/exception_notification.rb

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

data/lib/yandex/direct/models.rb

@@ -0,0 +1,3 @@
+module Yandex::Direct
+  autoload :Campaign, 'yandex/direct/models/campaign'
+end

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

@@ -0,0 +1,76 @@
+module Yandex
+  module Direct
+    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
+end

data/lib/yandex/direct/request.rb

@@ -0,0 +1,31 @@
+require 'faraday'
+
+module Yandex
+  module Direct
+    def self.parse(hash, key, klass)
+      hash.fetch(key,[]).map{|attributes| klass.new(attributes)}
+    end
+
+    def self.request(method, path, params = nil)
+      response = self.client.post(path, {
+          'method' => method,
+          'params' => (params.respond_to?(:to_param) ? params.to_param : params)
+      }.to_json, {
+                                          'Authorization' => "Bearer #{configuration['token']}",
+                                          'Client-Login' => configuration['login'],
+                                          'Accept-Language' => configuration['locale'],
+                                          'Content-Type' => 'application/json; charset=utf-8'
+                                      })
+
+      raise "Yandex.Direct response with status #{response.status}" unless response.success?
+
+      response = JSON.parse(response.body)
+
+      if (error = response['error'])
+        raise Error.new(error['request_id'], error['error_code'], error['error_string'], error['error_detail'])
+      end
+
+      response['result']
+    end
+  end
+end

data/lib/yandex/direct/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yandex-direct
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Evgeniy Shurmin
@@ -112,10 +112,13 @@ files:
 - lib/yandex/direct.rb
 - lib/yandex/direct/action_result.rb
 - lib/yandex/direct/base.rb
+- lib/yandex/direct/client.rb
+- lib/yandex/direct/config.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/models.rb
+- lib/yandex/direct/models/campaign.rb
+- lib/yandex/direct/request.rb
 - lib/yandex/direct/selection_criteria.rb
 - lib/yandex/direct/version.rb
 - yandex-direct.gemspec

data/lib/yandex/direct/model.rb

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

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

@@ -1,74 +0,0 @@
-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