gladwords 1.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Gladwords Team
+
+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,71 @@
+# Gladwords
+
+A saner Ruby wrapper over the AdWords API, using [ROM.rb](https://rom-rb.org).
+
+# Clout
+
+[![CircleCI](https://circleci.com/gh/adHawk/gladwords.svg?style=svg)](https://circleci.com/gh/adHawk/gladwords)
+
+## Usage
+
+```ruby
+# setup your client following these instructions:
+#   https://github.com/googleads/google-api-ads-ruby/blob/master/adwords_api/README.md#2---using-the-client-library
+client = AdwordsApi::Api.new
+
+ROM::Configuration.new(:adwords, client: client) do |config|
+  config.relation(:campaigns) do
+    auto_struct(true)
+    auto_map(true)
+
+    schema(infer: true) do
+      attribute :id, Gladwords::Types::ID
+
+      primary_key :id
+
+      associations do
+        has_many :ad_groups, combine_key: :campaign_id
+      end
+    end
+  end
+
+  config.relation(:ad_groups) do
+    auto_struct(true)
+    auto_map(true)
+
+    schema(infer: true) do
+      attribute :id, Gladwords::Types::ID
+
+      primary_key :id
+
+      associations do
+        belongs_to :campaign, combine_key: :id
+      end
+    end
+  end
+end
+
+scope = subject.select(:id, :name).where(name: 'Test Campaign 2')
+gladwords = ROM.container(configuration)
+
+# query the relations
+campaigns = gladwords.relations[:campaigns]
+campaigns.select(:id, :name).where(name: 'Campaign 2').to_a # [{ id: '123', name: 'Campaign 2']]
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'attr-gather'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install attr-gather
+

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'rake'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:lint)
+
+task :default do
+  sh "curl -fLSs https://circle.ci/cli | DESTDIR=#{__dir__}/tmp bash" unless File.exist?('./tmp/circleci')
+
+  sh './tmp/circleci local execute build'
+end

data/bin/rake

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+# rubocop:disable all
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")
+# rubocop:enable all

data/bin/rspec

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+# rubocop:disable all
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")
+# rubocop:enable all

data/bin/solargraph

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'solargraph' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("solargraph", "solargraph")

data/config/environment.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+# stub file for projectionist.vim

data/gladwords.code-workspace

@@ -0,0 +1,11 @@
+{
+  "settings": {
+    "editor.tabSize": 2,
+    "editor.formatOnSave": true,
+    "editor.formatOnSaveTimeout": 2000,
+    "ruby.format": "rubocop",
+    "ruby.lint": {
+      "rubocop": true
+    }
+  }
+}

data/gladwords.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gladwords/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gladwords'
+  spec.version       = Gladwords::VERSION.dup
+  spec.authors       = ['Ian Ker-Seymer', 'Patrick Sparrow']
+  spec.email         = ['ian@tryadhawk.com', 'patrick@tryadhawk.com']
+  spec.summary       = 'AdWords support for ROM.rb'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/adHawk/gladwords'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'google-adwords-api'
+  spec.add_runtime_dependency 'rom', '~> 4.2.0'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/ext/rom/inflector.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'rom/support/inflector'
+
+module ROM
+  remove_const('Inflector')
+  Inflector = Gladwords::Inflector
+end

data/lib/gladwords.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'rom'
+
+require_relative 'gladwords/inflector'
+require_relative 'ext/rom/inflector'
+require_relative 'gladwords/selector_fields_db'
+require_relative 'gladwords/errors'
+require_relative 'gladwords/version'
+require_relative 'gladwords/gateway'
+require_relative 'gladwords/relation'
+require_relative 'gladwords/commands'
+require_relative 'gladwords/types'
+
+# rom-rb adapter for Google AdWords
+#
+# @api public
+module Gladwords
+  include Dry::Core::Constants
+end
+
+ROM.register_adapter(:adwords, Gladwords)

data/lib/gladwords/associations.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'gladwords/associations/many_to_many'
+require 'gladwords/associations/many_to_one'
+require 'gladwords/associations/one_to_many'
+require 'gladwords/associations/one_to_one'
+require 'gladwords/associations/one_to_one_through'

data/lib/gladwords/associations/many_to_many.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'rom/associations/many_to_many'
+
+module Gladwords
+  module Associations
+    # Many to many implementation
+    class ManyToMany < ROM::Associations::ManyToMany
+      def call(target:)
+        target
+      end
+
+      def preload(target, _loaded)
+        target
+      end
+    end
+  end
+end

data/lib/gladwords/associations/many_to_one.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'rom/associations/many_to_one'
+
+module Gladwords
+  module Associations
+    # A class which represents a many to one relationship (i.e. belongs_to)
+    #
+    # @api private
+    class ManyToOne < ROM::Associations::ManyToOne
+      def call(target:)
+        target
+      end
+
+      def preload(target, loaded)
+        target_pks = loaded.pluck(:campaign_id)
+
+        target.where(target.schema.primary_key_name => target_pks)
+      end
+    end
+  end
+end

data/lib/gladwords/associations/one_to_many.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'rom/associations/one_to_many'
+
+module Gladwords
+  module Associations
+    # @api private
+    class OneToMany < ROM::Associations::OneToMany
+      def call(target:)
+        target
+      end
+
+      def preload(target, loaded)
+        target_pks = loaded.pluck(:id)
+        target.where(foreign_key => target_pks)
+      end
+    end
+  end
+end

data/lib/gladwords/associations/one_to_one.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'gladwords/associations/one_to_many'
+
+module Gladwords
+  module Associations
+    class OneToOne < OneToMany
+    end
+  end
+end

data/lib/gladwords/associations/one_to_one_through.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Gladwords
+  module Associations
+    class OneToOneThrough < ManyToMany
+    end
+  end
+end

data/lib/gladwords/commands.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'rom/commands'
+
+require 'gladwords/commands/create'
+require 'gladwords/commands/update'
+require 'gladwords/commands/delete'

data/lib/gladwords/commands/core.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'gladwords/commands/error_wrapper'
+
+module Gladwords
+  module Commands
+    # @api private
+    module Core
+      extend Dry::Core::ClassAttributes
+
+      # @api private
+      module Types
+        include Dry::Types.module
+
+        Operation = Hash.schema(
+          operator: Coercible::String.enum('ADD', 'SET', 'REMOVE'),
+          operand: Hash
+        )
+      end
+
+      def self.included(klass)
+        super
+
+        klass.include ErrorWrapper
+        klass.defines :adwords_operator
+        klass.defines :operand_mapper
+        klass.option :mutator, default: -> { method(:mutate) }
+      end
+
+      def execute(tuples)
+        perform_operations(tuples)
+      end
+
+      def perform_operations(tuples)
+        operations = build_operations(tuples)
+        raw_result = mutator.call(operations)
+
+        unwrap_result(raw_result)
+      end
+
+      private
+
+      def build_operations(tuples)
+        ensure_enumerable(tuples).map do |tuple|
+          operator(tuple)
+        end
+      end
+
+      def mutate(operations)
+        relation.dataset.mutate(operations)
+      end
+
+      def unwrap_result(result)
+        result[:value]
+      end
+
+      def ensure_enumerable(tuples)
+        if tuples.is_a?(Array)
+          tuples
+        else
+          [tuples]
+        end
+      end
+
+      def operator(operand)
+        op = if self.class.operand_mapper
+               self.class.operand_mapper.call(operand)
+             else
+               operand
+             end
+
+        Types::Operation[operator: self.class.adwords_operator, operand: op]
+      end
+    end
+  end
+end