Merge pull request #13 from fivetran/feature/v2-updates

Feature/v2 updates

.github/pull_request_template.md

@@ -1,4 +1,3 @@
-Pull Request
 **Are you a current Fivetran customer?** 
 <!--- Please tell us your name, title and company -->
 

.gitignore

@@ -2,5 +2,6 @@
 target/
 dbt_modules/
 logs/
-
+.DS_Store
+integration_tests/.DS_Store
 dbt_packages/

CHANGELOG.md

@@ -1,3 +1,31 @@
+# dbt_twitter_source v0.5.0
+
+## 🎉 Feature Enhancements 🎉
+PR [#13](https://github.com/fivetran/dbt_twitter_source/pull/13) includes the following changes:
+- Addition of the following staging models which pull from the source counterparts. The inclusion of the additional `_report` source tables is to generate a more accurate representation of the Twitter Ads data:
+  - `stg_twitter_ads__line_item_report`
+  - `stg_twitter_ads__account_report`
+  - `stg_twitter_ads__campaign_report`
+  - `stg_twitter_ads__line_item_keywords_report`: This can be disabled by setting the `twitter_ads__using_keywords` variable to `False`.
+  - `stg_twitter_ads__tweet`
+
+- Inclusion of passthrough metrics:
+  - `twitter_ads__line_item_report_passthrough_metrics`
+  - `twitter_ads__campaign_report_passthrough_metrics`
+  - `twitter_ads__line_item_keywords_report_passthrough_metrics`
+  - `twitter_ads__promoted_tweet_report_passthrough_metrics`
+> This applies to all passthrough columns within the `dbt_twitter_source` package and not just the `twitter_ads__line_item_report_passthrough_metrics` example.
+```yml
+vars:
+  twitter_ads__line_item_report_passthrough_metrics:
+    - name: "my_field_to_include" # Required: Name of the field within the source.
+      alias: "field_alias" # Optional: If you wish to alias the field within the staging model.
+```
+
+- README updates for easier navigation and use of the package.
+- Addition of identifier variables for each of the source tables to allow for further flexibility in source table direction within the dbt project.
+- Addition of grain uniqueness tests for each staging table.
+
 # dbt_twitter_source v0.4.1
 ## Fixes
 - Changes the partition order for the following models so that the `is_latest_version` flag identifies the last updated row.
@@ -8,6 +36,7 @@
 ## Contributors
 - [@dlubawy](https://github.com/dlubawy) ([#15](https://github.com/fivetran/dbt_twitter_source/pull/15))
 
+
 # dbt_twitter_source v0.4.0
 🎉 dbt v1.0.0 Compatibility 🎉
 ## 🚨 Breaking Changes 🚨

README.md

@@ -1,80 +1,140 @@
-[![Apache License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
-# Twitter Ads (Source)
+<p align="center">
+    <a alt="License"
+        href="https://github.com/fivetran/dbt_twitter_source/blob/main/LICENSE">
+        <img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" /></a>
+    <a alt="dbt-core">
+        <img src="https://img.shields.io/badge/dbt_Core™_version->=1.0.0_<2.0.0-orange.svg" /></a>
+    <a alt="Maintained?">
+        <img src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" /></a>
+    <a alt="PRs">
+        <img src="https://img.shields.io/badge/Contributions-welcome-blueviolet" /></a>
+</p>
+
+# Twitter Ads Source dbt Package ([Docs](https://fivetran.github.io/dbt_twitter_source/))
+
+# 📣 What does this dbt package do?
+- Materializes [Twitter Ads staging tables](https://fivetran.github.io/dbt_twitter_source/#!/overview/twitter_source/models/?g_v=1&g_e=seeds) which leverage data in the format described by [this ERD](https://fivetran.com/docs/applications/twitter-ads#schemainformation). These staging tables clean, test, and prepare your Twitter Ads data from [Fivetran's connector](https://fivetran.com/docs/applications/twitter-ads) for analysis by doing the following:
+  - Name columns for consistency across all packages and for easier analysis
+  - Adds freshness tests to source data
+  - Adds column-level testing where applicable. For example, all primary keys are tested for uniqueness and non-null values.
+- Generates a comprehensive data dictionary of your Twitter Ads data through the [dbt docs site](https://fivetran.github.io/dbt_twitter_source/).
+- These tables are designed to work simultaneously with our [Twitter Ads transformation package](https://github.com/fivetran/dbt_twitter).
+
+# 🎯 How do I use the dbt package?
+## Step 1: Prerequisites
+To use this dbt package, you must have the following:
+- At least one Fivetran Twitter Ads connector syncing data into your destination. 
+- A **BigQuery**, **Snowflake**, **Redshift**, **PostgreSQL**, or **Databricks** destination.
 
-This package models Twitter Ads data from [Fivetran's connector](https://fivetran.com/docs/applications/twitter-ads). It uses data in the format described by [this ERD](https://fivetran.com/docs/applications/twitter-ads#schemainformation).
-
-## Models
-
-This package contains staging models, designed to work simultaneously with our [Twitter Ads transform package](https://github.com/fivetran/dbt_twitter) and our [multi-platform Ad Reporting package](https://github.com/fivetran/dbt_ad_reporting). The staging models name columns consistently across all packages:
- * Boolean fields are prefixed with `is_` or `has_`
- * Timestamps are appended with `_timestamp`
- * ID primary keys are prefixed with the name of the table. For example, the campaign table's ID column is renamed `campaign_id`.
-
-## Installation Instructions
-Check [dbt Hub](https://hub.getdbt.com/) for the latest installation instructions, or [read the dbt docs](https://docs.getdbt.com/docs/package-management) for more information on installing packages.
+### Databricks Dispatch Configuration
+If you are using a Databricks destination with this package you will need to add the below (or a variation of the below) dispatch configuration within your `dbt_project.yml`. This is required in order for the package to accurately search for macros within the `dbt-labs/spark_utils` then the `dbt-labs/dbt_utils` packages respectively.
+```yml
+dispatch:
+  - macro_namespace: dbt_utils
+    search_order: ['spark_utils', 'dbt_utils']
+```
 
-Include in your `packages.yml`
+## Step 2: Install the package
+Include the following twitter_source package version in your `packages.yml` file.
+> TIP: Check [dbt Hub](https://hub.getdbt.com/) for the latest installation instructions or [read the dbt docs](https://docs.getdbt.com/docs/package-management) for more information on installing packages.
 
-```yaml
+```yml
+# packages.yml
 packages:
-  - package: fivetran/twitter_ads_source
-    version: [">=0.4.0", "<0.5.0"]
+  - package: fivetran/twitter_source
+    version: [">=0.5.0", "<0.6.0"]
 ```
 
-## Configuration
-By default, this package will look for your Twitter Ads data in the `twitter_ads` schema of your [target database](https://docs.getdbt.com/docs/running-a-dbt-project/using-the-command-line-interface/configure-your-profile). If this is not where your Twitter Ads data is, please add the following configuration to your `dbt_project.yml` file:
+## Step 3: Define database and schema variables
+By default, this package runs using your destination and the `twitter_ads` schema. If this is not where your Twitter Ads data is (for example, if your twitter schema is named `twitter_fivetran`), add the following configuration to your root `dbt_project.yml` file:
 
 ```yml
 # dbt_project.yml
-
-...
-config-version: 2
-
 vars:
     twitter_ads_schema: your_schema_name
-    twitter_ads_database: your_database_name 
+    twitter_ads_database: your_destination_name 
+```
+
+### Step 4: Disabling Keyword Models
+This package takes into consideration that not every Twitter Ads account tracks `keyword` performance, and allows you to disable the corresponding functionality by adding the following variable configuration:
+```yml
+# dbt_project.yml
+vars:
+    twitter_ads__using_keywords: False # Default = true
 ```
-### Changing the Build Schema
-By default this package will build the Twitter Ads staging models within a schema titled (<target_schema> + `_stg_twitter_ads`) in your target database. If this is not where you would like your Twitter Ads staging data to be written to, add the following configuration to your `dbt_project.yml` file:
+
+## (Optional) Step 5: Additional configurations
+<details><summary>Expand for configurations</summary>
+
+### Passing Through Additional Metrics
+By default, this package will select `clicks`, `impressions`, and `cost` from the source reporting tables to store into the staging models. If you would like to pass through additional metrics to the staging models, add the below configurations to your `dbt_project.yml` file. These variables allow for the pass-through fields to be aliased (`alias`) if desired, but not required. Use the below format for declaring the respective pass-through variables:
+
+>**Note** Please ensure you exercised due diligence when adding metrics to these models. The metrics added by default (taps, impressions, and spend) have been vetted by the Fivetran team maintaining this package for accuracy. There are metrics included within the source reports, for example metric averages, which may be inaccurately represented at the grain for reports created in this package. You will want to ensure whichever metrics you pass through are indeed appropriate to aggregate at the respective reporting levels provided in this package.
 
 ```yml
 # dbt_project.yml
+vars:
+    twitter_ads__campaign_report_passthrough_metrics: 
+        - name: "new_custom_field"
+          alias: "custom_field"
+    twitter_ads__line_item_report_passthrough_metrics: 
+        - name: "unique_int_field"
+          alias: "field_id"
+    twitter_ads__line_item_keywords_report_passthrough_metrics: 
+        - name: "that_field"
+    twitter_ads__promoted_tweet_report_passthrough_metrics: 
+        - name: "that_field"
+```
+
+### Change the build schema
+By default, this package builds the Twitter Ads staging models within a schema titled (`<target_schema>` + `_twitter_ads_source`) in your destination. If this is not where you would like your Twitter staging data to be written to, add the following configuration to your root `dbt_project.yml` file:
 
-...
+```yml
+# dbt_project.yml
 models:
     twitter_ads_source:
-      +schema: my_new_schema_name # leave blank for just the target_schema
+        +schema: my_new_schema_name # leave blank for just the target_schema
 ```
-## Database Support
 
-This package has been tested on BigQuery, Snowflake, Redshift, Postgres, and Databricks.
-
-### Databricks Dispatch Configuration
-dbt `v0.20.0` introduced a new project-level dispatch configuration that enables an "override" setting for all dispatched macros. If you are using a Databricks destination with this package you will need to add the below (or a variation of the below) dispatch configuration within your `dbt_project.yml`. This is required in order for the package to accurately search for macros within the `dbt-labs/spark_utils` then the `dbt-labs/dbt_utils` packages respectively.
+### Change the source table references
+If an individual source table has a different name than the package expects, add the table name as it appears in your destination to the respective variable:
+> IMPORTANT: See this project's [`dbt_project.yml`](https://github.com/fivetran/dbt_twitter_source/blob/main/dbt_project.yml) variable declarations to see the expected names.
+    
 ```yml
 # dbt_project.yml
+vars:
+    twitter_ads_<default_source_table_name>_identifier: your_table_name 
+```
 
-dispatch:
-  - macro_namespace: dbt_utils
-    search_order: ['spark_utils', 'dbt_utils']
+</details>
+
+## (Optional) Step 6: Orchestrate your models with Fivetran Transformations for dbt Core™
+<details><summary>Expand for details</summary>
+
+Fivetran offers the ability for you to orchestrate your dbt project through [Fivetran Transformations for dbt Core™](https://fivetran.com/docs/transformations/dbt). Learn how to set up your project for orchestration through Fivetran in our [Transformations for dbt Core™ setup guides](https://fivetran.com/docs/transformations/dbt#setupguide).
+
+</details>
+
+# 🔍 Does this package have dependencies?
+This dbt package is dependent on the following dbt packages. Please be aware that these dependencies are installed by default within this package. For more information on the following packages, refer to the [dbt hub](https://hub.getdbt.com/) site.
+> IMPORTANT: If you have any of these dependent packages in your own `packages.yml` file, we highly recommend that you remove them from your root `packages.yml` to avoid package version conflicts.
+
+```yml
+packages:
+    - package: fivetran/fivetran_utils
+      version: [">=0.3.0", "<0.4.0"]
+    - package: dbt-labs/dbt_utils
+      version: [">=0.8.0", "<0.9.0"]
 ```
 
+# 🙌 How is this package maintained and can I contribute?
+## Package Maintenance
+The Fivetran team maintaining this package _only_ maintains the latest version of the package. We highly recommend that you stay consistent with the [latest version](https://hub.getdbt.com/fivetran/twitter_source/latest/) of the package and refer to the [CHANGELOG](https://github.com/fivetran/dbt_twitter_source/blob/main/CHANGELOG.md) and release notes for more information on changes across versions.
+
 ## Contributions
+A small team of analytics engineers at Fivetran develops these dbt packages. However, the packages are made better by community contributions!
 
-Additional contributions to this package are very welcome! Please create issues
-or open PRs against `master`. Check out 
-[this post](https://discourse.getdbt.com/t/contributing-to-a-dbt-package/657) 
-on the best workflow for contributing to a package.
-
-## Resources:
-- Provide [feedback](https://www.surveymonkey.com/r/DQ7K7WW) on our existing dbt packages or what you'd like to see next
-- Have questions, feedback, or need help? Book a time during our office hours [using Calendly](https://calendly.com/fivetran-solutions-team/fivetran-solutions-team-office-hours) or email us at [email protected]
-- Find all of Fivetran's pre-built dbt packages in our [dbt hub](https://hub.getdbt.com/fivetran/)
-- Learn how to orchestrate your models with [Fivetran Transformations for dbt Core™](https://fivetran.com/docs/transformations/dbt)
-- Learn more about Fivetran overall [in our docs](https://fivetran.com/docs)
-- Check out [Fivetran's blog](https://fivetran.com/blog)
-- Learn more about dbt [in the dbt docs](https://docs.getdbt.com/docs/introduction)
-- Check out [Discourse](https://discourse.getdbt.com/) for commonly asked questions and answers
-- Join the [chat](http://slack.getdbt.com/) on Slack for live discussions and support
-- Find [dbt events](https://events.getdbt.com) near you
-- Check out [the dbt blog](https://blog.getdbt.com/) for the latest news on dbt's development and best practices
+# 🏪 Are there any resources available?
+- If you have questions or want to reach out for help, please refer to the [GitHub Issue](https://github.com/fivetran/dbt_twitter_source/issues/new/choose) section to find the right avenue of support for you.
+- If you would like to provide feedback to the dbt package team at Fivetran or would like to request a new dbt package, fill out our [Feedback Form](https://www.surveymonkey.com/r/DQ7K7WW).
+- Have questions or want to just say hi? Book a time during our office hours [on Calendly](https://calendly.com/fivetran-solutions-team/fivetran-solutions-team-office-hours) or email us at [email protected].

dbt_project.yml

@@ -1,10 +1,16 @@
 name: 'twitter_ads_source'
-version: '0.4.1'
+version: '0.5.0'
+
 config-version: 2
 require-dbt-version: [">=1.0.0", "<2.0.0"]
+
 models:
   twitter_ads_source:
-    +schema: stg_twitter_ads
+    +materialized: table
+    +schema: twitter_ads_source
+    tmp:
+      +materialized: view
+
 vars:
   twitter_ads_source:
     account_history: "{{ source('twitter_ads','account_history') }}"
@@ -13,3 +19,12 @@ vars:
     promoted_tweet_history: "{{ source('twitter_ads','promoted_tweet_history') }}"
     promoted_tweet_report: "{{ source('twitter_ads','promoted_tweet_report') }}"
     tweet_url: "{{ source('twitter_ads','tweet_url') }}"
+    tweet: "{{ source('twitter_ads','tweet') }}"
+    campaign_report: "{{ source('twitter_ads','campaign_report') }}"
+    line_item_report: "{{ source('twitter_ads','line_item_report') }}"
+    line_item_keywords_report: "{{ source('twitter_ads','line_item_keywords_report') }}"
+
+    twitter_ads__campaign_report_passthrough_metrics: []
+    twitter_ads__line_item_report_passthrough_metrics: []
+    twitter_ads__line_item_keywords_report_passthrough_metrics: []
+    twitter_ads__promoted_tweet_report_passthrough_metrics: []