RubyGems - oauth-cli - Versions diffs - 0.0.1 → 0.0.2 - Mend

oauth-cli 0.0.1 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

data/CHANGELOG CHANGED Viewed

@@ -1,3 +1,21 @@
+// 0.0.3
+// ---------------------------
+// on exit, ask if connection data should be saved to profile
+// show list of example profiles
+0.0.2
+---------------------------
+got rid of repl dependency
+added default profile, use $OAUTHC_CONFIG_FILE to customize default config file path
+show profile name in prompt
+updated help for CLI and interactive mode
+ask for URI if not given
+show error if wrong http method verb
+inline authorization process, triggered by 'auth' command
+added option to set default content_type/mime_type
+nice json syntax highlight with awesome_print
+set default content & mime type
 0.0.1
 ---------------------------

data/Manifest CHANGED Viewed

@@ -1,7 +1,7 @@
-CHANGELOG
-Manifest
-README.rdoc
-Rakefile
 bin/oauthc
+CHANGELOG
 init.rb
 lib/oauth_cli.rb
+Manifest
+Rakefile
+README.rdoc

data/README.rdoc CHANGED Viewed

@@ -7,12 +7,36 @@ oauth-cli is packed as gem, install with:
 == Usage
-[repl] oauthc [options] <method> <uri> [<body>]
+oauthc [options] [http_method_verb uri [body]]
-options may be:
-* profile: --profile=<profile> -> put a .yml file to ~/.oauthconfig
-* connection data: --host=<host> --consumer_key=<consumer_key> --consumer_secret=<consumer_secret> --token=<token> --token_secret=<token_secret>
-* if method it *post* or *put* and no body is provided, you're asked for input
+Options:
+  --help             Display this message
+  --profile          Name of preset profile to load, put profiles to a .yml file in ~/.oauthconfig
+  --host             Host to connect to
+  --consumer_key     Consumer Key
+  --consumer_secret  Consumer Secret
+  --token            Authentication Token
+  --token_secret     Authentication Secret
+  --mime_type        Set mime type, default: application/xml
+  --content_type     Set content type, default: application/xml
+Request params (leave blank for interactive mode)
+   http_method_verb  nay method of get, post, put or delete
+   uri               Uri to request
+   body              Body attached to request
+=== Interactive Mode
+if no request params are specified, interactive mode is started. Those commands are available:
+Interactive Commands:
+    get    uri         Get request for given uri
+    post   uri [body]  Post request for given uri, asks for body if not provided
+    put    uri [body]  Put request for given uri, asks for body if not provided
+    delete uri         Delete request for given uri
+    auth               Request authentication token
+    help               Display this message
 == Examples
@@ -28,13 +52,19 @@ oauthc was originally developed to test the {Qype API}[http://www.qype.com/devel
 == Hints
-* use with repl gem for nice handling, see http://github.com/defunkt/repl
+* use with repl gem for nice handling, see: http://github.com/defunkt/repl
 * make sure to have rlwrap installed, too: http://utopia.knoware.nl/~hlub/rlwrap1
+* Bug reports, suggestions, updates: http://github.com/rngtng/oauth-cli/issues
 == Todos
-* save given keys to config
+* save given keys to config, e-g introduce 'save' command
+* go into config mode, if no profiles found and no params specified
+* better support for getting authkeys
+* testing + better docs
+* check oauth client, streamline!?
+* add autocomplete
+* add auth profiles for Qype, Twitter etc!?
 == FAQ

data/Rakefile CHANGED Viewed

@@ -2,12 +2,12 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
-Echoe.new('oauth-cli', '0.0.1') do |p|
+Echoe.new('oauth-cli', '0.0.2') do |p|
   p.description    = "A simple CLI client to test your oauth API easily"
   p.url            = "http://github.com/rngtng/oauth-cli"
   p.author         = "rngtng - Tobias Bielohlawek"
   p.email          = "tobi @nospam@ rngtng.com"
   p.ignore_pattern = ["tmp/*", "script/*"]
   p.development_dependencies = []
-  p.runtime_dependencies = ["highline >=1.5.1", "json >=1.1.9", "oauth >=0.3.6", "repl >=0.2.1"]
+  p.runtime_dependencies = ["highline >=1.5.1", "json >=1.1.9", "oauth >=0.3.6"]
 end

data/bin/oauthc CHANGED Viewed

@@ -1,6 +1,138 @@
 #!/usr/bin/env ruby
 require 'rubygems'
-require 'oauth_cli'
+require 'pp'
+require 'lib/oauth_cli'
+CFG_FILE = ENV['OAUTHC_CONFIG_FILE'] || File.expand_path('~/.oauthconfig')
+def show_help
+  say <<-help
+oauthc version 0.0.2
+Usage: oauthc [options] [http_method_verb uri [body]]
+Options:
+  --help             Display this message
+  --profile          Name of preset profile to load, put profiles to a .yml file in ~/.oauthconfig
+  --host             Host to connect to
+  --consumer_key     Consumer Key
+  --consumer_secret  Consumer Secret
+  --token            Authentication Token
+  --token_secret     Authentication Secret
+  --mime_type        Set mime type, default: application/xml
+  --content_type     Set content type, default: application/xml
+Request params (leave blank for interactive mode)
+   http_method_verb  any method of get, post, put or delete
+   uri               Uri to request
+   body              Body attached to request
+Bug reports, suggestions, updates:
+http://github.com/rngtng/oauth-cli/issues
+help
+  exit
+end
+def show_commands
+  say <<-help
+Interactive Commands:
+    get    uri         Get request for given uri
+    post   uri [body]  Post request for given uri, asks for body if not provided
+    put    uri [body]  Put request for given uri, asks for body if not provided
+    delete uri         Delete request for given uri
+    auth               Request authentication token
+    help               Display this message
+help
+end
+if ARGV.empty? || ARGV.any? { |arg| %w( -h --help -help help ).include?(arg) }
+  show_help
+end
+#parse CLI input
+opt = {}
+method, uri, body = ARGV.clone.delete_if do |kv|
+  next opt[$1.to_sym] = $2 if kv =~ /-?-([^=]+)=(.+)$/
+  false
+end
+profile = opt[:profile] || opt[:p] #shortcut for profile
+#load external config if profile given
+if profile
+  unless File.exists?(CFG_FILE)
+    say " <%= color('#  ERROR: Profile File #{CFG_FILE} not found', RED) %>"
+    show_help
+  end
+  cfg_options = YAML.load_file(CFG_FILE)
+  profile = 'default' if !cfg_options[profile] && cfg_options['default']
+  unless cfg_options[profile]
+    say " <%= color('#  ERROR: Profile #{profile} not found', RED) %>"
+    show_help
+  end
+  cfg_options[profile].each { |key, value| opt[key.to_sym] = value }  #symbolize_keys
+end
+######## CREATE client
+@client = OauthCli.new(opt)
+if method && uri
+  @client.request(method, uri, body)
+  exit
+end
+######## START Interactive mode
+## following lines are shameless stolen from repl ->  http://http://github.com/defunkt/repl
+# completion_dir = ENV['REPL_COMPLETION_DIR'] || "~/.repl"
+# if File.exists?(cdir = File.expand_path(completion_dir))
+#   script = ARGV.detect { |a| a !~ /^-/ }
+#   if script
+#     cfile = Dir[cdir + '/' + File.basename(script)].first
+#     cfile = nil if cfile && !File.exists?(cfile)
+#   end
+# end
+history_dir = ENV['OAUTHC_HISTORY_DIR'] || "~/"
+if File.exists?(hdir = File.expand_path(history_dir))
+  if script = ARGV.detect { |a| a !~ /^-/ }
+    script = File.basename(script)
+    hfile = "#{hdir}/.#{oauthc}_history" #TODO include profile name???
+  end
+end
+if !ENV['__REPL_WRAPPED'] && system("which rlwrap > /dev/null 2> /dev/null")
+  ENV['__REPL_WRAPPED'] = '0'
+  rlargs = ""
+  #rlargs << " -f #{cfile}" if cfile
+  rlargs << " -H #{hfile}" if hfile
+  exec "rlwrap #{rlargs} #$0 #{ARGV.join(' ')}"
+end
+loop do
+  print ENV['REPL_PROMPT'] || "#{opt[:name] || profile} >> "
+  begin
+    command, uri, body = $stdin.gets.chomp.split(' ')
+    next warn(show_commands) if command =~ /^(help|\?)$/
+    next warn("Use Ctrl-D (i.e. EOF) to exit") if command =~ /^(exit|quit)$/
+    @client.request(command, uri, body)
+    next
+  rescue NoMethodError, Interrupt
+    #save_config unless profile
+    puts
+    exit
+  rescue
+  end
+end
-OauthCli.main($*)

data/lib/oauth_cli.rb CHANGED Viewed

@@ -2,89 +2,83 @@ require 'highline/import'
 require 'oauth'
 require 'json'
-CFG_FILE = File.expand_path('~/.oauthconfig')
+begin
+require 'ap'
+rescue LoadError
+end
 HighLine.track_eof = false #hotfix to make highline work
 class OauthCli
-  def self.main(params, opt = {})
-    #parse CLI input
-    method, uri, body = params.delete_if do |kv|
-      next opt[$1.to_sym] = $2 if kv =~ /-?-([^=]+)=(.+)$/
-      false
-    end
-    body = ask ">> request body:" if body.to_s.empty? && (method == "post" || method == "put")
-    opt[:profile] ||= opt[:p] #shortcut for profile
-    #load external config if profile given
-    if opt[:profile] && File.exists?(CFG_FILE)
-      cfg_options =  YAML.load_file(CFG_FILE)
-      opt = symbolize_keys(cfg_options[opt[:profile]]) if cfg_options[opt[:profile]]
-    end
-    if opt[:h] || opt[:help] || method.to_s.empty? || uri.to_s.empty?
-      say " <%= color('#  ERROR: please provide method and uri', RED) %>" if method.to_s.empty? || uri.to_s.empty?
-      say "Usage:"
-      say "[repl] oauthc [options] <method> <uri> [<body>]"
-      say "options are:"
-      say "profile: --profile=<profile> -> put a .yml file to ~/.oauthconfig"
-      say "--host=<host> --consumer_key=<consumer_key> --consumer_secret=<consumer_secret> --token=<token> --token_secret=<token_secret>"
-      return
-    end
-    response = execute(method, uri, body, opt)
-    header = response.header
-    color = (response.code.to_i < 400) ? 'GREEN' : 'RED'
-    say " <%= color('# -------------------------------------------------------------------------', #{color}) %>"
-    say " <%= color('# Status: #{header.code} #{header.message}  - calling #{opt[:host]}#{uri}', BOLD, #{color}) %>"
-    say " <%= color('# -------------------------------------------------------------------------', #{color}) %>"
-    body = response.body
-    body = " <%= color('# #{$1.gsub("'", "")} ', RED) %>" if body =~ /<pre>(.+)<\/pre>/
-    body = JSON.pretty_generate(JSON.parse(body)) if uri =~ /.json/  rescue ''
-    say body
-  end
-  def self.execute(method, uri, body, options)
+  def initialize( options = {})
+    @options      = options
     if options[:consumer_key].to_s.empty?
-      color = 'YELLOW'
+      color = 'YELLOW'
       say " <%= color('# -------------------------------------------------------------------------', #{color}) %>"
-      say " <%= color('# no consumer_key provided, call the script with:', #{color}) %>"
+      say " <%= color('# no consumer_key provided, please create a profile or call the script with:', #{color}) %>"
       say " <%= color('# oauthc --consumer_key=<consumer_key> --consumer_secret=<consumer_secret>', #{color}) %>"
       say " <%= color('# -------------------------------------------------------------------------', #{color}) %>"
       #please get a key here: http://#{options[:host]}/api_consumers"
       exit
     end
-    @consumer = OAuth::Consumer.new(options[:consumer_key], options[:consumer_secret], :site => "http://#{options[:host]}")
-    if options[:token]
-      @access_token = OAuth::AccessToken.new(@consumer, options[:token], options[:token_secret])
-    elsif !options[:read_only]
-      #say "To authorize, go to:\n  <%= color('http://#{options[:host].gsub('api.', 'www.')}/mobile/authorize?oauth_token=#{@request_token.token}', BOLD, UNDERLINE) %>\n\n"
+    @consumer     = OAuth::Consumer.new(options[:consumer_key], options[:consumer_secret], :site => "http://#{options[:host]}")
+    @access_token = OAuth::AccessToken.new(@consumer, options[:token], options[:token_secret]) if options[:token]
+  end
+  def request(method, uri, body = nil)
+    if method =~ /auth/
       @request_token = @consumer.get_request_token({}, "oauth_callback" => "oob")
-      color = 'YELLOW'
+      color = 'YELLOW'
       say " <%= color('# -------------------------------------------------------------------------', #{color}) %>"
-      say " <%= color('# no access token found please provide verifier to for tokens:', #{color}) %>"
-      verifier = ask ">>"
+      #say "To authorize, go to:\n  <%= color('http://#{options[:host].gsub('api.', 'www.')}/mobile/authorize?oauth_token=#{@request_token.token}', BOLD, UNDERLINE) %>\n\n"
+      verifier = ask " Token Verifier >>"
+      @access_token = @request_token.get_access_token({}, "oauth_verifier" => verifier)
-      @access_token = @request_token.get_access_token({}, "oauth_verifier" => verifier)
-      say " <%= color('# all done, recall the script with:', #{color}) %>"
-      say " <%= color('# oauthc --consumer_key=#{options[:consumer_key]} --consumer_secret=#{options[:consumer_secret]} --token=#{@consumer.token} --token_secret=#{@consumer.secret}', #{color}) %>"
-      say " <%= color('# -------------------------------------------------------------------------', #{color}) %>"
-      exit
+      options[:token] = @access_token.token
+      options[:token_secret] = @access_token.secret
+      say " <%= color('# -------------------------------------------------------------------------', #{color}) %>"
+    end
+    unless %w(get post put delete).include? method.to_s
+      color = 'RED'
+      say " <%= color('# -------------------------------------------------------------------------', #{color}) %>"
+      say " <%= color('# Wrong HTTP Method: #{method}  - calling #{@options[:host]}#{uri}', BOLD, #{color}) %>"
+      say " <%= color('# -------------------------------------------------------------------------', #{color}) %>"
+      return
+    end
+    uri  = ask " |-- request uri >> " if !uri
+    body = ask " |-- request body >> " if !body && (method == "post" || method == "put")
+    url = "http://#{@options[:host]}#{uri}"
+    @options[:mime_type]    ||= (url =~ /\.json/) ? "application/json" : "application/xml"
+    @options[:content_type] ||= (url =~ /\.json/) ? "application/json" : "application/xml"
+    response = @consumer.request(method, url, @access_token, {}, body, { 'Accept' => @options[:mime_type], 'Content-Type' => @options[:content_type] })
+    header = response.header
+    color = (response.code.to_i < 400) ? 'GREEN' : 'RED'
+    say " <%= color('# -------------------------------------------------------------------------', #{color}) %>"
+    say " <%= color('# Status: #{header.code} #{header.message}  - calling #{@options[:host]}#{uri}', BOLD, #{color}) %>"
+    say " <%= color('# -------------------------------------------------------------------------', #{color}) %>"
+    body = response.body
+    if header.content_type =~ /.json/
+      body = JSON.parse(body)
+      ap(body) rescue say(JSON.pretty_generate(body))
+      return
     end
-    url = "http://#{options[:host]}#{uri}"
-    mime_type = (url =~ /\.json/) ? "application/json" : "application/xml"
-    @consumer.request(method, url, @access_token, {}, body, { 'Accept' => mime_type, 'Content-Type' => mime_type })
-  end
-  def self.symbolize_keys(hash)
-    new_hash = {}
-    hash.each { |key, value| new_hash[key.to_sym] = value }
-    new_hash
+    body = " <%= color('# #{$1.gsub("'", "")} ', RED) %>" if body =~ /<pre>(.+)<\/pre>/
+    say body
   end
 end

data/oauth-cli.gemspec CHANGED Viewed

@@ -2,24 +2,24 @@
 Gem::Specification.new do |s|
   s.name = %q{oauth-cli}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["rngtng - Tobias Bielohlawek"]
-  s.cert_chain = ["/Users/tobiasb/.ssh/gem-public_cert.pem"]
-  s.date = %q{2010-04-09}
+  s.cert_chain = ["/Users/ted/.ssh/gem-public_cert.pem"]
+  s.date = %q{2010-04-14}
   s.default_executable = %q{oauthc}
   s.description = %q{A simple CLI client to test your oauth API easily}
   s.email = %q{tobi @nospam@ rngtng.com}
   s.executables = ["oauthc"]
-  s.extra_rdoc_files = ["CHANGELOG", "README.rdoc", "bin/oauthc", "lib/oauth_cli.rb"]
-  s.files = ["CHANGELOG", "Manifest", "README.rdoc", "Rakefile", "bin/oauthc", "init.rb", "lib/oauth_cli.rb", "oauth-cli.gemspec"]
+  s.extra_rdoc_files = ["bin/oauthc", "CHANGELOG", "lib/oauth_cli.rb", "README.rdoc"]
+  s.files = ["bin/oauthc", "CHANGELOG", "init.rb", "lib/oauth_cli.rb", "Manifest", "Rakefile", "README.rdoc", "oauth-cli.gemspec"]
   s.homepage = %q{http://github.com/rngtng/oauth-cli}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Oauth-cli", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{oauth-cli}
   s.rubygems_version = %q{1.3.6}
-  s.signing_key = %q{/Users/tobiasb/.ssh/gem-private_key.pem}
+  s.signing_key = %q{/Users/ted/.ssh/gem-private_key.pem}
   s.summary = %q{A simple CLI client to test your oauth API easily}
   if s.respond_to? :specification_version then
@@ -30,17 +30,14 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<highline>, [">= 1.5.1"])
       s.add_runtime_dependency(%q<json>, [">= 1.1.9"])
       s.add_runtime_dependency(%q<oauth>, [">= 0.3.6"])
-      s.add_runtime_dependency(%q<repl>, [">= 0.2.1"])
     else
       s.add_dependency(%q<highline>, [">= 1.5.1"])
       s.add_dependency(%q<json>, [">= 1.1.9"])
       s.add_dependency(%q<oauth>, [">= 0.3.6"])
-      s.add_dependency(%q<repl>, [">= 0.2.1"])
     end
   else
     s.add_dependency(%q<highline>, [">= 1.5.1"])
     s.add_dependency(%q<json>, [">= 1.1.9"])
     s.add_dependency(%q<oauth>, [">= 0.3.6"])
-    s.add_dependency(%q<repl>, [">= 0.2.1"])
   end
 end

data.tar.gz.sig CHANGED Viewed

Binary file

metadata CHANGED Viewed

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments:
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors:
 - rngtng - Tobias Bielohlawek
@@ -34,7 +34,7 @@ cert_chain:
   I5mOkC+DmQeKRCyukHoWnysL5IyK+l7JEPymkOlNWkl006u5rNu/d7LJJW19+ZvC
   -----END CERTIFICATE-----
-date: 2010-04-09 00:00:00 +02:00
+date: 2010-04-14 00:00:00 +02:00
 default_executable: oauthc
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -79,20 +79,6 @@ dependencies:
         version: 0.3.6
   type: :runtime
   version_requirements: *id003
-- !ruby/object:Gem::Dependency
-  name: repl
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        segments:
-        - 0
-        - 2
-        - 1
-        version: 0.2.1
-  type: :runtime
-  version_requirements: *id004
 description: A simple CLI client to test your oauth API easily
 email: tobi @nospam@ rngtng.com
 executables:
@@ -100,18 +86,18 @@ executables:
 extensions: []
 extra_rdoc_files:
-- CHANGELOG
-- README.rdoc
 - bin/oauthc
-- lib/oauth_cli.rb
-files:
 - CHANGELOG
-- Manifest
+- lib/oauth_cli.rb
 - README.rdoc
-- Rakefile
+files:
 - bin/oauthc
+- CHANGELOG
 - init.rb
 - lib/oauth_cli.rb
+- Manifest
+- Rakefile
+- README.rdoc
 - oauth-cli.gemspec
 has_rdoc: true
 homepage: http://github.com/rngtng/oauth-cli

metadata.gz.sig CHANGED Viewed

Binary file