tsclient 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6648c361899812cae382d7837f53a701fe96ad5c88e65055d6456d9b06e89a9
-  data.tar.gz: 58876bfffa730a35895524b3ddaae3c466f12d7577c2793d3d75b151705170ef
+  metadata.gz: 3d8e411a6b86bdef471ffd8eae72ecad6de48fdc87064f369c77d4fe933bb178
+  data.tar.gz: 77ae580387238cdc9f4606423b7b5ac1ce4a318d4c83b1c816c7deca8e80b3bb
 SHA512:
-  metadata.gz: dc32b3da4cc1c722badaae4af2bfab56a22e3d10eff089b7c023a6fd5944b866bc8e7c772e9cfcce0aa380759be50cf3d5769592a7bcc7a3e487492fbd76674b
-  data.tar.gz: 66205c34e15b3d97c3359da0ee87ad571830b0d87e05f1b805b813548bbb3a822625379ed4f3fd6778f18eb156ef0b701bd9e70a20ebea7c45efe4e6fcbe1607
+  metadata.gz: 29dc9903d92b12f591a1c7f285cff245ad69394ea5a55f7a6eabba8f96b18e96c218d73f2d23919771283b53651f717a09120791482908ad24a70299e8f47584
+  data.tar.gz: ddd78f1331eedae97746f4aa55d6baa5d3c7f46ac3ab2676025d44ee861eed132bd4de7d6f3e839069b3ad1fc69f0f7dc3ee413c206e4e4a84b9145f72299228

data/CHANGELOG.md

@@ -16,6 +16,17 @@ All notable changes to this project will be documented below. The format is base
 
 ## [Unreleased]
 
+## [0.1.1] - 2022-10-22
+
+- Changed: pinned dependencies to major versions
+- Fixed: Changelog link in gemspec
+
+## [0.1.0] - 2022-10-22
+
+- Added: Client can query whois a remote address
+- Added: Client can query current tailscale IPs
+- Added: `Tsclient.default_client` works on macOS
+
 ## [0.0.1] - 2022-10-20
 
 - Added: Initial release

data/Gemfile.lock

@@ -1,7 +1,9 @@
 PATH
   remote: .
   specs:
-    tsclient (0.0.1)
+    tsclient (0.1.1)
+      json (~> 2.5)
+      values (~> 1.8)
 
 GEM
   remote: https://rubygems.org/
@@ -36,13 +38,14 @@ GEM
       rubocop (= 1.35.1)
       rubocop-performance (= 1.14.3)
     unicode-display_width (2.3.0)
+    values (1.8.0)
 
 PLATFORMS
-  arm64-darwin-21
+  ruby
 
 DEPENDENCIES
-  minitest
-  rake
+  minitest (~> 5.0)
+  rake (>= 13.0)
   standard (~> 1.3)
   tsclient!
 

data/README.md

@@ -18,7 +18,15 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO.
+```ruby
+client = Tsclient.default_client
+
+client.tailscale_ips
+# => ["100.100.100.1", "fd7a:115c:a1e0::1"]
+
+client.whois "100.100.100.1"
+# => => #<Tsclient::Profile identifier="bob.bobbity@example.com", name="Bob Bobbity", profile_pic_url="www.google.com/images/errors/robot.png", human=true>
+```
 
 ## Development
 

data/Rakefile

@@ -11,4 +11,4 @@ end
 
 require "standard/rake"
 
-task default: %i[test standard]
+task default: %i[standard spec]

data/lib/tsclient/client.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+
+require_relative "./result"
+require_relative "./profile"
+
+module Tsclient
+  class Client
+    def initialize(uri:)
+      @api_uri = uri.freeze
+      freeze
+    end
+
+    def tailscale_ips
+      api_get(:status).result.dig("TailscaleIPs")
+    end
+
+    def whois(addr)
+      unless addr.include?(":")
+        addr += ":80"
+      end
+      response = api_get(:whois, addr: addr)
+      if response.error?
+        nil
+      else
+        Profile.from(response.result)
+      end
+    end
+
+    private
+
+    def api_get(endpoint, params = {})
+      case @api_uri.scheme
+      when "http", "https"
+        # All we actually need is the port & password, but expect well formed URI to be passed in
+        Net::HTTP.start(@api_uri.host, @api_uri.port, use_ssl: (@api_uri.scheme == "https")) do |http|
+          req = Net::HTTP::Get.new("/localapi/v0/#{endpoint}?#{params.map { |k, v| "#{k}=#{v}" }.join("&")}")
+          req.basic_auth "", @api_uri.password
+          req.content_type = "application/json"
+          res = http.request(req)
+          case res
+          when Net::HTTPOK
+            Result.with(error: false, result: JSON.parse(res.body))
+          when Net::HTTPNotFound
+            Result.with(error: true, result: res)
+          end
+        end
+      when "unix"
+        raise NotImplemented, "unix socket not implemented"
+      else
+        raise "Can't handle api uri with scheme #{@api_uri.scheme.inspect}"
+      end
+    end
+  end
+end

data/lib/tsclient/profile.rb

@@ -0,0 +1,19 @@
+require "values"
+
+module Tsclient
+  class Profile < Value.new(:identifier, :name, :profile_pic_url, :human)
+    def self.from(data)
+      with(
+        identifier: data.dig("UserProfile", "LoginName"),
+        name: data.dig("UserProfile", "DisplayName"),
+        profile_pic_url: data.dig("UserProfile", "ProfilePicURL"),
+        # We assume anyone with an email address as their SSO identifier is human
+        human: data.dig("UserProfile", "LoginName").include?("@")
+      )
+    end
+
+    def human?
+      human
+    end
+  end
+end

data/lib/tsclient/result.rb

@@ -0,0 +1,9 @@
+require "values"
+
+module Tsclient
+  class Result < Value.new(:error, :result)
+    def error?
+      error
+    end
+  end
+end

data/lib/tsclient/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tsclient
-  VERSION = "0.0.1"
+  VERSION = "0.1.1"
 end

data/lib/tsclient.rb

@@ -1,6 +1,26 @@
 # frozen_string_literal: true
 
-require_relative "tsclient/version"
+require_relative "tsclient/client"
 
 module Tsclient
+  def self.default_client
+    return @default_client if defined?(@default_client)
+
+    # Attempt to setup the default client from various known strategies
+    # Envariables override everything
+    uri = if ENV.key?("TS_LOCALAPI_PORT")
+      URI("http://:#{ENV["TS_LOCALAPI_KEY"]}@localhost:#{ENV["TS_LOCALAPI_PORT"]}")
+
+    # Running on macOS, need to find api deets from filesystem
+    elsif RUBY_PLATFORM["darwin"]
+      tsfile = Pathname.glob("#{ENV["HOME"]}/Library/Group Containers/*.io.tailscale.ipn.macos/sameuserproof-*-*").first
+      _, port, password = tsfile.basename.to_s.split("-", 3)
+      URI("http://:#{password}@localhost:#{port}")
+    # Throw our hands in the air, we just don't ~~care~~ know
+    else
+      raise NotImplemented, "Can't figure out where localapi is"
+    end
+
+    @default_client = Client.new(uri: uri)
+  end
 end

data/tsclient.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/tree/blob/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
 
   # 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.
@@ -31,7 +31,10 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
+  spec.add_dependency "json", "~> 2.5"
+  spec.add_dependency "values", "~> 1.8"
+
+  spec.add_development_dependency "rake", ">= 13.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "standard", "~> 1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tsclient
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Caius Durling
@@ -10,34 +10,62 @@ bindir: exe
 cert_chain: []
 date: 2022-10-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: values
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
@@ -68,6 +96,9 @@ files:
 - README.md
 - Rakefile
 - lib/tsclient.rb
+- lib/tsclient/client.rb
+- lib/tsclient/profile.rb
+- lib/tsclient/result.rb
 - lib/tsclient/version.rb
 - sig/tsclient.rbs
 - tsclient.gemspec
@@ -77,7 +108,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/caius/tsclient
   source_code_uri: https://github.com/caius/tsclient
-  changelog_uri: https://github.com/caius/tsclient/tree/blob/CHANGELOG.md
+  changelog_uri: https://github.com/caius/tsclient/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: