torn_ruby 0.1.0.beta → 1.0.1.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7162049ee394009ba45845e00e4ea788d30b96eab42f647d21f170d577f3ce3a
-  data.tar.gz: 6974bf77a223845a7769d151af60b196707f44841418d80732731d7563eb4766
+  metadata.gz: bf1168a05ee032a581d00e8188c2f53ab677a02c828cf6ec8320b68e48b4c220
+  data.tar.gz: 33188bb3d07fb5c107dfb9c7ca9a84d476f7f2389e4a2f976dff5677fca0565c
 SHA512:
-  metadata.gz: bf6f4abd4fadc268a8a63b9561daa535578468261beec520957944456255e6fdc0d9c077e4c802d0a3c79aa7e4af0a2cd28d9e03ad4f723ae465e7593ac0cb99
-  data.tar.gz: 2682eea306e9fb276d522ef4d79f8171278987514bbef87b70e157423ffc4007cff72cd03cb895f6bc4e34820a23cf0f0d61bbcca3c5bda3cd0e1d192fc82f47
+  metadata.gz: 9a2fc12525e4c16a927c0772301572906098f611fcca87433998e954e1f31cb4dab5b92b653f396560825e17de875e3ffab4b4557f294dfeac416cf2d62e82a6
+  data.tar.gz: 15942273fcc790da47b136513824d9c8dfb84e27c98f1bbb18b562b6cc8acda2433281a9de0c0cbfaf6be6d60d15afbc71c4c1d1668df0d402735adf55b4a697

data/.github/workflows/main.yml

@@ -0,0 +1,27 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby:
+          - '3.3.5'
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run the default task
+        run: bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
-## [0.1.0] - 2025-04-18
+## [0.1.0.beta] - 2025-04-18
 
-- Initial release
+- Initial Beta release
+- Published gem to RubyGems
+- Added `User`, `Faction`, `Property`, `Market` and `Company` endpoints
+- Introduced `valid_fields?` method for field validation in endpoints
+- Setup versioning and pre-release (beta) for early testing
+
+## [1.0.0.beta] - 2025-04-18
+
+- Fully implemented support for Torn API v2 endpoints
+- Added `Racing`, `Forum` , `Torn` endpoint
+- Improved internal architecture by extracting common logic to `Base` endpoint class
+- Added comprehensive test coverage for all v2 endpoints
+- Refactored and documented code for maintainability and clarity

data/Gemfile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in torn_ruby.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "rubocop-rspec", "~> 3.6"
+
+gem "rubocop-rake", "~> 0.7.1"
+
+group :development, :test do
+  gem "pry"
+  gem "pry-byebug"
+end
+
+group :test do
+  gem "simplecov", require: false
+end

data/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: .
+  specs:
+    torn_ruby (0.1.0.beta)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    byebug (12.0.0)
+    coderay (1.1.3)
+    diff-lcs (1.6.1)
+    docile (1.4.1)
+    fiddle (1.1.2)
+    json (2.10.2)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    method_source (1.1.0)
+    parallel (1.27.0)
+    parser (3.3.8.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
+    pry (0.15.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.11.0)
+      byebug (~> 12.0)
+      pry (>= 0.13, < 0.16)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.10.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    rubocop (1.75.2)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.44.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    rubocop-rspec (3.6.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.1)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  fiddle (~> 1.1)
+  pry
+  pry-byebug
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-rake (~> 0.7.1)
+  rubocop-rspec (~> 3.6)
+  simplecov
+  torn_ruby!
+
+BUNDLED WITH
+   2.6.3

data/README.md

@@ -1,4 +1,5 @@
 # TornRuby
+[![Gem Version](https://badge.fury.io/rb/torn_ruby.svg)](https://badge.fury.io/rb/torn_ruby)
 
 An implementation of the [Torn](https://www.torn.com/api.html) V2 API using Ruby.
 
@@ -20,9 +21,20 @@ gem install torn_ruby
 To use the TornRuby gem, you’ll need a valid Torn API key.
 
 ```ruby
+require "torn_ruby"
+
 api_key = "Valid Torn Api Key"
 client = TornRuby::Client.new(api_key:)
+
+# Fetch basic data
 user = client.user
+puts user.name  # => "YourTornName"
+
+# Fetch specific selections by passing symbols
+user = client.user(selections: [:profile])
+
+# Some endpoints require you to specify a path
+racing = client.racing(path: :carupgrades)
 ```
 
 ## Contributing

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "torn_ruby"
+require "pry"
+
+Pry.start

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/torn_ruby/client.rb

@@ -5,11 +5,17 @@ require_relative "endpoints/property"
 require_relative "endpoints/faction"
 require_relative "endpoints/company"
 require_relative "endpoints/market"
+require_relative "endpoints/torn"
+require_relative "endpoints/racing"
+require_relative "endpoints/forum"
 require_relative "user"
 require_relative "property"
 require_relative "faction"
 require_relative "company"
 require_relative "market"
+require_relative "torn"
+require_relative "racing"
+require_relative "forum"
 
 module TornRuby
   # Responsible for interacting with the Torn API
@@ -19,29 +25,44 @@ module TornRuby
       @api_key = api_key
     end
 
-    def user(id: nil, selections: nil)
-      data = TornRuby::Endpoints::User.new(@api_key).fetch(id: id, selections: selections)
+    def user(path: nil, selections: nil)
+      data = TornRuby::Endpoints::User.new(@api_key).fetch(path:, selections:)
       TornRuby::User.new(data)
     end
 
-    def property(id: nil, selections: nil)
-      data = TornRuby::Endpoints::Property.new(@api_key).fetch(id: id, selections: selections)
+    def property(path: nil, selections: nil)
+      data = TornRuby::Endpoints::Property.new(@api_key).fetch(path:, selections:)
       TornRuby::Property.new(data)
     end
 
-    def faction(id: nil, selections: nil)
-      data = TornRuby::Endpoints::Faction.new(@api_key).fetch(id: id, selections: selections)
+    def faction(path: nil, selections: nil)
+      data = TornRuby::Endpoints::Faction.new(@api_key).fetch(path:, selections:)
       TornRuby::Faction.new(data)
     end
 
-    def company(id: nil, selections: nil)
-      data = TornRuby::Endpoints::Company.new(@api_key).fetch(id: id, selections: selections)
+    def company(path: nil, selections: nil)
+      data = TornRuby::Endpoints::Company.new(@api_key).fetch(path:, selections:)
       TornRuby::Company.new(data)
     end
 
-    def market(id: nil, selections: nil)
-      data = TornRuby::Endpoints::Market.new(@api_key).fetch(id: id, selections: selections)
-      TornRuby::Market.new(data)
+    def market(path: nil, selections: nil)
+      data = TornRuby::Endpoints::Market.new(@api_key).fetch(path:, selections:)
+      TornRuby::Company.new(data)
+    end
+
+    def torn(path: nil, selections: nil)
+      data = TornRuby::Endpoints::Torn.new(@api_key).fetch(path:, selections:)
+      TornRuby::Torn.new(data)
+    end
+
+    def racing(path: nil, selections: nil)
+      data = TornRuby::Endpoints::Racing.new(@api_key).fetch(path:, selections:)
+      TornRuby::Racing.new(data)
+    end
+
+    def forum(path: nil, selections: nil)
+      data = TornRuby::Endpoints::Forum.new(@api_key).fetch(path:, selections:)
+      TornRuby::Forum.new(data)
     end
   end
 end

data/lib/torn_ruby/endpoints/base.rb

@@ -14,18 +14,18 @@ module TornRuby
         @api_key = api_key
       end
 
-      def fetch(id: nil, selections: nil)
+      def fetch(path: nil, selections: nil)
         selections = [] if selections.nil?
 
         raise TornRuby::Error, "Invalid fields selected" if respond_to?(:valid_fields?) && !valid_fields?(selections)
 
         params = build_params(selections)
-        path = build_path(id)
+        path = build_path(path)
         handle_response(make_request(build_uri(path, params)))
       end
 
       def valid_fields?(fields)
-        raise NotImplementedError, "#{self.class} must implement #valid_fields?"
+        fields.all? { |field| self.class::AVAILABLE_FIELDS.include?(field) }
       end
 
       private
@@ -40,10 +40,10 @@ module TornRuby
         URI("#{BASE_URL}#{path}?#{params.join("&")}")
       end
 
-      def build_path(id)
-        path = "/#{self.class.name.split("::").last.downcase}"
-        path += "/#{id}" if id
-        path
+      def build_path(path)
+        full_path = "/#{self.class.name.split("::").last.downcase}"
+        full_path += "/#{path}" if path
+        full_path
       end
 
       def make_request(uri)

data/lib/torn_ruby/endpoints/company.rb

@@ -12,14 +12,10 @@ module TornRuby
     # for specific fields to retrieve. The class ensures that only valid fields are requested
     # from the API and handles the response by parsing the JSON data into a usable format.
     class Company < Base
-      AVAILABLE_FIELDS = %w[
+      AVAILABLE_FIELDS = %i[
         companies lookup profile timestamp applications detailed
         employees news stock
       ].freeze
-
-      def valid_fields?(fields)
-        fields.all? { |field| AVAILABLE_FIELDS.include?(field) }
-      end
     end
   end
 end

data/lib/torn_ruby/endpoints/faction.rb

@@ -12,7 +12,7 @@ module TornRuby
     # for specific fields to retrieve. The class ensures that only valid fields are requested
     # from the API and handles the response by parsing the JSON data into a usable format.
     class Faction < Base
-      AVAILABLE_FIELDS = %w[
+      AVAILABLE_FIELDS = %i[
         applications armor armorynews attacknews attacks attacksfull balance basic
         boosters caches cesium chain chainreport chains contributors crimeexp
         crimenews crimes currency donations drugs fundsnews hof lookup mainnews
@@ -20,10 +20,6 @@ module TornRuby
         reports revives revivesfull stats temporary territory territorynews
         timestamp upgrades wars weapons
       ].freeze
-
-      def valid_fields?(fields)
-        fields.all? { |field| AVAILABLE_FIELDS.include?(field) }
-      end
     end
   end
 end

data/lib/torn_ruby/endpoints/forum.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "uri"
+require "net/http"
+require "json"
+require_relative "base"
+
+module TornRuby
+  module Endpoints
+    # Responsible for interacting with the Torn City API's racing endpoint.
+    # It provides methods to fetch racing-related data based on an API key, along with optional selections
+    # for specific fields to retrieve.
+    class Forum < Base
+      AVAILABLE_FIELDS = %i[categories posts thread threads timestamp].freeze
+    end
+  end
+end

data/lib/torn_ruby/endpoints/market.rb

@@ -12,11 +12,7 @@ module TornRuby
     # for specific fields to retrieve. The class ensures that only valid fields are requested
     # from the API and handles the response by parsing the JSON data into a usable format.
     class Market < Base
-      AVAILABLE_FIELDS = %w[bazaar itemmarket lookup pointsmarket timestamp].freeze
-
-      def valid_fields?(fields)
-        fields.all? { |field| AVAILABLE_FIELDS.include?(field) }
-      end
+      AVAILABLE_FIELDS = %i[bazaar itemmarket lookup pointsmarket timestamp].freeze
     end
   end
 end

data/lib/torn_ruby/endpoints/property.rb

@@ -12,11 +12,7 @@ module TornRuby
     # for specific fields to retrieve. The class ensures that only valid fields are requested
     # from the API and handles the response by parsing the JSON data into a usable format.
     class Property < Base
-      AVAILABLE_FIELDS = %w[property].freeze
-
-      def valid_fields?(fields)
-        fields.all? { |field| AVAILABLE_FIELDS.include?(field) }
-      end
+      AVAILABLE_FIELDS = %i[property].freeze
 
       private
 

data/lib/torn_ruby/endpoints/racing.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "uri"
+require "net/http"
+require "json"
+require_relative "base"
+
+module TornRuby
+  module Endpoints
+    # Responsible for interacting with the Torn City API's racing endpoint.
+    # It provides methods to fetch racing-related data based on an API key, along with optional selections
+    # for specific fields to retrieve.
+    class Racing < Base
+      AVAILABLE_FIELDS = %i[ cars carupgrades race races records
+                             tracks lookup timestamp ].freeze
+    end
+  end
+end

data/lib/torn_ruby/endpoints/torn.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "uri"
+require "net/http"
+require "json"
+require_relative "base"
+
+module TornRuby
+  module Endpoints
+    # Responsible for interacting with the Torn City API's torn endpoint.
+    class Torn < Base
+      AVAILABLE_FIELDS = %i[
+        attacklog bounties calendar crimes hof itemammo itemmods subcrimes rankedwarreport rankedwars
+        bank cards chainreport cityshops companies competition dirtybombs education factionhof factiontree
+        gyms honors itemdetails items itemstats logcategories logtypes lookup medals organisedcrimes pawnshop
+        pokertables properties rackets raidreport raids rockpaperscissors searchforcash shoplifting stats
+        stocks territory territorynames territorywarreport territorywars timestamp
+      ].freeze
+    end
+  end
+end

data/lib/torn_ruby/endpoints/user.rb

@@ -12,7 +12,7 @@ module TornRuby
     # for specific fields to retrieve. The class ensures that only valid fields are requested
     # from the API and handles the response by parsing the JSON data into a usable format.
     class User < Base
-      AVAILABLE_FIELDS = %w[
+      AVAILABLE_FIELDS = %i[
         ammo attacks attacksfull bars basic battlestats bazaar
         calendar cooldowns crimes criminalrecord discord display
         education enlistedcars equipment events factionBalance forumfeed
@@ -23,10 +23,6 @@ module TornRuby
         properties races refills reports revives revivesfull skills stocks
         timestamp travel weaponexp workstats
       ].freeze
-
-      def valid_fields?(fields)
-        fields.all? { |field| AVAILABLE_FIELDS.include?(field) }
-      end
     end
   end
 end

data/lib/torn_ruby/forum.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "utils"
+require_relative "base"
+
+module TornRuby
+  # Responsible for representing a Forum in the Torn City game.
+  class Forum < Base
+  end
+end

data/lib/torn_ruby/racing.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "utils"
+require_relative "base"
+
+module TornRuby
+  # Responsible for representing the racing information in the Torn City game.
+  # It encapsulates racing data retrieved from the Torn City API
+  class Racing < Base
+  end
+end

data/lib/torn_ruby/torn.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "utils"
+require_relative "base"
+
+module TornRuby
+  # Responsible for representing the general torn ingormation in the Torn City game.
+  # It encapsulates torn api data retrieved from the Torn City API
+  class Torn < Base
+  end
+end

data/lib/torn_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TornRuby
-  VERSION = "0.1.0.beta"
+  VERSION = "1.0.1.beta"
 end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "simplecov"
+SimpleCov.start
+require "torn_ruby"
+require "pry"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/torn_ruby/base_spec.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe TornRuby::Base do
+  describe "#initialize" do
+    subject(:model) { described_class.new(input_data) }
+
+    let(:input_data) do
+      {
+        "name" => "Bram",
+        "level" => 37,
+        "life" => {
+          "current" => 1725,
+          "maximum" => 1725
+        }
+      }
+    end
+
+    let(:symbolized_data) do
+      {
+        name: "Bram",
+        level: 37,
+        life: {
+          current: 1725,
+          maximum: 1725
+        }
+      }
+    end
+
+    before do
+      allow(TornRuby::Utils).to receive(:deep_symbolize_keys).with(input_data).and_return(symbolized_data)
+    end
+
+    it "symbolizes the keys using TornRuby::Utils.deep_symbolize_keys" do
+      model # trigger the call
+      expect(TornRuby::Utils).to have_received(:deep_symbolize_keys).with(input_data)
+    end
+
+    it "creates accessor methods for each top-level key" do
+      expect(model).to have_attributes(
+        name: "Bram",
+        level: 37,
+        life: hash_including(
+          current: 1725,
+          maximum: 1725
+        )
+      )
+    end
+
+    it "sets instance variables for each key" do
+      expect({
+               name: model.instance_variable_get("@name"),
+               level: model.instance_variable_get("@level"),
+               life: model.instance_variable_get("@life")
+             }).to eq({
+                        name: "Bram",
+                        level: 37,
+                        life: { current: 1725, maximum: 1725 }
+                      })
+    end
+
+    it "does not override existing methods" do
+      class << model
+        def name
+          "Overridden"
+        end
+      end
+
+      expect(model.name).to eq("Overridden")
+    end
+  end
+end