appnexusapi 1.0.0 → 1.1.0

data/lib/appnexusapi/read_only_service.rb

@@ -0,0 +1,8 @@
+module AppnexusApi
+  class ReadOnlyService < Service
+    def initialize(connection)
+      @read_only = true
+      super(connection)
+    end
+  end
+end

data/lib/appnexusapi/resource.rb

@@ -1,39 +1,43 @@
 class AppnexusApi::Resource
 
-  attr_reader :dbg_info
+  attr_reader :dbg_info, :raw_json
 
   def initialize(json, service, dbg_info = nil)
-    @json = json
+    @raw_json = json
     @service = service
     @dbg_info = dbg_info
   end
 
-  def update(route_params={}, body_params={})
-    resource = @service.update(id, route_params, body_params)
-    @json = resource.raw_json
+  def update(route_params = {}, body_params = {})
+    @raw_json = @service.update(id, route_params, body_params).raw_json
     self
   end
 
-  def delete(route_params={})
-    @service.delete(id, route_params)
+  # If you have modified the @raw_json hash in place, you can just do resource.save
+  def save
+    @service.update(id, {}, @raw_json).raw_json
+    self
   end
 
-  def raw_json
-    @json
+  def delete(route_params = {})
+    @service.delete(id, route_params)
   end
 
   def method_missing(sym, *args, &block)
-    if @json.respond_to?(sym)
-      @json.send(sym, *args, &block)
-    elsif @json.has_key?(sym.to_s)
-      return @json[sym.to_s]
+    if @raw_json.respond_to?(sym)
+      @raw_json.send(sym, *args, &block)
+    elsif @raw_json.key?(sym.to_s)
+      @raw_json[sym.to_s]
     else
       super(sym, *args, &block)
     end
   end
 
-  def to_s
-    @json.inspect
+  def respond_to_missing?(method_name, include_private = false)
+    @raw_json.respond_to?(method_name) || @raw_json.key?(method_name.to_s) || super
   end
 
+  def to_s
+    @raw_json.inspect
+  end
 end

data/lib/appnexusapi/service.rb

@@ -7,7 +7,7 @@ class AppnexusApi::Service
 
   def name
     @name ||= begin
-      str = self.class.name.split("::").last.gsub("Service", "")
+      str = self.class.name.split('::').last.sub(/Service\z/, '')
       str.gsub(/(.)([A-Z])/, '\1_\2').downcase
     end
   end
@@ -16,13 +16,6 @@ class AppnexusApi::Service
     name + 's'
   end
 
-  def resource_class
-    @resource_class ||= begin
-      resource_name = name.capitalize.gsub(/(_(.))/) { |c| $2.upcase }
-      AppnexusApi.const_get(resource_name + "Resource")
-    end
-  end
-
   def uri_name
     name.gsub('_', '-')
   end
@@ -35,20 +28,12 @@ class AppnexusApi::Service
     uri_name
   end
 
-  def get(params={})
-    return_response = params.delete(:return_response) || false
-    params = {
-      "num_elements" => DEFAULT_NUMBER_OF_ELEMENTS,
-      "start_element" => 0
-    }.merge(params)
-    response = @connection.get(uri_suffix, params).body['response']
-    if return_response
-      response
-    else
-      parse_response(response)
-    end
+  def get(params = {})
+    params = { 'num_elements' => DEFAULT_NUMBER_OF_ELEMENTS, 'start_element' => 0 }.merge(params)
+    parse_response(@connection.get(uri_suffix, params).body['response'])
   end
 
+  # Page through all available elements automatically
   def get_all(params = {})
     responses = []
     last_responses = get(params)
@@ -61,54 +46,56 @@ class AppnexusApi::Service
     responses
   end
 
-  def create(route_params={}, body={})
-    raise(AppnexusApi::NotImplemented, "Service is read-only.") if @read_only
-    body = { uri_name => body }
+  def create(route_params = {}, body = {})
+    check_read_only!
     route = @connection.build_url(uri_suffix, route_params)
-    response = @connection.post(route, body).body['response']
-    if response['error_id']
-      response.delete('dbg')
-      raise AppnexusApi::BadRequest.new(response.inspect)
-    end
+    response = @connection.post(route, { uri_name => body }).body['response']
+    validate_response!(response)
+
     parse_response(response).first
   end
 
-  def update(id, route_params={}, body={})
-    raise(AppnexusApi::NotImplemented, "Service is read-only.") if @read_only
-    body = { uri_name => body }
-    route = @connection.build_url(uri_suffix, route_params.merge("id" => id))
-    response = @connection.put(route, body).body['response']
-    if response['error_id']
-      response.delete('dbg')
-      raise AppnexusApi::BadRequest.new(response.inspect)
-    end
+  def update(id, route_params = {}, body = {})
+    check_read_only!
+    route = @connection.build_url(uri_suffix, route_params.merge('id' => id))
+    response = @connection.put(route, { uri_name => body }).body['response']
+    validate_response!(response)
+
     parse_response(response).first
   end
 
   def delete(id, route_params)
-    raise(AppnexusApi::NotImplemented, "Service is read-only.") if @read_only
-    route = @connection.build_url(uri_suffix, route_params.merge("id" => id))
+    check_read_only!
+    route = @connection.build_url(uri_suffix, route_params.merge('id' => id))
     response = @connection.delete(route).body['response']
-    if response['error_id']
-      response.delete('dbg')
-      raise AppnexusApi::BadRequest.new(response.inspect)
-    end
+    validate_response!(response)
+
     response
   end
 
+  private
+
+  def check_read_only!
+    raise(AppnexusApi::NotImplemented, "Service is read-only.") if @read_only
+  end
+
+  def validate_response!(response)
+    return unless response['error_id']
+
+    response.delete('dbg')
+    raise AppnexusApi::BadRequest.new(response.inspect)
+  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
+      response[key].map { |json| AppnexusApi::Resource.new(json, self, response['dbg']) }
     when name, uri_name
-      [resource_class.new(response[key], self, response['dbg'])]
+      [AppnexusApi::Resource.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/services/ad_server_service.rb

@@ -0,0 +1,9 @@
+class AppnexusApi::AdServerService < AppnexusApi::ReadOnlyService
+  def name
+    "adserver"
+  end
+
+  def uri_suffix
+    "ad-server"
+  end
+end

data/lib/appnexusapi/{bidder_instance_service.rb → services/bidder_instance_service.rb}

@@ -1,5 +1,4 @@
 class AppnexusApi::BidderInstanceService < AppnexusApi::Service
-
   def initialize(connection, bidder_id)
     @bidder_id = bidder_id
     super(connection)
@@ -9,10 +8,6 @@ class AppnexusApi::BidderInstanceService < AppnexusApi::Service
     "instance"
   end
 
-  def resource_class
-    AppnexusApi::BidderInstanceResource
-  end
-
   def uri_suffix
     "bidder-instance/#{@bidder_id}"
   end
@@ -20,5 +15,4 @@ class AppnexusApi::BidderInstanceService < AppnexusApi::Service
   def delete(id)
     raise AppnexusApi::NotImplemented, "To remove an instance, please set it to inactive."
   end
-
 end

data/lib/appnexusapi/{bidder_profile_service.rb → services/bidder_profile_service.rb}

@@ -1,5 +1,4 @@
 class AppnexusApi::BidderProfileService < AppnexusApi::Service
-
   def initialize(connection, bidder_id)
     @bidder_id = bidder_id
     super(connection)
@@ -9,10 +8,6 @@ class AppnexusApi::BidderProfileService < AppnexusApi::Service
     "profile"
   end
 
-  def resource_class
-    AppnexusApi::BidderProfileResource
-  end
-
   def uri_suffix
     "profile/#{@bidder_id}"
   end
@@ -20,5 +15,4 @@ class AppnexusApi::BidderProfileService < AppnexusApi::Service
   def delete(id)
     raise AppnexusApi::NotImplemented
   end
-
 end

data/lib/appnexusapi/services/brand_service.rb

@@ -0,0 +1,2 @@
+class AppnexusApi::BrandService < AppnexusApi::ReadOnlyService
+end

data/lib/appnexusapi/services/browser_service.rb

@@ -0,0 +1,2 @@
+class AppnexusApi::BrowserService < AppnexusApi::ReadOnlyService
+end

data/lib/appnexusapi/services/category_service.rb

@@ -0,0 +1,5 @@
+class AppnexusApi::CategoryService < AppnexusApi::ReadOnlyService
+  def plural_name
+    "categories"
+  end
+end

data/lib/appnexusapi/{content_category_service.rb → services/content_category_service.rb}

@@ -1,5 +1,4 @@
 class AppnexusApi::ContentCategoryService < AppnexusApi::Service
-
   def initialize(connection)
     super(connection)
   end

data/lib/appnexusapi/{creative_template_service.rb → services/creative_template_service.rb}

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

data/lib/appnexusapi/services/device_model_service.rb

@@ -0,0 +1,2 @@
+class AppnexusApi::DeviceModelService < AppnexusApi::ReadOnlyService
+end

data/lib/appnexusapi/services/inventory_attribute_service.rb

@@ -0,0 +1,2 @@
+class AppnexusApi::InventoryAttributeService < AppnexusApi::ReadOnlyService
+end

data/lib/appnexusapi/services/language_service.rb

@@ -0,0 +1,2 @@
+class AppnexusApi::LanguageService < AppnexusApi::ReadOnlyService
+end

data/lib/appnexusapi/services/log_level_data_download_service.rb

@@ -0,0 +1,13 @@
+require 'appnexusapi/services/log_level_data_service'
+
+# TODO: Remove this class in v2.0
+module AppnexusApi
+  class LogLevelDataDownloadService < LogLevelDataService
+    extend Gem::Deprecate
+
+    def initialize(connection, options = {})
+      super
+    end
+    deprecate :initialize, 'LogLevelDataService#initialize', 2017, 6
+  end
+end

data/lib/appnexusapi/services/log_level_data_service.rb

@@ -0,0 +1,105 @@
+module AppnexusApi
+  class LogLevelDataService < AppnexusApi::ReadOnlyService
+    DEFAULT_FEED = 'standard_feed'.freeze
+    DOWNLOAD_URI = 'siphon-download'.freeze
+    RETRY_DOWNLOAD_PARAMS = {
+      base_interval: 30,
+      tries: 20,
+      max_elapsed_time: 3600,
+      on: [AppnexusApi::Error, ::Faraday::Error::ClientError],
+      on_retry: Proc.new do |exception, tries|
+        AppnexusApi.config.logger.warn("Retrying after #{exception.class}: #{tries} attempts.")
+      end
+    }.freeze
+
+    def initialize(connection, options = {})
+      @downloaded_files_path = options[:downloaded_files_path] || '.'
+      @siphon_name = options[:siphon_name] || DEFAULT_FEED
+      super(connection)
+    end
+
+    def download_new_files_since(time = nil)
+      since(time).map { |siphon| download_resource(siphon) }
+    end
+
+    def uri_name
+      'siphon'
+    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
+      siphons = get(params) || {}
+
+      # Anything with the same name and hour but with a newer timestamp is a republished replacement for an older file.
+      # When this happens appnexus is supposed to set the checksum for the old file to NULL but they do not always
+      # actually do this, so we have to manually reject invalid entries.
+      siphons.reject do |siphon|
+        (siphons - [siphon]).any? { |s| s.name == siphon.name && s.hour == siphon.hour && s.timestamp > siphon.timestamp }
+      end
+    end
+
+    private
+
+    # Parameter is a LogLevelDataResource FKA a "Siphon"
+    # Downloads a gzipped file
+    # Returns an array of paths to downloaded files
+    def download_resource(siphon)
+      fail 'Missing necessary information!' unless siphon.name && siphon.hour && siphon.timestamp && siphon.splits
+
+      download_params = siphon.splits.map do |split_part|
+        # In the case of files that were later replaced, there should be no checksum and they shouldn't be downloaded
+        next nil if split_part['checksum'].nil? || split_part['checksum'].empty?
+
+        {
+          split_part: split_part['part'],
+          siphon_name: siphon.name,
+          timestamp: siphon.timestamp,
+          hour: siphon.hour,
+          checksum: split_part['checksum']
+        }
+      end.compact
+
+      download_params.map do |params|
+        uri = URI.parse(@connection.get(DOWNLOAD_URI, params.reject { |k, v| k == :checksum }).headers['location'])
+        filename = File.join(@downloaded_files_path, "#{params[:siphon_name]}_#{params[:hour]}_#{params[:split_part]}.gz")
+
+        Retriable.retriable(RETRY_DOWNLOAD_PARAMS) 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]}"
+            AppnexusApi.config.logger.fatal(error_message)
+            raise BadChecksumException, error_message
+          end
+        end
+
+        filename
+      end
+    end
+
+    def download_file(uri, filename)
+      AppnexusApi.config.logger.debug("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
+      end
+
+      AppnexusApi.config.logger.info("Stored download of #{uri.to_s} as #{filename}")
+    end
+  end
+end

data/lib/appnexusapi/services/media_type_service.rb

@@ -0,0 +1,2 @@
+class AppnexusApi::MediaTypeService < AppnexusApi::ReadOnlyService
+end