blurb 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bb4aebb3a2bdb46403386ed36afbd74790fb441a
-  data.tar.gz: c4c9a3d19a8179cdaaea574cb0e8a4e20d7eefcc
+SHA256:
+  metadata.gz: 308f8f046233821f03d87749c7bbbc5bd99d440b471f526bfffc82e50e187d07
+  data.tar.gz: 8e5c1636d1a129af2c21daf33fb10d2397da31b9dafafd8abdf924495c1c6775
 SHA512:
-  metadata.gz: f5cbcd59aa71b3f3c94334c2a51fec760d7dfb328c12d7fbc9aaa0919bff768f4c33c6ac56e5e17e1edec7eb46d14b9e0210dddad68543369139b335d9fc2bc6
-  data.tar.gz: 8c732c2235b78f7cb8cd327002e2f74340f540b24e44f36eeacd608219bfd5033345a7241bd2635c0fa7be508097b993f03c340d6f0184d04878c3aa2efc5ce7
+  metadata.gz: 4e7350f33658327c5a11e81835de61b2e68a141e812d335fcddab777ea3c36f3ae90bb36756c14656233106e9514bf3742e0a32d9d5ac1d90a89ab946e4c7878
+  data.tar.gz: 82bda34380cb304a6422fea70f0af6e14832c71a4c8339407fd192064799725fce1344baae64b915211b28064f8ae89ee1afca7217320ccc443392848c716688

data/.circleci/config.yml

@@ -6,7 +6,7 @@ version: 2
 jobs:
   build:
     docker:
-       - image: circleci/ruby:2.4.4
+       - image: circleci/ruby:2.6.2
 
     steps:
       - checkout
@@ -21,6 +21,7 @@ jobs:
       - run:
           name: install dependencies
           command: |
+            gem install bundler -v 2.0.2
             bundle install --jobs=4 --retry=3 --path vendor/bundle
 
       - save_cache:

data/.gitignore

@@ -11,3 +11,4 @@
 # rspec failure tracking
 .rspec_status
 .env
+.byebug_history

data/.travis.yml

@@ -1,5 +1,5 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.4
-before_install: gem install bundler -v 1.14.6
+  - 2.6.2
+before_install: gem install bundler -v 2.0.2

data/README.md

@@ -83,50 +83,56 @@ You can find your profiles by making the following Blurb call.
 
 This will return a JSON payload of profile information for your account.  You can then select the profile ID you want to use.
 
-## Blurb Values Setup
-Before using the Blurb API wrapper you need to set your API values. Simply do that by initializing the Blurb values to your API values.
-If you are using Rails, see below.
 
-```ruby
-Blurb.profile_id = "<YOUR_PROFILE_ID>"
-Blurb.client_id = "<YOUR_CLIENT_ID>"
-Blurb.client_secret = "<YOUR_CLIENT_SECRET>"
-Blurb.refresh_token = "<YOUR_REFRESH_TOKEN>"
-```
+
+
 
 ## Rails Integration
 
-You can setup the Amazon API keys and tokens in an initializer script.
-Create a file called config/initializers/blurb.rb and setup the following values
+When creating a new resource object, you may pass in a hash containing your api keys and tokens.  Utilizing this approach allows you to dynamically toggle accounts and or regions with you application.
 
 ```ruby
-Blurb.profile_id = "<YOUR_PROFILE_ID>"
-Blurb.client_id = "<YOUR_CLIENT_ID>"
-Blurb.client_secret = "<YOUR_CLIENT_SECRET>"
-Blurb.refresh_token = "<YOUR_REFRESH_TOKEN>"
+authorization_hash =  {
+  client_id: 'my_client_id',
+  profile_id: 'my_profile_id',
+  client_secret: 'client_secret',
+  refresh_token: 'refresh_token',
+  region: 'my_region'
+}
+
+blurb_instance = Blurb::Keyword.new(authorization_hash)
 ```
 
-If you don't want to store your API values in your code which gets checked into a public repo, you can utilize ENV variables
+
+
+
+
+If you only plan on using Blurb for one api account and region you can setup the Amazon API keys and tokens in an initializer script.
+Create a file called config/initializers/blurb.rb and setup the following values
 
 ```ruby
 Blurb.profile_id = ENV["YOUR_PROFILE_ID_VAR"]
 Blurb.client_id = ENV["YOUR_CLIENT_ID_VAR"]
 Blurb.client_secret = ENV["YOUR_CLIENT_SECRET_VAR"]
 Blurb.refresh_token = ENV["YOUR_REFRESH_TOKEN_VAR"]
+Blurb.region = ENV["YOUR_REGION_VAR"]
 ```
 
-You could also store API values in a persistence store and initialize from there too.
-
-## API Environments
-
-By default Blurb will run API calls to the Amazon Advertising API production environment.
-If you are under development and want to test out the API to see what it can do, you can set
-the following Blurb property to use the API test environment.
+Now, you no longer need to pass in an authorization hash when initializing the resource object.
 
 ```ruby
-Blurb.test_env = true
+blurb_instance = Blurb::Keyword.new()
 ```
 
+### Valid Region Codes
+
+Region Code | Region | Notes
+--- | --- | ---
+TEST | Sandbox Environment | All marketplaces
+NA | North America | Covers US and CA marketplaces
+EU | Europe | Covers UK, FR, IT, ES, and DE marketplaces
+FE | Far East | Cover JP and AU marketplaces
+
 ## Usage
 
 All API calls have been setup as closely as possible to REST Resource calls.
@@ -138,19 +144,6 @@ For example, to use the keywords resource object:
 blurb_instance = Blurb::Keyword.new()
 ```
 
-Optionally, you may pass in a set of account credentials to override the default API keys and tokens
-
-```ruby
-authorization_hash =  {
-  client_id: 'my_client_id',
-  profile_id: 'my_profile_id',
-  client_secret: 'client_secret',
-  refresh_token: 'refresh_token'
-}
-
-blurb_instance = Blurb::Keyword.new(authorization_hash)
-```
-
 In calls that require 'campaign_type' as a parameter, you must pass in either 'sp' for sponsored products or 'hsa' for sponsored brands (formerly known as headline search ads).  
 
 NOTE: Not all API endpoints are currently supported by Blurb.  Over time we will get more
@@ -380,6 +373,15 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+In order to run the rspec test suite, you will need the following variables in a .env file:
+
+```
+PROFILE_ID
+CLIENT_ID
+CLIENT_SECRET
+REFRESH_TOKEN
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/iserve-products/blurb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/bin/console

@@ -5,6 +5,7 @@ require "blurb"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
+require 'dotenv/load'
 
 # (If you use this, don't forget to add pry to your Gemfile!)
 # require "pry"

data/blurb.gemspec

@@ -1,13 +1,12 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'blurb/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "blurb"
-  spec.version       = Blurb::VERSION
-  spec.authors       = ["dlbunker"]
-  spec.email         = ["dan@iserve.com"]
+  spec.version       = "0.4.0"
+  spec.authors       = ["dlbunker", "eamigo13"]
+  spec.email         = ["evan@pattern.com"]
 
   spec.summary       = %q{Ruby gem for the Amazon Advertising API}
   spec.description   = %q{Amazon released a new Advertising API in 2017. This gem will integrate and allow you to make API calls to Amazon.}
@@ -30,12 +29,16 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec_junit_formatter", "~> 0.3.0"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "faker", "~> 2.1.0"
 
   spec.add_runtime_dependency "rest-client", "~> 2.0"
   spec.add_runtime_dependency "oauth2", "~> 1.4.0"
+  spec.add_runtime_dependency "activesupport"
 
 end

data/lib/blurb.rb

@@ -1,32 +1,26 @@
-require "oauth2"
-require "rest-client"
+require "blurb/account"
+require "blurb/client"
 
-require "blurb/version"
-require "blurb/base_resource"
+class Blurb
+  attr_accessor :client, :account
 
-require "blurb/bid_recommendation"
-require "blurb/campaign"
-require "blurb/profile"
-require "blurb/report"
-require "blurb/snapshot"
-require "blurb/suggested_keyword"
-require "blurb/keyword"
-require "blurb/ad_group"
-
-module Blurb
-
-  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
-    }
+  def initialize(
+    # Default to env variables
+    client_id: ENV["BLURB_CLIENT_ID"],
+    client_secret: ENV["BLURB_CLIENT_SECRET"],
+    refresh_token: ENV["BLURB_REFRESH_TOKEN"],
+    region: ENV["BLURB_REGION"],
+    profile_id: ENV["BLURB_PROFILE_ID"] # profile_id can be left nil
+  )
+    @client = Client.new(client_id: client_id, client_secret: client_secret)
+    @account = Account.new(refresh_token: refresh_token, region: region, client: @client, profile_id: profile_id)
   end
 
-  class << self
-    attr_accessor :client_secret, :client_id, :refresh_token, :profile_id, :test_env, :eu_env
+  def profiles
+    @account.profiles
   end
 
+  def active_profile
+    @account.active_profile
+  end
 end

data/lib/blurb/account.rb

@@ -0,0 +1,108 @@
+require "oauth2"
+require "blurb/client"
+require "blurb/profile"
+
+class Blurb
+  class Account < BaseClass
+    attr_accessor :refresh_token, :api_url, :client, :profiles, :active_profile
+
+    API_URLS = {
+      "TEST" => "https://advertising-api-test.amazon.com",
+      "NA" => "https://advertising-api.amazon.com",
+      "EU" => "https://advertising-api-eu.amazon.com",
+      "FE" => "https://advertising-api-fe.amazon.com"
+    }
+
+    def initialize(refresh_token:, region:, client:, profile_id: nil)
+      @refresh_token = refresh_token
+      @api_url = API_URLS[region]
+      @client = client
+      @token_refreshed_at = Process.clock_gettime(Process::CLOCK_MONOTONIC) # current time
+      @authorization_token = retrieve_token
+      initialize_profiles(profile_id)
+    end
+
+    def initialize_profiles(profile_id=nil)
+      @profiles = []
+      if profile_id
+        @profiles << Profile.new(
+          profile_id: profile_id,
+          account: self
+        )
+      else
+        amazon_profiles = profile_list()
+        amazon_profiles.each do |p|
+          @profiles << Profile.new(
+            profile_id: p[:profile_id],
+            account: self
+          )
+        end
+      end
+      @active_profile = @profiles.first
+    end
+
+    def set_active_profile(profile_id)
+      @active_profile = get_profile(profile_id)
+    end
+
+    def get_profile(profile_id)
+      @profiles.find{ |p| p.profile_id == profile_id }
+    end
+
+    def profile_list
+      profile_request("/v2/profiles")
+    end
+
+    def retrieve_profile(profile_id)
+      profile_request("/v2/profiles/#{profile_id}")
+    end
+
+    def retrieve_token
+      current_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      elapsed_time = current_time - @token_refreshed_at
+
+      # refresh the token if it's been over an hour
+      if @authorization_token.nil? || elapsed_time >= 3600 # 1 hour #Look at using amazons expires_inblurb/
+        response = authorization_client.request(:post, "/auth/o2/token",
+          {
+            body: {
+              grant_type: "refresh_token",
+              client_id: @client.client_id,
+              refresh_token: @refresh_token,
+              client_secret: @client.client_secret
+            }
+          }
+        )
+
+        @authorization_token = JSON.parse(response.body)['access_token']
+        @token_refreshed_at = current_time
+      end
+
+      return @authorization_token
+    end
+
+    private
+
+      def profile_request(api_path)
+        request = Request.new(
+          url: "#{@api_url}#{api_path}",
+          request_type: :get,
+          headers: {
+            "Authorization" => "Bearer #{retrieve_token()}",
+            "Content-Type" => "application/json",
+            "Amazon-Advertising-API-ClientId" => @client.client_id
+          }
+        )
+
+        request.make_request
+      end
+
+      def authorization_client
+        return OAuth2::Client.new(
+          "",
+          "",
+          :site => "https://api.amazon.com"
+        )
+      end
+  end
+end

data/lib/blurb/base_class.rb

@@ -0,0 +1,8 @@
+class Blurb
+  class BaseClass
+    CAMPAIGN_TYPE_CODES = {
+      sp: 'sp',
+      sb: 'hsa'
+    }.freeze
+  end
+end 

data/lib/blurb/campaign_requests.rb

@@ -0,0 +1,23 @@
+require 'blurb/request_collection_with_campaign_type'
+
+class Blurb
+  class CampaignRequests < RequestCollectionWithCampaignType
+    def create_bulk(create_array)
+      create_array = map_campaign_payload(create_array)
+      super(create_array)
+    end
+
+    def update_bulk(update_array)
+      update_array = map_campaign_payload(update_array)
+      super(update_array)
+    end
+
+    private
+
+      def map_campaign_payload(payload)
+        campaign_type_string = "sponsoredProducts" if @campaign_type == CAMPAIGN_TYPE_CODES[:sp]
+        campaign_type_string = "sponsoredBrands" if @campaign_type == CAMPAIGN_TYPE_CODES[:sb]
+        payload.each{ |p| p[:campaign_type] = campaign_type_string }
+      end
+  end
+end

data/lib/blurb/client.rb

@@ -0,0 +1,12 @@
+require "blurb/base_class"
+
+class Blurb
+  class Client < BaseClass
+    attr_accessor :client_id, :client_secret
+
+    def initialize(client_id:, client_secret:)
+      @client_id = client_id
+      @client_secret = client_secret
+    end
+  end
+end

data/lib/blurb/profile.rb

@@ -1,12 +1,146 @@
-module Blurb
-  class Profile < BaseResource
+require "blurb/account"
+require "blurb/campaign_requests"
+require "blurb/snapshot_requests"
+require "blurb/report_requests"
+require "blurb/request_collection"
+require "blurb/request_collection_with_campaign_type"
+require "blurb/suggested_keyword_requests"
 
-    def list()
-      profile_request("/v2/profiles")
+class Blurb
+  class Profile < BaseClass
+
+    attr_accessor(
+      :account,
+      :ad_groups,
+      :campaign_negative_keywords,
+      :portfolios,
+      :product_ads,
+      :profile_id,
+      :suggested_keywords,
+    )
+
+    def initialize(profile_id:, account:)
+      @profile_id = profile_id
+      @account = account
+
+      @sp_campaigns = CampaignRequests.new(
+        headers: headers_hash,
+        base_url: @account.api_url,
+        resource: "campaigns",
+        campaign_type: CAMPAIGN_TYPE_CODES[:sp]
+      )
+      @sb_campaigns = CampaignRequests.new(
+        headers: headers_hash,
+        base_url: @account.api_url,
+        resource: "campaigns",
+        campaign_type: CAMPAIGN_TYPE_CODES[:sb]
+      )
+      @sp_keywords = RequestCollectionWithCampaignType.new(
+        headers: headers_hash,
+        base_url: @account.api_url,
+        resource: "keywords",
+        campaign_type: CAMPAIGN_TYPE_CODES[:sp]
+      )
+      @sb_keywords = RequestCollectionWithCampaignType.new(
+        headers: headers_hash,
+        base_url: @account.api_url,
+        resource: "keywords",
+        campaign_type: CAMPAIGN_TYPE_CODES[:sb]
+      )
+      @sp_snapshots = SnapshotRequests.new(
+        headers: headers_hash,
+        base_url: @account.api_url,
+        campaign_type: CAMPAIGN_TYPE_CODES[:sp]
+      )
+      @sb_snapshots = SnapshotRequests.new(
+        headers: headers_hash,
+        base_url: @account.api_url,
+        campaign_type: CAMPAIGN_TYPE_CODES[:sb]
+      )
+      @sp_reports = ReportRequests.new(
+        headers: headers_hash,
+        base_url: @account.api_url,
+        campaign_type: CAMPAIGN_TYPE_CODES[:sp]
+      )
+      @sb_reports = ReportRequests.new(
+        headers: headers_hash,
+        base_url: @account.api_url,
+        campaign_type: CAMPAIGN_TYPE_CODES[:sb]
+      )
+      @ad_groups = RequestCollection.new(
+        headers: headers_hash,
+        base_url: "#{@account.api_url}/v2/sp/adGroups"
+      )
+      @product_ads = RequestCollection.new(
+        headers: headers_hash,
+        base_url: "#{account.api_url}/v2/sp/productAds"
+      )
+      @sp_negative_keywords = RequestCollectionWithCampaignType.new(
+        headers: headers_hash,
+        base_url: @account.api_url,
+        resource: 'negativeKeywords',
+        campaign_type: CAMPAIGN_TYPE_CODES[:sp]
+      )
+      @sb_negative_keywords = RequestCollectionWithCampaignType.new(
+        headers: headers_hash,
+        base_url: @account.api_url,
+        resource: 'negativeKeywords',
+        campaign_type: CAMPAIGN_TYPE_CODES[:sb]
+      )
+      @campaign_negative_keywords = RequestCollection.new(
+        headers: headers_hash,
+        base_url: "#{@account.api_url}/v2/sp/campaignNegativeKeywords"
+      )
+      @portfolios = RequestCollection.new(
+        headers: headers_hash,
+        base_url: "#{@account.api_url}/v2/portfolios"
+      )
+      @suggested_keywords = SuggestedKeywordRequests.new(
+        headers: headers_hash,
+        base_url: "#{@account.api_url}/v2/sp"
+      )
+    end
+
+    def campaigns(campaign_type)
+      return @sp_campaigns if campaign_type == :sp
+      return @sb_campaigns if campaign_type == :sb || campaign_type == :hsa
+    end
+
+    def keywords(campaign_type)
+      return @sp_keywords if campaign_type == :sp
+      return @sb_keywords if campaign_type == :sb || campaign_type == :hsa
+    end
+
+    def negative_keywords(campaign_type)
+      return @sp_negative_keywords if campaign_type == :sp
+      return @sb_negative_keywords if campaign_type == :sb || campaign_type == :hsa
     end
 
-    def retrieve(profile_id)
-      profile_request("/v2/profiles/#{profile_id}")
+    def snapshots(campaign_type)
+      return @sp_snapshots if campaign_type == :sp
+      return @sb_snapshots if campaign_type == :sb || campaign_type == :hsa
+    end
+
+    def reports(campaign_type)
+      return @sp_reports if campaign_type == :sp
+      return @sb_reports if campaign_type == :sb || campaign_type == :hsa
+    end
+
+    def profile_details
+      @account.retrieve_profile(@profile_id)
+    end
+
+    def headers_hash(opts = {})
+      headers_hash = {
+        "Authorization" => "Bearer #{@account.retrieve_token()}",
+        "Content-Type" => "application/json",
+        "Amazon-Advertising-API-Scope" => @profile_id,
+        "Amazon-Advertising-API-ClientId" => @account.client.client_id
+      }
+
+      headers_hash["Content-Encoding"] = "gzip" if opts[:gzip]
+
+      return headers_hash
     end
   end
 end