braze_ruby 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae77ca2f5ea9cf492d7f681c37fcbff40f912b8ce8ac9db237a9b91e8c5fc76a
-  data.tar.gz: 033f2a42048dfff0af864534900a5405ba5a56099e3630c23512f73a30a56468
+  metadata.gz: c00945c683cf1036e050a2268b6b79b8cde870b94a0e81de114a40088b4993c8
+  data.tar.gz: b96dacd6c85d3fe8aa3584f98e21f9876a1fbfa97120da01f410d8dcaf31826e
 SHA512:
-  metadata.gz: 67d8ff06c45f2e3d90e000c9093118c80d85136e77961cf5cf6bbdf1d45dd57b704905b1ff5388413df142773cd2e76a2473e92b9e2edcdbc85752ed09a6d111
-  data.tar.gz: 409c1603839abd4bf95c0096c54c936ea6fa438f350d368b8e3e117b1d1a17a082c55991c53fd4d75c2b67a2649792c01330db2e7f58ef94896cd00fe8f5bbaf
+  metadata.gz: 3ac7068ab004e42ec49d1e222ff945af8899d7b43a0bae95f9d93fa4a2d2873a3fb19236d1f5984b86c48c833f6d6ae6ce80d81fd061403709a11b2d7d34636b
+  data.tar.gz: d5ad50ff9090f009d1c461819f7c2d9327f37789720f26e21158a0e1b4178ea3aa3c4089b97be8940a45207cfc92a7193323f7214a83e8679002e84783cc4fc6

data/.circleci/config.yml

@@ -1,5 +1,4 @@
 version: 2.1
-
 jobs:
   test:
     parameters:
@@ -9,49 +8,19 @@ jobs:
       - image: << parameters.ruby-version >>
     steps:
       - checkout
-
       - run:
           name: Gem install bundler
           command: gem update --system && gem install bundler
-
       - run:
           name: Bundle install
           command: bundle install --jobs=4 --retry=3 --path vendor/bundle
-
       - run:
           name: Run tests
           command: bundle exec rake
-
-  publish:
-    docker:
-      - image: ruby:3.0.0
-    steps:
-      - checkout
-
-      - run:
-          name: Setup Rubygems
-          command: bash .circleci/setup-rubygems
-
-      - run:
-          name: Build gem
-          command: gem build braze_ruby.gemspec --output braze_ruby.gem
-
-      - run:
-          name: Publish gem
-          command: gem push braze_ruby.gem
-
 workflows:
   all-tests:
     jobs:
       - test:
           matrix:
             parameters:
-              ruby-version: ["ruby:3.0.0", "ruby:2.7.2", "ruby:2.6.3"]
-  release:
-    jobs:
-      - publish:
-          filters:
-            tags:
-              only: /^v.*/
-            branches:
-              ignore: /.*/
+              ruby-version: ["ruby:3.0.1", "ruby:2.7.3", "ruby:2.6.7"]

data/.github/workflows/release.yml

@@ -0,0 +1,20 @@
+name: release
+on:
+  push:
+    tags:
+      - v*
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup rubygems
+        run: |
+          mkdir ~/.gem
+          cp ./.github/workflows/gem_credentials ~/.gem/credentials
+          chmod 0600 ~/.gem/credentials
+          sed -i "s/REPLACE_ME/${{ secrets.RUBYGEMS_KEY }}/g" ~/.gem/credentials
+      - name: Build gem
+        run: gem build braze_ruby.gemspec --output braze_ruby.gem
+      - name: Publish gem
+        run: gem push braze_ruby.gem

data/README.md

@@ -246,6 +246,11 @@ api.email_unsubscribes(email: ['jdoe@example.com'])
 api.email_hard_bounces(email: ['jdoe@example.com'])
 ```
 
+#### Remove Email Addresses From Spam List
+```ruby
+api.remove_emails_from_spam(email: ['jdoe@example.com'])
+```
+
 ## Debugging
 
 The BRAZE_RUBY_DEBUG environment variable will trigger full printouts of the Faraday gem's HTTP requests and responses.

data/lib/braze_ruby/api.rb

@@ -12,6 +12,7 @@ require "braze_ruby/endpoints/canvas"
 require "braze_ruby/endpoints/subscription"
 require "braze_ruby/endpoints/rename_external_ids"
 require "braze_ruby/endpoints/remove_external_ids"
+require "braze_ruby/endpoints/remove_email_addresses_from_spam"
 
 module BrazeRuby
   class API
@@ -30,6 +31,7 @@ module BrazeRuby
     include BrazeRuby::Endpoints::CreateUserAliases
     include BrazeRuby::Endpoints::RenameExternalIds
     include BrazeRuby::Endpoints::RemoveExternalIds
+    include BrazeRuby::Endpoints::RemoveEmailAddressesFromSpam
 
     def export_users(**payload)
       BrazeRuby::REST::ExportUsers.new(api_key, braze_url, options).perform(**payload)

data/lib/braze_ruby/deprecated.rb

@@ -14,8 +14,7 @@ module BrazeRuby
 
     def schedule_message(date, message, segment_id, local_timezone = false)
       warn("[BrazeRuby] `schedule_message` is deprecated. Please use `schedule_messages` instead.")
-      schedule_messages(send_at: date, messages: message,
-                        segment_id: segment_id, local_timezone: local_timezone)
+      schedule_messages(send_at: date, messages: message, segment_id: segment_id, local_timezone: local_timezone)
     end
   end
 end

data/lib/braze_ruby/endpoints.rb

@@ -10,3 +10,4 @@ require "braze_ruby/endpoints/identify_users"
 require "braze_ruby/endpoints/create_user_aliases"
 require "braze_ruby/endpoints/rename_external_ids"
 require "braze_ruby/endpoints/remove_external_ids"
+require "braze_ruby/endpoints/remove_email_addresses_from_spam"

data/lib/braze_ruby/endpoints/remove_email_addresses_from_spam.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module Endpoints
+    module RemoveEmailAddressesFromSpam
+      attr_writer :remove_emails_from_spam_service
+
+      def remove_emails_from_spam(**payload)
+        remove_emails_from_spam_service.perform(**payload)
+      end
+
+      private
+
+      def remove_emails_from_spam_service
+        @remove_emails_from_spam_service ||= BrazeRuby::REST::RemoveEmailAddressesFromSpam.new(api_key, braze_url, options)
+      end
+    end
+  end
+end

data/lib/braze_ruby/http.rb

@@ -6,6 +6,7 @@ require "faraday"
 module BrazeRuby
   class HTTP
     DEFAULT_TIMEOUT = 30
+    DEFAULT_OPEN_TIMEOUT = 5
 
     def initialize(api_key, braze_url, options = {})
       @api_key = api_key
@@ -31,17 +32,19 @@ module BrazeRuby
         connection.headers["Authorization"] = "Bearer #{@api_key}"
 
         connection.response :logger if ENV["BRAZE_RUBY_DEBUG"]
+        connection.request :retry, @options[:retry] if @options[:retry]
 
         connection.adapter Faraday.default_adapter
 
         connection.options[:timeout] = @options[:timeout]
+        connection.options[:open_timeout] = @options[:open_timeout]
       end
     end
 
     private
 
     def default_options
-      {timeout: DEFAULT_TIMEOUT}
+      {timeout: DEFAULT_TIMEOUT, open_timeout: DEFAULT_OPEN_TIMEOUT}
     end
   end
 end

data/lib/braze_ruby/rest.rb

@@ -20,3 +20,4 @@ require "braze_ruby/rest/identify_users"
 require "braze_ruby/rest/create_user_aliases"
 require "braze_ruby/rest/rename_external_ids"
 require "braze_ruby/rest/remove_external_ids"
+require "braze_ruby/rest/remove_email_addresses_from_spam"

data/lib/braze_ruby/rest/export_users.rb

@@ -4,17 +4,17 @@ module BrazeRuby
   module REST
     class ExportUsers < Base
       def perform(external_ids: nil, segment_id: nil, **options)
-        return export_users_by_ids(external_ids) if external_ids
+        return export_users_by_ids(external_ids, options) if external_ids
 
         export_users_by_segment(segment_id, options) if segment_id
       end
 
       private
 
-      def export_users_by_ids(external_ids)
+      def export_users_by_ids(external_ids, options)
         http.post "/users/export/ids", {
           external_ids: external_ids
-        }
+        }.merge(options)
       end
 
       def export_users_by_segment(segment_id, options)

data/lib/braze_ruby/rest/remove_email_addresses_from_spam.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module REST
+    class RemoveEmailAddressesFromSpam < Base
+      def perform(email: [])
+        http.post "/email/spam/remove", {
+          email: email
+        }
+      end
+    end
+  end
+end

data/lib/braze_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BrazeRuby
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: braze_ruby
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Josh Nussbaum
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-06 00:00:00.000000000 Z
+date: 2021-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -150,8 +150,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
-- ".circleci/gem_credentials"
-- ".circleci/setup-rubygems"
+- ".github/workflows/gem_credentials"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".rspec"
 - ".standard.yml"
@@ -172,6 +172,7 @@ files:
 - lib/braze_ruby/endpoints/email_status.rb
 - lib/braze_ruby/endpoints/email_sync.rb
 - lib/braze_ruby/endpoints/identify_users.rb
+- lib/braze_ruby/endpoints/remove_email_addresses_from_spam.rb
 - lib/braze_ruby/endpoints/remove_external_ids.rb
 - lib/braze_ruby/endpoints/rename_external_ids.rb
 - lib/braze_ruby/endpoints/schedule_messages.rb
@@ -190,6 +191,7 @@ files:
 - lib/braze_ruby/rest/export_users.rb
 - lib/braze_ruby/rest/identify_users.rb
 - lib/braze_ruby/rest/list_segments.rb
+- lib/braze_ruby/rest/remove_email_addresses_from_spam.rb
 - lib/braze_ruby/rest/remove_external_ids.rb
 - lib/braze_ruby/rest/rename_external_ids.rb
 - lib/braze_ruby/rest/schedule_messages.rb
@@ -222,7 +224,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A wrapper gem for the Braze REST API.

data/.circleci/setup-rubygems

@@ -1,6 +0,0 @@
-#! /bin/sh
-
-mkdir -p ~/.gem
-cp ./.circleci/gem_credentials ~/.gem/credentials
-chmod 0600 ~/.gem/credentials
-sed -i "s/REPLACE_ME/${RUBYGEMS_API_KEY}/g" ~/.gem/credentials