appnexusapi 0.0.5 → 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dcb81e6d6e3e396e606b8f5f34133564bb1e23d4
+  data.tar.gz: c818e90587d6ea29f0732b4e0d26e6b4632c2a73
+SHA512:
+  metadata.gz: fbf3d7e3efe189261e35340b03ed7b06f34c5e99f8a11a3c3b1d0de6a93738a034dab5f7cbc867419dc03a027a01e97c2da35dbfbe53c762e7ad47c0ff69a467
+  data.tar.gz: 4a09f2255dc0e823f18b4c436ea959959afd087842389f125d5785dec9a18816a5fa5ad7396fb99091db7fd16c7761146cb5f16da58bdc0511fbecfb80d2f7a4

data/README.md

@@ -20,13 +20,14 @@ Or install it yourself as:
 
 Establish a connection:
 
-    connection = AppnexusApi::Connection.new({
-      # optionally pass a uri for the staging site
-      # defaults to "http://api.adnxs.com/"
-      # uri => "http://api.sand-08.adnxs.net",
-      "username" => 'username',
-      "password" => 'password'
-    })
+    connection = AppnexusApi::Connection.new(
+      'username' => 'username',
+      'password' => 'password'
+
+      # 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'
+    )
 
 Use a Service:
 
@@ -47,6 +48,16 @@ Use a Service:
     creative = creative_service.create(new_creative)
     creative.update("campaign" => "Testing")
 
+## Debugging
+
+The APPNEXUS_API_DEBUG environment variable will trigger full printouts of Faraday's debug output to STDERR.
+
+```bash
+cd /my/app
+export APPNEXUS_API_DEBUG=true
+bundle exec rails whatever
+```
+
 ## Contributing
 
 1. Fork it

data/appnexusapi.gemspec

@@ -15,7 +15,10 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = AppnexusApi::VERSION
 
-  gem.add_dependency 'faraday', '~>0.8.7'
-  gem.add_dependency  "multi_json", "~> 1.7.2"
+  gem.add_dependency 'faraday', '~> 0.9'
+  gem.add_dependency 'faraday_middleware'
+  gem.add_dependency 'multi_json'
+  gem.add_dependency 'pester'
+  
   gem.add_development_dependency 'bundler', '>= 1.2.0'
 end

data/lib/appnexusapi/bidder_profile_service.rb

@@ -1,4 +1,4 @@
-class AppnexusApi::BidderProfileResource < AppnexusApi::Service
+class AppnexusApi::BidderProfileService < AppnexusApi::Service
 
   def initialize(connection, bidder_id)
     @bidder_id = bidder_id
@@ -14,7 +14,7 @@ class AppnexusApi::BidderProfileResource < AppnexusApi::Service
   end
 
   def uri_suffix
-    "bidder-profile/#{@bidder_id}"
+    "profile/#{@bidder_id}"
   end
 
   def delete(id)

data/lib/appnexusapi/connection.rb

@@ -1,16 +1,19 @@
-require 'appnexusapi/faraday/encode_json'
-require 'appnexusapi/faraday/parse_json'
+require 'faraday_middleware'
 require 'appnexusapi/faraday/raise_http_error'
 
 class AppnexusApi::Connection
   def initialize(config)
-    config["uri"] = "http://api.adnxs.com/" unless config.has_key?("uri")
     @config = config
-    @connection = Faraday::Connection.new(:url => config["uri"]) do |builder|
-      builder.use AppnexusApi::Faraday::Request::JsonEncode
-      builder.use AppnexusApi::Faraday::Response::RaiseHttpError
-      builder.use AppnexusApi::Faraday::Response::ParseJson
-      builder.adapter Faraday.default_adapter
+    @config['uri'] ||= 'https://api.appnexus.com/'
+    @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.request :json
+      conn.response :json, :content_type => /\bjson$/
+      conn.use AppnexusApi::Faraday::Response::RaiseHttpError
+      conn.adapter Faraday.default_adapter
     end
   end
 
@@ -19,8 +22,11 @@ class AppnexusApi::Connection
   end
 
   def login
-    response = @connection.run_request(:post, 'auth', { "auth" => { "username" => @config["username"], "password" => @config["password"] } }, {})
-    @token = response.body["token"]
+    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
+    @token = response.body['response']['token']
   end
 
   def logout
@@ -29,25 +35,25 @@ class AppnexusApi::Connection
 
   def get(route, params={}, headers={})
     params = params.delete_if {|key, value| value.nil? }
-    run_request(:get, @connection.build_url(route, params), nil, headers).body
+    run_request(:get, @connection.build_url(route, params), nil, headers)
   end
 
   def post(route, body=nil, headers={})
-    run_request(:post, route, body, headers).body
+    run_request(:post, route, body, headers)
   end
 
   def put(route, body=nil, headers={})
-    run_request(:put, route, body, headers).body
+    run_request(:put, route, body, headers)
   end
 
   def delete(route, body=nil, headers={})
-    run_request(:delete, route, body, headers).body
+    run_request(:delete, route, body, headers)
   end
 
   def run_request(method, route, body, headers)
     login if !is_authorized?
     begin
-      @connection.run_request(method, route, body, { "Authorization" => @token }.merge(headers))
+      @connection.run_request(method, route, body, { 'Authorization' => @token }.merge(headers))
     rescue AppnexusApi::Unauthorized => e
       if @retry == true
         raise AppnexusApi::Unauthorized, e
@@ -57,7 +63,7 @@ class AppnexusApi::Connection
         run_request(method, route, body, headers)
       end
     rescue Faraday::Error::TimeoutError => e
-      raise AppnexusApi::Timeout, "Timeout"
+      raise AppnexusApi::Timeout, 'Timeout'
     ensure
       @retry = false
     end

data/lib/appnexusapi/creative_template_resource.rb

@@ -0,0 +1,2 @@
+class AppnexusApi::CreativeTemplateResource < AppnexusApi::Resource
+end

data/lib/appnexusapi/creative_template_service.rb

@@ -0,0 +1,18 @@
+class AppnexusApi::CreativeTemplateService < AppnexusApi::Service
+  def name
+    "template"
+  end
+
+  def resource_class
+    AppnexusApi::CreativeTemplateResource
+  end
+
+  def uri_suffix
+    "template"
+  end
+
+  def delete(id)
+    raise AppnexusApi::NotImplemented
+  end
+
+end

data/lib/appnexusapi/log_level_data_download_service.rb

@@ -0,0 +1,68 @@
+class AppnexusApi::LogLevelDataDownloadService < AppnexusApi::Service
+  class BadChecksumException < Exception
+  end
+
+  def initialize(connection, options = {})
+    @read_only = true
+    @downloaded_files_path = options[:downloaded_files_path] || '.'
+    super(connection)
+  end
+
+  def download_location(params = {})
+    @connection.get(uri_suffix, params).headers['location']
+  end
+
+  # Parameter is a LogLevelDataResource
+  # Downloads a gzipped file
+  # Returns an array of paths to downloaded files
+  def download_resource(data_resource)
+    data_resource.download_params.map do |params|
+      uri = URI.parse(download_location(params.reject { |k,v| k == :checksum }))
+      filename = File.join(@downloaded_files_path, "#{params[:siphon_name]}_#{params[:hour]}_#{params[:split_part]}.gz")
+      Pester.retry_with_exponential_backoff do
+        download_file(uri, filename)
+        calculated_checksum = Digest::MD5.hexdigest(File.read(filename))
+        if calculated_checksum != params[:checksum]
+          error_message = "Calculated checksum of #{calculated_checksum} doesn't match API provided checksum #{params[:checksum]}"
+          puts error_message
+          fail(BadChecksumException, error_message)
+        end
+      end
+
+      filename
+    end
+  end
+
+  def get
+    fail(AppnexusApi::NotImplemented, 'This service is designed to work through download_location method.')
+  end
+
+  def uri_name
+    'siphon-download'
+  end
+
+  private
+
+  def download_file(uri, filename)
+    puts "Starting HTTP download for: #{uri.to_s}..."
+    http_object = Net::HTTP.new(uri.host, uri.port)
+    http_object.use_ssl = true if uri.scheme == 'https'
+    begin
+      http_object.start do |http|
+        request = Net::HTTP::Get.new(uri.request_uri)
+        http.read_timeout = 500
+        http.request(request) do |response|
+          open(filename, 'wb') do |io|
+            response.read_body do |chunk|
+              io.write(chunk)
+            end
+          end
+        end
+      end
+    rescue StandardError => e
+      puts "=> Exception: '#{e}'. Skipping download."
+      return
+    end
+    puts "Stored download as #{filename}"
+  end
+end

data/lib/appnexusapi/log_level_data_resource.rb

@@ -0,0 +1,20 @@
+class AppnexusApi::LogLevelDataResource < AppnexusApi::Resource
+  # Extract an array of hashes of params to pass to the LogLevelDownloadService
+  def download_params
+    fail 'Missing necessaray information!' unless name && hour && timestamp && splits
+    splits.map do |split_part|
+      if split_part['checksum'].blank?
+        # In the case of regenerated files, there can be no checksum.  These replaced hourly files should not be downloaded.
+        nil
+      else
+        {
+          split_part: split_part['part'],
+          siphon_name: name,
+          timestamp: timestamp,
+          hour: hour,
+          checksum: split_part['checksum']
+        }
+      end
+    end.compact
+  end
+end

data/lib/appnexusapi/log_level_data_service.rb

@@ -0,0 +1,20 @@
+class AppnexusApi::LogLevelDataService < AppnexusApi::Service
+  def initialize(connection, options = {})
+    @read_only = true
+    @siphon_name = options[:siphon_name]
+
+    super(connection)
+  end
+
+  def since(time = nil)
+    params = {}
+    params[:siphon_name] = @siphon_name if @siphon_name
+    params[:updated_since] = time.strftime('%Y_%m_%d_%H') if time
+
+    get(params)
+  end
+
+  def uri_name
+    'siphon'
+  end
+end

data/lib/appnexusapi/service.rb

@@ -21,15 +21,15 @@ class AppnexusApi::Service
       AppnexusApi.const_get(resource_name + "Resource")
     end
   end
-  
+
   def uri_name
     name.gsub('_', '-')
   end
-  
+
   def plural_uri_name
     uri_name + 's'
   end
-  
+
   def uri_suffix
     uri_name
   end
@@ -40,7 +40,7 @@ class AppnexusApi::Service
       "num_elements" => 100,
       "start_element" => 0
     }.merge(params)
-    response = @connection.get(uri_suffix, params)
+    response = @connection.get(uri_suffix, params).body['response']
     if return_response
       response
     elsif response.has_key?(plural_name) || response.has_key?(plural_uri_name)
@@ -57,20 +57,28 @@ class AppnexusApi::Service
   def create(attributes={})
     raise(AppnexusApi::NotImplemented, "Service is read-only.") if @read_only
     attributes = { name => attributes }
-    response = @connection.post(uri_suffix, attributes)
+    response = @connection.post(uri_suffix, attributes).body['response']
+    if response['error_id']
+      response.delete('dbg')
+      raise AppnexusApi::BadRequest.new(response.inspect)
+    end
     get("id" => response["id"]).first
   end
 
   def update(id, attributes={})
     raise(AppnexusApi::NotImplemented, "Service is read-only.") if @read_only
     attributes = { name => attributes }
-    response = @connection.put([uri_suffix, id].join('/'), attributes)
+    response = @connection.put([uri_suffix, id].join('/'), attributes).body['response']
+    if response['error_id']
+      response.delete('dbg')
+      raise AppnexusApi::BadRequest.new(response.inspect)
+    end
     get("id" => response["id"]).first
   end
 
   def delete(id)
     raise(AppnexusApi::NotImplemented, "Service is read-only.") if @read_only
-    @connection.delete([uri_suffix, id].join('/'))
+    @connection.delete([uri_suffix, id].join('/')).body['response']
   end
 
 end

data/lib/appnexusapi/version.rb

@@ -1,3 +1,3 @@
 module AppnexusApi
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,49 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: appnexusapi
 version: !ruby/object:Gem::Version
-  version: 0.0.5
-  prerelease: 
+  version: 0.0.6
 platform: ruby
 authors:
 - Brandon Aaron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-10 00:00:00.000000000Z
+date: 2016-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &2168053620 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: '0.9'
   type: :runtime
   prerelease: false
-  version_requirements: *2168053620
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  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: multi_json
-  requirement: &2168052460 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.2
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2168052460
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pester
+  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: &2168051640 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.0
   type: :development
   prerelease: false
-  version_requirements: *2168051640
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 description: ''
 email:
 - brandon.aaron@gmail.com
@@ -51,7 +87,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
@@ -77,11 +113,11 @@ files:
 - lib/appnexusapi/content_category_service.rb
 - lib/appnexusapi/creative_resource.rb
 - lib/appnexusapi/creative_service.rb
+- lib/appnexusapi/creative_template_resource.rb
+- lib/appnexusapi/creative_template_service.rb
 - lib/appnexusapi/domain_list_resource.rb
 - lib/appnexusapi/domain_list_service.rb
 - lib/appnexusapi/error.rb
-- lib/appnexusapi/faraday/encode_json.rb
-- lib/appnexusapi/faraday/parse_json.rb
 - lib/appnexusapi/faraday/raise_http_error.rb
 - lib/appnexusapi/inventory_attribute_resource.rb
 - lib/appnexusapi/inventory_attribute_service.rb
@@ -91,6 +127,9 @@ files:
 - lib/appnexusapi/language_service.rb
 - lib/appnexusapi/line_item_resource.rb
 - lib/appnexusapi/line_item_service.rb
+- lib/appnexusapi/log_level_data_download_service.rb
+- lib/appnexusapi/log_level_data_resource.rb
+- lib/appnexusapi/log_level_data_service.rb
 - lib/appnexusapi/member_resource.rb
 - lib/appnexusapi/member_service.rb
 - lib/appnexusapi/operating_system_service.rb
@@ -109,27 +148,26 @@ files:
 - lib/appnexusapi/version.rb
 homepage: http://simpli.fi
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 2.2.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Unofficial Ruby API Wrapper for Appnexus
 test_files: []
 has_rdoc: 

data/lib/appnexusapi/faraday/encode_json.rb

@@ -1,15 +0,0 @@
-module AppnexusApi
-  module Faraday
-    module Request
-      class JsonEncode < ::Faraday::Middleware
-        def call(env)
-          if env[:request_headers]["Content-Type"] == nil
-            env[:body] = MultiJson.encode(env[:body]) if env[:body] != nil
-            env[:request_headers]["Content-Type"] = "application/json"
-          end
-          @app.call(env)
-        end
-      end
-    end
-  end
-end

data/lib/appnexusapi/faraday/parse_json.rb

@@ -1,61 +0,0 @@
-module AppnexusApi
-  module Faraday
-    module Response
-      class ParseJson < ::Faraday::Middleware
-        dependency 'multi_json'
-
-        def call(env)
-          @app.call(env).on_complete do
-            if env[:response_headers]["content-type"].include?("application/json")
-              env[:body] = convert_to_json(env[:body])["response"]
-              check_for_error(env)
-            end
-          end
-        end
-
-        protected
-
-        def convert_to_json(body)
-          case body.strip
-          when ''
-            nil
-          when 'true'
-            true
-          when 'false'
-            false
-          else
-            begin
-              ::MultiJson.decode(body)
-            rescue Exception => exception
-              raise AppnexusApi::InvalidJson
-            end
-          end
-        end
-
-        def check_for_error(env)
-          if env[:body].has_key?("error")
-            case env[:body]["error_id"]
-            when "NOAUTH"
-              raise AppnexusApi::Unauthorized, error_message(env)
-            when "UNAUTH"
-              raise AppnexusApi::Forbidden, error_message(env)
-            when "SYNTAX"
-              raise AppnexusApi::UnprocessableEntity, error_message(env)
-            when "SYSTEM"
-              raise AppnexusApi::InternalServerError, error_message(env)
-            when "INTEGRITY"
-              raise AppnexusApi::UnprocessableEntity, error_message(env)
-            else
-              raise AppnexusApi::Error, error_message(env)
-            end
-          end
-        end
-
-        def error_message(env)
-          "#{env[:method].to_s.upcase} #{env[:url].to_s} (#{env[:body]["error_id"]}): #{env[:body]["error"]}"
-        end
-
-      end
-    end
-  end
-end