extreme_overclocking_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bad0128705a8beafab93b7af85d186c1ba2d91c7a9f9be28f74c8879ecbce994
+  data.tar.gz: 9d5c0ebebd3e8692bb3acd6450a9b6fac7eb2f98893ff52a977b0009fc4a5c0d
+SHA512:
+  metadata.gz: b2fcf604c3957733e0b5a1c1aaaf71ba22da409ee679e256e112bae520a03242112471919d84fc442fe09f3dc6fd031e33c967b156748dbe4bd9978aa2dbd900
+  data.tar.gz: 8dd0b2c58be9dfa69f2fe931cbdcee9eaa07f00b110c675bc926e53a4fc693d2c15b4101d369456b5ce2da13098169fb10de192d41dce98f6e0644e7c60bd2c6

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,39 @@
+# Docs: https://docs.rubocop.org/rubocop/configuration
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.1
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: 'with_fixed_indentation'
+  Enabled: true
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/HashConversion:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: 'consistent_comma'

data/.ruby-version

@@ -0,0 +1 @@
+3.1.0

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Blake Gearin
+
+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,139 @@
+# extreme_overclocking_client
+
+Ruby client for [Extreme Overclocking's Folding@home Data Export](https://folding.extremeoverclocking.com/?nav=XML)
+
+## Getting Started
+
+Install and add to Gemfile:
+
+```bash
+bundle add extreme_overclocking_client
+```
+
+Install without bundler:
+
+```bash
+gem install extreme_overclocking_client
+```
+
+## Usage
+
+Please read the full [usage statement](https://folding.extremeoverclocking.com/?nav=XML) from Extreme Overclocking before using. This client has some simplistic rate limiting built-in, but ultimately it's up to consumers of the gem to prevent excessive queries and abuse. Neglecting to do so may result in your IP being blocked.
+
+- [Service](#service)
+- [Config](#config)
+- [User](#user)
+- [Team](#team)
+
+Data can be retrieved via the `Service` class or individual classes with a configuration parameter.
+
+### Service
+
+```ruby
+service = ExtremeOverclockingClient::Service.new(
+  project_url: "https://github.com/blakegearin/extreme_overclocking_client",
+  project_name: "ExtremeOverclockingClientTesting",
+  project_version: "0.0.1",
+)
+
+user_id = 32334
+name = "EOC_Jason"
+team_id = 11314
+
+# User
+
+user = service.user(id: user_id)
+user = service.user(name: name, team_id: team_id)
+
+# Users
+
+users = service.users(ids: [32334, 811139])
+hashes = [
+  { name: name, team_id: team_id},
+  { name: name, team_id: team_id},
+]
+users = service.users(hashes: hashes)
+
+# Team
+
+team = service.team(id: team_id)
+
+# Teams
+
+teams = service.teams(ids: [11314, 223518])
+```
+
+### Config
+
+Provide a `project_url` and `project_name` to let Extreme Overclocking know what your project is. These values populate referer and user-agent metadata sent with each request.
+
+```ruby
+config = ExtremeOverclockingClient::Config.new(
+  project_url: "https://github.com/blakegearin/extreme_overclocking_client",
+  project_name: "ExtremeOverclockingClientTesting",
+  project_version: "0.0.1",
+)
+```
+
+### User
+
+```ruby
+user_id = 32334
+name = "EOC_Jason"
+team_id = 11314
+config = ExtremeOverclockingClient::Config.new(
+  project_url: "https://github.com/blakegearin/extreme_overclocking_client",
+  project_name: "ExtremeOverclockingClientTesting",
+  project_version: "0.0.1",
+)
+
+# Fetch a user by id
+# Required: config, id
+user = ExtremeOverclockingClient::User.new(config: config, id: user_id)
+
+# Fetch a user with a name and team_id
+# Required: config, name, team_id
+user = ExtremeOverclockingClient::User.new(config: config, name: name, team_id: team_id)
+
+## Update a user with the latest stats
+user.refresh
+```
+
+### Team
+
+```ruby
+id = 11314
+config = ExtremeOverclockingClient::Config.new(
+  project_url: "https://github.com/blakegearin/extreme_overclocking_client",
+  project_name: "ExtremeOverclockingClientTesting",
+  project_version: "0.0.1",
+)
+
+# Fetch a team by id
+team = ExtremeOverclockingClient::Team.new(config: config, id: id)
+
+## Update a team with the latest stats
+team.refresh
+```
+
+## 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, feature requests, and pull requests are welcome.
+
+## Links
+
+- [Folding@home](https://foldingathome.org)
+
+- [Folding@home Download](https://foldingathome.org/start-folding)
+
+- [Folding@home Stats](https://stats.foldingathome.org)
+
+- [EXTREME Overclocking (EOC) Stats](https://folding.extremeoverclocking.com/aggregate_summary.php)
+
+- [EXTREME Overclocking (EOC) Stats Export Info](https://folding.extremeoverclocking.com/?nav=XML)

data/Rakefile

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

data/extreme_overclocking_client.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/extreme_overclocking_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'extreme_overclocking_client'
+  spec.version = ExtremeOverclockingClient::VERSION
+
+  spec.authors = ['Blake Gearin']
+  spec.email = 'hello@blakeg.me'
+
+  spec.summary = 'Ruby client for Extreme Overclocking'
+  spec.description = 'Ruby client for Extreme Overclocking'
+  spec.homepage = 'https://github.com/blakegearin/extreme_overclocking_client'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.1.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/blakegearin/extreme_overclocking_client'
+
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '~> 7.1'
+  spec.add_dependency 'nokogiri', '~> 1.16'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/extreme_overclocking_client/config.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ExtremeOverclockingClient
+  class Config
+    attr_reader :referer, :user_agent
+
+    def initialize(project_url:, project_name:, project_version:)
+      raise ArgumentError, "Param 'project_url' must be defined" unless project_url && !project_url.empty?
+
+      raise ArgumentError, "Param 'project_name' must be defined" unless project_name && !project_name.empty?
+
+      raise ArgumentError, "Param 'project_version' must be defined" unless project_version && !project_version.empty?
+
+      @referer = project_url
+      @user_agent = "#{project_name}/#{project_version} ExtremeOverclockingClient/" \
+                    "#{ExtremeOverclockingClient::VERSION} Ruby/#{RUBY_VERSION}"
+    end
+  end
+end

data/lib/extreme_overclocking_client/request.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: false
+
+require 'active_support/all'
+require 'net/http'
+require 'nokogiri'
+
+ActiveSupport::XmlMini.backend = 'Nokogiri'
+
+module ExtremeOverclockingClient
+  module Request
+    FEED_URL = 'https://folding.extremeoverclocking.com'.freeze
+
+    def request(config:, endpoint:, base_url: FEED_URL, params: {})
+      unless config.is_a?(ExtremeOverclockingClient::Config)
+        raise ArgumentError, "Param 'config' must be an instance of ExtremeOverclockingClient::Config"
+      end
+
+      url = URI.join(base_url, endpoint)
+      url.query = URI.encode_www_form(params) unless params.empty?
+
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true
+
+      request = Net::HTTP::Get.new(url.request_uri)
+      request['Referer'] = config.referer
+      request['User-Agent'] = config.user_agent
+
+      response = http.request(request)
+
+      raise StandardError, response.body unless response.code == '200'
+
+      Hash.from_xml(response.body)
+    end
+  end
+end

data/lib/extreme_overclocking_client/service.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module ExtremeOverclockingClient
+  class Service
+    attr_reader :config
+
+    def initialize(project_url:, project_name:, project_version:)
+      @config = Config.new(
+        project_url:,
+        project_name:,
+        project_version:
+      )
+    end
+
+    def team(id:)
+      raise ArgumentError, 'Required: id' unless id
+
+      Team.new(config: @config, id:)
+    end
+
+    def teams(ids:)
+      raise ArgumentError, 'Required: ids' unless ids
+
+      ids.map do |id|
+        rate_limit
+
+        if id.is_a?(Integer)
+          begin
+            Team.new(config: @config, id:)
+          rescue StandardError => e
+            { id:, error: e }
+          end
+        else
+          { error: "Ids entry is not an integer: #{id}" }
+        end
+      end
+    end
+
+    def user(id:, name: nil, team_id: nil)
+      if id
+        User.new(config: @config, id:)
+      elsif name && team_id
+        User.new(config: @config, name:, team_id:)
+      else
+        raise ArgumentError, 'Required: id or (name and team_id) of user'
+      end
+    end
+
+    def users(ids: nil, hashes: nil)
+      if ids
+        ids.map do |item|
+          rate_limit
+
+          id = nil
+
+          if item.is_a?(Integer)
+            id = item
+          else
+            symbol_hash = item.transform_keys(&:to_sym) if item.is_a?(Hash)
+            id = symbol_hash[:id] if symbol_hash
+          end
+
+          if id
+            User.new(config: @config, id:)
+          else
+            { error: "Could not find id: #{item}" }
+          end
+        rescue StandardError => e
+          { id:, error: e }
+        end
+      elsif hashes
+        hashes.map do |hash|
+          rate_limit
+
+          if hash.is_a?(Hash)
+            symbol_hash = hash.transform_keys(&:to_sym)
+            User.new(
+              config: @config,
+              name: symbol_hash[:name],
+              team_id: symbol_hash[:team_id]
+            )
+          else
+            { error: "Hashes entry is not a hash: #{hash}" }
+          end
+        rescue StandardError => e
+          { id:, error: e }
+        end
+      else
+        raise ArgumentError, 'Required: ids or hashes'
+      end
+    end
+
+    private
+
+    def rate_limit
+      # Limit to 2 calls per second
+      sleep(0.5)
+    end
+  end
+end

data/lib/extreme_overclocking_client/team.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module ExtremeOverclockingClient
+  class Team
+    include Request
+
+    attr_reader :id,
+      :name,
+      :users,
+      :rank,
+      :points,
+      :wus,
+      :updated_at,
+      :retrieved_at
+
+    def initialize(params = {})
+      unless params[:belongs_to_user]
+        config = params[:config] || nil
+
+        unless config.is_a?(ExtremeOverclockingClient::Config)
+          raise ArgumentError, "Param 'config' must be an instance of ExtremeOverclockingClient::Config"
+        end
+
+        id = params[:id] || nil
+
+        raise ArgumentError, 'Required: id of team' unless id.present?
+
+        params = fetch(config:, id:)
+      end
+
+      build(params:)
+    end
+
+    def refresh
+      time_difference_in_hours = (Time.now.utc - Time.parse(@retrieved_at)) / 3600
+
+      return unless time_difference_in_hours >= 3.0
+
+      params = fetch(config: @config, id: @id)
+      build(params:)
+
+      self
+    end
+
+    private
+
+    def fetch(config:, id:)
+      params = { t: id }
+      response = request(
+        config:,
+        endpoint: '/xml/team_summary.php',
+        params:
+      )
+
+      stats_hash = response['EOC_Folding_Stats']
+      params = stats_hash['team']
+      params[:updated_at] = Time.at(stats_hash['status']['Last_Update_Unix_TimeStamp']&.to_i).utc.to_s
+
+      params
+    end
+
+    def build(params:)
+      @id = params['TeamID']&.to_i
+      @name = params['Team_Name']
+      @users = {
+        active: params['Users_Active']&.to_i,
+        total: params['Users']&.to_i,
+      }
+      @rank = {
+        total: params['Rank']&.to_i,
+        day_change: params['Change_Rank_24hr']&.to_i,
+        week_change: params['Change_Rank_7days']&.to_i,
+      }
+      @points = {
+        day_average: params['Points_24hr_Avg']&.to_i,
+        last_day: params['Points_Last_24hr']&.to_i,
+        last_week: params['Points_Last_7days']&.to_i,
+        update: params['Points_Update']&.to_i,
+        today: params['Points_Today']&.to_i,
+        week: params['Points_Week']&.to_i,
+        total: params['Points']&.to_i,
+      }
+      @wus = params['WUs']&.to_i
+
+      @updated_at = params[:updated_at]
+      @retrieved_at = Time.now.utc.to_s
+    end
+  end
+end

data/lib/extreme_overclocking_client/user.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module ExtremeOverclockingClient
+  class User
+    include Request
+
+    attr_reader :id,
+      :name,
+      :rank,
+      :points,
+      :wus,
+      :team,
+      :created_at,
+      :updated_at,
+      :retrieved_at
+
+    def initialize(
+      config:,
+      id: nil,
+      name: nil,
+      team_id: nil
+    )
+      unless config.is_a?(ExtremeOverclockingClient::Config)
+        raise ArgumentError, "Param 'config' must be an instance of ExtremeOverclockingClient::Config"
+      end
+
+      params = fetch(config:, id:, name:, team_id:)
+      build(params:)
+    end
+
+    def refresh
+      time_difference_in_hours = (Time.now.utc - Time.parse(@retrieved_at)) / 3600
+
+      return unless time_difference_in_hours >= 3.0
+
+      params = fetch(config: @config, id: @id)
+      build(params:)
+
+      self
+    end
+
+    private
+
+    def fetch(config:, id: nil, name: nil, team_id: nil)
+      params = {}
+
+      if id
+        params = { u: id }
+      elsif name && team_id
+        params = {
+          t: team_id,
+          un: name,
+        }
+      else
+        raise ArgumentError, 'Required: id or (name and team_id) of user'
+      end
+
+      response = request(
+        config:,
+        endpoint: '/xml/user_summary.php',
+        params:
+      )
+
+      stats_hash = response['EOC_Folding_Stats']
+      params = stats_hash['user']
+      params[:updated_at] = Time.at(stats_hash['status']['Last_Update_Unix_TimeStamp']&.to_i).utc.to_s
+      params[:team] = stats_hash['team']
+
+      params
+    end
+
+    def build(params:)
+      @id = params['UserID']&.to_i
+      @name = params['User_Name']
+      @rank = {
+        team: params['Team_Rank']&.to_i,
+        overall: params['Overall_Rank']&.to_i,
+        day_change: params['Change_Rank_24hr']&.to_i,
+        week_change: params['Change_Rank_7days']&.to_i,
+      }
+      @points = {
+        day_average: params['Points_24hr_Avg']&.to_i,
+        last_day: params['Points_Last_24hr']&.to_i,
+        last_week: params['Points_Last_7days']&.to_i,
+        update: params['Points_Update']&.to_i,
+        today: params['Points_Today']&.to_i,
+        week: params['Points_Week']&.to_i,
+        total: params['Points']&.to_i,
+      }
+      @wus = params['WUs']&.to_i
+
+      @created_at = Time.parse(params['First_Record']).utc.to_s
+      @updated_at = params[:updated_at]
+      @retrieved_at = Time.now.utc.to_s
+
+      team_hash = params[:team]
+      team_hash[:updated_at] = @updated_at
+      team_hash[:belongs_to_user] = true
+
+      @team = Team.new(**team_hash)
+    end
+  end
+end

data/lib/extreme_overclocking_client/version.rb

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

data/lib/extreme_overclocking_client.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'extreme_overclocking_client/version'
+
+# Helpers
+require_relative 'extreme_overclocking_client/config'
+require_relative 'extreme_overclocking_client/request'
+
+# Classes
+require_relative 'extreme_overclocking_client/service'
+require_relative 'extreme_overclocking_client/team'
+require_relative 'extreme_overclocking_client/user'

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: extreme_overclocking_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Blake Gearin
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+description: Ruby client for Extreme Overclocking
+email: hello@blakeg.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- LICENSE
+- README.md
+- Rakefile
+- extreme_overclocking_client.gemspec
+- lib/extreme_overclocking_client.rb
+- lib/extreme_overclocking_client/config.rb
+- lib/extreme_overclocking_client/request.rb
+- lib/extreme_overclocking_client/service.rb
+- lib/extreme_overclocking_client/team.rb
+- lib/extreme_overclocking_client/user.rb
+- lib/extreme_overclocking_client/version.rb
+homepage: https://github.com/blakegearin/extreme_overclocking_client
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/blakegearin/extreme_overclocking_client
+  source_code_uri: https://github.com/blakegearin/extreme_overclocking_client
+  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.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Ruby client for Extreme Overclocking
+test_files: []