openpanel-sdk 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f058e44eeada090f73556e3717608d7f61868776840970d2ca51ffa14120b108
-  data.tar.gz: c9a7d201a55dca8e07096e13e8a5d7e415970cd2ccda2b3bae1ff2c08280db8a
+  metadata.gz: d14ac55d813c9ee97bcee346b856798bd52b1acac190a62945b4914f6588d1ad
+  data.tar.gz: 9bd22b7c57b950edb91b33c98c4653ad43dcbd18906dddda910fdb402481ec26
 SHA512:
-  metadata.gz: fbe6e1946cb014f429fdce91ab381900f7701a536a6142b8eac6cdf7a957f8e2264933f525f90ac9b20eba370c826dfa323cbf018cb29d62405a4fbb7e51560e
-  data.tar.gz: 1b3254a51f15c7a4604013c56b523fe1e53263d32c0c815e71a578970e08b097357f30462015442eaa4b523655eb885961c0114871bf5ea82e346d4ef284c0c5
+  metadata.gz: 36be770f2140341f272334848831d667be6dbd44435e2aa6fa5a2ae1752fa76ee7b8c67bf348611c06b6b9817423fe3c11b5eb6835e61bdc0faa7d214ad7701b
+  data.tar.gz: 41be2ad0aeeb1ceb343e1fce8190591447bba27827bf0c7bbba2349e8ec2edcd0374ffd259bea6c30cffb5ea7f35735ec8fdea2322a087831df852f763df59f0

data/README.md

@@ -16,9 +16,21 @@ If bundler is not being used to manage dependencies, install the gem by executin
 gem install openpanel-sdk
 ```
 
-## Usage
+## Usage example
 
-TODO: Write usage instructions here
+Use the gem by adding the following line to the Gemfile:
+
+```ruby
+tracker = OpenPanel::SDK::Tracker.new
+identify_user = OpenPanel::SDK::IdentifyUser.new
+
+# ... set user props
+
+tracker.identify identify_user
+tracker.track 'test_event', payload: { name: 'test' }
+tracker.increment_property identify_user, 'test_property', 1
+tracker.decrement_property identify_user, 'test_property', 1
+```
 
 ## Development
 

data/Rakefile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 

data/lib/openpanel/sdk/identify_user.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module OpenPanel
   module SDK
     class IdentifyUser
       attr_accessor :profile_id, :email, :first_name, :last_name, :properties
 
-      def to_json
+      def to_json(*_args)
         {
           profileId: profile_id,
           email: email,

data/lib/openpanel/sdk/tracker.rb

@@ -1,26 +1,30 @@
-require "faraday"
+# frozen_string_literal: true
+
+require 'faraday'
 
 module OpenPanel
   module SDK
     class OpenPanelError < StandardError; end
 
     class Tracker
-      TRACKING_TYPE_IDENTIFY = "identify"
-      TRACKING_TYPE_TRACK = "track"
-      TRACKING_TYPE_INCREMENT = "increment"
-      TRACKING_TYPE_DECREMENT = "decrement"
+      TRACKING_TYPE_IDENTIFY = 'identify'
+      TRACKING_TYPE_TRACK = 'track'
+      TRACKING_TYPE_INCREMENT = 'increment'
+      TRACKING_TYPE_DECREMENT = 'decrement'
 
       attr_reader :headers
 
       ##############################
       # Initialize OpenPanel tracker
+      # @param disabled [Boolean] disable sending tracking events, defaults to false
       ##############################
-      def initialize
+      def initialize(disabled: false)
         @headers = {
-          "Content-Type" => "application/json",
-          "openpanel-client-id" => ENV["OPENPANEL_CLIENT_ID"],
-          "openpanel-client-secret" => ENV["OPENPANEL_CLIENT_SECRET"],
+          'Content-Type' => 'application/json',
+          'openpanel-client-id' => ENV['OPENPANEL_CLIENT_ID'],
+          'openpanel-client-secret' => ENV['OPENPANEL_CLIENT_SECRET']
         }
+        @disabled = disabled
       end
 
       ##############################
@@ -52,9 +56,9 @@ module OpenPanel
       ##############################
       def track_page_view(user, path)
         if user
-          track "view", payload: { profileId: user.profile_id, path: path }
+          track 'view', payload: { profileId: user.profile_id, path: path }
         else
-          track "view", payload: { path: path }
+          track 'view', payload: { path: path }
         end
       end
 
@@ -64,13 +68,20 @@ module OpenPanel
       # @param user [OpenPanel::SDK::IdentifyUser] user to identify
       ##############################
       def identify(user)
-        payload = { profileId: user.profile_id, firstName: user.first_name, lastName: user.last_name, email: user.email }
+        payload = { profileId: user.profile_id, firstName: user.first_name, lastName: user.last_name,
+                    email: user.email }
         payload = { type: TRACKING_TYPE_IDENTIFY, payload: payload }
 
         send_request payload: payload
       end
 
-      def increment_property(user, property = "visits", value = 1)
+      ##############################
+      # Decrement property in OpenPanel
+      # @param user [User] user to identify
+      # @param property [String] property to increment
+      # @param value [Integer] value to increment by
+      #############################
+      def increment_property(user, property = 'visits', value = 1)
         payload = { profileId: user.profile_id, property: property, value: value }
         payload = { type: TRACKING_TYPE_INCREMENT, payload: payload }
 
@@ -80,8 +91,10 @@ module OpenPanel
       ##############################
       # Decrement property in OpenPanel
       # @param user [User] user to identify
+      # @param property [String] property to increment
+      # @param value [Integer] value to decrement by
       #############################
-      def decrement_property(user, property = "visits", value = 1)
+      def decrement_property(user, property = 'visits', value = 1)
         payload = { profileId: user.profile_id, property: property, value: value }
         payload = { type: TRACKING_TYPE_DECREMENT, payload: payload }
 
@@ -94,17 +107,21 @@ module OpenPanel
       # Send request to OpenPanel API
       # @param url [String] API endpoint URL
       # @param payload [Hash] request payload
+      # @return [Faraday::Response] The Faraday plain response object
+      # @raise [OpenPanel::SDK::OpenPanelError] if request fails
       ##############################
-      def send_request(url: ENV["OPENPANEL_TRACK_URL"], payload: {})
+      def send_request(url: ENV['OPENPANEL_TRACK_URL'], payload: {})
+        return if @disabled
+
         response = Faraday.post url, payload.to_json, @headers
 
         case response.status
         when 401
-          raise OpenPanel::SDK::OpenPanelError, "Unauthorized"
+          raise OpenPanel::SDK::OpenPanelError, 'Unauthorized'
         when 429
-          raise OpenPanel::SDK::OpenPanelError, "Too many requests"
+          raise OpenPanel::SDK::OpenPanelError, 'Too many requests'
         when 500
-          raise OpenPanel::SDK::OpenPanelError, "Internal server error"
+          raise OpenPanel::SDK::OpenPanelError, 'Internal server error'
         else
           response
         end

data/lib/openpanel/sdk/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module OpenPanel
   module SDK
-    VERSION = "0.1.1"
+    VERSION = '0.1.2'
   end
 end

data/lib/openpanel/sdk.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "sdk/identify_user"
-require_relative "sdk/tracker"
-require_relative "sdk/version"
+require_relative 'sdk/identify_user'
+require_relative 'sdk/tracker'
+require_relative 'sdk/version'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openpanel-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Thomas Stätter