appnexusapi 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0184db6bca5286e5ec3ac206cf0d964ce78484e0
-  data.tar.gz: dec7fe42720c2c0b89dcaa55bbb142bfce2721b5
+  metadata.gz: 06455610db5b16548020d670d175ef13fd7451f5
+  data.tar.gz: 07544e12f14bb6e8fe351a53798fcbf5e2eaef94
 SHA512:
-  metadata.gz: fb39def781471b2b91f8803116d0c71d734dca49ddaca2fec95e6d104b1f7e21c61aa9c0d55fa11300a69d6d95e7e961a7479dc34ef319a8791e9032483f5aa4
-  data.tar.gz: 6932d3ac84d2f075c5cb71c4d5a97a0a618ed2af94b7f41091f2776dff59c82099527a8ac6b2c319d9577c61f6725b1f7a322e115f24fbd1e3b76686dfe49535
+  metadata.gz: f96356e6bb6566aff2903b3964ccb01dbb0f2ad89aaa9c2372708fa9049569c3c37c95b8c15a28370af856dfe0352409775eba90c04aaa9b0eaef03a055bb476
+  data.tar.gz: 640ca6320f0c33ab849038014a8f7971cbaf09a02d729252c33b819609e50384f9fe5c1566c347991181dfa19a9e374c402c160f9554a32f9e79cbc3e2f4bb44

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## 1.1.0
+- Add `Resource#save` method to allow saving resources that have been modified with `update`
+- Replace `Pester` gem with `Retriable`
+- Remove `NullLogger` dependency; log to STDOUT by default
+- Delete unnecessary `_resource.rb` files
+
+## 1.0.0
+
+- Initial 1.0 release; lots of new services and resources.

data/README.md

@@ -18,58 +18,83 @@ Or install it yourself as:
 
 ## Usage
 
-Establish a connection:
+#### Configure defaults
+```ruby
+AppnexusApi.configure do |config|
+  config.logger = Logger.new('/path/to/log.log')
+end
+```
+
+#### Establish a connection:
+
+```ruby
+connection = AppnexusApi::Connection.new(
+  'username' => 'username',
+  'password' => 'password',
+  'logger'   => Logger.new(STDOUT) # defaults to STDOUT
+
+  # 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-test.appnexus.com',
+)
+```
 
-    connection = AppnexusApi::Connection.new(
-      'username' => 'username',
-      'password' => 'password',
-      'logger'   => Logger.new(STDOUT) # defaults to a null logger if no value passed in.
+#### Use a Service:
 
-      # 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-test.appnexus.com',
+```ruby
+member_service = AppnexusApi::MemberService.new(connection)
+# get always returns an array of results
+# and defaults "num_elements" to 100 and "start_element" to 0
+# and returns an AppnexusApi::Resource object which is a wrapper around the JSON
+member = member_service.get.first
 
+line_item_service = AppnexusApi::LineItemService.new(connection)
+line_item = line_item_service.get.first
+line_item = line_item_service.get({advertiser_id: 12345}).first
 
-    )
+# create a new object
+url_params  = { advertiser_id: 12345 }
+body_params = { name: "some line item", code: "line item code"}
 
-Use a Service:
+line_item = line_item_service.create(url_params, body_params)
+line_item.state
 
-    member_service = AppnexusApi::MemberService.new(connection)
-    # get always returns an array of results
-    # and defaults "num_elements" to 100 and "start_element" to 0
-    # and returns an AppnexusApi::Resource object which is a wrapper around the JSON
-    member = member_service.get.first
 
-    line_item_service = AppnexusApi::LineItemService.new(connection)
-    line_item = line_item_service.get.first
-    line_item = line_item_service.get({advertiser_id: 12345}).first
+# update an object
+update_params = { state: "inactive" }
+json_result = line_item.update(url_params, update_params)
 
-    # create a new object
-    url_params  = { advertiser_id: 12345 }
-    body_params = { name: "some line item", code: "line item code"}
+# delete an object
+line_item.delete(url_params)
 
-    line_item = line_item_service.create(url_params, body_params)
-    line_item.state
+# save an object that you modified locally
+line_item.raw_json[:state] = 'active'
+line_item.save
 
+# this raises an AppnexusApi::UnprocessableEntity, not a 404 as it should
+line_item_service.get(line_item.id)
 
-    # update an object
-    update_params = { state: "inactive" }
-    json_result = line_item.update(url_params, update_params)
+new_creative = {
+  "content"   => "<iframe src='helloword.html'></iframe>",
+  "width" => "300",
+  "height" => "250",
+  "template"  =>{ "id" => 7 }
+}
+creative = creative_service.create(new_creative)
+creative.update("campaign" => "Testing")
+```
 
-    # delete an object
-    line_item.delete(url_params)
+#### Downloading Log Level Data:
 
-    # this raises an AppnexusApi::UnprocessableEntity, not a 404 as it should
-    line_item_service.get(line_item.id)
+```ruby
+download_service = AppnexusApi::LogLevelDataService.new(
+  connection,
+  downloaded_files_path: '/example/local/path',
+  siphon_name: 'standard_feed'
+)
 
-    new_creative = {
-      "content"   => "<iframe src='helloword.html'></iframe>",
-      "width" => "300",
-      "height" => "250",
-      "template"  =>{ "id" => 7 }
-    }
-    creative = creative_service.create(new_creative)
-    creative.update("campaign" => "Testing")
+downloaded_files = data_service.download_new_files_since('2016-02-01'.to_time)
+```
 
 ## Testing
 
@@ -81,8 +106,15 @@ bundle exec rspec
 ### Writing New Specs or Updating Old Ones
 This library uses [VCR](https://github.com/vcr/vcr) and Webmock to record API call HTTP data and play it back when you run the specs.  To write new specs or update old ones, however, you will need to actually provide a valid login/password in a `.env` file (see [`env_example`](env_example) for an example) before launching the specs.
 
-To update a spec, simply remove the relevant file from [spec/fixtures/vcr](spec/fixtures/vcr) (and setup the username/password) before launching `rspec`; the changes will be recorded automatically by VCR.
+To update a spec, simply remove the relevant file from [spec/fixtures/vcr](spec/fixtures/vcr) (and setup the username/password as above) before launching `rspec`; the changes will be recorded automatically by VCR.
+
+## Debugging
 
+To trigger full Faraday request/respone logging, set the `APPNEXUS_API_DEBUG` environment variable before launching
+your application
+```
+export APPNEXUS_API_DEBUG=true
+```
 
 ## Contributing
 

data/appnexusapi.gemspec

@@ -18,8 +18,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'faraday', '~> 0.9'
   gem.add_dependency 'faraday_middleware'
   gem.add_dependency 'multi_json'
-  gem.add_dependency 'pester'
-  gem.add_dependency 'null_logger'
+  gem.add_dependency 'retriable', '>= 2.0'
 
   gem.add_development_dependency 'bundler', '>= 1.2.0'
   gem.add_development_dependency 'rspec'

data/lib/appnexusapi.rb

@@ -1,15 +1,26 @@
-require "faraday"
-require "appnexusapi/version"
-require "appnexusapi/error"
+require 'faraday'
+require 'faraday_middleware'
+require 'logger'
+require 'retriable'
 
-module AppnexusApi
-  autoload :Connection, "appnexusapi/connection"
+require 'appnexusapi/configuration'
+require 'appnexusapi/version'
+require 'appnexusapi/error'
+require 'appnexusapi/resource'
+require 'appnexusapi/service'
+require 'appnexusapi/read_only_service'
+require 'appnexusapi/connection'
+
+Dir.glob("#{File.join(File.dirname(__FILE__), 'appnexusapi', 'services')}/*.rb").each do |service_file|
+  require service_file
+end
 
-  dir = File.dirname(__FILE__) + "/appnexusapi"
-  files = Dir.glob(File.expand_path("{*resource,*service}.rb", dir)).map{|f| File.basename(f, '.rb')}
-  files.each do |file|
-    sym = file.capitalize.gsub(/(_(.))/) { |c| $2.upcase }.to_sym
-    autoload sym, "appnexusapi/#{file}"
+module AppnexusApi
+  def self.config
+    @configuration ||= Configuration.new
   end
 
+  def self.configure
+    yield(config)
+  end
 end

data/lib/appnexusapi/configuration.rb

@@ -0,0 +1,12 @@
+module AppnexusApi
+  class Configuration
+    attr_accessor :api_debug, :logger
+
+    def initialize
+      @api_debug = ENV['APPNEXUS_API_DEBUG'].to_s =~ /^(true|t|yes|y|1)$/i
+      @logger = Logger.new(STDOUT).tap do |logger|
+        @api_debug ? logger.level = Logger::DEBUG : logger.level = Logger::INFO
+      end
+    end
+  end
+end

data/lib/appnexusapi/connection.rb

@@ -1,108 +1,101 @@
-require 'faraday_middleware'
 require 'appnexusapi/faraday/raise_http_error'
-require 'null_logger'
-
-class AppnexusApi::Connection
-  RATE_EXCEEDED_DEFAULT_TIMEOUT = 15
-  # Inexplicably, sandbox uses the correct code of 429, while production uses 405? so
-  # we just rely on the error message
-  RATE_EXCEEDED_ERROR = 'RATE_EXCEEDED'.freeze
-
-  def initialize(config)
-    @config = config
-    @config['uri'] ||= 'https://api.appnexus.com/'
-    @logger = @config['logger'] || NullLogger.instance
-    @connection = Faraday.new(@config['uri']) do |conn|
-      conn.response :logger, @logger, bodies: true
-      conn.request :json
-      conn.response :json, :content_type => /\bjson$/
-      conn.use AppnexusApi::Faraday::Response::RaiseHttpError
-      conn.adapter Faraday.default_adapter
+
+module AppnexusApi
+  class Connection
+    RATE_EXCEEDED_DEFAULT_TIMEOUT = 15
+
+    RATE_LIMIT_WAITER = Proc.new do |exception, try, elapsed_time, next_interval|
+      if (match = /Retry after (\d+)s/.match(exception.message))
+        seconds = match[1].to_i
+      else
+        seconds = RATE_EXCEEDED_DEFAULT_TIMEOUT
+      end
+      seconds += RATE_EXCEEDED_DEFAULT_TIMEOUT # Just to be sure we waited long enough
+      AppnexusApi.config.logger.warn("WARN: Rate limit exceeded; retrying after #{seconds}s...")
+      sleep(seconds)
     end
-  end
 
-  def is_authorized?
-    !@token.nil?
-  end
+    attr_reader :connection, :logger
 
-  def log
-    @logger
-  end
+    def initialize(config)
+      @config = config
+      @config['uri'] ||= 'https://api.appnexus.com/'
+      @logger = @config['logger'] || AppnexusApi.config.logger
+      @connection = ::Faraday.new(@config['uri']) do |conn|
+        conn.response :logger, @logger, bodies: true if AppnexusApi.config.api_debug
+        conn.request :json
+        conn.response :json, :content_type => /\bjson$/
+        conn.use AppnexusApi::Faraday::Response::RaiseHttpError
+        conn.adapter ::Faraday.default_adapter
+      end
+    end
+
+    def login
+      response = @connection.run_request(
+        :post,
+        'auth',
+        { 'auth' => { 'username' => @config['username'], 'password' => @config['password'] } },
+        {}
+      )
+
+      if response.body['response']['error_code']
+        fail "#{response.body['response']['error_code']}/#{response.body['response']['error_description']}"
+      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']}"
+      @token = response.body['response']['token']
     end
-    @token = response.body['response']['token']
-  end
 
-  def logout
-    @token = nil
-  end
+    def get(route, params={}, headers={})
+      params = params.delete_if { |_, v| v.nil? }
+      run_request(:get, build_url(route, params), nil, headers)
+    end
 
-  def get(route, params={}, headers={})
-    params = params.delete_if {|key, value| value.nil? }
-    run_request(:get, build_url(route, params), nil, headers)
-  end
+    def build_url(route, params)
+      @connection.build_url(route, params)
+    end
 
-  def build_url(route, params)
-    @connection.build_url(route, params)
-  end
+    def post(route, body=nil, headers={})
+      run_request(:post, route, body, headers)
+    end
 
-  def post(route, body=nil, headers={})
-    run_request(:post, route, body, headers)
-  end
+    def put(route, body=nil, headers={})
+      run_request(:put, route, body, headers)
+    end
 
-  def put(route, body=nil, headers={})
-    run_request(:put, route, body, headers)
-  end
+    def delete(route, body=nil, headers={})
+      run_request(:delete, route, body, headers)
+    end
 
-  def delete(route, body=nil, headers={})
-    run_request(:delete, route, body, headers)
-  end
+    private
 
-  def run_request(method, route, body, headers)
-    login unless is_authorized?
-    response = {}
-    begin
-      loop do
-        response = run_request_only(
-          method,
-          route,
-          body,
-          { 'Authorization' => @token }.merge(headers)
-        )
-        break if response.body.empty? # Log level data download service returns a body of ""
-        break unless response.body.fetch('response', {})['error_code'] == RATE_EXCEEDED_ERROR
-        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
-      else
-        @retry = true
-        logout
-        response = run_request(method, route, body, headers)
+    def run_request(method, route, body, headers)
+      login unless is_authorized?
+      response = {}
+
+      Retriable.retriable(on: Unauthorized, on_retry: Proc.new { logout }) do
+        Retriable.retriable(on: RateLimitExceeded, on_retry: RATE_LIMIT_WAITER) do
+          begin
+            response = @connection.run_request(
+              method,
+              route,
+              body,
+              { 'Authorization' => @token }.merge(headers)
+            )
+          rescue ::Faraday::Error::TimeoutError => e
+            raise Timeout, e.message, e.message, e.backtrace
+          end
+        end
       end
-    rescue Faraday::Error::TimeoutError => _e
-      raise AppnexusApi::Timeout, 'Timeout'
-    ensure
-      @retry = false
+
+      response
+    end
+
+    def is_authorized?
+      !@token.nil?
     end
-    log.debug(response.body)
-    response
-  end
 
-  def run_request_only(method, route, body, headers)
-    @connection.run_request(
-      method,
-      route,
-      body,
-      { 'Authorization' => @token }.merge(headers)
-    )
+    def logout
+      @token = nil
+    end
   end
 end

data/lib/appnexusapi/error.rb

@@ -1,5 +1,7 @@
 module AppnexusApi
   class Error < StandardError; end
+
+  class BadChecksumException < Error; end
   class BadRequest < Error; end
   class Unauthorized < Error; end
   class Forbidden < Error; end
@@ -12,4 +14,5 @@ module AppnexusApi
   class ServiceUnavailable < Error; end
   class InvalidJson < Error; end
   class Timeout < Error; end
+  class RateLimitExceeded < Error; end
 end

data/lib/appnexusapi/faraday/raise_http_error.rb

@@ -2,6 +2,10 @@ module AppnexusApi
   module Faraday
     module Response
       class RaiseHttpError < ::Faraday::Response::Middleware
+        # Inexplicably, sandbox uses the correct code of 429, while production uses 405? so
+        # we just rely on the error message
+        RATE_EXCEEDED_ERROR = 'RATE_EXCEEDED'.freeze
+
         def on_complete(response)
           case response[:status].to_i
           when 400
@@ -25,11 +29,21 @@ module AppnexusApi
           when 503
             raise AppnexusApi::ServiceUnavailable, error_message(response)
           end
+
+          return if response.body.empty?
+          body = JSON.parse(response.body).fetch('response', {})
+
+          if body['error_code'] == RATE_EXCEEDED_ERROR
+            raise AppnexusApi::RateLimitExceeded, "Retry after #{response.response_headers['retry-after']}s"
+          elsif body['error_id'] && !body['error_id'].empty?
+            # TODO: this should raise an error, but a lot of the specs currently have error responses
+            # raise AppnexusApi::Error, "#{body['error_id']}: #{body['error']} - #{body['error_description']}"
+          end
         end
 
         def error_message(response)
           msg = "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]}"
-          if errors = response[:body] && response[:body]["errors"]
+          if (errors = response[:body]) && response[:body]['errors']
             msg << "\n"
             msg << errors.join("\n")
           end