leanplum_api 1.3.1 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eaef8b007ad46754ae7107b22f86db959f8805c9
-  data.tar.gz: 503030e7e4f4a85640e42aa2e2d60da7911bad5d
+  metadata.gz: e3ada1da3173ffd60da9b2abdddbf4901d20d8cd
+  data.tar.gz: 56ca6681108d38d0d91aed19701624db0faae812
 SHA512:
-  metadata.gz: 3d9b7d5ad103922bf4888953aaad2e5130b98c2136a8b18a0b02ba30e9d55d6d2d041403eddad4799457c51290b42491570a42a9a68bb63315b3843130cf0814
-  data.tar.gz: dc14c91eb847b399af97a187bed901f948f88a34462539a2489d72fd587c07a885537e3b3b2f34dac4e8bad3dd4795f0a918ccbd0395e3d99bd64046f876efa7
+  metadata.gz: f7f0436608323f894b38932da9dd1cd2ebab1aa5f992267fc0c01f871d48e6bdfed8800317dd255907ec6858a18711118e19de9820165d8cc133ff2663030651
+  data.tar.gz: f35e6b7a620fb5f4136f3914381f46abcff6931ebda1a5dbeb5efd2a9fcd072c80bde63b2c7a00135413b803af5fc472b006faa20259d8baab7b7f5b29bc9929

data/README.md

@@ -27,10 +27,10 @@ LeanplumApi.configure do |config|
   config.development_key = 'MY_CONTENT_KEY'       # Optional; needed for resetting anomalous events
 
   # Optional configuration variables
-  config.log_path = '/log/path'  # Defaults to 'log/'
-  attr_accessor :timeout_seconds # Defaults to 600
-  config.api_version             # Defaults to 1.0.6
-  attr_accessor :developer_mode  # Defaults to false
+  config.logger = LeanplumApi::Logger.new('file.log') # Defaults to STDOUT.  The gem logger class hides passwords.
+  config.timeout_seconds                              # Defaults to 600
+  config.api_version                                  # Defaults to 1.0.6
+  config.developer_mode                               # Defaults to false
 
   # S3 export required options
   config.s3_bucket_name = 'my_bucket'
@@ -75,6 +75,12 @@ api.track_events(event)
 
 # You can also track events and user attributes at the same time
 api.track_multi(event, attribute_hash)
+
+# If your event is sufficiently far in the past, leanplum will mark your user as "Anomalous"
+# To force a reset of this flag, either call the method directly
+api.reset_anomalous_users([12345, 23456])
+# Or use the :force_anomalous_override option when calling track_events or track_multi
+api.track_events(event, force_anomalous_override: true)
 ```
 
 Data export:

data/lib/leanplum_api/api.rb

@@ -4,11 +4,11 @@ module LeanplumApi
     EXPORT_RUNNING = 'RUNNING'
     EXPORT_FINISHED = 'FINISHED'
 
+    class LeanplumValidationException < RuntimeError; end
+
     def initialize(options = {})
       fail 'LeanplumApi not configured yet!' unless LeanplumApi.configuration
-
-      @logger = options[:logger] || LeanplumApiLogger.new(File.join(LeanplumApi.configuration.log_path, "#{$$}_leanplum_#{Time.now.utc.strftime('%Y-%m-%d_%H:%M:%S')}.log"))
-      @http = LeanplumApi::HTTP.new(logger: @logger)
+      @http = LeanplumApi::HTTP.new
     end
 
     def set_user_attributes(user_attributes, options = {})
@@ -24,12 +24,11 @@ module LeanplumApi
     # Set the :force_anomalous_override to catch warnings from leanplum about anomalous events and force them to not
     # be considered anomalous
     def track_multi(events = nil, user_attributes = nil, options = {})
-      events = arrayify(events)
-      user_attributes = arrayify(user_attributes)
+      events = Array.wrap(events)
+      user_attributes = Array.wrap(user_attributes)
 
       request_data = user_attributes.map { |h| build_user_attributes_hash(h) } + events.map { |h| build_event_attributes_hash(h) }
       response = @http.post(request_data)
-      validate_response(events + user_attributes, response)
 
       if options[:force_anomalous_override]
         user_ids_to_reset = []
@@ -48,7 +47,7 @@ module LeanplumApi
     # They recommend using the automatic export to S3 if possible.
     def export_data(start_time, end_time = nil)
       fail "Start time #{start_time} after end time #{end_time}" if end_time && start_time > end_time
-      @logger.info("Requesting data export from #{start_time} to #{end_time}...")
+      LeanplumApi.configuration.logger.info("Requesting data export from #{start_time} to #{end_time}...")
 
       # Because of open questions about how startTime and endTime work (or don't work, as the case may be), we
       # only want to pass the dates unless start and end times are specifically requested.
@@ -72,17 +71,12 @@ module LeanplumApi
         params.merge!(s3ObjectPrefix: LeanplumApi.configuration.s3_object_prefix) if LeanplumApi.configuration.s3_object_prefix
       end
 
-      response = data_export_connection.get(params).body['response'].first
-      if response['success'] == true
-        response['jobId']
-      else
-        fail "No success message!  Response: #{response}"
-      end
+      data_export_connection.get(params).body['response'].first['jobId']
     end
 
     # See leanplum docs.
     # The segment syntax is identical to that produced by the "Insert Value" feature on the dashboard.
-    # Examples: 'Country = "US"', '{Country = “US”} and {App version = 1}'.
+    # Examples: 'Country = "US"', '{Country = "US"} and {App version = 1}'.
     def export_users(segment, ab_test_id)
       data_export_connection.get(action: 'exportUsers', segment: segment, ab_test_id: ab_test_id)
     end
@@ -90,8 +84,8 @@ module LeanplumApi
     def get_export_results(job_id)
       response = data_export_connection.get(action: 'getExportResults', jobId: job_id).body['response'].first
       if response['state'] == EXPORT_FINISHED
-        @logger.info("Export finished.")
-        @logger.debug("  Response: #{response}")
+        LeanplumApi.configuration.logger.info("Export finished.")
+        LeanplumApi.configuration.logger.debug("  Response: #{response}")
         {
           files: response['files'],
           number_of_sessions: response['numSessions'],
@@ -106,7 +100,7 @@ module LeanplumApi
 
     def wait_for_job(job_id, polling_interval = 60)
       while get_export_results(job_id)[:state] != EXPORT_FINISHED
-        @logger.debug("Polling job #{job_id}: #{get_export_results(job_id)}")
+        LeanplumApi.configuration.logger.debug("Polling job #{job_id}: #{get_export_results(job_id)}")
         sleep(polling_interval)
       end
       get_export_results(job_id)
@@ -145,26 +139,25 @@ module LeanplumApi
     # Calling this method after you pass old events will fix that for all events for the specified user_id
     # For some reason this API feature requires the developer key
     def reset_anomalous_users(user_ids)
-      user_ids = arrayify(user_ids)
+      user_ids = Array.wrap(user_ids)
       request_data = user_ids.map { |user_id| { 'action' => 'setUserAttributes', 'resetAnomalies' => true, 'userId' => user_id } }
-      response = development_connection.post(request_data)
-      validate_response(request_data, response)
+      development_connection.post(request_data)
     end
 
     private
 
     # Only instantiated for data export endpoint calls
     def data_export_connection
-      @data_export ||= LeanplumApi::DataExport.new(logger: @logger)
+      @data_export ||= LeanplumApi::DataExport.new
     end
 
     # Only instantiated for ContentReadOnly calls (AB tests)
     def content_read_only_connection
-      @content_read_only ||= LeanplumApi::ContentReadOnly.new(logger: @logger)
+      @content_read_only ||= LeanplumApi::ContentReadOnly.new
     end
 
     def development_connection
-      @development ||= LeanplumApi::Development.new(logger: @logger)
+      @development ||= LeanplumApi::Development.new
     end
 
     def extract_user_id_or_device_id_hash(hash)
@@ -217,35 +210,5 @@ module LeanplumApi
       end
       new_hash
     end
-
-    # In case leanplum decides your events are too old, they will send a warning.
-    # Right now we aren't responding to this directly.
-    # '{"response":[{"success":true,"warning":{"message":"Anomaly detected: time skew. User will be excluded from analytics."}}]}'
-    def validate_response(input, response)
-      success_indicators = response.body['response']
-      if success_indicators.size != input.size
-        fail "Attempted to update #{input.size} records but only received confirmation for #{success_indicators.size}!"
-      end
-
-      failure_indices = []
-      success_indicators.each_with_index do |s,i|
-        if s['success'].to_s != 'true'
-          @logger.error("Unsuccessful attempt to update at position #{i}: #{input[i]}")
-          failure_indices << i
-        else
-          @logger.debug("Successfully updated position #{i}: #{input[i]}")
-        end
-      end
-
-      fail LeanplumValidationException.new('Failed to update') if failure_indices.size > 0
-    end
-
-    def arrayify(x)
-      if x && !x.is_a?(Array)
-        [x]
-      else
-        x || []
-      end
-    end
   end
 end

data/lib/leanplum_api/configuration.rb

@@ -26,6 +26,7 @@ module LeanplumApi
     attr_accessor :api_version
     attr_accessor :developer_mode
     attr_accessor :log_path
+    attr_accessor :logger
     attr_accessor :timeout_seconds
 
     # Optional configuration for exporting raw data to S3.
@@ -36,10 +37,13 @@ module LeanplumApi
     attr_accessor :s3_object_prefix
 
     def initialize
-      @log_path = 'log'
       @api_version = DEFAULT_LEANPLUM_API_VERSION
       @developer_mode = false
       @timeout_seconds = 600
+      @logger = LeanplumApi::Logger.new(STDOUT)
+
+      # Deprecated
+      @log_path = 'log'
     end
   end
 end

data/lib/leanplum_api/faraday_middleware/response_validation.rb

@@ -0,0 +1,45 @@
+module LeanplumApi
+  class BadResponseError < RuntimeError; end
+  class ResourceNotFoundError < RuntimeError; end
+
+  class ResponseValidation < Faraday::Middleware
+    Faraday::Request.register_middleware(leanplum_response_validation: self)
+
+    def call(environment)
+      operations = nil
+
+      if environment.body
+        operations = environment.body[:data] if environment.body[:data] && environment.body[:data].is_a?(Array)
+        environment.body = environment.body.to_json
+      end
+
+      @app.call(environment).on_complete do |response|
+        fail ResourceNotFoundError, response.inspect if response.status == 404
+        fail BadResponseError, response.inspect unless response.status == 200 && response.body['response']
+        fail BadResponseError, "No :success key in #{response.inspect}!" unless response.body['response'].is_a?(Array) && response.body['response'].first.has_key?('success')
+        fail BadResponseError, "Not a success! Response: #{response.inspect}" unless response.body['response'].first['success'] == true
+        validate_operation_success(operations, response) if operations
+      end
+    end
+
+    private
+
+    def validate_operation_success(operations, response)
+      success_indicators = response.body['response']
+      if success_indicators.size != operations.size
+        fail "Attempted to update #{operations.size} records but only received confirmation for #{success_indicators.size}!"
+      end
+
+      failures = []
+      success_indicators.each_with_index do |s, i|
+        if s['success'].to_s != 'true'
+          LeanplumApi.configuration.logger.error("Unsuccessful attempt to update at position #{i}: #{operations[i]}")
+          failures << { operation: operations[i], error: s }
+        end
+        LeanplumApi.configuration.logger.warn("Warning for operation #{operations[i]}: #{s['warning']}") if s['warning']
+      end
+
+      fail LeanplumValidationException.new("Operation failures: #{failures}") if failures.size > 0
+    end
+  end
+end

data/lib/leanplum_api/http.rb

@@ -12,7 +12,7 @@ module LeanplumApi
 
     def post(payload)
       connection.post("#{LEANPLUM_API_PATH}?#{authed_multi_param_string}") do |request|
-        request.body = { data: payload }.to_json
+        request.body = { data: payload }
       end
     end
 
@@ -44,7 +44,7 @@ module LeanplumApi
       }
 
       @connection ||= Faraday.new(options) do |connection|
-        connection.request :json
+        connection.request :leanplum_response_validation
 
         connection.response :logger, @logger, bodies: true if api_debug?
         connection.response :json, :content_type => /\bjson$/

data/lib/leanplum_api/logger.rb

@@ -1,7 +1,7 @@
 require 'logger'
 
 module LeanplumApi
-  class LeanplumApiLogger < Logger
+  class Logger < ::Logger
     def format_message(severity, timestamp, progname, msg)
       @keys ||= [
         LeanplumApi.configuration.production_key,

data/lib/leanplum_api/version.rb

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

data/lib/leanplum_api.rb

@@ -1,15 +1,9 @@
 require 'faraday'
 require 'active_support/all'
 
-require 'leanplum_api/api'
-require 'leanplum_api/configuration'
-require 'leanplum_api/content_read_only'
-require 'leanplum_api/data_export'
-require 'leanplum_api/development'
-require 'leanplum_api/exception'
-require 'leanplum_api/http'
-require 'leanplum_api/logger'
-require 'leanplum_api/version'
+path = File.join(File.expand_path(File.dirname(__FILE__)), 'leanplum_api')
+Dir["#{path}/*.rb"].each { |f| require f }
+Dir["#{path}/**/*.rb"].each { |f| require f }
 
 module LeanplumApi
 end

data/spec/api_spec.rb

@@ -152,10 +152,6 @@ describe LeanplumApi::API do
     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
@@ -165,17 +161,27 @@ describe LeanplumApi::API do
       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/)
+        context 'regular export' 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 LeanplumApi::ResourceNotFoundError
+            end
           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/)
+          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 LeanplumApi::ResourceNotFoundError
+            end
           end
         end
+
+        context 's3 export' do
+          let(:s3_bucket_name) { 'bucket' }
+          let(:s3_access_key) { 's3_access_key' }
+          let(:s3_access_id) { 's3_access_id' }
+
+          it 'should request an S3 export'
+        end
       end
 
       context 'get_export_results' do
@@ -195,34 +201,44 @@ describe LeanplumApi::API do
     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([])
+      context 'ab tests' do
+        it 'gets ab tests' do
+          VCR.use_cassette('get_ab_tests') do
+            expect(api.get_ab_tests).to eq([])
+          end
         end
-      end
 
-      it 'gets an ab test' do
-        VCR.use_cassette('get_ab_test') do
-          expect(api.get_ab_tests(1)).to eq([])
+        it 'gets an ab test' do
+          VCR.use_cassette('get_ab_test') do
+            expect(api.get_ab_tests(1)).to eq([])
+          end
         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"
-          }])
+      context 'messages' do
+        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 'throws exception on missing message' do
+          VCR.use_cassette('missing_message') do
+            expect { api.get_message(1234) }.to raise_error LeanplumApi::ResourceNotFoundError
+          end
         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})
+          expect(vars).to eq({ 'test_var' => 1 })
         end
       end
     end

data/spec/fixtures/vcr/missing_message.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://www.leanplum.com/api?action=getMessage&apiVersion=1.0.6&appId=<LEANPLUM_APP_ID>&clientKey=<LEANPLUM_CONTENT_READ_ONLY_KEY>&devMode=false&id=1234
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.2
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Access-Control-Allow-Origin:
+      - "*"
+      Content-Type:
+      - application/json
+      Date:
+      - Mon, 04 Jan 2016 18:15:51 GMT
+      Server:
+      - Google Frontend
+      Cache-Control:
+      - private
+      Alt-Svc:
+      - quic=":443"; ma=604800; v="30,29,28,27,26,25"
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"response":[{"error":{"message":"Message not found."},"success":false}]}'
+    http_version: 
+  recorded_at: Wed, 12 Aug 2015 00:00:00 GMT
+recorded_with: VCR 2.9.3

data/spec/spec_helper.rb

@@ -19,6 +19,7 @@ RSpec.configure do |config|
       configuration.data_export_key = ENV.fetch('LEANPLUM_DATA_EXPORT_KEY')
       configuration.content_read_only_key = ENV.fetch('LEANPLUM_CONTENT_READ_ONLY_KEY')
       configuration.development_key = ENV.fetch('LEANPLUM_DEVELOPMENT_KEY')
+      configuration.logger.level = Logger::FATAL
     end
 
     Timecop.freeze('2015-08-12'.to_time.utc)
@@ -37,7 +38,7 @@ VCR.configure do |c|
   c.filter_sensitive_data('<LEANPLUM_APP_ID>')                { ENV.fetch('LEANPLUM_APP_ID') }
   c.filter_sensitive_data('<LEANPLUM_CONTENT_READ_ONLY_KEY>') { ENV.fetch('LEANPLUM_CONTENT_READ_ONLY_KEY') }
   c.filter_sensitive_data('<LEANPLUM_DATA_EXPORT_KEY>')       { ENV.fetch('LEANPLUM_DATA_EXPORT_KEY') }
-  c.filter_sensitive_data('<LEANPLUM_DEVELOPMENT_KEY>')       { ENV.fetch('LEANPLUM_DEVELOPMENT_KEY') }  
+  c.filter_sensitive_data('<LEANPLUM_DEVELOPMENT_KEY>')       { ENV.fetch('LEANPLUM_DEVELOPMENT_KEY') }
 
   c.default_cassette_options = {
     match_requests_on: [:method, :uri, :body]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leanplum_api
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.5
 platform: ruby
 authors:
 - Lumos Labs, Inc.
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -145,7 +159,7 @@ files:
 - lib/leanplum_api/content_read_only.rb
 - lib/leanplum_api/data_export.rb
 - lib/leanplum_api/development.rb
-- lib/leanplum_api/exception.rb
+- lib/leanplum_api/faraday_middleware/response_validation.rb
 - lib/leanplum_api/http.rb
 - lib/leanplum_api/logger.rb
 - lib/leanplum_api/version.rb
@@ -159,6 +173,7 @@ files:
 - spec/fixtures/vcr/get_export_results.yml
 - spec/fixtures/vcr/get_messages.yml
 - spec/fixtures/vcr/get_vars.yml
+- spec/fixtures/vcr/missing_message.yml
 - spec/fixtures/vcr/reset_anomalous_user.yml
 - spec/fixtures/vcr/set_user_attributes.yml
 - spec/fixtures/vcr/track_events.yml
@@ -201,6 +216,7 @@ test_files:
 - spec/fixtures/vcr/get_export_results.yml
 - spec/fixtures/vcr/get_messages.yml
 - spec/fixtures/vcr/get_vars.yml
+- spec/fixtures/vcr/missing_message.yml
 - spec/fixtures/vcr/reset_anomalous_user.yml
 - spec/fixtures/vcr/set_user_attributes.yml
 - spec/fixtures/vcr/track_events.yml

data/lib/leanplum_api/exception.rb

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