appboy 0.0.1 → 0.1.7

data/lib/appboy/endpoints/send_messages.rb

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

data/lib/appboy/endpoints/track_users.rb

@@ -0,0 +1,29 @@
+module Appboy
+  module Endpoints
+    module TrackUsers
+      attr_writer :track_users_service
+
+      def track_users(**payload)
+        track_users_service.perform(app_group_id, 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 ||= Appboy::REST::TrackUsers.new
+      end
+    end
+  end
+end

data/lib/appboy/endpoints/trigger_campaign.rb

@@ -0,0 +1,15 @@
+module Appboy
+  module Endpoints
+    module TriggerCampaign
+      def trigger_campaign(**payload)
+        trigger_campaign_service.new(app_group_id, payload).perform
+      end
+
+      private
+
+      def trigger_campaign_service
+        Appboy::REST::TriggerCampaign
+      end
+    end
+  end
+end

data/lib/appboy/endpoints/trigger_canvas.rb

@@ -0,0 +1,15 @@
+module Appboy
+  module Endpoints
+    module TriggerCanvas
+      def trigger_canvas(**payload)
+        trigger_canvas_service.new(app_group_id, payload).perform
+      end
+
+      private
+
+      def trigger_canvas_service
+        Appboy::REST::TriggerCanvas
+      end
+    end
+  end
+end

data/lib/appboy/http.rb

@@ -0,0 +1,32 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module Appboy
+  class HTTP
+    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: api_host) do |connection|
+        connection.request :json
+
+        connection.response :logger if ENV['APPBOY_DEBUG']
+
+        connection.adapter Faraday.default_adapter
+      end
+    end
+
+    private
+
+    def api_host
+      @api_host ||= ENV.fetch('APPBOY_REST_BASE_URL', 'https://api.appboy.com')
+    end
+  end
+end

data/lib/appboy/rest.rb

@@ -0,0 +1,11 @@
+require 'appboy/rest/base'
+require 'appboy/rest/track_users'
+require 'appboy/rest/delete_users'
+require 'appboy/rest/send_messages'
+require 'appboy/rest/schedule_messages'
+require 'appboy/rest/email_status'
+require 'appboy/rest/export_users'
+require 'appboy/rest/list_segments'
+require 'appboy/rest/trigger_campaign'
+require 'appboy/rest/trigger_canvas'
+require 'appboy/rest/list_canvas'

data/lib/appboy/rest/base.rb

@@ -0,0 +1,15 @@
+require 'appboy/http'
+
+module Appboy
+  module REST
+    class Base
+      attr_writer :http
+
+      private
+
+      def http
+        @http ||= Appboy::HTTP.new
+      end
+    end
+  end
+end

data/lib/appboy/rest/delete_users.rb

@@ -0,0 +1,21 @@
+module Appboy
+  module REST
+    class DeleteUsers < Base
+      attr_reader :app_group_id, :external_ids, :appboy_ids
+
+      def initialize(app_group_id, external_ids: [], appboy_ids: [])
+        @app_group_id = app_group_id
+        @external_ids = external_ids
+        @appboy_ids   = appboy_ids
+      end
+
+      def perform
+        http.post '/users/delete', {
+          app_group_id:   app_group_id,
+          external_ids:   external_ids,
+          appboy_ids:     appboy_ids
+        }
+      end
+    end
+  end
+end

data/lib/appboy/rest/email_status.rb

@@ -0,0 +1,21 @@
+module Appboy
+  module REST
+    class EmailStatus < Base
+      attr_reader :app_group_id, :email, :status
+
+      def initialize(app_group_id, email:, status:)
+        @app_group_id = app_group_id
+        @email = email
+        @status = status
+      end
+
+      def perform
+        http.post '/email/status', {
+          app_group_id: app_group_id,
+          email: email,
+          subscription_state: status
+        }
+      end
+    end
+  end
+end

data/lib/appboy/rest/export_users.rb

@@ -0,0 +1,27 @@
+module Appboy
+  module REST
+    class ExportUsers < Base
+      def perform(app_group_id, external_ids: nil, segment_id: nil, **options)
+        return export_users_by_ids(app_group_id, external_ids) if external_ids
+
+        export_users_by_segment(app_group_id, segment_id, options) if segment_id
+      end
+
+      private
+
+      def export_users_by_ids(app_group_id, external_ids)
+        http.post '/users/export/ids', {
+          app_group_id: app_group_id,
+          external_ids: external_ids
+        }
+      end
+
+      def export_users_by_segment(app_group_id, segment_id, options)
+        http.post '/users/export/segment', {
+          app_group_id: app_group_id,
+          segment_id: segment_id
+        }.merge(options)
+      end
+    end
+  end
+end

data/lib/appboy/rest/list_canvas.rb

@@ -0,0 +1,21 @@
+module Appboy
+  module REST
+    class ListCanvas < Base
+      attr_reader :app_group_id, :sort_direction, :include_archived
+
+      def initialize(app_group_id, options = {})
+        @app_group_id = app_group_id
+        @sort_direction = options[:sort_direction]
+        @include_archived = options[:include_archived]
+      end
+
+      def perform
+        http.get '/canvas/list', {
+          app_group_id: app_group_id,
+          sort_direction: sort_direction,
+          include_archived: include_archived
+        }.compact
+      end
+    end
+  end
+end

data/lib/appboy/rest/list_segments.rb

@@ -0,0 +1,11 @@
+module Appboy
+  module REST
+    class ListSegments < Base
+      def perform(app_group_id)
+        http.get '/segments/list', {
+          app_group_id: app_group_id
+        }
+      end
+    end
+  end
+end

data/lib/appboy/rest/schedule_messages.rb

@@ -0,0 +1,25 @@
+module Appboy
+  module REST
+    class ScheduleMessages < Base
+      attr_reader :app_group_id, :send_at, :messages, :segment_id, :local_timezone
+
+      def initialize(app_group_id, send_at:, messages: [], segment_id: nil, local_timezone: false)
+        @app_group_id = app_group_id
+        @send_at = send_at
+        @messages = messages
+        @segment_id = segment_id
+        @local_timezone = local_timezone
+      end
+
+      def perform
+        http.post '/messages/schedule', {
+          app_group_id:      app_group_id,
+          segment_ids:               [segment_id],
+          send_at:                   send_at,
+          deliver_in_local_timezone: local_timezone,
+          messages:                  messages
+        }
+      end
+    end
+  end
+end

data/lib/appboy/rest/send_messages.rb

@@ -0,0 +1,23 @@
+module Appboy
+  module REST
+    class SendMessages < Base
+      attr_reader :app_group_id, :messages, :external_user_ids, :segment_id
+
+      def initialize(app_group_id, messages: [], external_user_ids: [], segment_id: nil)
+        @app_group_id = app_group_id
+        @messages = messages
+        @external_user_ids = external_user_ids
+        @segment_id = segment_id
+      end
+
+      def perform
+        http.post '/messages/send', {
+          app_group_id:      app_group_id,
+          messages:          messages,
+          external_user_ids: external_user_ids,
+          segment_ids:       [segment_id].compact
+        }
+      end
+    end
+  end
+end

data/lib/appboy/rest/track_users.rb

@@ -0,0 +1,14 @@
+module Appboy
+  module REST
+    class TrackUsers < Base
+      def perform(app_group_id, attributes: [], events: [], purchases: [])
+        http.post '/users/track', {
+          app_group_id:   app_group_id,
+          attributes:     attributes,
+          events:         events,
+          purchases:      purchases
+        }
+      end
+    end
+  end
+end

data/lib/appboy/rest/trigger_campaign.rb

@@ -0,0 +1,30 @@
+module Appboy
+  module REST
+    class TriggerCampaign < Base
+      attr_reader :api_key, :audience, :broadcast, :campaign_id,
+                  :recipients, :send_id, :trigger_properties
+
+      def initialize(api_key, options = {})
+        @api_key            = api_key
+        @audience           = options[:audience]
+        @broadcast          = options[:broadcast] || false
+        @campaign_id        = options[:campaign_id]
+        @recipients         = options[:recipients]
+        @send_id            = options[:send_id]
+        @trigger_properties = options[:trigger_properties]
+      end
+
+      def perform
+        http.post '/campaigns/trigger/send', {
+          api_key:            api_key,
+          audience:           audience,
+          broadcast:          broadcast,
+          campaign_id:        campaign_id,
+          recipients:         recipients,
+          send_id:            send_id,
+          trigger_properties: trigger_properties
+        }.compact
+      end
+    end
+  end
+end

data/lib/appboy/rest/trigger_canvas.rb

@@ -0,0 +1,28 @@
+module Appboy
+  module REST
+    class TriggerCanvas < Base
+      attr_reader :api_key, :audience, :broadcast, :canvas_id,
+                  :canvas_entry_properties, :recipients
+
+      def initialize(app_group_id, options = {})
+        @api_key                 = app_group_id
+        @audience                = options[:audience]
+        @broadcast               = options[:broadcast] || false
+        @canvas_entry_properties = options[:canvas_entry_properties]
+        @canvas_id               = options[:canvas_id]
+        @recipients              = options[:recipients]
+      end
+
+      def perform
+        http.post '/canvas/trigger/send', {
+          api_key:                 api_key,
+          audience:                audience,
+          broadcast:               broadcast,
+          canvas_entry_properties: canvas_entry_properties,
+          canvas_id:               canvas_id,
+          recipients:              recipients
+        }.compact
+      end
+    end
+  end
+end

data/lib/appboy/version.rb

@@ -1,3 +1,3 @@
 module Appboy
-  VERSION = "0.0.1"
+  VERSION = '0.1.7'
 end

data/spec/appboy/api_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Appboy::API do
+end

data/spec/appboy/endpoints/track_users_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+class API
+  include Appboy::Endpoints::TrackUsers
+
+  def app_group_id
+    :app_group_id
+  end
+end
+
+describe Appboy::Endpoints::TrackUsers do
+  let(:api) { API.new }
+  let(:track_users_service) { double(:track_users_service) }
+
+  before { api.track_users_service = track_users_service }
+
+  describe '#track_users' do
+    let(:payload) {{
+      attributes: [build(:attribute)],
+      events: [build(:event)],
+      purchases: [build(:purchase)]
+    }}
+
+    subject(:track_users!) { api.track_users(payload) }
+
+    it 'tracks attributes, events and purchases' do
+      expect(track_users_service).to receive(:perform)
+        .with(:app_group_id, payload)
+
+      track_users!
+    end
+  end
+
+  describe '#track_purchase' do
+    let(:payload) { build(:purchase) }
+
+    subject(:track_purchase!) { api.track_purchase(payload) }
+
+    it 'tracks a single purchase' do
+      expect(track_users_service).to receive(:perform)
+        .with(:app_group_id, purchases: [payload])
+
+      track_purchase!
+    end
+  end
+
+  describe '#track_event' do
+    let(:payload) { build(:event) }
+
+    subject(:track_event!) { api.track_event(payload) }
+
+    it 'tracks a single purchase' do
+      expect(track_users_service).to receive(:perform)
+        .with(:app_group_id, events: [payload])
+
+      track_event!
+    end
+  end
+
+  describe '#track_attribute' do
+    let(:payload) { build(:attribute) }
+
+    subject(:track_attribute!) { api.track_attribute(payload) }
+
+    it 'tracks a single purchase' do
+      expect(track_users_service).to receive(:perform)
+          .with(:app_group_id, attributes: [payload])
+
+      track_attribute!
+    end
+  end
+end