console_utils 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfc695ee09f05cefe834a9aacb4bc1725f923e0a
-  data.tar.gz: 6cf231b7ba03c3d14d4b893836938969d6b84f32
+  metadata.gz: edf4a90c287e0a2b35baf4b4b30a5a5205279aba
+  data.tar.gz: 7ee2964fc56778c17508aaa7f1f754149cc65fd1
 SHA512:
-  metadata.gz: 7eea9de0af66cb899fc6f7bd64f196383054852750c14908140b520fd4b433aa95fe0a46d9bd6483759cdc447c28ac1c76b45cadf5defcd61a43174575446f2f
-  data.tar.gz: c24230444dcdd36451ef6cfd86d085a897bb389f4654e0a7232d4fecea44348a526badf748d93d6d872fb8c16aa526333157bfdcad2bc238909642a9653cd908
+  metadata.gz: 2915ca3739fdad30c77ef674c71ace430178c5de0b5be74e49aeadaac7068b847181ae90aed5fc51a6f6f72a6207c7e6222eda7b37ff4bb72e3b45a419df0b24
+  data.tar.gz: bd9daf266a95ac31b80aed492ba63d40b949067b884d186f690c1a48ec6610b345ace9199266276f60b06dbc6522e0e7e4e5ebf95fb9879954eaa79cd48441b3

data/README.md

@@ -57,7 +57,6 @@ end
 
 ### Options:
 
-* `auto_token` - Enable auto-fetch of user's auth token in requests (default: `true`)
 * `curl_bin` - Binary path to curl (using in remote requests). (default: `"curl"`)
 * `curl_silence` - Disable print out generated curl command with remote requests. (default: `false`)
 * `default_token` - A plain string of the default token used to authorize user (default: `nil`)
@@ -71,6 +70,9 @@ end
 * `user_model_name` - A name of user's model (default: `:User`)
 * `user_primary_key` - A primary key of user's model (default: `:id`)
 * `user_token_column` - A column name with a user's token. Using by request tools. (default: `:auth_token`)
+* `request_auto_auth` - Enable the auth automator with the `exap` (default: `true`)
+* `auth_automator` - Specifies a callable object, which will hook requests with credentials. There are two built-in implementations: the default one `ConsoleUtils::RequestUtils::DefaultAuthAutomator` and the `ConsoleUtils::RequestUtils::SimpleTokenAutomator`, which is useful when using the `simple_token_automator` gem.
+
 
 ## RequestUtils
 

data/lib/console_utils.rb

@@ -43,6 +43,11 @@ end
 module ConsoleUtils
   extend ActiveSupport::Autoload
 
+  JSON_FORMATTERS = [
+    :default,
+    :jq
+  ]
+
   MODULES = [
     :ActiveRecordUtils,
     :RequestUtils,
@@ -50,76 +55,82 @@ module ConsoleUtils
     :OtherUtils
   ]
 
-  JSON_FORMATTERS = %i(default jq)
-
   MODULES.each { |mod| autoload mod }
 
+
   # :section: Configuration
 
-  ##
   # :attr:
   # An array with disabled modules (default: <tt>[]</tt>)
   mattr_accessor(:disabled_modules) { [] }
-  ##
-  # :attr:
-  # Enable the auto-fetching of user's auth token in requests
-  # (default: <tt>true</tt>)
-  mattr_accessor(:auto_token) { true }
-  ##
+
   # :attr:
   # ID of the user which will be used by default in requests
   # (default: <tt>1</tt>)
   mattr_accessor(:default_uid) { 1 }
-  ##
+
+  # :attr:
+  # A plain string of the default token used to authorize user
+  # (default: <tt>nil</tt>)
+  mattr_accessor(:default_token)
+
   # :attr:
   # A name of user's model (default: <tt>:User</tt>)
   mattr_accessor(:user_model_name) { :User }
-  ##
+
   # :attr:
   # A primary key of user's model (default: <tt>:id</tt>)
   mattr_accessor(:user_primary_key) { :id }
-  ##
+
   # :attr:
   # A column name with a user's token. Using by request tools.
   # (default: <tt>:auth_token</tt>)
   mattr_accessor(:user_token_column) { :auth_token }
-  ##
+
   # :attr:
   # A name of the request parameter used to authorize user by a token
   # (default: <tt>:token</tt>)
   mattr_accessor(:token_param) { :token }
-  ##
-  # :attr:
-  # A plain string of the default token used to authorize user
-  # (default: <tt>nil</tt>)
-  mattr_accessor(:default_token)
-  ##
+
   # :attr:
   # JSON formatter used in API request helpers
   # (<tt>:default</tt> or <tt>:jq</tt>)
   mattr_accessor(:json_formatter) { :default }
-  ##
+
   # :attr:
   # Command for +jq+ json formatter (default: <tt>"jq . -C"</tt>)
   mattr_accessor(:jq_command) { "jq . -C" }
-  ##
+
   # :attr:
   # Binary path to +curl+ (using in remote requests). (default: <tt>"curl"</tt>)
   mattr_accessor(:curl_bin) { "curl" }
-  ##
+
   # :attr:
   # Don't print generated curl command with remote requests.
   # (default: <tt>false</tt>)
   mattr_accessor(:curl_silence) { false }
-  ##
+
   # :attr:
   # Remote endpoint used in remote API request helpers
   # (default: <tt>"http://example.com"</tt>)
   mattr_accessor(:remote_endpoint) { "http://example.com" }
-  ##
+
+  # :attr:
+  # Output logger (<tt>Logger.new(STDOUT)</tt> by default)
+  mattr_accessor(:logger) { Logger.new(STDOUT) }
+
   # :attr:
-  # Output logger (<tt>Rails.logger</tt> by default)
-  mattr_accessor :logger
+  # Enable the auth automator with the "exap"
+  # (default: <tt>true</tt>)
+  mattr_accessor(:request_auto_auth) { true }
+
+  # :attr:
+  # Specifies a callable object, which will hook requests with
+  # credentials. There are two built-in implementations: the default
+  # one <tt>ConsoleUtils::RequestUtils::DefaultAuthAutomator</tt> and
+  # the <tt>ConsoleUtils::RequestUtils::SimpleTokenAutomator</tt>,
+  # which is useful when using the +simple_token_automator+ gem.
+  mattr_accessor(:auth_automator) { ConsoleUtils::RequestUtils::DefaultAuthAutomator }
 
 
   # :section: Class Methods
@@ -183,11 +194,22 @@ module ConsoleUtils
     end
 
     # Setup enabled modules by extending given context
-    def setup_modules_to(context = nil, &block)
+    def setup_modules_to(context = nil)
       context, block = block, context if !block_given? && context.respond_to?(:call)
-      context ||= block.call
+      context ||= yield if block_given?
+
+      if context.nil?
+        warn "[ConsoleUtils] Trying to setup with empty context"
+        return
+      end
+
+      if ENV["CONSOLE_UTILS_DEBUG"] == "1"
+        logger.level = Logger::DEBUG
+        logger.debug { "Console instance: #{context.inspect} (#{ReplContext.instance.initialized_to})" }
+      else
+        logger.level = Logger::WARN
+      end
 
-      puts "Console instance: #{context.inspect}" if ENV["CONSOLE_UTILS_DEBUG"]
       each_enabled_module { |mod| context.send(:extend, mod) }
     end
   end

data/lib/console_utils/railtie.rb

@@ -7,9 +7,9 @@ module ConsoleUtils
     #:nodoc: all
     config.console_utils = ActiveSupport::OrderedOptions.new
 
-    initializer 'console_utils.logger' do
-      ActiveSupport.on_load(:console_utils) { self.logger = ::Rails.logger }
-    end
+    # initializer 'console_utils.logger' do
+    #   ActiveSupport.on_load(:console_utils) { self.logger = ::Rails.logger }
+    # end
 
     initializer "console_utils.set_configs" do |app|
       options = app.config.console_utils

data/lib/console_utils/repl_context.rb

@@ -11,25 +11,40 @@ module ConsoleUtils
     end
 
     def irb!
-      irb_rails! || ::IRB::ExtendCommandBundle
+      init_to(:irb) { irb_rails! || ::IRB::ExtendCommandBundle }
     end
 
     def irb_rails!
-      ::Rails.application.config.console::ExtendCommandBundle if rails?
+      init_to(:rails) { ::Rails.application.config.console::ExtendCommandBundle } if rails?
     end
 
     def pry!
-      ::TOPLEVEL_BINDING.eval('self') if pry?
+      init_to(:pry) { ::TOPLEVEL_BINDING.eval('self') } if pry?
     end
 
-    private
+    def initialized_to
+      @initialized_to ||= []
+    end
+
+    def initialized?
+      initialized_to.size > 0
+    end
 
     def rails?
-      defined?(::Rails::Application)
+      defined? ::Rails::Application
     end
 
     def pry?
-      defined?(::Pry)
+      defined? ::Pry
+    end
+
+    private
+
+    def init_to(context)
+      unless initialized_to.include?(context)
+        initialized_to << context
+        yield if block_given?
+      end
     end
   end
 end

data/lib/console_utils/request_utils.rb

@@ -18,6 +18,9 @@ module ConsoleUtils #:nodoc:
       autoload :Jq
     end
 
+    autoload :DefaultAuthAutomator, "console_utils/request_utils/auth_automators"
+    autoload :SimpleTokenAutomator, "console_utils/request_utils/auth_automators"
+
     # :call-seq:
     #   autoken(id)
     #   autoken(:any)

data/lib/console_utils/request_utils/auth_automators.rb

@@ -0,0 +1,18 @@
+module ConsoleUtils::RequestUtils
+  class DefaultAuthAutomator
+    def self.call(rq)
+      rq.params[ConsoleUtils.token_param] ||=
+        ConsoleUtils.default_token.presence or ConsoleUtils.auto_token_for(rq.uid)
+    end
+  end
+
+  class SimpleTokenAutomator
+    def self.call(rq)
+      model_key = ConsoleUtils.user_model.model_name.param_key
+      header_names = ::SimpleTokenAuthentication.header_names[model_key.to_sym]
+      fields = header_names.keys
+      user = ConsoleUtils.find_user(rq.uid, scope: ConsoleUtils.user_model.select(:id, *fields))
+      header_names.each { |field, name| rq.headers[name] ||= user.public_send(field) }
+    end
+  end
+end

data/lib/console_utils/request_utils/json_output.rb

@@ -31,7 +31,7 @@ module ConsoleUtils::RequestUtils
     # The default formatter uses standart JSON library to output prettified JSON
     class Default < Formatter
       def format(body) #:nodoc:
-        jj JSON(body)
+        JSON.pretty_generate JSON(body), :allow_nan => true, :max_nesting => false
       rescue JSON::GeneratorError => e
         warn "Warning: Failed to format a json.", e.message, body
         body.to_s

data/lib/console_utils/request_utils/request_params.rb

@@ -1,55 +1,50 @@
 module ConsoleUtils::RequestUtils
   class RequestParams
-    def initialize(uid_or_params = true, params = nil, headers_or_env = nil)
-      if ConsoleUtils.auto_token
-        @uid = case uid_or_params
-               when Numeric, true, false, nil then uid_or_params
-               when headers_or_env.nil?       then need_shift!
-               end
-      else
-        need_shift!
+    attr_accessor :uid
+
+    def initialize(uid_or_params = true, params = nil, headers = nil)
+      if uid_or_params.is_a? Hash
+        headers, params, uid_or_params = [params, uid_or_params, nil]
       end
 
-      params, headers_or_env = [uid_or_params, params] if need_shift?
+      @params = params
+      @headers = headers
+      @uid = auto_auth? && ((uid_or_params.nil? || uid_or_params == true) ? ConsoleUtils.default_uid : uid_or_params)
 
-      @params = params.is_a?(Hash) ? params : {}
-      @headers = headers_or_env.to_h
+      ConsoleUtils.logger.debug { "#{uid}, #{params()}, #{headers()}" }
 
-      if need_default_token?
-        use_token ConsoleUtils.default_token
-      else
-        @uid = ConsoleUtils.default_uid if need_default_uid?
-        use_token ConsoleUtils.auto_token_for(@uid) if @uid.present?
-      end
+      auth_automator.(self) if can_auto_auth?
     end
 
-    def to_a
-      [@params.presence, @headers.presence].tap(&:compact!)
+    def params
+      @params ||= {}
     end
 
-    def use_token value
-      @params[ConsoleUtils.token_param] ||= value
+    def headers
+      @headers ||= {}
+    end
+
+    def to_a
+      [params, headers.presence].tap(&:compact!)
     end
 
     def with_default(default_params = nil)
-      @params.merge!(default_params.to_h)
+      params.merge!(default_params.to_h)
       to_a
     end
 
-    def need_default_uid?
-      @uid == true && ConsoleUtils.default_token.nil?
+    def can_auto_auth?
+      auto_auth? && uid && auth_automator.respond_to?(:call)
     end
 
-    def need_default_token?
-      @uid == true && ConsoleUtils.default_token.present?
-    end
+    private
 
-    def need_shift!
-      @need_shift = true
+    def auto_auth?
+      ConsoleUtils.request_auto_auth
     end
 
-    def need_shift?
-      !!@need_shift
+    def auth_automator
+      ConsoleUtils.auth_automator
     end
   end
 end

data/lib/console_utils/request_utils/requester.rb

@@ -16,13 +16,10 @@ module ConsoleUtils::RequestUtils #:nodoc:
 
     def preview(mth = nil)
       if output = to_s.presence
-        JSONOutput.formatter.(output) do |formatted|
-          @formatted = formatted
-          puts @formatted
-          show_complete_in!
-          show_transfered!
-          yield(self) if block_given?
-        end
+        JSONOutput.formatter.(output)
+        show_complete_in!
+        show_transfered!
+        yield(self) if block_given?
       else
         puts NO_RESPONSE
       end
@@ -30,7 +27,7 @@ module ConsoleUtils::RequestUtils #:nodoc:
 
     # Copies to pasteboard
     def pbcopy(content = nil)
-      content ||= @formatted
+      content ||= JSONOutput::Default.instance.format(to_s)
       IO.popen('pbcopy', 'w') { |io| io << content.to_s }
       puts PBCOPY_MESSAGE
     end
@@ -64,9 +61,9 @@ module ConsoleUtils::RequestUtils #:nodoc:
     protected
 
     def normalize_args
-      RequestParams.new(*@_args) { |uid| autoken(uid) }.
-        with_default(default_params).
-        to_a
+      RequestParams.new(*@_args).with_default(default_params).tap do |args|
+        ConsoleUtils.logger.debug { args }
+      end
     end
 
     private

data/lib/console_utils/version.rb

@@ -1,3 +1,3 @@
 module ConsoleUtils
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: console_utils
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Anton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-05 00:00:00.000000000 Z
+date: 2015-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -145,6 +145,7 @@ files:
 - lib/console_utils/railtie.rb
 - lib/console_utils/repl_context.rb
 - lib/console_utils/request_utils.rb
+- lib/console_utils/request_utils/auth_automators.rb
 - lib/console_utils/request_utils/exap.rb
 - lib/console_utils/request_utils/json_output.rb
 - lib/console_utils/request_utils/remo.rb