plz 0.0.6 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fed69be3c08f69644d4a0324f6cb595922227b5
-  data.tar.gz: 5b55fa2b2532c5179af56a384188aabfe995ee84
+  metadata.gz: 74ec91c41138b2f96d02372d1166737067d0bb1a
+  data.tar.gz: 3f8766d51ffb4bc9dd2e72bc318de6d0fd3c02b9
 SHA512:
-  metadata.gz: f1f9b49e49ed042fffc77b83416ffb977c12c4977cb8048475bad1184366a8d8d94fe8627dc84569457e3c2ee7ad1ea58107498e302940d6185114e29ef3f80b
-  data.tar.gz: 616d398921414557c4da80cc82163ff2c3cbaac42f814185ed3abe86bbbf5fd48edbafdc9af5b058a54e7d3d08be421dcc29900e93952b7a71afc5bcd6d54ccb
+  metadata.gz: d87b4bd04dfa82276006b3e1340b6f2b34250fc4403d6b74895de0d967ea5fe9eb401422afa63b6ac1947bad3770ad1df653fd9cdb78b065828e65d7b4c81c4c
+  data.tar.gz: 442b673abd50fafd745cd3996e4c436ebb8de0f7cb3b28711ece3d7a3f0adc97284332a7efc5c3cbf6c3fb8aa696cf3b2ac6fb46c9b68b0fba5761f23da4d477

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.0.8
+* Fix bug :bug:
+
+## 0.0.7
+* Add command examples in help message
+
 ## 0.0.6
 * Better error handling
 * Add some command line options

data/README.md

@@ -10,19 +10,20 @@ $ gem install plz
 
 ### Synopsis
 ```sh
-$ plz <action> <target> [headers|params]
+$ plz <action> <target> [headers|params] [options]
+         |        |         |      |       |
+         |        |         |      |       `-- --no-response-header
+         |        |         |      |           --no-response-body
+         |        |         |      |           --no-color
+         |        |         |      |           --help, -h
          |        |         |      |
-         |        |         |      `---- key=value ({"key":"value"}) or key:=value ({"key":value})
-         |        |         |            params can be:
-         |        |         |            * URI Template variable
-         |        |         |            * Query string in GET method
-         |        |         |            * Request body in other methods
+         |        |         |      `---------- key=value or key:=value
          |        |         |
-         |        |         `----------- Key:value
+         |        |         `----------------- Key:value
          |        |
-         |        `--------------------- target resource name (e.g. user, recipe, etc.)
+         |        `--------------------------- target name
          |
-         `------------------------------ action name (e.g. show, list, create, delete, etc.)
+         `------------------------------------ action name
 ```
 
 ### Schema
@@ -31,6 +32,28 @@ that describes about the API where you want to send HTTP request.
 Plz interprets command-line arguments based on that JSON Schema, then sends HTTP request.
 See [schema.yml](schema.yml) as an example.
 
+### Headers
+To set custom request headers you can use `Key:value` syntax in command line argument.
+
+```sh
+$ plz list user Api-Access-Token:123
+```
+
+### Params
+Params are used for the following purpose:
+
+* URI Template variables
+* Query string in GET method
+* Request body in other methods
+
+You can set params by `key=value` or `key:=value` syntax in command line argument.
+`key=value` is parsed into String value,
+while `key:=value` is parsed into JSON value (e.g. key:=17 will be `{"key":17}`).
+
+```sh
+$ plz create user name=alice age:=17
+```
+
 ### Example
 ```sh
 # GET /users

data/lib/plz.rb

@@ -16,8 +16,17 @@ require "yaml"
 
 require "plz/error"
 require "plz/arguments"
-require "plz/command"
 require "plz/command_builder"
+require "plz/commands/base_url_not_found"
+require "plz/commands/help"
+require "plz/commands/invalid_schema"
+require "plz/commands/link_not_found"
+require "plz/commands/no_action_name"
+require "plz/commands/no_target_name"
+require "plz/commands/request"
+require "plz/commands/schema_file_not_found"
+require "plz/commands/undecodable_schema_file"
+require "plz/commands/unparsable_json_param"
 require "plz/error_command"
 require "plz/response_renderer"
 require "plz/version"

data/lib/plz/arguments.rb

@@ -18,7 +18,7 @@ module Plz
     # @return [Hash] Params parsed from given arguments
     # @raise [Plz::UnparsableJsonParam]
     def params
-      ARGV[2..-1].inject({}) do |result, section|
+      @params ||= ARGV[2..-1].inject({}) do |result, section|
         case
         when /(?<key>.+):=(?<value>.+)/ =~ section
           begin

data/lib/plz/command_builder.rb

@@ -26,42 +26,56 @@ module Plz
 
     # @return [Plz::Command] Callable command object
     def call
-      exit_if_help
-      validate!
-      Command.new(
-        method: method,
-        base_url: base_url,
-        path: path,
-        headers: headers,
-        params: request_params,
-        options: options,
-      )
-    rescue Error => error
-      ErrorCommand.new(error)
-    end
-
-    private
-
-    # @raise [Plz::Error] Raises if invalid arguments given
-    def validate!
       case
-      when !has_action_name?
-        raise NoActionName
-      when !has_target_name?
-        raise NoTargetName
       when !has_schema_file?
-        raise SchemaFileNotFound
+        Commands::SchemaFileNotFound.new
       when !has_decodable_schema_file?
-        raise UndecodableSchemaFile, pathname: schema_file_pathname
+        Commands::UndecodableSchemaFile.new(pathname: schema_file_pathname)
       when !has_valid_schema_file?
-        raise InvalidSchema, pathname: schema_file_pathname
+        Commands::InvalidSchema.new(pathname: schema_file_pathname, error: @json_schema_error)
       when !has_base_url?
-        raise BaseUrlNotFound, pathname: schema_file_pathname
+        Commands::BaseUrlNotFound.new(pathname: schema_file_pathname)
+      when has_help?
+        Commands::Help.new(options: options, schema: json_schema)
+      when !has_action_name?
+        Commands::NoActionName.new
+      when !has_target_name?
+        Commands::NoTargetName.new
       when !has_link?
-        raise LinkNotFound, pathname: schema_file_pathname, action_name: action_name, target_name: target_name
+        Commands::LinkNotFound.new(
+          pathname: schema_file_pathname,
+          action_name: action_name,
+          target_name: target_name
+        )
+      when has_unparsable_json_param?
+        Commands::UnparsableJsonParam.new(error: @json_parse_error)
+      else
+        Commands::Request.new(
+          method: method,
+          base_url: base_url,
+          path: path,
+          headers: headers,
+          params: request_params,
+          options: options,
+        )
       end
     end
 
+    private
+
+    def has_unparsable_json_param?
+      params
+      false
+    rescue UnparsableJsonParam => exception
+      @json_parse_error = exception
+      true
+    end
+
+    # @return [true, false] True if --help or -h given
+    def has_help?
+      options[:help]
+    end
+
     # @return [true, false] True if given arguments include action name
     def has_action_name?
       !!action_name
@@ -79,7 +93,7 @@ module Plz
 
     # @return [true, false] True if no error occured in parsing schema file as JSON Schema
     def has_valid_schema_file?
-      !!json_schema
+      !json_schema.nil?
     end
 
     # @return [true, false] True if no error occured in decoding schema file
@@ -195,7 +209,9 @@ module Plz
     # @return [JsonSchema::Schema, nil]
     def json_schema
       @json_schema ||= JsonSchema.parse!(@schema).tap(&:expand_references!)
-    rescue JsonSchema::SchemaError
+    rescue => exception
+      @json_schema_error = exception
+      nil
     end
 
     # @return [Plz::Arguments] Wrapper of Raw ARGV
@@ -205,17 +221,13 @@ module Plz
 
     # @return [Hash] Command line options
     def options
-      @options ||= Slop.parse!(@argv, help: true) do
+      @options ||= Slop.parse!(@argv) do
         banner Error::USAGE
-        on "no-response-header", "Hide response header"
-        on "no-response-body", "Hide response body"
+        on "h", "help", "Display help message"
         on "no-color", "Disable coloring output"
-      end.to_hash
-    end
-
-    # Display the help message and exits the program if --help or -h given
-    def exit_if_help
-      options
+        on "no-response-body", "Hide response body"
+        on "no-response-header", "Hide response header"
+      end
     end
   end
 end

data/lib/plz/commands/base_url_not_found.rb

@@ -0,0 +1,13 @@
+module Plz
+  module Commands
+    class BaseUrlNotFound
+      def initialize(pathname: nil)
+        @pathname = pathname
+      end
+
+      def call
+        puts "#{@pathname} has no base URL at top-level links property"
+      end
+    end
+  end
+end

data/lib/plz/commands/help.rb

@@ -0,0 +1,30 @@
+module Plz
+  module Commands
+    class Help
+      # @param options [Slop]
+      # @param schema [JsonSchema::Schema]
+      def initialize(options: nil, schema: nil)
+        @options = options
+        @schema = schema
+      end
+
+      # Logs out help message
+      def call
+        puts %<#{@options}\nExamples:\n#{links.join("\n")}>
+      end
+
+      private
+
+      # @return [Array<String>]
+      def links
+        @schema.properties.map do |target_name, schema|
+          schema.links.map do |link|
+            if link.href && link.method && link.title
+              "  plz #{link.title.underscore} #{target_name.underscore}"
+            end
+          end.compact
+        end.flatten
+      end
+    end
+  end
+end

data/lib/plz/commands/invalid_schema.rb

@@ -0,0 +1,20 @@
+module Plz
+  module Commands
+    class InvalidSchema
+      def initialize(pathname: nil, error: error)
+        @pathname = pathname
+        @error = error
+      end
+
+      def call
+        puts "#{@pathname} was invalid:#{error_message}"
+      end
+
+      private
+
+      def error_message
+        @error.to_s.gsub("#: ", "\n")
+      end
+    end
+  end
+end

data/lib/plz/commands/link_not_found.rb

@@ -0,0 +1,15 @@
+module Plz
+  module Commands
+    class LinkNotFound
+      def initialize(pathname: nil, action_name: action_name, target_name: target_name)
+        @pathname = pathname
+        @action_name = action_name
+        @target_name = target_name
+      end
+
+      def call
+        puts "#{@pathname} has no definition for `#{@action_name} #{@target_name}`"
+      end
+    end
+  end
+end

data/lib/plz/commands/no_action_name.rb

@@ -0,0 +1,9 @@
+module Plz
+  module Commands
+    class NoActionName
+      def call
+        puts "You didn't pass action name\n#{Error::USAGE}"
+      end
+    end
+  end
+end

data/lib/plz/commands/no_target_name.rb

@@ -0,0 +1,9 @@
+module Plz
+  module Commands
+    class NoTargetName
+      def call
+        puts "You didn't pass target name\n#{Error::USAGE}"
+      end
+    end
+  end
+end

data/lib/plz/commands/request.rb

@@ -0,0 +1,61 @@
+module Plz
+  module Commands
+    class Request
+      # @param headers [Hash]
+      # @param params [Hash]
+      # @param method [String]
+      # @param base_url [String]
+      # @param path [String]
+      # @param options [Hash]
+      def initialize(headers: nil, params: nil, method: nil, base_url: nil, path: nil, options: nil)
+        @headers = headers
+        @params = params
+        @method = method
+        @base_url = base_url
+        @path = path
+        @options = options
+      end
+
+      # Sends an HTTP request and logs out the response
+      def call
+        response = client.send(@method.downcase, @path, @params, @headers)
+        print ResponseRenderer.call(
+          status: response.status,
+          headers: response.headers,
+          body: response.body,
+          response_header: flag_to_show_response_header,
+          response_body: flag_to_show_response_body,
+          color: flag_to_color_response,
+        )
+      rescue Faraday::ConnectionFailed => exception
+        puts exception
+      end
+
+      private
+
+      # @return [Faraday::Connection]
+      def client
+        Faraday.new(url: @base_url) do |connection|
+          connection.request :json
+          connection.response :json
+          connection.adapter :net_http
+        end
+      end
+
+      # @return [true, false]
+      def flag_to_show_response_header
+        !@options[:"no-response-header"]
+      end
+
+      # @return [true, false]
+      def flag_to_show_response_body
+        !@options[:"no-response-body"]
+      end
+
+      # @return [true, false]
+      def flag_to_color_response
+        !@options[:"no-color"]
+      end
+    end
+  end
+end

data/lib/plz/commands/schema_file_not_found.rb

@@ -0,0 +1,9 @@
+module Plz
+  module Commands
+    class SchemaFileNotFound
+      def call
+        puts "Schema file was not found in #{CommandBuilder::SCHEMA_FILE_PATH_PATTERN}"
+      end
+    end
+  end
+end

data/lib/plz/commands/undecodable_schema_file.rb

@@ -0,0 +1,13 @@
+module Plz
+  module Commands
+    class UndecodableSchemaFile
+      def initialize(pathname: nil)
+        @pathname = pathname
+      end
+
+      def call
+        puts "Failed to decode #{@pathname}"
+      end
+    end
+  end
+end

data/lib/plz/commands/unparsable_json_param.rb

@@ -0,0 +1,13 @@
+module Plz
+  module Commands
+    class UnparsableJsonParam
+      def initialize(error: error)
+        @error = error
+      end
+
+      def call
+        puts "Given `#{@error.value}` was not valid as JSON"
+      end
+    end
+  end
+end

data/lib/plz/error.rb

@@ -3,67 +3,11 @@ module Plz
     USAGE = "Usage: plz <action> <target> [headers|params] [options]"
   end
 
-  class NoActionName < Error
-    def to_s
-      "You didn't pass action name\n#{USAGE}"
-    end
-  end
-
-  class NoTargetName < Error
-    def to_s
-      "You didn't pass target name\n#{USAGE}"
-    end
-  end
-
-  class SchemaFileNotFound < Error
-    def to_s
-      "Schema file was not found in #{SCHEMA_FILE_PATH_PATTERN}"
-    end
-  end
-
   class UnparsableJsonParam < Error
+    attr_reader :value
+
     def initialize(value: nil)
       @value = value
     end
-
-    def to_s
-      "Given `#{@value}` was not valid as JSON"
-    end
-  end
-
-  class InvalidSchema < Error
-    def initialize(pathname: nil)
-      @pathname = pathname
-    end
-  end
-
-  class UndecodableSchemaFile < InvalidSchema
-    def to_s
-      "Failed to decode #{@pathname}"
-    end
-  end
-
-  class InvalidSchemaFile < InvalidSchema
-    def to_s
-      "#{@pathname} was invalid JSON Schema"
-    end
-  end
-
-  class BaseUrlNotFound < InvalidSchema
-    def to_s
-      "#{@pathname} has no base URL at top-level links property"
-    end
-  end
-
-  class LinkNotFound < InvalidSchema
-    def initialize(action_name: action_name, target_name: target_name, **args)
-      super(**args)
-      @action_name = action_name
-      @target_name = target_name
-    end
-
-    def to_s
-      "#{@pathname} has no definition for `#{@action_name} #{@target_name}`"
-    end
   end
 end

data/lib/plz/version.rb

@@ -1,3 +1,3 @@
 module Plz
-  VERSION = "0.0.6"
+  VERSION = "0.0.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plz
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.8
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -196,8 +196,17 @@ files:
 - images/screenshot.png
 - lib/plz.rb
 - lib/plz/arguments.rb
-- lib/plz/command.rb
 - lib/plz/command_builder.rb
+- lib/plz/commands/base_url_not_found.rb
+- lib/plz/commands/help.rb
+- lib/plz/commands/invalid_schema.rb
+- lib/plz/commands/link_not_found.rb
+- lib/plz/commands/no_action_name.rb
+- lib/plz/commands/no_target_name.rb
+- lib/plz/commands/request.rb
+- lib/plz/commands/schema_file_not_found.rb
+- lib/plz/commands/undecodable_schema_file.rb
+- lib/plz/commands/unparsable_json_param.rb
 - lib/plz/error.rb
 - lib/plz/error_command.rb
 - lib/plz/response_renderer.rb

data/lib/plz/command.rb

@@ -1,59 +0,0 @@
-module Plz
-  class Command
-    # @param headers [Hash]
-    # @param params [Hash]
-    # @param method [String]
-    # @param base_url [String]
-    # @param path [String]
-    # @param options [Hash]
-    def initialize(headers: nil, params: nil, method: nil, base_url: nil, path: nil, options: nil)
-      @headers = headers
-      @params = params
-      @method = method
-      @base_url = base_url
-      @path = path
-      @options = options
-    end
-
-    # Sends an HTTP request and logs out the response
-    def call
-      response = client.send(@method.downcase, @path, @params, @headers)
-      print ResponseRenderer.call(
-        status: response.status,
-        headers: response.headers,
-        body: response.body,
-        response_header: flag_to_show_response_header,
-        response_body: flag_to_show_response_body,
-        color: flag_to_color_response,
-      )
-    rescue Faraday::ConnectionFailed => exception
-      puts exception
-    end
-
-    private
-
-    # @return [Faraday::Connection]
-    def client
-      Faraday.new(url: @base_url) do |connection|
-        connection.request :json
-        connection.response :json
-        connection.adapter :net_http
-      end
-    end
-
-    # @return [true, false]
-    def flag_to_show_response_header
-      !@options[:"no-response-header"]
-    end
-
-    # @return [true, false]
-    def flag_to_show_response_body
-      !@options[:"no-response-body"]
-    end
-
-    # @return [true, false]
-    def flag_to_color_response
-      !@options[:"no-color"]
-    end
-  end
-end