blurb 0.3.2 → 0.4.0

data/lib/blurb/{report.rb → report_requests.rb}

@@ -1,48 +1,52 @@
-module Blurb
-  class Report < BaseResource
-    CAMPAIGNS = "campaigns"
-    AD_GROUPS = "adGroups"
-    KEYWORDS = "keywords"
-    PRODUCT_ADS = "productAds"
-    ASINS = "asins"
-    TARGETS = "targets"
+require 'blurb/request_collection_with_campaign_type'
 
-    def create(params = {}, opts = {})
-      # required argument checks
-      raise ArgumentError.new("params hash must contain a recordType") unless params["recordType"]
-
-      # If no metrics are passed in, use the default metrics
-      metrics = params["metrics"] || get_default_metrics(params["recordType"],params["campaignType"])
+class Blurb
+  class ReportRequests < RequestCollectionWithCampaignType
+    def initialize(campaign_type:, base_url:, headers:)
+      @campaign_type = campaign_type
+      @base_url = "#{base_url}/v2/#{@campaign_type}"
+      @headers = headers
+    end
 
-      api_params = {
-        "reportDate" => params["reportDate"],
-        "metrics" => metrics
+    def create(
+      record_type:,
+      report_date: Date.today,
+      metrics: nil,
+      segment: nil
+    )
+      # create payload
+      metrics = get_default_metrics(record_type.to_s.underscore.to_sym) if metrics.nil?
+      payload = {
+        metrics: metrics.map{ |m| m.to_s.camelize(:lower) }.join(","),
+        report_date: report_date
       }
+      payload[:segment] = segment if segment
 
-      api_params["segment"] = params["segment"] if params["segment"]
-
-      if params["recordType"] == ASINS
-        request_url = "/v2/#{ASINS}/report"
-        api_params["campaignType"] = 'sponsoredProducts' if params["campaignType"] == SPONSORED_PRODUCTS
-        raise ArgumentError.new("ASIN report is not supported for Sponsored Brands") if params["campaignType"] == SPONSORED_BRANDS
-      else
-        request_url = "/v2/#{params["campaignType"]}/#{params["recordType"]}/report"
-      end
-
-      post_request(request_url, api_params)
+      execute_request(
+        api_path: "/#{record_type.to_s.camelize(:lower)}/report",
+        request_type: :post,
+        payload: payload
+      )
     end
 
-    def status(report_id, opts = {})
-      get_request("/v2/reports/#{report_id}")
+    def retrieve(report_id)
+      execute_request(
+        api_path: "/reports/#{report_id}",
+        request_type: :get,
+      )
     end
 
-    def download(location, opts = {})
-      opts.merge!({:full_path => true, :gzip => true, :no_token => true})
-      get_request(location, opts)
+    def download(report_id)
+      execute_request(
+        api_path: "/reports/#{report_id}/download",
+        request_type: :get,
+      )
     end
 
-    def get_default_metrics(record_type, campaign_type)
-      if campaign_type == SPONSORED_BRANDS
+    private
+
+    def get_default_metrics(record_type)
+      if @campaign_type == CAMPAIGN_TYPE_CODES[:sb]
         return [
           "campaignId",
           "impressions",
@@ -52,7 +56,7 @@ module Blurb
           "attributedSales14dSameSKU",
           "attributedConversions14d",
           "attributedConversions14dSameSKU"
-        ].join(",") if record_type == CAMPAIGNS
+        ] if record_type == :campaigns
         return [
           "adGroupId",
           "campaignId",
@@ -63,7 +67,7 @@ module Blurb
           "attributedSales14dSameSKU",
           "attributedConversions14d",
           "attributedConversions14dSameSKU"
-        ].join(",") if record_type == AD_GROUPS
+        ] if record_type == :ad_groups
         return [
           "keywordId",
           "adGroupId",
@@ -74,27 +78,9 @@ module Blurb
           "attributedSales14d",
           "attributedSales14dSameSKU",
           "attributedConversions14d",
-          "attributedConversions14dSameSKU" 
-        ].join(",") if record_type == KEYWORDS
-      elsif campaign_type == SPONSORED_PRODUCTS
-        return [
-          "campaignName",
-          "campaignId",
-          "adGroupId",
-          "adGroupName",
-          "asin",
-          "otherAsin",
-          "sku",
-          "currency",
-          "attributedUnitsOrdered1dOtherSKU",
-          "attributedUnitsOrdered7dOtherSKU",
-          "attributedUnitsOrdered14dOtherSKU",
-          "attributedUnitsOrdered30dOtherSKU",
-          "attributedSales1dOtherSKU",
-          "attributedSales7dOtherSKU",
-          "attributedSales14dOtherSKU",
-          "attributedSales30dOtherSKU"
-        ].join(",") if record_type == ASINS
+          "attributedConversions14dSameSKU"
+        ] if record_type == :keywords
+      elsif @campaign_type == CAMPAIGN_TYPE_CODES[:sp]
         return [
           "campaignName",
           "campaignId",
@@ -123,7 +109,7 @@ module Blurb
           "attributedSales7dSameSKU",
           "attributedSales14dSameSKU",
           "attributedSales30dSameSKU"
-        ].join(",") if record_type == CAMPAIGNS
+        ] if record_type == :campaigns
         return [
           "campaignName",
           "campaignId",
@@ -152,7 +138,7 @@ module Blurb
           "attributedSales7dSameSKU",
           "attributedSales14dSameSKU",
           "attributedSales30dSameSKU"
-        ].join(",") if record_type == AD_GROUPS
+        ] if record_type == :ad_groups
         return [
           "campaignName",
           "campaignId",
@@ -182,7 +168,7 @@ module Blurb
           "attributedSales7dSameSKU",
           "attributedSales14dSameSKU",
           "attributedSales30dSameSKU"
-        ].join(",") if record_type == KEYWORDS
+        ] if record_type == :keywords
         return [
           "campaignName",
           "campaignId",
@@ -214,7 +200,7 @@ module Blurb
           "attributedSales7dSameSKU",
           "attributedSales14dSameSKU",
           "attributedSales30dSameSKU"
-        ].join(",") if record_type == PRODUCT_ADS
+        ] if record_type == :product_ads
         return [
           "campaignName",
           "campaignId",
@@ -245,7 +231,7 @@ module Blurb
           "attributedSales7dSameSKU",
           "attributedSales14dSameSKU",
           "attributedSales30dSameSKU"
-        ].join(",") if record_type == TARGETS
+        ] if record_type == :targets
         return [
           "campaignName",
           "campaignId",
@@ -277,7 +263,7 @@ module Blurb
           "attributedSales7dSameSKU",
           "attributedSales14dSameSKU",
           "attributedSales30dSameSKU"
-        ].join(",") if record_type == PORTFOLIOS
+        ] if record_type == :portfolios
       end
     end
   end

data/lib/blurb/request.rb

@@ -0,0 +1,81 @@
+require 'active_support/core_ext/string'
+require "rest-client"
+require "blurb/base_class"
+
+class Blurb
+  class Request < BaseClass
+
+    def initialize(url:, request_type:, payload: nil, headers:, url_params: nil)
+      @url = setup_url(url, url_params)
+      @payload = convert_payload(payload)
+      @headers = headers
+      @request_type = request_type
+    end
+
+    def request_config
+      request_config = {
+        method: @request_type,
+        url: @url,
+        headers: @headers
+      }
+
+      case @request_type
+      when :get
+        request_config[:max_redirects] = 0
+      when :post, :put
+        request_config[:payload] = @payload if @payload
+      end
+
+      return request_config
+    end
+
+    def make_request
+      begin
+        resp = RestClient::Request.execute(request_config())
+      rescue RestClient::ExceptionWithResponse => err
+        # If this happens, then we are downloading a report from the api, so we can simply download the location
+        if err.response.code == 307
+          return RestClient.get(err.response.headers[:location])
+        else
+          return JSON.parse(err.response.body)
+        end
+      end
+      resp = convert_response(resp)
+      return resp
+    end
+
+    private
+      def setup_url(url, url_params)
+        url += "?#{URI.encode_www_form(camelcase_keys(url_params))}" if url_params
+        return url
+      end
+
+      def convert_payload(payload)
+        return if payload.nil?
+        payload = payload.map{|r| camelcase_keys(r)} if payload.class == Array
+        payload = camelcase_keys(payload) if payload.class == Hash
+        return payload.to_json
+      end
+
+      def convert_response(resp)
+        resp = JSON.parse(resp)
+        resp = resp.map{|r| underscore_keys(r)} if resp.class == Array
+        resp = underscore_keys(resp) if resp.class == Hash
+        #TODO convert to symbols recursively
+        return resp
+      end
+
+      def camelcase_keys(hash)
+        map = hash.map do |key,value|
+          value = value.strftime('%Y%m%d') if value.class == Date || value.class == Time
+          [key.to_s.camelize(:lower), value]
+        end
+        map.to_h
+      end
+
+      def underscore_keys(hash)
+        hash.map{|k,v| [k.underscore.to_sym, v]}.to_h
+      end
+
+  end
+end

data/lib/blurb/request_collection.rb

@@ -0,0 +1,99 @@
+require 'blurb/request'
+require "blurb/base_class"
+
+class Blurb
+  class RequestCollection < BaseClass
+
+    def initialize(headers:, base_url:)
+      @base_url = base_url
+      @headers = headers
+    end
+
+    def list(url_params=nil)
+      execute_request(
+        request_type: :get,
+        url_params: url_params
+      )
+    end
+
+    def list_extended(url_params=nil)
+      execute_request(
+        api_path: "/extended",
+        request_type: :get,
+        url_params: url_params
+      )
+    end
+
+    def retrieve(resource_id)
+      execute_request(
+        api_path: "/#{resource_id}",
+        request_type: :get
+      )
+    end
+
+    def retrieve_extended(resource_id)
+      execute_request(
+        api_path: "/extended/#{resource_id}",
+        request_type: :get
+      )
+    end
+
+    def create(**create_params)
+      create_bulk([create_params])
+    end
+
+    def create_bulk(create_array)
+      execute_bulk_request(
+        request_type: :post,
+        payload: create_array,
+        api_limit: 100
+      )
+    end
+
+    def update(**update_params)
+      update_bulk([update_params])
+    end
+
+    def update_bulk(update_array)
+      execute_bulk_request(
+        request_type: :put,
+        payload: update_array,
+        api_limit: 100
+      )
+    end
+
+    def delete(resource_id)
+      execute_request(
+        api_path: "/#{resource_id}",
+        request_type: :delete
+      )
+    end
+
+    private
+
+      def execute_request(api_path: "", request_type:, payload: nil, url_params: nil)
+        url = "#{@base_url}#{api_path}"
+
+        request = Request.new(
+          url: url,
+          url_params: url_params,
+          request_type: request_type,
+          payload: payload,
+          headers: @headers
+        )
+
+        request.make_request
+      end
+
+      # Split up bulk requests to match the api limit
+      def execute_bulk_request(api_limit:, **execute_request_params)
+        results = []
+        payloads = execute_request_params[:payload].each_slice(api_limit).to_a
+        payloads.each do |p|
+          execute_request_params[:payload] = p
+          results << execute_request(execute_request_params)
+        end
+        results.flatten
+      end
+  end
+end

data/lib/blurb/request_collection_with_campaign_type.rb

@@ -0,0 +1,12 @@
+require 'blurb/request_collection'
+
+class Blurb
+  class RequestCollectionWithCampaignType < RequestCollection
+
+    def initialize(campaign_type:, resource:, base_url:, headers:)
+      @campaign_type = campaign_type
+      @base_url = "#{base_url}/v2/#{@campaign_type}/#{resource}"
+      @headers = headers
+    end
+  end
+end 

data/lib/blurb/snapshot_requests.rb

@@ -0,0 +1,36 @@
+require 'blurb/request_collection_with_campaign_type'
+
+class Blurb
+  class SnapshotRequests < RequestCollectionWithCampaignType
+    def initialize(campaign_type:, base_url:, headers:)
+      @campaign_type = campaign_type
+      @base_url = "#{base_url}/v2/#{@campaign_type}"
+      @headers = headers
+    end
+
+    def create(record_type, state_filter='enabled,paused')
+      execute_request(
+        api_path: "/#{record_type.to_s.camelize(:lower)}/snapshot",
+        request_type: :post,
+        payload: {state_filter: state_filter}
+      )
+    end
+
+    def retrieve(snapshot_id)
+      execute_request(
+        api_path: "/snapshots/#{snapshot_id}",
+        request_type: :get,
+      )
+    end
+
+    def download(snapshot_id)
+      download_url = retrieve(snapshot_id)[:location]
+      headers = @headers.dup["Content-Encoding"] = "gzip"
+      Request.new(
+        url: download_url,
+        request_type: :get,
+        headers: @headers
+      ).make_request
+    end
+  end
+end

data/lib/blurb/suggested_keyword_requests.rb

@@ -0,0 +1,61 @@
+require 'blurb/request'
+
+class Blurb
+  class SuggestedKeywordRequests
+    def initialize(base_url:, headers:)
+      @base_url = base_url
+      @headers = headers
+    end
+
+    def ad_group_retrieve(ad_group_id)
+      execute_request(
+        api_path: "/adGroups/#{ad_group_id}/suggested/keywords",
+        request_type: :get
+      )
+    end
+
+    def ad_group_retrieve_extended(ad_group_id)
+      execute_request(
+        api_path: "/adGroups/#{ad_group_id}/suggested/keywords/extended",
+        request_type: :get
+      )
+    end
+
+    def asin_retrieve(asin_value, max_num_suggestions=100)
+      url_params = {max_num_suggestions: max_num_suggestions}
+      execute_request(
+        api_path: "/asins/#{asin_value}/suggested/keywords",
+        request_type: :get,
+        url_params: url_params
+      )
+    end
+
+    def asin_list(asin_list, max_num_suggestions=100)
+      url_params = {max_num_suggestions: max_num_suggestions}
+      execute_request(
+        api_path: '/asins/suggested/keywords',
+        request_type: :post,
+        payload: {
+          asins: asin_list,
+          max_num_suggestions: max_num_suggestions
+        }
+      )
+    end
+
+    private
+
+    def execute_request(api_path: "", request_type:, payload: nil, url_params: nil)
+      url = "#{@base_url}#{api_path}"
+
+      request = Request.new(
+        url: url,
+        url_params: url_params,
+        request_type: request_type,
+        payload: payload,
+        headers: @headers
+      )
+
+      request.make_request
+    end
+  end
+end