idcfcloud 0.2.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09cbeede1098617cb40e566cd20f240d6b2d0404
-  data.tar.gz: d7a1709c7246eb5a56d83cb2b310830d40f4383a
+  metadata.gz: 6941bbdef01e10485802468bf365d7d105146ba1
+  data.tar.gz: a32b22a5411de149cf8fd792e5b79c0df512ec89
 SHA512:
-  metadata.gz: e9f9c7a579f7772f72b190fce4e712e1b63dcb2144952b5e42d69faa31a7572e97aad5009b7ff933b9dd14ddc49f04f429dab5ba509c5bfc47a110cda1fcc8c1
-  data.tar.gz: 8374e4292620361ca1e6e2eb798316dcaeb852cf810549062493ab2643049c4d03e995b9534aff6dbce7d4af7c5df63d264527b8aa3e6c0a3e613c2d640a102e
+  metadata.gz: 18b046b27be00e1770388bd6067b5d37748a5ed56862e27a5e68cc995fd944a1d15649a5a6206695708f5f61b360b439e1d9c82f210f71c21f892cd78d86e00e
+  data.tar.gz: b1af470e7aac83d807b319e7308851e513541207b9993f65a4cf1ec5bd2047c7640d7bbde2b68c86596ed1731c13afb3a15c5f7726cbda7977ad3b1c91356fa3

data/.codeclimate.yml

@@ -12,11 +12,23 @@ engines:
     enabled: true
   rubocop:
     enabled: true
+  structure:
+    exclude_paths:
+      - 'test/**/*'
 ratings:
   paths:
     - "**.rb"
+checks:
+  argument-count:
+    config:
+      threshold: 6
+  method-complexity:
+      config:
+        threshold: 9
+
 exclude_paths:
   - vendor/bundle
   - .idea
   - bin
   - doc
+  - output

data/.rubocop.yml

@@ -28,7 +28,7 @@ LineLength:
   Exclude:
     - 'test/**/*'
 Style/ClassLength:
-  Max: 150
+  Max: 160
   Exclude:
     - 'test/**/*'
 Style/ModuleLength:
@@ -38,4 +38,14 @@ Style/ModuleLength:
 ParameterLists:
   Max: 6
 Style/DoubleNegation:
-  Enabled: false
+  Enabled: false
+Style/SymbolArray:
+  Exclude:
+    - 'test/**/*'
+Style/IndentHeredoc:
+  EnforcedStyle: active_support
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - 'test/**/*'
+Lint/InterpolationCheck:
+  Enabled: false

data/README.md

@@ -55,8 +55,9 @@ cat [attributes file path] | echo -e "'"$(cat)"'" | xargs -L1 idcfcloud <service
 | secret-key |  | [Configuration file description] | Secret Key |
 | no-ssl |  |  | Not using SSL |
 | no-vssl |  |  | Not using Verify SSL |
-| json-path |  |  | Narrowing the data part of a return value using json-path<br/>https://github.com/joshbuddy/jsonpath |
-| fields |  |  | Limiting the return value to be displayed (applied only to the latest hash)<br/>Punctuation: comma (",") |
+| json-path | j |  | Narrowing the data part of a return value using json-path<br/>https://github.com/joshbuddy/jsonpath |
+| fields | f |  | Limiting the return value to be displayed (applied only to the latest hash)<br/>Punctuation: comma (",") |
+| version |  | [latest] | The API version to be used |
 
 
 #### How to Narrow Down (Examples)
@@ -75,8 +76,18 @@ idcfcloud your list_billing_history --json-path '$.data[?(@.month=="2017-10")]'
 
 [Your](#your)
 
-### Compute(Bata)<a name="compute"></a>
-\* If you encounter any problem, please contact us or file a pull request.
+### Common Features
+
+versions
+
+Get a supported API version. 
+
+```code
+$ idcfcloud your versions
+```
+
+
+### Compute<a name="compute"></a>
 
 http://docs.idcf.jp/cloud/api/
 

data/idcfcloud.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'idcf/cli/version'
@@ -31,15 +30,15 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activemodel', '~> 4.2', '>= 4.2.3'
   spec.add_dependency 'activesupport', '~> 4.2', '>= 4.2.3'
-  spec.add_dependency 'inifile', '~> 3.0', '>= 3.0.0'
-  spec.add_dependency 'thor', '~> 0.19.4'
   spec.add_dependency 'builder', '~> 3.1'
+  spec.add_dependency 'CFPropertyList', '~> 2.3.5'
+  spec.add_dependency 'facter', '~> 2.5.1'
+  spec.add_dependency 'idcf-faraday_middleware', '~> 0.0.2'
+  spec.add_dependency 'idcf-json_hyper_schema', '~> 0.2.0'
+  spec.add_dependency 'inifile', '~> 3.0', '>= 3.0.0'
+  spec.add_dependency 'jsonpath', '~> 0.8.10'
   spec.add_dependency 'kosi', '~> 1.0', '>= 1.0.0'
 
   spec.add_dependency 'open_uri_redirections', '~> 0.2.1'
-  spec.add_dependency 'idcf-json_hyper_schema', '~> 0.1.0'
-  spec.add_dependency 'idcf-faraday_middleware', '~> 0.0.2'
-  spec.add_dependency 'jsonpath', '~> 0.8.10'
-  spec.add_dependency 'facter', '~> 2.5.1'
-  spec.add_dependency 'CFPropertyList', '~> 2.3.5'
+  spec.add_dependency 'thor', '~> 0.19.4'
 end

data/lib/idcf/cli/command/morio.rb

@@ -11,7 +11,7 @@ module Idcf
     module Command
       # morio command
       class Morio
-        MORIO_TXT = <<-'EOS'.freeze
+        MORIO_TXT = <<-TEXT.freeze
                         -+sso+-
                ....    -ssssssso`
           `-/ossssss+/. `ssssssso`
@@ -25,7 +25,7 @@ module Idcf
    ./osssssssssssssssssssssss+.
       `-:+oosssssssssssso+:.
              ``````````
-        EOS
+        TEXT
         ATTRIBUTES_OFF = "\e[0m".freeze
         MORIO_COLOR    = "\e[38;5;45m".freeze
         TITLE_COLOR    = "\e[38;5;45m".freeze
@@ -81,7 +81,7 @@ module Idcf
               result << [k.to_s, data.body] if data.success?
             end
           end
-        rescue
+        rescue StandardError => _e
           []
         end
 
@@ -108,7 +108,7 @@ module Idcf
           if content && content.class == Array && content.size == 2
             title   = content[1].present? ? "#{content[0]} : " : content[0]
             txt     = content[1].present? ? content[1] : ''
-            add_str = format(" #{TITLE_COLOR}%s#{TEXT_COLOR}%s", title, txt)
+            add_str = format(" #{TITLE_COLOR}%<title>s#{TEXT_COLOR}%<txt>s", title: title, txt: txt)
           end
           "#{base_str}#{add_str}"
         end

data/lib/idcf/cli/conf/const.rb

@@ -1,4 +1,3 @@
-require 'date'
 require 'logger'
 require 'idcf/cli/version'
 module Idcf
@@ -6,32 +5,36 @@ module Idcf
     module Conf
       # const
       class Const
-        VERSION_STR        = "idcfcloud version #{Idcf::Cli::VERSION}".freeze
-        now                = DateTime.now.strftime('%Y%m%d%H%M%S%6N')
-        dir_path           = File.dirname(__FILE__)
-        BASE_PATH          = File.expand_path("#{dir_path}/../../../")
-        LOCAL_ERROR_PREFIX = '[idcfcli]'.freeze
-        HEADERS            =
+        DOCUMENT_URL              = 'https://www.idcf.jp/api-docs/'.freeze
+        DOCUMENT_ID_PREFIX        = 'reference'.freeze
+        DOCUMENT_ID_SEP           = '_'.freeze
+        DOCUMENT_SPACE_CONVERSION = '-'.freeze
+        VERSION_STR               = "idcfcloud version #{Idcf::Cli::VERSION}".freeze
+        now                       = Time.now.strftime('%Y%m%d%H%M%S%6N')
+        dir_path                  = File.dirname(__FILE__)
+        BASE_PATH                 = File.expand_path("#{dir_path}/../../../")
+        LOCAL_ERROR_PREFIX        = '[idcfcli]'.freeze
+        HEADERS                   =
           {
             'User-Agent': "IDCF CLI v#{Idcf::Cli::VERSION}"
           }.freeze
-        USER_DIR_PATH      = '~/.idcfcloud'.freeze
-        VALIDATOR_DIR_PATH = 'idcf/cli/validate/define'.freeze
-        CODE_CONF_PATH     = "#{BASE_PATH}/idcf/cli/conf/conf.yml".freeze
-        USER_CONF_PATH     = "#{USER_DIR_PATH}/config.ini".freeze
-        USER_CONF_GLOBAL   = "#{BASE_PATH}/../config/config.ini".freeze
-        REGIONS            = %w(jp-east jp-east-2 jp-west).freeze
-        GLOBAL_CONF_ITEMS  =
+        USER_DIR_PATH             = '~/.idcfcloud'.freeze
+        VALIDATOR_DIR_PATH        = 'idcf/cli/validate/define'.freeze
+        CODE_CONF_PATH            = "#{BASE_PATH}/idcf/cli/conf/conf.yml".freeze
+        USER_CONF_PATH            = "#{USER_DIR_PATH}/config.ini".freeze
+        USER_CONF_GLOBAL          = "#{BASE_PATH}/../config/config.ini".freeze
+        REGIONS                   = %w[jp-east jp-east-2 jp-west].freeze
+        GLOBAL_CONF_ITEMS         =
           {
             output_log: {
               default: 'Y',
-              list:    %w(Y n)
+              list:    %w[Y n]
             },
             log_path:   {
               default: '~/.idcfcloud/log'
             }
           }.freeze
-        USER_CONF_ITEMS    =
+        USER_CONF_ITEMS           =
           {
             api_key:    nil,
             secret_key: nil,
@@ -39,22 +42,22 @@ module Idcf
               list: REGIONS
             }
           }.freeze
-        FULL_HREF_REGEXP   = Regexp.new('\A[a-zA-Z]*:?//').freeze
-        CMD_FILE_DIR       = "#{BASE_PATH}/idcf/cli/conf/service".freeze
-        CMD_FILE_EXT       = 'json'.freeze
-        SERVICE_PATH       = 'idcf/cli/service'.freeze
-        TEMPLATE_DIR       = "#{BASE_PATH}/idcf/cli/templates".freeze
-        OUT_DIR            = "#{BASE_PATH}/../output".freeze
-        COMP_PATHS         = {
+        FULL_HREF_REGEXP          = Regexp.new('\A[a-zA-Z]*:?//').freeze
+        CMD_FILE_DIR              = "#{BASE_PATH}/idcf/cli/conf/service".freeze
+        CMD_FILE_EXT              = 'json'.freeze
+        SERVICE_PATH              = 'idcf/cli/service'.freeze
+        TEMPLATE_DIR              = "#{BASE_PATH}/idcf/cli/templates".freeze
+        OUT_DIR                   = "#{BASE_PATH}/../output".freeze
+        COMP_PATHS                = {
           bash: '~/.bash_profile',
           zsh:  '~/.zprofile'
         }.freeze
-        LOG_FILE_PREFIX    = 'cli_log_'.freeze
-        LOG_FILE_NAME      = "#{LOG_FILE_PREFIX}#{now}.log".freeze
-        LOG_LEVEL          = Logger::INFO.freeze
-        CLASSIFY_RULE      = [
-          %w(sslalgorithms_ids SslalgorithmsIds),
-          %w(dns Dns)
+        LOG_FILE_PREFIX           = 'cli_log_'.freeze
+        LOG_FILE_NAME             = "#{LOG_FILE_PREFIX}#{now}.log".freeze
+        LOG_LEVEL                 = Logger::INFO.freeze
+        CLASSIFY_RULE             = [
+          %w[sslalgorithms_ids SslalgorithmsIds],
+          %w[dns Dns]
         ].freeze
       end
     end

data/lib/idcf/cli/controller/base.rb

@@ -11,6 +11,7 @@ require_relative './extend/init'
 require_relative './include/init'
 require 'jsonpath'
 require 'idcf/cli/lib/include/recurring_calling'
+require 'idcf/cli/lib/document'
 
 module Idcf
   module Cli
@@ -35,9 +36,13 @@ module Idcf
         class_option :no_vssl,
                      desc: 'not use verify ssl'
         class_option :json_path,
-                     desc: 'data filter json_path'
+                     aliases: '-j',
+                     desc:    'data filter json_path'
         class_option :fields,
-                     desc: 'field filter'
+                     aliases: '-f',
+                     desc:    'field filter'
+        class_option :version,
+                     desc: 'api version'
 
         attr_reader :config, :code_conf, :cmd, :m_classes
 
@@ -49,7 +54,11 @@ module Idcf
           attr_accessor :links
 
           def init(argv)
-            o = Thor::Options.new(class_options).parse(argv)
+            o       = Thor::Options.new(class_options).parse(argv)
+            region  = get_region(o)
+            version = service_version(o)
+            Idcf::Cli::Lib::Document.init(region: region, version: version)
+
             register_schema_method(o)
 
             make_module_classes.each do |cn, c|
@@ -83,28 +92,38 @@ module Idcf
             name.underscore.split('/').last
           end
 
-          # service version
+          # service version list
           #
-          # @param o [Hash]
-          # @return String
-          def service_version(o)
-            sn     = service_name
-            list   = Idcf::Cli::Lib::Configure.get_code_conf(sn, o)
-            result = o[:version].nil? ? list.keys.last : o[:version]
-            msg    = "not found input version[#{o[:version]}]"
-            raise Idcf::Cli::Error::CliError, msg unless list.keys.include?(result)
-            result
+          # @return [Array]
+          def service_versions(region)
+            [].tap do |result|
+              sn = service_name
+              Idcf::Cli::Lib::Configure.get_code_conf(sn).each do |k, v|
+                v['region'].each_key do |reg|
+                  next unless region == reg
+                  result << k
+                  break
+                end
+              end
+            end
           end
         end
 
+        desc 'versions', 'versions'
+
+        def versions
+          list = self.class.service_versions(self.class.get_region(options))
+          puts make_result_str(make_result_data(list, options), options)
+        end
+
         protected
 
         def execute(cmd, *args)
           data = run(cmd, args, options)
-          puts make_result_str(data, false, options)
+          puts make_result_str(data, options)
           Idcf::Cli::Lib::Util::CliLogger.delete
           Idcf::Cli::Lib::Util::CliLogger.cleaning(options)
-        rescue => e
+        rescue StandardError => e
           self.class.error_exit(e)
         end
 
@@ -202,26 +221,34 @@ module Idcf
 
         def make_result_data(data, o)
           format     = output_format(o, '')
-          table_flag = %w(csv table).include?(format)
+          table_flag = %w[csv table].include?(format)
           helper     = Idcf::Cli::Lib::Convert::Helper.new
 
-          if helper.filter_target?(o)
-            result = helper.filter(data, o, table_flag)
-          elsif table_flag
-            result = make_table_data(data)
-          else
-            result        = make_base_response
-            result[:data] = data
+          return data_filter(data, o, table_flag) if helper.filter_target?(o)
+          if table_flag
+            return data.class == Hash ? make_table_data(data) : data
           end
+          result        = make_base_response
+          result[:data] = data
           result
         end
 
+        def data_filter(data, o, table_flag)
+          helper = Idcf::Cli::Lib::Convert::Helper.new
+          data   = make_field_data(data) if helper.only_filter_fields?(o)
+          [Hash, Array].include?(data.class) ? helper.filter(data, o, table_flag) : data
+        end
+
         # table data
         # @param data [Hash]
         # @return Hash
         def make_table_data(data)
           data
         end
+
+        def make_field_data(data)
+          data
+        end
       end
     end
   end

data/lib/idcf/cli/controller/cdn.rb

@@ -8,6 +8,9 @@ module Idcf
       class Cdn < Base
         default_command :help
 
+        class_option :version,
+                     desc: 'API Version'
+
         class << self
           def description
             'Contents Cache Service'

data/lib/idcf/cli/controller/compute.rb

@@ -16,7 +16,7 @@ module Idcf
 
         class << self
           def description
-            'Computeing Service(beta)'
+            'Computeing Service'
           end
         end
 
@@ -38,6 +38,20 @@ module Idcf
           faraday
         end
 
+        def make_table_data(data)
+          return data unless data.class == Hash
+          keys = data.keys
+          return data unless keys.count == 2 && keys.include?('count')
+          data.each do |k, v|
+            return v unless k == 'count'
+          end
+          data
+        end
+
+        def make_field_data(data)
+          make_table_data(data)
+        end
+
         # raise api error msg
         #
         # @param res [Faraday::Responce]

data/lib/idcf/cli/controller/extend/command.rb

@@ -1,18 +1,24 @@
 require 'idcf/cli/conf/const'
 require 'idcf/cli/lib/api'
+require 'idcf/cli/lib/document'
 module Idcf
   module Cli
     module Controller
       module Extend
         # command
         module Command
+          attr_reader :public_commands
+
           # register schema method by link
           #
           # @param link [Idcf::JsonHyperSchema::Expands::LinkInfoBase]
           def register_schema_method_by_link!(link)
-            param_str = Idcf::Cli::Lib::Api.command_param_str(link)
+            param_str   = Idcf::Cli::Lib::Api.command_param_str(link)
             method_desc = "#{link.title} #{param_str}"
-            desc method_desc.strip, link.description
+            description = link.description
+            desc method_desc.strip, description
+            description = "#{description}\n\n#{Idcf::Cli::Lib::Document.make_document_desc(link)}"
+            long_desc description
             define_method link.title.to_sym do |*args|
               execute(__method__, *args)
             end
@@ -43,6 +49,23 @@ module Idcf
               method_option opn, option
             end
           end
+
+          def desc(usage, description, options = {})
+            super(usage, description, options)
+            @public_commands ||= []
+            cmd = usage.split(' ').shift
+            @public_commands << cmd unless @public_commands.include?(cmd)
+          end
+
+          def subcommand_structure
+            result = super
+            list = @public_commands
+            list.concat(superclass.public_commands) if superclass.respond_to?(:public_commands)
+            list.each do |cmd|
+              result[cmd] = nil unless result.key?(cmd)
+            end
+            result
+          end
         end
       end
     end

data/lib/idcf/cli/controller/extend/search_module.rb

@@ -22,7 +22,6 @@ module Idcf
           def make_module_classes
             return @m_classes if @m_classes
             result = {}
-            add_classify_rule
 
             make_service_paths.each do |fn, path|
               require path
@@ -32,15 +31,6 @@ module Idcf
             @m_classes = result
           end
 
-          # add classify rule
-          def add_classify_rule
-            Idcf::Cli::Conf::Const::CLASSIFY_RULE.each do |rule|
-              ActiveSupport::Inflector.inflections do |inflect|
-                inflect.irregular(*rule)
-              end
-            end
-          end
-
           # make service paths
           #
           # @return Hash

data/lib/idcf/cli/controller/extend/util.rb

@@ -27,6 +27,18 @@ module Idcf
             v      = service_version(o)
             "#{dir}/#{fn}_#{v}_#{region}.#{ext}"
           end
+
+          # service version
+          #
+          # @param o [Hash]
+          # @return String
+          def service_version(o)
+            versions = service_versions(get_region(o))
+            result   = o[:version].nil? ? versions.last : o[:version]
+            msg      = "not found input version[#{o[:version]}]"
+            raise Idcf::Cli::Error::CliError, msg unless versions.include?(result)
+            result
+          end
         end
       end
     end

data/lib/idcf/cli/controller/include/client.rb

@@ -54,7 +54,7 @@ module Idcf
           def faraday_setting(faraday, o)
             prof = Idcf::Cli::Lib::Configure.get_profile(o)
             op   = {}
-            [:api_key, :secret_key].each do |v|
+            %i[api_key secret_key].each do |v|
               op[v] = o.key?(v) ? o[v] : Idcf::Cli::Lib::Configure.get_user_conf(v.to_s, prof)
             end
             faraday.request(faraday_request)

data/lib/idcf/cli/controller/include/command.rb

@@ -20,7 +20,7 @@ module Idcf
             args.each do |v|
               begin
                 result << JSON.parse(v, symbolize_names: false)
-              rescue
+              rescue StandardError => _e
                 result << v
               end
             end

data/lib/idcf/cli/controller/include/util.rb

@@ -12,10 +12,10 @@ module Idcf
           # @param err_f [Boolean]
           # @param o [Hash]
           # @return Stirng
-          def make_result_str(data, err_f, o)
+          def make_result_str(data, o)
             message = data.class == Hash ? data[:message] : {}
             f       = output_format(o, message)
-            Idcf::Cli::Lib::Convert::Helper.new.format(data, err_f, f)
+            Idcf::Cli::Lib::Convert::Helper.new.format(data, f)
           end
 
           # output format
@@ -25,9 +25,7 @@ module Idcf
           # @return String
           def output_format(o, message)
             default_output = Idcf::Cli::Lib::Configure.get_code_conf('output', o)
-            if message.class == Hash && !message[:output].nil?
-              return default_output
-            end
+            return default_output if message.class == Hash && !message[:output].nil?
 
             f = o[:output]
             f.nil? ? default_output : f

data/lib/idcf/cli/controller/include/validate.rb

@@ -60,7 +60,7 @@ module Idcf
                 next
               end
             end
-            cli_error 'Validate load error'
+            cli_error('Validate load error')
           end
 
           # make validation error

data/lib/idcf/cli/extend/configure.rb

@@ -25,9 +25,7 @@ module Idcf
 
         def make_profiles(config, o)
           [].tap do |result|
-            if o[:profile] != 'default' && !check_profile?(config, 'default')
-              result << 'default'
-            end
+            result << 'default' if o[:profile] != 'default' && !check_profile?(config, 'default')
             result << o[:profile]
           end
         end
@@ -35,7 +33,7 @@ module Idcf
         def check_profile?(config, name)
           conf = config[name]
           return false if conf.nil?
-          Idcf::Cli::Conf::Const::USER_CONF_ITEMS.each do |k, _v|
+          Idcf::Cli::Conf::Const::USER_CONF_ITEMS.each_key do |k|
             return false if conf[k.to_s].strip.empty?
           end
           true