scrimmage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2a817e143f6c56d5336728c7efd42fbf9dbd5daebac99191982ce23bf5014cab
+  data.tar.gz: 04da20f25b988024d168ff453117d9693287bc76e3fa473ebfb35f140aa45fef
+SHA512:
+  metadata.gz: a6843f8d6425d643fdd699a3c0fd87eb440055d0436dd9cf1f9f1d219b1f3c251a6b50d1fa08d26e7ce255d560e8a8f99096ba03b86abf8f4a6d4b3f67528d63
+  data.tar.gz: 9d334bea87a3010133c1e08dfd674b8bef665c0ae03e22006265e19526f96ee916a5d9716e1da8e238cd3790bd0440bd736940e172d8cec8a104a8fe7dac84d2

data/.env.example

@@ -0,0 +1,6 @@
+# ENV template
+# Use this file configure the client to run tests
+
+SCRIMMAGE_API_SERVER_ENDPOINT=
+SCRIMMAGE_PRIVATE_KEY=
+SCRIMMAGE_NAMESPACE=

data/.rubocop.yml

@@ -0,0 +1,25 @@
+require:
+  - rubocop-minitest
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Style/OpenStructUse:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 50
+
+Naming/AccessorMethodName:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-06-12
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at rafe@existentialmutt.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Rafe Rosen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,166 @@
+# Scrimmage Rewards
+
+The low-code loyalty program maker.
+
+This library is a part of the [Scrimmage Rewards Program](https://scrimmage.co)
+that is providing a solution for loyalty programs and rewards.
+
+Tutorial can be found at [Scrimmage Rewards Tutorial](https://scrimmage-rewards.readme.io/docs).
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+1. Load the library (if not using bundler)
+```ruby
+require "scrimmage"
+```
+
+2. Initialize the library with global configuration
+```ruby
+# config/initializers/scrimmage.rb
+Scrimmage.configure do |config|
+  config.api_server_endpoint = '<your api server endpoint>'
+  config.private_key = '<your private key>',
+  config.namespace = '<environment, e.g. staging or production>'
+end
+```
+
+3.  Use the library
+```ruby
+Scrimmage::Rewards.track_rewardable(
+  'unique-user-id',
+  'Data Type Name',
+  {
+    'custom-property': 'custom-value',
+    'custom-property-2': {
+      'custom-property-2-1': 'custom-value-2-1',
+    },
+  },
+)
+```
+
+For one-time events you can use `track_rewardable_once` method. Make sure to use unique event id.
+
+```ruby
+Scrimmage::Rewards.track_rewardable_once(
+  'unique-user-id',
+  'Data Type Name',
+  'unique-event-id',
+  {
+     'custom-property': 'custom-value',
+     'custom-property-2': {
+         'custom-property-2-1': 'custom-value-2-1',
+     },
+  },
+);
+```
+
+4. Get user token
+```ruby
+token = Scrimmage::Users.get_user_token('unique-user-id')
+```
+or
+```ruby
+token = Scrimmage::Users.get_user_token('unique-user-id',
+ tags: ['tag1', 'tag2'],
+ properties: {
+   'custom-property': 'custom-value',
+   'custom-property-2': 12345,
+ },
+)
+```
+
+  Use this token to identify the user on the frontend. Make sure to deliver the token to the frontend securely.
+
+## Multiple connections
+If you want to use multiple connections, you need to create a new instance of `Scrimmage::Client`.
+
+```ruby
+rewarder_for_production = Scrimmage::Client.new(
+  api_server: '<your api server endpoint 1>',
+  private_key: '<your private key 1>',
+  namespace: '<environment 1, e.g. staging or production>',
+)
+
+rewarder_for_staging = Scrimmage::Client.new(
+  api_server: '<your api server endpoint 2>',
+  private_key: '<your private key 2>',
+  namespace: '<environment 2, e.g. staging or production>',
+)
+```
+
+Then you can use the two instances simultaneously.
+
+```ruby
+rewarder_for_production.rewards.track_rewardable(
+  'unique-user-id',
+  'Data Type Name',
+  {
+    'custom-property': 'custom-value',
+    'custom-property-2': {
+      'custom-property-2-1': 'custom-value-2-1',
+    },
+  },
+);
+
+rewarder_for_staging.rewards.track_rewardable(
+  'unique-user-id',
+  'Data Type Name',
+  {
+    'custom-property': 'custom-value',
+    'custom-property-2': {
+      'custom-property-2-1': 'custom-value-2-1',
+    },
+  },
+);
+```
+
+## Configuration
+
+The following configuration parameters can be passed to `Scrimmage.configure` or `Scrimmage::Client.new`
+
+- `api_server_endpoint` the URL of your API server
+- `private_key` your private key
+- `namespace` your environment (e.g. staging or production)
+- `secure` set to `true` when using an https url for `api_server_endpoint` and false when using plain http (default `true`)
+- `retry` set to `false` to skip retrying failed requests or pass a hash with the following keys to configure retry behavior:
+  - `tries` max number of retries (default 3)
+  - `sleep_base` the number of seconds for the initial retry.  Subsequent retries will delay with exponential backoff.  Pass a decimal for fractional seconds (default `0.1`)
+  - `sleep` a fixed number of seconds between retries or a proc that determines the delay based on the number of previous tries.  (default `->(n) { config.retry[:sleep_base] * (2**n) }`)
+
+## Usage on other platforms
+
+- Using `<iframe />`: [github.com/Scrimmage-co/scrimmage-rewards-iframe](https://github.com/Scrimmage-co/scrimmage-rewards-iframe)
+- Using Android: [github.com/Scrimmage-co/scrimmage-rewards-android](https://github.com/Scrimmage-co/scrimmage-rewards-android)
+- Using iOS: [github.com/Scrimmage-co/scrimmage-rewards-ios](https://github.com/Scrimmage-co/scrimmage-rewards-ios)
+- Using Flutter: [github.com/Scrimmage-co/scrimmage-rewards-flutter](https://github.com/Scrimmage-co/scrimmage-rewards-flutter)
+- Using NodeJS: [github.com/Scrimmage-co/rewards/backend-library](https://github.com/Scrimmage-co/rewards/backend-library)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. To run the tests first copy `.env.example` to `.env` and fill it in with your API credentials.  Then you can run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/scrimmage-rewards. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/scrimmage-co/scrimmage-rewards-ruby/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Scrimmage Ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/scrimmage-co/scrimmage-rewards-ruby/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/scrimmage/client.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+require "http"
+require "json"
+require "retryable"
+
+module Scrimmage
+  class Client
+    attr_reader :config, :rewards, :users, :status
+
+    HTTP_NOT_FOUND = 404
+    HTTP_UNAUTHORIZED = 401
+    HTTP_FORBIDDEN = 403
+    SERVICES = %w[api p2e fed nbc].freeze
+
+    # Initialize a new client, specifying any local configuration overrides
+    def initialize(**config_overrides)
+      config_attrs = Scrimmage.config.to_h.merge(config_overrides)
+      @config = Scrimmage::Config.new(**config_attrs)
+
+      @rewards = Scrimmage::Rewards.new(client: self)
+      @users = Scrimmage::Users.new(client: self)
+      @status = Scrimmage::Status.new(client: self)
+    end
+
+    def create_integration_reward(user_id, data_type, event_id_or_reward, reward = nil)
+      if event_id_or_reward.is_a? String
+        event_id = event_id_or_reward
+        rewardable = reward.to_h
+      else
+        event_id = nil
+        rewardable = event_id_or_reward.to_h
+      end
+
+      response = http_request(
+        :post,
+        url("/integrations/rewards"),
+        json: {
+          eventId: event_id,
+          userId: user_id,
+          dataType: data_type,
+          body: rewardable
+        }
+      ) do |my_response|
+        # handle errors
+        case my_response.code
+        when HTTP_NOT_FOUND
+          raise Scrimmage::Errors::AccountNotLinkedError, reward&.user_id
+        when HTTP_UNAUTHORIZED, HTTP_FORBIDDEN
+          raise Scrimmage::Errors::InvalidPrivateKeyError
+        when ->(code) { !(200..299).include?(code) }
+          raise Scrimmage::Errors::RequestFailedError, response
+        end
+      end
+
+      parse_data(response)
+    end
+
+    def get_user_token(user_id, **options)
+      response = http_request(
+        :post,
+        url("/integrations/users"),
+        json: {
+          id: user_id,
+          tags: options[:tags].to_a,
+          properties: options[:properties].to_h
+        }
+      )
+      parse_data(response)&.token
+    end
+
+    #
+    # Requests Service Status
+    #
+    # @param [String] service the code for a scrimmage service e.g. ('api', 'p2e', 'fed', 'nbc')
+    #
+    # @return [Scrimmage::Object] an object detailing service status
+    #
+    def get_service_status(service)
+      my_url = url("/system/status", service: service)
+      response = http_request(:get, my_url)
+      parse_data(response)
+    end
+
+    #
+    # Request overall status for all services
+    #
+    # @return [Boolean] Indicates whether all services are fulfilled
+    #
+    def get_overall_service_status
+      response_data = SERVICES.map do |service|
+        get_service_status(service)
+      end
+      response_data.all? { |d| d&.uptime&.positive? }
+    end
+
+    def get_rewarder_key_details
+      url = url("/rewarders/keys/@me")
+      response = http_request(:get, url)
+
+      parse_data(response)
+    end
+
+    private
+
+    def http_client
+      private_key = config.private_key!
+      namespace = config.namespace!
+
+      HTTP.auth("Token #{private_key}")
+          .headers("Scrimmage-Namespace" => namespace)
+    end
+
+    #
+    # Initiate an authorized http request
+    #
+    # @param [Symbol] method HTTP method (get, post, etc)
+    # @param [String] uri Full URL of the request (build with #url)
+    # @param [Hash] options Options for the request (e.g. json body)
+    # @param [Proc] &block Block to override default response validation
+    #
+    # @return [HTTP::Response]
+    #
+    def http_request(method, uri, options = {}, &block)
+      request_proc = lambda { |*_args|
+        response = http_client.request(method, uri, options)
+
+        if block
+          block.call(response)
+        else
+          Scrimmage::Errors::RequestFailedError unless (200..299).include?(response.code)
+        end
+        response
+      }
+
+      if config.retry
+        Retryable.retryable(tries: config.retry[:tries], sleep: config.retry[:sleep], &request_proc)
+      else
+        request_proc.call
+      end
+    end
+
+    def url(path, service: "api")
+      service_url = config.service_url(service)
+      service_url + path
+    end
+
+    def parse_data(response)
+      JSON.parse(response.body.to_s, object_class: Scrimmage::Object)
+    end
+  end
+end

data/lib/scrimmage/config.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+Scrimmage::Config = Struct.new(
+  :api_server_endpoint,
+  :private_key,
+  :namespace,
+  :secure,
+  :retry,
+  keyword_init: true
+) do |klass|
+  def initialize(**args)
+    super
+    validate_protocol! if api_server_endpoint
+  end
+
+  # define e.g. private_key! to fetch struct member or raise an error
+  klass.members.each do |member_key|
+    define_method "#{member_key}!" do
+      raise Scrimmage::Errors::MissingConfigurationError(member_key) unless send(member_key)
+
+      send(member_key)
+    end
+  end
+
+  def service_url(service)
+    "#{api_server_endpoint}/#{service}"
+  end
+
+  private
+
+  def validate_protocol!
+    protocol_regex = secure ? %r{^https://.+} : %r{^https?://.+}
+    return if api_server_endpoint.match?(protocol_regex)
+
+    raise Scrimmage::Errors::ConfigurationError("Service URL must start with http#{secure ? "s" : ""}://")
+  end
+end

data/lib/scrimmage/errors.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Scrimmage
+  module Errors
+    class Base < StandardError; end
+
+    class ConfigurationError < Base; end
+
+    class MissingConfigurationError < ConfigurationError
+      attr_reader :config_key
+
+      def initialize(config_key)
+        @config_key = config_key
+        super("#{config_key} not configured")
+      end
+    end
+
+    class AccountNotLinkedError < Base
+      attr_reader :user_id
+
+      def initialize(user_id)
+        @user_id = user_id
+        super("Account not linked")
+      end
+    end
+
+    class InvalidPrivateKeyError < Base; end
+
+    class RequestFailedError < Base
+      attr_reader :response
+
+      def initialize(response)
+        @response = response
+        super("HTTP request failed with status #{response.code}")
+      end
+    end
+  end
+end

data/lib/scrimmage/object.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "ostruct"
+
+module Scrimmage
+  class Object < OpenStruct
+  end
+end

data/lib/scrimmage/rewards.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Scrimmage
+  class Rewards
+    attr_reader :client
+
+    def initialize(client: Scrimmage.default_client)
+      @client = client
+    end
+
+    #
+    # Track one or multiple rewards
+    #
+    # @param [String] user_id
+    # @param [String] data_type
+    # @param [Array<Hash>] rewards
+    #
+    # @return [Array<Scrimmage::Object>]
+    #
+    def track_rewardable(user_id, data_type, rewards = [])
+      rewards = [rewards] unless rewards.is_a? Array
+      rewards.map do |reward|
+        client.create_integration_reward(user_id, data_type, reward)
+      end
+    end
+
+    #
+    # Track Rewardable with a single event
+    #
+    # @param [String] user_id
+    # @param [String] data_type
+    # @param [String] unique_id
+    # @param [Hash] reward
+    #
+    # @return [Scrimmage::Object]
+    #
+    def track_rewardable_once(user_id, data_type, unique_id, reward)
+      client.create_integration_reward(user_id, data_type, unique_id, reward)
+    end
+
+    # delegate class methods to new instance
+    class << self
+      extend Forwardable
+      def_delegators :new, :track_rewardable, :track_rewardable_once
+    end
+  end
+end

data/lib/scrimmage/status.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Scrimmage
+  class Status
+    attr_reader :client
+
+    def initialize(client: Scrimmage.default_client)
+      @client = client
+    end
+
+    #
+    # Verify API Service Status
+    #
+    # @return [Hash{verified: Boolean, errors: Array<String>}] A hash object indicating service status
+    #
+    def verify
+      verified = true
+      errors = []
+
+      unless client.get_overall_service_status
+        verified = false
+        errors << "Rewarder API is not available"
+      end
+
+      begin
+        client.get_rewarder_key_details
+      rescue Scrimmage::Errors::RequestFailedError
+        verified = false
+        errors << "Rewarder API key is invalid"
+      end
+      { verified: verified, errors: errors }
+    end
+
+    # delegate class methods to new instance
+    class << self
+      extend Forwardable
+      def_delegators :new, :verify
+    end
+  end
+end

data/lib/scrimmage/users.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Scrimmage
+  class Users
+    attr_reader :client
+
+    def initialize(client: Scrimmage.default_client)
+      @client = client
+    end
+
+    def get_user_token(user_id, **options)
+      client.get_user_token(user_id, **options)
+    end
+
+    # delegate class methods to new instance
+    class << self
+      extend Forwardable
+      def_delegators :new, :get_user_token
+    end
+  end
+end

data/lib/scrimmage/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Scrimmage
+  VERSION = "0.1.0"
+end

data/lib/scrimmage.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "scrimmage/version"
+
+Dir[File.join(__dir__, "scrimmage", "*.rb")].each { |file| require file }
+
+module Scrimmage
+  @config = Scrimmage::Config.new(
+    secure: true,
+    retry: {
+      tries: 3,
+      sleep_base: (100 / 1000.0),
+      sleep: ->(n) { config.retry[:sleep_base] * (2**n) }
+    }
+  )
+
+  module_function
+
+  def configure
+    yield @config
+  end
+
+  def config
+    if block_given?
+      yield @config
+    else
+      @config
+    end
+  end
+
+  def default_client
+    Scrimmage::Client.new
+  end
+end

data/sig/scrimmage.rbs

@@ -0,0 +1,4 @@
+module Scrimmage
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: scrimmage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Scrimmage Co
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: retryable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.5
+description: 
+email:
+- support@scrimmage.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/scrimmage.rb
+- lib/scrimmage/client.rb
+- lib/scrimmage/config.rb
+- lib/scrimmage/errors.rb
+- lib/scrimmage/object.rb
+- lib/scrimmage/rewards.rb
+- lib/scrimmage/status.rb
+- lib/scrimmage/users.rb
+- lib/scrimmage/version.rb
+- sig/scrimmage.rbs
+homepage: https://github.com/scrimmage-co/scrimmage-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/scrimmage-co/scrimmage-ruby
+  source_code_uri: https://github.com/scrimmage-co/ruby-sdk
+  changelog_uri: https://github.com/scrimmage-co/ruby-sdk/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: Ruby SDK for the Scrimmage Rewards API
+test_files: []