rubocop-google_ads 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9fa293a81fb19cf2a475155458f2b4cd378927e392950a47641f46924d9bb333
+  data.tar.gz: 584a02dcdd660daaf8b2975b3851c5e6f13ec24b09c5cb9af68d74795369ece7
+SHA512:
+  metadata.gz: f76d1a6c8bc82a06b96e3bcb53ddaf297579c5e87b5e01a9125c50f4c873f1c6e5cdcaee74e5e08dd5eeb6b10efbea2ae5f161e3651fc7c45dd9e1a8c3afdc1b
+  data.tar.gz: a2f39debec957f3284626fdd0615e1685c12556e0b36248143a6ea4456d2cd72fb9037055ae01902c3a3a9bd4c3e85a8b31e8428831b69e32707afb5c846d333

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,12 @@
+Naming/FileName:
+ Exclude:
+   - lib/rubocop-google_ads.rb
+
+Metrics/ClassLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change log
+
+## 0.1.0
+
+### New features
+
+- Add new `GoogleAds/DoNotGetResourceMethods` cop.

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rubocop-google_ads.gemspec
+gemspec
+
+gem 'google-ads-googleads'
+gem 'pry-byebug'
+gem 'rake', '~> 12.0'
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,102 @@
+PATH
+  remote: .
+  specs:
+    rubocop-google_ads (0.1.0)
+      rubocop
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.0)
+    byebug (11.1.1)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    faraday (0.17.3)
+      multipart-post (>= 1.2, < 3)
+    google-ads-googleads (4.0.0)
+      google-gax (~> 1.6)
+    google-gax (1.8.1)
+      google-protobuf (~> 3.9)
+      googleapis-common-protos (>= 1.3.9, < 2.0)
+      googleauth (~> 0.9)
+      grpc (~> 1.24)
+      rly (~> 0.2.3)
+    google-protobuf (3.11.3)
+    googleapis-common-protos (1.3.9)
+      google-protobuf (~> 3.0)
+      googleapis-common-protos-types (~> 1.0)
+      grpc (~> 1.0)
+    googleapis-common-protos-types (1.0.4)
+      google-protobuf (~> 3.0)
+    googleauth (0.10.0)
+      faraday (~> 0.12)
+      jwt (>= 1.4, < 3.0)
+      memoist (~> 0.16)
+      multi_json (~> 1.11)
+      os (>= 0.9, < 2.0)
+      signet (~> 0.12)
+    grpc (1.27.0)
+      google-protobuf (~> 3.11)
+      googleapis-common-protos-types (~> 1.0)
+    jaro_winkler (1.5.4)
+    jwt (2.2.1)
+    memoist (0.16.2)
+    method_source (0.9.2)
+    multi_json (1.14.1)
+    multipart-post (2.1.1)
+    os (1.0.1)
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.8.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    public_suffix (4.0.3)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rly (0.2.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.79.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    signet (0.12.0)
+      addressable (~> 2.3)
+      faraday (~> 0.9)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+    unicode-display_width (1.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  google-ads-googleads
+  pry-byebug
+  rake (~> 12.0)
+  rspec
+  rubocop-google_ads!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 hanocha
+
+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,42 @@
+# Rubocop::GoogleAds
+
+A RuboCop extension for [Google Ads Client Library for Ruby](https://github.com/googleads/google-ads-ruby).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-google_ads', require: false
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rubocop-google_ads
+
+## Usage
+
+Require it in your `.rubocop.yml`, like below.
+
+```
+require: rubocop-rails
+```
+
+## 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/hanocha/rubocop-google_ads.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Generate a new cop with a template'
+task :new_cop, [:cop] do |_task, args|
+  require 'rubocop'
+
+  cop_name = args.fetch(:cop) do
+    warn 'usage: bundle exec rake new_cop[Department/Name]'
+    exit!
+  end
+
+  github_user = `git config github.user`.chop
+  github_user = 'your_id' if github_user.empty?
+
+  generator = RuboCop::Cop::Generator.new(cop_name, github_user)
+
+  generator.write_source
+  generator.write_spec
+  generator.inject_require(root_file_path: 'lib/rubocop/cop/google_ads_cops.rb')
+  generator.inject_config(config_file_path: 'config/default.yml')
+
+  puts generator.todo
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rubocop/google_ads'
+
+# 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 'pry'
+Pry.start

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/config/default.yml

@@ -0,0 +1,4 @@
+GoogleAds/DoNotGetResourceMethods:
+  Description: 'Do not use get methods to fetch resource informations. Use GoogleAdsService.search.'
+  Enabled: true
+  VersionAdded: '0.1'

data/lib/rubocop-google_ads.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+require_relative 'rubocop/google_ads'
+require_relative 'rubocop/google_ads/version'
+require_relative 'rubocop/google_ads/inject'
+
+RuboCop::GoogleAds::Inject.defaults!
+
+require_relative 'rubocop/cop/google_ads_cops'

data/lib/rubocop/cop/google_ads/do_not_get_resource_methods.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+# TODO: when finished, run `rake generate_cops_documentation` to update the docs
+module RuboCop
+  module Cop
+    module GoogleAds
+      # This cop enforces to use GoogleAdsService.search to retrive resource.
+      #
+      # @example
+      #   # bad
+      #   client.service.resource.get_resource
+      #
+      #   # good
+      #   client.service.google_ads.search(customer_id, query_to_retrive_resource)
+      #
+      class DoNotGetResourceMethods < Cop
+        DEPRECATED_GET_METHODS = %i[
+          get_ad_group_bid_modifier
+          get_group_placement_view
+          get_campaign_budget
+          get_extension_feed_item
+          get_customer_manager_link
+          get_search_term_view
+          get_keyword_plan_ad_group
+          get_billing_setup
+          get_click_view
+          get_shared_criterion
+          get_campaign_draft
+          get_ad_group_simulation
+          get_product_group_view
+          get_landing_page_view
+          get_campaign_shared_set
+          get_keyword_plan_keyword
+          get_location_view
+          get_custom_interest
+          get_merchant_center_link
+          get_detail_placement_view
+          get_customer_negative_criterion
+          get_keyword_plan_campaign
+          get_paid_organic_search_term_view
+          get_age_range_view
+          get_campaign_label
+          get_ad_group_audience_view
+          get_mobile_app_category_constant
+          get_topic_constant
+          get_parental_status_view
+          get_bidding_strategy
+          get_geo_target_constant
+          get_ad_parameter
+          get_mobile_device_constant
+          get_ad_group_ad_asset_view
+          get_ad_group_feed
+          get_ad_group_criterion_simulation
+          get_ad_group_criterion
+          get_distance_view
+          get_media_file
+          get_user_location_view
+          get_feed_item_target
+          get_carrier_constant
+          get_campaign_audience_view
+          get_hotel_group_view
+          get_feed_item
+          get_campaign_criterion_simulation
+          get_customer_client
+          get_ad_group_label
+          get_recommendation
+          get_ad_schedule_view
+          get_domain_category
+          get_keyword_plan_negative_keyword
+          get_ad_group_extension_setting
+          get_ad
+          get_ad_group_ad
+          get_keyword_plan
+          get_feed_placeholder_view
+          get_customer_client_link
+          get_mutate_job
+          get_dynamic_search_ads_search_term_view
+          get_feed_mapping
+          get_language_constant
+          get_feed
+          get_hotel_performance_view
+          get_campaign_criterion
+          get_campaign_bid_modifier
+          get_customer
+          get_remarketing_action
+          get_ad_group
+          get_label
+          get_customer_feed
+          get_shared_set
+          get_customer_extension_setting
+          get_account_budget
+          get_campaign_feed
+          get_gender_view
+          get_video
+          get_keyword_view
+          get_user_list
+          get_product_bidding_category_constant
+          get_topic_view
+          get_asset
+          get_campaign_experiment
+          get_conversion_action
+          get_ad_group_ad_label
+          get_change_status
+          get_campaign_extension_setting
+          get_operating_system_version_constant
+          get_ad_group_criterion_label
+          get_geographic_view
+          get_google_ads_field
+          get_campaign
+          get_user_interest
+          get_shopping_performance_view
+          get_expanded_landing_page_view
+          get_customer_label
+          get_display_keyword_view
+          get_managed_placement_view
+          get_account_budget_proposal
+        ].freeze
+
+        MSG = 'Use `GoogleAdsService.search`, instead of get methods.'
+
+        def on_send(node)
+          receiver, method_name = *node
+          return unless receiver && DEPRECATED_GET_METHODS.include?(method_name)
+
+          add_offense(node, location: :selector)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/google_ads_cops.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'google_ads/do_not_get_resource_methods'

data/lib/rubocop/google_ads.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'rubocop/google_ads/version'
+
+module RuboCop
+  module GoogleAds
+    class Error < StandardError; end
+    # Your code goes here...
+    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
+    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+  end
+end

data/lib/rubocop/google_ads/inject.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# The original code is from https://github.com/rubocop-hq/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
+# See https://github.com/rubocop-hq/rubocop-rspec/blob/master/MIT-LICENSE.md
+module RuboCop
+  module GoogleAds
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      def self.defaults!
+        path = CONFIG_DEFAULT.to_s
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = Config.new(hash, path).tap(&:make_excludes_absolute)
+        puts "configuration from #{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/google_ads/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module GoogleAds
+    VERSION = '0.1.0'
+  end
+end

data/rubocop-google_ads.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'lib/rubocop/google_ads/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rubocop-google_ads'
+  spec.version       = RuboCop::GoogleAds::VERSION
+  spec.authors       = ['hanocha']
+  spec.email         = ['hanocha.peter@gmail.com']
+
+  spec.summary       = 'Custom cops for Google Ads API Ruby Client Library'
+  spec.homepage      = 'https://github.com/hanocha/rubocop-google_ads'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.5')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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_runtime_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-google_ads
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hanocha
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: 
+email:
+- hanocha.peter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/default.yml
+- lib/rubocop-google_ads.rb
+- lib/rubocop/cop/google_ads/do_not_get_resource_methods.rb
+- lib/rubocop/cop/google_ads_cops.rb
+- lib/rubocop/google_ads.rb
+- lib/rubocop/google_ads/inject.rb
+- lib/rubocop/google_ads/version.rb
+- rubocop-google_ads.gemspec
+homepage: https://github.com/hanocha/rubocop-google_ads
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hanocha/rubocop-google_ads
+  source_code_uri: https://github.com/hanocha/rubocop-google_ads
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.5
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Custom cops for Google Ads API Ruby Client Library
+test_files: []