leanplum_api 2.0.1 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b8d4f6eb38f52bcc546f280eedf54ae413f6029
-  data.tar.gz: 023e78d43a6bd80fb69eb4a225a4fc59a14a72db
+  metadata.gz: 2e94814a101ee266130f5484232809cd1543d641
+  data.tar.gz: 1f6bd9fefa701bad19d839fbc42dcc0833a61d6a
 SHA512:
-  metadata.gz: 93b7f8cd1ce616bcbe16a0c5045363e8defad9a23c746333b91a7bac2bf30dfe1c09b023835e689d01aac07310b9d391eb540ba63853c03cc8b92bcc27b74b5c
-  data.tar.gz: 54648ce19ffa56ff6f4377100181e6347228d1def62dd0af22ec3e4734c27be1385dc0e14848571f527b149dbb691d86a6b0311fa3a71cb582959702edcc1d1c
+  metadata.gz: acbaab2cf26e530ab7fc1f48a5021f6f1732c4b75255448e2f28f079fe6b70a1233f588211f6dd11b82402eb99d625297abc0c96ba3b2e7bfa1aad25891855e2
+  data.tar.gz: 1f72ae8dcd7e107af18433ab762447c0df4f96cb763cc0aefd5276efd4a29402216b3cda8b7b68a3b8b2ed216c9e6ebfd616bbe9d9658e1bbdaa46e6b4e60733

data/README.md

@@ -10,7 +10,7 @@ The gem uses the ```multi``` method with a POST for all event tracking and user
 
 Tested with Leanplum API version 1.0.6.
 
-required_ruby_version is set to 1.9 but this code has only been tested with Ruby 2.1.5!
+`required_ruby_version` is set to 1.9 but this code has only been tested with Ruby 2.1.5 and up!
 
 ## Configuration
 
@@ -125,4 +125,14 @@ export LEANPLUM_API_DEBUG=true
 bundle exec whatever
 ```
 
+Alternatively you can configure the same sort of output in the gem config block:
+
+```ruby
+LeanplumApi.configure do |config|
+  config.api_debug = true
+end
+```
+
+### Developer Mode
+
 You can also configure "developer mode".  This will use the `devMode=true` parameter on some requests, which seems to sends them to a separate queue which might not count towards Leanplum's usage billing.

data/lib/leanplum_api/api.rb

@@ -116,7 +116,18 @@ module LeanplumApi
     end
 
     def user_attributes(user_id)
-      export_user(user_id)['userAttributes']
+      export_user(user_id)['userAttributes'].inject({}) do |attrs, (k, v)|
+        # Leanplum doesn't use true JSON for booleans...
+        if v == 'True'
+          attrs[k] = true
+        elsif v == 'False'
+          attrs[k] = false
+        else
+          attrs[k] = v
+        end
+
+        attrs
+      end
     end
 
     def user_events(user_id)
@@ -205,7 +216,7 @@ module LeanplumApi
     def build_event_attributes_hash(event_hash, options = {})
       event_hash = HashWithIndifferentAccess.new(event_hash)
       event_name = event_hash.delete(:event)
-      fail "Event name or timestamp not provided in #{event_hash}" unless event_name
+      fail ":event key not present in #{event_hash}" unless event_name
 
       event = { action: 'track', event: event_name }.merge(extract_user_id_or_device_id_hash!(event_hash))
       event.merge!(time: event_hash.delete(:time).strftime('%s')) if event_hash[:time]

data/lib/leanplum_api/configuration.rb

@@ -23,9 +23,9 @@ module LeanplumApi
     attr_accessor :development_key
 
     # Optional
+    attr_accessor :api_debug
     attr_accessor :api_version
     attr_accessor :developer_mode
-    attr_accessor :log_path
     attr_accessor :logger
     attr_accessor :timeout_seconds
 
@@ -41,9 +41,7 @@ module LeanplumApi
       @developer_mode = false
       @timeout_seconds = 600
       @logger = LeanplumApi::Logger.new(STDOUT)
-
-      # Deprecated
-      @log_path = 'log'
+      @api_debug = ENV['LEANPLUM_API_DEBUG'].to_s =~ /^(true|t|yes|y|1)$/i
     end
   end
 end

data/lib/leanplum_api/connections/production.rb

@@ -43,17 +43,13 @@ module LeanplumApi::Connection
         connection.request :leanplum_response_validation
         connection.request :json
 
-        connection.response :logger, @logger, bodies: true if api_debug?
+        connection.response :logger, @logger, bodies: true if LeanplumApi.configuration.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
       params = authentication_params.merge(action: 'multi', time: Time.now.utc.strftime('%s'))
       params.merge!(devMode: true) if LeanplumApi.configuration.developer_mode

data/lib/leanplum_api/version.rb

@@ -1,3 +1,3 @@
 module LeanplumApi
-  VERSION = '2.0.1'
+  VERSION = '3.0.1'
 end

data/spec/api_spec.rb

@@ -10,7 +10,8 @@ describe LeanplumApi::API do
       last_name: 'Jones',
       gender: 'm',
       email: 'still_tippin@test.com',
-      create_date: '2010-01-01'.to_date
+      create_date: '2010-01-01'.to_date,
+      is_tipping: true
     }]
   end
 
@@ -24,7 +25,8 @@ describe LeanplumApi::API do
           last_name: 'Jones',
           gender: 'm',
           email: 'still_tippin@test.com',
-          create_date: '2010-01-01'
+          create_date: '2010-01-01',
+          is_tipping: true
         )
       })
     end

data/spec/fixtures/vcr/export_user.yml

@@ -8,7 +8,7 @@ http_interactions:
       string: ''
     headers:
       User-Agent:
-      - Faraday v0.9.2
+      - Faraday v0.10.0
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:
@@ -22,19 +22,21 @@ http_interactions:
       - "*"
       Content-Type:
       - application/json
+      X-Cloud-Trace-Context:
+      - b7ed8a2d93f600276bf6f09eddff4c8c
       Date:
-      - Fri, 01 Jul 2016 14:47:49 GMT
+      - Tue, 15 Nov 2016 10:32:36 GMT
       Server:
       - Google Frontend
+      Content-Length:
+      - '303'
+      Expires:
+      - Tue, 15 Nov 2016 10:32:36 GMT
       Cache-Control:
       - private
-      Alt-Svc:
-      - quic=":443"; ma=2592000; v="34,33,32,31,30,29,28,27,26,25"
-      Transfer-Encoding:
-      - chunked
     body:
       encoding: UTF-8
-      string: '{"response":[{"created":1.43935302887E9,"events":{"purchase":{"count":11}},"lastActive":1.446709787966E9,"states":{},"success":true,"userAttributes":{"first_name":"Mike","create_date":"2010-01-01","email":"still_tippin@test.com","last_name":"Jones","gender":"m"}}]}'
-    http_version: 
+      string: '{"response":[{"totalSessions":0,"created":1.43935302887E9,"events":{"purchase":{"count":24}},"lastActive":1.446709787966E9,"states":{},"success":true,"userAttributes":{"first_name":"Mike","create_date":"2010-01-01","email":"still_tippin@test.com","last_name":"Jones","is_tipping":"True","gender":"m"}}]}'
+    http_version:
   recorded_at: Wed, 12 Aug 2015 04:00:00 GMT
 recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/set_user_attributes.yml

@@ -5,10 +5,10 @@ http_interactions:
     uri: https://www.leanplum.com/api?action=multi&apiVersion=1.0.6&appId=<LEANPLUM_APP_ID>&clientKey=<LEANPLUM_PRODUCTION_KEY>&devMode=false&time=1439352000
     body:
       encoding: UTF-8
-      string: '{"data":[{"userId":123456,"action":"setUserAttributes","userAttributes":{"first_name":"Mike","last_name":"Jones","gender":"m","email":"still_tippin@test.com","create_date":"2010-01-01"}}]}'
+      string: '{"data":[{"userId":123456,"action":"setUserAttributes","userAttributes":{"first_name":"Mike","last_name":"Jones","gender":"m","email":"still_tippin@test.com","create_date":"2010-01-01","is_tipping":true}}]}'
     headers:
       User-Agent:
-      - Faraday v0.9.2
+      - Faraday v0.10.0
       Content-Type:
       - application/json
       Accept-Encoding:
@@ -24,20 +24,22 @@ http_interactions:
       - "*"
       Content-Type:
       - application/json
+      X-Cloud-Trace-Context:
+      - be84cbe23b33980fe7159ca706386efb
       Date:
-      - Fri, 01 Jul 2016 14:47:49 GMT
+      - Tue, 15 Nov 2016 10:28:11 GMT
       Server:
       - Google Frontend
+      Content-Length:
+      - '122'
+      Expires:
+      - Tue, 15 Nov 2016 10:28:11 GMT
       Cache-Control:
       - private
-      Alt-Svc:
-      - quic=":443"; ma=2592000; v="34,33,32,31,30,29,28,27,26,25"
-      Transfer-Encoding:
-      - chunked
     body:
       encoding: UTF-8
       string: '{"response":[{"success":true,"warning":{"message":"Anomaly detected:
         time skew. User will be excluded from analytics."}}]}'
-    http_version: 
+    http_version:
   recorded_at: Wed, 12 Aug 2015 04:00:00 GMT
 recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/track_events_and_attributes.yml

@@ -5,11 +5,11 @@ http_interactions:
     uri: https://www.leanplum.com/api?action=multi&apiVersion=1.0.6&appId=<LEANPLUM_APP_ID>&clientKey=<LEANPLUM_PRODUCTION_KEY>&devMode=false&time=1439352000
     body:
       encoding: UTF-8
-      string: '{"data":[{"userId":123456,"action":"setUserAttributes","userAttributes":{"first_name":"Mike","last_name":"Jones","gender":"m","email":"still_tippin@test.com","create_date":"2010-01-01"}},{"action":"track","event":"purchase","userId":123456,"time":"1439352000","params":{"some_timestamp":"2015-05-01
+      string: '{"data":[{"userId":123456,"action":"setUserAttributes","userAttributes":{"first_name":"Mike","last_name":"Jones","gender":"m","email":"still_tippin@test.com","create_date":"2010-01-01","is_tipping":true}},{"action":"track","event":"purchase","userId":123456,"time":"1439352000","params":{"some_timestamp":"2015-05-01
         01:02:03"}},{"action":"track","event":"purchase_page_view","userId":54321,"time":"1439351400"}]}'
     headers:
       User-Agent:
-      - Faraday v0.9.2
+      - Faraday v0.10.0
       Content-Type:
       - application/json
       Accept-Encoding:
@@ -25,22 +25,24 @@ http_interactions:
       - "*"
       Content-Type:
       - application/json
+      X-Cloud-Trace-Context:
+      - 4a5e92e1cf1088dd41b9caa898272564
       Date:
-      - Fri, 01 Jul 2016 14:47:51 GMT
+      - Tue, 15 Nov 2016 10:29:45 GMT
       Server:
       - Google Frontend
+      Content-Length:
+      - '372'
+      Expires:
+      - Tue, 15 Nov 2016 10:29:45 GMT
       Cache-Control:
       - private
-      Alt-Svc:
-      - quic=":443"; ma=2592000; v="34,33,32,31,30,29,28,27,26,25"
-      Transfer-Encoding:
-      - chunked
     body:
       encoding: UTF-8
       string: '{"response":[{"success":true,"warning":{"message":"Anomaly detected:
         time skew. User will be excluded from analytics."}},{"isOffline":true,"success":true,"warning":{"message":"Anomaly
         detected: time skew. User will be excluded from analytics."}},{"isOffline":true,"success":true,"warning":{"message":"Anomaly
         detected: time skew. User will be excluded from analytics."}}]}'
-    http_version: 
+    http_version:
   recorded_at: Wed, 12 Aug 2015 04:00:00 GMT
 recorded_with: VCR 3.0.3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: leanplum_api
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.0.1
 platform: ruby
 authors:
 - Lumos Labs, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-01 00:00:00.000000000 Z
+date: 2016-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -78,20 +78,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -158,7 +144,6 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - lib/leanplum_api.rb
 - lib/leanplum_api/api.rb
 - lib/leanplum_api/configuration.rb

data/Rakefile

@@ -1,11 +0,0 @@
-require 'bundler/gem_tasks'
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
-task prep: %w(spec)
-
-task default: :spec