appnexusapi 0.1.3 → 1.0.0

data/spec/integration/line_item_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe AppnexusApi::LineItemService do
+  include_context 'with a new line item'
+
+  it "line item life cycle" do
+    # get all the line items
+    VCR.use_cassette('line_item_life_cycle') do
+      line_items = line_item_service.get(advertiser_id: advertiser_id)
+      new_line_item = line_item_service.create(advertiser_url_params, line_item_params)
+
+      ids = line_items.map(&:id) + [new_line_item.id]
+      expect(line_item_service.get(advertiser_id: advertiser_id).map(&:id).sort).to eq(ids.sort)
+
+      # update a line item
+      expect(new_line_item.state).to eq("active")
+      updated_line_item = new_line_item.update(advertiser_url_params, {state: "inactive"} )
+      expect(updated_line_item["state"]).to eq('inactive')
+
+      # delete a line item
+      new_line_item.delete(advertiser_url_params)
+
+      expect(line_item_service.get("id" => new_line_item.id)).to be_nil
+      advertiser.delete
+    end
+  end
+end

data/spec/integration/member_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe AppnexusApi::MemberService do
+  it 'returns the current member' do
+    VCR.use_cassette('member_get') do
+      described_class.new(connection).get
+    end
+  end
+end

data/spec/integration/payment_rule_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe AppnexusApi::PaymentRuleService do
+  include_context 'with a publisher'
+
+  let(:payment_rule_service) { described_class.new(connection) }
+  let(:code) { 'spec_payment_rule_code' }
+  let(:payment_rules_url_params) { { publisher_id: publisher['id'] } }
+  let(:initial_cost_cpm) { 1.00 }
+  let(:update_cost_cpm) { 2.00 }
+  let(:payment_rule_params) do
+    {
+      code: code,
+      name: 'spec payment rule',
+      pricing_type: 'cpm',
+      cost_cpm: initial_cost_cpm
+    }
+  end
+
+  it 'payment rule life cycle' do
+    VCR.use_cassette('payment_rule_lifecycle') do
+      payment_rule = payment_rule_service.create(payment_rules_url_params, payment_rule_params)
+      expect(payment_rule.name).to eq('spec payment rule')
+      expect(payment_rule.cost_cpm).to eq(initial_cost_cpm)
+
+      updated_rule = payment_rule.update(payment_rules_url_params, { cost_cpm: update_cost_cpm} )
+      expect(updated_rule['cost_cpm']).to eq(update_cost_cpm)
+
+      payment_rule.delete
+      publisher.delete
+    end
+  end
+end

data/spec/integration/placement_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe AppnexusApi::PlacementService do
+
+  include_context 'with a publisher'
+
+  let(:placement_service) { described_class.new(connection) }
+
+  it "default placement" do
+    pending 'seems to rely on a configured default_site_id'
+    raise 'seems to rely on a configured default_site_id'
+
+    VCR.use_cassette('placement_service_default_placement') do
+      # now grab the default site
+      default_site = AppnexusApi::SiteService.new(connection).get(
+        id: publisher.default_site_id,
+        publisher_id: publisher.id
+      ).first
+
+      # grab the default placement
+      default_placement = placement_service.get(id: default_site.placements.first["id"]).first
+      default_placement.name.should  == "[Publisher Name] - Default"
+      default_placement.state.should == "active"
+
+      default_site.delete
+      publisher.delete
+    end
+  end
+end

data/spec/integration/profile_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe AppnexusApi::ProfileService do
+  include_context 'with a new line item'
+
+  let(:profile_service) { described_class.new(connection) }
+  let(:profile_descript) { 'Targeting only the US' }
+
+  it "profile life cycle" do
+    VCR.use_cassette('profile_life_cycle') do
+      profile_params = {
+        :code => "spec_profile_code",
+        :description => profile_descript,
+        :country_targets => [ { :id => 233 } ],
+        :country_action  => "include"
+      }
+
+      profile = profile_service.create(advertiser_url_params, profile_params)
+      expect(profile.description).to eq(profile_descript)
+      expect(profile.country_targets).to eq([{ "id"=>233,"code"=>"US", "name"=>"United States", "active"=>true }])
+
+      new_line_item = line_item_service.create(advertiser_url_params, line_item_params.merge(profile_id: profile.id))
+      new_line_item.profile_id.should == profile.id
+
+      new_line_item.delete({ "advertiser_id" => advertiser_id })
+      advertiser.delete
+    end
+  end
+end

data/spec/integration/publisher_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe AppnexusApi::PublisherService do
+  include_context 'with a publisher'
+
+  it "cruds" do
+    VCR.use_cassette('publisher_crud') do
+      expect(publisher.name).to eq 'spec publisher'
+      expect(publisher.expose_domains).to be true
+      expect(publisher.reselling_exposure).to eq "public"
+      expect(publisher.ad_quality_advanced_mode_enabled).to be true
+
+      expect { publisher_service.get("id" => publisher.id) }.to_not raise_error
+
+      publisher.delete
+
+      expect(publisher_service.get("id" => publisher.id)).to be_nil
+    end
+  end
+end

data/spec/integration/site_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe AppnexusApi::SiteService do
+  include_context 'with a publisher'
+
+  let(:code) { 'spec_pub_code' }
+  let(:site_service) { described_class.new(connection) }
+  let(:site_code) { 'spec_site_code' }
+
+  it "site life cycle" do
+    VCR.use_cassette('site_lifecycle') do
+      new_site_url_params = { publisher_id: publisher.id }
+      new_site_params = {
+        name: "Site Name",
+        code: site_code,
+        url: "http://www.example.com",
+        intended_audience: "general",
+        audited: true
+      }
+
+      new_site = site_service.create(new_site_url_params, new_site_params)
+      new_site.name.should == "Site Name"
+      new_site.code.should == site_code
+      new_site.url.should  == "http://www.example.com"
+      new_site.intended_audience.should == "general"
+      new_site.audited.should == true
+
+      new_site.delete
+      publisher.delete
+    end
+  end
+end

data/spec/integration/user_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe AppnexusApi::UserService do
+  let(:user_service) { described_class.new(connection) }
+  let(:current_user) { user_service.get(current: 1).first }
+  let(:new_user_hash) do
+    {
+       username: 'rspec_user',
+       password: 'rspec_user',
+       user_type: 'member',
+       entity_id: current_user.entity_id,
+       first_name: "rspec",
+       last_name: "test",
+       email: "rspec@api.appnexus.com",
+       state: "inactive",
+       api_login: true, #this can only be set by Appnexus
+     }
+  end
+
+  it 'returns the current user' do
+    VCR.use_cassette('user_login') do
+      expect(current_user.api_login).to be true
+    end
+  end
+
+  #users aren't delete-able
+  #it 'create' do
+  #  @new_user = @user_service.create({}, new_user_hash)
+  #  expect(@user_service.get(id: @new_user.id).last_name).to eq "test"
+  #end
+
+  it 'updates' do
+    VCR.use_cassette('user_update') do
+      last_name ||= current_user.last_name
+      current_user.update({}, { last_name: "test" })
+      updated_user = user_service.get(id: current_user.id).first
+      #restore the last_name before expecting
+      current_user.update({}, { last_name: last_name })
+      expect(updated_user.last_name).to eq "test"
+    end
+  end
+end

data/spec/object_limit_service_spec.rb

@@ -1,24 +1,27 @@
 require 'spec_helper'
 
 describe AppnexusApi::ObjectLimitService do
-  let(:object_limit_service) do
-    AppnexusApi::ObjectLimitService.new(connection)
-  end
+  let(:object_limit_service) { described_class.new(connection) }
 
   it "returns info about your current creative limits" do
-    creative_limits = object_limit_service.creative_limits.raw_json
-    expect(creative_limits["object_type"]).to eq "creative"
-    expect(creative_limits["limit"].to_i).to be > 0
+    VCR.use_cassette('object_limit_info') do
+      creative_limits = object_limit_service.creative_limits.raw_json
+      expect(creative_limits["object_type"]).to eq "creative"
+      expect(creative_limits["limit"].to_i).to be > 0
+    end
   end
 
   it "returns info about your current profile limits" do
-    profile_limits = object_limit_service.profile_limits.raw_json
-    expect(profile_limits["object_type"]).to eq "profile"
+    VCR.use_cassette('profile_limits') do
+      profile_limits = object_limit_service.profile_limits.raw_json
+      expect(profile_limits["object_type"]).to eq "profile"
+    end
   end
 
   it "returns info about your current domain list limits" do
-    domain_list_limits = object_limit_service.domain_list_limits.raw_json
-    expect(domain_list_limits["object_type"]).to eq "domain_list"
+    VCR.use_cassette('domain_list_limits') do
+      domain_list_limits = object_limit_service.domain_list_limits.raw_json
+      expect(domain_list_limits["object_type"]).to eq "domain_list"
+    end
   end
 end
-

data/spec/spec_helper.rb

@@ -1,36 +1,63 @@
 require 'dotenv'
-Dotenv.load
-
 require 'pry'
 require 'logger'
+require 'vcr'
+require 'webmock'
 require_relative '../lib/appnexusapi'
+Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
 
-RSpec.configure do |c|
-  c.filter_run_excluding :slow => true
-end
+DEFAULT_SPEC_USERNAME = 'user'
+DEFAULT_SPEC_PASSWORD = 'pass'
 
-def test_logger
-  return @logger unless @logger.nil?
-  FileUtils.mkdir_p('./log')
-  @logger = Logger.new('./log/test.log')
-  @logger.level = Logger::INFO
-  @logger
-end
+Dotenv.load
+
+module SpecWithConnection
+  extend RSpec::SharedContext
 
-def connection
-  AppnexusApi::Connection.new(
-    'username' => ENV['APPNEXUS_USERNAME'],
-    'password' => ENV['APPNEXUS_PASSWORD'],
-    'uri'      => ENV['APPNEXUS_URI'],
-    'logger'   => test_logger
-  )
+  let(:test_logger) { Logger.new('./log/test.log') }
+  let(:connection) { AppnexusApi::Connection.new(connection_params.merge('logger' => test_logger)) }
+  let(:connection_with_null_logger) { AppnexusApi::Connection.new(connection_params) }
+  let(:connection_params) do
+    {
+      'username' => ENV['APPNEXUS_USERNAME'] || 'user',
+      'password' => ENV['APPNEXUS_PASSWORD'] || 'pass',
+      'uri'      => ENV['APPNEXUS_URI'] || 'https://api-test.appnexus.com'
+    }
+  end
 end
 
-def connection_with_null_logger
-  AppnexusApi::Connection.new(
-    'username' => ENV['APPNEXUS_USERNAME'],
-    'password' => ENV['APPNEXUS_PASSWORD'],
-    'uri'      => ENV['APPNEXUS_URI']
-  )
+RSpec.configure do |config|
+  config.before(:suite) do
+    FileUtils.mkdir_p('./log')
+
+    if ENV['APPNEXUS_USERNAME'] && ENV['APPNEXUS_PASSWORD']
+      puts 'Attempting to destroy rspec created records on the Appnexus test server...'
+      connection_params = {
+        'username' => ENV['APPNEXUS_USERNAME'],
+        'password' => ENV['APPNEXUS_PASSWORD'],
+        'uri'      => ENV['APPNEXUS_URI'] || 'https://api-test.appnexus.com'
+      }
+
+      connection = AppnexusApi::Connection.new(connection_params.merge('logger' => Logger.new('./log/test.log')))
+
+      AppnexusApi::PublisherService.new(connection).get.each { |p| p.delete if p.name =~ /spec/ || p.code =~ /spec/ }
+      AppnexusApi::AdvertiserService.new(connection).get.each { |a| a.delete if a.name =~ /spec/ }
+    end
+  end
+
+  config.filter_run_excluding slow: true
+  config.include SpecWithConnection
 end
 
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr'
+  c.hook_into :webmock
+
+  c.allow_http_connections_when_no_cassette = true
+  c.filter_sensitive_data('<APPNEXUS_USERNAME>')        { ENV['APPNEXUS_USERNAME'] || DEFAULT_SPEC_USERNAME }
+  c.filter_sensitive_data('<APPNEXUS_PASSWORD>')        { ENV['APPNEXUS_PASSWORD'] || DEFAULT_SPEC_PASSWORD }
+
+  c.default_cassette_options = {
+    match_requests_on: [:method, :uri, :body]
+  }
+end

data/spec/support/shared_contexts.rb

@@ -0,0 +1,28 @@
+shared_context 'with an advertiser' do
+  let(:advertiser_params) { { name: 'rspec advertiser' } }
+  let(:advertiser) { AppnexusApi::AdvertiserService.new(connection).create({}, advertiser_params) }
+  let(:advertiser_id) { advertiser.id }
+  let(:advertiser_url_params) { { advertiser_id: advertiser_id } }
+end
+
+shared_context 'with a new line item' do
+  include_context 'with an advertiser'
+
+  let(:line_item_service) { AppnexusApi::LineItemService.new(connection) }
+  let(:line_item_params) { { name: 'some line item', code: 'spec_line_code' } }
+end
+
+shared_context 'with a publisher' do
+  let(:publisher_service) { AppnexusApi::PublisherService.new(connection) }
+  let(:publisher) { publisher_service.create(publisher_url_params, publisher_params) }
+  let(:publisher_url_params) { { create_default_placement: false } }
+  let(:publisher_params) do
+    {
+      name: "spec publisher",
+      code: 'spec_publisher_code',
+      expose_domains: true,
+      reselling_exposure: "public",
+      ad_quality_advanced_mode_enabled: true
+    }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appnexusapi
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Marlon Moyer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-26 00:00:00.000000000 Z
+date: 2017-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -138,6 +138,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ''
 email:
 - marlon@simpli.fi
@@ -151,11 +179,14 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- UPGRADING.md
 - appnexusapi.gemspec
 - env_example
 - lib/appnexusapi.rb
 - lib/appnexusapi/ad_server_resource.rb
 - lib/appnexusapi/ad_server_service.rb
+- lib/appnexusapi/advertiser_resource.rb
+- lib/appnexusapi/advertiser_service.rb
 - lib/appnexusapi/bidder_instance_resource.rb
 - lib/appnexusapi/bidder_instance_service.rb
 - lib/appnexusapi/bidder_profile_resource.rb
@@ -166,6 +197,8 @@ files:
 - lib/appnexusapi/brand_service.rb
 - lib/appnexusapi/browser_resource.rb
 - lib/appnexusapi/browser_service.rb
+- lib/appnexusapi/campaign_resource.rb
+- lib/appnexusapi/campaign_service.rb
 - lib/appnexusapi/category_resource.rb
 - lib/appnexusapi/category_service.rb
 - lib/appnexusapi/connection.rb
@@ -202,12 +235,22 @@ files:
 - lib/appnexusapi/operating_system_extended_service.rb
 - lib/appnexusapi/operating_system_resource.rb
 - lib/appnexusapi/operating_system_service.rb
+- lib/appnexusapi/payment_rule_resource.rb
+- lib/appnexusapi/payment_rule_service.rb
+- lib/appnexusapi/placement_resource.rb
+- lib/appnexusapi/placement_service.rb
 - lib/appnexusapi/platform_member_resource.rb
 - lib/appnexusapi/platform_member_service.rb
+- lib/appnexusapi/profile_resource.rb
+- lib/appnexusapi/profile_service.rb
+- lib/appnexusapi/publisher_resource.rb
+- lib/appnexusapi/publisher_service.rb
 - lib/appnexusapi/resource.rb
 - lib/appnexusapi/segment_resource.rb
 - lib/appnexusapi/segment_service.rb
 - lib/appnexusapi/service.rb
+- lib/appnexusapi/site_resource.rb
+- lib/appnexusapi/site_service.rb
 - lib/appnexusapi/technical_attribute_resource.rb
 - lib/appnexusapi/technical_attribute_service.rb
 - lib/appnexusapi/tiny_tag_resource.rb
@@ -217,8 +260,39 @@ files:
 - lib/appnexusapi/version.rb
 - spec/connection_spec.rb
 - spec/creative_service_spec.rb
+- spec/fixtures/vcr/advertiser_get.yml
+- spec/fixtures/vcr/campaign_life_cycle.yml
+- spec/fixtures/vcr/content_category_crud.yml
+- spec/fixtures/vcr/creative_service_create.yml
+- spec/fixtures/vcr/creative_service_delete.yml
+- spec/fixtures/vcr/creative_service_get.yml
+- spec/fixtures/vcr/creative_service_update.yml
+- spec/fixtures/vcr/domain_list_limits.yml
+- spec/fixtures/vcr/line_item_life_cycle.yml
+- spec/fixtures/vcr/member_get.yml
+- spec/fixtures/vcr/object_limit_info.yml
+- spec/fixtures/vcr/payment_rule_lifecycle.yml
+- spec/fixtures/vcr/placement_service_default_placement.yml
+- spec/fixtures/vcr/profile_life_cycle.yml
+- spec/fixtures/vcr/profile_limits.yml
+- spec/fixtures/vcr/publisher_crud.yml
+- spec/fixtures/vcr/site_lifecycle.yml
+- spec/fixtures/vcr/user_login.yml
+- spec/fixtures/vcr/user_update.yml
+- spec/integration/advertiser_spec.rb
+- spec/integration/campaign_spec.rb
+- spec/integration/content_category_spec.rb
+- spec/integration/line_item_spec.rb
+- spec/integration/member_spec.rb
+- spec/integration/payment_rule_spec.rb
+- spec/integration/placement_spec.rb
+- spec/integration/profile_spec.rb
+- spec/integration/publisher_spec.rb
+- spec/integration/site_spec.rb
+- spec/integration/user_spec.rb
 - spec/object_limit_service_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared_contexts.rb
 homepage: https://github.com/simplifi/appnexusapi
 licenses: []
 metadata: {}
@@ -238,12 +312,44 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: Unofficial Ruby API Wrapper for Appnexus
 test_files:
 - spec/connection_spec.rb
 - spec/creative_service_spec.rb
+- spec/fixtures/vcr/advertiser_get.yml
+- spec/fixtures/vcr/campaign_life_cycle.yml
+- spec/fixtures/vcr/content_category_crud.yml
+- spec/fixtures/vcr/creative_service_create.yml
+- spec/fixtures/vcr/creative_service_delete.yml
+- spec/fixtures/vcr/creative_service_get.yml
+- spec/fixtures/vcr/creative_service_update.yml
+- spec/fixtures/vcr/domain_list_limits.yml
+- spec/fixtures/vcr/line_item_life_cycle.yml
+- spec/fixtures/vcr/member_get.yml
+- spec/fixtures/vcr/object_limit_info.yml
+- spec/fixtures/vcr/payment_rule_lifecycle.yml
+- spec/fixtures/vcr/placement_service_default_placement.yml
+- spec/fixtures/vcr/profile_life_cycle.yml
+- spec/fixtures/vcr/profile_limits.yml
+- spec/fixtures/vcr/publisher_crud.yml
+- spec/fixtures/vcr/site_lifecycle.yml
+- spec/fixtures/vcr/user_login.yml
+- spec/fixtures/vcr/user_update.yml
+- spec/integration/advertiser_spec.rb
+- spec/integration/campaign_spec.rb
+- spec/integration/content_category_spec.rb
+- spec/integration/line_item_spec.rb
+- spec/integration/member_spec.rb
+- spec/integration/payment_rule_spec.rb
+- spec/integration/placement_spec.rb
+- spec/integration/profile_spec.rb
+- spec/integration/publisher_spec.rb
+- spec/integration/site_spec.rb
+- spec/integration/user_spec.rb
 - spec/object_limit_service_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared_contexts.rb
+has_rdoc: