appboy 0.0.1 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b9b08323e1d2602a33183a99f18a06a7bb59ad1e
-  data.tar.gz: 984094644be733e86940bb0e4b6d2c0dcf397d36
+SHA256:
+  metadata.gz: 96b1b915bc01148105219d0aa25762991883ac33ecdfbc42afc2d05703bd4084
+  data.tar.gz: 23b7079dbcf8fa2dc7c095bcce30766dd542b9580d21b8eba3044275e313ba74
 SHA512:
-  metadata.gz: 4f39f353d4618c26b0b340ea7580d535042f40baf1b03e74c578d80066db094b70e65f283e1a408a54b6946087a436417788da032265e2e4168131fcce10fc8c
-  data.tar.gz: ec645bebf908780c2d633bdb18b7e211b72d304024ccf5afcb02e519921db65b49373bd3626489e4dd8573779a6ae2fcc2427fa29502800d901535907c1cbc8b
+  metadata.gz: 5636f61473d6f7c854e8086a695af8364429387b1fc710542805fe250fef63ff709265620dcc23c4eefb8cc8da394d4d5a87bbeec2830622f4c09503b1ca1781
+  data.tar.gz: e61ef8f59d13886bcc8dd62e854fa7137bde95b786599a9a7bf5f57e74d9d8a5ee9e40a443e31a31938a8b7ebd8134e6e9b981d902195f7c4ea6ea5f999c4ddd

data/.gitignore

@@ -3,6 +3,8 @@
 .bundle
 .config
 .yardoc
+.ruby-version
+.env
 Gemfile.lock
 InstalledFiles
 _yardoc

data/.rspec

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

data/README.md

@@ -1,6 +1,6 @@
 # Appboy
 
-A wrapper for the Appboy REST API using HTTParty
+A wrapper for the Appboy REST API.
 
 ## Installation
 
@@ -21,49 +21,193 @@ Or install it yourself as:
 ### Initializing API
 
 ```ruby
-api = Appboy::API.new('<secret>', '<app-group-id>')
+api = Appboy::API.new('<app-group-id>')
 ```
 
-### Track User
+By default Appboy will be using 'https://api.appboy.com' as the default REST API base url, but you can override this base url by setting the env variable `APPBOY_REST_BASE_URL`. E.G.
+
+```
+APPBOY_REST_BASE_URL="https://rest.iad-01.braze.com"
+```
+
+### Track User Attributes
+
+See: [User Attributes Object Specification](https://www.braze.com/documentation/REST_API/#user-attributes-object-specification)
 
 ```ruby
-api.track [{external_id: 123,
-            first_name: 'John',
-            last_name: 'Smith',
-            gender: 'male',
-            email: 'jsmith@example.com'}]
+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
 
+See: [Event Object Specification](https://www.braze.com/documentation/REST_API/#event-object-specification)
+
 ```ruby
-events = [
-  {external_id: 123, name: 'add-to-cart', time: Time.now}
-]
-api.track [], events
+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
+
+See: [Purchase Object Specfication](https://www.braze.com/documentation/REST_API/#purchase-object-specification)
+
+```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
 
+See: [Platform Push Object Specifications](https://www.braze.com/documentation/REST_API/#messaging)
+
+##### Messages Payload
+
 ```ruby
-message  = {android_push: {alert: 'Hello Android'},
-            apple_push:   {alert: "Hello iOS"}}
+messages = {
+  android_push: { alert: 'Hello Android' },
+  apple_push:   { alert: "Hello iOS" }
+}
+```
 
-user_ids = [123, 456]
+##### Option A, Using External User IDs
 
-api.send_message(message, 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>')
+```
+
+### Triggered Delivery Messages
+
+See: [Sending Messages via API Triggered Delivery](https://www.braze.com/documentation/REST_API/#sending-messages-via-api-triggered-delivery)
+
+##### Option A, Using Campaign ID
+```ruby
+api.trigger_campaign(
+  api_key: (required, string),
+  campaign_id: (required, string),
+  send_id: (optional, string),
+  audience: (optional, string),
+  trigger_properties: (optional, object),
+  broadcast: (optional, boolean, default, false),
+  recipients: (optional, array of recipient objects)
+)
+```
+
+##### Option B, Using Canvas ID
+
+```ruby
+api.trigger_canvas(
+  api_key: (required, string),
+  campaign_id: (required, string),
+  audience: (optional, string),
+  canvas_entry_properties: (optional, object),
+  broadcast: (optional, boolean, default, false),
+  recipients: (optional, array of recipient objects)
+)
 ```
 
 ### Schedule Message
 
+See: [Platform Push Object Specifications](https://www.braze.com/documentation/REST_API/#schedule-api-triggered-campaigns-and-canvases)
+
+```ruby
+api.schedule_messages(send_at: 1.hour.since, messages: messages, segment_id: '<segment-id>')
+```
+
+### Changing Email Subscription
+
+See: [Changing Email Subscription Status](https://www.braze.com/documentation/REST_API/#email-sync)
+
+```ruby
+api.email_status(email: 'john@example.com', status: :opted_in)
+```
+
+### List Segments
+
+See: [Segment Export](https://www.braze.com/documentation/REST_API/#segment-export)
+
 ```ruby
-message    = {android_push: {alert: 'Hello Android'},
-              apple_push:   {alert: "Hello iOS"}}
-segment_id = '<segment id>'
-send_at    = Time.new(2014, 3, 12)
+api.list_segments
+```
+
+### List Canvas
+
+See: [Segment Export](https://www.braze.com/docs/api/endpoints/export/canvas/get_canvases)
+
+```ruby
+api.list_canvas(
+  sort_direction: (optional, string, default: 'desc',
+  include_archived: (optional, boolean, default: false)
+)
+```
+
+### Export Users
+
+See: [User Export](https://www.braze.com/documentation/REST_API/#user-export)
+
+#### 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 APPBOY_DEBUG environment variable will trigger full printouts of the Faraday gem's HTTP requests and responses.
 
-api.schedule_message(send_at, message, segment_id)
+```bash
+cd /my/app
+export APPBOY_DEBUG=true
+bundle exec rails whatever
 ```
 
 ## Contributing

data/appboy.gemspec

@@ -4,22 +4,30 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'appboy/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "appboy"
+  spec.name          = 'appboy'
   spec.version       = Appboy::VERSION
-  spec.authors       = ["Josh Nussbaum"]
-  spec.email         = ["josh@godynamo.com"]
+  spec.authors       = ['Josh Nussbaum', 'Hugo Bastien']
+  spec.email         = %w(josh@godynamo.com hugo@godynamo.com)
   spec.description   = %q{Appboy wrapper}
   spec.summary       = %q{A wrapper for the Appboy REST API, track users/events/purchases, send & schedule messages}
-  spec.homepage      = "http://appboy.com"
-  spec.license       = "MIT"
+  spec.homepage      = 'http://appboy.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.require_paths = ['lib']
 
-  spec.add_dependency 'httparty'
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  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', '~> 0.9.12'
+  spec.add_development_dependency 'activesupport'
+  spec.add_development_dependency 'factory_girl', '~> 4.4.0'
 end

data/lib/appboy.rb

@@ -1,6 +1,8 @@
-require "appboy/version"
-require 'httparty'
+require 'json'
+require 'virtus'
+require 'appboy/version'
 
 module Appboy
-  autoload :API, "appboy/api"
+  autoload :API, 'appboy/api'
+  autoload :REST, 'appboy/rest'
 end

data/lib/appboy/api.rb

@@ -1,42 +1,39 @@
+require 'appboy/deprecated'
+require 'appboy/endpoints/track_users'
+require 'appboy/endpoints/delete_users'
+require 'appboy/endpoints/send_messages'
+require 'appboy/endpoints/schedule_messages'
+require 'appboy/endpoints/email_status'
+require 'appboy/endpoints/trigger_campaign'
+require 'appboy/endpoints/trigger_canvas'
+require 'appboy/endpoints/list_canvas'
+
 module Appboy
   class API
-    include HTTParty
+    include Appboy::Deprecated
 
-    base_uri 'https://api.appboy.com'
+    include Appboy::Endpoints::TrackUsers
+    include Appboy::Endpoints::DeleteUsers
+    include Appboy::Endpoints::SendMessages
+    include Appboy::Endpoints::ScheduleMessages
+    include Appboy::Endpoints::EmailStatus
+    include Appboy::Endpoints::TriggerCampaign
+    include Appboy::Endpoints::TriggerCanvas
+    include Appboy::Endpoints::ListCanvas
 
-    def initialize(secret, app_group_id)
-      @secret, @app_group_id = secret, app_group_id
+    def export_users(**payload)
+      Appboy::REST::ExportUsers.new.perform(app_group_id, payload)
     end
 
-    def track(attributes, events=[], purchases=[])
-      post '/users/track', company_secret: @secret,
-                           app_group_id:   @app_group_id,
-                           attributes:     attributes,
-                           events:         events,
-                           purchases:      purchases
+    def list_segments
+      Appboy::REST::ListSegments.new.perform(app_group_id)
     end
 
-    def send_message(message, user_ids, segment_id = nil)
-      post '/messages/send', company_secret:    @secret,
-                             app_group_id:      @app_group_id,
-                             messages:          message,
-                             external_user_ids: user_ids,
-                             segment_ids:       [segment_id].compact
-    end
+    attr_reader :app_group_id
 
-    def schedule_message(date, message, segment_id, local_timezone=false)
-      post '/messages/schedule', company_secret:            @secret,
-                                 segment_ids:               [segment_id],
-                                 send_at:                   date,
-                                 deliver_in_local_timezone: local_timezone,
-                                 messages:                  message
-    end
-
-  private
-    def post(url, payload)
-      response = self.class.post(url, query: payload)
-      puts response.inspect
-      response['message'] == 'success'
+    def initialize(app_group_id)
+      @app_group_id = app_group_id
     end
   end
 end
+

data/lib/appboy/deprecated.rb

@@ -0,0 +1,19 @@
+module Appboy
+  module Deprecated
+    def track(attribute, events = [], purchases = [])
+      warn('[Appboy] `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('[Appboy] `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('[Appboy] `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/appboy/endpoints/delete_users.rb

@@ -0,0 +1,15 @@
+module Appboy
+  module Endpoints
+    module DeleteUsers
+      def delete_users(**payload)
+        delete_users_service.new(app_group_id, payload).perform
+      end
+
+      private
+
+      def delete_users_service
+        Appboy::REST::DeleteUsers
+      end
+    end
+  end
+end

data/lib/appboy/endpoints/email_status.rb

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

data/lib/appboy/endpoints/list_canvas.rb

@@ -0,0 +1,15 @@
+module Appboy
+  module Endpoints
+    module ListCanvas
+      def list_canvas(**payload)
+        list_canvas_service.new(app_group_id, payload).perform
+      end
+
+      private
+
+      def list_canvas_service
+        Appboy::REST::ListCanvas
+      end
+    end
+  end
+end

data/lib/appboy/endpoints/schedule_messages.rb

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