plz 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 488ff35d58b0afabb4dc2ef94aafee3456bec27f
+  data.tar.gz: db861eecffcf54f36e841e3472ba135522e42190
+SHA512:
+  metadata.gz: ae44fcd683b3a0abb5df567df603cc4384ae3ce83adcdd7c0df2fc6d2b83859b226bebbba18dce34e48214806bafa4e53b7578c74e161cd4e47e6bfa0060b8de
+  data.tar.gz: 9453b228fc5806abb8d50a666aed30f92cd84b97c5436fcd5b8a4e63bea9455f09c66e43d00314bb029c8a1eae53077de2acf7a3fffd4ffd28614673f6f936b7

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in plz.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ryo Nakamura
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# Plz
+JSON Schema based command line HTTP client.
+
+## Usage
+
+### Install
+```sh
+$ gem install plz
+```
+
+### Synopsis
+```sh
+$ 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.)
+```
+
+### Schema
+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.
+
+### Example
+```sh
+# GET /users
+$ plz list user
+[
+  {
+    "id": 1,
+    "name": "alice"
+  },
+  {
+    "id": 2,
+    "name": "bob"
+  }
+]
+
+# GET /users/2
+$ plz show user id=2
+{
+  "id": 2,
+  "name": "bob"
+}
+
+# POST /users with {"name":"charlie"} params
+$ plz create user name=charlie
+{
+  "id": 3,
+  "name": "charlie"
+}
+
+# POST /users with {"name":"dave",age:20} params
+$ plz create user name=dave age:=20
+{
+  "id": 4,
+  "age":20
+  "name": "dave"
+}
+
+# POST /users with Api-Access-Token:123 header and {"name":"ellen"} params
+$ plz create user name=ellen Api-Access-Token:123
+{
+  "id": 5,
+  "name": "ellen"
+}
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/plz

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "plz"
+
+command = Plz::CommandBuilder.call(ARGV)
+command.call

data/lib/plz.rb

@@ -0,0 +1,14 @@
+require "active_support/core_ext/string/inflections"
+require "active_support/core_ext/string/strip"
+require "faraday"
+require "faraday_middleware"
+require "json"
+require "json_schema"
+require "pathname"
+require "yaml"
+
+require "plz/error"
+require "plz/command"
+require "plz/command_builder"
+require "plz/error_command"
+require "plz/version"

data/lib/plz/command.rb

@@ -0,0 +1,71 @@
+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
+      @headers = headers
+      @params = params
+      @schema = schema
+    end
+
+    # TODO
+    # Sends an HTTP request and logs out the response
+    def call
+      puts client.send(method, path, @params, @headers).body
+    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|
+        connection.request :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

@@ -0,0 +1,158 @@
+module Plz
+  class CommandBuilder
+    SCHEMA_FILE_PATH_PATTERN = "{.,config}/schema.{json,yml}"
+
+    # Builds callable command object from given ARGV
+    # @return [Plz::Command]
+    # @example
+    #   Plz::CommandBuilder.call(ARGV).call
+    def self.call(arguments)
+      new(arguments).call
+    end
+
+    # @param [Array<String>] ARGV
+    def initialize(arguments)
+      @arguments = arguments
+    end
+
+    # @return [Plz::Command] Callable command object
+    def call
+      validate!
+      Command.new(
+        action_name: action_name,
+        target_name: target_name,
+        headers: headers,
+        params: params,
+        schema: schema,
+      )
+    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
+      when !has_valid_schema_file?
+        raise InvalidSchemaFile, schema_file_pathname
+      end
+    end
+
+    # @return [true, false] True if given arguments include action name
+    def has_action_name?
+      !!action_name
+    end
+
+    # @return [true, false] True if given arguments include target name
+    def has_target_name?
+      !!target_name
+    end
+
+    # @return [true, false] True if schema file exists
+    def has_schema_file?
+      !!schema_file_pathname
+    end
+
+    # @return [true, false] True if no error occured in parsing schema file
+    def has_valid_schema_file?
+      !!schema
+    end
+
+    # @return [Hash]
+    def schema
+      @schema ||= begin
+        case schema_file_pathname.extname
+        when ".yml"
+          YAML.load(schema_file_body)
+        else
+          JSON.parse(schema_file_body)
+        end
+      end
+    rescue
+    end
+
+    # @return [String]
+    def schema_file_body
+      @schema_file_body ||= schema_file_pathname.read
+    end
+
+    # @return [Pathname, nil] Found schema file path
+    def schema_file_pathname
+      @schema_file_pathname ||= Pathname.glob(SCHEMA_FILE_PATH_PATTERN).first
+    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
+
+    # TODO
+    # @return [Hash] Params made from given arguments
+    def params
+      {}
+    end
+
+    # TODO
+    # @return [Hash] Headers made from given arguments
+    def headers
+    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
+    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 InvalidSchemaFile < Error
+      def initialize(pathname)
+        @pathname = pathname
+      end
+
+      def to_s
+        "Failed to parse #{@pathname}"
+      end
+    end
+  end
+end

data/lib/plz/error.rb

@@ -0,0 +1,4 @@
+module Plz
+  class Error < StandardError
+  end
+end

data/lib/plz/error_command.rb

@@ -0,0 +1,14 @@
+module Plz
+  class ErrorCommand
+    # @param error [Plz::Error] Error to show error message to user
+    def initialize(error)
+      @error = error
+    end
+
+    # Logs out error reason and usage, then exits with error code 1
+    def call
+      puts "Error: #{@error}"
+      exit(1)
+    end
+  end
+end

data/lib/plz/version.rb

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

data/plz.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "plz/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "plz"
+  spec.version       = Plz::VERSION
+  spec.authors       = ["Ryo Nakamura"]
+  spec.email         = ["r7kamura@gmail.com"]
+  spec.summary       = "JSON Schema based command line HTTP client."
+  spec.homepage      = "https://github.com/r7kamura/plz"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "json_schema"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/schema.yml

@@ -0,0 +1,81 @@
+---
+"$schema": http://json-schema.org/draft-04/hyper-schema
+definitions:
+  user:
+    title: User
+    description: Each user who is managed by us
+    type:
+    - object
+    required:
+    - id
+    definitions:
+      id:
+        description: Auto incremental unique ID
+        example: 1
+        readOnly: true
+        type:
+        - integer
+      name:
+        description: Human readable user name
+        example: alice
+        type:
+        - string
+      home:
+        description: True if the user exists in the location
+        example: true
+        type:
+        - boolean
+      email:
+        description: Email for fetching gravator icon
+        example: alice@example.com
+        type:
+        - string
+      updated_at:
+        description: When this resource is updated
+        example: "2014-06-10T21:05:20+09:00"
+        readOnly: true
+        format: date-time
+        type:
+        - string
+    links:
+    - description: List all users
+      href: "/users"
+      method: GET
+      rel: instances
+      title: List
+    - description: Create a new user
+      href: "/users"
+      method: POST
+      rel: create
+      title: Create
+    - description: Update the user
+      href: "/users/{(#/definitions/users/definitions/id)}"
+      method: PATCH
+      rel: update
+      title: Update
+    - description: Delete the user
+      href: "/users/{(#/definitions/users/definitions/id)}"
+      method: DELETE
+      rel: delete
+      title: Delete
+    properties:
+      id:
+        "$ref": "#/definitions/user/definitions/id"
+      name:
+        "$ref": "#/definitions/user/definitions/name"
+      home:
+        "$ref": "#/definitions/user/definitions/home"
+      email:
+        "$ref": "#/definitions/user/definitions/email"
+      updated_at:
+        "$ref": "#/definitions/user/definitions/updated_at"
+properties:
+  user:
+    "$ref": "#/definitions/user"
+type:
+- object
+description: API server for TQKey
+links:
+- href: http://localhost:8080
+  rel: self
+title: Dummy API

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: plz
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryo Nakamura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: faraday
+  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: faraday_middleware
+  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: json_schema
+  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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+executables:
+- plz
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/plz
+- lib/plz.rb
+- lib/plz/command.rb
+- lib/plz/command_builder.rb
+- lib/plz/error.rb
+- lib/plz/error_command.rb
+- lib/plz/version.rb
+- plz.gemspec
+- schema.yml
+homepage: https://github.com/r7kamura/plz
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: JSON Schema based command line HTTP client.
+test_files: []
+has_rdoc: