trophy_api_client 1.0.17 → 1.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b47c1dffc5c157c7dffe0f36b0ab3dd3ddd2a156b9df8e9a627df0bc76964a69
-  data.tar.gz: ebd77639b480e7c9a86ec6d66d7df2d8a3573f24eb41b73d2f4f53a86c8a7c99
+  metadata.gz: c8d767c67c359d85255fda71dfc5b23dfdbd7ec7703a02843e025c593da2604a
+  data.tar.gz: d661b2fb934daeb5f28d2189646fb3c09294f3f05db4b3454f3f4c2cc337babd
 SHA512:
-  metadata.gz: b3f96b20a61f733c3aa9dab75996649d880857be9afdd41fd28982875bbac47bd0222499bbd5a3ac5738e099eb4e395ccb3d103c47aad07573e4756848b893ca
-  data.tar.gz: 0bbedd740ea253b4b9b5a19a335de5e153fabb163060040723a729870d7cb629451734ab2f9a58be6388d3400f73007526ab0e6394ccb68d3d6a1ebe30870623
+  metadata.gz: 6310df4c2f5a5fcf9a10a1134bbe38860c32fb0ab7af8715c07335152461d8bf8fd1cd1026dd3286a28e80ac31d4e3f9e3d06413ad91d138ba834d26d1773cbb
+  data.tar.gz: 41ec09de29b07a35735a5f188aabcf7cf29e0e14f9c661caf0f15138efc8c153403edec02346e05d89d2fd3b095367f83f7c747c1ef81920355f9e98b33eb902

data/lib/gemconfig.rb

@@ -2,7 +2,7 @@
 
 module TrophyApiClient
   module Gemconfig
-    VERSION = "1.0.17"
+    VERSION = "1.0.19"
     AUTHORS = ["Trophy Labs, Inc"].freeze
     EMAIL = ""
     SUMMARY = "Ruby library for the Trophy API."

data/lib/trophy_api_client/streaks/client.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "types/streaks_rankings_request_type"
+require_relative "../types/streak_ranking_user"
+require "json"
+require "async"
+
+module TrophyApiClient
+  class StreaksClient
+    # @return [TrophyApiClient::RequestClient]
+    attr_reader :request_client
+
+    # @param request_client [TrophyApiClient::RequestClient]
+    # @return [TrophyApiClient::StreaksClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Get the top users by streak length (active or longest).
+    #
+    # @param limit [Integer] Number of users to return. Must be between 1 and 100.
+    # @param type [TrophyApiClient::Streaks::StreaksRankingsRequestType] Whether to rank users by active streaks or longest streaks ever achieved.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [Array<TrophyApiClient::StreakRankingUser>]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.streaks.rankings
+    def rankings(limit: nil, type: nil, request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers = {
+      **(req.headers || {}),
+      **@request_client.get_headers,
+      **(request_options&.additional_headers || {})
+        }.compact
+        req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit, "type": type }.compact
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        req.url "#{@request_client.get_url(request_options: request_options)}/streaks/rankings"
+      end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.map do |item|
+        item = item.to_json
+        TrophyApiClient::StreakRankingUser.from_json(json_object: item)
+      end
+    end
+  end
+
+  class AsyncStreaksClient
+    # @return [TrophyApiClient::AsyncRequestClient]
+    attr_reader :request_client
+
+    # @param request_client [TrophyApiClient::AsyncRequestClient]
+    # @return [TrophyApiClient::AsyncStreaksClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Get the top users by streak length (active or longest).
+    #
+    # @param limit [Integer] Number of users to return. Must be between 1 and 100.
+    # @param type [TrophyApiClient::Streaks::StreaksRankingsRequestType] Whether to rank users by active streaks or longest streaks ever achieved.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [Array<TrophyApiClient::StreakRankingUser>]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.streaks.rankings
+    def rankings(limit: nil, type: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit, "type": type }.compact
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/streaks/rankings"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do |item|
+          item = item.to_json
+          TrophyApiClient::StreakRankingUser.from_json(json_object: item)
+        end
+      end
+    end
+  end
+end

data/lib/trophy_api_client/streaks/types/streaks_rankings_request_type.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  class Streaks
+    class StreaksRankingsRequestType
+      ACTIVE = "active"
+      LONGEST = "longest"
+    end
+  end
+end

data/lib/trophy_api_client/types/streak_ranking_user.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # A user with their streak length in the rankings.
+  class StreakRankingUser
+    # @return [String] The ID of the user.
+    attr_reader :user_id
+    # @return [String] The name of the user. May be null if no name is set.
+    attr_reader :name
+    # @return [Integer] The user's streak length (active or longest depending on query parameter).
+    attr_reader :streak_length
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param user_id [String] The ID of the user.
+    # @param name [String] The name of the user. May be null if no name is set.
+    # @param streak_length [Integer] The user's streak length (active or longest depending on query parameter).
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::StreakRankingUser]
+    def initialize(user_id:, streak_length:, name: OMIT, additional_properties: nil)
+      @user_id = user_id
+      @name = name if name != OMIT
+      @streak_length = streak_length
+      @additional_properties = additional_properties
+      @_field_set = { "userId": user_id, "name": name, "streakLength": streak_length }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of StreakRankingUser
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::StreakRankingUser]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      user_id = parsed_json["userId"]
+      name = parsed_json["name"]
+      streak_length = parsed_json["streakLength"]
+      new(
+        user_id: user_id,
+        name: name,
+        streak_length: streak_length,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of StreakRankingUser to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.user_id.is_a?(String) != false || raise("Passed value for field obj.user_id is not the expected type, validation failed.")
+      obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.streak_length.is_a?(Integer) != false || raise("Passed value for field obj.streak_length is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/version.rb

@@ -1,3 +1,3 @@
 module MyGem
-  VERSION = "1.0.17"
+  VERSION = "1.0.19"
 end

data/lib/trophy_api_client.rb

@@ -6,6 +6,7 @@ require_relative "requests"
 require_relative "trophy_api_client/achievements/client"
 require_relative "trophy_api_client/metrics/client"
 require_relative "trophy_api_client/users/client"
+require_relative "trophy_api_client/streaks/client"
 require_relative "trophy_api_client/points/client"
 
 module TrophyApiClient
@@ -16,6 +17,8 @@ module TrophyApiClient
     attr_reader :metrics
     # @return [TrophyApiClient::UsersClient]
     attr_reader :users
+    # @return [TrophyApiClient::StreaksClient]
+    attr_reader :streaks
     # @return [TrophyApiClient::PointsClient]
     attr_reader :points
 
@@ -37,6 +40,7 @@ module TrophyApiClient
       @achievements = TrophyApiClient::AchievementsClient.new(request_client: @request_client)
       @metrics = TrophyApiClient::MetricsClient.new(request_client: @request_client)
       @users = TrophyApiClient::UsersClient.new(request_client: @request_client)
+      @streaks = TrophyApiClient::StreaksClient.new(request_client: @request_client)
       @points = TrophyApiClient::PointsClient.new(request_client: @request_client)
     end
   end
@@ -48,6 +52,8 @@ module TrophyApiClient
     attr_reader :metrics
     # @return [TrophyApiClient::AsyncUsersClient]
     attr_reader :users
+    # @return [TrophyApiClient::AsyncStreaksClient]
+    attr_reader :streaks
     # @return [TrophyApiClient::AsyncPointsClient]
     attr_reader :points
 
@@ -69,6 +75,7 @@ module TrophyApiClient
       @achievements = TrophyApiClient::AsyncAchievementsClient.new(request_client: @async_request_client)
       @metrics = TrophyApiClient::AsyncMetricsClient.new(request_client: @async_request_client)
       @users = TrophyApiClient::AsyncUsersClient.new(request_client: @async_request_client)
+      @streaks = TrophyApiClient::AsyncStreaksClient.new(request_client: @async_request_client)
       @points = TrophyApiClient::AsyncPointsClient.new(request_client: @async_request_client)
     end
   end

data/lib/types_export.rb

@@ -4,6 +4,7 @@ require_relative "trophy_api_client/users/types/users_metric_event_summary_reque
 require_relative "trophy_api_client/users/types/users_metric_event_summary_response_item"
 require_relative "trophy_api_client/users/types/users_points_event_summary_request_aggregation"
 require_relative "trophy_api_client/users/types/users_points_event_summary_response_item"
+require_relative "trophy_api_client/streaks/types/streaks_rankings_request_type"
 require_relative "trophy_api_client/types/metric_status"
 require_relative "trophy_api_client/types/streak_frequency"
 require_relative "trophy_api_client/types/base_streak_response"
@@ -36,3 +37,4 @@ require_relative "trophy_api_client/types/points_trigger_response_user_attribute
 require_relative "trophy_api_client/types/points_trigger_response_event_attribute"
 require_relative "trophy_api_client/types/points_trigger_response"
 require_relative "trophy_api_client/types/points_system_response"
+require_relative "trophy_api_client/types/streak_ranking_user"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trophy_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.17
+  version: 1.0.19
 platform: ruby
 authors:
 - Trophy Labs, Inc
@@ -102,6 +102,8 @@ files:
 - lib/trophy_api_client/achievements/client.rb
 - lib/trophy_api_client/metrics/client.rb
 - lib/trophy_api_client/points/client.rb
+- lib/trophy_api_client/streaks/client.rb
+- lib/trophy_api_client/streaks/types/streaks_rankings_request_type.rb
 - lib/trophy_api_client/types/achievement_completion_response.rb
 - lib/trophy_api_client/types/achievement_response.rb
 - lib/trophy_api_client/types/achievement_response_trigger.rb
@@ -129,6 +131,7 @@ files:
 - lib/trophy_api_client/types/points_trigger_response_user_attributes_item.rb
 - lib/trophy_api_client/types/points_trigger_type.rb
 - lib/trophy_api_client/types/streak_frequency.rb
+- lib/trophy_api_client/types/streak_ranking_user.rb
 - lib/trophy_api_client/types/streak_response.rb
 - lib/trophy_api_client/types/streak_response_streak_history_item.rb
 - lib/trophy_api_client/types/updated_user.rb