yandex-api-direct 0.0.1

data/test/test_helper.rb

@@ -0,0 +1,50 @@
+# -*- encoding : utf-8 -*-
+require 'simplecov'
+SimpleCov.start do 
+  add_filter "/test/"
+  add_filter "/config/"
+  add_filter "database"
+  
+  add_group 'Lib', 'lib/'
+end
+
+require 'colorize'
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'test/unit'
+require 'mocha'
+require 'turn'
+require 'shoulda-context'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'yandex-api-direct'
+
+# Set test to use YML config
+require 'yaml'
+
+ENV['RACK_ENV'] = "test"
+
+class MissingConfigFile < Exception ; end
+
+
+require "webmock/test_unit"
+
+# test models
+require 'models'
+
+def load_fixture name
+  File.open(File.join(File.dirname(__FILE__), "fixtures", name), "r:UTF-8").read
+end
+
+def set_sandbox_access
+  YandexApiDirect.url "sandbox"
+end

data/test/test_yandex-api.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+require 'test_helper'
+
+class TestYandexApiDirect < Test::Unit::TestCase
+
+  context "Setup config values" do
+
+    should "have defaults" do
+      assert_not_nil YandexApiDirect.config
+    end
+
+    should "be set" do
+      conf = YandexApiDirect.config.merge({ access_token: "Test"})
+      YandexApiDirect.config = conf
+      assert_equal YandexApiDirect.config, conf
+    end
+    
+  end
+
+  context "Yandex url" do
+    should "be set to sandbox for tests" do
+      assert_equal YandexApiDirect.url, "https://api-sandbox.direct.yandex.ru/json-api/v4/"
+    end
+
+    should "be set to sandbox by param" do
+      YandexApiDirect.url "sandbox"
+      assert_equal YandexApiDirect.url, "https://api-sandbox.direct.yandex.ru/json-api/v4/"
+    end
+
+    should "be set to production by setting it to production" do
+      YandexApiDirect.url "production"
+      assert_equal YandexApiDirect.url, "https://soap.direct.yandex.ru/json-api/v4/"
+    end
+
+  end
+end

data/test/yandex-api-direct/test_campaign.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+require 'test_helper'
+
+class TestCampaign < Test::Unit::TestCase
+
+  context "Yandex Campaign" do
+    setup do
+      set_sandbox_access
+
+      # webmock get campaign list
+        stub_request(:post, "https://api-sandbox.direct.yandex.ru/json-api/v4/").
+        with( :body => "{\"method\":\"GetCampaignsList\",\"locale\":\"uk\",\"login\":\"\",\"application_id\":\"\",\"token\":\"\",\"param\":{}}",
+              :headers => {'Accept'=>'*/*', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}).
+        to_return(:status => 200, :body => load_fixture("yandex_get_campaigns_list.json"))
+
+      # webmock campaign params
+      stub_request(:post, "https://api-sandbox.direct.yandex.ru/json-api/v4/").
+        with( :body => "{\"method\":\"GetCampaignParams\",\"locale\":\"uk\",\"login\":\"\",\"application_id\":\"\",\"token\":\"\",\"param\":{\"CampaignIDS\":[123451]}}",
+              :headers => {'Accept'=>'*/*', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}).
+        to_return(:status => 200, :body => load_fixture("yandex_campaign_params.json"))
+
+      # webmock campaign stats
+      stub_request(:post, "https://api-sandbox.direct.yandex.ru/json-api/v4/").
+        with(:body => "{\"method\":\"GetSummaryStat\",\"locale\":\"uk\",\"login\":\"\",\"application_id\":\"\",\"token\":\"\",\"param\":{\"StartDate\":\"2008-11-13\",\"EndDate\":\"2008-11-15\",\"CampaignIDS\":[123451]}}",
+             :headers => {'Accept'=>'*/*', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}).
+        to_return(:status => 200, :body => load_fixture("yandex_campaign_stats.json"))
+
+    end
+
+    context "find" do
+      setup do 
+        @campaigns = YandexApiDirect::Campaign.find
+      end
+
+      should "be array" do
+        assert @campaigns.is_a?(Array)
+      end
+
+      should "be array of Campaigns" do
+        assert @campaigns.first.is_a?(YandexApiDirect::Campaign)
+      end
+
+      should "have right count of clients" do
+        assert_equal @campaigns.size, 3
+      end
+
+      context "campaign" do
+        setup do 
+          @campaign = @campaigns.first
+        end
+
+        should "have right attributes" do
+          assert_equal @campaign.name, "Campaign #1"
+        end
+
+        should "have campaign params" do
+          assert @campaign.campaign_params.is_a?(YandexApiDirect::CampaignParams)
+        end
+
+        should "have campaign stats" do
+          assert_equal @campaign.campaign_stats(start_date: Date.new(2008,11,13), end_date: Date.new(2008,11,15)).size, 3
+        end
+
+      end
+    end
+
+  end
+end

data/test/yandex-api-direct/test_campaign_params.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+require 'test_helper'
+
+#require "webmock/test_unit"
+
+class TestCampaignParams < Test::Unit::TestCase
+
+  context "Yandex Campaign Params" do
+    setup do
+      set_sandbox_access
+
+      # webmock campaign params
+      stub_request(:post, "https://api-sandbox.direct.yandex.ru/json-api/v4/").
+        with( :body => "{\"method\":\"GetCampaignParams\",\"locale\":\"uk\",\"login\":\"\",\"application_id\":\"\",\"token\":\"\",\"param\":{\"CampaignID\":123451}}",
+              :headers => {'Accept'=>'*/*', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}).
+        to_return(:status => 200, :body => load_fixture("yandex_campaign_params.json"))
+
+    end
+
+    context "find" do
+      setup do 
+        @campaign_param = YandexApiDirect::CampaignParams.find campaign_id: 123451
+      end
+
+      should "have right attributes" do
+        assert_equal @campaign_param.name, "Campaign #1"
+      end
+
+    end
+
+  end
+end

data/test/yandex-api-direct/test_campaign_stats.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+require 'test_helper'
+
+#require "webmock/test_unit"
+
+class TestCampaignStats < Test::Unit::TestCase
+
+  context "Yandex Campaign Stats" do
+    setup do
+      set_sandbox_access
+
+      # webmock campaign stats
+      stub_request(:post, "https://api-sandbox.direct.yandex.ru/json-api/v4/").
+        with( :body => "{\"method\":\"GetSummaryStat\",\"locale\":\"uk\",\"login\":\"\",\"application_id\":\"\",\"token\":\"\",\"param\":{\"CampaignIDS\":[123451],\"StartDate\":\"2008-11-13\",\"EndDate\":\"2008-11-15\"}}",
+              :headers => {'Accept'=>'*/*', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}).
+        to_return(:status => 200, :body => load_fixture("yandex_campaign_stats.json"))
+
+    end
+
+    context "find" do
+      setup do 
+        @campaign_stats = YandexApiDirect::CampaignStats.find campaign_ids: [123451], start_date: Date.new(2008,11,13), end_date: Date.new(2008,11,15)
+      end
+
+      should "have right attributes" do
+        assert_equal @campaign_stats.first.campaign_id, 123451
+      end
+
+      should "be for 3 days" do
+        assert_equal @campaign_stats.size, 3
+      end
+    end
+
+  end
+end

data/test/yandex-api-direct/test_client.rb

@@ -0,0 +1,113 @@
+# encoding: utf-8
+require 'test_helper'
+
+class TestClient < Test::Unit::TestCase
+
+  context "Yandex Client" do
+    setup do
+      set_sandbox_access
+
+      # webmock get client list
+      stub_request(:post, "https://api-sandbox.direct.yandex.ru/json-api/v4/").
+        with(:body => "{\"method\":\"GetClientsList\",\"locale\":\"uk\",\"login\":\"\",\"application_id\":\"\",\"token\":\"\",\"param\":{}}").
+        to_return(:status => 200, :body => load_fixture("yandex_get_client_list.json"))
+
+      # webmock get campaign list
+      stub_request(:post, "https://api-sandbox.direct.yandex.ru/json-api/v4/").
+        with(:body => "{\"method\":\"GetCampaignsList\",\"locale\":\"uk\",\"login\":\"\",\"application_id\":\"\",\"token\":\"\",\"param\":[\"test\"]}",
+             :headers => {'Accept'=>'*/*', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}).
+        to_return(:status => 200, :body => load_fixture("yandex_get_campaigns_list.json"))
+
+      # webmock campaign params
+      stub_request(:post, "https://api-sandbox.direct.yandex.ru/json-api/v4/").
+        with(:body => "{\"method\":\"GetCampaignsParams\",\"locale\":\"uk\",\"login\":\"\",\"application_id\":\"\",\"token\":\"\",\"param\":[\"yand-10\"]}").
+        to_return(:status => 200, :body => load_fixture("yandex_campaign_params.json"))
+
+      # webmock campaign stats
+      stub_request(:post, "https://api-sandbox.direct.yandex.ru/json-api/v4/").
+        with(:body => "{\"method\":\"GetSummaryStat\",\"locale\":\"uk\",\"login\":\"\",\"application_id\":\"\",\"token\":\"\",\"param\":{\"StartDate\":\"2008-11-13\",\"EndDate\":\"2008-11-15\",\"CampaignIDS\":[123451]}}",
+             :headers => {'Accept'=>'*/*', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}).
+        to_return(:status => 200, :body => load_fixture("yandex_campaign_stats.json"))
+
+      stub_request(:post, "https://api-sandbox.direct.yandex.ru/json-api/v4/").
+        with(:body => "{\"method\":\"GetSummaryStat\",\"locale\":\"uk\",\"login\":\"\",\"application_id\":\"\",\"token\":\"\",\"param\":{\"StartDate\":\"2008-11-13\",\"EndDate\":\"2008-11-15\",\"CampaignIDS\":[123452]}}",
+             :headers => {'Accept'=>'*/*', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}).
+        to_return(:status => 200, :body => "{\"data\":[]}")
+
+      stub_request(:post, "https://api-sandbox.direct.yandex.ru/json-api/v4/").
+        with(:body => "{\"method\":\"GetSummaryStat\",\"locale\":\"uk\",\"login\":\"\",\"application_id\":\"\",\"token\":\"\",\"param\":{\"StartDate\":\"2008-11-13\",\"EndDate\":\"2008-11-15\",\"CampaignIDS\":[123453]}}",
+             :headers => {'Accept'=>'*/*', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}).
+        to_return(:status => 200, :body => "{\"data\":[]}")
+    end
+
+    context "initialization" do
+      should "have methods defined by params" do
+        client = YandexApiDirect::Client.new( foo: "bar")
+        assert_equal client.foo, "bar"
+      end
+    end
+
+    context "find" do
+      setup do 
+        @clients = YandexApiDirect::Client.find
+      end
+
+      should "be array" do
+        assert @clients.is_a?(Array)
+      end
+
+      should "be array of Clients" do
+        assert @clients.first.is_a?(YandexApiDirect::Client)
+      end
+
+      should "have right count of clients" do
+        assert_equal @clients.size, 2
+      end
+
+      context "client" do
+        setup do 
+          @client = @clients.first
+        end
+
+        should "have right attributes" do
+          assert_equal @client.login, "test", "Same login"
+        end
+
+        should "have underscored method names" do
+          assert_equal @client.status_arch, "no"
+        end
+      end
+    end
+
+    context "campaigns find" do
+      setup do 
+        @client = YandexApiDirect::Client.find.first
+      end
+
+      should "be array" do
+        assert @client.campaigns.is_a?(Array)
+      end
+
+      should "be array of campaigns" do
+        assert @client.campaigns.first.is_a?(YandexApiDirect::Campaign)
+      end
+
+      should "be array of campaigns with valid informations" do
+        assert_same_elements @client.campaigns.collect{|c| c.name}, ["Campaign #1","Campaign #2","Campaign #3"]
+      end
+    end
+
+    context "campaigns stats" do
+      setup do
+        @client = YandexApiDirect::Client.find.first
+      end
+
+      should "return campaigns and inside of them stats" do
+        campaigns = @client.campaigns_stats start_date: Date.new(2008,11,13), end_date: Date.new(2008,11,15)
+        assert_equal campaigns.size, 3, "Should have 3 campaigns"
+        assert_equal campaigns.first.stats.size, 3, "First campaign should have 3 date statistics"
+        assert_equal campaigns.last.stats.size, 0, "Last campaign has no stats for this dates"
+      end
+    end
+  end
+end

data/test/yandex-api-direct/test_generic.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+require 'test_helper'
+
+#require "webmock/test_unit"
+
+class TestGeneric < Test::Unit::TestCase
+
+  context "Yandex Generic" do
+    setup do
+      set_sandbox_access
+
+      # webmock get client list
+      stub_request(:post, "https://api-sandbox.direct.yandex.ru/json-api/v4/").
+            with(:body => "{\"method\":\"GetClientsList\",\"locale\":\"uk\",\"login\":\"\",\"application_id\":\"\",\"token\":\"\"}",
+                 :headers => {'Accept'=>'*/*', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}).
+        to_return(:status => 200, :body => load_fixture("yandex_get_client_list.json"))
+
+      # webmock get client info
+      stub_request(:post, "https://api-sandbox.direct.yandex.ru/json-api/v4/").
+            with(:body => "{\"method\":\"GetClientInfo\",\"locale\":\"uk\",\"login\":\"\",\"application_id\":\"\",\"token\":\"\"}",
+                 :headers => {'Accept'=>'*/*', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}).
+            to_return(:status => 200, :body => load_fixture("yandex_get_client_info.json"))
+    end
+
+    context "get only one item" do
+      setup do 
+        @generic = YandexApiDirect::Generic.get "get_client_info"
+      end
+
+      should "have right attributes" do
+        assert_equal @generic.login, "test"
+      end
+
+    end
+
+    context "get more one items" do
+      setup do 
+        @generics = YandexApiDirect::Generic.get "get_clients_list"
+      end
+
+      should "be array" do
+        assert @generics.is_a?(Array)
+      end
+    end
+
+  end
+end

data/test/yandex-api-direct/test_yandex_object.rb

@@ -0,0 +1,131 @@
+# encoding: utf-8
+require 'test_helper'
+
+
+class TestYandexObject < Test::Unit::TestCase
+
+  context "Yandex object" do
+    setup do
+      set_sandbox_access
+    end
+
+    context "initialization" do
+      setup do
+        @args_camelized = {
+          :'Foo'=> "bar",
+          :'BarFoo' => "foo bar",
+          :'Deep' => {
+            :'DarkSide' => "bar"
+          }
+        }
+
+        @object = TestingYandexObject.new @args_camelized
+      end
+
+      should "have added methods for params" do
+        assert_equal @object.foo, "bar"
+        assert_equal @object.bar_foo, "foo bar"
+      end
+
+      context "change keys" do
+        setup do 
+          @args_underscored = {
+            foo: "bar",
+            bar_foo: "foo bar",
+            deep: {
+              dark_side: "bar"
+            }
+          }
+        end
+
+        should "take care about more ID characters Underscore" do
+          assert_equal @object.underscore_keys("CampaignID" => "foo"), {campaign_id: "foo" }
+          assert_equal @object.underscore_keys("FIO" => "foo"), {fio: "foo" }
+        end
+
+        should "take care about more ID characters Camelize" do
+          assert_equal @object.camelize_keys(campaign_id: "foo"), {:"CampaignID" => "foo"}
+          assert_equal @object.camelize_keys(fio: "foo"), {:"FIO" => "foo"}
+        end
+
+        should "underscore keys" do
+          assert_equal @object.underscore_keys(@args_camelized), @args_underscored
+        end
+    
+        should "camelize keys" do
+          assert_equal @object.camelize_keys(@args_underscored), @args_camelized
+        end
+
+        should "camelize keys only for Hash, Array return without update" do
+          assert_equal @object.camelize_keys(["test"]), ["test"]
+        end
+
+      end
+    end
+
+    context "valid call" do
+      setup do
+        stub_request(:post, "https://api-sandbox.direct.yandex.ru/json-api/v4/").to_return(:status => 200, :body => load_fixture("yandex_object_valid_responce.json"))
+        @responce = TestingYandexObject.new.call_method "get_client_info", [YandexApiDirect.config[:login]]
+      end
+      
+      should "return not nil" do
+        assert_not_nil @responce
+      end
+      
+      should "return hash" do
+        assert @responce.is_a?(Hash)
+      end
+
+    end
+
+    context "authorization error" do
+      setup do
+        stub_request(:post, "https://api-sandbox.direct.yandex.ru/json-api/v4/").to_return(:status => 200, :body => "{\"error_detail\":\"\",\"error_str\":\"Authorization error\",\"error_code\":53}")
+      end
+      
+      should "raise exception" do
+        assert_raises YandexApiDirect::YandexAuthorizationError do
+          TestingYandexObject.new.call_method "get_client_info", [YandexApiDirect.config[:login]]
+        end
+      end      
+    end
+
+    context "unknown method error" do
+      setup do
+        stub_request(:post, "https://api-sandbox.direct.yandex.ru/json-api/v4/").to_return(:status => 200, :body => "{\"error_detail\":\"\",\"error_str\":\"Authorization error\",\"error_code\":55}")
+      end
+      
+      should "raise exception" do
+        assert_raises YandexApiDirect::YandexMethodError do
+          TestingYandexObject.new.call_method "unkwnown method", [YandexApiDirect.config[:login]]
+        end
+      end      
+    end
+
+    context "generic error" do
+      setup do
+        stub_request(:post, "https://api-sandbox.direct.yandex.ru/json-api/v4/").to_return(:status => 200, :body => "{\"error_detail\":\"\",\"error_str\":\"Authorization error\",\"error_code\":123}")
+      end
+      
+      should "raise exception" do
+        assert_raises YandexApiDirect::YandexError do
+          TestingYandexObject.new.call_method "get_client_info", [YandexApiDirect.config[:login]]
+        end
+      end      
+    end
+
+    context "bad connection" do
+      setup do
+        stub_request(:post, "https://api-sandbox.direct.yandex.ru/json-api/v4/").to_return(:status => 502, :body => "502 Bad Gateway")
+      end
+      
+      should "raise exception" do
+        assert_raises YandexApiDirect::YandexConnectionError do
+          TestingYandexObject.new.call_method "get_client_info", [YandexApiDirect.config[:login]]
+        end
+      end      
+    end
+
+  end
+end