blurb 0.3.2 → 0.4.0

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: blurb
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - dlbunker
+- eamigo13
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-01 00:00:00.000000000 Z
+date: 2019-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +67,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -94,10 +137,24 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
 description: Amazon released a new Advertising API in 2017. This gem will integrate
   and allow you to make API calls to Amazon.
 email:
-- dan@iserve.com
+- evan@pattern.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -115,16 +172,17 @@ files:
 - bin/setup
 - blurb.gemspec
 - lib/blurb.rb
-- lib/blurb/ad_group.rb
-- lib/blurb/base_resource.rb
-- lib/blurb/bid_recommendation.rb
-- lib/blurb/campaign.rb
-- lib/blurb/keyword.rb
+- lib/blurb/account.rb
+- lib/blurb/base_class.rb
+- lib/blurb/campaign_requests.rb
+- lib/blurb/client.rb
 - lib/blurb/profile.rb
-- lib/blurb/report.rb
-- lib/blurb/snapshot.rb
-- lib/blurb/suggested_keyword.rb
-- lib/blurb/version.rb
+- lib/blurb/report_requests.rb
+- lib/blurb/request.rb
+- lib/blurb/request_collection.rb
+- lib/blurb/request_collection_with_campaign_type.rb
+- lib/blurb/snapshot_requests.rb
+- lib/blurb/suggested_keyword_requests.rb
 homepage: https://github.com/iserve-products/blurb
 licenses:
 - MIT
@@ -144,8 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby gem for the Amazon Advertising API

data/lib/blurb/ad_group.rb

@@ -1,40 +0,0 @@
-module Blurb
-  class AdGroup < BaseResource
-
-    URL_PARAMS = ['startIndex', 'campaignType', 'count', 'matchTypeFilter', 'name', 'state', 'campaignIdFilter', 'adGroupIdFilter']
-
-    def retrieve(keyword_id, campaign_type)
-      raise ArgumentError.new("adGroups interface is only supported for Sponsored Products") unless campaign_type == SPONSORED_PRODUCTS
-      get_request("/v2/#{campaign_type}/adGroups/#{keyword_id}")
-    end
-
-    def retrieve_extended(keyword_id, campaign_type)
-      raise ArgumentError.new("adGroups interface is only supported for Sponsored Products") unless campaign_type == SPONSORED_PRODUCTS
-      get_request("/v2/#{campaign_type}/adGroups/extended/#{keyword_id}")
-    end
-
-    def list(campaign_type, params = {}, opts = {})
-      raise ArgumentError.new("adGroups interface is only supported for Sponsored Products") unless campaign_type == SPONSORED_PRODUCTS
-      get_request("/v2/#{campaign_type}/adGroups?#{setup_url_params(params, URL_PARAMS)}")
-    end
-
-    def list_extended(campaign_type, params = {}, opts = {})
-      raise ArgumentError.new("adGroups interface is only supported for Sponsored Products") unless campaign_type == SPONSORED_PRODUCTS
-      get_request("/v2/#{campaign_type}/adGroups/extended?#{setup_url_params(params, URL_PARAMS)}")
-    end
-
-    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")
-      end
-      raise ArgumentError.new("Only sponsored product adGroups can be created through the api.  Sponsored Brands adGroups must be created through the user interface") unless campaign_type == SPONSORED_PRODUCTS
-
-      post_request("/v2/#{campaign_type}/adGroups", [params])
-    end
-
-    def delete(keyword_id)
-      delete_request("/v2/adGroups/#{keyword_id}")
-    end
-  end
-end

data/lib/blurb/base_resource.rb

@@ -1,172 +0,0 @@
-module Blurb
-  class BaseResource
-    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"
-
-    SPONSORED_PRODUCTS = "sp"
-    SPONSORED_BRANDS = "hsa"
-
-    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: "#{active_api_url}#{api_path}",
-          headers: {
-            "Authorization" => "Bearer #{access_token['access_token']}",
-            "Content-Type" => "application/json",
-            "Amazon-Advertising-API-ClientId" => @client_id
-          }
-        }
-
-      resp = RestClient::Request.execute(request_config)
-      return JSON.parse(resp)
-    end
-
-    def get_request(api_path, opts = {})
-      url = "#{active_api_url}#{api_path}"
-      url = api_path if opts[:full_path]
-
-      request_config = {
-          method: :get,
-          url: url,
-          headers: headers_hash(opts),
-          max_redirects: 0
-        }
-
-      return make_request(request_config)
-    end
-
-    def post_request(api_path, payload)
-      request_config = {
-          method: :post,
-          url: "#{active_api_url}#{api_path}",
-          payload: payload.to_json,
-          headers: headers_hash
-        }
-
-      return make_request(request_config)
-    end
-
-    def put_request(api_path, payload)
-      request_config = {
-          method: :put,
-          url: "#{active_api_url}#{api_path}",
-          payload: payload.to_json,
-          headers: headers_hash
-        }
-
-      return make_request(request_config)
-    end
-
-    def delete_request(api_path)
-      request_config = {
-          method: :delete,
-          url: "#{active_api_url}#{api_path}",
-          headers: headers_hash,
-        }
-
-      return make_request(request_config)
-    end
-
-    private
-
-    def make_request(request_config)
-      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 err.response.body
-        end
-      end
-
-      response = JSON.parse(resp) if resp
-      return response
-    end
-
-    def headers_hash(opts = {})
-      access_token = retrieve_token()
-
-      headers_hash = {
-        "Authorization" => "Bearer #{access_token['access_token']}",
-        "Content-Type" => "application/json",
-        "Amazon-Advertising-API-Scope" => @profile_id,
-        "Amazon-Advertising-API-ClientId" => @client_id
-      }
-
-      headers_hash["Content-Encoding"] = "gzip" if opts[:gzip]
-
-      return headers_hash
-    end
-
-    def setup_url_params(params, whitelist)
-      whitelisted_params = params.select { |k,v| whitelist.include?(k) }
-      return URI.encode_www_form(whitelisted_params)
-    end
-  end
-end

data/lib/blurb/bid_recommendation.rb

@@ -1,24 +0,0 @@
-module Blurb
-  class BidRecommendation < BaseResource
-    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 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 bulk_keyword_recommendations(params = {}, opts = {})
-      # required argument checks
-      raise ArgumentError.new("params hash must contain an array of keywordIds") unless params["keywordIds"]
-
-      post_request("/v2/keywords/bidRecommendations", params["keywordIds"])
-    end
-  end
-end

data/lib/blurb/campaign.rb

@@ -1,38 +0,0 @@
-module Blurb
-  class Campaign < BaseResource
-
-    URL_PARAMS = ['count', 'stateFilter', 'startIndex', 'name', 'campaignIdFilter']
-
-    def retrieve(campaign_id, campaign_type)
-      get_request("/v2/#{campaign_type}/campaigns/#{campaign_id}")
-    end
-
-    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 list(campaign_type, params = {}, opts = {})
-      get_request("/v2/#{campaign_type}/campaigns?#{setup_url_params(params, URL_PARAMS)}")
-    end
-
-    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, URL_PARAMS)}")
-    end
-
-    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")
-      end
-      raise ArgumentError.new("Only sponsored product campaigns can be created through the api.  Sponsored Brands campaigns must be created through the user interface") unless campaign_type == SPONSORED_PRODUCTS
-
-      post_request("/v2/#{campaign_type}/campaigns", [params])
-    end
-
-    def delete(campaign_id)
-      delete_request("/v2/campaigns/#{campaign_id}")
-    end
-  end
-end

data/lib/blurb/keyword.rb

@@ -1,51 +0,0 @@
-module Blurb
-  class Keyword < BaseResource
-    URL_PARAMS = ['startIndex', 'count', 'matchTypeFilter', 'keywordText', 'state', 'campaignIdFilter', 'adGroupIdFilter']
-
-    def retrieve(keyword_id, campaign_type)
-      get_request("/v2/#{campaign_type}/keywords/#{keyword_id}")
-    end
-
-    def retrieve_extended(keyword_id, campaign_type)
-      raise ArgumentError.new("Extended keywords interface is only supported for Sponsored Products") unless campaign_type == SPONSORED_PRODUCTS
-      get_request("/v2/#{campaign_type}/keywords/extended/#{keyword_id}")
-    end
-
-    def list(campaign_type, params = {}, opts = {})
-      get_request("/v2/#{campaign_type}/keywords?#{setup_url_params(params, URL_PARAMS)}")
-    end
-
-    def list_extended(campaign_type, params = {}, opts = {})
-      raise ArgumentError.new("Extended keywords interface is only supported for Sponsored Products") unless campaign_type == SPONSORED_PRODUCTS
-      get_request("/v2/#{campaign_type}/keywords/extended?#{setup_url_params(params, URL_PARAMS)}")
-    end
-
-    def update(campaign_type, payload, opts = {})
-      raise ArgumentError.new("Extended keywords interface is only supported for Sponsored Products") unless campaign_type == SPONSORED_PRODUCTS
-      payload = [payload] unless payload.class == Array
-
-      # The Amazon Advertising API only accepts bulk changes of up to 1000 keywords
-      results = []
-      payloads = payload.each_slice(1000).to_a
-      payloads.each do |p|
-        results << put_request("/v2/#{campaign_type}/keywords", p)
-      end
-
-      return results.flatten
-    end
-
-    def create(campaign_type, params = {}, opts = {})
-      # required argument checks
-      if !params["campaignId"] && !params["adGroupId"] && !params["keywordText"] && !params["matchType"] && !params["state"]
-        raise ArgumentError.new("params hash must contain campaignId, adGroupId, keywordText, matchType and state")
-      end
-      raise ArgumentError.new("Only sponsored product keywords can be created through the api.  Sponsored Brands keywords must be created through the user interface") unless campaign_type == SPONSORED_PRODUCTS
-
-      post_request("/v2/#{campaign_type}/keywords", [params])
-    end
-
-    def delete(keyword_id)
-      delete_request("/v2/keywords/#{keyword_id}")
-    end
-  end
-end