esirb 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 94353029d857afc9d90b2c82d0f7d0c4f4f0aa907ffbd0f48f94024a88cb8c9b
+  data.tar.gz: e73055498ed2e2d6dfcb0c97208b6b4beb8ea2907717b6c405ac357801eed36b
+SHA512:
+  metadata.gz: 647a5145b585538150d6cfde39f082292e51989a471757da4092fae87fc59dfe5aff3827f0441cfa54ea9c3832c0a220ed3ac697822326529e0e357f30ab452a
+  data.tar.gz: 8811c42691a106c6c8ad888c61248724bf7706ee21def1c7039b0a1ec005df8aa02d1cb58bbc626cc647aef47754f6501b3e5edf6dfa60c8adddf667b8174fc7

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.4.7

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-06-04
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 sicks
+
+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,80 @@
+# Esirb
+
+Esirb is a light wrapper around Faraday for the purposes of interacting with Eve Online's Swagger API.
+
+I wanted something low maintenance, so this gem makes a few assumptions to let you dynamically generate any path that might end up on the ESI.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add esirb
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install esirb
+```
+
+## Usage
+
+
+### Create a client
+```ruby
+client = Esirb::Client.new
+```
+##### Create a client with a token
+```ruby
+client = Esirb::Client.new(token: "...")
+```
+
+### Build the path, with any path parameters
+
+Treat ESI static paths as method names, and path parameters as the arguments for those methods. Chain these methods to build the path to the desired ESI endpoint.
+
+```ruby
+
+path = client.route(3000142, 30002187)
+path.string # => "/route/3000142/30002187"
+
+path = client.ui.autopilot.waypoint
+path.string # => "/ui/autopilot/waypoint"
+
+path = client.characters(123456789).location
+path.string # => "/characters/123456789/location"
+```
+
+### Make the request, with any query parameters or body
+
+Call an http verb, optionally passing `params`, `body` or `headers`.
+
+```ruby
+resp = path.get # => #<Faraday::Response>
+resp.status # => 204
+resp.body # => { "solar_system_id": 30000142 }
+
+# check ESI documentation to know whether you need to pass query parameters, or a body
+resp = path.post(params:, body:, headers:)
+```
+
+### All together now
+```ruby
+client = Esirb::Client.new
+list_of_alliance_ids = client.alliances.get.body # => [...]
+```
+
+## 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/[USERNAME]/esirb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/esirb/client.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday-http-cache"
+
+module Esirb
+  class Client
+    BASE_URL = "https://esi.evetech.net"
+    DEFAULT_HEADERS = {
+      "Accept" => "application/json",
+      "Accept-Language" => "en",
+      "If-Modified-Since" => "",
+      "If-None-Match" => "",
+      "X-Tenant" => "tranquility",
+      "X-Compatibility-Date" => "2026-06-09"
+    }
+
+    attr_reader :token, :path, :tenant, :language, :cache, :cache_store
+
+    def initialize(token: nil, tenant: "tranquility", language: "en", cache: true, cache_store: nil)
+      @token = token
+      @tenant = tenant
+      @language = language
+      @cache = cache
+      @cache_store = cache_store
+    end
+
+    def connection
+      @connection ||= Faraday.new(BASE_URL) do |c|
+        c.request :authorization, "Bearer", token if token
+
+        if cache
+          c.use :http_cache,
+            store: cache_store,
+            strategy: Faraday::HttpCache::Strategies::ByUrl,
+            serializer: Marshal
+        end
+
+        c.request :json
+        c.headers = DEFAULT_HEADERS
+        c.response :json, content_type: "application/json"
+      end
+    end
+
+    def method_missing(m, *args, &block)
+      @path = Path.new(client: self).send(m.to_sym, *args)
+    end
+  end
+end

data/lib/esirb/path.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Esirb
+  class Path
+    attr_reader :client, :string
+
+    def initialize(client: nil)
+      @client = client
+      @string = ""
+    end
+
+    %i[get head delete trace post put patch].each do |verb|
+      define_method verb do |**args|
+        client.connection.send(verb, @string) do |req|
+          req.params = args[:params] if args[:params]
+          req.body = args[:body] if args[:body]
+          req.headers = args[:headers] if args[:headers]
+        end
+      end
+    end
+
+    def method_missing(m, *args, &block)
+      @string += "/#{m}"
+      args.each do |arg|
+        @string += "/#{arg}"
+      end
+
+      self
+    end
+  end
+end

data/lib/esirb/version.rb

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

data/lib/esirb.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "esirb/version"
+require_relative "esirb/client"
+require_relative "esirb/path"
+
+module Esirb
+  class Error < StandardError; end
+end

data/sig/esirb.rbs

@@ -0,0 +1,4 @@
+module Esirb
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: esirb
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- sicks
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+email:
+- esirb@sicks.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/esirb.rb
+- lib/esirb/client.rb
+- lib/esirb/path.rb
+- lib/esirb/version.rb
+- sig/esirb.rbs
+homepage: https://github.com/sicks/esirb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/sicks/esirb
+  source_code_uri: https://github.com/sicks/esirb
+  changelog_uri: https://github.com/sicks/esirb/blob/main/CHANGELOG.md
+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: 4.0.15
+specification_version: 4
+summary: Ruby interface for Eve Online's Swagger API
+test_files: []