trophy_api_client 0

data/lib/trophy_api_client/users/client.rb

@@ -0,0 +1,247 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "../types/metric_response"
+require "json"
+require_relative "../types/achievement_response"
+require "async"
+
+module TrophyApiClient
+  class UsersClient
+    # @return [TrophyApiClient::RequestClient]
+    attr_reader :request_client
+
+    # @param request_client [TrophyApiClient::RequestClient]
+    # @return [TrophyApiClient::UsersClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Get a single user's progress against all active metrics.
+    #
+    # @param user_id [String] ID of the user
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [Array<TrophyApiClient::MetricResponse>]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.allmetrics(user_id: "userId")
+    def allmetrics(user_id:, 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
+        unless request_options.nil? || request_options&.additional_query_parameters.nil?
+          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+        end
+        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)}/users/#{user_id}/metrics"
+      end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.map do |item|
+        item = item.to_json
+        TrophyApiClient::MetricResponse.from_json(json_object: item)
+      end
+    end
+
+    # Get a user's progress against a single active metric.
+    #
+    # @param user_id [String] ID of the user.
+    # @param key [String] Unique key of the metric.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::MetricResponse]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.singlemetric(user_id: "userId", key: "key")
+    def singlemetric(user_id:, key:, 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
+        unless request_options.nil? || request_options&.additional_query_parameters.nil?
+          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+        end
+        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)}/users/#{user_id}/metrics/#{key}"
+      end
+      TrophyApiClient::MetricResponse.from_json(json_object: response.body)
+    end
+
+    # Get all of a user's completed achievements.
+    #
+    # @param user_id [String] ID of the user.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [Array<TrophyApiClient::AchievementResponse>]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.allachievements(user_id: "userId")
+    def allachievements(user_id:, 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
+        unless request_options.nil? || request_options&.additional_query_parameters.nil?
+          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+        end
+        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)}/users/#{user_id}/achievements"
+      end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.map do |item|
+        item = item.to_json
+        TrophyApiClient::AchievementResponse.from_json(json_object: item)
+      end
+    end
+  end
+
+  class AsyncUsersClient
+    # @return [TrophyApiClient::AsyncRequestClient]
+    attr_reader :request_client
+
+    # @param request_client [TrophyApiClient::AsyncRequestClient]
+    # @return [TrophyApiClient::AsyncUsersClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Get a single user's progress against all active metrics.
+    #
+    # @param user_id [String] ID of the user
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [Array<TrophyApiClient::MetricResponse>]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.allmetrics(user_id: "userId")
+    def allmetrics(user_id:, 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
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          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)}/users/#{user_id}/metrics"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do |item|
+          item = item.to_json
+          TrophyApiClient::MetricResponse.from_json(json_object: item)
+        end
+      end
+    end
+
+    # Get a user's progress against a single active metric.
+    #
+    # @param user_id [String] ID of the user.
+    # @param key [String] Unique key of the metric.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::MetricResponse]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.singlemetric(user_id: "userId", key: "key")
+    def singlemetric(user_id:, key:, 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
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          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)}/users/#{user_id}/metrics/#{key}"
+        end
+        TrophyApiClient::MetricResponse.from_json(json_object: response.body)
+      end
+    end
+
+    # Get all of a user's completed achievements.
+    #
+    # @param user_id [String] ID of the user.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [Array<TrophyApiClient::AchievementResponse>]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.allachievements(user_id: "userId")
+    def allachievements(user_id:, 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
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          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)}/users/#{user_id}/achievements"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do |item|
+          item = item.to_json
+          TrophyApiClient::AchievementResponse.from_json(json_object: item)
+        end
+      end
+    end
+  end
+end

data/lib/trophy_api_client/version.rb

@@ -0,0 +1,3 @@
+module MyGem
+  VERSION = "0.1.9"
+end

data/lib/trophy_api_client.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require_relative "environment"
+require_relative "types_export"
+require_relative "requests"
+require_relative "trophy_api_client/achievements/client"
+require_relative "trophy_api_client/metrics/client"
+require_relative "trophy_api_client/users/client"
+
+module TrophyApiClient
+  class Client
+    # @return [TrophyApiClient::AchievementsClient]
+    attr_reader :achievements
+    # @return [TrophyApiClient::MetricsClient]
+    attr_reader :metrics
+    # @return [TrophyApiClient::UsersClient]
+    attr_reader :users
+
+    # @param base_url [String]
+    # @param environment [TrophyApiClient::Environment]
+    # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
+    # @param timeout_in_seconds [Long]
+    # @param api_key [String]
+    # @return [TrophyApiClient::Client]
+    def initialize(api_key:, base_url: nil, environment: TrophyApiClient::Environment::DEFAULT, max_retries: nil,
+                   timeout_in_seconds: nil)
+      @request_client = TrophyApiClient::RequestClient.new(
+        base_url: base_url,
+        environment: environment,
+        max_retries: max_retries,
+        timeout_in_seconds: timeout_in_seconds,
+        api_key: api_key
+      )
+      @achievements = TrophyApiClient::AchievementsClient.new(request_client: @request_client)
+      @metrics = TrophyApiClient::MetricsClient.new(request_client: @request_client)
+      @users = TrophyApiClient::UsersClient.new(request_client: @request_client)
+    end
+  end
+
+  class AsyncClient
+    # @return [TrophyApiClient::AsyncAchievementsClient]
+    attr_reader :achievements
+    # @return [TrophyApiClient::AsyncMetricsClient]
+    attr_reader :metrics
+    # @return [TrophyApiClient::AsyncUsersClient]
+    attr_reader :users
+
+    # @param base_url [String]
+    # @param environment [TrophyApiClient::Environment]
+    # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
+    # @param timeout_in_seconds [Long]
+    # @param api_key [String]
+    # @return [TrophyApiClient::AsyncClient]
+    def initialize(api_key:, base_url: nil, environment: TrophyApiClient::Environment::DEFAULT, max_retries: nil,
+                   timeout_in_seconds: nil)
+      @async_request_client = TrophyApiClient::AsyncRequestClient.new(
+        base_url: base_url,
+        environment: environment,
+        max_retries: max_retries,
+        timeout_in_seconds: timeout_in_seconds,
+        api_key: api_key
+      )
+      @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)
+    end
+  end
+end

data/lib/types_export.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "trophy_api_client/types/metric_status"
+require_relative "trophy_api_client/types/streak_frequency"
+require_relative "trophy_api_client/types/streak_response"
+require_relative "trophy_api_client/types/achievement_response"
+require_relative "trophy_api_client/types/metric_response"
+require_relative "trophy_api_client/types/event_request_user"
+require_relative "trophy_api_client/types/error_body"
+require_relative "trophy_api_client/types/achievement_completion_response"
+require_relative "trophy_api_client/types/event_response_metrics_item"
+require_relative "trophy_api_client/types/event_response"

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: trophy_api_client
+version: !ruby/object:Gem::Version
+  version: '0'
+platform: ruby
+authors:
+- ''
+bindir: exe
+cert_chain: []
+date: 2025-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async-http-faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-net_http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ''
+email: ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/environment.rb
+- lib/gemconfig.rb
+- lib/requests.rb
+- lib/trophy_api_client.rb
+- lib/trophy_api_client/achievements/client.rb
+- lib/trophy_api_client/metrics/client.rb
+- lib/trophy_api_client/types/achievement_completion_response.rb
+- lib/trophy_api_client/types/achievement_response.rb
+- lib/trophy_api_client/types/error_body.rb
+- lib/trophy_api_client/types/event_request_user.rb
+- lib/trophy_api_client/types/event_response.rb
+- lib/trophy_api_client/types/event_response_metrics_item.rb
+- lib/trophy_api_client/types/metric_response.rb
+- lib/trophy_api_client/types/metric_status.rb
+- lib/trophy_api_client/types/streak_frequency.rb
+- lib/trophy_api_client/types/streak_response.rb
+- lib/trophy_api_client/users/client.rb
+- lib/trophy_api_client/version.rb
+- lib/types_export.rb
+homepage: https://github.com/REPO/URL
+licenses: []
+metadata:
+  homepage_uri: https://github.com/REPO/URL
+  source_code_uri: https://github.com/REPO/URL
+  changelog_uri: https://github.com/REPO/URL/blob/master/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: ''
+test_files: []