plz 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d16e7dc1ce2ee151b95707d38a2c7e01c083e8e4
-  data.tar.gz: 7c3589d4cafde4a6b993ec2d5b073c2cc43b0ba3
+  metadata.gz: f5260f7a973909cd914441eb5b29d5611e6a1aff
+  data.tar.gz: 501f2095a5c66ff2b40ec1ebe742f6ded54f3f4e
 SHA512:
-  metadata.gz: b252fcd39c83256aba2b89a0f1e64c00c753865cac668c8124ba0fb56e78eb022c3d1df42a3089a529f553de65f403e96bb643f5f0296d5ff5243311286946cd
-  data.tar.gz: 4e379afb816dc5f2a2cf4b2e0812f4bc8c1b4c7cf76a17aa5d5cf19d4b62b673d7e2b82664a4383a95f23ab7f494cd99f8f4dda1316e94768a898b63d5c753f7
+  metadata.gz: f29827446649900133e5fd58ce91086434fbd4a3f0d7454876b6d298ca83dc4a3b35a9f94665caae6875139f636015f4556f8b81ab7bf112c804aa5bfbe3e689
+  data.tar.gz: 0432bc2eb51b8efc96ca242a612d05d3d64a568aa99f2594834bbbe0232f6f832d3fbd8782aa0cdb3de737c3a56d6ae62db1f09e14ec31dec6a8d5f47ea19a17

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.0.5
+* Support URI Template in API path
+
+## 0.0.4
+* Implement headers & params parser
+
 ## 0.0.3
 * Color header value
 

data/README.md

@@ -1,7 +1,7 @@
 # Plz
 JSON Schema based command line HTTP client.
 
-## Usage
+![screenshot](images/screenshot.png)
 
 ### Install
 ```sh
@@ -29,6 +29,7 @@ $ plz <action> <target> [headers|params]
 To use Plz, you need to have a JSON Schema file at `./schema.json` or `./schema.yaml`,
 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.
 
 ### Example
 ```sh

data/lib/plz.rb

@@ -1,3 +1,6 @@
+require "active_support/core_ext/hash/keys"
+require "active_support/core_ext/hash/slice"
+require "active_support/core_ext/module/delegation"
 require "active_support/core_ext/string/inflections"
 require "active_support/core_ext/string/strip"
 require "faraday"
@@ -11,6 +14,7 @@ require "rouge"
 require "yaml"
 
 require "plz/error"
+require "plz/arguments"
 require "plz/command"
 require "plz/command_builder"
 require "plz/error_command"

data/lib/plz/arguments.rb

@@ -0,0 +1,49 @@
+module Plz
+  class Arguments
+    # @param arguments [Array] Raw ARGV
+    def initialize(argv)
+      @argv = argv
+    end
+
+    # @return [String, nil] Given action name
+    def action_name
+      ARGV[0]
+    end
+
+    # @return [String, nil] Given target name
+    def target_name
+      ARGV[1]
+    end
+
+    # @return [Hash] Params parsed from given arguments
+    # @raise [Plz::UnparsableJsonParam]
+    def params
+      ARGV[2..-1].inject({}) do |result, section|
+        case
+        when /(?<key>.+):=(?<value>.+)/ =~ section
+          begin
+            result.merge(key => JSON.parse(%<{"key":#{value}}>)["key"])
+          rescue JSON::ParserError
+            raise UnparsableJsonParam, value: value
+          end
+        when /(?<key>.+)=(?<value>.+)/ =~ section
+          result.merge(key => value)
+        else
+          result
+        end
+      end
+    end
+
+    # @return [Hash] Headers parsed from given arguments
+    def headers
+      ARGV[2..-1].inject({}) do |result, section|
+        case
+        when /(?<key>.+):(?<value>[^=]+)/ =~ section
+          result.merge(key => value)
+        else
+          result
+        end
+      end
+    end
+  end
+end

data/lib/plz/command_builder.rb

@@ -10,9 +10,17 @@ module Plz
       new(arguments).call
     end
 
-    # @param [Array<String>] ARGV
-    def initialize(arguments)
-      @arguments = arguments
+    delegate(
+      :action_name,
+      :target_name,
+      :headers,
+      :params,
+      to: :arguments,
+    )
+
+    # @param argv [Array<String>] Raw ARGV
+    def initialize(argv)
+      @argv = argv
     end
 
     # @return [Plz::Command] Callable command object
@@ -23,7 +31,7 @@ module Plz
         base_url: base_url,
         path: path,
         headers: headers,
-        params: params,
+        params: request_params,
       )
     rescue Error => error
       ErrorCommand.new(error)
@@ -109,32 +117,44 @@ module Plz
       @schema_file_pathname ||= Pathname.glob(SCHEMA_FILE_PATH_PATTERN).first
     end
 
-    # @return [String, nil] Given action name
-    def action_name
-      ARGV[0]
+    # @return [String]
+    # @example
+    #   path #=> "/users"
+    def path
+      path_with_template % path_params.symbolize_keys
     end
 
-    # @return [String, nil] Given target name
-    def target_name
-      ARGV[1]
+    # @return [String]
+    # @example
+    #   path_with_template #=> "/apps/%{id}"
+    def path_with_template
+      link.href.gsub(/{(.+)}/) do |matched|
+        key = CGI.unescape($1).gsub(/[()]/, "").split("/").last
+        "%{#{key}}"
+      end
     end
 
-    # TODO
-    # @return [Hash] Params made from given arguments
-    def params
-      {}
+    # @return [Array<String>] Parameter names required for path
+    # @exmaple
+    #   path_keys #=> ["id"]
+    def path_keys
+      link.href.scan(/{(.+)}/).map do |str|
+        CGI.unescape($1).gsub(/[()]/, "").split("/").last
+      end
     end
 
-    # TODO
-    # @return [Hash] Headers made from given arguments
-    def headers
+    # @return [Hash] Params to be embedded into path
+    # @example
+    #   path_params #=> { "id" => 1 }
+    def path_params
+      params.slice(*path_keys)
     end
 
-    # @return [String]
+    # @return [Hash] Params to be used for request body or query string
     # @example
-    #   path #=> "/users"
-    def path
-      link.href
+    #   request_params #=> { "name" => "example" }
+    def request_params
+      params.except(*path_keys)
     end
 
     # @return [String]
@@ -175,62 +195,9 @@ module Plz
     rescue JsonSchema::SchemaError
     end
 
-    class Error < Error
-      USAGE = "Usage: plz <action> <target> [headers|params]"
-    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 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
-        "#{@pathname} has no definition for `#{@action_name} #{@target_name}`"
-      end
+    # @return [Plz::Arguments] Wrapper of Raw ARGV
+    def arguments
+      @arguments ||= Arguments.new(@argv)
     end
   end
 end

data/lib/plz/error.rb

@@ -1,4 +1,69 @@
 module Plz
   class Error < StandardError
+    USAGE = "Usage: plz <action> <target> [headers|params]"
+  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
+    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.3"
+  VERSION = "0.0.5"
 end

data/plz.gemspec

@@ -25,4 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rouge"
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "2.14.1"
+  spec.add_development_dependency "rack-json_schema"
 end

data/schema.yml

@@ -74,8 +74,8 @@ properties:
     "$ref": "#/definitions/user"
 type:
 - object
-description: API server for TQKey
+description: Example API for Plz
 links:
 - href: http://localhost:8080
   rel: self
-title: Dummy API
+title: Example API

data/spec/plz_spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+describe Plz do
+  it { should be_true }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "plz"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plz
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-12 00:00:00.000000000 Z
+date: 2014-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -136,6 +136,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: rack-json_schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - r7kamura@gmail.com
@@ -151,7 +179,9 @@ files:
 - README.md
 - Rakefile
 - bin/plz
+- images/screenshot.png
 - lib/plz.rb
+- lib/plz/arguments.rb
 - lib/plz/command.rb
 - lib/plz/command_builder.rb
 - lib/plz/error.rb
@@ -160,6 +190,8 @@ files:
 - lib/plz/version.rb
 - plz.gemspec
 - schema.yml
+- spec/plz_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/r7kamura/plz
 licenses:
 - MIT
@@ -184,5 +216,7 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: JSON Schema based command line HTTP client.
-test_files: []
+test_files:
+- spec/plz_spec.rb
+- spec/spec_helper.rb
 has_rdoc: