soapy_cake 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f1b3eafd1d67264317255af0c6a0ec5a7bdf768
-  data.tar.gz: 060efd87807a74298141dc39000b59f029e06974
+  metadata.gz: ffa62a533e0dbfd1cd366b024b007c9a923d4a12
+  data.tar.gz: 5b47bba259aa0ccaafcd0eb6ffb10384b3ea4030
 SHA512:
-  metadata.gz: 27b28c976de97f17fc8e15e3c2a8052d17855f3edc17fe07b1e116cb713f94fcfb2924fb18bd4ee014cfce5ebedecbfbdb6fe63e8ef5c2fe7330b00595f159de
-  data.tar.gz: f4242f62639da6318b213391528d4c6e7e43038567a4da2a8502c208348a04e8db0a84a608a7be5d84e10997cac1751ec9d6da1d2d85634d98141c6b7901b202
+  metadata.gz: cb9a9ceabe4b5733bec4d5b56a2dc33f47564322d92c96af2beda789b9c376fb6aa4dc2e6b1f6bd05e01b2eff16cdeba1d6c7b9ab1b7373a0a974e2b322105a1
+  data.tar.gz: f204021e63684c64c838bb03d45addb6098e0ffb6142cf6fda723c0d97440af1a875b0dcecaf99b5240737240a01afe2be550c262b42a17e56df99b0ffc399b9

data/.rubocop_todo.yml

@@ -0,0 +1,16 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-11-11 15:36:42 +0100 using RuboCop version 0.43.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 27
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 20

data/Gemfile

@@ -4,6 +4,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rubocop-ci', github: 'ad2games/rubocop-ci'
+  gem 'rubocop-ci', git: 'https://github.com/ad2games/rubocop-ci'
+  gem 'simplecov'
   gem 'codeclimate-test-reporter', require: false
 end

data/circle.yml

@@ -4,3 +4,5 @@ dependencies:
 test:
   pre:
     - bundle exec rake rubocop
+  post:
+    - bundle exec codeclimate-test-reporter

data/lib/soapy_cake.rb

@@ -23,6 +23,9 @@ require 'soapy_cake/admin_addedit'
 require 'soapy_cake/admin_track'
 require 'soapy_cake/affiliate'
 
+require 'soapy_cake/modification_type'
+require 'soapy_cake/campaigns'
+
 module SoapyCake
   API_CONFIG = YAML.load(File.read(File.expand_path('../../api.yml', __FILE__)))
   NET_TIMEOUT = 600

data/lib/soapy_cake/admin.rb

@@ -37,7 +37,7 @@ module SoapyCake
     end
 
     def creatives(opts = {})
-      opts = translate_values(opts, %i(creative_type_id creative_status_id))
+      opts = translate_values(opts)
 
       run Request.new(:admin, :export, :creatives, opts)
     end
@@ -80,7 +80,7 @@ module SoapyCake
 
     def caps(opts)
       require_params(opts, %i(start_date end_date))
-      opts = translate_values(opts, %i(cap_type_id))
+      opts = translate_values(opts)
 
       run Request.new(:admin, :reports, :caps, opts)
     end

data/lib/soapy_cake/admin_addedit.rb

@@ -70,29 +70,6 @@ module SoapyCake
       offer_contract_is_default use_fallback_targeting
     ).freeze
 
-    REQUIRED_NEW_CAMPAIGN_PARAMS = %i(
-      affiliate_id offer_id account_status_id payout
-      redirect_404 clear_session_on_conversion paid_upsells
-    ).freeze
-
-    CAMPAIGN_UPDATE_DEFAULT_OPTIONS = {
-      account_status_id: :no_change,
-      auto_disposition_delay_hours: 0,
-      clear_session_on_conversion: 'no_change',
-      currency_id: 0,
-      expiration_date_modification_type: 'do_not_change',
-      media_type_id: 0,
-      paid: 'no_change',
-      paid_redirects: 'no_change',
-      paid_upsells: 'no_change',
-      postback_delay_ms: -1,
-      redirect_404: 'no_change',
-      redirect_offer_contract_id: 0,
-      review: 'no_change',
-      use_offer_contract_payout: 'no_change',
-      payout_update_option: 'do_not_change'
-    }.freeze
-
     def add_offer(opts)
       require_params(opts, REQUIRED_NEW_OFFER_PARAMS)
 
@@ -164,7 +141,7 @@ module SoapyCake
     def update_caps(opts)
       require_params(opts, %i(cap_type_id cap_interval_id cap_amount send_alert_only))
 
-      opts = translate_values(opts, %i(cap_type_id cap_interval_id))
+      opts = translate_values(opts)
 
       run Request.new(:admin, :addedit, :caps, opts)
     end
@@ -172,7 +149,7 @@ module SoapyCake
     def remove_caps(opts)
       require_params(opts, %i(cap_type_id))
 
-      opts = translate_values(opts, %i(cap_type_id))
+      opts = translate_values(opts)
 
       opts = opts.merge(cap_interval_id: 0, cap_amount: -1, send_alert_only: false)
       run Request.new(:admin, :addedit, :caps, opts)
@@ -196,25 +173,13 @@ module SoapyCake
       run Request.new(:admin, :addedit, :advertiser, opts.merge(advertiser_id: 0))
     end
 
-    def add_campaign(opts)
-      require_params(opts, REQUIRED_NEW_CAMPAIGN_PARAMS)
-      addedit_campaign(opts.merge(campaign_id: 0, expiration_date: future_expiration_date))
-    end
-
-    def edit_campaign(opts)
-      require_params(opts, %i(campaign_id))
-      validate_id(opts, :campaign_id)
-
-      addedit_campaign(CAMPAIGN_UPDATE_DEFAULT_OPTIONS.merge(opts))
-    end
-
     private
 
     def addedit_offer_tier(add_edit_option, opts)
       require_params(opts, %i(offer_id tier_id price_format_id offer_contract_id status_id))
 
       opts = opts.merge(redirect_offer_contract_id: -1, add_edit_option: add_edit_option)
-      opts = translate_values(opts, %i(status_id price_format_id))
+      opts = translate_values(opts)
 
       run Request.new(:admin, :addedit, :offer_tiers, opts)
     end
@@ -252,26 +217,16 @@ module SoapyCake
 
       opts = translate_booleans(opts)
       opts = apply_tag_opts(opts)
-      opts = translate_values(opts, %i(
-                                currency_id offer_status_id offer_type_id price_format_id
-                                conversion_cap_behavior conversion_behavior_on_redirect
-                              ))
+      opts = translate_values(opts)
 
       run(Request.new(:admin, :addedit, :offer, default_offer_options.merge(opts)))[:success_info]
     end
 
     def addedit_offer_contract(opts)
       require_params(opts, REQUIRED_OFFER_CONTRACT_PARAMS)
-      opts = translate_values(opts, %i(price_format_id))
+      opts = translate_values(opts)
 
       run Request.new(:admin, :addedit, :offer_contract, opts)
     end
-
-    def addedit_campaign(opts)
-      opts = translate_booleans(opts)
-      opts = translate_values(opts, %i(account_status_id))
-      opts = opts.reverse_merge(display_link_type_id: 1)
-      run Request.new(:admin, :addedit, :campaign, opts)
-    end
   end
 end

data/lib/soapy_cake/campaigns.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+module SoapyCake
+  class Campaigns
+    include Helper
+
+    # TODO: Figure out what `static_suppression` is for and whether it needs to
+    # be in the list.
+    ALL_PARAMS = %i(
+      account_status_id affiliate_id auto_disposition_delay_hours campaign_id
+      clear_session_on_conversion currency_id display_link_type_id
+      expiration_date expiration_date_modification_type media_type_id
+      offer_contract_id offer_id paid paid_redirects paid_upsells payout
+      payout_update_option pixel_html postback_delay_ms postback_url
+      redirect_404 redirect_domain redirect_offer_contract_id review test_link
+      third_party_name unique_key_hash use_offer_contract_payout
+    ).freeze
+
+    NO_CHANGE_VALUES = {
+      account_status_id: 0,
+      expiration_date_modification_type: ModificationType::DO_NOT_CHANGE,
+      currency_id: 0,
+      use_offer_contract_payout: 'no_change',
+      payout_update_option: ModificationType::DO_NOT_CHANGE,
+      paid: 'no_change',
+      paid_redirects: 'no_change',
+      paid_upsells: 'no_change',
+      review: 'no_change',
+      auto_disposition_delay_hours: 0,
+      redirect_offer_contract_id: 0,
+      redirect_404: 'no_change',
+      clear_session_on_conversion: 'no_change',
+      postback_delay_ms: -1
+    }.freeze
+
+    delegate :read_only?, to: :client
+
+    def get(opts = {})
+      client.run Request.new(:admin, :export, :campaigns, opts)
+    end
+
+    def create(opts = {})
+      response = addedit_campaign(opts.merge(campaign_id: 0))
+      response.fetch(:success_info).fetch(:campaign_id)
+    end
+
+    def update(campaign_id, opts = {})
+      opts = opts.merge(campaign_id: campaign_id)
+      opts = opts.merge(payout.options(opts))
+      opts = opts.merge(expiration_date.options(opts))
+      opts = NO_CHANGE_VALUES.merge(opts)
+      require_params(opts, ALL_PARAMS)
+      addedit_campaign(opts)
+      nil
+    end
+
+    def patch(campaign_id, opts = {})
+      campaign = get(campaign_id: campaign_id).first
+      opts = NO_CHANGE_VALUES
+        .merge(
+          affiliate_id: campaign.fetch(:affiliate).fetch(:affiliate_id),
+          # Only present in production:
+          display_link_type_id: campaign.dig(:link_display_type, :link_display_type_id) || 1,
+          media_type_id: campaign.fetch(:media_type).fetch(:media_type_id),
+          offer_contract_id: campaign.fetch(:offer_contract).fetch(:offer_contract_id),
+          offer_id: campaign.fetch(:offer).fetch(:offer_id),
+          payout: campaign.fetch(:payout).fetch(:amount),
+          payout_update_option: 'do_not_change',
+          pixel_html: campaign.dig(:pixel_info, :pixel_html) || '',
+          postback_url: campaign.dig(:pixel_info, :postback_url) || '',
+          redirect_domain: campaign.fetch(:redirect_domain, ''),
+          test_link: campaign[:test_link] || '',
+          unique_key_hash: campaign.dig(:pixel_info, :hash_type, :hash_type_id) || 'none',
+          third_party_name: campaign.fetch(:third_party_name, '')
+        )
+        .merge(opts)
+      update(campaign_id, opts)
+      nil
+    end
+
+    private
+
+    def payout
+      ModificationType.new(:payout, :payout_update_option, 0)
+    end
+
+    def expiration_date
+      ModificationType.new(
+        :expiration_date,
+        :expiration_date_modification_type,
+        Time.utc(1970, 1, 1)
+      )
+    end
+
+    def addedit_campaign(opts)
+      opts = translate_booleans(opts)
+      opts = translate_values(opts)
+      client.run Request.new(:admin, :addedit, :campaign, opts)
+    end
+
+    def client
+      @client ||= Client.new
+    end
+  end
+end

data/lib/soapy_cake/client.rb

@@ -22,10 +22,6 @@ module SoapyCake
       !write_enabled
     end
 
-    protected
-
-    attr_reader :domain, :api_key, :time_converter, :opts, :logger, :retry_count, :write_enabled
-
     def run(request)
       check_write_enabled!(request)
       request.api_key = api_key
@@ -37,6 +33,10 @@ module SoapyCake
       end
     end
 
+    protected
+
+    attr_reader :domain, :api_key, :time_converter, :opts, :logger, :retry_count, :write_enabled
+
     private
 
     def fetch_opt(key, fallback = nil)
@@ -49,7 +49,7 @@ module SoapyCake
     end
 
     def with_retries(&block)
-      opts = { tries: retry_count + 1, on: [RateLimitError, SocketError], sleep: -> (n) { 3**n } }
+      opts = { tries: retry_count + 1, on: [RateLimitError, SocketError], sleep: ->(n) { 3**n } }
       Retryable.retryable(opts, &block)
     end
 

data/lib/soapy_cake/helper.rb

@@ -5,9 +5,9 @@ module SoapyCake
       return nil if obj == {}
 
       case obj
-      when Hash
+      when Hash, Saxerator::Builder::HashElement
         obj.map { |hk, hv| [hk, walk_tree(hv, hk, &block)] }.to_h
-      when Array
+      when Array, Saxerator::Builder::ArrayElement
         obj.map { |av| walk_tree(av, &block) }
       else
         yield(obj, key)
@@ -20,7 +20,7 @@ module SoapyCake
 
     def require_params(opts, params)
       params.each do |param|
-        raise Error, "Parameter '#{param}' missing!" unless opts.key?(param)
+        raise Error, "Parameter '#{param}' missing!" if opts[param].nil?
       end
     end
 
@@ -34,17 +34,22 @@ module SoapyCake
       end
     end
 
-    def translate_values(opts, params)
+    def translate_values(opts)
       opts.map do |k, v|
-        [
-          k,
-          params.include?(k) ? const_lookup(k, v) : v
-        ]
+        id_key = :"#{k}_id"
+
+        if Const::CONSTS.key?(id_key)
+          [id_key, const_lookup(id_key, v)]
+        elsif Const::CONSTS.key?(k) && !v.is_a?(Integer)
+          [k, const_lookup(k, v)]
+        else
+          [k, v]
+        end
       end.to_h
     end
 
     def const_lookup(type, key)
-      Const::CONSTS[type].fetch(key) do
+      Const::CONSTS.fetch(type).fetch(key) do
         raise ArgumentError, "#{key} is not a valid value for #{type}"
       end
     end

data/lib/soapy_cake/modification_type.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+module SoapyCake
+  class ModificationType
+    CHANGE = 'change'
+    REMOVE = 'remove'
+    DO_NOT_CHANGE = 'do_not_change'
+
+    def initialize(key, modification_type_key, default)
+      @key = key
+      @modification_type_key = modification_type_key
+      @default = default
+    end
+
+    def options(input_opts)
+      validate_input(input_opts)
+
+      input_opts.merge(
+        key => value(input_opts),
+        modification_type_key => modification_type(input_opts)
+      )
+    end
+
+    private
+
+    attr_reader :key, :modification_type_key, :default
+
+    def value(input_opts)
+      input_opts.fetch(key, default)
+    end
+
+    def modification_type(input_opts)
+      input_opts.fetch(modification_type_key) do
+        input_opts[key] ? CHANGE : REMOVE
+      end
+    end
+
+    def validate_input(input_opts)
+      return unless input_opts[key].nil? && input_opts[modification_type_key] == CHANGE
+      raise InvalidInput,
+        "`#{modification_type_key}` was '#{CHANGE}', but no `#{key}` was provided to change it to"
+    end
+
+    InvalidInput = Class.new(StandardError)
+  end
+end

data/lib/soapy_cake/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module SoapyCake
-  VERSION = '2.1.0'
+  VERSION = '2.1.1'
 end

data/spec/fixtures/vcr_cassettes/SoapyCake_AdminAddedit/campaigns/edits_a_campaign.yml

@@ -17,6 +17,7 @@ http_interactions:
               <cake:auto_disposition_delay_hours>0</cake:auto_disposition_delay_hours>
               <cake:clear_session_on_conversion>no_change</cake:clear_session_on_conversion>
               <cake:currency_id>0</cake:currency_id>
+              <cake:expiration_date>1970-01-01T01:00:00</cake:expiration_date>
               <cake:expiration_date_modification_type>do_not_change</cake:expiration_date_modification_type>
               <cake:media_type_id>1</cake:media_type_id>
               <cake:paid>no_change</cake:paid>
@@ -28,16 +29,28 @@ http_interactions:
               <cake:review>no_change</cake:review>
               <cake:use_offer_contract_payout>no_change</cake:use_offer_contract_payout>
               <cake:payout_update_option>do_not_change</cake:payout_update_option>
-              <cake:campaign_id>123</cake:campaign_id>
+              <cake:campaign_id>23727</cake:campaign_id>
               <cake:affiliate_id>1</cake:affiliate_id>
               <cake:offer_id>8910</cake:offer_id>
               <cake:payout>1.23</cake:payout>
+              <cake:offer_contract_id>767</cake:offer_contract_id>
+              <cake:pixel_html>&lt;&gt;</cake:pixel_html>
+              <cake:postback_url>http://examle.com/postback</cake:postback_url>
+              <cake:redirect_domain>trk_ad2games.cakemarketing.net</cake:redirect_domain>
+              <cake:test_link>http://example.com/test</cake:test_link>
+              <cake:unique_key_hash>none</cake:unique_key_hash>
             </cake:Campaign>
           </env:Body>
         </env:Envelope>
     headers:
       Content-Type:
       - application/soap+xml;charset=UTF-8
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
   response:
     status:
       code: 200
@@ -54,15 +67,15 @@ http_interactions:
       X-Powered-By:
       - ASP.NET
       Date:
-      - Wed, 04 May 2016 09:44:11 GMT
+      - Thu, 03 Nov 2016 16:08:18 GMT
       Content-Length:
-      - '626'
+      - '631'
     body:
       encoding: UTF-8
       string: <?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Body><CampaignResponse
         xmlns="http://cakemarketing.com/api/3/"><CampaignResult><success>true</success><message>Campaign
-        Updated</message><success_info><campaign_id>123</campaign_id><affiliate_id>-1</affiliate_id><offer_id>5078</offer_id><offer_contract_id>123</offer_contract_id><media_type_id>1</media_type_id><original>true</original></success_info></CampaignResult></CampaignResponse></soap:Body></soap:Envelope>
+        Updated</message><success_info><campaign_id>23727</campaign_id><affiliate_id>13978</affiliate_id><offer_id>7704</offer_id><offer_contract_id>767</offer_contract_id><media_type_id>1</media_type_id><original>true</original></success_info></CampaignResult></CampaignResponse></soap:Body></soap:Envelope>
     http_version: 
   recorded_at: Tue, 17 Feb 2015 12:00:00 GMT
-recorded_with: VCR 3.0.1
+recorded_with: VCR 3.0.3