plz 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5260f7a973909cd914441eb5b29d5611e6a1aff
-  data.tar.gz: 501f2095a5c66ff2b40ec1ebe742f6ded54f3f4e
+  metadata.gz: 6fed69be3c08f69644d4a0324f6cb595922227b5
+  data.tar.gz: 5b55fa2b2532c5179af56a384188aabfe995ee84
 SHA512:
-  metadata.gz: f29827446649900133e5fd58ce91086434fbd4a3f0d7454876b6d298ca83dc4a3b35a9f94665caae6875139f636015f4556f8b81ab7bf112c804aa5bfbe3e689
-  data.tar.gz: 0432bc2eb51b8efc96ca242a612d05d3d64a568aa99f2594834bbbe0232f6f832d3fbd8782aa0cdb3de737c3a56d6ae62db1f09e14ec31dec6a8d5f47ea19a17
+  metadata.gz: f1f9b49e49ed042fffc77b83416ffb977c12c4977cb8048475bad1184366a8d8d94fe8627dc84569457e3c2ee7ad1ea58107498e302940d6185114e29ef3f80b
+  data.tar.gz: 616d398921414557c4da80cc82163ff2c3cbaac42f814185ed3abe86bbbf5fd48edbafdc9af5b058a54e7d3d08be421dcc29900e93952b7a71afc5bcd6d54ccb

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.0.6
+* Better error handling
+* Add some command line options
+ * `--help`
+ * `--no-color`
+ * `--no-response-header`
+ * `--no-response-body`
+
 ## 0.0.5
 * Support URI Template in API path
 

data/lib/plz.rb

@@ -11,6 +11,7 @@ require "pathname"
 require "rack"
 require "rainbow"
 require "rouge"
+require "slop"
 require "yaml"
 
 require "plz/error"
@@ -18,5 +19,5 @@ require "plz/arguments"
 require "plz/command"
 require "plz/command_builder"
 require "plz/error_command"
-require "plz/response"
+require "plz/response_renderer"
 require "plz/version"

data/lib/plz/command.rb

@@ -5,18 +5,29 @@ module Plz
     # @param method [String]
     # @param base_url [String]
     # @param path [String]
-    def initialize(headers: nil, params: nil, method: nil, base_url: nil, path: nil)
+    # @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
-      raw = client.send(@method.downcase, @path, @params, @headers)
-      puts Response.new(raw).render
+      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
@@ -29,5 +40,20 @@ module Plz
         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

data/lib/plz/command_builder.rb

@@ -3,7 +3,8 @@ module Plz
     SCHEMA_FILE_PATH_PATTERN = "schema.{json,yml}"
 
     # Builds callable command object from given ARGV
-    # @return [Plz::Command]
+    # @return [Plz::Command, Plz::ErrorCommand]
+    # @note This is a shortcut for #call method
     # @example
     #   Plz::CommandBuilder.call(ARGV).call
     def self.call(arguments)
@@ -25,6 +26,7 @@ module Plz
 
     # @return [Plz::Command] Callable command object
     def call
+      exit_if_help
       validate!
       Command.new(
         method: method,
@@ -32,6 +34,7 @@ module Plz
         path: path,
         headers: headers,
         params: request_params,
+        options: options,
       )
     rescue Error => error
       ErrorCommand.new(error)
@@ -199,5 +202,20 @@ module Plz
     def arguments
       @arguments ||= Arguments.new(@argv)
     end
+
+    # @return [Hash] Command line options
+    def options
+      @options ||= Slop.parse!(@argv, help: true) do
+        banner Error::USAGE
+        on "no-response-header", "Hide response header"
+        on "no-response-body", "Hide response body"
+        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
+    end
   end
 end

data/lib/plz/error.rb

@@ -1,6 +1,6 @@
 module Plz
   class Error < StandardError
-    USAGE = "Usage: plz <action> <target> [headers|params]"
+    USAGE = "Usage: plz <action> <target> [headers|params] [options]"
   end
 
   class NoActionName < Error

data/lib/plz/response_renderer.rb

@@ -0,0 +1,97 @@
+module Plz
+  class ResponseRenderer
+    # Shortcut for #call method
+    def self.call(*args)
+      new(*args).call
+    end
+
+    # @param status [Fixnum] Status code
+    # @param headers [Hash] Response header fields
+    # @param body [Array, Hash] JSON decoded response body
+    # @param response_header [true, false] Flag to show response header
+    # @param response_body [true, false] Flag to show response body
+    # @param color [true, false] Flag to color response body
+    def initialize(status: nil, headers: nil, body: nil, response_header: nil, response_body: nil, color: nil)
+      @status = status
+      @headers = headers
+      @body = body
+      @show_response_header = response_header
+      @show_response_body = response_body
+      @color_response = color
+    end
+
+    # Renders response with given options
+    # @return [String] Rendered output
+    def call
+      template % {
+        status: status,
+        headers: headers,
+        body: body,
+      }
+    end
+
+    private
+
+    # @return [String] Template for embedding variables, changing by options
+    def template
+      str = ""
+      str << <<-EOS.strip_heredoc if @show_response_header
+        HTTP/1.1 %{status}
+        %{headers}
+      EOS
+      str << "\n" if @show_response_header && @show_response_body
+      str << "%{body}" if @show_response_body
+      str
+    end
+
+    # @return [String]
+    # @example
+    #   headers #=> ["Content-Type: application/json"]
+    def headers
+      @headers.sort_by do |key, value|
+        key
+      end.map do |key, value|
+        "%{key}: %{value}" % {
+          key: Rainbow(key.split("-").map(&:camelize).join("-")).underline,
+          value: Rainbow(value).green,
+        }
+      end.join("\n")
+    end
+
+    # @return [String]
+    def status
+      Rainbow("#{@status} #{status_in_words}").bright
+    end
+
+    # @return [String] Words for its status code
+    def status_in_words
+      Rack::Utils::HTTP_STATUS_CODES[@status]
+    end
+
+    # @return [String]
+    def body
+      if @color_response
+        Rouge::Formatters::Terminal256.format(
+          Rouge::Lexers::Javascript.new.lex(plain_body),
+          theme: "github"
+        )
+      else
+        plain_body
+      end
+    end
+
+    # @return [String] Pretty-printed JSON body
+    def plain_body
+      JSON.pretty_generate(@body) + "\n"
+    end
+
+    # Overridden to disable coloring
+    def Rainbow(str)
+      if @color_response
+        super
+      else
+        Rainbow::NullPresenter.new(str.to_s)
+      end
+    end
+  end
+end

data/lib/plz/version.rb

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

data/plz.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rack"
   spec.add_dependency "rainbow"
   spec.add_dependency "rouge"
+  spec.add_dependency "slop"
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "2.14.1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plz
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-13 00:00:00.000000000 Z
+date: 2014-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -186,7 +200,7 @@ files:
 - lib/plz/command_builder.rb
 - lib/plz/error.rb
 - lib/plz/error_command.rb
-- lib/plz/response.rb
+- lib/plz/response_renderer.rb
 - lib/plz/version.rb
 - plz.gemspec
 - schema.yml

data/lib/plz/response.rb

@@ -1,68 +0,0 @@
-module Plz
-  class Response
-    TEMPLATE = <<-EOS.strip_heredoc
-      HTTP/1.1 %{status}
-      %{headers}
-
-      %{body}
-    EOS
-
-    # @param [Faraday::Response]
-    def initialize(raw)
-      @raw = raw
-    end
-
-    # @return [String]
-    def render
-      TEMPLATE % {
-        status: status,
-        headers: headers.join("\n"),
-        body: body,
-      }
-    end
-
-    private
-
-    # @return [Array<String>]
-    # @example
-    #   headers #=> ["Content-Type: application/json"]
-    def headers
-      @raw.headers.sort_by do |key, value|
-        key
-      end.map do |key, value|
-        "%{key}: %{value}" % {
-          key: Rainbow(key.split("-").map(&:camelize).join("-")).underline,
-          value: Rainbow(value).green,
-        }
-      end
-    end
-
-    # @return [String]
-    def status
-      Rainbow("#{status_code} #{status_in_words}").bright
-    end
-
-    # @return [Fixnum]
-    def status_code
-      @raw.status
-    end
-
-    # @return [String] Words for its status code
-    def status_in_words
-      Rack::Utils::HTTP_STATUS_CODES[@raw.status]
-    end
-
-    # @return [String]
-    def body
-      Rouge::Formatters::Terminal256.format(
-        Rouge::Lexers::Javascript.new.lex(plain_body),
-        theme: "github"
-      )
-    end
-
-    # @return [String] Pretty-printed JSON body
-    def plain_body
-      JSON.pretty_generate(@raw.body)
-    end
-  end
-end