soapy_cake 2.2.1 → 2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da80a1e33c7b95e91a5bd942846a9028ae2866e5
-  data.tar.gz: 642af06412ab6edf7d3c54cf7d0bc122f497dd8a
+  metadata.gz: db53a85a24c32bedc5424cb71fa94299d1b2b656
+  data.tar.gz: 6ff419a8734b6c665d239c9f277abfce3a6e7d3a
 SHA512:
-  metadata.gz: bb8ccda5ad2682c9068a06b7ed5e68cc63b1a6685b4bfc0e54aa11ee084a575950a6ebe662ca4511accb563e530353514bd5830d91b83c266c216225844540a3
-  data.tar.gz: 974c65b039671c8a79e95053c7f5b52045d1deec988fd96f45ffa8dc90ec86090bb5da56fb1ef195a4ad047d09eaf2e7a74f925d238fcb22c7c51a700dcc5145
+  metadata.gz: e7ef921b6577c7e37f9fc448199f1b832ff556cd9ad63dfc2db1377a66160185eda2669f1067c48a7266155d2190f6f45699fa8c0f42b266981faaf8ff949d91
+  data.tar.gz: 7be351d763c9cafebd1f500e6a3cf6b3c879e26e821d96e7e701f09ec103a6e798037dca7d87aa5e8157a2a217ff345f7fc8e86693945551a3e157e73c14052a

data/.ruby-version

@@ -1 +1 @@
-2.3.4
+2.4.1

data/lib/soapy_cake/admin_addedit.rb

@@ -174,8 +174,60 @@ module SoapyCake
       run Request.new(:admin, :addedit, :advertiser, opts.merge(advertiser_id: 0))
     end
 
+    ALLOWED_CREATIVE_OPTS = %i[
+      creative_name
+      creative_status_id
+      creative_type_id
+      height
+      notes
+      offer_id
+      offer_link
+      third_party_name
+      width
+    ].freeze
+
+    ALLOWED_CREATIVE_FILES_OPTS = %i[
+      creative_file_id
+      creative_file_import_url
+      creative_id
+      is_preview_file
+      replace_all_files
+    ].freeze
+
+    def create_creative(opts)
+      raise 'need offer_id to create creative' if opts[:offer_id].blank?
+      raise 'cannot pass creative_id when creating creative' if opts[:creative_id].present?
+
+      creative_opts = opts.select { |key, _| ALLOWED_CREATIVE_OPTS.include? key }
+      create_result = addedit_creative(creative_opts)
+
+      files_opts = opts.select { |key, _| ALLOWED_CREATIVE_FILES_OPTS.include? key }
+        .merge(creative_id: create_result[:creative_id])
+
+      create_result.merge(addedit_creative_files(files_opts)).except(:message)
+    end
+
     private
 
+    def addedit_creative(opts)
+      defaults = {
+        creative_name: '',
+        creative_status_id: 1, # Active: 1, Inactive: 2, Hidden: 3
+        creative_type_id: 3, # Link: 1, Image: 3, Flash: 4, HTML: 6, Email: 2, Text: 5, Video: 7
+        height: 0,
+        notes: '',
+        offer_link: '',
+        third_party_name: '',
+        width: 0
+      }
+
+      run Request.new(:admin, :addedit, :creative, defaults.merge(opts))
+    end
+
+    def addedit_creative_files(opts)
+      run Request.new(:admin, :addedit, :creative_files, opts)
+    end
+
     def addedit_offer_tier(add_edit_option, opts)
       require_params(opts, %i[offer_id tier_id price_format_id offer_contract_id status_id])
 

data/lib/soapy_cake/client.rb

@@ -36,7 +36,7 @@ module SoapyCake
 
     protected
 
-    attr_reader :domain, :api_key, :time_converter, :opts, :logger, :retry_count, :write_enabled
+    attr_reader :domain, :api_key, :time_converter, :opts, :retry_count, :write_enabled
 
     private
 
@@ -82,7 +82,12 @@ module SoapyCake
       response = perform_http_request(http_request)
 
       unless response.is_a?(Net::HTTPSuccess)
-        raise RequestFailed, "Request failed with HTTP #{response.code}: #{response.body}"
+        raise RequestFailed.new(
+          "Request failed with HTTP #{response.code}",
+          request_path: request.path,
+          request_body: http_request.body,
+          response_body: response.body
+        )
       end
 
       response.body

data/lib/soapy_cake/error.rb

@@ -2,6 +2,17 @@
 
 module SoapyCake
   class Error < RuntimeError; end
-  class RequestFailed < Error; end
+
+  class RequestFailed < Error
+    attr_reader :request_path, :request_body, :response_body
+
+    def initialize(message, request_path: nil, request_body: nil, response_body: nil)
+      @request_path = request_path
+      @request_body = request_body&.sub(ENV.fetch('CAKE_API_KEY'), '[redacted]')
+      @response_body = response_body
+      super(message)
+    end
+  end
+
   class RateLimitError < RequestFailed; end
 end

data/lib/soapy_cake/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SoapyCake
-  VERSION = '2.2.1'
+  VERSION = '2.2.3'
 end

data/soapy_cake.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 # frozen_string_literal: true
 
 lib = File.expand_path('../lib', __FILE__)
@@ -21,16 +20,16 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport'
-  spec.add_dependency 'saxerator'
   spec.add_dependency 'nokogiri'
   spec.add_dependency 'retryable'
+  spec.add_dependency 'saxerator'
 
   spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '>= 3.0.0'
+  spec.add_development_dependency 'timecop'
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'webmock'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'timecop'
-  spec.add_development_dependency 'dotenv'
 end

data/spec/fixtures/vcr_cassettes/SoapyCake_AdminAddedit/_create_creatives/creates_a_creative_and_adds_a_file_to_it.yml

@@ -0,0 +1,116 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://cake-partner-domain.com/api/1/addedit.asmx
+    body:
+      encoding: ASCII-8BIT
+      string: |
+        <?xml version="1.0"?>
+        <env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" xmlns:cake="http://cakemarketing.com/api/1/">
+          <env:Header/>
+          <env:Body>
+            <cake:Creative>
+              <cake:api_key>cake-api-key</cake:api_key>
+              <cake:creative_name>creative_name</cake:creative_name>
+              <cake:creative_status_id>1</cake:creative_status_id>
+              <cake:creative_type_id>3</cake:creative_type_id>
+              <cake:height>0</cake:height>
+              <cake:notes/>
+              <cake:offer_link/>
+              <cake:third_party_name/>
+              <cake:width>0</cake:width>
+              <cake:offer_id>11428</cake:offer_id>
+            </cake:Creative>
+          </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
+      message: OK
+    headers:
+      Cache-Control:
+      - private, max-age=0
+      Content-Length:
+      - '450'
+      Content-Type:
+      - application/soap+xml; charset=utf-8
+      Date:
+      - Thu, 03 Aug 2017 09:25:39 GMT
+      X-Aspnet-Version:
+      - 4.0.30319
+      X-Powered-By:
+      - ASP.NET
+      Connection:
+      - close
+    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><CreativeResponse
+        xmlns="http://cakemarketing.com/api/1/"><CreativeResult><success>true</success><message>Creative
+        12164 Created</message><creative_id>12164</creative_id></CreativeResult></CreativeResponse></soap:Body></soap:Envelope>
+    http_version: 
+  recorded_at: Tue, 17 Feb 2015 12:00:00 GMT
+- request:
+    method: post
+    uri: https://cake-partner-domain.com/api/1/addedit.asmx
+    body:
+      encoding: ASCII-8BIT
+      string: |
+        <?xml version="1.0"?>
+        <env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" xmlns:cake="http://cakemarketing.com/api/1/">
+          <env:Header/>
+          <env:Body>
+            <cake:CreativeFiles>
+              <cake:api_key>cake-api-key</cake:api_key>
+              <cake:creative_file_import_url>http://placehold.it/300x250</cake:creative_file_import_url>
+              <cake:creative_id>12164</cake:creative_id>
+            </cake:CreativeFiles>
+          </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
+      message: OK
+    headers:
+      Cache-Control:
+      - private, max-age=0
+      Content-Length:
+      - '621'
+      Content-Type:
+      - application/soap+xml; charset=utf-8
+      Date:
+      - Thu, 03 Aug 2017 09:25:40 GMT
+      X-Aspnet-Version:
+      - 4.0.30319
+      X-Powered-By:
+      - ASP.NET
+      Connection:
+      - close
+    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><CreativeFilesResponse
+        xmlns="http://cakemarketing.com/api/1/"><CreativeFilesResult><success>true</success><message>Creative
+        Files 8015 Created.</message><creative_files><creative_file><creative_file_id>8015</creative_file_id><creative_file_name>300x250</creative_file_name><updated>false</updated></creative_file></creative_files></CreativeFilesResult></CreativeFilesResponse></soap:Body></soap:Envelope>
+    http_version: 
+  recorded_at: Tue, 17 Feb 2015 12:00:00 GMT
+recorded_with: VCR 3.0.3

data/spec/integration/soapy_cake/admin_addedit_spec.rb

@@ -284,4 +284,25 @@ RSpec.describe SoapyCake::AdminAddedit do
       expect(result[:message]).to eq('Offer Tier Replaced')
     end
   end
+
+  describe '#create_creatives' do
+    it 'creates a creative and adds a file to it', :vcr do
+      result = admin_addedit.create_creative(
+        offer_id: 11428,
+        creative_name: 'creative_name',
+        creative_file_import_url: 'http://placehold.it/300x250'
+      )
+      expect(result).to eq(
+        creative_files: {
+          creative_file: {
+            creative_file_id: 8015,
+            creative_file_name: '300x250',
+            updated: false
+          }
+        },
+        creative_id: 12164,
+        success: true
+      )
+    end
+  end
 end

data/spec/integration/soapy_cake/admin_spec.rb

@@ -66,9 +66,12 @@ RSpec.describe SoapyCake::Admin do
   end
 
   it 'raises if there is an error', :vcr do
-    expect do
-      admin.affiliates(affiliate_id: 'bloops')
-    end.to raise_error(SoapyCake::RequestFailed)
+    expect { admin.affiliates(affiliate_id: 'bloops') }
+      .to raise_error(SoapyCake::RequestFailed) do |e|
+        expect(e.request_path).to eq('/api/5/export.asmx')
+        expect(e.request_body).to include('<cake:affiliate_id>bloops</cake:affiliate_id>')
+        expect(e.response_body).to include('There is an error in XML document')
+      end
   end
 
   it 'creates an affiliate and returns the ID', :vcr do

data/spec/lib/soapy_cake/admin_addedit_spec.rb

@@ -136,4 +136,46 @@ RSpec.describe SoapyCake::AdminAddedit do
       admin_addedit.add_geo_targets(base_opts)
     end
   end
+
+  describe '#create_creative' do
+    context 'when no offer id was passed' do
+      it 'raises an error' do
+        expect { admin_addedit.create_creative({}) }.to raise_error(
+          'need offer_id to create creative'
+        )
+      end
+    end
+
+    context 'when creative id was passed' do
+      it 'raises an error' do
+        expect { admin_addedit.create_creative(offer_id: 10, creative_id: 11) }.to raise_error(
+          'cannot pass creative_id when creating creative'
+        )
+      end
+    end
+
+    context 'when given the right parameters' do
+      it 'creates a creative and adds a file to it' do
+        expect(admin_addedit).to receive(:addedit_creative).with(
+          offer_id: 10, creative_name: 'creative_name'
+        ).and_return(
+          success: true, message: 'Creative 12163 Created', creative_id: 12163
+        )
+        expect(admin_addedit).to receive(:addedit_creative_files).with(
+          creative_id: 12163, creative_file_import_url: 'http://www.example.org/image.png'
+        ).and_return(
+          success: true, message: 'Creative Files 8013 Created.', creative_files: {
+            creative_file: {
+              creative_file_id: 8013, creative_file_name: 'image.jpg', updated: false
+            }
+          }
+        )
+        admin_addedit.create_creative(
+          offer_id: 10,
+          creative_name: 'creative_name',
+          creative_file_import_url: 'http://www.example.org/image.png'
+        )
+      end
+    end
+  end
 end

data/spec/lib/soapy_cake/request_failed_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+RSpec.describe SoapyCake::RequestFailed do
+  it 'has request related attributes' do
+    error = described_class.new(
+      'Boo!',
+      request_path: 'request path',
+      request_body: 'request body',
+      response_body: 'response body'
+    )
+    expect(error).to have_attributes(
+      'request_path' => 'request path',
+      'request_body' => 'request body',
+      'response_body' => 'response body'
+    )
+  end
+
+  it 'redacts the API key from the request body' do
+    error = described_class.new('Boo!', request_body: ">#{ENV.fetch('CAKE_API_KEY')}<")
+    expect(error.request_body).to eq('>[redacted]<')
+  end
+end

data/spec/lib/soapy_cake/response_spec.rb

@@ -2,7 +2,7 @@
 
 RSpec.describe SoapyCake::Response do
   let(:xml) do
-    <<-EOD
+    <<-XML
       <?xml version="1.0" encoding="utf-8"?>
       <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
         <soap:Body>
@@ -22,7 +22,7 @@ RSpec.describe SoapyCake::Response do
           </SomeResponse>
         </soap:Body>
       </soap:Envelope>
-    EOD
+    XML
   end
 
   subject(:response) { described_class.new(xml.strip, false, 0) }
@@ -32,9 +32,6 @@ RSpec.describe SoapyCake::Response do
   end
 
   it 'parses the CAKE XML structure properly' do
-    expect(response.to_enum.to_a).to eq([
-                                          { id: '123' },
-                                          { id: '312' }
-                                        ])
+    expect(response.to_enum.to_a).to eq([{ id: '123' }, { id: '312' }])
   end
 end

data/spec/lib/soapy_cake/time_converter_spec.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# rubocop:disable Style/DateTime
 RSpec.describe SoapyCake::TimeConverter do
   subject(:time_converter) { described_class.new('Europe/Berlin') }
 
@@ -37,3 +38,4 @@ RSpec.describe SoapyCake::TimeConverter do
     end
   end
 end
+# rubocop:enable Style/DateTime

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soapy_cake
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.3
 platform: ruby
 authors:
 - ad2games GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-14 00:00:00.000000000 Z
+date: 2018-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: saxerator
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: retryable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: retryable
+  name: saxerator
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,21 +95,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,21 +123,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -165,7 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -225,6 +225,7 @@ files:
 - spec/fixtures/vcr_cassettes/SoapyCake_Admin/returns_a_clicks_report_with_a_defined_time_range.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_Admin/returns_an_affiliate_with_correct_data_types.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_Admin/returns_media_types.yml
+- spec/fixtures/vcr_cassettes/SoapyCake_AdminAddedit/_create_creatives/creates_a_creative_and_adds_a_file_to_it.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_AdminAddedit/advertisers/creates_advertisers.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_AdminAddedit/affiliates/edits_affiliates.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_AdminAddedit/campaigns/adds_a_campaign.yml
@@ -260,6 +261,7 @@ files:
 - spec/lib/soapy_cake/affiliate_spec.rb
 - spec/lib/soapy_cake/campaigns_spec.rb
 - spec/lib/soapy_cake/modification_type_spec.rb
+- spec/lib/soapy_cake/request_failed_spec.rb
 - spec/lib/soapy_cake/request_spec.rb
 - spec/lib/soapy_cake/response_spec.rb
 - spec/lib/soapy_cake/response_value_spec.rb
@@ -286,7 +288,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Simple client for the CAKE API
@@ -302,6 +304,7 @@ test_files:
 - spec/fixtures/vcr_cassettes/SoapyCake_Admin/returns_a_clicks_report_with_a_defined_time_range.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_Admin/returns_an_affiliate_with_correct_data_types.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_Admin/returns_media_types.yml
+- spec/fixtures/vcr_cassettes/SoapyCake_AdminAddedit/_create_creatives/creates_a_creative_and_adds_a_file_to_it.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_AdminAddedit/advertisers/creates_advertisers.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_AdminAddedit/affiliates/edits_affiliates.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_AdminAddedit/campaigns/adds_a_campaign.yml
@@ -337,6 +340,7 @@ test_files:
 - spec/lib/soapy_cake/affiliate_spec.rb
 - spec/lib/soapy_cake/campaigns_spec.rb
 - spec/lib/soapy_cake/modification_type_spec.rb
+- spec/lib/soapy_cake/request_failed_spec.rb
 - spec/lib/soapy_cake/request_spec.rb
 - spec/lib/soapy_cake/response_spec.rb
 - spec/lib/soapy_cake/response_value_spec.rb