appnexusapi 0.1.3 → 1.0.0

data/spec/fixtures/vcr/user_login.yml

@@ -0,0 +1,107 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api-test.appnexus.com/auth
+    body:
+      encoding: UTF-8
+      string: '{"auth":{"username":"<APPNEXUS_USERNAME>","password":"<APPNEXUS_PASSWORD>"}}'
+    headers:
+      User-Agent:
+      - Faraday v0.11.0
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0;no-cache
+      Content-Length:
+      - '698'
+      Content-Type:
+      - application/json
+      Date:
+      - Wed, 08 Feb 2017 12:59:25 GMT
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Pragma:
+      - no-cache
+      Server:
+      - Apache
+      Set-Cookie:
+      - HBFAPI_SESSID=hbapi%3A171678%3A589b162e31b3a%3Anym2; Path=/
+      X-Route:
+      - "/auth"
+      X-Route-Time:
+      - '1384'
+    body:
+      encoding: UTF-8
+      string: '{"response":{"status":"OK","token":"hbapi:171678:589b162e31b3a:nym2","dbg_info":{"instance":"01.hbapi.test104169.nym2","slave_hit":false,"db":"master","parent_dbg_info":{"instance":"01.api.test104169.nym2","slave_hit":false,"db":"master","awesomesauce_cache_used":false,"count_cache_used":false,"uuid":"0d9e096f-4020-5334-82c8-5bad38b57e01","warnings":[],"time":793.72978210449,"start_microtime":1486558765.074,"version":"1.17","output_term":"not_found"},"awesomesauce_cache_used":false,"count_cache_used":false,"uuid":"d3d34a81-db7b-5457-8594-7b0ffcc53054","warnings":[],"time":1371.4709281921,"start_microtime":1486558765.0501,"version":"1.17.202","slave_lag":1040300,"output_term":"not_found"}}}'
+    http_version: 
+  recorded_at: Wed, 08 Feb 2017 12:59:24 GMT
+- request:
+    method: get
+    uri: https://api-test.appnexus.com/user?current=1&num_elements=100&start_element=0
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.11.0
+      Authorization:
+      - hbapi:171678:589b162e31b3a:nym2
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0;no-cache
+      Content-Length:
+      - '1396'
+      Content-Type:
+      - application/json
+      Date:
+      - Wed, 08 Feb 2017 12:59:26 GMT
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Pragma:
+      - no-cache
+      Server:
+      - Apache
+      Set-Cookie:
+      - HBFAPI_SESSID=hbapi%3A171678%3A589b162e31b3a%3Anym2; Path=/
+      X-Count-Read:
+      - user:7,member:2,serviceHostUser:1,serviceHostMember:1,hostUser:2,hostMember:2,ip:0
+      X-Count-Write:
+      - user:4,member:4,serviceHostUser:0,serviceHostMember:0,hostUser:4,hostMember:4,ip:0
+      X-Ratelimit-Read:
+      - '1000'
+      X-Ratelimit-Service:
+      - 1000-Default
+      X-Ratelimit-System:
+      - 1000-Default
+      X-Ratelimit-Write:
+      - '1000'
+      X-Route:
+      - "/user"
+      X-Route-Time:
+      - '28'
+    body:
+      encoding: UTF-8
+      string: '{"response":{"status":"OK","start_element":0,"num_elements":100,"user":{"id":171678,"first_name":"Analytics","last_name":"Dev","phone":"","username":"<APPNEXUS_USERNAME>","email":"<APPNEXUS_USERNAME>","user_type":"member","read_only":false,"api_login":true,"entity_id":487,"publisher_id":null,"advertiser_id":null,"custom_data":"{}","send_safety_budget_notifications":false,"entity_name":"Lumos
+        Labs","timezone":"EST5EDT","entity_reporting_decimal_type":"decimal","reporting_decimal_type":"decimal","decimal_mark":"period","thousand_separator":"comma","is_admin":false,"last_modified":"2017-02-08
+        11:51:42","is_developer":false,"role_id":null,"state":"active","password_expires_on":null,"advertiser_access":null,"publisher_access":null},"count":1,"dbg_info":{"instance":"01.hbapi.test104169.nym2","slave_hit":false,"db":"master","user::reads":7,"user::read_limit":1000,"user::read_limit_seconds":60,"user::writes":4,"user::write_limit":1000,"user::write_limit_seconds":60,"reads":2,"read_limit":1000,"read_limit_seconds":60,"writes":4,"write_limit":1000,"write_limit_seconds":60,"awesomesauce_cache_used":false,"count_cache_used":false,"uuid":"0818d126-ebc4-500c-8f86-0bdc8d5e2d53","warnings":[],"time":18.574953079224,"start_microtime":1486558766.8049,"version":"1.17.202","slave_miss":"no_slaves_found","slave_lag":1040309,"member_last_modified_age":1249,"output_term":"user"}}}'
+    http_version: 
+  recorded_at: Wed, 08 Feb 2017 12:59:24 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/user_update.yml

@@ -0,0 +1,288 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api-test.appnexus.com/auth
+    body:
+      encoding: UTF-8
+      string: '{"auth":{"username":"<APPNEXUS_USERNAME>","password":"<APPNEXUS_PASSWORD>"}}'
+    headers:
+      User-Agent:
+      - Faraday v0.11.0
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0;no-cache
+      Content-Length:
+      - '699'
+      Content-Type:
+      - application/json
+      Date:
+      - Wed, 08 Feb 2017 12:59:27 GMT
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Pragma:
+      - no-cache
+      Server:
+      - Apache
+      Set-Cookie:
+      - HBFAPI_SESSID=hbapi%3A171678%3A589b163056ac9%3Anym2; Path=/
+      X-Route:
+      - "/auth"
+      X-Route-Time:
+      - '1383'
+    body:
+      encoding: UTF-8
+      string: '{"response":{"status":"OK","token":"hbapi:171678:589b163056ac9:nym2","dbg_info":{"instance":"01.hbapi.test104169.nym2","slave_hit":false,"db":"master","parent_dbg_info":{"instance":"01.api.test104169.nym2","slave_hit":false,"db":"master","awesomesauce_cache_used":false,"count_cache_used":false,"uuid":"43400c7f-a6f2-5028-b567-8f0d0727e053","warnings":[],"time":801.22804641724,"start_microtime":1486558767.2259,"version":"1.17","output_term":"not_found"},"awesomesauce_cache_used":false,"count_cache_used":false,"uuid":"a91383cd-2622-52ea-9ced-856c9f629eff","warnings":[],"time":1371.9110488892,"start_microtime":1486558767.2019,"version":"1.17.202","slave_lag":1040309,"output_term":"not_found"}}}'
+    http_version: 
+  recorded_at: Wed, 08 Feb 2017 12:59:26 GMT
+- request:
+    method: get
+    uri: https://api-test.appnexus.com/user?current=1&num_elements=100&start_element=0
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.11.0
+      Authorization:
+      - hbapi:171678:589b163056ac9:nym2
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0;no-cache
+      Content-Length:
+      - '1395'
+      Content-Type:
+      - application/json
+      Date:
+      - Wed, 08 Feb 2017 12:59:28 GMT
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Pragma:
+      - no-cache
+      Server:
+      - Apache
+      Set-Cookie:
+      - HBFAPI_SESSID=hbapi%3A171678%3A589b163056ac9%3Anym2; Path=/
+      X-Count-Read:
+      - user:9,member:3,serviceHostUser:2,serviceHostMember:2,hostUser:3,hostMember:3,ip:0
+      X-Count-Write:
+      - user:4,member:4,serviceHostUser:0,serviceHostMember:0,hostUser:4,hostMember:4,ip:0
+      X-Ratelimit-Read:
+      - '1000'
+      X-Ratelimit-Service:
+      - 1000-Default
+      X-Ratelimit-System:
+      - 1000-Default
+      X-Ratelimit-Write:
+      - '1000'
+      X-Route:
+      - "/user"
+      X-Route-Time:
+      - '27'
+    body:
+      encoding: UTF-8
+      string: '{"response":{"status":"OK","start_element":0,"num_elements":100,"user":{"id":171678,"first_name":"Analytics","last_name":"Dev","phone":"","username":"<APPNEXUS_USERNAME>","email":"<APPNEXUS_USERNAME>","user_type":"member","read_only":false,"api_login":true,"entity_id":487,"publisher_id":null,"advertiser_id":null,"custom_data":"{}","send_safety_budget_notifications":false,"entity_name":"Lumos
+        Labs","timezone":"EST5EDT","entity_reporting_decimal_type":"decimal","reporting_decimal_type":"decimal","decimal_mark":"period","thousand_separator":"comma","is_admin":false,"last_modified":"2017-02-08
+        11:51:42","is_developer":false,"role_id":null,"state":"active","password_expires_on":null,"advertiser_access":null,"publisher_access":null},"count":1,"dbg_info":{"instance":"01.hbapi.test104169.nym2","slave_hit":false,"db":"master","user::reads":9,"user::read_limit":1000,"user::read_limit_seconds":60,"user::writes":4,"user::write_limit":1000,"user::write_limit_seconds":60,"reads":3,"read_limit":1000,"read_limit_seconds":60,"writes":4,"write_limit":1000,"write_limit_seconds":60,"awesomesauce_cache_used":false,"count_cache_used":true,"uuid":"d8b8c8ea-ea9d-5539-a876-e94dc93f95f5","warnings":[],"time":17.499923706055,"start_microtime":1486558769.0024,"version":"1.17.202","slave_miss":"no_slaves_found","slave_lag":1040309,"member_last_modified_age":1252,"output_term":"user"}}}'
+    http_version: 
+  recorded_at: Wed, 08 Feb 2017 12:59:27 GMT
+- request:
+    method: put
+    uri: https://api-test.appnexus.com/user?id=171678
+    body:
+      encoding: UTF-8
+      string: '{"user":{"last_name":"test"}}'
+    headers:
+      User-Agent:
+      - Faraday v0.11.0
+      Authorization:
+      - hbapi:171678:589b163056ac9:nym2
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0;no-cache
+      Content-Length:
+      - '1386'
+      Content-Type:
+      - application/json
+      Date:
+      - Wed, 08 Feb 2017 12:59:29 GMT
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Pragma:
+      - no-cache
+      Server:
+      - Apache
+      Set-Cookie:
+      - HBFAPI_SESSID=hbapi%3A171678%3A589b163056ac9%3Anym2; Path=/
+      X-Count-Read:
+      - user:9,member:3,serviceHostUser:2,serviceHostMember:2,hostUser:3,hostMember:3,ip:0
+      X-Count-Write:
+      - user:5,member:5,serviceHostUser:1,serviceHostMember:1,hostUser:5,hostMember:5,ip:0
+      X-Ratelimit-Read:
+      - '1000'
+      X-Ratelimit-Service:
+      - 1000-Default
+      X-Ratelimit-System:
+      - 1000-Default
+      X-Ratelimit-Write:
+      - '1000'
+      X-Route:
+      - "/user"
+      X-Route-Time:
+      - '99'
+    body:
+      encoding: UTF-8
+      string: '{"response":{"status":"OK","count":1,"id":"171678","start_element":0,"num_elements":100,"user":{"id":171678,"first_name":"Analytics","last_name":"test","phone":"","username":"<APPNEXUS_USERNAME>","email":"<APPNEXUS_USERNAME>","user_type":"member","read_only":false,"api_login":true,"entity_id":487,"publisher_id":null,"advertiser_id":null,"custom_data":"{}","send_safety_budget_notifications":false,"entity_name":"Lumos
+        Labs","timezone":"EST5EDT","entity_reporting_decimal_type":"decimal","reporting_decimal_type":"decimal","decimal_mark":"period","thousand_separator":"comma","is_admin":false,"last_modified":"2017-02-08
+        12:59:29","is_developer":false,"role_id":null,"state":"active","password_expires_on":null,"advertiser_access":null,"publisher_access":null},"dbg_info":{"instance":"01.hbapi.test104169.nym2","slave_hit":false,"db":"master","user::reads":9,"user::read_limit":1000,"user::read_limit_seconds":60,"user::writes":5,"user::write_limit":1000,"user::write_limit_seconds":60,"reads":3,"read_limit":1000,"read_limit_seconds":60,"writes":5,"write_limit":1000,"write_limit_seconds":60,"awesomesauce_cache_used":false,"count_cache_used":false,"uuid":"324739a4-3b68-51dd-8b4f-d428a041755b","warnings":[],"time":85.218906402588,"start_microtime":1486558769.4822,"version":"1.17.202","slave_lag":1040309,"member_last_modified_age":1486558769,"output_term":"user"}}}'
+    http_version: 
+  recorded_at: Wed, 08 Feb 2017 12:59:27 GMT
+- request:
+    method: get
+    uri: https://api-test.appnexus.com/user?id=171678&num_elements=100&start_element=0
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.11.0
+      Authorization:
+      - hbapi:171678:589b163056ac9:nym2
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0;no-cache
+      Content-Length:
+      - '1395'
+      Content-Type:
+      - application/json
+      Date:
+      - Wed, 08 Feb 2017 12:59:30 GMT
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Pragma:
+      - no-cache
+      Server:
+      - Apache
+      Set-Cookie:
+      - HBFAPI_SESSID=hbapi%3A171678%3A589b163056ac9%3Anym2; Path=/
+      X-Count-Read:
+      - user:10,member:4,serviceHostUser:3,serviceHostMember:3,hostUser:4,hostMember:4,ip:0
+      X-Count-Write:
+      - user:5,member:5,serviceHostUser:1,serviceHostMember:1,hostUser:5,hostMember:5,ip:0
+      X-Ratelimit-Read:
+      - '1000'
+      X-Ratelimit-Service:
+      - 1000-Default
+      X-Ratelimit-System:
+      - 1000-Default
+      X-Ratelimit-Write:
+      - '1000'
+      X-Route:
+      - "/user"
+      X-Route-Time:
+      - '234'
+    body:
+      encoding: UTF-8
+      string: '{"response":{"status":"OK","start_element":0,"num_elements":100,"user":{"id":171678,"first_name":"Analytics","last_name":"test","phone":"","username":"<APPNEXUS_USERNAME>","email":"<APPNEXUS_USERNAME>","user_type":"member","read_only":false,"api_login":true,"entity_id":487,"publisher_id":null,"advertiser_id":null,"custom_data":"{}","send_safety_budget_notifications":false,"entity_name":"Lumos
+        Labs","timezone":"EST5EDT","entity_reporting_decimal_type":"decimal","reporting_decimal_type":"decimal","decimal_mark":"period","thousand_separator":"comma","is_admin":false,"last_modified":"2017-02-08
+        12:59:29","is_developer":false,"role_id":null,"state":"active","password_expires_on":null,"advertiser_access":null,"publisher_access":null},"count":1,"dbg_info":{"instance":"01.hbapi.test104169.nym2","slave_hit":false,"db":"master","user::reads":10,"user::read_limit":1000,"user::read_limit_seconds":60,"user::writes":5,"user::write_limit":1000,"user::write_limit_seconds":60,"reads":4,"read_limit":1000,"read_limit_seconds":60,"writes":5,"write_limit":1000,"write_limit_seconds":60,"awesomesauce_cache_used":false,"count_cache_used":false,"uuid":"e753df42-3cb3-5ccb-8475-39be94d5e9bd","warnings":[],"time":223.97899627686,"start_microtime":1486558770.0428,"version":"1.17.202","slave_miss":"no_slaves_found","slave_lag":1040309,"member_last_modified_age":1,"output_term":"user"}}}'
+    http_version: 
+  recorded_at: Wed, 08 Feb 2017 12:59:28 GMT
+- request:
+    method: put
+    uri: https://api-test.appnexus.com/user?id=171678
+    body:
+      encoding: UTF-8
+      string: '{"user":{"last_name":"Dev"}}'
+    headers:
+      User-Agent:
+      - Faraday v0.11.0
+      Authorization:
+      - hbapi:171678:589b163056ac9:nym2
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0;no-cache
+      Content-Length:
+      - '1386'
+      Content-Type:
+      - application/json
+      Date:
+      - Wed, 08 Feb 2017 12:59:30 GMT
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Pragma:
+      - no-cache
+      Server:
+      - Apache
+      Set-Cookie:
+      - HBFAPI_SESSID=hbapi%3A171678%3A589b163056ac9%3Anym2; Path=/
+      X-Count-Read:
+      - user:10,member:4,serviceHostUser:3,serviceHostMember:3,hostUser:4,hostMember:4,ip:0
+      X-Count-Write:
+      - user:6,member:6,serviceHostUser:2,serviceHostMember:2,hostUser:6,hostMember:6,ip:0
+      X-Ratelimit-Read:
+      - '1000'
+      X-Ratelimit-Service:
+      - 1000-Default
+      X-Ratelimit-System:
+      - 1000-Default
+      X-Ratelimit-Write:
+      - '1000'
+      X-Route:
+      - "/user"
+      X-Route-Time:
+      - '271'
+    body:
+      encoding: UTF-8
+      string: '{"response":{"status":"OK","count":1,"id":"171678","start_element":0,"num_elements":100,"user":{"id":171678,"first_name":"Analytics","last_name":"Dev","phone":"","username":"<APPNEXUS_USERNAME>","email":"<APPNEXUS_USERNAME>","user_type":"member","read_only":false,"api_login":true,"entity_id":487,"publisher_id":null,"advertiser_id":null,"custom_data":"{}","send_safety_budget_notifications":false,"entity_name":"Lumos
+        Labs","timezone":"EST5EDT","entity_reporting_decimal_type":"decimal","reporting_decimal_type":"decimal","decimal_mark":"period","thousand_separator":"comma","is_admin":false,"last_modified":"2017-02-08
+        12:59:30","is_developer":false,"role_id":null,"state":"active","password_expires_on":null,"advertiser_access":null,"publisher_access":null},"dbg_info":{"instance":"01.hbapi.test104169.nym2","slave_hit":false,"db":"master","user::reads":10,"user::read_limit":1000,"user::read_limit_seconds":60,"user::writes":6,"user::write_limit":1000,"user::write_limit_seconds":60,"reads":4,"read_limit":1000,"read_limit_seconds":60,"writes":6,"write_limit":1000,"write_limit_seconds":60,"awesomesauce_cache_used":false,"count_cache_used":false,"uuid":"35b5b341-540b-5da6-813d-e0261b1ff06c","warnings":[],"time":256.20198249817,"start_microtime":1486558770.7333,"version":"1.17.202","slave_lag":1040309,"member_last_modified_age":1486558770,"output_term":"user"}}}'
+    http_version: 
+  recorded_at: Wed, 08 Feb 2017 12:59:29 GMT
+recorded_with: VCR 3.0.3

data/spec/integration/advertiser_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe AppnexusApi::AdvertiserService do
+  let(:advertiser_service) { described_class.new(connection) }
+
+  it 'supports a get operation' do
+    VCR.use_cassette('advertiser_get') do
+      expect { advertiser_service.get(num_elements: 1) }.to_not raise_error
+    end
+  end
+end

data/spec/integration/campaign_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe AppnexusApi::CampaignService do
+  include_context 'with a new line item'
+
+  let(:campaign_name) { 'campaign name' }
+  let(:profile_params) do
+    {
+      code: 'spec_profile_code',
+      description: 'Targeting only the US',
+      country_targets: [ { id: 233 } ],
+      country_action: 'include'
+    }
+  end
+
+  it 'executes a campaigns life cycle' do
+    VCR.use_cassette('campaign_life_cycle') do
+      profile = AppnexusApi::ProfileService.new(connection).create(advertiser_url_params, profile_params)
+      new_line_item = AppnexusApi::LineItemService.new(connection).create(advertiser_url_params, line_item_params)
+      campaign_params = {
+        name: campaign_name,
+        code: 'codecode',
+        line_item_id: new_line_item.id,
+        inventory_type: 'direct',
+        profile_id: profile.id # profile is what targets Geo
+      }
+      campaign = described_class.new(connection).create(advertiser_url_params, campaign_params)
+
+      expect(campaign.name).to eq('campaign name')
+      expect(campaign.profile_id).to eq(profile.id)
+
+      campaign.delete(advertiser_url_params)
+      new_line_item.delete('advertiser_id' => advertiser_id)
+      profile.delete(advertiser_url_params)
+      advertiser.delete
+    end
+  end
+end

data/spec/integration/content_category_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe AppnexusApi::ContentCategoryService do
+  let(:ccs) { described_class.new(connection) }
+  let(:name) { 'rspec_content_category' }
+  let(:name_update) { name + '_part_2' }
+
+  it 'cruds' do
+    VCR.use_cassette('content_category_crud') do
+      created = ccs.create({}, name: name)
+
+      gotten = ccs.get(id: created.id).first
+      expect(gotten.name).to eq(name)
+
+      gotten.update({}, name: name_update)
+      expect(ccs.get(id: created.id).first.name).to eq(name_update)
+
+      gotten.delete({})
+      expect(ccs.get(id: created.id)).to be_nil
+    end
+  end
+end