cadburybot 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c17493616fddf011b5fe64a0aa58d6ab0f2833dd6a2dcc4d584d39991b89104
-  data.tar.gz: ce03d500a7b8f749b2a998e8ff6c8f9af09a1ab81bc2ab0dccbe7bcd6d16b22f
+  metadata.gz: 2c371c8182fbcbea0a95fba155932c49773f1369ece5f872aa029140b69749d5
+  data.tar.gz: fba23894de55ff18063b000afc7e58ccdadedf9ecf3a5e731922f2ce4f8015e5
 SHA512:
-  metadata.gz: 0f4efe37c186b55fa2532dfd35d3018809d6bcc717cd0f2051e7e4ac8efefdff42d86d6cdfe40bfe563b56531eeb04c2b6d8032d56a1a4ee671af6bdd621b44b
-  data.tar.gz: 02f4ff4ceb778af74686d4449b3920e7b4c7978aeeb447e0e302be73da1592b2801a0ce8e464b5c727fa29508523d3fe8a41c857e6fd012cfe3a8f3b8044cdae
+  metadata.gz: 70fef744a7aedcdbd74d3588105c1afac2b9c3596a64d8d0b8f992f515a6e8d92560f636ca24230ddb76955091f2324c76f59320424d82647750830c96f89646
+  data.tar.gz: c998b25201a0b1423289efa4604110636f7f5393a364cd3c587bd781f9688931934ac5592753f5cde6b90e42a50c989aaa6e93324e9350af2baddb40538c6d3c

data/README.md

@@ -1,24 +1,24 @@
 # CadburyBot :man_in_tuxedo:
 
-CadburyBot is an API client CLI which helps you manage multiple api environments like `dev/qa/local/prod`. Just simply define your environment by running `cadburybot env set <environment-name>`. 
+## Under development 🚧
 
-## Command list
+## Usage
 
 ```bash
-cadburybot env get # lists all the environments
-cadburybot env get <env-name> # lists the asked envrironment
-cadburybot env set <environment-name> # Creates or updates environment by asking questions to you.
-cadburybot env delete <environment-name>
-cadburybot env default <environment-name> # sets the default environment
-
-cadburybot request get # lists all the request for the default environment
-cadburybot request get <request-name> # lists the asked request
-cadburybot request set <request-name> # add/update request to the default environment by answering the questions like request endpoint, http method etc.,
-cadburybot request delete <request-name>
-
-cadburybot send <request-name> #uses default environment
+cb env get # lists all the environments
+cb env get <env-name> # lists the asked envrironment
+cb env set <environment-name> # Creates or updates environment by asking questions to you.
+cb env delete <environment-name>
+cb env default <environment-name> # sets the default environment
+
+cb request get # lists all the request for the default environment
+cb request get <request-name> # lists the asked request
+cb request set <request-name> # add/update request to the default environment by answering the questions like request endpoint, http method etc.,
+cb request delete <request-name>
+
+cb send <request-name> #uses default environment
 or
-cadburybot send <request-name> --env <env-name>
+cb send <request-name> --env <env-name>
 ```
 
 > Pro tip: CadburyBot saves all these configurations as JSON file under `~/cadburybot` directory. Instead of using `request` or `env` command, You can also manually update them.
@@ -39,20 +39,6 @@ Or install it yourself as:
 
     $ gem install cadburybot
 
-## 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/sharran-murali/cadburybot. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/cadburybot/blob/master/CODE_OF_CONDUCT.md).
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/cadbury/environment.rb

@@ -1,22 +1,26 @@
 require "thor"
 require "json"
 require_relative "./helpers/environment_builder"
-require_relative "./helpers/loader"
 
 module Cadbury
   class Env < Thor
     desc "set [environment-name]", "Creates a new environment or updates the existing environment"
     def set(name)
-      EnvironmentBuilder.create_environment name
+      EnvironmentBuilder.new.create_environment name
     end
 
     desc "get 'or' get [environment-name]", "Gets all environments or the asked environment"
     def get(name = nil)
       if name.nil?
-        puts JSON.pretty_generate EnvironmentBuilder.read_configs
+        puts JSON.pretty_generate EnvironmentBuilder.new.list_environments
       else
-        puts JSON.pretty_generate EnvironmentBuilder.get_config(env: name)
+        puts JSON.pretty_generate EnvironmentBuilder.new.get_environment(name: name)
       end
     end
+
+    desc "delete [environment-name]", "Deletes the environment"
+    def delete(name)
+      EnvironmentBuilder.new.delete_environment name
+    end
   end
 end

data/lib/cadbury/helpers/config_manager.rb

@@ -0,0 +1,32 @@
+require "json"
+require "fileutils"
+require_relative "./global"
+
+class ConfigManager
+  def get_all
+    config = File.open Global::ENV_FILE_PATH
+    config_json = JSON.load config
+    config.close
+    config_json
+  rescue StandardError => e
+    if e.message.include? "No such file or directory"
+      puts "Error: No Environment file found at #{ENV_FILE_PATH}."
+      puts "Please run 'cadburybot env set <env-name>' command to create a new environment"
+    else
+      puts "Error: #{e.message}"
+    end
+    exit
+  end
+
+  def get_by_env(env:)
+    get_all[env]
+  end
+
+  def save(configs)
+    FileUtils.mkdir_p Global::APIBOT_DIR
+    File.open(Global::ENV_FILE_PATH, "w") do |f|
+      f.write(JSON.pretty_generate(configs))
+      puts "Config updated successfully in #{Global::ENV_FILE_PATH}"
+    end
+  end
+end

data/lib/cadbury/helpers/environment_builder.rb

@@ -2,57 +2,55 @@
 
 require "json"
 require "fileutils"
+require_relative "./config_manager"
 
 class EnvironmentBuilder
-  APIBOT_DIR = "#{Dir.home}/apibot".freeze
-  ENV_FILE_PATH = "#{APIBOT_DIR}/environment.json".freeze
-
   attr_accessor :configs
 
-  def self.create_environment(name)
-    config_util = EnvironmentBuilder.new
-    config_util.set_environment name
-    config_util.get_base_url
-    config_util.get_auth_token_header_key
-    config_util.get_auth_token_header_value
-    config_util.save_config_as_json
-  end
-
   def initialize
-    puts "Hi, I am ApiBot!"
-    print "You can have multiple environments of API requests and easily switch between them. "
-    puts "To create an environment please follow the steps,\n"
-    puts "Note: I have created some default values for easily getting started."
-    puts "Press enter for using default value."
-
-    @configs = File.exist?(ENV_FILE_PATH) ? EnvironmentBuilder.read_configs : {}
+    @config_manager = ConfigManager.new
+    @configs = {}
     @env = "dev"
   end
 
-  def self.read_configs
-    config = File.open ENV_FILE_PATH
-    config_json = JSON.load config
-    config.close
-    config_json
-  rescue StandardError => e
-    if e.message.include? "No such file or directory"
-      puts "Error: No Environment file found at #{ENV_FILE_PATH}. Please run 'init' command to create a new environment"
-    else
-      puts "Error: #{e.message}"
+  def create_environment(name, silent: false)
+    unless silent
+      puts "Hi, I am ApiBot!"
+      print "You can have multiple environments of API requests and easily switch between them. "
+      puts "To create an environment please follow the steps,\n"
+      puts "Note: I have created some default values for easily getting started."
+      puts "Press enter for using default value."
     end
-    exit
+
+    @configs = @config_manager.get_all if File.exist?(Global::ENV_FILE_PATH)
+    set_environment name
+    get_base_url
+    get_auth_token_header_key
+    get_auth_token_header_value
+    save_config_as_json
   end
 
-  def self.get_config(env:)
-    EnvironmentBuilder.read_configs[env]
+  def list_environments
+    @config_manager.get_all
   end
 
-  # Instance methods
+  def get_environment(name:)
+    @config_manager.get_by_env(env: name)
+  end
+
+  def delete_environment(name)
+    environments = @config_manager.get_all
+    environments.delete(name)
+    @config_manager.save environments
+  end
+
+  private
 
   def set_environment(name)
     env = name
     @env = env unless env.empty?
     @configs[@env] = {} unless @configs.key?(@env)
+    @configs[@env]["requests"] = {}
   end
 
   def get_base_url
@@ -74,10 +72,6 @@ class EnvironmentBuilder
   end
 
   def save_config_as_json
-    FileUtils.mkdir_p APIBOT_DIR
-    File.open(ENV_FILE_PATH, "w") do |config|
-      config.write(JSON.pretty_generate(@configs))
-      puts "Config saved successfully in #{ENV_FILE_PATH}"
-    end
+    @config_manager.save(@configs)
   end
 end

data/lib/cadbury/helpers/global.rb

@@ -3,4 +3,6 @@
 class Global
   OPTIONS = { env: "dev", headers: {} }.freeze
   DIVIDER = "-" * 50
+  APIBOT_DIR = "#{Dir.home}/apibot".freeze
+  ENV_FILE_PATH = "#{APIBOT_DIR}/environment.json".freeze
 end

data/lib/cadbury/helpers/request_builder.rb

@@ -0,0 +1,83 @@
+require "json"
+require "fileutils"
+require_relative "./global"
+require_relative "./config_manager"
+
+class RequestBuilder
+  def initialize(name: "", env: "dev")
+    @env = env
+    @name = name
+    @endpoint = ""
+    @headers = {}
+    @method = "get"
+    @body = {}
+    @request = {}
+    @config_manager = ConfigManager.new
+  end
+
+  def create_request
+    get_endpoint
+    get_headers
+    get_method
+    get_body
+    self
+  end
+
+  def get_all
+    @config_manager.get_all[@env]["requests"]
+  end
+
+  def get_by_name(name)
+    @config_manager.get_all[@env]["requests"][name]
+  end
+
+  def save
+    configs = @config_manager.get_all
+    if configs.nil? || configs == {}
+      puts "Error: No Environments detected."
+      puts "Please run 'cadburybot env set <env-name>' command to create a new environment"
+      exit
+    end
+    configs[@env]["requests"][@name] = build_request
+    @config_manager.save configs
+  end
+
+  private
+
+  def get_endpoint
+    puts "Endpoint: eg., /api/check-weather"
+    @endpoint = $stdin.gets.chomp
+  end
+
+  def get_headers
+    loop do
+      puts "Headers: [headerKey:headerValue] ---> Type value or press <Enter> to skip"
+      key, value = $stdin.gets.chomp.split ":"
+      break if key.nil? || value.nil?
+
+      @headers[key] = value
+    end
+  rescue StandardError => e
+    puts "Error: #{e.message}"
+    exit
+  end
+
+  def get_method
+    puts "Method: [GET]"
+    @method = $stdin.gets.chomp.upcase
+  end
+
+  def get_body
+    puts "Body: []"
+    body = $stdin.gets.chomp
+    @body = JSON.parse body unless body.empty?
+  end
+
+  def build_request
+    {
+      method: @method,
+      headers: @headers,
+      body: @body
+    }
+  end
+end

data/lib/cadbury/request.rb

@@ -0,0 +1,29 @@
+require "thor"
+require "json"
+require_relative "./helpers/request_builder"
+
+module Cadbury
+  class Request < Thor
+    desc "set [request-name]", "Creates a new request or updates the existing request"
+    def set(name)
+      RequestBuilder
+        .new(name: name, env: options[:env])
+        .create_request
+        .save
+    end
+
+    desc "get 'or' get [environment-name]", "Gets all environments or the asked environment"
+    def get(name = nil)
+      if name.nil?
+        puts JSON.pretty_generate RequestBuilder.new(env: options[:env]).get_all
+      else
+        puts JSON.pretty_generate RequestBuilder.new(name: name).get_by_name name
+      end
+    end
+
+    desc "delete [environment-name]", "Deletes the environment"
+    def delete(name)
+      # EnvironmentBuilder.delete_environment(name)
+    end
+  end
+end

data/lib/cadbury/version.rb

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

data/lib/cadbury.rb

@@ -1,9 +1,17 @@
 require "cadbury/environment"
+require "cadbury/request"
 require "thor"
 
 module Cadbury
   class CLI < Thor
+    shared_options = [:env, { type: :string, required: true }]
+
     desc "env [command]", "CRUD operations for environment"
+    method_option(*shared_options)
     subcommand "env", Cadbury::Env
+
+    desc "request [command]", "CRUD operations for request"
+    method_option(*shared_options)
+    subcommand "request", Cadbury::Request
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cadburybot
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Sharran
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-30 00:00:00.000000000 Z
+date: 2021-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -126,20 +126,23 @@ description: Write a longer description or delete this line.
 email:
 - sharran.murali@gmail.com
 executables:
-- cadburybot
+- cb
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- bin/cadburybot
+- bin/cb
 - bin/console
 - bin/setup
 - lib/cadbury.rb
 - lib/cadbury/environment.rb
+- lib/cadbury/helpers/config_manager.rb
 - lib/cadbury/helpers/environment_builder.rb
 - lib/cadbury/helpers/global.rb
 - lib/cadbury/helpers/http_client.rb
 - lib/cadbury/helpers/loader.rb
+- lib/cadbury/helpers/request_builder.rb
+- lib/cadbury/request.rb
 - lib/cadbury/version.rb
 homepage: https://github.com/sharran-murali/cadbury
 licenses:
@@ -157,7 +160,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="