poke-your-api 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 013bffa8e1fd7cc08a67690af8a31338f81f625d21e2fdb768c414f1b5b50332
-  data.tar.gz: 71372e8e4c8cce9846d264d4dd047f772d807b6a9f5f08d66d92c0ede5531211
+  metadata.gz: 81877f6f324360849440ea79c839c8581596586b479e18b18e615f7693d8954c
+  data.tar.gz: bd0c96547df1d62cde88632f41ddf481fd2e7218d775eef4eb96d370fb50f660
 SHA512:
-  metadata.gz: da14a06ee7ced9ab757c6745ff669db496ff331f7cf5414186605db9d06196bc7be867a6bbf295556dceea27649d99de09953086365d60e63991b3a228c840c8
-  data.tar.gz: 7287edb8ee100e11176ba9b66c71c57374b2c304e91d50787af79da43edb3a5d8b710527d6f1182fd626a37a08a5c6cf1a45ff4be4f1822ea1929acc00316b37
+  metadata.gz: ba0f1bfb9c5a732c64e31a303913ba1abfeb77ea4aeed643ed0f94cac1462e8da31f730d26a5ea0112cde6192646462836d69fa5f966b10b90de6e8e04e17688
+  data.tar.gz: 9e1f4371b95115de6af6be2dd406767b226728dec89dc70d544fa4df51a5d761dd1f9469ef6549d771bbf7a79106ca7719aff0b85722bd2e59e17ae88919753e

data/exe/poke

@@ -13,7 +13,7 @@ end
 begin
   # run default command if the first command is not recognised
   Poke::CLI.start(ARGV)
-rescue Poke::CLI::Error => err
-  puts "ERROR: #{err.message}"
+rescue Poke::CLI::Error => e
+  puts "ERROR: #{e.message}"
   exit 1
 end

data/lib/poke/cli.rb

@@ -15,6 +15,12 @@ module Poke
     end
     map %w[--version -v] => :version
 
+    desc 'init', 'Setup config directory and example API'
+    def init
+      require_relative 'commands/init'
+      Poke::Commands::Init.new.execute
+    end
+
     desc 'env', 'Display and edit environments'
     method_option :help, aliases: '-h', type: :boolean,
                          desc: 'Display usage information'
@@ -53,18 +59,6 @@ module Poke
       end
     end
 
-    desc 'config', 'Manage poke config'
-    method_option :help, aliases: '-h', type: :boolean, desc: 'Display usage information'
-    method_option :open, aliases: '-o', type: :string, desc: 'Open config in the editor'
-    def config(*)
-      if options[:help]
-        invoke :help, ['response']
-      else
-        require_relative 'commands/config'
-        Poke::Commands::Config.new(options).execute
-      end
-    end
-
     require_relative 'commands/lru'
     register Poke::Commands::Lru, 'lru', 'lru [SUBCOMMAND]', 'Manage usage statistics'
 

data/lib/poke/commands/curl.rb

@@ -34,9 +34,9 @@ module Poke
         if (name = @options.fetch(:name, nil))
           request = Request.find_by_name(Config.find_request_name_by_alias(name))
         else
-          choices = Request.all.sort_by(&:position).map(&:name)
-          name = TTY::Prompt.new.select('Select the endpoint', choices, filter: true, quiet: true)
-          request = Request.find_by_name(name)
+          choices = Request.all.sort_by(&:position).map(&:name_with_alias)
+          name = TTY::Prompt.new(interrupt: :exit).select('Select the endpoint', choices, filter: true, quiet: true)
+          request = Request.find_by_name_with_alias(name)
         end
 
         request.use!

data/lib/poke/commands/init.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+require_relative '../config'
+
+module Poke
+  module Commands
+    class Init < Poke::Command
+      EXAMPLE_CONFIG = {
+        "envs": {
+          "development": {
+            "BASE_URL": 'https://httpbin.org'
+          },
+          "production": {
+            "BASE_URL": 'https://httpbin.org'
+          }
+        },
+        "default_env": 'development'
+      }.freeze
+
+      private
+
+      def run
+        return if ::Poke::Config.valid?
+
+        Dir.mkdir("#{Dir.home}/.poke")
+
+        create_config_files
+        create_example_api
+      end
+
+      def create_config_files
+        File.write(Config.aliases_path, {}.to_json)
+        File.write(Config.lru_path, {}.to_json)
+        File.write(Config.response_path, {}.to_json)
+      end
+
+      def create_example_api
+        Dir.mkdir("#{Dir.home}/.poke/example_api")
+        File.write("#{Dir.home}/.poke/example_api/config.json", EXAMPLE_CONFIG.to_json)
+        File.write("#{Dir.home}/.poke/example_api/example_get.curl", 'curl $BASE_URL/get -G -d foo=bar')
+      end
+    end
+  end
+end

data/lib/poke/commands/lru.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../config'
-
 module Poke
   module Commands
     class Lru < Thor

data/lib/poke/commands/response.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../command'
+require_relative '../config'
 
 require 'tty-command'
 
@@ -10,7 +11,7 @@ module Poke
       private
 
       def run(output: $stdout)
-        out, _err = TTY::Command.new(printer: :null).run("cat #{Poke::Config.root_path}/response.json")
+        out, _err = TTY::Command.new(printer: :null).run("cat #{Poke::Config.response_path}")
         output << "#{out}\n"
       end
     end

data/lib/poke/config.rb

@@ -6,19 +6,17 @@ module Poke
   class Config
     class NotFound < StandardError; end
 
-    PATH = "#{Dir.home}/.poke.json".freeze
-    DEFAULT_ROOT_PATH = "#{Dir.home}/.poke".freeze
+    ROOT_PATH = "#{Dir.home}/.poke".freeze
 
-    def self.all
-      @all ||= begin
-        config = File.exist?(PATH) ? JSON.parse(File.read(PATH)) : {}
-        config['root_path'] ||= DEFAULT_ROOT_PATH
-        config
-      end
+    def self.root_path
+      ROOT_PATH
     end
 
-    def self.root_path
-      all['root_path']
+    def self.valid?
+      Dir.exist?("#{Dir.home}/.poke") &&
+        File.exist?("#{Dir.home}/.poke/aliases.json") &&
+        File.exist?("#{Dir.home}/.poke/lru.json") &&
+        File.exist?("#{Dir.home}/.poke/response.json")
     end
 
     def self.response_path
@@ -29,17 +27,29 @@ module Poke
       [root_path, 'lru.json'].join('/')
     end
 
+    def self.aliases_path
+      [root_path, 'aliases.json'].join('/')
+    end
+
+    def self.aliases
+      @aliases ||= JSON.parse(File.read(aliases_path))
+    end
+
     def self.find_request_name_by_alias(value)
-      result = all.dig('aliases', value)
+      result = aliases[value]
+
       raise NotFound unless result
 
       result
     end
 
+    def self.find_alias_by_request_name(value)
+      aliases.find { |_k, v| v == value }&.first
+    end
+
     def self.set_alias!(value, path)
-      all['aliases'] ||= {}
-      all['aliases'][value] = path.to_s
-      File.write(PATH, all.to_json)
+      aliases[value] = path.to_s
+      File.write(aliases_path, aliases.to_json)
     end
   end
 end

data/lib/poke/request.rb

@@ -17,8 +17,9 @@ module Poke
 
           group_name = path.to_s.gsub(%r{#{Config.root_path}/([^\/]+)/.*}, '\1')
           name = path.to_s.gsub(%r{#{Config.root_path}/(.*)\.curl}, '\1')
+          alias_name = Config.find_alias_by_request_name(name)
 
-          new(group_name:, name:, path:)
+          new(group_name:, name:, alias_name:, path:)
         end
       end
     end
@@ -27,14 +28,23 @@ module Poke
       all.find { |request| request.name == name }
     end
 
-    attr_reader :path, :name, :group_name
+    def self.find_by_name_with_alias(name)
+      all.find { |request| request.name_with_alias == name }
+    end
+
+    attr_reader :path, :name, :alias_name, :group_name
 
-    def initialize(path:, name:, group_name:)
+    def initialize(path:, name:, alias_name:, group_name:)
       @path = path
       @name = name
+      @alias_name = alias_name
       @group_name = group_name
     end
 
+    def name_with_alias
+      @name_with_alias ||= "#{name}#{alias_name ? " (#{alias_name})" : ''}"
+    end
+
     def position
       LastRecentlyUsed.position(namespace: 'requests', key: name.to_s)
     end

data/lib/poke/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Poke
-  VERSION = '0.1.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: poke-your-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Jan Bator
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-06 00:00:00.000000000 Z
+date: 2024-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -117,27 +117,15 @@ extensions:
 - ext/poke/extconf.rb
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-version"
-- CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
-- LICENSE.txt
-- README.md
-- Rakefile
 - exe/poke
 - ext/poke/extconf.rb
-- ext/poke/poke.c
-- ext/poke/poke.h
 - lib/poke.rb
 - lib/poke/cli.rb
 - lib/poke/command.rb
 - lib/poke/commands/.gitkeep
-- lib/poke/commands/config.rb
 - lib/poke/commands/curl.rb
 - lib/poke/commands/env.rb
+- lib/poke/commands/init.rb
 - lib/poke/commands/lru.rb
 - lib/poke/commands/lru/cat.rb
 - lib/poke/commands/lru/reset.rb
@@ -149,7 +137,6 @@ files:
 - lib/poke/paint.rb
 - lib/poke/request.rb
 - lib/poke/version.rb
-- sig/poke.rbs
 homepage: https://github.com/MrBananaLord/poke
 licenses:
 - MIT

data/.editorconfig

@@ -1,9 +0,0 @@
-root = true
-
-[*.rb]
-charset = utf-8
-end_of_line = lf
-insert_final_newline = true
-indent_style = space
-indent_size = 2
-trim_trailing_whitespace = true

data/.rspec

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

data/.rubocop.yml

@@ -1,5 +0,0 @@
-Style/Documentation:
-  Enabled: false
-Style/FrozenStringLiteralComment:
-  Enabled: true
-  SafeAutoCorrect: true

data/.ruby-version

@@ -1 +0,0 @@
-3.2.0

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at jan@bloomandwild.com. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in poke.gemspec
-gemspec
-
-gem "rake"
-gem "rake-compiler"
-gem "rspec"
-
-gem "tty"#, path: "/Users/janbator/Projects/tty" # That's with some of my "fixes" :D
-gem "pry", require: true
-gem "pry-nav", require: true

data/Gemfile.lock

@@ -1,89 +0,0 @@
-PATH
-  remote: .
-  specs:
-    poke (0.1.0)
-      pastel (~> 0.8)
-      thor (~> 1.0)
-      tty-box (~> 0.7)
-      tty-command (~> 0.10)
-      tty-cursor (~> 0.7)
-      tty-editor (~> 0.6)
-      tty-table (~> 0.12)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    coderay (1.1.3)
-    diff-lcs (1.5.0)
-    method_source (1.0.0)
-    pastel (0.8.0)
-      tty-color (~> 0.5)
-    pry (0.14.2)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    pry-nav (1.0.0)
-      pry (>= 0.9.10, < 0.15)
-    rake (13.0.6)
-    rake-compiler (1.2.1)
-      rake
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    strings (0.2.1)
-      strings-ansi (~> 0.2)
-      unicode-display_width (>= 1.5, < 3.0)
-      unicode_utils (~> 1.4)
-    strings-ansi (0.2.0)
-    thor (1.2.2)
-    tty (0.1.0)
-    tty-box (0.7.0)
-      pastel (~> 0.8)
-      strings (~> 0.2.0)
-      tty-cursor (~> 0.7)
-    tty-color (0.6.0)
-    tty-command (0.10.1)
-      pastel (~> 0.8)
-    tty-cursor (0.7.1)
-    tty-editor (0.7.0)
-      tty-prompt (~> 0.22)
-    tty-prompt (0.23.1)
-      pastel (~> 0.8)
-      tty-reader (~> 0.8)
-    tty-reader (0.9.0)
-      tty-cursor (~> 0.7)
-      tty-screen (~> 0.8)
-      wisper (~> 2.0)
-    tty-screen (0.8.1)
-    tty-table (0.12.0)
-      pastel (~> 0.8)
-      strings (~> 0.2.0)
-      tty-screen (~> 0.8)
-    unicode-display_width (2.4.2)
-    unicode_utils (1.4.0)
-    wisper (2.0.1)
-
-PLATFORMS
-  arm64-darwin-22
-  x86_64-linux
-
-DEPENDENCIES
-  poke!
-  pry
-  pry-nav
-  rake
-  rake-compiler
-  rspec
-  tty
-
-BUNDLED WITH
-   2.4.3

data/LICENSE.txt

@@ -1,20 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2023 MrBananaLord
-
-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

@@ -1,6 +0,0 @@
-# Poke
-Manage your curl requests with ease
-
-## Copyright
-
-Copyright (c) 2023 MrBananaLord. See [MIT License](LICENSE.txt) for further details.

data/Rakefile

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-require "rake/extensiontask"
-
-task build: :compile
-
-Rake::ExtensionTask.new("poke") do |ext|
-  ext.lib_dir = "lib/poke"
-end
-
-task default: %i[clobber compile spec]

data/ext/poke/poke.c

@@ -1,9 +0,0 @@
-#include "poke.h"
-
-VALUE rb_mPoke;
-
-void
-Init_poke(void)
-{
-  rb_mPoke = rb_define_module("Poke");
-}

data/ext/poke/poke.h

@@ -1,6 +0,0 @@
-#ifndef POKE_H
-#define POKE_H 1
-
-#include "ruby.h"
-
-#endif /* POKE_H */

data/lib/poke/commands/config.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../command'
-require_relative '../config'
-
-require 'tty-command'
-require 'tty-editor'
-
-module Poke
-  module Commands
-    class Config < Poke::Command
-      private
-
-      def run(output: $stdout)
-        return TTY::Editor.open(Poke::Config::PATH) if @options.fetch(:open, nil)
-
-        out, _err = TTY::Command.new(printer: :null).run("cat #{Poke::Config::PATH}")
-        output << "#{out}\n"
-      end
-    end
-  end
-end

data/sig/poke.rbs

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