braze_ruby 0.0.1

data/spec/fixtures/responses/track_users/with_success/responds_with_created.yml

@@ -0,0 +1,71 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: "<BRAZE_REST_URL>/users/track"
+    body:
+      encoding: UTF-8
+      string: '{"api_key":"<BRAZE_REST_API_KEY>","attributes":[{"external_id":1,"foo":"bar"}],"events":[{"external_id":1,"name":"baz","time":"2019-02-15
+        00:00:00 -0500"}],"purchases":[{"external_id":1,"product_id":1,"time":"2019-02-15
+        00:00:00 -0500","currency":"CAD","price":1.0}]}'
+    headers:
+      User-Agent:
+      - Faraday v0.14.0
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Content-Type:
+      - application/json
+      Etag:
+      - W/"68b326343749fed4d6cc5dda395b5367"
+      Server:
+      - nginx
+      Strict-Transport-Security:
+      - max-age=0; includeSubDomains
+      - max-age=31536000; includeSubDomains
+      X-Ratelimit-Limit:
+      - '50000'
+      X-Ratelimit-Remaining:
+      - '50000'
+      X-Ratelimit-Reset:
+      - '1524002400'
+      X-Request-Id:
+      - af452a7f-9be9-417d-b9d5-2c4db3de274d
+      X-Runtime:
+      - '0.020310'
+      Content-Length:
+      - '85'
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Tue, 17 Apr 2018 21:08:07 GMT
+      Via:
+      - 1.1 varnish
+      Connection:
+      - keep-alive
+      X-Served-By:
+      - cache-pdk17837-PDK
+      X-Cache:
+      - MISS
+      X-Cache-Hits:
+      - '0'
+      X-Timer:
+      - S1523999287.293178,VS0,VE220
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: ASCII-8BIT
+      string: '{"attributes_processed":1,"events_processed":1,"purchases_processed":1,"message":"success"}'
+    http_version: 
+  recorded_at: Tue, 17 Apr 2018 21:08:07 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/responses/track_users/with_success/responds_with_success_message.yml

@@ -0,0 +1,71 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: "<BRAZE_REST_URL>/users/track"
+    body:
+      encoding: UTF-8
+      string: '{"api_key":"<BRAZE_REST_API_KEY>","attributes":[{"external_id":1,"foo":"bar"}],"events":[{"external_id":1,"name":"baz","time":"2019-02-15
+        00:00:00 -0500"}],"purchases":[{"external_id":1,"product_id":1,"time":"2019-02-15
+        00:00:00 -0500","currency":"CAD","price":1.0}]}'
+    headers:
+      User-Agent:
+      - Faraday v0.14.0
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Content-Type:
+      - application/json
+      Etag:
+      - W/"68b326343749fed4d6cc5dda395b5367"
+      Server:
+      - nginx
+      Strict-Transport-Security:
+      - max-age=0; includeSubDomains
+      - max-age=31536000; includeSubDomains
+      X-Ratelimit-Limit:
+      - '50000'
+      X-Ratelimit-Remaining:
+      - '50000'
+      X-Ratelimit-Reset:
+      - '1524002400'
+      X-Request-Id:
+      - e810e390-4c31-49ac-abd4-5b1151cc3c33
+      X-Runtime:
+      - '0.012176'
+      Content-Length:
+      - '85'
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Tue, 17 Apr 2018 21:08:07 GMT
+      Via:
+      - 1.1 varnish
+      Connection:
+      - keep-alive
+      X-Served-By:
+      - cache-pdk17824-PDK
+      X-Cache:
+      - MISS
+      X-Cache-Hits:
+      - '0'
+      X-Timer:
+      - S1523999288.612820,VS0,VE214
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: ASCII-8BIT
+      string: '{"attributes_processed":1,"events_processed":1,"purchases_processed":1,"message":"success"}'
+    http_version: 
+  recorded_at: Tue, 17 Apr 2018 21:08:07 GMT
+recorded_with: VCR 4.0.0

data/spec/integrations/email_status_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe 'email status' do
+  let(:email) { 'john@example.com' }
+  let(:status) { :unsubscribed }
+
+  subject do
+    api.email_status(email: email, status: status)
+  end
+
+  context 'existing email', vcr: true do
+    it 'responds with created' do
+      expect(subject.status).to be 201
+    end
+
+    it 'responds with success message' do
+      expect(JSON.parse(subject.body)).to eq(
+        'message' => 'success'
+      )
+    end
+  end
+
+  context 'unknown email', vcr: true do
+    let(:email) { 'notthere@example.com' }
+
+    it 'responds with bad request' do
+      expect(subject.status).to be 201
+    end
+
+    it 'responds with success message' do
+      expect(JSON.parse(subject.body)).to eq(
+        'message' => 'success'
+      )
+    end
+  end
+end

data/spec/integrations/export_users_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe 'export users' do
+  context 'by ids' do
+    subject(:export_users) { api.export_users(external_ids: [1]) }
+
+    context 'with success', :vcr do
+      it 'responds with created' do
+        expect(export_users).to be_success
+      end
+    end
+  end
+
+  context 'by segment' do
+    context 'with success', :vcr do
+      let(:segment_id) { braze_test_segment }
+
+      subject(:export_users) do
+        api.export_users(segment_id: segment_id, callback_endpoint: 'https://example.com')
+      end
+
+      it 'responds with created' do
+        expect(export_users).to be_success
+      end
+    end
+  end
+end

data/spec/integrations/list_segments_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe 'list segments' do
+  subject(:list_segments) { api.list_segments }
+
+  context 'with success', :vcr do
+    it 'responds with success' do
+      expect(list_segments).to be_success
+    end
+
+    it 'responds with a list of segments' do
+      expect(segments.count).to be 13
+    end
+
+    def segments
+      JSON.parse(list_segments.body)['segments']
+    end
+  end
+end

data/spec/integrations/schedule_messages_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe 'schedule messages' do
+  let(:user_ids) { [1] }
+  let(:messages) { build(:messages) }
+
+  subject(:schedule_messages) do
+    api.schedule_messages(time: test_time,
+      messages: messages, external_user_ids: user_ids)
+  end
+
+  context 'with success', vcr: true do
+    it 'responds with created' do
+      expect(schedule_messages.status).to be 201
+    end
+
+    it 'responds with success message' do
+      expect(JSON.parse(schedule_messages.body)).to include(
+          'message' => 'success'
+        )
+    end
+  end
+
+  context 'unauthorized', vcr: true do
+    let(:api_key) { 'non-existent' }
+
+    it 'responds with unauthorize' do
+      expect(schedule_messages.status).to be 401
+    end
+  end
+end

data/spec/integrations/send_messages_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe 'send messages' do
+  let(:user_ids) { [1] }
+  let(:messages) { build(:messages) }
+
+  subject(:send_messages) do
+    api.send_messages(messages: messages, external_user_ids: user_ids)
+  end
+
+  context 'with success', vcr: true do
+    it 'responds with created' do
+      expect(send_messages.status).to be 201
+    end
+
+    it 'responds with success message' do
+      expect(JSON.parse(send_messages.body)).to eq(
+          'message' => 'success'
+        )
+    end
+  end
+
+  context 'unauthorized', vcr: true do
+    let(:api_key) { 'non-existent' }
+
+    it 'responds with unauthorized' do
+      expect(send_messages.status).to be 401
+    end
+  end
+end

data/spec/integrations/track_users_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe 'track users' do
+  let(:attributes) { [build(:attribute)] }
+  let(:events) { [build(:event, time: test_time)] }
+  let(:purchases) { [build(:purchase, time: test_time)] }
+
+  subject(:track_users) do
+    api.track_users(attributes: attributes,
+      events: events, purchases: purchases)
+  end
+
+  context 'with success', vcr: true do
+    it 'responds with created' do
+      expect(track_users.status).to be 201
+    end
+
+    it 'responds with success message' do
+      expect(JSON.parse(track_users.body)).to eq(
+          'attributes_processed' => 1,
+          'events_processed' => 1,
+          'purchases_processed' => 1,
+          'message' => 'success'
+        )
+    end
+  end
+
+  context 'unauthorized', vcr: true do
+    let(:api_key) { 'non-existent' }
+
+    it 'responds with unauthorized' do
+      expect(track_users.status).to be 401
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'pry'
+require 'dotenv'
+require 'bundler/setup'
+
+Bundler.setup
+Dotenv.load
+
+require 'braze_ruby'
+require 'support/vcr'
+require 'support/factory_bot'
+require 'support/integrations'
+
+RSpec.configure do |config|
+  def test_time
+    Time.parse('2019-02-15 00:00:00 -0500')
+  end
+
+  def braze_rest_api_key
+    'test'
+  end
+
+  def braze_rest_url
+    'https://rest.iad-03.braze.com'
+  end
+
+  def braze_test_segment
+    'a8fde797-4c44-4406-8e6c-5850d323f169'
+  end
+end

data/spec/support/factory_bot.rb

@@ -0,0 +1,10 @@
+require 'factory_bot'
+require 'factories'
+
+RSpec.configure do |config|
+  config.include FactoryBot::Syntax::Methods
+
+  config.before(:suite) do
+    FactoryBot.lint
+  end
+end

data/spec/support/integrations.rb

@@ -0,0 +1,20 @@
+require 'active_support/concern'
+
+module Integrations
+  extend ActiveSupport::Concern
+
+  included do
+    let(:api_key) { braze_rest_api_key }
+    let(:rest_url) { braze_rest_url }
+    let(:segment_id) { braze_test_segment }
+
+    let(:api) { BrazeRuby::API.new(api_key, rest_url) }
+
+
+
+  end
+
+  RSpec.configure do |config|
+    config.include self, type: :integrations, file_path: %r(spec/integrations)
+  end
+end

data/spec/support/vcr.rb

@@ -0,0 +1,16 @@
+require 'vcr'
+
+VCR.configure do |config|
+  config.filter_sensitive_data('<BRAZE_REST_API_KEY>') { ENV.fetch('BRAZE_REST_API_KEY') }
+  config.filter_sensitive_data('<BRAZE_REST_URL>') { ENV.fetch('BRAZE_REST_URL')}
+
+  config.cassette_library_dir = 'spec/fixtures/responses'
+
+  config.default_cassette_options = {
+    match_requests_on: [:method, :uri, :body]
+  }
+
+  config.configure_rspec_metadata!
+
+  config.hook_into :webmock
+end

metadata

@@ -0,0 +1,312 @@
+--- !ruby/object:Gem::Specification
+name: braze_ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Josh Nussbaum
+- Hugo Bastien
+- Justin Boltz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Braze wrapper
+email:
+- josh@godynamo.com
+- hugo@godynamo.com
+- justin.boltz@takl.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- braze_ruby.gemspec
+- lib/braze_ruby.rb
+- lib/braze_ruby/api.rb
+- lib/braze_ruby/deprecated.rb
+- lib/braze_ruby/endpoints.rb
+- lib/braze_ruby/endpoints/email_status.rb
+- lib/braze_ruby/endpoints/schedule_messages.rb
+- lib/braze_ruby/endpoints/send_messages.rb
+- lib/braze_ruby/endpoints/track_users.rb
+- lib/braze_ruby/http.rb
+- lib/braze_ruby/rest.rb
+- lib/braze_ruby/rest/base.rb
+- lib/braze_ruby/rest/email_status.rb
+- lib/braze_ruby/rest/export_users.rb
+- lib/braze_ruby/rest/list_segments.rb
+- lib/braze_ruby/rest/schedule_messages.rb
+- lib/braze_ruby/rest/send_messages.rb
+- lib/braze_ruby/rest/track_users.rb
+- lib/braze_ruby/version.rb
+- spec/braze_ruby/api_spec.rb
+- spec/braze_ruby/endpoints/track_users_spec.rb
+- spec/braze_ruby/rest/email_status_spec.rb
+- spec/braze_ruby/rest/export_users_spec.rb
+- spec/braze_ruby/rest/schedule_messages_spec.rb
+- spec/braze_ruby/rest/send_messages_spec.rb
+- spec/braze_ruby/rest/track_users_spec.rb
+- spec/factories.rb
+- spec/fixtures/responses/email_status/existing_email/responds_with_created.yml
+- spec/fixtures/responses/email_status/existing_email/responds_with_success_message.yml
+- spec/fixtures/responses/email_status/unknown_email/responds_with_bad_request.yml
+- spec/fixtures/responses/email_status/unknown_email/responds_with_success_message.yml
+- spec/fixtures/responses/export_users/by_ids/with_success/responds_with_created.yml
+- spec/fixtures/responses/export_users/by_segment/with_success/responds_with_created.yml
+- spec/fixtures/responses/list_segments/with_success/responds_with_a_list_of_segments.yml
+- spec/fixtures/responses/list_segments/with_success/responds_with_success.yml
+- spec/fixtures/responses/schedule_messages/unauthorized/responds_with_unauthorize.yml
+- spec/fixtures/responses/schedule_messages/with_success/responds_with_created.yml
+- spec/fixtures/responses/schedule_messages/with_success/responds_with_success_message.yml
+- spec/fixtures/responses/send_messages/unauthorized/responds_with_unauthorized.yml
+- spec/fixtures/responses/send_messages/with_success/responds_with_created.yml
+- spec/fixtures/responses/send_messages/with_success/responds_with_success_message.yml
+- spec/fixtures/responses/track_users/unauthorized/responds_with_unauthorized.yml
+- spec/fixtures/responses/track_users/with_success/responds_with_created.yml
+- spec/fixtures/responses/track_users/with_success/responds_with_success_message.yml
+- spec/integrations/email_status_spec.rb
+- spec/integrations/export_users_spec.rb
+- spec/integrations/list_segments_spec.rb
+- spec/integrations/schedule_messages_spec.rb
+- spec/integrations/send_messages_spec.rb
+- spec/integrations/track_users_spec.rb
+- spec/spec_helper.rb
+- spec/support/factory_bot.rb
+- spec/support/integrations.rb
+- spec/support/vcr.rb
+homepage: http://braze.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: A wrapper for the Braze REST API forked from the appboy gem, track users/events/purchases,
+  send & schedule messages
+test_files:
+- spec/braze_ruby/api_spec.rb
+- spec/braze_ruby/endpoints/track_users_spec.rb
+- spec/braze_ruby/rest/email_status_spec.rb
+- spec/braze_ruby/rest/export_users_spec.rb
+- spec/braze_ruby/rest/schedule_messages_spec.rb
+- spec/braze_ruby/rest/send_messages_spec.rb
+- spec/braze_ruby/rest/track_users_spec.rb
+- spec/factories.rb
+- spec/fixtures/responses/email_status/existing_email/responds_with_created.yml
+- spec/fixtures/responses/email_status/existing_email/responds_with_success_message.yml
+- spec/fixtures/responses/email_status/unknown_email/responds_with_bad_request.yml
+- spec/fixtures/responses/email_status/unknown_email/responds_with_success_message.yml
+- spec/fixtures/responses/export_users/by_ids/with_success/responds_with_created.yml
+- spec/fixtures/responses/export_users/by_segment/with_success/responds_with_created.yml
+- spec/fixtures/responses/list_segments/with_success/responds_with_a_list_of_segments.yml
+- spec/fixtures/responses/list_segments/with_success/responds_with_success.yml
+- spec/fixtures/responses/schedule_messages/unauthorized/responds_with_unauthorize.yml
+- spec/fixtures/responses/schedule_messages/with_success/responds_with_created.yml
+- spec/fixtures/responses/schedule_messages/with_success/responds_with_success_message.yml
+- spec/fixtures/responses/send_messages/unauthorized/responds_with_unauthorized.yml
+- spec/fixtures/responses/send_messages/with_success/responds_with_created.yml
+- spec/fixtures/responses/send_messages/with_success/responds_with_success_message.yml
+- spec/fixtures/responses/track_users/unauthorized/responds_with_unauthorized.yml
+- spec/fixtures/responses/track_users/with_success/responds_with_created.yml
+- spec/fixtures/responses/track_users/with_success/responds_with_success_message.yml
+- spec/integrations/email_status_spec.rb
+- spec/integrations/export_users_spec.rb
+- spec/integrations/list_segments_spec.rb
+- spec/integrations/schedule_messages_spec.rb
+- spec/integrations/send_messages_spec.rb
+- spec/integrations/track_users_spec.rb
+- spec/spec_helper.rb
+- spec/support/factory_bot.rb
+- spec/support/integrations.rb
+- spec/support/vcr.rb