sendgrid_webapi 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c4750102028a182ab7e513792ca0f127684c5ce2f59562dbe1997869c7099e9
-  data.tar.gz: 406420e68b953fca19e900acd80ab5914c689941588c4b056239f2f5f64f6971
+  metadata.gz: 3d193cbbc918879debc5aee92e0f7397be4f83a4d876bac7a049dd42c9a9a671
+  data.tar.gz: ae235e49239b82ed69de5c93654555cc93f702e6905928e6fb89de0fc6427fe5
 SHA512:
-  metadata.gz: d912c4463cb6cf6b77d55444e31302450e395c4b2c0eb14bbd4345b77d83dfbba7b3b5b9b563b0e0fff577a5989a00255c69d731d56c08495bd727eb3f15c358
-  data.tar.gz: 445d7ef45b7cb2b7325405120ef271ab1c6b13d50a902e83c63e5bebe16f95889c722f06555adedabb08ba4e70eb652eeec810a6a29f4d285dea64ec51def652
+  metadata.gz: b65c616400aeeaa7e5bfff61f0626635558986679c3f56b4dc9e42c165c68cdf7998a4b8574a1cc60d2b0c96ce3f18982dfb2d69c197ce065ad29a2285e500fa
+  data.tar.gz: 12c01121d669de6b3bdc22d5b44b6036152b8e06495f56542acb541f1600b360f154cfdf1dac279bd94648f0be85587009ae70c9a054f75e99f4aec816fd6f73

data/.tekton/Chart.lock

@@ -0,0 +1,6 @@
+dependencies:
+- name: gem-delivery
+  repository: oci://us-docker.pkg.dev/onehq-production/onehq-public/
+  version: 0.1.0-dev.7
+digest: sha256:b52b9dc05efeb3ce5eaa793726defb2787e0f27baa6effd2040c998f7be0adce
+generated: "2021-03-27T22:26:28.397590199+01:00"

data/.tekton/Chart.yaml

@@ -0,0 +1,14 @@
+apiVersion: v2
+name: pipeline
+description: A Helm chart for Kubernetes
+
+type: application
+
+version: 0.1.0
+
+dependencies:
+- name: ruby-pipelines
+  alias: delivery
+  version: "0.2.0-dev.2"
+  repository: "oci://public.ecr.aws/c6o8b8d1"
+

data/.tekton/templates/pipelinerun.yaml

@@ -0,0 +1,53 @@
+apiVersion: tekton.dev/v1beta1
+kind: PipelineRun
+metadata:
+  name: {{ .Release.Name }}-{{ .Release.Revision }}
+  annotations:
+    "helm.sh/hook": post-upgrade,post-install
+spec:
+  serviceAccountName: build-bot
+  params:
+  - name: ci-image-name
+    value: 237082684006.dkr.ecr.us-east-2.amazonaws.com/{{ .Values.gem }}-ci
+  - name: gem-name
+    value: "{{ .Values.gem }}"
+  - name: publish
+    value: '{{ .Values.publish }}'
+  - name: git-url
+    value: "https://{{ .Values.git.provider }}/{{ .Values.git.organization }}/{{ .Values.git.repository }}.git"
+  - name: git-sha
+    value: "{{ .Values.git.sha }}"
+  - name: git-ref
+    value: "{{ required "Required .Values.git.ref" .Values.git.ref }}"
+  - name: rubyVersion
+    value: "{{ .Values.global.rubyVersion }}"
+  - name: run-rubocop
+    value: "{{ .Values.global.runRubocop }}"
+  - name: gem-repository
+    value: "{{ .Values.global.gemRepository }}"
+  workspaces:
+
+
+  pipelineRef:
+    name: gem-delivery
+  timeout: 1h30m0s
+  podTemplate:
+    volumes:
+    - name: oidc-token
+      projected:
+        sources:
+          - serviceAccountToken:
+              path: oidc-token
+              expirationSeconds: 1800
+
+  workspaces:
+    - name: git-source
+      volumeClaimTemplate:
+        spec:
+          storageClassName: rwm
+          accessModes:
+            - ReadWriteMany # access mode may affect how you can use this volume in parallel tasks
+          resources:
+            requests:
+              storage: 1Gi
+              

data/.tekton/values-main.yaml

@@ -0,0 +1,14 @@
+publish: true
+
+delivery:
+  rbac:
+    rolebindings:
+      - role: edit
+        subjects:
+          - kind: Group
+            name: hq-platform
+
+      - role: view
+        subjects:
+          - kind: Group
+            name: hq-product

data/.tekton/values-pr.yaml

@@ -0,0 +1,8 @@
+publish: false
+delivery:
+  rbac:
+    rolebindings:
+      - role: edit
+        subjects:
+          - kind: Group
+            name: hq-product

data/.tekton/values.yaml

@@ -0,0 +1,19 @@
+publish: false
+
+gem: &gem sendgrid_webapi
+git:
+  provider: github.com
+  organization: OneHQ
+  repository: *gem
+
+global:
+  taskAnnotations: 
+    vault.security.banzaicloud.io/vault-addr: "https://vault-onehq.apps.hub.internal.onehq.com"
+    vault.security.banzaicloud.io/vault-path: "jwt-hub"
+    vault.security.banzaicloud.io/vault-auth-method: "jwt"
+    vault.security.banzaicloud.io/vault-tls-secret: "custom-trusted-ca"  
+  gem: *gem
+  rubyVersion: 3.0.2
+  mountGemDockerfile: true
+  runRubocop: "false"
+  gemRepository: rubygems

data/README.rdoc

@@ -26,51 +26,102 @@ for sendgrid v2 support
 === Bounces
 This module allows you to retrieve and delete email addresses that have bounced from emails that you've delivered.
 
-    client.bounces.get(options)
-
-    client.bounces.delete(:email => "email@example.com", :foor => "bar")
-
+    # Retrieve all of your bounces.
+    # A maximum of 500 bounces will be returned per query.
+    # You can use the offset and limit parameters to retrieve more or less than 500 results.
+    # You can use the start_time and end_time parameters to filter by time frames.
+    # * https://docs.sendgrid.com/api-reference/bounces-api/retrieve-all-bounces
+    # i.e client.bounces.get({ "on_behalf_of": "sub_user_email"})
+    # i.e using limit/offset: client.bounces.get({ on_behalf_of: "sub_user_email", limit: 100, offset: 1 })
+    client.bounces.get (options)
+
+    # This method will delete all bounces from the given email.
+    # * https://docs.sendgrid.com/api-reference/bounces-api/delete-a-bounce
+    # i.e: client.bounces.delete( { on_behalf_of: "sub_user_email", email: "email@to.delete" })
+    client.bounces.delete(options)
+
+    # Deprecated: Count is no longer supported on SendGrid v3.
+    # As an alternative, SendGrid recommends to query depending on time frames since `get` limit is 500.
+    # Deprecated, under the hood it's doing a get an returning the count
     client.blocks.count
 
-* options are available here: http://sendgrid.com/docs/API_Reference/Web_API/bounces.html
+* options are available here: https://docs.sendgrid.com/api-reference/bounces-api
 
 === Blocks
 This module allows you to retrieve and delete email addresses that were blocked by their ISP. These emails are not suppressed and are just for information.
-
+    # Retrieve all of your blocks.
+    # A maximum of 500 blocks will be returned per query.
+    # You can use the offset and limit parameters to retrieve more or less than 500 results.
+    # You can use the start_time and end_time parameters to filter by time frames.
+    #* https://docs.sendgrid.com/api-reference/blocks-api/retrieve-all-blocks
+    # i.e: client.blocks.get({ on_behalf_of: "sub_user_email", limit: 100, offset: 1 })
     client.blocks.get(options)
-
-    client.blocks.delete(:email => "email@example.com", :foor => "bar")
-
+    
+
+    # This method will delete all blocks from the given email
+    # * https://docs.sendgrid.com/api-reference/blocks-api/delete-blocks
+    # i.e: client.blocks.delete( { on_behalf_of: "sub_user_email", email: "email@example.com" })
+    client.blocks.delete(options)
+    
+    # Deprecated: Count is no longer supported on SendGrid v3.
+    # As an alternative, SendGrid recommends to query depending on time frames since `get` limit is 500.
     client.blocks.count
 
-* options are available here: http://sendgrid.com/docs/API_Reference/Web_API/blocks.html
+* options are available here: https://docs.sendgrid.com/api-reference/blocks-api
 
 === Invalid Email
 This module allows you to retrieve and delete email addresses that you've sent to that are invalid email addresses.
-
+    # Retrieve a list of all invalid email addresses.
+    # You can use the offset and limit parameters to retrieve a custom number of results.
+    # You can use the start_time and end_time parameters to filter by time frames.
+    # * https://docs.sendgrid.com/api-reference/invalid-e-mails-api/retrieve-all-invalid-emails
+    # i.e: client.invalid_emails.get({ on_behalf_of: "sub_user_email", limit: 100, offset: 1 })
     client.invalid_emails.get(options)
 
-    client.invalid_emails.delete(:email => "email@example.com", :foor => "bar")
+    # This method will delete all invalid_emails from the given email
+    # * https://docs.sendgrid.com/api-reference/invalid-e-mails-api/delete-a-specific-invalid-email
+    # i.e: client.invalid_emails.delete( { on_behalf_of: "sub_user_email", email: "email@example.com" })
+    client.invalid_emails.delete(options)
 
-* options are available here: http://sendgrid.com/docs/API_Reference/Web_API/invalid_emails.html
+* options are available here: https://docs.sendgrid.com/api-reference/invalid-e-mails-api
 
 === Spam Report
 This module allows you to retrieve and delete email addresses that have marked your emails as SPAM.
-
+    # Retrieve a list of all spam reports.
+    # You can use the offset and limit parameters to retrieve a custom number of results.
+    # You can use the start_time and end_time parameters to filter by time frames.
+    # * https://docs.sendgrid.com/api-reference/spam-reports-api/retrieve-all-spam-reports
+    # i.e: client.spam.get({ on_behalf_of: "sub_user_email", limit: 100, offset: 1 })
     client.spam.get(options)
 
-    client.spam.delete(:email => "email@example.com", :foor => "bar")
+    # This method will delete all spam_reports from the given email.
+    # * https://docs.sendgrid.com/api-reference/spam-reports-api/delete-a-specific-spam-report
+    # i.e: client.spam.delete( { on_behalf_of: "sub_user_email", email: "email@example.com" })
+    client.spam.delete(options)
 
 * options are available here: http://sendgrid.com/docs/API_Reference/Web_API/spam_reports.html
 
 === Unsubscribes
 This module allows you to add, retrieve and delete email addresses that were unsubscribed from your emails.
 
-    client.unsubscribes.add(:email => "email@example.com", :foor => "bar")
-
+    
+    # Example @email_client.send(:unsubscribes).delete( { email: "test@example.com", on_behalf_of: "sub_user_email" })
+    # * https://docs.sendgrid.com/api-reference/suppressions-global-suppressions/add-recipient-addresses-to-the-global-suppression-group
+    # i.e: client.unsubscribes.add( { on_behalf_of: "sub_user_email, recipient_emails: ["test@example.com"] })
+    client.unsubscribes.add(options)
+
+    # Retrieve a list of all email address that are globally suppressed.
+    # You can use the offset and limit parameters to retrieve a custom number of results.
+    # You can use the start_time and end_time parameters to filter by time frames.
+    # * https://docs.sendgrid.com/api-reference/suppressions-global-suppressions/retrieve-all-global-suppressions
+    # client.unsubscribes.get({ on_behalf_of: "sub_user_email", limit: 100, offset: 1 })
     client.unsubscribes.get(options)
 
-    client.unsubscribes.delete(:email => "email@example.com", :foor => "bar")
+
+    # This method will delete all unsubscribes from the given email
+    # * https://docs.sendgrid.com/api-reference/suppressions-global-suppressions/delete-a-global-suppression
+    # i.e: client.unsubscribes.delete( { on_behalf_of: "sub_user_email", email: "email@example.com" })
+    client.unsubscribes.delete(options)
 
 * options are available here: http://sendgrid.com/docs/API_Reference/Web_API/unsubscribes.html
 

data/lib/base.rb

@@ -71,5 +71,12 @@ module SendGridWebApi
         conn.adapter Faraday.default_adapter
       end
     end
+
+    private
+    def process_header_options options
+      on_behalf_of = options.delete(:on_behalf_of)
+      options.merge!({ headers: { "on-behalf-of" => on_behalf_of } }) unless on_behalf_of.nil?
+      options
+    end
   end
 end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module SendGridWebApi
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/web_api/blocks.rb

@@ -1,18 +1,31 @@
 module SendGridWebApi::Modules
   class Block < SendGridWebApi::Client
+    BLOCKS_URL = "suppression/blocks"
+
+    def base_url
+      "https://api.sendgrid.com/v3/"
+    end
+
+    # Retrieve all of your blocks.
+    # A maximum of 500 blocks will be returned per query.
+    # You can use the offset and limit parameters to retrieve more or less than 500 results.
+    # You can use the start_time and end_time parameters to filter by time frames.
     def get options = {}
-      block_get_url = "blocks.get.json"
-      query_api(block_get_url, options)
+      query_api(BLOCKS_URL, process_header_options(options))
     end
 
+    # This method will delete all blocks from the given email
     def delete options = {}
-      block_delete_url = "blocks.delete.json"
-      query_api(block_delete_url, options)
+      delete_url = BLOCKS_URL+"/#{options[:email]}"
+      options.delete(:email)
+      query_delete_api(delete_url, process_header_options(options))
     end
 
+    # Deprecated: Count is no longer supported on SendGrid v3.
+    # As an alternative, SendGrid recommends to query depending on time frames since `get` limit is 500.
     def count options = {}
-      block_count_url = "blocks.count.json"
-      query_api(block_count_url, options)
+      count = query_api(BLOCKS_URL, process_header_options(options)).count
+      {count: count}
     end
   end  
-end
+end

data/lib/web_api/bounces.rb

@@ -1,18 +1,31 @@
 module SendGridWebApi::Modules
   class Bounce < SendGridWebApi::Client
+    BOUNCES_URL = "suppression/bounces"
+
+    def base_url
+      "https://api.sendgrid.com/v3/"
+    end
+
+    # Retrieve all of your bounces.
+    # A maximum of 500 bounces will be returned per query.
+    # You can use the offset and limit parameters to retrieve more or less than 500 results.
+    # You can use the start_time and end_time parameters to filter by time frames.
     def get options = {}
-      bounce_get_url = "bounces.get.json"
-      query_api(bounce_get_url, options)
+      query_api(BOUNCES_URL, process_header_options(options))
     end
 
+    # This method will delete all bounces from the given email.
     def delete options = {}
-      bounce_delete_url = "bounces.delete.json"
-      query_api(bounce_delete_url, options)
+      delete_url = BOUNCES_URL+"/#{options[:email]}"
+      options.delete(:email)
+      query_delete_api(delete_url, process_header_options(options))
     end
 
+    # Deprecated: Count is no longer supported on SendGrid v3.
+    # As an alternative, SendGrid recommends to query depending on time frames since `get` limit is 500.
     def count options = {}
-      bounces_count_url = "bounces.count.json"
-      query_api(bounces_count_url, options)
+      count = query_api(BOUNCES_URL, process_header_options(options)).count
+      {count: count}
     end
   end
 end

data/lib/web_api/invalid_emails.rb

@@ -1,13 +1,23 @@
 module SendGridWebApi::Modules
   class InvalidEmail < SendGridWebApi::Client
+    INVALID_EMAILS_URL = "suppression/invalid_emails"
+
+    def base_url
+      "https://api.sendgrid.com/v3/"
+    end
+
+    # Retrieve a list of all invalid email addresses.
+    # You can use the offset and limit parameters to retrieve a custom number of results.
+    # You can use the start_time and end_time parameters to filter by time frames.
     def get options = {}
-      invalid_email_get_url = "invalidemails.get.json"
-      query_api(invalid_email_get_url, options)
+      query_api(INVALID_EMAILS_URL, process_header_options(options))
     end
 
+    # This method will delete all invalid_emails from the given email
     def delete options = {}
-      invalid_email_delete_url = "invalidemails.delete.json"
-      query_api(invalid_email_delete_url, options)
-    end    
+      delete_url = INVALID_EMAILS_URL+"/#{options[:email]}"
+      options.delete(:email)
+      query_delete_api(delete_url, process_header_options(options))
+    end
   end
 end

data/lib/web_api/spam.rb

@@ -1,13 +1,23 @@
 module SendGridWebApi::Modules
   class Spam < SendGridWebApi::Client
+    SPAM_REPORTS_URL = "suppression/spam_reports"
+
+    def base_url
+      "https://api.sendgrid.com/v3/"
+    end
+
+    # Retrieve a list of all spam reports.
+    # You can use the offset and limit parameters to retrieve a custom number of results.
+    # You can use the start_time and end_time parameters to filter by time frames.
     def get options = {}
-      spam_get_url = "spamreports.get.json"
-      query_api(spam_get_url, options)
+      query_api(SPAM_REPORTS_URL, process_header_options(options))
     end
 
+    # This method will delete all spam_reports from the given email.
     def delete options = {}
-      spam_delete_url = "spamreports.delete.json"
-      query_api(spam_delete_url, options)
+      delete_url = SPAM_REPORTS_URL+"/#{options[:email]}"
+      options.delete(:email)
+      query_delete_api(delete_url, process_header_options(options))
     end
   end
 end

data/lib/web_api/unsubscribes.rb

@@ -1,18 +1,31 @@
 module SendGridWebApi::Modules
   class Unsubscribe < SendGridWebApi::Client
+    def base_url
+      "https://api.sendgrid.com/v3/"
+    end
+
+    # Retrieve a list of all email address that are globally suppressed.
+    # You can use the offset and limit parameters to retrieve a custom number of results.
+    # You can use the start_time and end_time parameters to filter by time frames.
     def get options = {}
-      unsubscribe_get_url = "unsubscribes.get.json"
-      query_api(unsubscribe_get_url, options)
+      unsubscribe_url = "suppression/unsubscribes"
+      query_api(unsubscribe_url, process_header_options(options))
     end
 
+    # Add one or more email addresses to the global suppressions group.
+    # Expects options => recipient_emails: ["test@example.com"]
     def add options = {}
-      unsubscribe_add_url = "unsubscribes.add.json"
-      query_api(unsubscribe_add_url, options)
+    unsubscribe_url = "asm/suppressions/global"
+      query_post_json_api(unsubscribe_url, process_header_options(options))
     end
 
+    # This method will delete all unsubscribes from the given email
     def delete options = {}
-      unsubscribe_delete_url = "unsubscribes.delete.json"
-      query_api(unsubscribe_delete_url, options)
+      unsubscribe_url = "asm/suppressions/global"
+      delete_url = unsubscribe_url + "/#{options[:email]}"
+      options.delete(:email)
+
+      query_delete_api(delete_url, process_header_options(options))
     end
   end
 end

data/spec/cassettes/client/_modules/_block/should_get_block_emails.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.sendgrid.com/api/blocks.get.json
+    uri: https://api.sendgrid.com/v3/suppression/blocks
     body:
       encoding: US-ASCII
       string: ''

data/spec/cassettes/client/_modules/_block/should_get_totals_blocks.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.sendgrid.com/api/blocks.count.json
+    uri: https://api.sendgrid.com/v3/suppression/blocks
     body:
       encoding: US-ASCII
       string: ''
@@ -30,7 +30,7 @@ http_interactions:
       - keep-alive
     body:
       encoding: UTF-8
-      string: '{"count": 0}'
+      string: '[]'
     http_version: 
   recorded_at: Fri, 17 Jan 2014 01:37:40 GMT
 recorded_with: VCR 2.8.0

data/spec/cassettes/client/_modules/_block/should_try_delete_not_existing_block_email.yml

@@ -1,8 +1,8 @@
 ---
 http_interactions:
 - request:
-    method: get
-    uri: https://api.sendgrid.com/api/blocks.delete.json?email=test@example.com
+    method: delete
+    uri: https://api.sendgrid.com/v3/suppression/blocks/test@example.com
     body:
       encoding: US-ASCII
       string: ''

data/spec/cassettes/client/_modules/_bounce/should_get_bounce_emails.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.sendgrid.com/api/bounces.get.json
+    uri: https://api.sendgrid.com/v3/suppression/bounces
     body:
       encoding: US-ASCII
       string: ''

data/spec/cassettes/client/_modules/_bounce/should_get_bounce_emails_using_params.yml

@@ -0,0 +1,36 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.sendgrid.com/v3/suppression/bounces?limit=2&offset=1
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.9
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.4.2
+      Date:
+      - Fri, 17 Jan 2014 01:39:31 GMT
+      Content-Type:
+      - text/html
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '["email1@test.com", "email2@test.com"]'
+    http_version: 
+  recorded_at: Fri, 17 Jan 2014 01:39:31 GMT
+recorded_with: VCR 2.8.0