plz 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 488ff35d58b0afabb4dc2ef94aafee3456bec27f
-  data.tar.gz: db861eecffcf54f36e841e3472ba135522e42190
+  metadata.gz: 2f07a8d7d61f673d93630bc76387e45042ecaba6
+  data.tar.gz: c1b1b718a3cf09b83b80aca3c783e3c5991f84fd
 SHA512:
-  metadata.gz: ae44fcd683b3a0abb5df567df603cc4384ae3ce83adcdd7c0df2fc6d2b83859b226bebbba18dce34e48214806bafa4e53b7578c74e161cd4e47e6bfa0060b8de
-  data.tar.gz: 9453b228fc5806abb8d50a666aed30f92cd84b97c5436fcd5b8a4e63bea9455f09c66e43d00314bb029c8a1eae53077de2acf7a3fffd4ffd28614673f6f936b7
+  metadata.gz: 3485ee06d7409b3a8c15544245947f6fd5121165f7b488de9fd6637142a00bb18e80c7a014399d50e76a6e68f68cf9d25e0459a2cc4aba3388073ebd15b139d6
+  data.tar.gz: 406e5b5bd2e6bd055934214adbdb50925703eef87def6633c62eebdf04acd2cc67f0613b6b056e9f082a3954758479712e0914d4836adba00ab1c65e0e4dc5f7

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## 0.0.2
+* cURL-like output
+* Color output
+
+## 0.0.1
+* 1st release

data/lib/plz.rb

@@ -5,10 +5,14 @@ require "faraday_middleware"
 require "json"
 require "json_schema"
 require "pathname"
+require "rack"
+require "rainbow"
+require "rouge"
 require "yaml"
 
 require "plz/error"
 require "plz/command"
 require "plz/command_builder"
 require "plz/error_command"
+require "plz/response"
 require "plz/version"

data/lib/plz/command.rb

@@ -1,71 +1,33 @@
 module Plz
   class Command
-    # @param action_name [String]
-    # @param target_name [String]
     # @param headers [Hash]
     # @param params [Hash]
-    # @param schema [Hash]
-    def initialize(action_name: nil, target_name: nil, headers: nil, params: nil, schema: nil)
-      @action_name = action_name
-      @target_name = target_name
+    # @param method [String]
+    # @param base_url [String]
+    # @param path [String]
+    def initialize(headers: nil, params: nil, method: nil, base_url: nil, path: nil)
       @headers = headers
       @params = params
-      @schema = schema
+      @method = method
+      @base_url = base_url
+      @path = path
     end
 
-    # TODO
     # Sends an HTTP request and logs out the response
     def call
-      puts client.send(method, path, @params, @headers).body
+      raw = client.send(@method.downcase, @path, @params, @headers)
+      puts Response.new(raw).render
     end
 
     private
 
-    # @return [String]
-    def path
-      current_link.href
-    end
-
-    # @return [Symbol]
-    def method
-      current_link.method
-    end
-
-    # @return [JsonSchema::Schema::Link, nil]
-    def current_link
-      @current_link ||= json_schema.properties.find do |key, schema|
-        if key == @target_name
-          schema.links.find do |link|
-            if link.href && link.method && link.title.underscore == @action_name
-              return link
-            end
-          end
-        end
-      end
-    end
-
-    # @return JsonSchema::Schema
-    # @raise [JsonSchema::SchemaError]
-    def json_schema
-      @json_schema ||= JsonSchema.parse!(@schema).tap(&:expand_references!)
-    end
-
     # @return [Faraday::Connection]
     def client
-      Faraday.new(url: base_url) do |connection|
+      Faraday.new(url: @base_url) do |connection|
         connection.request :json
+        connection.response :json
         connection.adapter :net_http
       end
     end
-
-    # Extracts the base url of the API
-    # @return [String, nil]
-    def base_url
-      json_schema.links.find do |link|
-        if link.href && link.rel == "self"
-          return link.href
-        end
-      end
-    end
   end
 end

data/lib/plz/command_builder.rb

@@ -1,6 +1,6 @@
 module Plz
   class CommandBuilder
-    SCHEMA_FILE_PATH_PATTERN = "{.,config}/schema.{json,yml}"
+    SCHEMA_FILE_PATH_PATTERN = "schema.{json,yml}"
 
     # Builds callable command object from given ARGV
     # @return [Plz::Command]
@@ -19,11 +19,11 @@ module Plz
     def call
       validate!
       Command.new(
-        action_name: action_name,
-        target_name: target_name,
+        method: method,
+        base_url: base_url,
+        path: path,
         headers: headers,
         params: params,
-        schema: schema,
       )
     rescue Error => error
       ErrorCommand.new(error)
@@ -40,8 +40,14 @@ module Plz
         raise NoTargetName
       when !has_schema_file?
         raise SchemaFileNotFound
+      when !has_decodable_schema_file?
+        raise UndecodableSchemaFile, pathname: schema_file_pathname
       when !has_valid_schema_file?
-        raise InvalidSchemaFile, schema_file_pathname
+        raise InvalidSchema, pathname: schema_file_pathname
+      when !has_base_url?
+        raise BaseUrlNotFound, pathname: schema_file_pathname
+      when !has_link?
+        raise LinkNotFound, pathname: schema_file_pathname, action_name: action_name, target_name: target_name
       end
     end
 
@@ -60,11 +66,26 @@ module Plz
       !!schema_file_pathname
     end
 
-    # @return [true, false] True if no error occured in parsing schema file
+    # @return [true, false] True if no error occured in parsing schema file as JSON Schema
     def has_valid_schema_file?
+      !!json_schema
+    end
+
+    # @return [true, false] True if no error occured in decoding schema file
+    def has_decodable_schema_file?
       !!schema
     end
 
+    # @return [true, false] True if given JSON Schema has a link of base URL of API
+    def has_base_url?
+      !!base_url
+    end
+
+    # @return [true, false] True if any link for given action and target found
+    def has_link?
+      !!link
+    end
+
     # @return [Hash]
     def schema
       @schema ||= begin
@@ -109,22 +130,53 @@ module Plz
     def headers
     end
 
+    # @return [String]
+    # @example
+    #   path #=> "/users"
+    def path
+      link.href
+    end
+
+    # @return [String]
+    # @example
+    #   method #=> "GET"
+    def method
+      link.method.to_s.upcase
+    end
+
+    # Extracts the base url of the API
+    # @return [String, nil]
+    # @example
+    #   base_url #=> "https://api.example.com/"
+    def base_url
+      @base_url ||= json_schema.links.find do |link|
+        if link.href && link.rel == "self"
+          return link.href
+        end
+      end
+    end
+
+    # @return [JsonSchema::Schema::Link, nil]
+    def link
+      @link ||= json_schema.properties.find do |key, schema|
+        if key == target_name
+          schema.links.find do |link|
+            if link.href && link.method && link.title.underscore == action_name
+              return link
+            end
+          end
+        end
+      end
+    end
+
+    # @return [JsonSchema::Schema, nil]
+    def json_schema
+      @json_schema ||= JsonSchema.parse!(@schema).tap(&:expand_references!)
+    rescue JsonSchema::SchemaError
+    end
+
     class Error < Error
-      USAGE = <<-EOS.strip_heredoc
-        $ plz <action> <target> [headers|params]
-                  |        |         |      |
-                  |        |         |      `---- 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
-                  |        |
-                  |        `--------------------- target resource name (e.g. user, recipe, etc.)
-                  |
-                  `------------------------------ action name (e.g. show, list, create, delete, etc.)
-      EOS
+      USAGE = "Usage: plz <action> <target> [headers|params]"
     end
 
     class NoActionName < Error
@@ -145,13 +197,39 @@ module Plz
       end
     end
 
-    class InvalidSchemaFile < Error
-      def initialize(pathname)
+    class InvalidSchema < Error
+      def initialize(pathname: pathname)
         @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
-        "Failed to parse #{@pathname}"
+        "#{@pathname} has no definition for `#{@action_name} #{@target_name}`"
       end
     end
   end

data/lib/plz/response.rb

@@ -0,0 +1,66 @@
+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>]
+    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: value,
+        }
+      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

data/lib/plz/version.rb

@@ -1,3 +1,3 @@
 module Plz
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/plz.gemspec

@@ -20,6 +20,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday"
   spec.add_dependency "faraday_middleware"
   spec.add_dependency "json_schema"
+  spec.add_dependency "rack"
+  spec.add_dependency "rainbow"
+  spec.add_dependency "rouge"
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plz
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -66,6 +66,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  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: rainbow
+  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: rouge
+  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
@@ -103,6 +145,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -113,6 +156,7 @@ files:
 - lib/plz/command_builder.rb
 - lib/plz/error.rb
 - lib/plz/error_command.rb
+- lib/plz/response.rb
 - lib/plz/version.rb
 - plz.gemspec
 - schema.yml