steamworks 0.1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c4799de857fa2c26896db50b3bda719056184eb9d7fd403599cc1d094e65748
-  data.tar.gz: 3cbed9886f461c0be772d656c9a0bab73f691ad5dcb8e2c883a88d13cf9cd411
+  metadata.gz: 88601346707fc11c18002353b8e70d0e8375fd559c1a70a2d5ddb10eff13565f
+  data.tar.gz: 65ab3bf4f736e5984e221610607a45d87a9da12cc2a6fc671a0787a0a448b329
 SHA512:
-  metadata.gz: e5b24e0c7d5e129b611bd64a2af5444145d648c74cd8e0fa3585d0929bdfa2d8b502f6c220fe10054137ce99cf3257fc8c8095b7085ff5e25c3eee775f55a27d
-  data.tar.gz: 8e146d88dfa763a8f4f82288c3970dc0ce293b02db7e1b029f22f58aa661f799520986b336b4f98b5ea4195fcee9068319ec5fff1b11f1f057d9ebd01b29eea1
+  metadata.gz: 8dd57be9464caeb61287788d4a7d751f3191bebde1c19c3eaf67fae0690270e44a94655f895d68f3c1aa78d9f66c4b60d5337652a896e05d748fc1211aea1d6f
+  data.tar.gz: 195a73fd61f26a0e9d058521691b9b98183bf3e95bd0a3033eaff4511954f5577e6ca97016fb10eac5a389177731bcd81260ce126783584b98e2ec2e2a8a1b8b

data/.rubocop.yml

@@ -13,5 +13,8 @@ Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
 
+Style/Documentation:
+  Enabled: false
+
 Layout/LineLength:
   Max: 120

data/Gemfile

@@ -12,3 +12,7 @@ gem "minitest", "~> 5.0"
 gem "rubocop", "~> 1.21"
 gem "rubocop-minitest"
 gem "rubocop-rake"
+
+gem "falcon", "~> 0.39"
+gem "rack-cors", "~> 1.1"
+gem "sinatra", "~>3.0"

data/README.md

@@ -1,39 +1,27 @@
 # Steamworks
 
-TODO: Delete this and the text below, and describe your gem
+Steamworks Web API client for Ruby.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/steamworks`. To experiment with that code, run `bin/console` for an interactive prompt.
+[Steam official documentation](https://partner.steamgames.com/doc/webapi)
 
-## Installation
+## Supported APIs
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_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.
+- [ISteamUserAuth Interface](https://partner.steamgames.com/doc/webapi/ISteamUserAuth)
+  - AuthenticateUserTicket
 
-Install the gem and add to the application's Gemfile by executing:
+## Example
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+require "steamworks"
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+class Steamworks::Configure
+  set :key, "key"
+  set :appid, "appid"
+  set :identity, "identity"
+end
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+steamworks_api = Steamworks::API.new
 
-## Usage
+steamworks_api.authenticate_user_ticket(ticket: params[:ticket]).to_json
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, 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]/steamworks. 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/[USERNAME]/steamworks/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 Steamworks project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/steamworks/blob/main/CODE_OF_CONDUCT.md).
+```

data/Rakefile

@@ -13,4 +13,8 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
+task :serve do
+  exec "bin/server"
+end
+
 task default: %i[test rubocop]

data/lib/steamworks/api.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Steamworks
+  class API
+    def initialize
+      @partner_conn = Steamworks::Connection.new(gateway: :partner)
+      @public_conn = Steamworks::Connection.new(gateway: :public)
+
+      config = Steamworks::Configure
+      @key = config.key
+      @appid = config.appid
+      @identity = config.identity
+    end
+
+    # https://partner.steamgames.com/doc/webapi/ISteamUserAuth#AuthenticateUserTicket
+    # GET https://partner.steam-api.com/ISteamUserAuth/AuthenticateUserTicket/v1/
+    # key: string
+    # appid: uint32
+    # ticket: string
+    # identity: string
+    def authenticate_user_ticket(ticket: nil)
+      resp = @partner_conn.get("/ISteamUserAuth/AuthenticateUserTicket/v1/") do |req|
+        req.params = {
+          key: @key,
+          appid: @appid,
+          ticket: ticket,
+          identity: @identity
+        }
+      end
+
+      JSON.parse(resp.body)
+    end
+  end
+end

data/lib/steamworks/configure.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Steamworks
+  class Configure
+    extend Configurable
+
+    set :key, "key"
+    set :appid, "appid"
+    set :identity, "identity"
+  end
+end

data/lib/steamworks/connection.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Steamworks
+  class Connection
+    def initialize(gateway: :partner)
+      raise ArgumentError, "Invalid gateway: #{gateway}" unless %i[partner public].include?(gateway)
+
+      @connection = Faraday.new(
+        url: gateway == :partner ? "https://partner.steam-api.com" : "https://api.steampowered.com",
+        headers: { "Content-Type" => "application/x-www-form-urlencoded" }
+      )
+    end
+
+    def get(path)
+      @connection.get(path) do |req|
+        yield(req) if block_given?
+      end
+    end
+
+    def post(path)
+      @connection.post(path) do |req|
+        yield(req) if block_given?
+      end
+    end
+  end
+end

data/lib/steamworks/core_ext/configurable.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# From https://github.com/midori-rb/midori.rb/blob/master/lib/midori/core_ext/configurable.rb
+
+module Configurable
+  # Sets an option to the given value.
+  # @param [Symbol] option the name of config
+  # @param [Object] value value to the name
+  # @param [Boolean] read_only Generate option= method or not
+  # @return [nil] nil
+  def set(option, value = (not_set = true), read_only: false)
+    raise ArgumentError if not_set
+
+    setter = proc { |val| set option, val }
+    getter = proc { value }
+
+    define_singleton("#{option}=", setter) unless read_only
+    define_singleton(option, getter)
+    define_singleton("#{option}?", "!!#{option}") unless method_defined? "#{option}?"
+
+    self
+  end
+
+  private
+
+  # Dynamically defines a method on settings.
+  # @param [String] name method name
+  # @param [Proc] content method content
+  # @return [nil] nil
+  def define_singleton(name, content = Proc.new)
+    singleton_class.class_eval do
+      undef_method(name) if method_defined? name
+      if content.is_a?(String)
+        # rubocop:disable Style/DocumentDynamicEvalDefinition
+        class_eval("def #{name}() #{content}; end", __FILE__, __LINE__)
+        # rubocop:enable Style/DocumentDynamicEvalDefinition
+      else
+        define_method(name, &content)
+      end
+    end
+  end
+end

data/lib/steamworks/errors.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Steamworks
+  class Error < StandardError; end
+end

data/lib/steamworks/version.rb

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

data/lib/steamworks.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
+require "faraday"
+
 require_relative "steamworks/version"
+require_relative "steamworks/errors"
+
+require_relative "steamworks/core_ext/configurable"
+require_relative "steamworks/configure"
 
-module Steamworks
-  class Error < StandardError; end
-  # Your code goes here...
-end
+require_relative "steamworks/connection"
+require_relative "steamworks/api"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: steamworks
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Kowalski Dark
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-05 00:00:00.000000000 Z
-dependencies: []
+date: 2023-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
 description:
 email:
 - github@akenonet.com
@@ -18,12 +32,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rubocop.yml"
-- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/steamworks.rb
+- lib/steamworks/api.rb
+- lib/steamworks/configure.rb
+- lib/steamworks/connection.rb
+- lib/steamworks/core_ext/configurable.rb
+- lib/steamworks/errors.rb
 - lib/steamworks/version.rb
 homepage: https://github.com/yet-another-ai/steamworks.rb
 licenses:

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# 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 nemo.zhang@yetanother.ai. 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.