docomoru 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1feaff8bd63031fba1d9f25bf7393dbbc18c601c
-  data.tar.gz: cf783fdc98fc102b7841e203434493ca18c78bf1
+  metadata.gz: d04d819418e0183a2bde1d8d85ee096a91f6c1d6
+  data.tar.gz: f49da17d964b80a229105e960ed4e319729648c0
 SHA512:
-  metadata.gz: 9166219c8b8c0eed5524d7f3bde099471f451b53e94a2e4b1dc7ab353293f75d8efda3970e44bb7c7d21ab18937834f0d0362127387e074b1eaaeedabbd59a12
-  data.tar.gz: 0bd018033a62327c95a7b7122bd9d4515f6a91f295ac3441bbcbe4e4b75423bcf83e4c40d511e06856feeab09bb8c3ffc1d10cdba4be28cdce9895dae47abef1
+  metadata.gz: f8ec6d380bbd1cebe49f39366f4ff3035dda5ab3ae1ba0211e4e0258b02e24e57da31dee75aa2be7e80b6b4d1fb0d0546ee8f5d3dcec5eadb2d3c7de2bf6ee0c
+  data.tar.gz: 270de75d628caa1f2f35006c3da903b21370e6917e21b41eb51ad8d4ef9f9b28732ce41dd7201b9248fcbe33d8b08a39a9889371398bec6de77fe32e33bf111d

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.1.0
+- Add `docomoru` executable for CLI use
+
 ## 0.0.3
 - Make it compatible with Ruby 2.0
 

data/README.md

@@ -1,8 +1,16 @@
 # Docomoru
 Client library for DoCoMo API written in Ruby.
 
-## Usage
-Currenty docomoru is supporting [Dialogue API](https://dev.smt.docomo.ne.jp/?p=docs.api.page&api_docs_id=3).
+## Install
+Note: requires Ruby 2.0.0 or higher.
+
+```sh
+gem install docomoru
+```
+
+## Library
+Currenty docomoru is supporting [Dialogue API](https://dev.smt.docomo.ne.jp/?p=docs.api.page&api_docs_id=3)
+(You need DoCoMo API Key).
 
 ```rb
 client = Docomoru::Client.new(api_key: ENV["DOCOMO_API_KEY"])
@@ -23,3 +31,23 @@ response.body #=> {
   "context" => "dXIgT9u1_XKfO1QbaVkAGQ"
 }
 ```
+
+## CLI
+`docomoru` executable is bundled to call use Docomoru from CLI.
+
+```
+$ docomoru <method> <arguments> [options]
+              |          |          |
+              |          |          `-- -a, --api-key (or use DOCOMO_API_KEY env)
+              |          |              -h, --help
+              |          |                  --header
+              |          |                  --no-body
+              |          |
+              |          `------------------------------ required arguments for the method
+              |
+              `----------------------------------------- method name
+
+$ docomoru create_dialogue Gemになってみた感想はどうですか
+```
+
+![](images/cli.png)

data/bin/docomoru

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "docomoru"
+
+builder = Docomoru::CommandBuilder.new(ARGV)
+command = builder.call
+command.call

data/docomoru.gemspec

@@ -19,6 +19,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activesupport"
   spec.add_dependency "faraday"
   spec.add_dependency "faraday_middleware"
+  spec.add_dependency "json"
+  spec.add_dependency "rack"
+  spec.add_dependency "slop"
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/docomoru/arguments.rb

@@ -0,0 +1,131 @@
+require "json"
+require "slop"
+
+module Docomoru
+  class Arguments
+    def initialize(argv)
+      @argv = argv
+    end
+
+    def api_key
+      slop_options["api-key"] || ENV["DOCOMO_API_KEY"]
+    end
+
+    def arguments
+      parsed_argv_data[:arguments]
+    end
+
+    def error_message
+      slop_options.to_s
+    end
+
+    def headers
+      parsed_argv_data[:headers]
+    end
+
+    def method_name
+      ARGV[0]
+    end
+
+    def params
+      params_from_stdin.merge(parsed_argv_data[:params])
+    end
+
+    def show_body
+      !slop_options["no-body"]
+    end
+
+    def show_header
+      slop_options["header"]
+    end
+
+    def valid?
+      has_valid_slop_options? && has_valid_method_name? && has_valid_arguments? &&
+        !has_invalid_json_input? && has_api_key?
+    end
+
+    private
+
+    def has_api_key?
+      !!api_key
+    end
+
+    def has_input_from_stdin?
+      has_pipe_input? || has_redirect_input?
+    end
+
+    def has_invalid_json_input?
+      params_from_stdin
+      false
+    rescue JSON::ParserError
+      true
+    end
+
+    def has_pipe_input?
+      File.pipe?(STDIN)
+    end
+
+    def has_redirect_input?
+      File.select([STDIN], [], [], 0) != nil
+    end
+
+    def has_valid_arguments?
+      -(Client.instance_method(method_name).arity) - 1 == arguments.length
+    end
+
+    def has_valid_method_name?
+      !method_name.nil? && Client.instance_methods.include?(method_name.to_sym)
+    end
+
+    def has_valid_slop_options?
+      !slop_options["help"]
+    rescue
+      false
+    end
+
+    def params_from_stdin
+      @params_from_stdin ||= begin
+        if has_input_from_stdin?
+          JSON.parse(STDIN.read)
+        else
+          {}
+        end
+      end
+    end
+
+    def parsed_argv_data
+      @parsed_argv_data ||= begin
+        params = {}
+        headers = {}
+        arguments = []
+        ARGV[1..-1].each do |section|
+          case
+          when /(?<key>.+):(?<value>[^=]+)/ =~ section
+            headers[key] = value
+          when /(?<key>.+):=(?<value>.+)/ =~ section
+            params[key] = JSON.parse(%<{"key":#{value}}>)["key"]
+          when /(?<key>.+)=(?<value>.+)/ =~ section
+            params[key] = value
+          else
+            arguments << section
+          end
+        end
+        {
+          arguments: arguments,
+          headers: headers,
+          params: params,
+        }
+      end
+    end
+
+    def slop_options
+      @slop_options ||= Slop.parse!(@argv) do
+        banner "Usage: docomoru <method> [arguments] [headers|params] [options]"
+        on "a", "api-key=", "Pass API Key or use DOCOMO_API_KEY instead"
+        on "h", "help", "Display help message"
+        on "header", "Show response header"
+        on "no-body", "Hide response body"
+      end
+    end
+  end
+end

data/lib/docomoru/command_builder.rb

@@ -0,0 +1,25 @@
+require "docomoru/arguments"
+require "docomoru/commands/error"
+require "docomoru/commands/request"
+
+module Docomoru
+  class CommandBuilder
+    def initialize(argv)
+      @argv = argv
+    end
+
+    def call
+      if arguments.valid?
+        Commands::Request.new(arguments)
+      else
+        Commands::Error.new(arguments)
+      end
+    end
+
+    private
+
+    def arguments
+      @arguments ||= Arguments.new(@argv)
+    end
+  end
+end

data/lib/docomoru/commands/base.rb

@@ -0,0 +1,13 @@
+module Docomoru
+  module Commands
+    class Base
+      def initialize(arguments)
+        @arguments = arguments
+      end
+
+      def call
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/docomoru/commands/error.rb

@@ -0,0 +1,11 @@
+require "docomoru/commands/base"
+
+module Docomoru
+  module Commands
+    class Error < Base
+      def call
+        abort(@arguments.error_message)
+      end
+    end
+  end
+end

data/lib/docomoru/commands/request.rb

@@ -0,0 +1,29 @@
+require "docomoru/client"
+require "docomoru/commands/base"
+require "docomoru/response_renderer"
+
+module Docomoru
+  module Commands
+    class Request < Base
+      def call
+        response = client.send(
+          @arguments.method_name,
+          *@arguments.arguments,
+          @arguments.params,
+          @arguments.headers,
+        )
+        print ResponseRenderer.new(
+          response,
+          show_body: @arguments.show_body,
+          show_header: @arguments.show_header,
+        )
+      end
+
+      private
+
+      def client
+        Client.new(api_key: @arguments.api_key)
+      end
+    end
+  end
+end

data/lib/docomoru/response.rb

@@ -1,4 +1,5 @@
 require "active_support/core_ext/string/inflections"
+require "rack/utils"
 
 module Docomoru
   class Response
@@ -21,5 +22,9 @@ module Docomoru
     def status
       @raw_status
     end
+
+    def status_message
+      Rack::Utils::HTTP_STATUS_CODES[status]
+    end
   end
 end

data/lib/docomoru/response_renderer.rb

@@ -0,0 +1,54 @@
+require "active_support/core_ext/string/strip"
+require "json"
+
+module Docomoru
+  class ResponseRenderer
+    def initialize(response, show_header: nil, show_body: nil)
+      @response = response
+      @show_body = show_body
+      @show_header = show_header
+    end
+
+    def to_s
+      template % {
+        status: status,
+        headers: headers,
+        body: body,
+      }
+    end
+
+    private
+
+    def body
+      JSON.pretty_generate(@response.body) + "\n"
+    end
+
+    def headers
+      @response.headers.sort_by do |key, value|
+        key
+      end.map do |key, value|
+        "%{key}: %{value}" % {
+          key: key.split("-").map(&:camelize).join("-"),
+          value: value,
+        }
+      end.join("\n")
+    end
+
+    def status
+      "#{@response.status} #{@response.status_message}"
+    end
+
+    def template
+      str = ""
+      str << <<-EOS.strip_heredoc if @show_header
+        HTTP/1.1 %{status}
+        %{headers}
+      EOS
+      if @show_body
+        str << "\n" if @show_header
+        str << "%{body}"
+      end
+      str
+    end
+  end
+end

data/lib/docomoru/version.rb

@@ -1,3 +1,3 @@
 module Docomoru
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/lib/docomoru.rb

@@ -1,2 +1,3 @@
 require "docomoru/client"
+require "docomoru/command_builder"
 require "docomoru/version"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docomoru
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -52,6 +52,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  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: 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: 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
@@ -97,7 +139,8 @@ dependencies:
 description: 
 email:
 - r7kamura@gmail.com
-executables: []
+executables:
+- docomoru
 extensions: []
 extra_rdoc_files: []
 files:
@@ -107,11 +150,19 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/docomoru
 - docomoru.gemspec
+- images/cli.png
 - lib/docomoru.rb
+- lib/docomoru/arguments.rb
 - lib/docomoru/client.rb
+- lib/docomoru/command_builder.rb
+- lib/docomoru/commands/base.rb
+- lib/docomoru/commands/error.rb
+- lib/docomoru/commands/request.rb
 - lib/docomoru/dialogue_methods.rb
 - lib/docomoru/response.rb
+- lib/docomoru/response_renderer.rb
 - lib/docomoru/version.rb
 homepage: https://github.com/r7kamura/docomoru
 licenses: