typhoon 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 729c44cc7816f616756d4d25525faedb00465d34fe57c46769555e7b5f55fe76
+  data.tar.gz: 2351de94633c2a1df90f981b8543c280df9a5a6fe5609df99bca721ff41ea2d6
+SHA512:
+  metadata.gz: e1aac1364a9a9460e36d905fda5ef2eac0b11588ea1e2b8faf58233acfa9c28f5ce70d7d90d9af38f7e89061f2b2e80c027956ad0adfd3e4e85715d66086a321
+  data.tar.gz: e4c436987936d4d72ab0270b2c348599d7ec8a77e497b557505e4901598d8c4d66de24be30fa75c25a19030208974574722f36aa4faa3ee591bb372a48c7e37e

data/.rspec

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

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in typhoon.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Gary Tou
+
+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,35 @@
+# Typhoon
+
+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/typhoon`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add typhoon
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install typhoon
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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).
+
+https://bundler.io/guides/creating_gem.html
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/typhoon.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec]

data/lib/typhoon/cloudflared/configuration.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Typhoon::Cloudflared
+  class Configuration
+    attr_accessor :tunnel_cert_path
+
+    def initialize
+      @tunnel_cert_path = nil
+    end
+
+  end
+end

data/lib/typhoon/cloudflared.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'mkmf'
+require 'typhoon/concerns/configurable'
+require 'typhoon/cloudflared/configuration'
+
+module Typhoon
+  module Cloudflared
+    include Concerns::Configurable
+    configure_with Cloudflared::Configuration
+
+    class << self
+      def run!(command = nil)
+        raise MissingCloudflared unless installed?
+
+        run(command || yeild)
+      end
+
+      def logged_in?
+        # TODO
+        run!('tunnel login')
+      end
+
+      def version
+        @version ||= installed? && run('-v').split[2]
+      end
+
+      def installed?
+        @installed ||= !!path && run('-v').start_with?('cloudflared version')
+      end
+
+      def path
+        # The `find_executable0` method doesn't polute the stdout with messages
+        @path ||= find_executable0 'cloudflared'
+      end
+
+      private
+
+      def run(command = nil)
+        command ||= yeild
+        cmd = path
+
+        # Global options
+        cmd += " --credentials-file #{configuration.tunnel_cert_path}" if configuration.tunnel_cert_path
+
+        `#{cmd} #{command}`.strip
+      end
+    end
+  end
+end

data/lib/typhoon/concerns/configurable.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require 'active_support/inflector'
+
+module Typhoon::Concerns
+  module Configurable
+    extend ActiveSupport::Concern
+
+    class_methods do
+      attr_reader :configurator
+      attr_writer :configuration
+
+      def configuration
+        @configuration ||= reset
+      end
+
+      def reset
+        @configuration = configurator.new
+      end
+
+      def configure
+        yield configuration
+      end
+
+      def configurator
+        raise Typhoon::MissingConfigurator unless @configurator
+
+        @configurator
+      end
+
+      private
+
+      def configurator=(value)
+        @configurator = value
+      end
+
+      def configure_with(value)
+        self.configurator = value
+      end
+
+    end
+  end
+end

data/lib/typhoon/configuration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Typhoon
+  class Configuration
+    attr_accessor :default_port
+
+    def cloudflared_configuration
+      ::Typhoon::Cloudflared.configuration
+    end
+
+    def cloudflared_configuration=(value)
+      ::Typhoon::Cloudflared.configuration = value
+    end
+  end
+end

data/lib/typhoon/typhoon.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'typhoon/cloudflared'
+require 'typhoon/configuration'
+require 'socket'
+
+module Typhoon
+  # This class could really use a better name
+  class Typhoon
+    include Concerns::Configurable
+    configure_with ::Typhoon::Configuration
+
+    def initialize(name)
+      @name = name
+      raise NotFound unless self.class.exists? name
+    end
+
+    def self.find(name)
+      new(name)
+    end
+
+    def self.list
+      out = Cloudflared.run!('tunnel list')
+      lines = out.split("\n")
+      lines.shift # remove message
+      headers = lines.shift.split
+
+      lines.map do |l|
+        id, name, created, conn = l.split
+
+        conn = conn&.split(',')&.map do |c|
+          num, loc = c.split('x')
+          { location: loc, quantity: num.to_i }
+        end
+
+        { id: id, name: name, created: created, connections: conn }
+      end
+    end
+
+    def self.create(name: nil, hostname:, force: false)
+      name ||= hostname.split('.').first
+      raise AlreadyExists if exists? name && !force
+
+      # Create tunnel
+      Cloudflared.run!("tunnel create #{name}")
+
+      # Map DNS name to tunnel
+      cmd = "tunnel route dns #{name} #{hostname}"
+      cmd += ' -f' if force
+      Cloudflared.run!(cmd)
+    end
+
+    def info
+      Cloudflared.run!("tunnel info #{@name}")
+    end
+
+    def start(port: nil, hostname: 'localhost')
+      port ||= self.class.find_port
+      Cloudflared.run!("tunnel run --url #{hostname}:#{port} #{@name}")
+    end
+
+    def delete(force: false)
+      cleanup
+
+      cmd = "tunnel delete #{@name}"
+      cmd += ' -f' if force
+      Cloudflared.run!(cmd)
+
+      # The DNS record still lingers. The cloudflared CLI doesn't provide a way
+      # to delete it :(
+    end
+
+    def cleanup
+      Cloudflared.run! "tunnel cleanup #{@name}"
+    end
+
+    def self.version
+      ::Typhoon::VERSION
+    end
+
+    def self.exists?(name)
+      list.find { |t| t[:name] == name }
+    end
+
+    private
+
+    def self.find_port(hostname: 'localhost')
+      # TODO: try to find a reasonable open (used) port
+      configuration.default_port || 3000
+    end
+  end
+end

data/lib/typhoon/version.rb

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

data/lib/typhoon.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'typhoon/version'
+require 'typhoon/typhoon'
+require 'typhoon/concerns/configurable'
+require 'typhoon/configuration'
+
+module Typhoon
+  class TyphoonError < StandardError; end
+
+  class AlreadyExists < TyphoonError; end
+
+  class NotFound < TyphoonError; end
+
+  class MissingCloudflared < TyphoonError; end
+
+  class MissingConfigurator < TyphoonError; end
+
+  (Typhoon.public_methods - Object.public_methods).each do |m|
+    # Send all methods to Typhoon class
+    define_singleton_method m do |*args, **kwargs, &block|
+      Typhoon.send(m, *args, **kwargs, &block)
+    end
+  end
+
+end

data/sig/typhoon.rbs

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

data/terms.md

@@ -0,0 +1,20 @@
+# Typhoon-related Terminology
+
+- convection
+- cyclone
+- eye
+- gale
+- gust
+- hurricane
+- hurricane season
+- landfall
+- monsoon
+- storm surge
+- surge
+- swell
+- thunderstorm
+- tide
+- vortex
+- weather alert/warning
+- weather watch
+- wind

data/typhoon.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/typhoon/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "typhoon"
+  spec.version = Typhoon::VERSION
+  spec.authors = ["Gary Tou"]
+  spec.email = ["gary@garytou.com"]
+
+  spec.summary = "An inclement tunnel through the clouds"
+  spec.description = "Expose your local development servers with the help of a typhoon (via cloudflared tunnels)"
+  spec.homepage = "https://github.com/garyhtou/typhoon"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # 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.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Dependencies
+  spec.add_runtime_dependency "rake", "~> 13.0"
+  spec.add_runtime_dependency "activesupport", "~> 7.0"
+
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: typhoon
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gary Tou
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Expose your local development servers with the help of a typhoon (via
+  cloudflared tunnels)
+email:
+- gary@garytou.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/typhoon.rb
+- lib/typhoon/cloudflared.rb
+- lib/typhoon/cloudflared/configuration.rb
+- lib/typhoon/concerns/configurable.rb
+- lib/typhoon/configuration.rb
+- lib/typhoon/typhoon.rb
+- lib/typhoon/version.rb
+- sig/typhoon.rbs
+- terms.md
+- typhoon.gemspec
+homepage: https://github.com/garyhtou/typhoon
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/garyhtou/typhoon
+  source_code_uri: https://github.com/garyhtou/typhoon
+  changelog_uri: https://github.com/garyhtou/typhoon
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: An inclement tunnel through the clouds
+test_files: []