leanplum_api 1.3.1

data/lib/leanplum_api/configuration.rb

@@ -0,0 +1,45 @@
+module LeanplumApi
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration) if block_given?
+  end
+
+  def self.reset!
+    self.configuration = Configuration.new
+  end
+
+  class Configuration
+    DEFAULT_LEANPLUM_API_VERSION = '1.0.6'
+
+    # Required IDs and access keys provided by leanplum
+    attr_accessor :app_id
+    attr_accessor :production_key
+    attr_accessor :content_read_only_key
+    attr_accessor :data_export_key
+    attr_accessor :development_key
+
+    # Optional
+    attr_accessor :api_version
+    attr_accessor :developer_mode
+    attr_accessor :log_path
+    attr_accessor :timeout_seconds
+
+    # Optional configuration for exporting raw data to S3.
+    # If s3_bucket_name is provided, s3_access_id and s3_access_key must also be provided.
+    attr_accessor :s3_bucket_name
+    attr_accessor :s3_access_id
+    attr_accessor :s3_access_key
+    attr_accessor :s3_object_prefix
+
+    def initialize
+      @log_path = 'log'
+      @api_version = DEFAULT_LEANPLUM_API_VERSION
+      @developer_mode = false
+      @timeout_seconds = 600
+    end
+  end
+end

data/lib/leanplum_api/content_read_only.rb

@@ -0,0 +1,15 @@
+require 'leanplum_api/http'
+
+module LeanplumApi
+  class ContentReadOnly < HTTP
+    def initialize(options = {})
+      raise 'Content read only key not configured!' unless LeanplumApi.configuration.content_read_only_key
+      super
+    end
+
+    # Data export API requests need to use the Data Export key
+    def authentication_params
+      super.merge(clientKey: LeanplumApi.configuration.content_read_only_key)
+    end
+  end
+end

data/lib/leanplum_api/data_export.rb

@@ -0,0 +1,15 @@
+require 'leanplum_api/http'
+
+module LeanplumApi
+  class DataExport < HTTP
+    def initialize(options = {})
+      raise 'Data export key not configured' unless LeanplumApi.configuration.data_export_key
+      super
+    end
+
+    # Data export API requests need to use the Data Export key
+    def authentication_params
+      super.merge(clientKey: LeanplumApi.configuration.data_export_key)
+    end
+  end
+end

data/lib/leanplum_api/development.rb

@@ -0,0 +1,14 @@
+require 'leanplum_api/http'
+
+module LeanplumApi
+  class Development < HTTP
+    def initialize(options = {})
+      raise 'Development key not configured!' unless LeanplumApi.configuration.development_key
+      super
+    end
+
+    def authentication_params
+      super.merge(clientKey: LeanplumApi.configuration.development_key)
+    end
+  end
+end

data/lib/leanplum_api/exception.rb

@@ -0,0 +1,4 @@
+module LeanplumApi
+  class LeanplumValidationException < Exception
+  end
+end

data/lib/leanplum_api/http.rb

@@ -0,0 +1,68 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'uri'
+
+module LeanplumApi
+  class HTTP
+    LEANPLUM_API_PATH = '/api'
+
+    def initialize(options = {})
+      @logger = options[:logger] || Logger.new(STDERR)
+    end
+
+    def post(payload)
+      connection.post("#{LEANPLUM_API_PATH}?#{authed_multi_param_string}") do |request|
+        request.body = { data: payload }.to_json
+      end
+    end
+
+    def get(query)
+      connection.get(LEANPLUM_API_PATH, query.merge(authentication_params))
+    end
+
+    def authentication_params
+      {
+        appId: LeanplumApi.configuration.app_id,
+        clientKey: LeanplumApi.configuration.production_key,
+        apiVersion: LeanplumApi.configuration.api_version,
+        devMode: LeanplumApi.configuration.developer_mode
+      }
+    end
+
+    private
+
+    def connection
+      fail 'APP_ID not configured!' unless LeanplumApi.configuration.app_id
+      fail 'PRODUCTION_KEY not configured!' unless LeanplumApi.configuration.production_key
+
+      options = {
+        url: 'https://www.leanplum.com',
+        request: {
+          timeout: LeanplumApi.configuration.timeout_seconds,
+          open_timeout: LeanplumApi.configuration.timeout_seconds
+        }
+      }
+
+      @connection ||= Faraday.new(options) do |connection|
+        connection.request :json
+
+        connection.response :logger, @logger, bodies: true if api_debug?
+        connection.response :json, :content_type => /\bjson$/
+
+        connection.adapter Faraday.default_adapter
+      end
+    end
+
+    def api_debug?
+      ENV['LEANPLUM_API_DEBUG'].to_s =~ /^(true|1)$/i
+    end
+
+    def authed_multi_param_string
+      if LeanplumApi.configuration.developer_mode
+        URI.encode_www_form(authentication_params.merge(action: 'multi', time: Time.now.utc.strftime('%s'), devMode: true))
+      else
+        URI.encode_www_form(authentication_params.merge(action: 'multi', time: Time.now.utc.strftime('%s')))
+      end
+    end
+  end
+end

data/lib/leanplum_api/logger.rb

@@ -0,0 +1,23 @@
+require 'logger'
+
+module LeanplumApi
+  class LeanplumApiLogger < Logger
+    def format_message(severity, timestamp, progname, msg)
+      @keys ||= [
+        LeanplumApi.configuration.production_key,
+        LeanplumApi.configuration.app_id,
+        LeanplumApi.configuration.data_export_key,
+        LeanplumApi.configuration.content_read_only_key,
+        LeanplumApi.configuration.development_key,
+        LeanplumApi.configuration.s3_access_key,
+        LeanplumApi.configuration.s3_access_id
+      ].compact
+
+      if @keys.empty?
+        "#{timestamp.strftime('%Y-%m-%d %H:%M:%S')} #{severity} #{msg}\n"
+      else
+        "#{timestamp.strftime('%Y-%m-%d %H:%M:%S')} #{severity} #{msg.gsub(/#{@keys.map { |k| Regexp.quote(k) }.join('|')}/, '<HIDDEN_KEY>')}\n"
+      end
+    end
+  end
+end

data/lib/leanplum_api/version.rb

@@ -0,0 +1,3 @@
+module LeanplumApi
+  VERSION = '1.3.1'
+end

data/spec/api_spec.rb

@@ -0,0 +1,230 @@
+require 'spec_helper'
+
+describe LeanplumApi::API do
+  let(:api) { LeanplumApi::API.new }
+  let(:users) do
+    [{
+      user_id: 123456,
+      first_name: 'Mike',
+      last_name: 'Jones',
+      gender: 'm',
+      email: 'still_tippin@test.com',
+      create_date: '2010-01-01'.to_date
+    }]
+  end
+  let(:first_user_id) { users.first[:user_id] }
+
+  context 'users' do
+    it 'build_user_attributes_hash' do
+      expect(api.send(:build_user_attributes_hash, users.first)).to eq({
+        'userId' => 123456,
+        'action' => 'setUserAttributes',
+        'userAttributes' => {
+          first_name: 'Mike',
+          last_name: 'Jones',
+          gender: 'm',
+          email: 'still_tippin@test.com',
+          create_date: '2010-01-01'
+        }
+      })
+    end
+
+    context 'set_user_attributes' do
+      context 'valid request' do
+        it 'should successfully set user attributes' do
+          VCR.use_cassette('set_user_attributes') do
+            expect { api.set_user_attributes(users) }.to_not raise_error
+          end
+        end
+      end
+
+      context 'invalid request' do
+        let(:broken_users) { users + [{ first_name: 'Moe' }] }
+
+        it 'should raise an error' do
+          VCR.use_cassette('set_user_attributes_broken') do
+            expect{ api.set_user_attributes(broken_users) }.to raise_error(/No device_id or user_id in hash/)
+          end
+        end
+      end
+    end
+
+    context 'export_user' do
+      it 'should get user attributes for this user' do
+        VCR.use_cassette('export_user') do
+          user_info = api.export_user(first_user_id)
+          user_info.keys.each do |k|
+            if users.first[k.to_sym].is_a?(Date) || users.first[k.to_sym].is_a?(DateTime)
+              expect(user_info[k]).to eq(users.first[k.to_sym].strftime('%Y-%m-%d'))
+            else
+              expect(user_info[k]).to eq(users.first[k.to_sym])
+            end
+          end
+        end
+      end
+    end
+
+    context 'export_users' do
+      it 'should export users'
+    end
+
+    context 'reset_anomalous_users' do
+      it 'should successfully call setUserAttributes with resetAnomalies' do
+        VCR.use_cassette('reset_anomalous_user') do
+          expect { api.reset_anomalous_users(first_user_id) }.to_not raise_error
+        end
+      end
+    end
+  end
+
+  context 'events' do
+    let(:events) do
+      [
+        {
+          user_id: 12345,
+          event: 'purchase',
+          time: Time.now.utc,
+          params: {
+            'some_timestamp' => '2015-05-01 01:02:03'
+          }
+        },
+        {
+          user_id: 54321,
+          event: 'purchase_page_view',
+          time: Time.now.utc - 10.minutes,
+        }
+      ]
+    end
+
+    it 'build_event_attributes_hash' do
+      expect(api.send(:build_event_attributes_hash, events.first)).to eq({
+        'userId' => 12345,
+        'time' => Time.now.utc.strftime('%s'),
+        'action' => 'track',
+        'event' => 'purchase',
+        'params' => { params: { 'some_timestamp'=>'2015-05-01 01:02:03' } }
+      })
+    end
+
+    context 'without user attributes' do
+      context 'valid request' do
+        it 'should successfully track events' do
+          VCR.use_cassette('track_events') do
+            expect { api.track_events(events) }.to_not raise_error
+          end
+        end
+      end
+
+      context 'invalid request' do
+        let(:broken_events) { events + [{ event: 'no_user_id_event' }] }
+
+        it 'should raise an error' do
+          VCR.use_cassette('track_events_broken') do
+            expect { api.track_events(broken_events) }.to raise_error(/No device_id or user_id in hash/)
+          end
+        end
+      end
+
+      context 'anomalous data force_anomalous_override' do
+        it 'should successfully force the anomalous data override events' do
+          VCR.use_cassette('track_events_anomaly_overrider') do
+            expect { api.track_events(events, force_anomalous_override: true) }.to_not raise_error
+          end
+        end
+      end
+    end
+
+    context 'along with user attributes' do
+      it 'should work' do
+        VCR.use_cassette('track_events_and_attributes') do
+          expect { api.track_multi(events, users) }.to_not raise_error
+        end
+      end
+    end
+  end
+
+  # Data export and content read only endpoints forbid use of devMode
+  context 'non devMode methods' do
+    around(:all) do |example|
+      LeanplumApi.configure { |c| c.developer_mode = false }
+      example.run
+      LeanplumApi.configure { |c| c.developer_mode = true }
+    end
+
+    context 'data export methods' do
+      let(:s3_bucket_name) { 'bucket' }
+      let(:s3_access_key) { 's3_access_key' }
+      let(:s3_access_id) { 's3_access_id' }
+
+      around(:all) do |example|
+        LeanplumApi.configure do |c|
+          c.developer_mode = false
+        end
+        example.run
+        LeanplumApi.configure { |c| c.developer_mode = true }
+      end
+
+      context 'export_data' do
+        it 'should request a data export job with a starttime' do
+          VCR.use_cassette('export_data') do
+            expect { api.export_data(Time.at(1438660800).utc) }.to raise_error(/No matching data found/)
+          end
+        end
+
+        it 'should request a data export job with start and end dates' do
+          VCR.use_cassette('export_data_dates') do
+            expect { api.export_data(Date.new(2015, 9, 5), Date.new(2015, 9, 6)) }.to raise_error(/No matching data found/)
+          end
+        end
+      end
+
+      context 'get_export_results' do
+        it 'should get a status for a data export job' do
+          VCR.use_cassette('get_export_results') do
+            response = api.get_export_results('export_4727756026281984_2904941266315269120')
+            expect(response).to eq({
+              files: ['https://leanplum_export.storage.googleapis.com/export-4727756026281984-d5969d55-f242-48a6-85a3-165af08e2306-output-0'],
+              number_of_bytes: 36590,
+              number_of_sessions: 101,
+              state: LeanplumApi::API::EXPORT_FINISHED,
+              s3_copy_status: nil
+            })
+          end
+        end
+      end
+    end
+
+    context 'content read only methods' do
+      it 'gets ab tests' do
+        VCR.use_cassette('get_ab_tests') do
+          expect(api.get_ab_tests).to eq([])
+        end
+      end
+
+      it 'gets an ab test' do
+        VCR.use_cassette('get_ab_test') do
+          expect(api.get_ab_tests(1)).to eq([])
+        end
+      end
+
+      it 'gets messages' do
+        VCR.use_cassette('get_messages') do
+          expect(api.get_messages).to eq([{
+            "id" => 5670583287676928,
+            "created" => 1440091595.799,
+            "name" => "New Message",
+            "active" => false,
+            "messageType" => "Push Notification"
+          }])
+        end
+      end
+
+      it 'gets vars' do
+        VCR.use_cassette('get_vars') do
+          vars = api.get_vars(first_user_id)
+          expect(vars).to eq({'test_var' => 1})
+        end
+      end
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe LeanplumApi do
+  context 'configuration' do
+    after(:each) do
+      LeanplumApi.reset!
+    end
+
+    it 'should have a default configuration' do
+      expect(LeanplumApi.configuration.log_path.is_a?(String)).to eq(true)
+    end
+
+    it 'should allow configuration' do
+      LeanplumApi.configure do |config|
+        config.log_path = 'test/path'
+        config.production_key = 'new_client_key'
+        config.app_id = 'new_app_id'
+      end
+
+      expect(LeanplumApi.configuration.log_path).to eq('test/path')
+      expect(LeanplumApi.configuration.production_key).to eq('new_client_key')
+      expect(LeanplumApi.configuration.app_id).to eq('new_app_id')
+      expect(LeanplumApi.configuration.api_version).to eq(LeanplumApi::Configuration::DEFAULT_LEANPLUM_API_VERSION)
+    end
+  end
+end