appboy 0.0.1 → 0.1.2

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_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/version.rb

@@ -1,3 +1,3 @@
 module Appboy
-  VERSION = "0.0.1"
+  VERSION = '0.1.2'
 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

data/spec/appboy/rest/email_status_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Appboy::REST::EmailStatus do
+  let(:http) { double(:http) }
+
+  before { subject.http = http }
+
+  subject { described_class.new(:app_group_id, email: :email, status: :status) }
+
+  it 'makes an http call to the email status endpoint' do
+    expect(http).to receive(:post).with '/email/status', {
+      app_group_id: :app_group_id,
+      email: :email,
+      subscription_state: :status
+    }
+
+    subject.perform
+  end
+end

data/spec/appboy/rest/export_users_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Appboy::REST::ExportUsers do
+  let(:http) { double(:http) }
+
+  let(:payload) {{ external_ids: :external_ids }}
+
+  let(:app_group_id) { :app_group_id }
+
+  subject { described_class.new }
+
+  before { subject.http = http }
+
+  it 'makes an http call to the track user endpoint' do
+    expect(http).to receive(:post).with '/users/export/ids',
+        payload.merge({ app_group_id: :app_group_id })
+
+    subject.perform(app_group_id, payload)
+  end
+end

data/spec/appboy/rest/schedule_messages_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Appboy::REST::ScheduleMessages do
+  let(:http) { double(:http) }
+
+  let(:payload) {{
+    send_at: :send_at,
+    segment_id: :segment_id,
+    local_timezone: :local_timezone,
+    messages: :messages
+  }}
+
+  let(:app_group_id) { :app_group_id }
+
+  subject { described_class.new(app_group_id, payload) }
+
+  before { subject.http = http }
+
+  it 'makes an http call to the schedule messages endpoint' do
+    expect_schedule_messages_http_call
+
+    subject.perform
+  end
+
+  def expect_schedule_messages_http_call
+    expect(http).to receive(:post).with '/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

data/spec/appboy/rest/send_messages_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Appboy::REST::SendMessages do
+  let(:http) { double(:http) }
+
+  let(:payload) {{
+    messages: :messages,
+    external_user_ids: :external_user_ids,
+    segment_id: :segment_id
+  }}
+
+  let(:app_group_id) { :app_group_id }
+
+  subject { described_class.new(app_group_id,
+    messages: :messages,
+    external_user_ids: :external_user_ids,
+    segment_id: :segment_id
+  ) }
+
+  before { subject.http = http }
+
+  it 'makes an http call to the send messages endpoint' do
+    expect_send_messages_http_call
+
+    subject.perform
+  end
+
+  def expect_send_messages_http_call
+    expect(http).to receive(:post).with '/messages/send', {
+      app_group_id: :app_group_id,
+      messages: :messages,
+      external_user_ids: :external_user_ids,
+      segment_ids: [:segment_id]
+    }
+  end
+end

data/spec/appboy/rest/track_users_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Appboy::REST::TrackUsers do
+  let(:http) { double(:http) }
+
+  let(:payload) {{
+    attributes: :attributes,
+    events: :events,
+    purchases: :purchases
+  }}
+
+  let(:app_group_id) { :app_group_id }
+
+  subject { described_class.new }
+
+  before { subject.http = http }
+
+  it 'makes an http call to the track user endpoint' do
+    expect(http).to receive(:post).with '/users/track',
+        payload.merge({ app_group_id: :app_group_id })
+
+    subject.perform(app_group_id, payload)
+  end
+end

data/spec/factories.rb

@@ -0,0 +1,32 @@
+FactoryGirl.define do
+  factory :attribute, class: Hash do
+    external_id 1
+    foo :bar
+
+    initialize_with { attributes }
+  end
+
+  factory :event, class: Hash do
+    external_id 1
+    name :baz
+    time Time.now
+
+    initialize_with { attributes }
+  end
+
+  factory :purchase, class: Hash do
+    external_id 1
+    product_id 1
+    time Time.now
+    currency 'CAD'
+    price 1.0
+
+    initialize_with { attributes }
+  end
+
+  factory :messages, class: Hash do
+    apple_push({ alert: :hello })
+
+    initialize_with { attributes }
+  end
+end

data/spec/fixtures/responses/email_status/existing_email/responds_with_created.yml

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.appboy.com/email/status
+    body:
+      encoding: UTF-8
+      string: '{"app_group_id":"<APPBOY_GROUP_ID>","email":"john@example.com","subscription_state":"unsubscribed"}'
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      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:
+      Server:
+      - nginx/1.6.2
+      Date:
+      - Thu, 19 Feb 2015 20:42:25 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Status:
+      - 201 Created
+      Strict-Transport-Security:
+      - max-age=31536000
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Etag:
+      - '"8736cdfe08480bca66cffeee06268705"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 664ec9e1c8bf8666cadff79ee1a56434
+      X-Runtime:
+      - '0.024496'
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: UTF-8
+      string: '{"message":"success"}'
+    http_version: 
+  recorded_at: Thu, 19 Feb 2015 20:42:24 GMT
+recorded_with: VCR 2.9.2

data/spec/fixtures/responses/email_status/existing_email/responds_with_success_message.yml

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.appboy.com/email/status
+    body:
+      encoding: UTF-8
+      string: '{"app_group_id":"<APPBOY_GROUP_ID>","email":"john@example.com","subscription_state":"unsubscribed"}'
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      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:
+      Server:
+      - nginx/1.6.2
+      Date:
+      - Thu, 19 Feb 2015 20:42:25 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Status:
+      - 201 Created
+      Strict-Transport-Security:
+      - max-age=31536000
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Etag:
+      - '"8736cdfe08480bca66cffeee06268705"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 0854d9c1be11939007bace0da4e264ac
+      X-Runtime:
+      - '0.025690'
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: UTF-8
+      string: '{"message":"success"}'
+    http_version: 
+  recorded_at: Thu, 19 Feb 2015 20:42:25 GMT
+recorded_with: VCR 2.9.2