blurb 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 928e005a12bfa4aa4ed10d4f0a2cf15ef22e8153
+  data.tar.gz: 45e8e3dff5107ade531d12940c2dcb814860dc4a
+SHA512:
+  metadata.gz: 4c1298fed2c2ae82d9e1a1b237c442402426ec7b025c14972163b005bd518bd2e7cff14d856ce5639345aee8a243864d73d26abbc5681f16d9251214036f3874
+  data.tar.gz: 0db358d2dbd433cc970ab77d060b6b3164ac9557e955c5c4d8d5ef24991a5f2c25e7630a51c4f7b8243057b8bda349c3c298fc6dc3a883c6485768b529c0908a

data/.circleci/config.yml

@@ -0,0 +1,55 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.3-node-browsers
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+
+            bundle exec rspec --format progress \
+                            --format RspecJunitFormatter \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 1.9.3
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dan@iserve.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in blurb.gemspec
+gemspec
+
+ruby '2.3.5'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 dlbunker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,217 @@
+# Blurb
+
+[![CircleCI](https://circleci.com/gh/iserve-products/blurb.svg?style=shield)](https://circleci.com/gh/iserve-products/blurb)
+
+Blurb is an API wrapper (written in Ruby and packaged as a Gem) for the Amazon Advertising API. The Amazon Ad API lets you tie in programmatically to
+Amazon's Advertising Service. More info can be found at [Amazon Advertising](https://services.amazon.com/advertising/overview.htm?ld=NSGoogleAS)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'blurb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blurb
+
+## API Credentials
+
+Getting setup to make calls to the Amazon Advertising API can unfortunately be a tedious process.
+You will need to apply for and have a valid Amazon Advertising Account. You can find that info
+here: [Amazon Advertising](https://services.amazon.com/advertising/overview.htm?ld=NSGoogleAS)
+
+You may also want to get a copy of the advertising docs and getting started guides which can be found here:
+
+1. [Amazon Advertising API Getting Started Guide.pdf](https://advertising.amazon.com/downloads/Amazon_Advertising_API_Getting_Started_Guide.pdf)
+2. [Amazon Advertising API Reference.pdf](https://advertising.amazon.com/downloads/Amazon_Advertising_API_Reference.pdf)
+
+Once you have an account you will be assigned a "client_id" and a "client_secret".
+
+Next you will need to obtain an authorization code from the Amazon API. You can do that by making a browser request to the following URL:
+
+```
+https://www.amazon.com/ap/oa?client_id=YOUR_LWA_CLIENT_ID &scope=cpc_advertising:campaign_management&response_type=code&redirect_uri=YOUR_RETURN_URL
+```
+
+Enter your client ID in the URL and a valid website as the return URL. Amazon will direct you to login.  Login with your
+advertising credentials.  You will then be redirected back to your provided URL.  NOTICE that you will have an authorization code listed
+on the return URL.  YOU NEED THIS code to now obtain your refresh token.
+
+## Obtaining Your Refresh Token
+Once you have your authorization code, you can obtain your first access token and refresh token.
+Do that by making a curl call to the following:
+
+```
+curl \
+  -X POST \
+  -H "Content-Type:application/x-www-form-urlencoded;charset=UTF-8" \
+  --data "grant_type=authorization_code&code=AUTH_CODE&redirect_uri=YOUR_RETURN_URL&client_id=YOUR_CLIENT_ID&client_secret=YOUR_SECRET_KEY" \
+  https://api.amazon.com/auth/o2/token
+```
+
+The response should return a JSON payload. Find the "refresh token" and save it's value.  
+You will need this token to make repeated API calls.  The refresh token is tied to your account
+and won't change as long as your account is valid and hasn't changed.
+
+The Blurb API wrapper will then use the refresh token to make OAUTH calls to get a valid
+access token and call the API with the appropriate bearer token headers setup.
+
+## Obtaining Your Profile ID
+The last piece you need to obtain before you can be on your way to using the API is the profile.
+The profile scopes you to certain features and you can have multiple profiles setup for your account.
+
+You can find your profiles by making the following Blurb call.
+
+```ruby
+  Blurb.client_id = "<YOUR_CLIENT_ID>"
+  Blurb.client_secret = "<YOUR_CLIENT_SECRET>"
+  Blurb.refresh_token = "<YOUR_REFRESH_TOKEN>"
+
+  Blurb::Profile.list()
+```
+
+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
+
+```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>"
+```
+
+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
+
+```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"]
+```
+
+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.
+
+```ruby
+Blurb.test_env = true
+```
+
+## Usage
+
+All API calls have been setup as closely as possible to REST Resource calls.
+All you need to do is find the appropriate resource object and make a method call on it and Blurb will do the rest.
+
+NOTE: Not all API endpoints are currently supported by Blurb.  Over time we will get more
+endpoints added. In the mean time you are always welcome to submit a pull request.
+
+### Profiles
+List account profiles
+
+```ruby
+Blurb::Profile.list()
+```
+
+### Campaigns
+List campaigns
+
+```ruby
+Blurb::Campaign.list()
+```
+
+Get a campaign
+
+```ruby
+Blurb::Campaign.retrieve(campaign_id)
+```
+
+Create a campaign
+
+```ruby
+Blurb::Campaign.create({
+  "name" => "test",
+  "campaignType" => "sponsoredProducts",
+  "state" => "enabled",
+  "dailyBudget" => 10,
+  "startDate" => (Time.now).strftime('%Y%m%d'),
+  "targetingType" => "abc"
+})
+```
+
+### Reports
+Request a report
+
+```ruby
+payload_response = Blurb::Report.create({
+  "recordType" => Blurb::Report::KEYWORDS,
+  "reportDate" => (Time.now - 2592000).strftime('%Y%m%d'),
+  "metrics" => "impressions,clicks"
+})
+```
+
+Report record types are
+
+```ruby
+Blurb::Report::KEYWORDS
+Blurb::Report::CAMPAIGNS
+Blurb::Report::AD_GROUPS
+Blurb::Report::PRODUCT_ADS
+```
+
+### Suggested Keywords
+Suggestions by ASIN
+
+```ruby
+Blurb::SuggestedKeyword.asin_suggestions({
+  "asinValue" => "B0006HUJJO"
+})
+```
+
+Suggestions for a list of ASIN's
+
+```ruby
+Blurb::SuggestedKeyword.bulk_asin_suggestions({
+  "asins" => ["B0006HUJJO","B0042SWOHI"]
+})
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## 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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/blurb.gemspec

@@ -0,0 +1,41 @@
+# 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.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.}
+  spec.homepage      = "https://github.com/iserve-products/blurb"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  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 "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.3.0"
+
+  spec.add_runtime_dependency "rest-client", "~> 2.0"
+  spec.add_runtime_dependency "oauth2", "~> 1.4.0"
+
+end

data/lib/blurb.rb

@@ -0,0 +1,46 @@
+require "oauth2"
+require "rest-client"
+
+require "blurb/version"
+require "blurb/base_resource"
+
+require "blurb/bid_recommendation"
+require "blurb/campaign"
+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
+  end
+
+  class << self
+    attr_accessor :client_secret, :client_id, :refresh_token, :profile_id, :test_env, :eu_env
+  end
+
+end

data/lib/blurb/base_resource.rb

@@ -0,0 +1,72 @@
+module Blurb
+  class BaseResource
+    def self.profile_request(api_path)
+      access_token = Blurb::Token.retrieve()
+
+      request_config = {
+          method: :get,
+          url: "#{Blurb.active_api_url}#{api_path}",
+          headers: {
+            :Authorization => "Bearer #{access_token['access_token']}",
+            "Content-Type" => "application/json"
+          }
+        }
+
+      resp = RestClient::Request.execute(request_config)
+      return JSON.parse(resp)
+    end
+
+    def self.get_request(api_path, opts = {})
+      access_token = Blurb::Token.retrieve()
+
+      url = "#{Blurb.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
+      }
+
+      headers_hash["Content-Encoding"] = "gzip" if opts[:gzip]
+      # headers_hash.delete("Authorization") if opts[:no_token]
+
+      request_config = {
+          method: :get,
+          url: url,
+          headers: headers_hash,
+          max_redirects: 0
+        }
+
+      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])
+        end
+      end
+
+      response = JSON.parse(resp) if resp
+      return response
+    end
+
+    def self.post_request(api_path, payload)
+      access_token = Blurb::Token.retrieve()
+
+      request_config = {
+          method: :post,
+          url: "#{Blurb::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
+          }
+        }
+
+      resp = RestClient::Request.execute(request_config)
+      return JSON.parse(resp)
+    end
+  end
+end

data/lib/blurb/bid_recommendation.rb

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

data/lib/blurb/campaign.rb

@@ -0,0 +1,62 @@
+module Blurb
+  class Campaign < BaseResource
+    def self.retrieve(campaign_id)
+      get_request("/v1/campaigns/#{campaign_id}")
+    end
+
+    def self.retrieve_extended(campaign_id)
+      get_request("/v1/campaigns/extended/#{campaign_id}")
+    end
+
+    def self.list(params = {}, opts = {})
+      get_request("/v1/campaigns?#{setup_url_params(params)}")
+    end
+
+    def self.create(params = {}, opts = {})
+      # required argument checks
+      if !params["name"] && !params["campaignType"] && !params["targetingType"] && !params["state"] && !params["dailyBudget"] && !params["startDate"]
+        raise ArgumentError.new("params hash must contain name, campaignType, targetingType, state, dailyBudget and startDate")
+      end
+
+      post_request("/v1/campaigns", [params])
+    end
+
+    def self.create_bulk(campaign_array, opts = {})
+      post_request("/v1/campaigns", campaign_array)
+    end
+
+    private
+
+    def self.setup_url_params(params)
+      url_params = ""
+      url_params = "startIndex=#{params['startIndex']}" if params['startIndex']
+
+      if params['count']
+        url_params += "&" if url_params.size > 0
+        url_params += "count=#{params['count']}"
+      end
+
+      if params['campaignType']
+        url_params += "&" if url_params.size > 0
+        url_params += "campaignType=#{params['campaignType']}"
+      end
+
+      if params['stateFilter']
+        url_params += "&" if url_params.size > 0
+        url_params += "stateFilter=#{params['stateFilter']}"
+      end
+
+      if params['name']
+        url_params += "&" if url_params.size > 0
+        url_params += "name=#{params['name']}"
+      end
+
+      if params['campaignIdFilter']
+        url_params += "&" if url_params.size > 0
+        url_params += "campaignIdFilter=#{params['campaignIdFilter']}"
+      end
+
+      return url_params
+    end
+  end
+end

data/lib/blurb/profile.rb

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

data/lib/blurb/report.rb

@@ -0,0 +1,32 @@
+module Blurb
+  class Report < BaseResource
+    CAMPAIGNS = "campaigns"
+    AD_GROUPS = "adGroups"
+    KEYWORDS = "keywords"
+    PRODUCT_ADS = "productAds"
+
+    def self.create(params = {}, opts = {})
+      # required argument checks
+      raise ArgumentError.new("params hash must contain a recordType") unless params["recordType"]
+
+      api_params = {
+        "campaignType" => "sponsoredProducts",
+        "reportDate" => params["reportDate"],
+        "metrics" => params["metrics"]
+      }
+
+      api_params["segment"] = params["segment"] if params["segment"]
+
+      post_request("/v1/#{params["recordType"]}/report", api_params)
+    end
+
+    def self.status(report_id, opts = {})
+      get_request("/v1/reports/#{report_id}")
+    end
+
+    def self.download(location, opts = {})
+      opts.merge!({:full_path => true, :gzip => true, :no_token => true})
+      get_request(location, opts)
+    end
+  end
+end

data/lib/blurb/snapshot.rb

@@ -0,0 +1,20 @@
+module Blurb
+  class Snapshot < BaseResource
+    CAMPAIGNS = "campaigns"
+    AD_GROUPS = "adGroups"
+    KEYWORDS = "keywords"
+    NEGATIVE_KEYWORDS = "negativeKeywords"
+    CAMPAIGN_NEGATIVE_KEYWORDS = "campaignNegativeKeywords"
+    PRODUCT_ADS = "productAds"
+
+    def self.create(params = {}, opts = {})
+      # required argument checks
+      raise ArgumentError.new("params hash must contain a recordType") unless params["recordType"]
+
+      post_request("/v1/#{params["recordType"]}/snapshot", {
+        "campaignType" => "sponsoredProducts",
+        "stateFilter" => params["stateFilter"]
+      })
+    end
+  end
+end

data/lib/blurb/suggested_keyword.rb

@@ -0,0 +1,56 @@
+module Blurb
+  class SuggestedKeyword < BaseResource
+    def self.ad_group_suggestions(params = {}, opts = {})
+      # required argument checks
+      raise ArgumentError.new("params hash must contain an adGroupId") unless params["adGroupId"]
+
+      get_request("/v1/adGroups/#{params["adGroupId"]}/suggested/keywords?#{setup_url_params(params)}")
+    end
+
+    def self.ad_group_extended_suggestions(params = {}, opts = {})
+      # required argument checks
+      raise ArgumentError.new("params hash must contain an adGroupId") unless params["adGroupId"]
+
+      get_request("/v1/adGroups/#{params["adGroupId"]}/suggested/keywords/extended?#{setup_url_params(params)}")
+    end
+
+    def self.asin_suggestions(params = {}, opts = {})
+      # required argument checks
+      raise ArgumentError.new("params hash must contain an asinValue") unless params["asinValue"]
+
+      get_request("/v1/asins/#{params["asinValue"]}/suggested/keywords?#{setup_url_params(params)}")
+    end
+
+    def self.bulk_asin_suggestions(params = {}, opts = {})
+      # required argument checks
+      raise ArgumentError.new("params hash must contain an asins array") unless params["asins"]
+
+      maxNumSuggestions = 100
+      maxNumSuggestions = params["maxNumSuggestions"] if params["maxNumSuggestions"]
+      
+      post_request("/v1/asins/suggested/keywords", {
+        "asins" => params["asins"],
+        "maxNumSuggestions" => maxNumSuggestions
+      })
+    end
+
+    private
+
+    def self.setup_url_params(params)
+      url_params = ""
+      url_params = "maxNumSuggestions=#{params['maxNumSuggestions']}" if params['maxNumSuggestions']
+
+      if params['adStateFilter']
+        url_params += "&" if url_params.size > 0
+        url_params += "adStateFilter=#{params['adStateFilter']}"
+      end
+
+      if params['suggestBids']
+        url_params += "&" if url_params.size > 0
+        url_params += "suggestBids=#{params['suggestBids']}"
+      end
+
+      return url_params
+    end
+  end
+end

data/lib/blurb/token.rb

@@ -0,0 +1,34 @@
+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

data/lib/blurb/version.rb

@@ -0,0 +1,3 @@
+module Blurb
+  VERSION = "0.1.1".freeze
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: blurb
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- dlbunker
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- blurb.gemspec
+- lib/blurb.rb
+- lib/blurb/base_resource.rb
+- lib/blurb/bid_recommendation.rb
+- lib/blurb/campaign.rb
+- lib/blurb/profile.rb
+- 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:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Ruby gem for the Amazon Advertising API
+test_files: []