braze_ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c0406b29e745be8bd5e98d2353edb96e5753c12
+  data.tar.gz: ff30b73feb4b87a7bc02ad38a8b4b359490c2427
+SHA512:
+  metadata.gz: e22f67115caaa99d694cae39b5e2c930c352d037939313ce7ba82426c4197c094588305d4f3fa51329d3aefbc2177f1addcd07ea1dbd0a3403c43e97e995b931
+  data.tar.gz: 54ae4986cfe73d3dddff37450bf947187aaf4b36ebbb7585b9050c6ecc34d753e6e439eaeac1c62ef78ef9bf02f376d169d564836656bd192bb1d091c0aaeefb

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.ruby-version
+.env
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in braze_ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Josh Nussbaum
+
+MIT License
+
+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,157 @@
+# BrazeRuby
+
+A wrapper for the Braze REST API. Forked from https://github.com/DynamoMTL/appboy
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'braze_ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install braze_ruby
+
+## Examples
+
+### Initializing API
+
+```ruby
+api = BrazeRuby::API.new('<braze-rest-api-key>', '<braze-rest-api-url')
+```
+
+### Track User Attributes
+
+```ruby
+api.track_users(attributes: [{
+  external_id: 123,
+  first_name: 'John',
+  last_name: 'Smith',
+  gender: 'male',
+  email: 'jsmith@example.com'
+}])
+```
+
+##### Track Attributes for Single User
+
+```ruby
+api.track_attribute(external_id: 123, first_name: 'John', ...)
+```
+
+### Track Event
+
+```ruby
+api.track_users(events: [{
+  external_id: 123,
+  name: 'add-to-cart',
+  time: Time.now
+}])
+```
+
+##### Track Events for Single User
+
+```ruby
+api.track_event(external_id: 123, name: 'Event', ...)
+```
+
+### Track Purchase
+
+```ruby
+api.track_users(purchases: [{
+  external_id: 123,
+  product_id: 456,
+  currency: 'CAD',
+  price: 1.99,
+  time: Time.now
+}])
+```
+
+##### Track Purchases for Single User
+
+```ruby
+api.track_purchase(external_id: 123, product_id: 456, ...)
+```
+
+### Track Everything for Everyone All at Once
+
+```ruby
+api.track_users(purchases: purchases, events: events, attributes: attributes)
+```
+
+### Send Message
+
+##### Messages Payload
+
+```ruby
+messages = {
+  android_push: { alert: 'Hello Android' },
+  apple_push:   { alert: "Hello iOS" }
+}
+```
+
+##### Option A, Using External User IDs
+
+```ruby
+api.send_messages(messages: messages, external_user_ids: [123, 456])
+```
+
+##### Option B, Using Segment ID
+
+```ruby
+api.send_messages(messages: messages, segment_id: '<segment-id>')
+```
+
+
+### Schedule Message
+
+```ruby
+api.schedule_messages(send_at: 1.hour.since, messages: messages, external_user_ids: [123, 456])
+```
+
+### Changing Email Subscription
+
+```ruby
+api.email_status(email: 'john@example.com', status: :opted_in)
+```
+
+### List Segments
+
+```ruby
+api.list_segments
+```
+
+### Export Users
+
+#### By IDs
+
+```ruby
+api.export_users(external_ids: [1])
+```
+
+#### By Segment
+
+```ruby
+api.export_users(segment_id: segment_id, callback_endpoint: 'https://example.com')
+```
+
+## Debugging
+
+The BRAZE_RUBY_DEBUG environment variable will trigger full printouts of the Faraday gem's HTTP requests and responses.
+
+```bash
+cd /my/app
+export BRAZE_RUBY_DEBUG=true
+bundle exec rails whatever
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/braze_ruby.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'braze_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'braze_ruby'
+  spec.version       = BrazeRuby::VERSION
+  spec.authors       = ['Josh Nussbaum', 'Hugo Bastien', 'Justin Boltz']
+  spec.email         = %w(josh@godynamo.com hugo@godynamo.com justin.boltz@takl.com)
+  spec.description   = %q{Braze wrapper}
+  spec.summary       = %q{A wrapper for the Braze REST API forked from the appboy gem, track users/events/purchases, send & schedule messages}
+  spec.homepage      = 'http://braze.com'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency 'virtus'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'activesupport'
+  spec.add_development_dependency 'factory_bot'
+end

data/lib/braze_ruby.rb

@@ -0,0 +1,9 @@
+require 'json'
+require 'virtus'
+require 'braze_ruby/version'
+
+module BrazeRuby
+  autoload :API, 'braze_ruby/api'
+  autoload :REST, 'braze_ruby/rest'
+  autoload :Endpoints, 'braze_ruby/endpoints'
+end

data/lib/braze_ruby/api.rb

@@ -0,0 +1,31 @@
+require 'braze_ruby/deprecated'
+require 'braze_ruby/endpoints/track_users'
+require 'braze_ruby/endpoints/send_messages'
+require 'braze_ruby/endpoints/schedule_messages'
+require 'braze_ruby/endpoints/email_status'
+
+module BrazeRuby
+  class API
+    include BrazeRuby::Deprecated
+
+    include BrazeRuby::Endpoints::TrackUsers
+    include BrazeRuby::Endpoints::SendMessages
+    include BrazeRuby::Endpoints::ScheduleMessages
+    include BrazeRuby::Endpoints::EmailStatus
+
+    def export_users(**payload)
+      BrazeRuby::REST::ExportUsers.new(braze_url).perform(api_key, payload)
+    end
+
+    def list_segments
+      BrazeRuby::REST::ListSegments.new(braze_url).perform(api_key)
+    end
+
+    attr_reader :api_key, :braze_url
+
+    def initialize(api_key, braze_url)
+      @api_key = api_key
+      @braze_url = braze_url
+    end
+  end
+end

data/lib/braze_ruby/deprecated.rb

@@ -0,0 +1,19 @@
+module BrazeRuby
+  module Deprecated
+    def track(attribute, events = [], purchases = [])
+      warn('[BrazeRuby] `track` is deprecated. Please use `track_users` instead.')
+      track_users(attribute: attribute, events: events, purchases: purchases)
+    end
+
+    def send_message(message, user_ids, segment_ids = nil)
+      warn('[BrazeRuby] `send_message` is deprecated. Please use `send_messages` instead.')
+      send_messages(messages: message, user_ids: user_ids, segment_ids: segment_ids)
+    end
+
+    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)
+    end
+  end
+end

data/lib/braze_ruby/endpoints.rb

@@ -0,0 +1,4 @@
+require 'braze_ruby/endpoints/email_status'
+require 'braze_ruby/endpoints/schedule_messages'
+require 'braze_ruby/endpoints/send_messages'
+require 'braze_ruby/endpoints/track_users'

data/lib/braze_ruby/endpoints/email_status.rb

@@ -0,0 +1,13 @@
+module BrazeRuby
+  module Endpoints
+    module EmailStatus
+      def email_status(**payload)
+        email_status_service.new(api_key, braze_url, payload).perform
+      end
+
+      def email_status_service
+        BrazeRuby::REST::EmailStatus
+      end
+    end
+  end
+end

data/lib/braze_ruby/endpoints/schedule_messages.rb

@@ -0,0 +1,15 @@
+module BrazeRuby
+  module Endpoints
+    module ScheduleMessages
+      def schedule_messages(**payload)
+        schedule_messages_service.new(api_key, braze_url, payload).perform
+      end
+
+      private
+
+      def schedule_messages_service
+        BrazeRuby::REST::ScheduleMessages
+      end
+    end
+  end
+end

data/lib/braze_ruby/endpoints/send_messages.rb

@@ -0,0 +1,15 @@
+module BrazeRuby
+  module Endpoints
+    module SendMessages
+      def send_messages(**payload)
+        send_messages_service.new(api_key, braze_url, payload).perform
+      end
+
+      private
+
+      def send_messages_service
+        BrazeRuby::REST::SendMessages
+      end
+    end
+  end
+end

data/lib/braze_ruby/endpoints/track_users.rb

@@ -0,0 +1,29 @@
+module BrazeRuby
+  module Endpoints
+    module TrackUsers
+      attr_writer :track_users_service
+
+      def track_users(**payload)
+        track_users_service.perform(api_key, payload)
+      end
+
+      def track_purchase(payload)
+        track_users(purchases: [payload])
+      end
+
+      def track_event(payload)
+        track_users(events: [payload])
+      end
+
+      def track_attribute(payload)
+        track_users(attributes: [payload])
+      end
+
+      private
+
+      def track_users_service
+        @track_users_service ||= BrazeRuby::REST::TrackUsers.new(braze_url)
+      end
+    end
+  end
+end

data/lib/braze_ruby/http.rb

@@ -0,0 +1,30 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module BrazeRuby
+  class HTTP
+    def initialize(braze_url)
+      @braze_url = braze_url
+    end
+
+    def post(path, payload)
+      connection.post path do |request|
+        request.body = payload
+      end
+    end
+
+    def get(path, query)
+      connection.get path, query
+    end
+
+    def connection
+      @connection ||= Faraday.new(url: @braze_url) do |connection|
+        connection.request :json
+
+        connection.response :logger if ENV['BRAZE_RUBY_DEBUG']
+
+        connection.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest.rb

@@ -0,0 +1,7 @@
+require 'braze_ruby/rest/base'
+require 'braze_ruby/rest/track_users'
+require 'braze_ruby/rest/send_messages'
+require 'braze_ruby/rest/schedule_messages'
+require 'braze_ruby/rest/email_status'
+require 'braze_ruby/rest/export_users'
+require 'braze_ruby/rest/list_segments'

data/lib/braze_ruby/rest/base.rb

@@ -0,0 +1,19 @@
+require 'braze_ruby/http'
+
+module BrazeRuby
+  module REST
+    class Base
+      attr_writer :http
+
+      def initialize(braze_url)
+        @braze_url = braze_url
+      end
+
+      private
+
+      def http
+        @http ||= BrazeRuby::HTTP.new(@braze_url)
+      end
+    end
+  end
+end