blurb 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 040ae071f23800ce24f8c7fe8602d690b6c97983
-  data.tar.gz: f2b702bd101e5a4f9343ceba783e801cefe07599
+  metadata.gz: f418adffdec8cb6dad94905f36907bbb783afc52
+  data.tar.gz: 275ea7f93bc0ca704db76c4476c10cd4ecc1ea8a
 SHA512:
-  metadata.gz: b1e46b85afb82c8351b7cd30880e4bd923dd56e18cad37772a352fb85712493591f3192b07fd1428de7d86b945745fe000680edbe57b647f2587b497416980dd
-  data.tar.gz: b6d4fa9ec4ef124eca1e6ed9038f028e5c0cf9dd223a93188dcba1f90852c2649ae5193d5742e30714327b12e24fb2440d42826bbecc43666c0e87486cf28128
+  metadata.gz: 5bb60ed1768e2c2bb618518741768fd31759b9a10cae29210ab7ab3c1a5f7ee9d8d05f0059f8d3cd139653b2f6789d8fcaade68fbc0d96f4e4a81a043c2b59b8
+  data.tar.gz: be5d2d3a75f03c76493b1ff560f5041a87fc3bb402566d5fa63d96ec9e5e7a4749354d34fbc145ed595abf7c3ab87fc3683aa63306da2f2bbb26cb2405ab20d3

data/lib/blurb.rb

@@ -10,33 +10,17 @@ require "blurb/profile"
 require "blurb/report"
 require "blurb/snapshot"
 require "blurb/suggested_keyword"
-require "blurb/token"
 
 module Blurb
-  TOKEN_URL = "https://api.amazon.com"
-  API_URL = "https://advertising-api.amazon.com"
-  TEST_API_URL = "https://advertising-api-test.amazon.com"
-  EU_API_URL = "https://advertising-api-eu.amazon.com"
 
-  def self.client
-    return OAuth2::Client.new(
-      "",
-      "",
-      :site => TOKEN_URL
-    )
-  end
-
-  # By default this gem will use the production API url unless the test_env module
-  # variable is set to true. Then the test API url will be used
-  def self.active_api_url
-    if test_env
-      return TEST_API_URL
-    end
-    if eu_env
-      return EU_API_URL
-    end
-
-    return API_URL
+  def self.default_account
+    {
+      client_secret: self.client_secret,
+      client_id: self.client_id,
+      refresh_token: self.refresh_token,
+      profile_id: self.profile_id,
+      eu_env: self.eu_env
+    }
   end
 
   class << self

data/lib/blurb/base_resource.rb

@@ -1,15 +1,80 @@
 module Blurb
   class BaseResource
-    def self.profile_request(api_path)
-      access_token = Blurb::Token.retrieve()
+    attr_accessor :client_secret, :client_id, :refresh_token, :profile_id, :test_env, :eu_env
+
+    TOKEN_URL = "https://api.amazon.com"
+    API_URL = "https://advertising-api.amazon.com"
+    TEST_API_URL = "https://advertising-api-test.amazon.com"
+    EU_API_URL = "https://advertising-api-eu.amazon.com"
+
+    def initialize(account=Blurb.default_account)
+      @client_secret = account[:client_secret]
+      @client_id = account[:client_id]
+      @refresh_token = account[:refresh_token]
+      @profile_id = account[:profile_id]
+      @test_env = Blurb.test_env
+      @eu_env = account[:eu_env]
+    end
+
+    def active_api_url
+      if @test_env
+        return TEST_API_URL
+      end
+      if @eu_env
+        return EU_API_URL
+      end
+
+      return API_URL
+    end
+
+    def client
+      return OAuth2::Client.new(
+        "",
+        "",
+        :site => TOKEN_URL
+      )
+    end
+
+    def token_code(auth_code)
+      response = client.request(:post, "/auth/o2/token",
+        {
+          body: {
+            grant_type: "authorization_code",
+            client_id: @client_id,
+            code: auth_code,
+            client_secret: @client_secret
+          }
+        }
+      )
+
+      return JSON.parse(response.body)
+    end
+
+    def retrieve_token(params = {}, opts = {})
+      response = client.request(:post, "/auth/o2/token",
+        {
+          body: {
+            grant_type: "refresh_token",
+            client_id: @client_id,
+            refresh_token: @refresh_token,
+            client_secret: @client_secret
+          }
+        }
+      )
+
+      return JSON.parse(response.body)
+    end
+
+    def profile_request(api_path)
+      access_token = retrieve_token()
 
       request_config = {
           method: :get,
-          url: "#{Blurb.active_api_url}#{api_path}",
+          url: "#{active_api_url}#{api_path}",
           headers: {
             "Authorization" => "Bearer #{access_token['access_token']}",
             "Content-Type" => "application/json",
-            "Amazon-Advertising-API-ClientId" => Blurb.client_id
+            "Amazon-Advertising-API-ClientId" => @client_id
           }
         }
 
@@ -17,17 +82,17 @@ module Blurb
       return JSON.parse(resp)
     end
 
-    def self.get_request(api_path, opts = {})
-      access_token = Blurb::Token.retrieve()
+    def get_request(api_path, opts = {})
+      access_token = retrieve_token()
 
-      url = "#{Blurb.active_api_url}#{api_path}"
+      url = "#{active_api_url}#{api_path}"
       url = api_path if opts[:full_path]
 
       headers_hash = {
         "Authorization" => "Bearer #{access_token['access_token']}",
         "Content-Type" => "application/json",
-        "Amazon-Advertising-API-Scope" => Blurb.profile_id,
-        "Amazon-Advertising-API-ClientId" => Blurb.client_id
+        "Amazon-Advertising-API-Scope" => @profile_id,
+        "Amazon-Advertising-API-ClientId" => @client_id
       }
 
       headers_hash["Content-Encoding"] = "gzip" if opts[:gzip]
@@ -43,37 +108,37 @@ module Blurb
       return make_request(request_config)
     end
 
-    def self.post_request(api_path, payload)
-      access_token = Blurb::Token.retrieve()
+    def post_request(api_path, payload)
+      access_token = retrieve_token()
 
       request_config = {
           method: :post,
-          url: "#{Blurb.active_api_url}#{api_path}",
+          url: "#{active_api_url}#{api_path}",
           payload: payload.to_json,
           headers: {
             "Authorization" => "Bearer #{access_token['access_token']}",
             "Content-Type" => "application/json",
-            "Amazon-Advertising-API-Scope" => Blurb.profile_id.to_i,
-            "Amazon-Advertising-API-ClientId" => Blurb.client_id
+            "Amazon-Advertising-API-Scope" => @profile_id.to_i,
+            "Amazon-Advertising-API-ClientId" => @client_id
           }
         }
 
       return make_request(request_config)
     end
 
-    def self.delete_request(api_path)
-      access_token = Blurb::Token.retrieve()
+    def delete_request(api_path)
+      access_token = retrieve_token()
 
       headers_hash = {
         "Authorization" => "Bearer #{access_token['access_token']}",
         "Content-Type" => "application/json",
-        "Amazon-Advertising-API-Scope" => Blurb.profile_id,
-        "Amazon-Advertising-API-ClientId" => Blurb.client_id
+        "Amazon-Advertising-API-Scope" => @profile_id,
+        "Amazon-Advertising-API-ClientId" => @client_id
       }
 
       request_config = {
           method: :delete,
-          url: "#{Blurb.active_api_url}#{api_path}",
+          url: "#{active_api_url}#{api_path}",
           headers: headers_hash,
         }
 
@@ -82,7 +147,7 @@ module Blurb
 
     private
 
-    def self.make_request(request_config)
+    def make_request(request_config)
       begin
         resp = RestClient::Request.execute(request_config)
       rescue RestClient::ExceptionWithResponse => err

data/lib/blurb/bid_recommendation.rb

@@ -1,20 +1,20 @@
 module Blurb
   class BidRecommendation < BaseResource
-    def self.ad_group_recommendations(params = {}, opts = {})
+    def ad_group_recommendations(params = {}, opts = {})
       # required argument checks
       raise ArgumentError.new("params hash must contain an adGroupId") unless params["adGroupId"]
 
       get_request("/v2/adGroups/#{params["adGroupId"]}/bidRecommendations")
     end
 
-    def self.keyword_recommendations(params = {}, opts = {})
+    def keyword_recommendations(params = {}, opts = {})
       # required argument checks
       raise ArgumentError.new("params hash must contain an keywordId") unless params["keywordId"]
 
       get_request("/v2/keywords/#{params["keywordId"]}/bidRecommendations")
     end
 
-    def self.bulk_keyword_recommendations(params = {}, opts = {})
+    def bulk_keyword_recommendations(params = {}, opts = {})
       # required argument checks
       raise ArgumentError.new("params hash must contain an array of keywordIds") unless params["keywordIds"]
 

data/lib/blurb/campaign.rb

@@ -3,25 +3,25 @@ module Blurb
     SPONSORED_PRODUCTS = "sp"
     SPONSORED_BRANDS = "hsa"
 
-    def self.retrieve(campaign_id, campaign_type)
+    def retrieve(campaign_id, campaign_type)
       get_request("/v2/#{campaign_type}/campaigns/#{campaign_id}")
     end
 
-    def self.retrieve_extended(campaign_id, campaign_type)
+    def retrieve_extended(campaign_id, campaign_type)
       raise ArgumentError.new("Extended campaigns interface is only supported for Sponsored Products") unless campaign_type == SPONSORED_PRODUCTS
       get_request("/v2/#{campaign_type}/campaigns/extended/#{campaign_id}")
     end
 
-    def self.list(campaign_type, params = {}, opts = {})
+    def list(campaign_type, params = {}, opts = {})
       get_request("/v2/#{campaign_type}/campaigns?#{setup_url_params(params)}")
     end
 
-    def self.list_extended(campaign_type, params = {}, opts = {})
+    def list_extended(campaign_type, params = {}, opts = {})
       raise ArgumentError.new("Extended campaigns interface is only supported for Sponsored Products") unless campaign_type == SPONSORED_PRODUCTS
       get_request("/v2/#{campaign_type}/campaigns/extended?#{setup_url_params(params)}")
     end
 
-    def self.create(campaign_type, params = {}, opts = {})
+    def create(campaign_type, params = {}, opts = {})
       # required argument checks
       if !params["name"] && !params["targetingType"] && !params["state"] && !params["dailyBudget"] && !params["startDate"]
         raise ArgumentError.new("params hash must contain name, targetingType, state, dailyBudget and startDate")
@@ -31,13 +31,13 @@ module Blurb
       post_request("/v2/#{campaign_type}/campaigns", [params])
     end
 
-    def self.delete(campaign_id)
+    def delete(campaign_id)
       delete_request("/v2/campaigns/#{campaign_id}")
     end
 
     private
 
-    def self.setup_url_params(params)
+    def setup_url_params(params)
       url_params = ""
       url_params = "startIndex=#{params['startIndex']}" if params['startIndex']
 

data/lib/blurb/profile.rb

@@ -1,11 +1,11 @@
 module Blurb
   class Profile < BaseResource
 
-    def self.list()
+    def list()
       profile_request("/v2/profiles")
     end
 
-    def self.retrieve(profile_id)
+    def retrieve(profile_id)
       profile_request("/v2/profiles/#{profile_id}")
     end
   end

data/lib/blurb/report.rb

@@ -9,7 +9,7 @@ module Blurb
     SPONSORED_PRODUCTS = "sp"
     SPONSORED_BRANDS = "hsa"
 
-    def self.create(params = {}, opts = {})
+    def create(params = {}, opts = {})
       # required argument checks
       raise ArgumentError.new("params hash must contain a recordType") unless params["recordType"]
 
@@ -34,18 +34,16 @@ module Blurb
       post_request(request_url, api_params)
     end
 
-    def self.status(report_id, opts = {})
+    def status(report_id, opts = {})
       get_request("/v2/reports/#{report_id}")
     end
 
-    def self.download(location, opts = {})
+    def download(location, opts = {})
       opts.merge!({:full_path => true, :gzip => true, :no_token => true})
       get_request(location, opts)
     end
 
-    private
-
-    def self.get_default_metrics(record_type, campaign_type)
+    def get_default_metrics(record_type, campaign_type)
       if campaign_type == SPONSORED_BRANDS
         return [
           "campaignName",
@@ -118,7 +116,6 @@ module Blurb
           "attributedSales30dOtherSKU"
         ].join(",") if record_type == ASINS
         return [
-          "bidPlus",
           "campaignName",
           "campaignId",
           "campaignStatus",

data/lib/blurb/snapshot.rb

@@ -10,7 +10,7 @@ module Blurb
     SPONSORED_PRODUCTS = "sp"
     SPONSORED_BRANDS = "hsa"
 
-    def self.create(params = {}, opts = {})
+    def create(params = {}, opts = {})
       # required argument checks
       raise ArgumentError.new("params hash must contain a recordType") unless params["recordType"]
 
@@ -25,11 +25,11 @@ module Blurb
       })
     end
 
-    def self.status(snapshot_id, opts = {})
+    def status(snapshot_id, opts = {})
       get_request("/v2/snapshots/#{snapshot_id}")
     end
 
-    def self.download(location, opts = {})
+    def download(location, opts = {})
       opts.merge!({:full_path => true, :gzip => true, :no_token => true})
       get_request(location, opts)
     end

data/lib/blurb/suggested_keyword.rb

@@ -1,27 +1,27 @@
 module Blurb
   class SuggestedKeyword < BaseResource
-    def self.ad_group_suggestions(params = {}, opts = {})
+    def ad_group_suggestions(params = {}, opts = {})
       # required argument checks
       raise ArgumentError.new("params hash must contain an adGroupId") unless params["adGroupId"]
 
       get_request("/v2/adGroups/#{params["adGroupId"]}/suggested/keywords?#{setup_url_params(params)}")
     end
 
-    def self.ad_group_extended_suggestions(params = {}, opts = {})
+    def ad_group_extended_suggestions(params = {}, opts = {})
       # required argument checks
       raise ArgumentError.new("params hash must contain an adGroupId") unless params["adGroupId"]
 
       get_request("/v2/adGroups/#{params["adGroupId"]}/suggested/keywords/extended?#{setup_url_params(params)}")
     end
 
-    def self.asin_suggestions(params = {}, opts = {})
+    def asin_suggestions(params = {}, opts = {})
       # required argument checks
       raise ArgumentError.new("params hash must contain an asinValue") unless params["asinValue"]
 
       get_request("/v2/asins/#{params["asinValue"]}/suggested/keywords?#{setup_url_params(params)}")
     end
 
-    def self.bulk_asin_suggestions(params = {}, opts = {})
+    def bulk_asin_suggestions(params = {}, opts = {})
       # required argument checks
       raise ArgumentError.new("params hash must contain an asins array") unless params["asins"]
 
@@ -36,7 +36,7 @@ module Blurb
 
     private
 
-    def self.setup_url_params(params)
+    def setup_url_params(params)
       url_params = ""
       url_params = "maxNumSuggestions=#{params['maxNumSuggestions']}" if params['maxNumSuggestions']
 

data/lib/blurb/version.rb

@@ -1,3 +1,3 @@
 module Blurb
-  VERSION = "0.2.3".freeze
+  VERSION = "0.3.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blurb
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - dlbunker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-18 00:00:00.000000000 Z
+date: 2019-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,7 +122,6 @@ files:
 - lib/blurb/report.rb
 - lib/blurb/snapshot.rb
 - lib/blurb/suggested_keyword.rb
-- lib/blurb/token.rb
 - lib/blurb/version.rb
 homepage: https://github.com/iserve-products/blurb
 licenses:

data/lib/blurb/token.rb

@@ -1,34 +0,0 @@
-module Blurb
-  class Token
-
-    def self.code(auth_code)
-      response = Blurb::client.request(:post, "/auth/o2/token",
-        {
-          body: {
-            grant_type: "authorization_code",
-            client_id: Blurb.client_id,
-            code: auth_code,
-            client_secret: Blurb.client_secret
-          }
-        }
-      )
-
-      return JSON.parse(response.body)
-    end
-
-    def self.retrieve(params = {}, opts = {})
-      response = Blurb::client.request(:post, "/auth/o2/token",
-        {
-          body: {
-            grant_type: "refresh_token",
-            client_id: Blurb.client_id,
-            refresh_token: Blurb.refresh_token,
-            client_secret: Blurb.client_secret
-          }
-        }
-      )
-
-      return JSON.parse(response.body)
-    end
-  end
-end