sleeper_ff 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d2eabd815df1063832834aa7efcfa764631331510fab7a4efe816b6ee149171f
+  data.tar.gz: e420eb29b532a533e53e8dd38c0357e477d9465f5eda757e24be9991033960ce
+SHA512:
+  metadata.gz: 83b97c33a2122a7d668f8d8c95788f1b2ec80522617bdfb3895db0395c869c454c92e9846f3ddc1a9a7d94a412f71c967a67dbaf5f6f8b62d2e9cfe14c5330cd
+  data.tar.gz: 5b6d6c0071ddc254bddef7049802dbf19ff98f4362f103f782188a9f56c9ba3e257f00180b6865d662dd285e13f4204343642e7ef31ab6ed81aecac4e876d804

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Josh Mejia
+
+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,122 @@
+# SleeperFF
+
+A Ruby toolkit for the Sleeper Fantasy Football API. This gem provides a simple way to interact with Sleeper's API endpoints.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sleeper_ff'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install sleeper_ff
+```
+
+## Usage
+
+### Quick Start
+
+```ruby
+# Create a new client
+client = SleeperFF.new
+
+# Get user information
+user = client.user("username")
+puts user.display_name
+```
+
+### Configuration
+
+You can configure the client with custom options:
+
+```ruby
+# Configure with a custom user agent
+client = SleeperFF.new(user_agent: "My App v1.0")
+
+# Or configure globally
+SleeperFF.configure do |config|
+  config.user_agent = "My App v1.0"
+  config.api_endpoint = "https://api.sleeper.app/v1" # default
+end
+```
+
+### Available Methods
+
+#### Users
+
+```ruby
+# Get user by username
+user = client.user("username")
+
+# Access user attributes
+user.username       # => "username"
+user.user_id       # => "123456789"
+user.display_name  # => "Display Name"
+user.avatar       # => "avatar_url"
+```
+
+### Leagues
+
+```ruby
+# Get all leagues for a user in a season
+leagues = client.user_leagues("username", 2023)
+
+# Get a specific league
+league = client.league("league_id")
+
+# Get all rosters in a league
+rosters = client.league_rosters("league_id")
+
+# Get all users in a league
+users = client.league_users("league_id")
+```
+
+You can access various attributes on the returned objects:
+
+```ruby
+# League attributes
+league.name          # => "My Fantasy League"
+league.season        # => "2023"
+league.settings      # => { scoring_settings: {...}, roster_settings: {...} }
+league.roster_positions  # => ["QB", "RB", "WR", "TE", "FLEX", "BN", ...]
+
+# Roster attributes
+roster.owner_id      # => "user_id"
+roster.players       # => ["player_id1", "player_id2", ...]
+roster.starters      # => ["player_id1", "player_id2", ...]
+roster.settings      # => { wins: 10, losses: 4, ... }
+```
+
+More endpoints coming soon:
+- Players
+- Drafts
+- Matchups
+- Transactions
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/jmejia/sleeper_ff. 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/jmejia/sleeper_ff/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 SleeperFF project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jmejia/sleeper_ff/blob/main/CODE_OF_CONDUCT.md).

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "sleeper_ff"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sleeper_ff/client/leagues.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module SleeperFF
+  class Client
+    module Leagues
+      # Get all leagues for a user in a season
+      #
+      # @param username [String] Username of the Sleeper user
+      # @param season [Integer] NFL season year (e.g., 2023)
+      # @return [Array<Sawyer::Resource>] Array of league information
+      def user_leagues(username, season)
+        get "user/#{username}/leagues/nfl/#{season}"
+      end
+
+      # Get a specific league
+      #
+      # @param league_id [String] League ID
+      # @return [Sawyer::Resource] League information
+      def league(league_id)
+        get "league/#{league_id}"
+      end
+
+      # Get all rosters in a league
+      #
+      # @param league_id [String] League ID
+      # @return [Array<Sawyer::Resource>] Array of roster information
+      def league_rosters(league_id)
+        get "league/#{league_id}/rosters"
+      end
+
+      # Get all users in a league
+      #
+      # @param league_id [String] League ID
+      # @return [Array<Sawyer::Resource>] Array of user information
+      def league_users(league_id)
+        get "league/#{league_id}/users"
+      end
+    end
+  end
+end 

data/lib/sleeper_ff/client/users.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SleeperFF
+  class Client
+    module Users
+      # Get a user by username
+      #
+      # @param username [String] Username of the Sleeper user
+      # @return [Sawyer::Resource] User information
+      def user(username)
+        get "user/#{username}"
+      end
+    end
+  end
+end 

data/lib/sleeper_ff/client.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "sawyer"
+require "sleeper_ff/configurable"
+require "sleeper_ff/client/users"
+require "sleeper_ff/client/leagues"
+
+module SleeperFF
+  class Client
+    include SleeperFF::Configurable
+    include SleeperFF::Client::Users
+    include SleeperFF::Client::Leagues
+
+    # Header keys that can be passed in options hash
+    CONVENIENCE_HEADERS = Set.new([:accept, :content_type])
+
+    def initialize(options = {})
+      SleeperFF::Configurable.keys.each do |key|
+        value = options[key].nil? ? SleeperFF::Default.send(key) : options[key]
+        instance_variable_set(:"@#{key}", value)
+      end
+    end
+
+    # Make a HTTP GET request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @return [Sawyer::Resource]
+    def get(url, options = {})
+      request :get, url, options
+    end
+
+    private
+
+    def request(method, path, data, options = {})
+      if data.is_a?(Hash)
+        options[:query]   = data.delete(:query) || {}
+        options[:headers] = data.delete(:headers) || {}
+        if accept = data.delete(:accept)
+          options[:headers][:accept] = accept
+        end
+      end
+
+      @last_response = response = agent.call(method, URI::Parser.new.escape(path.to_s), data, options)
+      response.data
+    end
+
+    def agent
+      @agent ||= Sawyer::Agent.new(api_endpoint) do |http|
+        http.headers[:accept] = default_media_type
+        http.headers[:user_agent] = user_agent
+      end
+    end
+  end
+end 

data/lib/sleeper_ff/configurable.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module SleeperFF
+  module Configurable
+    attr_accessor :api_endpoint, :user_agent, :default_media_type
+
+    class << self
+      def keys
+        @keys ||= [
+          :api_endpoint,
+          :user_agent,
+          :default_media_type
+        ]
+      end
+    end
+
+    def configure
+      yield self
+    end
+
+    private
+
+    def reset!
+      SleeperFF::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", SleeperFF::Default.send(key))
+      end
+      self
+    end
+  end
+end 

data/lib/sleeper_ff/default.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module SleeperFF
+  module Default
+    API_ENDPOINT = "https://api.sleeper.app/v1".freeze
+    USER_AGENT = "SleeperFF Ruby Gem #{SleeperFF::VERSION}".freeze
+    MEDIA_TYPE = "application/json".freeze
+
+    class << self
+      def api_endpoint
+        API_ENDPOINT
+      end
+
+      def user_agent
+        USER_AGENT
+      end
+
+      def default_media_type
+        MEDIA_TYPE
+      end
+    end
+  end
+end 

data/lib/sleeper_ff/error.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module SleeperFF
+  # Custom error class for rescuing from all SleeperFF errors
+  class Error < StandardError; end
+
+  # Raised when Sleeper returns a 400 HTTP status code
+  class BadRequest < Error; end
+
+  # Raised when Sleeper returns a 401 HTTP status code
+  class Unauthorized < Error; end
+
+  # Raised when Sleeper returns a 403 HTTP status code
+  class Forbidden < Error; end
+
+  # Raised when Sleeper returns a 404 HTTP status code
+  class NotFound < Error; end
+
+  # Raised when Sleeper returns a 429 HTTP status code
+  class TooManyRequests < Error; end
+
+  # Raised when Sleeper returns a 500 HTTP status code
+  class InternalServerError < Error; end
+
+  # Raised when Sleeper returns a 502 HTTP status code
+  class BadGateway < Error; end
+
+  # Raised when Sleeper returns a 503 HTTP status code
+  class ServiceUnavailable < Error; end
+end 

data/lib/sleeper_ff/version.rb

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

data/lib/sleeper_ff.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "sleeper_ff/version"
+require "sleeper_ff/client"
+require "sleeper_ff/default"
+require "sleeper_ff/error"
+
+module SleeperFF
+  class Error < StandardError; end
+
+  # Return a new SleeperFF::Client instance
+  #
+  # @return [SleeperFF::Client]
+  def self.new(options = {})
+    SleeperFF::Client.new(options)
+  end
+
+  # Delegate to SleeperFF::Client.new
+  #
+  # @return [SleeperFF::Client]
+  def self.client(options = {})
+    SleeperFF::Client.new(options)
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: sleeper_ff
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Mejia
+bindir: bin
+cert_chain: []
+date: 2025-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: sawyer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: Ruby toolkit for the Sleeper Fantasy Football API
+email:
+- joshua.mejia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/setup
+- lib/sleeper_ff.rb
+- lib/sleeper_ff/client.rb
+- lib/sleeper_ff/client/leagues.rb
+- lib/sleeper_ff/client/users.rb
+- lib/sleeper_ff/configurable.rb
+- lib/sleeper_ff/default.rb
+- lib/sleeper_ff/error.rb
+- lib/sleeper_ff/version.rb
+homepage: https://github.com/jmejia/sleeper_ff
+licenses:
+- MIT
+metadata: {}
+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.6.2
+specification_version: 4
+summary: Ruby toolkit for the Sleeper Fantasy Football API
+test_files: []