skipper-cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 197b36f07814e98e9490c32bab5c531f3dd0f226ced2b44a5780b17ceb5485da
+  data.tar.gz: c2b578ad4e728a6c5ac829832311600144e5b3c69545340bb02f0446bd6be063
+SHA512:
+  metadata.gz: 7238cbce4df4ecd9a1477fd7289cb6a1e1a737ac601fa2ac9cee6fca6456397c6cd8843355e042c9c11412d309a47b5d279bb67ef1286bde2df970ec1daf7556
+  data.tar.gz: 1eaf7a2f794d44571b2c0a6ad14130c0ba8d39dac533b72f6a5603b9cc732ba8460b74e985978f5a549667419cf72b8e0b1d8d3a993e60c1a920185c546063aa

data/README.md

@@ -0,0 +1,31 @@
+# SkipperClient
+
+TODO: Delete this and the text below, and describe your gem
+
+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/skipper_client`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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]/skipper_client.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/clippy

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'skipper_client'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+c = SkipperClient::Clippy.new
+c.run

data/config.json

@@ -0,0 +1,4 @@
+{
+	"uri": "http://localhost:8080",
+	"token": "a0b027fe-5b3f-4f0a-ac1f-4e84078ae65e"
+}

data/lib/skipper_client/configs.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'json'
+
+class Config
+  @@configs_path = './config.json'
+
+  attr_reader :uri, :token
+
+  def initialize
+    data = read_configs
+    @uri = data['uri']
+    @token = data['token']
+  end
+
+  private
+
+  def read_configs
+    file = File.read @@configs_path
+    JSON.parse file
+  end
+end

data/lib/skipper_client/consumer.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'json'
+require 'http'
+require 'skipper_client/models/models'
+require 'skipper_client/models/requests'
+
+# cosumer
+class Consumer
+  attr_reader :cfg
+
+  def initialize(cfg)
+    @cfg = cfg
+  end
+
+  def content_type
+    { 'Content-Type' => 'application/json' }
+  end
+
+  def x_api_key
+    { "x-api-key": token }
+  end
+
+  def merge_headers(*headers)
+    HTTP.headers(headers.reduce { |output, header| output.merge(header) })
+  end
+
+  def token_valid?
+    valid_uri = URI("#{uri}/auth/validate/#{token}".strip)
+    begin
+      (Models::SkipperResponse.from_response HTTP.get(valid_uri), Models::ValidApiKeyResponse).success
+      true
+    rescue StandardError
+      false
+    end
+  end
+
+  def create_api_key
+    new_token_api = URI "#{uri}/internal/management/api_key"
+    req = HTTP::Post.new new_token_api.path, content_type
+    req.body = { origin: '*', name: 'new_api_key', purpose: 'general' }
+    SkipperResponse.from_response HTTP.request(req), Models::ApiKeyResponse
+  end
+
+  def products
+    products_uri = URI "#{uri}/api/v1/products"
+    Models::SkipperResponse.from_response HTTP.headers("x-api-key": token).get(products_uri), Models::Price, :list
+  end
+
+  def coupon(coupon)
+    validation_uri = URI "#{uri}/api/v1/products/coupons/#{coupon}".strip
+    Models::SkipperResponse.from_response HTTP.headers("x-api-key": token).get(validation_uri), Models::Coupon,
+                                          :unit
+  end
+
+  def customer_by_company_and_project(company, project)
+    customers_uri = URI "#{uri}/api/v1/customers?project_name=#{project}&company_name=#{company}".strip
+    Models::SkipperResponse.from_response HTTP.headers("x-api-key": token).get(customers_uri), Models::Customer,
+                                          :unit
+  rescue Models::SkipperApiError
+    nil
+  end
+
+  def valid_coupon?(input)
+    (coupon input).success
+  rescue Models::SkipperApiError
+    false
+  end
+
+  def checkout(checkout_req)
+    raise 'Error checkout_req is not a JsonRequest' unless checkout_req.is_a? Models::JsonRequest
+
+    checkout_uri = URI "#{uri}/api/v1/checkout"
+    p checkout_req.as_json
+
+    res = merge_headers(x_api_key, content_type).post(checkout_uri, json: checkout_req.as_json)
+    Models::SkipperResponse.from_response res, Models::Checkout, :unit
+  end
+
+  def product(id)
+    products.data.find { |d| d.external_id == id }
+  end
+
+  def uri
+    @cfg.uri
+  end
+
+  def token
+    @cfg.token
+  end
+
+  private
+
+  def body_to_json(body)
+    JSON.parse! body
+  end
+end

data/lib/skipper_client/models/models.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Models
+  # Skipper api Exception
+  class SkipperApiError < StandardError; end
+
+  class MissingFromJSON < StandardError; end
+
+  # json model
+  class JsonModel
+    def self.from_json(_json_dict)
+      raise 'not implemented'
+    end
+  end
+
+  # Basic skipper response
+  class SkipperResponse
+    attr_reader :success, :message, :data
+
+    def initialize(json_dict, data)
+      @success = json_dict['success']
+      @message = json_dict['message']
+      @data = data
+    end
+
+    def self.from_response(response, data_class, type)
+      raise SkipperApiError, response.to_s unless response.status.success?
+      raise MissingFromJSON, 'missing from_json method' unless data_class < JsonModel
+
+      _parse_from_response parse_json(response.body), data_class, type
+    end
+
+    def self.parse_json(body)
+      JSON.parse! body
+    end
+
+    def self._parse_from_response(json_dict, data_class, type)
+      case type
+      when :unit
+        _from_unit_response json_dict, data_class
+      when :list
+        _from_list_response json_dict, data_class
+      else
+        raise SkipperApiError, 'invalid type passed'
+      end
+    end
+
+    def self._from_unit_response(json_dict, data_class)
+      json_data = json_dict['data']
+      raise SkipperApiError, 'data was expected to not be a list' if json_data.is_a? Array
+
+      new json_dict, data_class.from_json(json_dict['data'])
+    end
+
+    def self._from_list_response(json_dict, data_class)
+      json_data = json_dict['data']
+      raise SkipperApiError, 'data was expected to be a list' unless json_data.is_a? Array
+
+      new(json_dict, json_data.map { |item| data_class.from_json(item) })
+    end
+  end
+
+  # api create api key response
+  class ApiKeyResponse < JsonModel
+    attr_accessor :key
+
+    def initialize(key)
+      @key = key
+      super()
+    end
+
+    def self.from_json(json_dict)
+      new json_dict['key']
+    end
+  end
+
+  # api key models
+  class ValidApiKeyResponse < JsonModel
+    attr_reader :value, :name, :origin, :purpose
+
+    def initialize(value, name, origin, purpose)
+      @value = value
+      @name = name
+      @origin = origin
+      @purpose = purpose
+      super()
+    end
+
+    def self.from_json(json_dict)
+      new json_dict['value'], json_dict['name'], json_dict['origin'], json_dict['purpose']
+    end
+  end
+
+  # ExternalID string        `json:"external_id"`
+  # Product    Product       `json:"product"`
+  # Currency   string        `json:"currency"`
+  # Amount     int64         `json:"amount"`
+  # StripeData *stripe.Price `json:"stripe_data"`
+  class Price < JsonModel
+    attr_reader :external_id, :product, :currency, :amount, :stripe_data, :billing_schema
+
+    def initialize(external_id, product, currency, amount, stripe_data)
+      @external_id = external_id
+      @product = product
+      @currency = currency
+      @amount = amount
+      @stripe_data = stripe_data
+      @billing_schema = amount > 300_000 ? 'monthly' : 'weekly'
+      super()
+    end
+
+    def self.from_json(json_dict)
+      new json_dict['external_id'], json_dict['product'], json_dict['currency'], json_dict['amount'],
+          json_dict['stripe_data']
+    end
+
+    def to_dollar
+      (@amount / 100).to_s
+    end
+  end
+
+  # checkout session created res
+  class Checkout < JsonModel
+    attr_reader :payment_url
+
+    def initialize(payment_url)
+      @payment_url = payment_url
+      super()
+    end
+
+    def self.from_json(json_dict)
+      new json_dict['payment_url']
+    end
+  end
+
+  # ExternalID       string  `json:"id"`
+  # PercentOff       float64 `json:"percent_off"`
+  # Duration         string  `json:"duration"`
+  # DurationInMonths int64   `json:"duration_in_months"`
+  class Coupon < JsonModel
+    attr_reader :id, :name, :percent_off, :duration, :duration_in_months
+
+    def initialize(id, name, _percent_off, duration, duration_in_months)
+      @id = id
+      @name = name
+      @duration = duration
+      @duration_in_months = duration_in_months
+      @percent_off = percent_off
+      super()
+    end
+
+    def self.from_json(json_dict)
+      new json_dict['id'], json_dict['name'], json_dict['percent_off'], json_dict['duration'],
+          json_dict['duration_in_months']
+    end
+  end
+
+  # ID              int        `db:"id"`
+  # CompanyName     string     `db:"company_name" json:"company_name"`
+  # ProjectName     string     `db:"project_name" json:"project_name"`
+  class Customer < JsonModel
+    attr_reader :id, :company_name, :project_name
+
+    def initialize(id, company_name, project_name)
+      @id = id
+      @company_name = company_name
+      @project_name = project_name
+    end
+
+    def self.from_json(json_dict)
+      new json_dict['id'], json_dict['company_name'], json_dict['project_name']
+    end
+  end
+end

data/lib/skipper_client/models/requests.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Models
+  # base request
+  class JsonRequest
+    def as_json
+      raise "not implemented"
+    end
+  end
+
+  # PriceID      string  `json:"price_id"`
+  # Qty          int     `json:"quantity"`
+  # CompanyName  string  `json:"company_name"`
+  # ProjectName  string  `json:"project_name"`
+  # CouponCode   *string `json:"coupon_code"`
+  # ReferredCode *string `json:"referred_code"`
+  class CheckouReq < JsonRequest
+    attr_reader :price_id, :quantity, :company_name, :project_name, :coupon_code
+
+    def initialize(price, quantity, company_name, project_name, coupon_code)
+      @price = price
+      @quantity = quantity
+      @company_name = company_name
+      @project_name = project_name
+      @coupon_code = coupon_code
+      super()
+    end
+
+    def as_json
+      {
+        price_id: @price.external_id,
+        quantity: @quantity,
+        company_name: @company_name,
+        project_name: @project_name,
+        coupon_code: @coupon_code
+      }
+    end
+  end
+end

data/lib/skipper_client/version.rb

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

data/lib/skipper_client.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+require_relative 'skipper_client/version'
+require_relative 'skipper_client/configs'
+require_relative 'skipper_client/consumer'
+require 'tty-prompt'
+require 'cli/ui'
+
+module SkipperClient
+  class Error < StandardError; end
+
+  class Clippy
+    def initialize
+      @cfg = Config.new
+      @consumer = Consumer.new @cfg
+      @cached_products = []
+    end
+
+    def run
+      CLI::UI::StdoutRouter.enable
+      CLI::UI::Frame.open('SKIPPER DIGITAL STUDIO') do
+        puts CLI::UI.fmt title
+        fetch_products
+        product, amount, company_name, project_name, discount = subscription_form
+        subscription_details product, amount, company_name, project_name, discount
+        unless CLI::UI::Prompt.confirm 'Continue to checkout?', default: true
+          puts CLI::UI.fmt '{{error:Checkout canceled }}'
+          puts CLI::UI.fmt 'Thank you for using Clippy the Skipper Command Line Application'
+          return
+        end
+
+        session = checkout product, amount, company_name, project_name, discount
+        success_output session
+      end
+    end
+
+    def title
+      "
+    __|__ |___| |\\
+    |o__| |___| | \\
+    |___| |___| |o \\
+   _|___| |___| |__o\\
+  /...\\_____|___|____\\_/
+  \\   o * o * * o o  /
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+"
+    end
+
+    def products
+      return @cached_products unless @cached_products.empty?
+
+      @cached_products = @consumer.products.data
+      @cached_products
+    end
+
+    def product_from_prompt(str_product)
+      str_product.include?('WEEKLY') ? weekly_product : monthly_product
+    end
+
+    def success_output(session)
+      puts CLI::UI.fmt " {{success: checkout session created: \n #{session.data.payment_url} \n Open the ssession on any broweser you want}}"
+      puts CLI::UI.fmt "\n {{success: Thank you for Using Clippy - The Command line tool to work with Skipper Digital Studio }}"
+    end
+
+    def subscription_form
+      product = nil
+      CLI::UI::Frame.open('SUBSCRIPTION FORM') do
+        CLI::UI::Prompt.ask('Choose the subscription model you want') do |handler|
+          prompt_products.each do |prompt|
+            handler.option(prompt[:prompt]) do |_|
+              product = prompt[:value]
+            end
+          end
+        end
+        [product, cli_amount, cli_company_name, cli_project_name, cli_discount]
+      end
+    end
+
+    def subscription_details(product, amount, company_name, project_name, discount)
+      CLI::UI::Frame.open('Subscription details') do
+        puts CLI::UI.fmt "{{info: Company Name -> #{company_name} }}"
+        puts CLI::UI.fmt "{{info: Project Name -> #{project_name} }}"
+        puts CLI::UI.fmt "{{info: Number of workflows -> #{amount} }}"
+        unless discount.nil?
+          puts CLI::UI.fmt "\n{{info: Discount coupon applied '#{discount}' = 5% for the first 3 months}}"
+        end
+        net_amount = product.amount * amount
+        customer_res = (@consumer.customer_by_company_and_project company_name, project_name)
+        puts CLI::UI.fmt "\n{{info: New customer discount applied 45% for the first 3 months}}" if customer_res.nil?
+        new_customer_disc = customer_res.nil? ? 0.45 : 0.0
+        coupon_discount = discount.nil? ? 0.0 : 0.05
+        total = net_amount * (1 - coupon_discount - new_customer_disc)
+        puts CLI::UI.fmt "\n{{success: Total = #{product.currency} #{(total / 100).round} (First 3 months) - Then #{product.currency} #{net_amount / 100} }}"
+      end
+    end
+
+    def checkout(product, amount, company_name, project_name, discount)
+      session = nil
+      CLI::UI::Frame.open('CHECKOUT') do
+        CLI::UI::SpinGroup.new do |spin_group|
+          spin_group.add('Generating checkout session') do |_|
+            session = @consumer.checkout Models::CheckouReq.new(product, amount, company_name, project_name,
+                                                                discount)
+          end
+        end
+      end
+      session
+    end
+
+    def fetch_products
+      CLI::UI::SpinGroup.new do |spin_group|
+        spin_group.add('Fetching all the products') do |_|
+          products
+        end
+      end
+    end
+
+    private
+
+    def validate_string(str)
+      special = "?<>',?[]}{=-)(*&^%$#`,.~{}"
+      regex = /[#{special.gsub(/./) { |char| "\\#{char}" }}]/
+      !(str =~ regex)
+    end
+
+    def string_prompt(prompt_text, is_retry)
+      puts CLI::UI.fmt 'Invalid input. The text cannot contain any special character or . (dot) | , (comma)' if is_retry
+      CLI::UI::Prompt.ask prompt_text, allow_empty: false
+    end
+
+    def cli_amount
+      CLI::UI::Prompt.ask('How many workstreams you want?', default: '1').to_i
+    end
+
+    def cli_company_name
+      output = string_prompt "What's your company name?", false
+      loop do
+        break if validate_string output
+
+        output = string_prompt "What's your company name?", true
+      end
+      output
+    end
+
+    def cli_project_name
+      output = string_prompt "What's your project name?", false
+      loop do
+        break if validate_string output
+
+        output = string_prompt "What's your project name?", true
+      end
+      output
+    end
+
+    def cli_discount
+      output = nil
+      CLI::UI::Frame.open('DISCOUNT FORM') do
+        discount_coupon = cli_discount_loop
+        output = discount_coupon != '' ? discount_coupon : nil
+      end
+      output
+    end
+
+    def cli_discount_loop
+      loop do
+        discount_coupon = CLI::UI::Prompt.ask('Input a discount coupon if you have one / (Not required)')
+        return '' unless discount_coupon != ''
+
+        valid = valid_coupon? discount_coupon
+        return discount_coupon if valid
+
+        next if cli_should_try_again_discount
+
+        puts CLI::UI.fmt '{{info: Continuing without a discount coupon}}'
+        break
+      end
+    end
+
+    def cli_should_try_again_discount
+      CLI::UI::Prompt.ask 'The coupon was not a valid one. What you want to do?' do |handler|
+        handler.option('Use a different coupon?') { |_| true }
+        handler.option('Continue without a coupon?') { |_| false }
+      end
+    end
+
+    def valid_coupon?(discount_coupon)
+      final_glyph = ->(success) { success ? CLI::UI::Glyph::CHEVRON.to_s : CLI::UI::Glyph::X.to_s }
+      valid = false
+      CLI::UI::SpinGroup.new do |spin_group|
+        spin_group.add 'Validating coupon', final_glyph: final_glyph do |spinner|
+          valid = @consumer.valid_coupon?(discount_coupon)
+          spinner.update_title CLI::UI.fmt "{{error: Discount coupon #{discount_coupon} is Invalid }}" unless valid
+        end
+      end
+      valid
+    end
+
+    def prompt_products
+      products.map do |product|
+        { prompt: "#{product.billing_schema.upcase} -> #{product.currency} #{product.amount / 100}", value: product }
+      end
+    end
+
+    def weekly_product
+      products.find { |p| p.billing_schema == 'weekly' }
+    end
+
+    def monthly_product
+      products.find { |p| p.billing_schema == 'monthly' }
+    end
+  end
+end

data/sig/skipper_client.rbs

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

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: skipper-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- wmb1207
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-06-10 00:00:00.000000000 Z
+dependencies: []
+description: a command line client to interact with skipper
+email:
+- lao@skipper.studio
+executables:
+- clippy
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- bin/clippy
+- config.json
+- lib/skipper_client.rb
+- lib/skipper_client/configs.rb
+- lib/skipper_client/consumer.rb
+- lib/skipper_client/models/models.rb
+- lib/skipper_client/models/requests.rb
+- lib/skipper_client/version.rb
+- sig/skipper_client.rbs
+homepage: https://skipper.studio
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://skipper.studio
+  source_code_uri: https://gitlab.com/skipperstudio/clippy
+  changelog_uri: https://gitlab.com/skipperstudio/clippy/changelog.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.21
+signing_key:
+specification_version: 4
+summary: A command line client to interact with skipper
+test_files: []