epom 0.3.3 → 0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2f7ff464e113173d1226be61d7f539ee678f5f0
-  data.tar.gz: 2396838f749d1781d4d40efe8ab81ec8db05c19c
+  metadata.gz: 21b944bfdb65f1df249b459bd138aaa74065882c
+  data.tar.gz: 1140a8e3f043eb92f19878d98222345eb38398e1
 SHA512:
-  metadata.gz: e92d8fa8eea1609a637bcd9539189390d864d871b924bb60729ed9721b91a3f2e788582999c195eccad82ac48db630194e564f1eda8f6cd6e5062911f8f21249
-  data.tar.gz: 6df4a1a6e3bb530616907f136411b1b924dec603c530bb1c1a1842d5a02ab78362817a66c288c6d5c6922dd3c9a95419eb7471aaca348db34695566b0265fecd
+  metadata.gz: e8de4951251283334aaaf9b9fc236915510699b6e46dc71cb8cfa59b34ef1479f394a6072d5130f227e72fc90527ceab6e1b9c54a46b8fbc81c58a62166cf9fc
+  data.tar.gz: 1553904d2cd5b10cfed9405400e2bdd90b6c2e3ce234997d5ba75bfbd7cccea5770d4247a9f965debf80274cab942faa96b62d573a1ae800bb4f720dc6984a28

data/lib/epom/analytic.rb

@@ -0,0 +1,27 @@
+require 'epom/epom_element'
+
+module Epom
+  class Analytic < EpomElement
+
+    def self.extended_methods
+      {
+        :analytics => {
+          :url => '/rest-api/analytics/FORMAT/LOGIN/HASH/TIMESTAMP.do',
+          :url_parameters => [:format, :login, :hash, :timestamp],
+          :body_parameters => [:customFrom, :customTo, :hourFrom, :hourTo, :groupRange, :displayIds, :statisticType, :range, :groupBy, :filterBy, :eqStr, :eqLong],
+          :method => :get,
+          :format => nil
+        }
+      }
+    end
+
+    def self.replace_params_in_url(url, url_params)
+      url.gsub!('FORMAT', url_params[:format]) if url.include?('FORMAT')
+      url.gsub!('LOGIN', url_params[:login]) if url.include?('LOGIN')
+      url.gsub!('HASH', url_params[:hash]) if url.include?('HASH')
+      url.gsub!('TIMESTAMP', url_params[:timestamp].to_s) if url.include?('TIMESTAMP')
+      url
+    end
+
+  end
+end

data/lib/epom/campaign.rb

@@ -444,6 +444,10 @@ module Epom
               :body_parameters => [:name, :clickToConversionTimeFrame, :clickToConversionTimeFramePeriodType, :viewToConversionTimeFrame, :viewToConversionTimeFramePeriodType, :hash, :timestamp, :username],
               :method => :post
           },
+
+          ###########################
+          # Campaign Pricing API
+          ###########################
           :disable_campaign_country_pricing => {
               :url => '/rest-api/campaigns/CAMPAIGN_ID/pricing/COUNTRY_CODE.do',
               :url_parameters => [:campaignId, :countryCode],
@@ -489,7 +493,7 @@ module Epom
           :update_campaign_pricing => {
               :url => '/rest-api/campaign/CAMPAIGN_ID/pricing.do',
               :url_parameters => [:campaignId],
-              :body_parameters => [:hash, :timestamp, :username],
+              :body_parameters => [:price, :hash, :timestamp, :username],
               :method => :post
           },
       }

data/lib/epom/epom_element.rb

@@ -4,7 +4,6 @@ module Epom
     include HTTMultiParty
       base_uri 'https://n29.epom.com/'
       default_params :output => 'json'
-      format :json
       debug_output $stderr
 
     def self.extended_methods
@@ -33,6 +32,13 @@ module Epom
         default_options[:headers] = {}
       end
 
+      if signature.has_key?(:format)
+        format signature[:format]
+      else
+        format :json
+      end
+
+
       if params_validation(url_params, url_params_signature) and params_validation(body_params, body_params_signature)
         http_proxy ENV['proxy_address'], ENV['proxy_port'], ENV['proxy_user'], ENV['proxy_password']
         response = send(method, url, :query => body_params)

data/lib/epom/version.rb

@@ -1,3 +1,3 @@
 module Epom
-  VERSION = '0.3.3'
+  VERSION = '0.4'
 end

data/test/epom/analytic_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+require 'epom/analytic'
+
+class AnalyticTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Class, Epom::Analytic
+  end
+
+  test "analytics" do
+    timestamp = Time.now.to_i * 1000
+    url_params = {
+      :format => 'CSV',
+      :login => ENV['username'],
+      :timestamp => timestamp,
+      :hash => Epom.create_hash(Epom.create_hash(ENV['password']), timestamp)
+    }
+    body_params = {    
+      :displayIds => true,
+      :range => 'CURRENT_MONTH',
+      :groupBy => 'ADVERTISER,CAMPAIGN,BANNER,SITE,ZONE,PLACEMENT',
+    }
+
+    response = Epom::Analytic.analytics(url_params, body_params)
+    assert_not_instance_of Fixnum, response
+  end
+end

data/test/epom/campaign_test.rb

@@ -6,10 +6,51 @@ class CampaignTest < ActiveSupport::TestCase
     assert_kind_of Class, Epom::Campaign
   end
 
-  test "get_actions" do
+  test "create_campaign" do
+    timestamp = Time.now.to_i * 1000
+    body_params = {
+      :advertiserId => ENV['advertiser_id'], 
+      :hash => Epom.create_hash(Epom.create_hash(ENV['password']), timestamp),
+      :timestamp => timestamp, 
+      :username => ENV['username'],
+      :name => "campaign #{timestamp}",
+      :description => "description for campaign #{timestamp}",
+      :active => true}
+
+    response = Epom::Campaign.create_campaign({}, body_params)
+    assert_instance_of Hash, response
+    assert_instance_of Fixnum, response['id']
+    assert_instance_of String, response['name']
+  end  
+
+  test "update_campaign" do
     timestamp = Time.now.to_i * 1000
     url_params = {
-      :campaignId => ENV['campaign_id'],
+      :campaignId => ENV['campaign_id']
+    }
+    body_params = {
+      :advertiserId => ENV['advertiser_id'], 
+      :hash => Epom.create_hash(Epom.create_hash(ENV['password']), timestamp),
+      :timestamp => timestamp, 
+      :username => ENV['username'],
+      :name => "campaign #{timestamp}",
+      :description => "description for campaign #{timestamp}",
+      :active => true}
+
+    response = Epom::Campaign.update_campaign(url_params, body_params)
+    assert_instance_of Hash, response
+    assert response['success']
+
+    campaign = test_get_campaign()
+    assert_instance_of Hash, campaign
+    assert_equal ENV['campaign_id'], campaign['id'].to_s
+    assert_equal "campaign #{timestamp}", campaign['name']
+  end  
+
+  test "get_click_capping" do
+    timestamp = Time.now.to_i * 1000
+    url_params = {
+      :campaignId => ENV['campaign_id']
     }
     body_params = {
       :hash => Epom.create_hash(Epom.create_hash(ENV['password']), timestamp),
@@ -17,12 +58,217 @@ class CampaignTest < ActiveSupport::TestCase
       :username => ENV['username'],
     }
 
-    response = Epom::Campaign.get_actions(url_params, body_params)
+    response = Epom::Campaign.get_click_capping(url_params, body_params)
     assert_instance_of Array, response
     if response.count > 0
       first = response[0]
-      assert_instance_of String, first['key']
-    end
+      assert_instance_of Hash, first
+      assert_instance_of Fixnum, first['id']
+      assert_instance_of Fixnum, first['amount']
+      assert_instance_of String, first['periodType']
+      assert_instance_of Fixnum, first['period']
+    end  
+    response
+  end  
+
+  test "set_click_capping" do
+    timestamp = Time.now.to_i * 1000
+    url_params = {
+      :campaignId => ENV['campaign_id']
+    }
+    body_params = {
+      :hash => Epom.create_hash(Epom.create_hash(ENV['password']), timestamp),
+      :timestamp => timestamp, 
+      :username => ENV['username'],
+      :amount => [1,2,3,4,5,6,7].sample,
+      :evenDistribution => true,
+      :periodType => 'HOUR',
+      :period => 2
+    }
+
+    response = Epom::Campaign.set_click_capping(url_params, body_params)
+
+    click_cappings = test_get_click_capping()
+    click_capping = click_cappings.find { |cc| cc['amount'] == body_params[:amount] }
+    assert_instance_of Hash, click_capping
+    assert_instance_of Fixnum, click_capping['id']
+    assert_equal true, click_capping['evenDistribution']
+    assert_equal 'HOUR', click_capping['periodType']
+    assert_equal 2, click_capping['period']
+  end  
+
+  test "get_limits" do
+    timestamp = Time.now.to_i * 1000
+    url_params = {
+      :campaignId => ENV['campaign_id'],
+    }
+    body_params = {
+      :hash => Epom.create_hash(Epom.create_hash(ENV['password']), timestamp),
+      :timestamp => timestamp, 
+      :username => ENV['username'],
+    }
+
+    response = Epom::Campaign.get_limits(url_params, body_params)
+    assert_instance_of Hash, response
+    response
+  end  
+
+  test "set_limits" do
+    timestamp = Time.now.to_i * 1000
+    url_params = {
+      :campaignId => ENV['campaign_id'],
+    }
+    body_params = {
+      :hash => Epom.create_hash(Epom.create_hash(ENV['password']), timestamp),
+      :timestamp => timestamp, 
+      :username => ENV['username'],
+      :totalImpressionsLimit => 100, 
+      :dailyImpressionsLimit => 20,
+      :totalClicksLimit => 50,
+      :dailyClicksLimit => 10,
+      :totalBudgetLimit => 50,
+      :dailyBudgetLimit => 10, 
+      :startDate => DateTime.now.strftime('%Y-%m-%d-%H-%M'), 
+      :endDate => Date.tomorrow.strftime('%Y-%m-%d-%H-%M'),
+    }
+
+    response = Epom::Campaign.set_limits(url_params, body_params)
+
+    limit = test_get_limits()
+    assert_instance_of Hash, limit
+    assert_equal body_params[:totalImpressionsLimit], limit['totalImpressionsLimit']
+    assert_equal body_params[:dailyImpressionsLimit], limit['dailyImpressionsLimit']
+    assert_equal body_params[:totalClicksLimit], limit['totalClicksLimit']
+    assert_equal body_params[:dailyClicksLimit], limit['dailyClicksLimit']
+    assert_equal body_params[:totalBudgetLimit], limit['totalBudgetLimit']
+    assert_equal body_params[:dailyBudgetLimit], limit['dailyBudgetLimit']
+    assert_equal body_params[:startDate], limit['startDate']
+    assert_equal body_params[:endDate], limit['endDate']
+  end  
+
+  test "create_cookie_value_target" do
+    timestamp = Time.now.to_i * 1000
+    url_params = {
+      :campaignId => ENV['campaign_id'],
+    }
+    body_params = {
+      :hash => Epom.create_hash(Epom.create_hash(ENV['password']), timestamp),
+      :timestamp => timestamp, 
+      :username => ENV['username'],
+      :cookieName => 'age',
+      :cookieValue => '20',
+      :rule => 'INCLUDE'
+    }
+
+    response = Epom::Campaign.create_cookie_value_target(url_params, body_params)
+    assert_instance_of Hash, response
+    assert_instance_of Fixnum, response['id']
+    assert_equal body_params[:cookieName], response['cookieName']
+    assert_equal body_params[:cookieValue], response['cookieValue']
+  end  
+
+  test "create_country_target" do
+    timestamp = Time.now.to_i * 1000
+    url_params = {
+      :campaignId => ENV['campaign_id'],
+    }
+    body_params = {
+      :hash => Epom.create_hash(Epom.create_hash(ENV['password']), timestamp),
+      :timestamp => timestamp, 
+      :username => ENV['username'],
+      :countryCode => ENV['country_code'],
+      :rule => 'INCLUDE'
+    }
+
+    response = Epom::Campaign.create_country_target(url_params, body_params)
+    assert_instance_of Hash, response
+    assert_instance_of Fixnum, response['id']
+    assert_equal 'COUNTRY', response['type']
+  end  
+
+  test "create_custom_parameter_target" do
+    timestamp = Time.now.to_i * 1000
+    url_params = {
+      :campaignId => ENV['campaign_id'],
+    }
+    body_params = {
+      :hash => Epom.create_hash(Epom.create_hash(ENV['password']), timestamp),
+      :timestamp => timestamp, 
+      :username => ENV['username'],
+      :expression => "($p1==1 || $p1=='a') && ($p2>=12 && $p2<=22)",
+      :rule => 'INCLUDE'
+    }
+
+    response = Epom::Campaign.create_custom_parameter_target(url_params, body_params)
+    assert_instance_of Hash, response
+    assert_instance_of Fixnum, response['id']
+    assert_equal 'CUSTOM', response['type']
+  end  
+
+  test "create_language_target" do
+    timestamp = Time.now.to_i * 1000
+    url_params = {
+      :campaignId => ENV['campaign_id'],
+    }
+    body_params = {
+      :hash => Epom.create_hash(Epom.create_hash(ENV['password']), timestamp),
+      :timestamp => timestamp, 
+      :username => ENV['username'],
+      :languageCode => 'en',
+      :rule => 'INCLUDE'
+    }
+
+    response = Epom::Campaign.create_language_target(url_params, body_params)
+    assert_instance_of Hash, response
+    assert_instance_of Fixnum, response['id']
+    assert_equal 'LANGUAGE', response['type']
+  end  
+
+  test "disable_targeting" do
+    timestamp = Time.now.to_i * 1000
+    url_params = {
+      :campaignId => ENV['campaign_id'],
+    }
+    body_params = {
+      :hash => Epom.create_hash(Epom.create_hash(ENV['password']), timestamp),
+      :timestamp => timestamp, 
+      :username => ENV['username'],
+    }
+
+    response = Epom::Campaign.disable_targeting(url_params, body_params)
+    assert_not_instance_of Fixnum, response
+  end  
+
+  test "enable_targeting" do
+    timestamp = Time.now.to_i * 1000
+    url_params = {
+      :campaignId => ENV['campaign_id'],
+    }
+    body_params = {
+      :hash => Epom.create_hash(Epom.create_hash(ENV['password']), timestamp),
+      :timestamp => timestamp, 
+      :username => ENV['username'],
+    }
+
+    response = Epom::Campaign.enable_targeting(url_params, body_params)
+    assert_not_instance_of Fixnum, response
+  end  
+
+  test "get_targeting" do
+    timestamp = Time.now.to_i * 1000
+    url_params = {
+      :campaignId => ENV['campaign_id'],
+      :targetId => '3929'
+    }
+    body_params = {
+      :hash => Epom.create_hash(Epom.create_hash(ENV['password']), timestamp),
+      :timestamp => timestamp, 
+      :username => ENV['username'],
+    }
+
+    response = Epom::Campaign.get_targeting(url_params, body_params)
+    assert_instance_of Hash, response
+    assert_instance_of Fixnum, response['id']
   end  
 
   test "get_targetings" do
@@ -42,30 +288,92 @@ class CampaignTest < ActiveSupport::TestCase
       first = response[0]
       assert_instance_of Fixnum, first['id']
     end
-  end  
+  end
 
-  test "create_campaign" do
-  	timestamp = Time.now.to_i * 1000
+  test "get_campaign" do
+    timestamp = Time.now.to_i * 1000
+    url_params = {
+      :campaignId => ENV['campaign_id']
+    }
     body_params = {
-  		:advertiserId => ENV['advertiser_id'], 
-  		:hash => Epom.create_hash(Epom.create_hash(ENV['password']), timestamp),
-  		:timestamp => timestamp, 
-  		:username => ENV['username'],
-      :name => "campaign #{timestamp}",
-      :description => "description for campaign #{timestamp}",
-      :active => true}
-
-  	response = Epom::Campaign.create_campaign({}, body_params)
+      :hash => Epom.create_hash(Epom.create_hash(ENV['password']), timestamp),
+      :timestamp => timestamp, 
+      :username => ENV['username'],
+    }
+      
+    response = Epom::Campaign.get_campaign(url_params, body_params)
     assert_instance_of Hash, response
     assert_instance_of Fixnum, response['id']
     assert_instance_of String, response['name']
+    response
+  end
+
+  ##########################
+  ## Campaign Adjusted CPM API
+  ##########################
+
+  test "add_fixed_cpm_country_pricing" do
+    timestamp = Time.now.to_i * 1000
+    url_params = {
+      :campaignId => ENV['campaign_id']
+    }
+    body_params = {
+      :hash => Epom.create_hash(Epom.create_hash(ENV['password']), timestamp),
+      :timestamp => timestamp, 
+      :username => ENV['username'],
+      :countryCode => ENV['country_code'],
+      :value => '2.5',
+      :date => DateTime.now.strftime('%Y-%m-%d-%H-%M')
+    }
+      
+    response = Epom::Campaign.add_fixed_cpm_country_pricing(url_params, body_params)
+    assert_instance_of Hash, response
+    assert_instance_of Fixnum, response['id']
+    assert response['success']
+  end
+
+  test "adjusted_cpm_list" do
+    timestamp = Time.now.to_i * 1000
+    url_params = {
+      :campaignId => ENV['campaign_id']
+    }
+    body_params = {
+      :hash => Epom.create_hash(Epom.create_hash(ENV['password']), timestamp),
+      :timestamp => timestamp, 
+      :username => ENV['username'],
+    }
+      
+    # PENDING
+    # response = Epom::Campaign.adjusted_cpm_list(url_params, body_params)
+  end
+
+  ##########################
+  ## Campaign Action Management API
+  ##########################
+
+  test "get_actions" do
+    timestamp = Time.now.to_i * 1000
+    url_params = {
+      :campaignId => ENV['campaign_id'],
+    }
+    body_params = {
+      :hash => Epom.create_hash(Epom.create_hash(ENV['password']), timestamp),
+      :timestamp => timestamp, 
+      :username => ENV['username'],
+    }
+
+    response = Epom::Campaign.get_actions(url_params, body_params)
+    assert_instance_of Array, response
+    if response.count > 0
+      first = response[0]
+      assert_instance_of String, first['key']
+    end
   end  
 
-  test "get_targeting" do
+  test "get_campaign_pricing" do
     timestamp = Time.now.to_i * 1000
     url_params = {
       :campaignId => ENV['campaign_id'],
-      :targetId => '3929'
     }
     body_params = {
       :hash => Epom.create_hash(Epom.create_hash(ENV['password']), timestamp),
@@ -73,9 +381,47 @@ class CampaignTest < ActiveSupport::TestCase
       :username => ENV['username'],
     }
 
-    response = Epom::Campaign.get_targeting(url_params, body_params)
+    response = Epom::Campaign.get_campaign_pricing(url_params, body_params)
     assert_instance_of Hash, response
     assert_instance_of Fixnum, response['id']
+    assert_instance_of String, response['paymentModel']
+    response
+  end  
+
+  test "update_campaign_country_pricing" do
+    timestamp = Time.now.to_i * 1000
+    url_params = {
+      :campaignId => ENV['campaign_id'],
+      :countryCode => ENV['country_code']
+    }
+    body_params = {
+      :hash => Epom.create_hash(Epom.create_hash(ENV['password']), timestamp),
+      :timestamp => timestamp, 
+      :username => ENV['username'],
+      :price => [1.1, 2.3, 3.1].sample
+    }
+
+    response = Epom::Campaign.update_campaign_country_pricing(url_params, body_params)
+    assert_not_instance_of Fixnum, response
+  end  
+
+  test "update_campaign_pricing" do
+    timestamp = Time.now.to_i * 1000
+    url_params = {
+      :campaignId => ENV['campaign_id'],
+    }
+    body_params = {
+      :hash => Epom.create_hash(Epom.create_hash(ENV['password']), timestamp),
+      :timestamp => timestamp, 
+      :username => ENV['username'],
+      :price => 2.9
+    }
+
+    response = Epom::Campaign.update_campaign_pricing(url_params, body_params)
+    assert_not_instance_of Fixnum, response
+
+    pricing = test_get_campaign_pricing()
+    assert_equal 2.9, body_params[:price]
   end  
 
   define_get_tests_auto(Epom::Campaign)

data/test/test_helper.rb

@@ -1,11 +1,10 @@
-require 'yaml'
-
 require "codeclimate-test-reporter"
 CodeClimate::TestReporter.start
 
 # Configure Rails Environment
 ENV["RAILS_ENV"] = "test"
 
+require 'yaml'
 env_file = File.join(Pathname.new(__FILE__).parent.parent, 'config', 'application.yml')
 YAML.load(File.open(env_file)).each do |key, value|
   ENV[key.to_s] = value.to_s

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: epom
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: '0.4'
 platform: ruby
 authors:
 - Pedro Quintero
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-28 00:00:00.000000000 Z
+date: 2015-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -107,6 +107,7 @@ files:
 - lib/epom.rb
 - lib/epom/ad_unit_size.rb
 - lib/epom/advertiser.rb
+- lib/epom/analytic.rb
 - lib/epom/auth.rb
 - lib/epom/banner.rb
 - lib/epom/banner_type.rb
@@ -160,6 +161,7 @@ files:
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
 - test/epom/advertiser_test.rb
+- test/epom/analytic_test.rb
 - test/epom/auth_test.rb
 - test/epom/banner_test.rb
 - test/epom/campaign_test.rb
@@ -208,6 +210,7 @@ test_files:
 - test/epom/campaign_test.rb
 - test/epom/banner_test.rb
 - test/epom/auth_test.rb
+- test/epom/analytic_test.rb
 - test/epom/advertiser_test.rb
 - test/dummy/config.ru
 - test/dummy/Rakefile