torn_ruby 0.1.0.beta → 1.0.0.beta

data/spec/torn_ruby/client_spec.rb

@@ -0,0 +1,336 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe TornRuby::Client do
+  let(:api_key) { "test_api_key" }
+  let(:client) { described_class.new(api_key: api_key) }
+
+  describe "#user" do
+    subject(:user) { client.user }
+
+    let(:mock_response) do
+      {
+        "rank" => "Star Trader",
+        "level" => 37,
+        "name" => "Bram",
+        "life" => {
+          "current" => 1725,
+          "maximum" => 1725
+        }
+      }
+    end
+
+    before do
+      user_endpoint = instance_double(TornRuby::Endpoints::User)
+      allow(TornRuby::Endpoints::User).to receive(:new).and_return(user_endpoint)
+      allow(user_endpoint).to receive(:fetch).and_return(mock_response)
+    end
+
+    it "returns a TornRuby::User with expected attributes" do
+      expect(user).to be_a(TornRuby::User)
+        .and have_attributes(
+          rank: "Star Trader",
+          level: 37,
+          name: "Bram",
+          life: hash_including(
+            current: 1725,
+            maximum: 1725
+          )
+        )
+    end
+  end
+
+  describe "#property" do
+    subject(:property) { client.property }
+
+    let(:mock_response) do
+      {
+        "owner_id" => 123_456,
+        "property_type" => 5,
+        "happy" => 9000,
+        "upkeep" => 100_000,
+        "upgrades" => %w[pool gym],
+        "staff" => %w[maid guard],
+        "rented" => false,
+        "users_living" => "123456,654321"
+      }
+    end
+
+    before do
+      property_endpoint = instance_double(TornRuby::Endpoints::Property)
+
+      allow(TornRuby::Endpoints::Property).to receive(:new).and_return(property_endpoint)
+      allow(property_endpoint).to receive(:fetch).and_return(mock_response)
+    end
+
+    it "returns a TornRuby::Property with expected attributes" do
+      expect(property).to be_a(TornRuby::Property)
+        .and have_attributes(
+          owner_id: 123_456,
+          property_type: 5,
+          happy: 9000,
+          upkeep: 100_000,
+          upgrades: %w[pool gym],
+          staff: %w[maid guard],
+          rented: false,
+          users_living: "123456,654321"
+        )
+    end
+
+    it "parses living user ids correctly" do
+      expect(property.living_user_ids).to eq([123_456, 654_321])
+    end
+
+    it "returns false for rented?" do
+      expect(property.rented?).to be(false)
+    end
+  end
+
+  describe "#faction" do
+    subject(:faction) { client.faction }
+
+    let(:mock_response) do
+      {
+        "ID" => 38_761,
+        "name" => "Shadow Healers",
+        "respect" => 2_450_100,
+        "rank" => {
+          "level" => 9,
+          "name" => "Silver",
+          "division" => 3
+        }
+      }
+    end
+
+    before do
+      faction_endpoint = instance_double(TornRuby::Endpoints::Faction)
+      allow(TornRuby::Endpoints::Faction).to receive(:new).and_return(faction_endpoint)
+      allow(faction_endpoint).to receive(:fetch).and_return(mock_response)
+    end
+
+    it "returns a TornRuby::Faction with expected attributes" do
+      expect(faction).to be_a(TornRuby::Faction)
+        .and have_attributes(
+          ID: 38_761,
+          name: "Shadow Healers",
+          respect: 2_450_100,
+          rank: hash_including(
+            level: 9,
+            name: "Silver",
+            division: 3
+          )
+        )
+    end
+  end
+
+  describe "#company" do
+    subject(:company) { client.company }
+
+    let(:mock_response) do
+      {
+        "ID" => 96_842,
+        "company_type" => 26,
+        "rating" => 8,
+        "name" => "Slippery When Wet",
+        "director" => 3_391_134,
+        "employees_hired" => 10,
+        "employees_capacity" => 10,
+        "daily_income" => 1_322_838,
+        "daily_customers" => 24_009,
+        "weekly_income" => 13_071_476,
+        "weekly_customers" => 239_180,
+        "days_old" => 950,
+        "employees" => {
+          "207875" => {
+            "name" => "wryte",
+            "position" => "Manager",
+            "days_in_company" => 236,
+            "last_action" => {
+              "status" => "Offline",
+              "timestamp" => 1_744_802_457,
+              "relative" => "3 days ago"
+            },
+            "status" => {
+              "description" => "Okay",
+              "details" => "",
+              "state" => "Okay",
+              "color" => "green",
+              "until" => 0
+            }
+          }
+        }
+      }
+    end
+
+    before do
+      endpoint = instance_double(TornRuby::Endpoints::Company)
+      allow(TornRuby::Endpoints::Company).to receive(:new).and_return(endpoint)
+      allow(endpoint).to receive(:fetch).and_return(mock_response)
+    end
+
+    it "returns a TornRuby::Company with expected attributes" do
+      expect(company).to be_a(TornRuby::Company)
+        .and have_attributes(
+          name: "Slippery When Wet",
+          director: 3_391_134,
+          employees_hired: 10,
+          daily_income: 1_322_838
+        )
+    end
+
+    it "has employee data accessible by string ID" do
+      employee = company.employees["207875"]
+      expect(employee).to include(
+        name: "wryte",
+        position: "Manager",
+        days_in_company: 236,
+        last_action: hash_including(
+          status: "Offline",
+          timestamp: 1_744_802_457,
+          relative: "3 days ago"
+        ),
+        status: hash_including(
+          description: "Okay",
+          state: "Okay",
+          color: "green"
+        )
+      )
+    end
+  end
+
+  describe "#market" do
+    subject(:market) { client.market }
+
+    let(:mock_response) do
+      {
+        "ID" => 96_842,
+        "company_type" => 26,
+        "rating" => 8,
+        "name" => "Slippery When Wet",
+        "director" => 3_391_134,
+        "employees_hired" => 10,
+        "employees_capacity" => 10,
+        "daily_income" => 1_322_838,
+        "daily_customers" => 24_009,
+        "weekly_income" => 13_071_476,
+        "weekly_customers" => 239_180,
+        "days_old" => 950
+      }
+    end
+
+    before do
+      market_endpoint = instance_double(TornRuby::Endpoints::Market)
+      allow(TornRuby::Endpoints::Market).to receive(:new).and_return(market_endpoint)
+      allow(market_endpoint).to receive(:fetch).and_return(mock_response)
+    end
+
+    it "returns a TornRuby::Company with expected attributes" do
+      expect(market).to be_a(TornRuby::Company)
+        .and have_attributes(
+          name: "Slippery When Wet",
+          director: 3_391_134,
+          employees_hired: 10,
+          daily_income: 1_322_838
+        )
+    end
+  end
+
+  describe "#torn" do
+    subject(:torn) { client.torn }
+
+    let(:mock_response) do
+      {
+        "bounties" => [
+          {
+            "target_id" => 2_556_147,
+            "target_name" => "salakau",
+            "target_level" => 36,
+            "lister_id" => 2_932_719,
+            "lister_name" => "Ridyard",
+            "reward" => 1_000_000,
+            "reason" => nil,
+            "quantity" => 1,
+            "is_anonymous" => false,
+            "valid_until" => 1_745_619_969
+          }
+        ]
+      }
+    end
+
+    before do
+      torn_endpoint = instance_double(TornRuby::Endpoints::Torn)
+      allow(TornRuby::Endpoints::Torn).to receive(:new).and_return(torn_endpoint)
+      allow(torn_endpoint).to receive(:fetch).and_return(mock_response)
+    end
+
+    it "returns a TornRuby::Torn with expected attributes" do
+      expect(torn).to be_a(TornRuby::Torn)
+        .and have_attributes(
+          bounties: match_array(
+            hash_including(
+              target_id: 2_556_147,
+              target_name: "salakau",
+              target_level: 36,
+              lister_id: 2_932_719,
+              lister_name: "Ridyard",
+              reward: 1_000_000,
+              reason: nil,
+              quantity: 1,
+              is_anonymous: false,
+              valid_until: 1_745_619_969
+            )
+          )
+        )
+    end
+  end
+
+  describe "#racing" do
+    subject(:racing) { client.racing }
+
+    let(:mock_response) do
+      {
+        "cars": [
+          {
+            "car_item_id": 77,
+            "car_item_name": "Tabata RM2",
+            "top_speed": 25,
+            "acceleration": 20,
+            "braking": 15,
+            "dirt": 15,
+            "handling": 20,
+            "safety": 20,
+            "tarmac": 20,
+            "class": "D"
+          }
+        ]
+      }
+    end
+
+    before do
+      racing_endpoint = instance_double(TornRuby::Endpoints::Racing)
+      allow(TornRuby::Endpoints::Racing).to receive(:new).and_return(racing_endpoint)
+      allow(racing_endpoint).to receive(:fetch).and_return(mock_response)
+    end
+
+    it "returns a TornRuby::Racing with expected attributes" do
+      expect(racing).to be_a(TornRuby::Racing)
+        .and have_attributes(
+          cars: match_array(
+            hash_including(
+              car_item_id: 77,
+              car_item_name: "Tabata RM2",
+              top_speed: 25,
+              acceleration: 20,
+              braking: 15,
+              dirt: 15,
+              handling: 20,
+              safety: 20,
+              tarmac: 20,
+              class: "D"
+            )
+          )
+        )
+    end
+  end
+end

data/spec/torn_ruby/company_spec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "spec_helper"

data/spec/torn_ruby/endpoints/company_spec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "spec_helper"

data/spec/torn_ruby/endpoints/faction_spec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "spec_helper"

data/spec/torn_ruby/endpoints/forum_spec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "spec_helper"

data/spec/torn_ruby/endpoints/market_spec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "spec_helper"

data/spec/torn_ruby/endpoints/property_spec.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "torn_ruby/endpoints/user"
+
+RSpec.describe TornRuby::Endpoints::Property do
+  let(:api_key) { "test_api_key" }
+  let(:property_endpoint) { described_class.new(api_key) }
+
+  describe "#handle_response" do
+    context "when the response is a success" do
+      let(:successful_response) do
+        instance_double(Net::HTTPSuccess, is_a?: true, code: "200", message: "OK", body: '{"property": "value"}')
+      end
+
+      it "parses the response body and returns the property" do
+        result = property_endpoint.send(:handle_response, successful_response)
+        expect(result).to eq("value")
+      end
+    end
+
+    context "when the response is not a success" do
+      let(:error_response) do
+        instance_double(Net::HTTPResponse, is_a?: false, code: "500", message: "Internal Server Error", body: "")
+      end
+
+      it "raises a TornRuby::Error with the appropriate message" do
+        expect do
+          property_endpoint.send(:handle_response, error_response)
+        end.to raise_error(TornRuby::Error, "API request failed: 500 Internal Server Error")
+      end
+    end
+  end
+end

data/spec/torn_ruby/endpoints/racing_spec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "spec_helper"

data/spec/torn_ruby/endpoints/torn_spec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "spec_helper"

data/spec/torn_ruby/endpoints/user_spec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "spec_helper"

data/spec/torn_ruby/faction_spec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "spec_helper"

data/spec/torn_ruby/forum_spec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "spec_helper"

data/spec/torn_ruby/market_spec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "spec_helper"

data/spec/torn_ruby/property_spec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe TornRuby::Property do
+  subject(:property) { described_class.new(data) }
+
+  let(:data) do
+    {
+      "owner_id" => 2_187_512,
+      "property_type" => 13,
+      "happy" => 5025,
+      "upkeep" => 100_000,
+      "upgrades" => [
+        "Superior interior",
+        "Large pool",
+        "Extra large vault"
+      ],
+      "staff" => [
+        "5x Maid service",
+        "3x Butler service"
+      ],
+      "rented" => {
+        "user_id" => 2_728_237,
+        "days_left" => 73,
+        "total_cost" => 81_000_000,
+        "cost_per_day" => 810_000
+      },
+      "users_living" => "2725863,2728237"
+    }
+  end
+
+  describe "#living_user_ids" do
+    it "returns an array of user IDs as integers" do
+      expect(property.living_user_ids).to eq([2_725_863, 2_728_237])
+    end
+  end
+
+  describe "#rented?" do
+    it "returns true when rented data is present" do
+      expect(property.rented?).to be true
+    end
+  end
+end

data/spec/torn_ruby/racing_spec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "spec_helper"

data/spec/torn_ruby/torn_spec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "spec_helper"

data/spec/torn_ruby/user_spec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "spec_helper"

data/spec/torn_ruby/utils_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe TornRuby::Utils do
+  describe ".deep_symbolize_keys" do
+    it "symbolizes top-level keys" do
+      input = { "foo" => "bar" }
+      result = described_class.deep_symbolize_keys(input)
+      expect(result).to eq({ foo: "bar" })
+    end
+
+    it "recursively symbolizes nested hash keys" do
+      input = { "outer" => { "inner" => "value" } }
+      result = described_class.deep_symbolize_keys(input)
+      expect(result).to eq({ outer: { inner: "value" } })
+    end
+
+    it "symbolizes keys in hashes within arrays" do
+      input = { "list" => [{ "id" => 1 }, { "id" => 2 }] }
+
+      result = described_class.deep_symbolize_keys(input)
+      expect(result).to eq({ list: [{ id: 1 }, { id: 2 }] })
+    end
+
+    it "leaves non-hash, non-array values untouched" do
+      input = "string"
+      result = described_class.deep_symbolize_keys(input)
+      expect(result).to eq("string")
+    end
+  end
+end

data/spec/torn_ruby_spec.rb

@@ -0,0 +1 @@
+# frozen_string_literal: true

data/torn_ruby.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/torn_ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "torn_ruby"
+  spec.version = TornRuby::VERSION
+  spec.authors = ["Bram"]
+  spec.email = ["bramjanssen@hey.com"]
+
+  spec.summary = "A Ruby gem for interacting with the Torn City API, providing easy access to" \
+                 "game data and functionality."
+  spec.description = "A Ruby gem that provides a convenient wrapper around the Torn City API." \
+                     "Ideal for developers looking to integrate Torn City data into Ruby applications."
+
+  spec.homepage = "https://github.com/ibramsterdam/torn_ruby"
+
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  gemspec = File.basename(__FILE__)
+  spec.files = IO.popen(%w[git ls-files -z], chdir: __dir__, err: IO::NULL) do |ls|
+    ls.readlines("\x0", chomp: true).reject do |f|
+      (f == gemspec) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+      f.end_with?(".gem") # Exclude .gem files
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_development_dependency "fiddle", "~> 1.1"
+  spec.add_development_dependency "pry", "~> 0.15"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: torn_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta
+  version: 1.0.0.beta
 platform: ruby
 authors:
 - Bram
@@ -10,33 +10,33 @@ cert_chain: []
 date: 2025-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: fiddle
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: fiddle
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0.15'
 description: A Ruby gem that provides a convenient wrapper around the Torn City API.Ideal
   for developers looking to integrate Torn City data into Ruby applications.
 email:
@@ -45,13 +45,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
+- ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - lib/torn_ruby.rb
 - lib/torn_ruby/base.rb
 - lib/torn_ruby/client.rb
@@ -59,24 +65,49 @@ files:
 - lib/torn_ruby/endpoints/base.rb
 - lib/torn_ruby/endpoints/company.rb
 - lib/torn_ruby/endpoints/faction.rb
+- lib/torn_ruby/endpoints/forum.rb
 - lib/torn_ruby/endpoints/market.rb
 - lib/torn_ruby/endpoints/property.rb
+- lib/torn_ruby/endpoints/racing.rb
+- lib/torn_ruby/endpoints/torn.rb
 - lib/torn_ruby/endpoints/user.rb
 - lib/torn_ruby/faction.rb
+- lib/torn_ruby/forum.rb
 - lib/torn_ruby/market.rb
 - lib/torn_ruby/property.rb
+- lib/torn_ruby/racing.rb
+- lib/torn_ruby/torn.rb
 - lib/torn_ruby/user.rb
 - lib/torn_ruby/utils.rb
 - lib/torn_ruby/version.rb
 - sig/torn_ruby.rbs
+- spec/spec_helper.rb
+- spec/torn_ruby/base_spec.rb
+- spec/torn_ruby/client_spec.rb
+- spec/torn_ruby/company_spec.rb
+- spec/torn_ruby/endpoints/company_spec.rb
+- spec/torn_ruby/endpoints/faction_spec.rb
+- spec/torn_ruby/endpoints/forum_spec.rb
+- spec/torn_ruby/endpoints/market_spec.rb
+- spec/torn_ruby/endpoints/property_spec.rb
+- spec/torn_ruby/endpoints/racing_spec.rb
+- spec/torn_ruby/endpoints/torn_spec.rb
+- spec/torn_ruby/endpoints/user_spec.rb
+- spec/torn_ruby/faction_spec.rb
+- spec/torn_ruby/forum_spec.rb
+- spec/torn_ruby/market_spec.rb
+- spec/torn_ruby/property_spec.rb
+- spec/torn_ruby/racing_spec.rb
+- spec/torn_ruby/torn_spec.rb
+- spec/torn_ruby/user_spec.rb
+- spec/torn_ruby/utils_spec.rb
+- spec/torn_ruby_spec.rb
+- torn_ruby.gemspec
 homepage: https://github.com/ibramsterdam/torn_ruby
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/ibramsterdam/torn_ruby
-  source_code_uri: https://github.com/ibramsterdam/torn_ruby
-  changelog_uri: https://github.com/ibramsterdam/torn_ruby/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib