appnexusapi 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7969421f4404cb5d0af083544387927a493d2ccb
-  data.tar.gz: fdf085dd9a11e7ca9877300f25d271e7e74a4a3d
+  metadata.gz: d0d8a696916d00cb33332f0c9f959536f321838b
+  data.tar.gz: b6bc7bc92daf371d2f9c6141ee9f174d3f9a35f2
 SHA512:
-  metadata.gz: c2f9db3645266be119063ef0bb5c3944ebab0cb036b74c78c99fc9e5abfc4ad105b7a8d0ade59c80bc95ed9c18619305f383ee9034a98ff95373d75e111f4c8e
-  data.tar.gz: e786a842d258682287651a46d8fcb32f00f41519d7cf53c1ab9dbf4b4f173778409c0cebc22686da3937b12808b4d3d860ef7106a9c63543017e2b2128ec2a72
+  metadata.gz: d3c91ef186f3236070d03cbec6780cae75a7b5a8d7631da21fc4187411e3039fe4364aca15e5b6f5f3e6548896b58e95975d3df69339b45dc8f64ab8d3bbf3b2
+  data.tar.gz: 310fc055c9f7f0e6ff8c4a2094070bcc03b19f3b4be789078b25877237cf3f24484f745e9b74787092aa4929a8936813f7ed83b8ac99297c2dcaebfae1805e4f

data/.gitignore

@@ -16,3 +16,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.env
+log

data/README.md

@@ -22,11 +22,14 @@ Establish a connection:
 
     connection = AppnexusApi::Connection.new(
       'username' => 'username',
-      'password' => 'password'
+      'password' => 'password',
+      'logger'   => Logger.new(STDOUT) # defaults to a null logger if no value passed in.
 
       # Defaults to connecting to https://api.appnexus.com/ but you can optionally pass a uri to
       # connect to another endpoint, e.g. the staging site could be
-      # uri: 'http://api.sand-08.adnxs.net'
+      # uri: 'http://api.sand-08.adnxs.net
+
+      
     )
 
 Use a Service:
@@ -40,23 +43,18 @@ Use a Service:
     creative_service = AppnexusApi::CreativeService.new(connection, member.id)
 
     new_creative = {
-      "media_url" => "http://ad.doubleclick.net/adi/ABC.Advertising.com/DEF.40;sz=300x250;click0=",
+      "content"   => "<iframe src='helloword.html'></iframe>",
       "width" => "300",
       "height" => "250",
-      "format" => "url-html"
+      "template"  =>{ "id" => 7 }
     }
     creative = creative_service.create(new_creative)
     creative.update("campaign" => "Testing")
 
-## Debugging
+## Testing
 
-The APPNEXUS_API_DEBUG environment variable will trigger full printouts of Faraday's debug output to STDERR.
+There is a rudimentary test suite that centers around creatives/creative_service.  To use it, you'll need to copy the `env_example` file to `.env` and replace the values with your correct values for your account. After that, a simple `bundle exec rspec spec` will run the test suite
 
-```bash
-cd /my/app
-export APPNEXUS_API_DEBUG=true
-bundle exec rails whatever
-```
 
 ## Contributing
 

data/appnexusapi.gemspec

@@ -19,6 +19,10 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'faraday_middleware'
   gem.add_dependency 'multi_json'
   gem.add_dependency 'pester'
-  
+  gem.add_dependency 'null_logger'
+
   gem.add_development_dependency 'bundler', '>= 1.2.0'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'dotenv'
+  gem.add_development_dependency 'pry'
 end

data/env_example

@@ -0,0 +1,5 @@
+APPNEXUS_MEMBER_ID=123
+APPNEXUS_USERNAME=appnexus_user
+APPNEXUS_PASSWORD=HGsgwDdxDVWM
+APPNEXUS_URI=https://sand.api.adnxs.com
+

data/lib/appnexusapi/connection.rb

@@ -2,14 +2,15 @@ require 'faraday_middleware'
 require 'appnexusapi/faraday/raise_http_error'
 
 class AppnexusApi::Connection
+  RATE_EXCEEDED_DEFAULT_TIMEOUT = 15
+  RATE_EXCEEDED_HTTP_CODE = 429
+
   def initialize(config)
     @config = config
     @config['uri'] ||= 'https://api.appnexus.com/'
+    @logger = @config['logger'] || NullLogger.new
     @connection = Faraday.new(@config['uri']) do |conn|
-      if ENV['APPNEXUS_API_DEBUG'].to_s =~ /^(true|1)$/i
-        conn.response :logger, Logger.new(STDERR), bodies: true
-      end
-
+      conn.response :logger, @logger, bodies: true
       conn.request :json
       conn.response :json, :content_type => /\bjson$/
       conn.use AppnexusApi::Faraday::Response::RaiseHttpError
@@ -21,8 +22,13 @@ class AppnexusApi::Connection
     !@token.nil?
   end
 
+  def log
+    @logger
+  end
+
   def login
     response = @connection.run_request(:post, 'auth', { 'auth' => { 'username' => @config['username'], 'password' => @config['password'] } }, {})
+    log.debug(response.body)
     if response.body['response']['error_code']
       fail "#{response.body['response']['error_code']}/#{response.body['response']['error_description']}"
     end
@@ -52,8 +58,20 @@ class AppnexusApi::Connection
 
   def run_request(method, route, body, headers)
     login if !is_authorized?
+    response = {}
     begin
-      @connection.run_request(method, route, body, { 'Authorization' => @token }.merge(headers))
+      loop do
+        response = @connection.run_request(
+          method,
+          route,
+          body,
+          { 'Authorization' => @token }.merge(headers)
+        )
+        break unless response.status == RATE_EXCEEDED_HTTP_CODE
+        wait_time = response.headers['retry-after'] || RATE_EXCEEDED_DEFAULT_TIMEOUT
+        log.info("received rate exceeded.  wait time: #{wait_time}s")
+        sleep wait_time.to_i
+      end
     rescue AppnexusApi::Unauthorized => e
       if @retry == true
         raise AppnexusApi::Unauthorized, e
@@ -62,10 +80,12 @@ class AppnexusApi::Connection
         logout
         run_request(method, route, body, headers)
       end
-    rescue Faraday::Error::TimeoutError => e
+    rescue Faraday::Error::TimeoutError => _e
       raise AppnexusApi::Timeout, 'Timeout'
     ensure
       @retry = false
     end
+    log.debug(response.body)
+    response
   end
 end

data/lib/appnexusapi/resource.rb

@@ -1,8 +1,11 @@
 class AppnexusApi::Resource
 
-  def initialize(json, service)
+  attr_reader :dbg_info
+
+  def initialize(json, service, dbg_info = nil)
     @json = json
     @service = service
+    @dbg_info = dbg_info
   end
 
   def update(attributes={})

data/lib/appnexusapi/service.rb

@@ -44,14 +44,8 @@ class AppnexusApi::Service
     response = @connection.get(uri_suffix, params).body['response']
     if return_response
       response
-    elsif response.has_key?(plural_name) || response.has_key?(plural_uri_name)
-      key = response.has_key?(plural_name) ? plural_name : plural_uri_name
-      response[key].map do |json|
-        resource_class.new(json, self)
-      end
-    elsif response.has_key?(name) || response.has_key?(uri_name)
-      key = response.has_key?(name) ? name : uri_name
-      [resource_class.new(response[key], self)]
+    else
+      parse_response(response)
     end
   end
 
@@ -62,7 +56,6 @@ class AppnexusApi::Service
     while last_responses.size > 0
       responses += last_responses
       last_responses = get(params.merge('start_element' => responses.size))
-      sleep(1) # The gem has no error handling at all for rate limit errors; sleeping for a second prevents errors
     end
 
     responses
@@ -76,7 +69,7 @@ class AppnexusApi::Service
       response.delete('dbg')
       raise AppnexusApi::BadRequest.new(response.inspect)
     end
-    get("id" => response["id"]).first
+    parse_response(response).first
   end
 
   def update(id, attributes={})
@@ -87,7 +80,7 @@ class AppnexusApi::Service
       response.delete('dbg')
       raise AppnexusApi::BadRequest.new(response.inspect)
     end
-    get("id" => response["id"]).first
+    parse_response(response).first
   end
 
   def delete(id)
@@ -95,4 +88,19 @@ class AppnexusApi::Service
     @connection.delete([uri_suffix, id].join('/')).body['response']
   end
 
+  def parse_response(response)
+    case key = resource_name(response)
+    when plural_name, plural_uri_name
+      response[key].map do |json|
+        resource_class.new(json, self, response['dbg'])
+      end
+    when name, uri_name
+      [resource_class.new(response[key], self, response['dbg'])]
+    end
+  end
+
+  def resource_name(response)
+    [plural_name, plural_uri_name, name, uri_name].detect { |n| response.key?(n) }
+  end
+
 end

data/lib/appnexusapi/version.rb

@@ -1,3 +1,3 @@
 module AppnexusApi
-  VERSION = "0.0.9"
+  VERSION = '0.1.0'.freeze
 end

data/spec/creative_service_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe AppnexusApi::CreativeService do
+  let(:creative_service) do
+    AppnexusApi::CreativeService.new(connection, ENV['APPNEXUS_MEMBER_ID'])
+  end
+  let(:new_creative) do
+    {
+      'campaign'  => 'default campaign',
+      'content'   => '<iframe src="helloword.html"></iframe>',
+      'width'     => '300',
+      'height'    => '250',
+      'template'  => { 'id' => 7 }
+    }
+  end
+
+  it 'respects the throttle limit', slow: true do
+    # this spec will attempt to make 100 writes as fast as possible with 10
+    # threads running in a loop of 10.  Typically you hit the limit right
+    # around 25 seconds in.  If your connection is slow, this
+    # test may never hit the throttle limit
+    expect do
+      # this runs so we only authenticate once instead of 10 times.
+      _p = creative_service.get('num_elements' => 1, 'start_element' => 0)
+      10.times do
+        threads = []
+        10.times do
+          threads << Thread.new do
+            creative = creative_service.create(new_creative)
+            puts creative.dbg_info
+          end
+        end
+        threads.map(&:join)
+      end
+    end.to_not raise_error
+  end
+
+  it 'supports a get operation' do
+    expect do
+      creative_service.get('start_element' => 0, 'num_elements' => 1)
+    end.to_not raise_error
+  end
+
+  context 'creating a new creative' do
+    it 'supports creating a new creative' do
+      creative = creative_service.create(new_creative)
+      expect(creative.width).to eq 300
+      expect(creative.height).to eq 250
+    end
+  end
+
+  context 'an existing creative' do
+    let(:existing_creative) { creative_service.create(new_creative) }
+
+    it 'supports changing attributes with the update action' do
+      expect(existing_creative.campaign).to eq 'default campaign'
+      existing_creative.update('campaign' => 'My Best Campaign Yet')
+      expect(existing_creative.campaign).to eq 'My Best Campaign Yet'
+    end
+
+    it 'supports removing the creative' do
+      id = existing_creative.id
+      creative = creative_service.get('id' => id).first
+      expect(creative.id).to eq id
+      existing_creative.delete
+      creative = creative_service.get('id' => id)
+      expect(creative).to be_nil
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'dotenv'
+Dotenv.load
+
+Bundler.require
+require 'pry'
+require 'logger'
+require_relative '../lib/appnexusapi'
+
+RSpec.configure do |c|
+  c.filter_run_excluding :slow => true
+end
+
+def test_logger
+  return @logger unless @logger.nil?
+  FileUtils.mkdir_p('./log')
+  @logger = Logger.new('./log/test.log')
+  @logger.level = Logger::INFO
+  @logger
+end
+
+def connection
+  AppnexusApi::Connection.new(
+    'username' => ENV['APPNEXUS_USERNAME'],
+    'password' => ENV['APPNEXUS_PASSWORD'],
+    'uri'      => ENV['APPNEXUS_URI'],
+    'logger'   => test_logger
+  )
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appnexusapi
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Brandon Aaron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-06 00:00:00.000000000 Z
+date: 2016-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: null_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: dotenv
+  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: pry
+  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:
 - brandon.aaron@gmail.com
@@ -93,6 +149,7 @@ files:
 - README.md
 - Rakefile
 - appnexusapi.gemspec
+- env_example
 - lib/appnexusapi.rb
 - lib/appnexusapi/ad_server_resource.rb
 - lib/appnexusapi/ad_server_service.rb
@@ -153,6 +210,8 @@ files:
 - lib/appnexusapi/user_resource.rb
 - lib/appnexusapi/user_service.rb
 - lib/appnexusapi/version.rb
+- spec/creative_service_spec.rb
+- spec/spec_helper.rb
 homepage: http://simpli.fi
 licenses: []
 metadata: {}
@@ -172,9 +231,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: Unofficial Ruby API Wrapper for Appnexus
-test_files: []
-has_rdoc: 
+test_files:
+- spec/creative_service_spec.rb
+- spec/spec_helper.rb