Merge pull request #25 from fivetran/release/v0.6.0

Release/v0.6.0

.circleci/config.yml

@@ -22,6 +22,16 @@ jobs:
             pip install -r integration_tests/requirements.txt
             mkdir -p ~/.dbt
             cp integration_tests/ci/sample.profiles.yml ~/.dbt/profiles.yml
+      - run:
+          name: "Run Tests - Postgres"
+          command: |
+            . venv/bin/activate
+            echo `pwd`
+            cd integration_tests
+            dbt deps
+            dbt seed --target postgres --full-refresh
+            dbt run --target postgres --full-refresh
+            dbt test --target postgres
       - run:
           name: "Run Tests - Redshift"
           command: |

CHANGELOG.md

@@ -1,3 +1,21 @@
+# dbt_asana_source v0.6.0
+🛠 Deprecated columns fix 🛠
+## 🚨 Breaking Changes 🚨
+- As per our Release Notes for the Asana connector, this new version of the package removes deprecated columns from the Task table (https://fivetran.com/docs/applications/asana/changelog#june2021) - please refer to the June 2021 and May 2021 release notes. The following columns have been deprecated from the Task table:
+  - `assingee_status`
+  - `hearted` - the `liked` column has been added to replace hearted
+  - `num_hearts` - the `num_likes` column has been added to replace num_hearts
+Please be sure to update your queries.
+
+## 🎉 Features 🎉
+PR [#24](https://github.com/fivetran/dbt_asana_source/pull/24) introduced the following updates.
+- PostgreSQL compatibility 
+- Updated README for enhanced user experience
+- Add source identifiers to give users more dynamic flexibility
+
+## Contributors
+- @fivetran-poonamagate ([#21](https://github.com/fivetran/dbt_asana_source/pull/21)).
+
 # dbt_asana_source v0.5.1
 ## Under the Hood
 - Leveraged the `{{ dbt_utils.type_timestamp() }}` macro within the staging models for all timestamp fields. 

README.md

@@ -1,92 +1,113 @@
-[![Apache License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
-# Asana 
-
-This package models Asana data from [Fivetran's connector](https://fivetran.com/docs/applications/asana). It uses data in the format described by [this ERD](https://fivetran.com/docs/applications/asana#schemainformation).
-
-This package enriches your Fivetran data by doing the following:
-* Adds descriptions to tables and columns that are synced using Fivetran
-* 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.
-* Models staging tables, which will be used in our transform package
-
-## Models
-
-This package contains staging models, designed to work simultaneously with our [Asana transform package](https://github.com/fivetran/dbt_asana).  The staging models:
-* Remove any rows that are soft-deleted
-* Name columns consistently across all packages:
-    * Boolean fields are prefixed with `is_` or `has_`
-    * Timestamps are appended with `_at`
-    * ID primary keys are prefixed with the name of the table.  For example, the user table's ID column is renamed user_id.
-    * Foreign keys include the table that they refer to. For example, the project table's owner ID column is renamed owner_user_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.
-
-Include in your `packages.yml`
-
+<p align="center">
+    <a alt="License"
+        href="https://github.com/fivetran/dbt_asana_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>
+
+# Asana Source dbt Package ([Docs](https://fivetran.github.io/dbt_asana_source/))
+# 📣 What does this dbt package do?
+- Materializes [Asana staging tables](https://fivetran.github.io/dbt_asana_source/#!/overview/asana_source/models/?g_v=1&g_e=seeds), which leverage data in the format described by [this ERD](https://fivetran.com/docs/applications/asana#schemainformation). These staging tables clean, test, and prepare your Asana data from [Fivetran's connector](https://fivetran.com/docs/applications/asana) for analysis by doing the following:
+  - Names columns for consistency across all packages and for easier analysis
+  - Removes any rows that are soft-deleted
+  - 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 Asana data through the [dbt docs site](https://fivetran.github.io/dbt_asana_source/).
+- These tables are designed to work simultaneously with our [Asana transformation package](https://github.com/fivetran/dbt_asana).
+
+# 🎯 How do I use the dbt package?
+## Step 1: Prerequisites
+To use this dbt package, you must have the following:
+
+- At least one Fivetran Asana connector syncing data into your destination.
+- A **BigQuery**, **Snowflake**, **Redshift**, or **PostgreSQL** destination.
+
+## Step 2: Install the package
+Include the following asana_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
 packages:
   - package: fivetran/asana_source
-    version: [">=0.5.0", "<0.6.0"]
+    version: [">=0.6.0", "<0.7.0"]
 ```
 
-## Configuration
-By default, this package will run using your target database and the `asana` schema. If this is not where your Asana data is (perhaps your Asana schema is `asana_fivetran`), 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 `asana` schema. If this is not where your Asana data is (for example, if your Asana schema is named `asana_fivetran`), add the following configuration to your root `dbt_project.yml` file:
 
 ```yml
-# dbt_project.yml
-
-...
 config-version: 2
 
 vars:
   asana_source:
     asana_database: your_database_name
     asana_schema: your_schema_name 
 ```
+## (Optional) Step 4: Additional configurations
+<details><summary>Expand for configurations</summary>
 
-To add additional columns to tasks use the pass-through column variable.  This is useful for adding custom fields not already included in this package.
+### Passing Through Additional Columns 
+To add additional columns to tasks use the pass-through column variable. This is useful for adding custom fields not already included in this package.
 
 ```yml
-# dbt_project.yml
-
-...
 vars:
   asana_source:
     task_pass_through_columns: [custom_status, custom_department]
 ```
 
 ### Changing the Build Schema
-By default this package will build the Asana staging models within a schema titled (<target_schema> + `_stg_asana`) in your target database. If this is not where you would like your Asana staging data to be written to, add the following configuration to your `dbt_project.yml` file:
+By default this package will build the Asana staging models within a schema titled (<target_schema> + `_stg_asana`) in your destination. If this is not where you would like your Asana staging data to be written to, add the following configuration to your root `dbt_project.yml` file:
 
 ```yml
-# dbt_project.yml
-
-...
 models:
     asana_source:
       +schema: my_new_schema_name # leave blank for just the target_schema
 ```
 
-## Database support
-This package is compatible with BigQuery, Snowflake, and Redshift.
+### 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_asana_source/blob/main/dbt_project.yml) variable declarations to see the expected names.
+
+```yml
+vars:
+    asana_<default_source_table_name>_identifier: your_table_name 
+```
+
+</details>
+
+## (Optional) Step 5: Orchestrate your models with Fivetran Transformations for dbt Core™
+<details><summary>Expand for more 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/asana_source/latest/) of the package and refer to the [CHANGELOG](https://github.com/fivetran/dbt_asana_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! 
+
+We highly encourage and welcome contributions to this package. Check out [this dbt Discourse article](https://discourse.getdbt.com/t/contributing-to-a-dbt-package/657) to learn how to contribute to a dbt package!
 
-Additional contributions to this package are very welcome! Please create issues
-or open PRs against `main`. 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_asana_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 just want to 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,7 +1,7 @@
 config-version: 2
 
 name: 'asana_source'
-version: '0.5.1'
+version: '0.6.0'
 
 require-dbt-version: [">=1.0.0", "<2.0.0"]
 

integration_tests/ci/sample.profiles.yml

@@ -16,14 +16,14 @@ integration_tests:
       pass: "{{ env_var('CI_REDSHIFT_DBT_PASS') }}"
       dbname: "{{ env_var('CI_REDSHIFT_DBT_DBNAME') }}"
       port: 5439
-      schema: asana_source_integration_tests
+      schema: asana_source_integrations_tests
       threads: 8
     bigquery:
       type: bigquery
       method: service-account
       keyfile: "{{ env_var('GCLOUD_SERVICE_KEY_PATH') }}"
       project: 'dbt-package-testing'
-      schema: asana_source_integration_tests
+      schema: asana_source_integrations_tests
       threads: 8
     snowflake:
       type: snowflake
@@ -33,5 +33,16 @@ integration_tests:
       role: "{{ env_var('CI_SNOWFLAKE_DBT_ROLE') }}"
       database: "{{ env_var('CI_SNOWFLAKE_DBT_DATABASE') }}"
       warehouse: "{{ env_var('CI_SNOWFLAKE_DBT_WAREHOUSE') }}"
-      schema: asana_source_integration_tests
-      threads: 8
+      schema: asana_source_integrations_tests
+      threads: 8
+    postgres: 
+      type: postgres
+      host: "{{ env_var('CI_POSTGRES_DBT_HOST') }}"
+      user: "{{ env_var('CI_POSTGRES_DBT_USER') }}"
+      password: "{{ env_var('CI_POSTGRES_DBT_PASS') }}"
+      port: 5432
+      dbname: "{{ env_var('CI_POSTGRES_DBT_DATABASE') }}"
+      schema: asana_source_integrations_tests
+      threads: 8
+      keepalives_idle: 0
+      sslmode: prefer

integration_tests/dbt_project.yml

@@ -1,24 +1,24 @@
 config-version: 2
 
 name: 'asana_source_integration_tests'
-version: '0.5.1'
+version: '0.6.0'
 
 profile: 'integration_tests' 
 
 vars:
-  asana_schema: asana_source_integration_tests
+  asana_schema: asana_source_integrations_tests
   asana_source:
-    user:           "{{ ref('user_data') }}" 
-    project:        "{{ ref('project_data') }}"
-    task:           "{{ ref('task_data') }}"
-    story:          "{{ ref('story_data') }}"  
-    team:           "{{ ref('team_data') }}"
-    tag:            "{{ ref('tag_data') }}"
-    project_task:   "{{ ref('project_task_data') }}" 
-    task_follower:  "{{ ref('task_follower_data') }}" 
-    task_tag:       "{{ ref('task_tag_data') }}"
-    section:        "{{ ref('section_data') }}"
-    task_section:   "{{ ref('task_section_data') }}"
+    asana_user_identifier:          "user_data"
+    asana_project_identifier:       "project_data"
+    asana_task_identifier:          "task_data"
+    asana_story_identifier:         "story_data"  
+    asana_team_identifier:          "team_data"
+    asana_tag_identifier:           "tag_data"
+    asana_project_task_identifier:  "project_task_data" 
+    asana_task_follower_identifier: "task_follower_data" 
+    asana_task_tag_identifier:      "task_tag_data"
+    asana_section_identifier:       "section_data"
+    asana_task_section_identifier:  "task_section_data"
 
 seeds:
   +quote_columns: "{{ true if target.type == 'redshift' else false }}"

macros/get_task_columns.sql

@@ -3,19 +3,18 @@
 {% set columns = [
     {"name": "_fivetran_synced", "datatype": dbt_utils.type_timestamp()},
     {"name": "assignee_id", "datatype": dbt_utils.type_string()},
-    {"name": "assignee_status", "datatype": dbt_utils.type_string()},
     {"name": "completed", "datatype": "boolean"},
     {"name": "completed_at", "datatype": dbt_utils.type_timestamp()},
     {"name": "completed_by_id", "datatype": dbt_utils.type_string()},
     {"name": "created_at", "datatype": dbt_utils.type_timestamp()},
     {"name": "due_at", "datatype": dbt_utils.type_timestamp()},
     {"name": "due_on", "datatype": dbt_utils.type_timestamp()},
-    {"name": "hearted", "datatype": "boolean"},
     {"name": "id", "datatype": dbt_utils.type_string()},
     {"name": "modified_at", "datatype": dbt_utils.type_timestamp()},
     {"name": "name", "datatype": dbt_utils.type_string()},
     {"name": "notes", "datatype": dbt_utils.type_string()},
-    {"name": "num_hearts", "datatype": dbt_utils.type_int()},
+    {"name": "liked", "datatype": "boolean"},
+    {"name": "num_likes", "datatype": dbt_utils.type_int()},
     {"name": "parent_id", "datatype": dbt_utils.type_string()},
     {"name": "start_on", "datatype": dbt_utils.type_timestamp()},
     {"name": "workspace_id", "datatype": dbt_utils.type_string()}