bing_ads_ruby_sdk 1.5.2 → 1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee1dd6d1c423e271f716d5a8d71aea958a73126002eb777a765f10416a0aa095
-  data.tar.gz: d145e027e36d473eb849a06e5eac94641f85f4c427a96a76136841e1a70a7814
+  metadata.gz: 10064130886df96745297db7c95d5482b3127563383425554e7ee722e36e17ff
+  data.tar.gz: ffd8833ecabc68e2d6ac7760891399070bbffb6f644f79b7f71275270e5e9c95
 SHA512:
-  metadata.gz: 7b78346cc370f6c287987c32cab9f898051158b40070375d3ae9f33b29fce2538674d276b8917cf9ce6710897b8727bd43dce1ae56a2346facf0087867300d6a
-  data.tar.gz: b3fdebf99829b5d1dafa5d30197829dabeedb8960727d0c49b7ab8b1990304f3589873137becefdc9b7f03c1ac5953c8174b76f29ee35b8323a011ea7034e70a
+  metadata.gz: 5dad795cb0dba423784ad86926c397740b083201bfb9c327f04763e94f34149860d857989b2e1386008ed19d96317a9ea91655b1267f39017b32fd14d34b9388
+  data.tar.gz: b5d31b8cd1fad4f64b91debaead3daf4878d427b5d5d17639247e732eedc125a406d16968a1dd5a3d1fc4402059268d5cffa05ee6a0c96ae153836246f232154

data/Gemfile

@@ -3,4 +3,4 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in bing_ads_ruby_sdk.gemspec
 gemspec
 
-gem "standard", "1.25.3"
+gem "standard", "1.31.1"

data/README.md

@@ -16,7 +16,8 @@ Or install it yourself as:
 
     $ gem install bing_ads_ruby_sdk
 
-## Getting Started
+## Usage
+### Getting Started
 
 In order to use Microsoft's advertising API you need to 
 [get your API credentials from MS](https://learn.microsoft.com/en-us/advertising/guides/get-started?view=bingads-13).
@@ -33,7 +34,6 @@ bin/rake bing_token:get['credentials.json',YOUR_DEVELOPER_TOKEN,YOUR_CLIENT_ID,Y
 bin/rake bing_token:get['credentials.json',ABC1234,3431b6d0-a2ac-48e1-a1c5-1d0b82f3187f,SECRETVALUEHERE]
 ```
 
-
 Then to use the api:
 ```ruby
 store = ::BingAdsRubySdk::OAuth2::FsStore.new('my_token.json')
@@ -44,6 +44,22 @@ api = BingAdsRubySdk::Api.new(
 )
 ```
 
+### Configuration
+```ruby
+BingAdsRubySdk.configure do |conf|
+  conf.log = true
+  conf.logger.level = Logger::DEBUG
+  conf.pretty_print_xml = true
+  # to filter sensitive data before logging
+  conf.filters = ["AuthenticationToken", "DeveloperToken"]
+  
+  # Optionally allow ActiveSupport::Notifications to be emitted by Excon.
+  # These notifications can then be sent on to your profiling system
+  # conf.instrumentor = ActiveSupport::Notifications 
+end
+```
+
+### Account creation and management
 If you want to create an account using the API:
 ```ruby
 api.customer_management.signup_customer(
@@ -54,7 +70,7 @@ api.customer_management.signup_customer(
 ```
 
 Otherwise you can [use existing account IDs as explained here](https://learn.microsoft.com/en-us/advertising/guides/get-started?view=bingads-13#get-ids),
-or use the `customer_management` endpoint as explained below.
+or use the `customer_management` endpoint as explained above.
 
 Once you have your MS Advertising customer and account ids:
 ```ruby
@@ -80,22 +96,76 @@ The methods implemented contain additional code to ease data manipulation but an
 
 ```
 
+### Reporting
+You can generate the report following the 
+[process recommended by Microsoft](https://learn.microsoft.com/en-us/advertising/guides/request-download-report?view=bingads-13):
+
+That would mean coding something like this:
 
-## Configure the gem
 ```ruby
-BingAdsRubySdk.configure do |conf|
-  conf.log = true
-  conf.logger.level = Logger::DEBUG
-  conf.pretty_print_xml = true
-  # to filter sensitive data before logging
-  conf.filters = ["AuthenticationToken", "DeveloperToken"]
-  
-  # Optionally allow ActiveSupport::Notifications to be emitted by Excon.
-  # These notifications can then be sent on to your profiling system
-  # conf.instrumentor = ActiveSupport::Notifications 
+submission_response = api.reporting
+  .call(:submit_generate_report,
+     account_performance_report_request: {
+       exclude_report_header: true,
+       exclude_report_footer: true,
+       exclude_column_headers: true,
+       format: "Csv",
+       aggregation: "Daily",
+       filter: nil,
+       columns: [
+         {
+           account_performance_report_column: "TimePeriod"
+         },
+         {
+           account_performance_report_column: "AccountId"
+         },
+         {
+           account_performance_report_column: "DeviceType"
+         },
+         {
+           account_performance_report_column: "Clicks"
+         }
+       ],
+       scope: {
+         # Your account ID here
+         account_ids: [{long: 1000000}]
+       },
+       time: {
+         custom_date_range_start: {
+           day: 7,
+           month: 5,
+           year: 2023
+         },
+         custom_date_range_end: {
+           day: 8,
+           month: 5,
+           year: 2023
+         }
+       }
+     }
+  )
+
+report_request_id = submission_response.fetch(:report_request_id)
+
+# Then you can poll the API to check the status of the report generation
+poll_response = api.reporting.call(:poll_generate_report, report_request_id: report_request_id)
+
+# When it is ready you can download it
+report_request_status = poll_response.fetch(:report_request_status)
+
+report_generation_status = report_request_status[:status].downcase.to_sym 
+# => One of these: :pending, :error, :success
+
+if report_generation_status == :success
+  url = report_request_status[:report_download_url]
+  # => The URL to download the report (with the library of your choice)
 end
 ```
 
+🛈 Report request example [here in the API docs](https://learn.microsoft.com/en-us/advertising/reporting-service/accountperformancereportrequest?view=bingads-13)
+
+🛈 Hint: convert parameter names from PascalCase to snake_case when consulting the API docs
+
 ## Development
 You can run `bin/console` for an interactive prompt that will allow you to experiment.
 

data/bing_ads_ruby_sdk.gemspec

@@ -4,7 +4,7 @@ require "bing_ads_ruby_sdk/version"
 
 Gem::Specification.new do |spec|
   spec.name = "bing_ads_ruby_sdk"
-  spec.required_ruby_version = ">= 2.3"
+  spec.required_ruby_version = ">= 3"
 
   spec.version = BingAdsRubySdk::VERSION
   spec.authors = %w[Effilab developers]

data/changelog.md

@@ -1,3 +1,8 @@
+## V1.6 Release
+- Updated documentation
+- Fixed an envkey/dotenv related bug preventing the gem from starting
+- Dropped support for Ruby 2
+
 ## V1.5.1 Release
 - Bug fix: Rake task missing
 

data/lib/bing_ads_ruby_sdk/oauth2/fs_store.rb

@@ -23,7 +23,7 @@ module BingAdsRubySdk
       # @return [nil] if the file doesn't exist.
       def read
         return nil unless File.file?("./#{filename}")
-        JSON.parse(IO.read(filename))
+        JSON.parse(File.read(filename))
       end
 
       private

data/lib/bing_ads_ruby_sdk/string_utils.rb

@@ -7,6 +7,8 @@ module BingAdsRubySdk
     end
 
     def self.snakize(string)
+      raise "Unexpected string length : #{string.length} for string '#{string[0..200]}...'" if string.length > 1000
+
       string.gsub(MULTIPLE_CAPSREGEX, MATCHING_PATTERN)
         .gsub(SPLIT_REGEX, MATCHING_PATTERN)
         .tr("-", "_")

data/lib/bing_ads_ruby_sdk/tasks/bing_ads_ruby_sdk.rake

@@ -1,4 +1,8 @@
-require "dotenv/load"
+begin
+  require "dotenv/load"
+rescue LoadError
+  puts "Unable to load .env file, resuming..."
+end
 
 namespace :bing_token do
   desc "Gets OAuth token from MS and stores it in a JSON file defined by filename parameter"

data/lib/bing_ads_ruby_sdk/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module BingAdsRubySdk
-  VERSION = "1.5.2"
+  VERSION = "1.6"
   DEFAULT_SDK_VERSION = :v13
 end

data/lib/bing_ads_ruby_sdk.rb

@@ -10,6 +10,9 @@ require "bing_ads_ruby_sdk/string_utils"
 require "bing_ads_ruby_sdk/railtie" if defined?(Rails)
 
 module BingAdsRubySdk
+  TYPE_KEY = "@type"
+  ROOT_PATH = File.join(__dir__, "..")
+
   def self.config
     @configuration ||= BingAdsRubySdk::Configuration.new
   end
@@ -18,9 +21,9 @@ module BingAdsRubySdk
     yield(config)
   end
 
-  def self.log(level, *args, &block)
+  def self.log(level, ...)
     return unless config.log
-    config.logger.send(level, *args, &block)
+    config.logger.send(level, ...)
   end
 
   def self.root_path
@@ -30,7 +33,4 @@ module BingAdsRubySdk
   def self.type_key
     TYPE_KEY
   end
-
-  TYPE_KEY = "@type"
-  ROOT_PATH = File.join(__dir__, "..")
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bing_ads_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: '1.6'
 platform: ruby
 authors:
 - Effilab
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-27 00:00:00.000000000 Z
+date: 2023-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: signet
@@ -256,14 +256,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.9
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Bing Ads Ruby SDK