oauth-cli 0.0.3 → 0.0.4

data/CHANGELOG

@@ -1,12 +1,19 @@
-// planned: 0.0.4
+// planned: 0.0.X
 // ---------------------------
 // on exit, ask if connection data should be saved to profile
 // show list of example profiles
 
+0.0.4
+---------------------------
+introduced easy auth (by now for Qype API only)
+added tests
+"http://" for any host options got optional
+
 0.0.3
 ---------------------------
 minor fix to resolve dependencies 
 
+
 0.0.2
 ---------------------------
 got rid of repl dependency

data/Manifest

@@ -3,6 +3,8 @@ Manifest
 README.rdoc
 Rakefile
 bin/oauthc
-init.rb
 lib/oauth_cli.rb
 oauth-cli.gemspec
+test/helper.rb
+test/test_oauth_cli.rb
+test/test_oauthc.rb

data/README.rdoc

@@ -30,13 +30,13 @@ Request params (leave blank for 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
+    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
+    auth                 Request authentication token
+    help                 Display this message
 
 
 == Examples
@@ -52,18 +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
-* make sure to have rlwrap installed, too: http://utopia.knoware.nl/~hlub/rlwrap1
+* make sure to have rlwrap installed, to get CLI history support: http://utopia.knoware.nl/~hlub/rlwrap (or "port install rlwarp")
+
+
 * Bug reports, suggestions, updates: http://github.com/rngtng/oauth-cli/issues
 
 
 == Todos
-* save given keys to config, e-g introduce 'save' command
+* 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 autocomplete for interactive commands
 * add auth profiles for Qype, Twitter etc!?
 
 == FAQ

data/Rakefile

@@ -2,12 +2,12 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('oauth-cli', '0.0.3') do |p|
+Echoe.new('oauth-cli', '0.0.4') 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.development_dependencies = ["mocha >=0"]
   p.runtime_dependencies = ["highline >=1.5.1", "json >=1.1.9", "oauth >=0.3.6"]
 end

data/bin/oauthc

@@ -2,13 +2,19 @@
 
 require 'rubygems'
 require 'pp'
-require 'oauth_cli'
+begin
+  require "#{File.dirname(File.dirname(File.expand_path(__FILE__)))}/lib/oauth_cli"
+rescue LoadError
+  require "oauth_cli"
+end
 
 CFG_FILE = ENV['OAUTHC_CONFIG_FILE'] || File.expand_path('~/.oauthconfig')
 
+#http://api.betterbecool.com/v1/places/1197081
+
 def show_help
   say <<-help
-oauthc version 0.0.3
+oauthc version 0.0.4
 Usage: oauthc [options] [http_method_verb uri [body]]
 
 Options:
@@ -101,7 +107,7 @@ 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???
+    hfile = "#{hdir}/.oauthc_history" #TODO include profile name???
   end
 end
 
@@ -131,7 +137,7 @@ loop do
     #save_config unless profile
     puts
     exit
-  rescue
+  #rescue
   end
 
 end

data/lib/oauth_cli.rb

@@ -3,16 +3,18 @@ require 'oauth'
 require 'json'
 
 begin
-require 'ap' 
-rescue LoadError 
+  require 'ap' #try to load awesome_print for nice json output
+rescue LoadError
 end
 
 HighLine.track_eof = false #hotfix to make highline work
 
 class OauthCli
 
-  def initialize( options = {})
-    @options      = options
+  attr_reader :options
+  
+  def initialize(options = {})
+    @options = options
 
     if options[:consumer_key].to_s.empty?
       color = 'YELLOW'
@@ -20,28 +22,46 @@ class OauthCli
       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
+      #please get a key here: #{options[:host]}/api_consumers"
+      return
     end
-
-    @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]
+    
+    #add http if missing
+    [:host, :reg_host, :auth_host].each do |key|
+      @options[key] = "http://#{@options[key]}" unless @options[key] =~ /^http/
+    end
+    
+    @consumer     = OAuth::Consumer.new(@options[:consumer_key], @options[:consumer_secret], :site => @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")
+      @options[:auth_host] ||= "#{@options[:host].gsub('api.', 'www.').gsub('v1/', '')}/mobile/authorize?oauth_token=" #That's for Qype only!!
       color = 'YELLOW'
-      say " <%= color('# -------------------------------------------------------------------------', #{color}) %>"
-      #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)
-      
-      options[:token] = @access_token.token
-      options[:token_secret] = @access_token.secret
-      
-      say " <%= color('# -------------------------------------------------------------------------', #{color}) %>"
+      say " <%= color('# To authorize, go to ...', #{color}) %>"
+      say " <%= '#   ' + color('#{@options[:auth_host]}#{@request_token.token}', BOLD, UNDERLINE) %>\n"
+      say " <%= color('#  ... and enter given token verifier:', #{color}) %>"
+      verifier = ask " |-- verifier >> "
+
+      begin
+        @access_token = @request_token.get_access_token({}, "oauth_verifier" => verifier)
+
+        @options[:token] = @access_token.token
+        @options[:token_secret] = @access_token.secret
+
+        color = 'GREEN'
+        say " <%= color('# -------------------------------------------------------------------------', #{color}) %>"
+        say " <%= color('# Authorization SUCCESSFUL', BOLD, #{color}) %>"
+        say " <%= color('# -------------------------------------------------------------------------', #{color}) %>"
+      rescue
+        color = 'RED'
+        say " <%= color('# -------------------------------------------------------------------------', #{color}) %>"
+        say " <%= color('# Authorization FAILED', BOLD, #{color}) %>"
+        say " <%= color('# -------------------------------------------------------------------------', #{color}) %>"
+      end
+      return
     end
 
     unless %w(get post put delete).include? method.to_s
@@ -54,8 +74,8 @@ class OauthCli
 
     uri  = ask " |-- request uri >> " if !uri
     body = ask " |-- request body >> " if !body && (method == "post" || method == "put")
-
-    url = "http://#{@options[:host]}#{uri}"
+    
+    url = @options[:host] + uri
 
     @options[:mime_type]    ||= (url =~ /\.json/) ? "application/json" : "application/xml"
     @options[:content_type] ||= (url =~ /\.json/) ? "application/json" : "application/xml"
@@ -70,15 +90,14 @@ class OauthCli
     say " <%= color('# -------------------------------------------------------------------------', #{color}) %>"
 
     body = response.body
-    if header.content_type =~ /.json/
+    if header.content_type =~ /json/
       body = JSON.parse(body)
       ap(body) rescue say(JSON.pretty_generate(body))
       return
     end
-    
+
     body = " <%= color('# #{$1.gsub("'", "")} ', RED) %>" if body =~ /<pre>(.+)<\/pre>/
     say body
   end
 
-
 end

data/oauth-cli.gemspec

@@ -2,18 +2,18 @@
 
 Gem::Specification.new do |s|
   s.name = %q{oauth-cli}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   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-20}
+  s.date = %q{2010-04-23}
   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.files = ["CHANGELOG", "Manifest", "README.rdoc", "Rakefile", "bin/oauthc", "lib/oauth_cli.rb", "oauth-cli.gemspec", "test/helper.rb", "test/test_oauth_cli.rb", "test/test_oauthc.rb"]
   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"]
@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.6}
   s.signing_key = %q{/Users/tobiasb/.ssh/gem-private_key.pem}
   s.summary = %q{A simple CLI client to test your oauth API easily}
+  s.test_files = ["test/test_oauth_cli.rb", "test/test_oauthc.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
@@ -30,14 +31,17 @@ 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_development_dependency(%q<mocha>, [">= 0"])
     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<mocha>, [">= 0"])
     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<mocha>, [">= 0"])
   end
 end

data/test/helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'test/unit'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'oauth_cli'
+
+class Test::Unit::TestCase
+end
+
+#mock oauth stuff ??
+
+# mock highline stuff??

data/test/test_oauth_cli.rb

@@ -0,0 +1,19 @@
+require 'helper'
+
+class TestOauthCli < Test::Unit::TestCase 
+  
+  def test_should_init_oauth
+    opt = {}
+    @client = OauthCli.new(opt)
+    assert @client
+  end
+  
+  def test_should_add_http_to_host
+    opt = { :host => "api.bbc.com", :auth_host => "http://test.domain", :reg_host => "https://test.domain", :consumer_key => "dummy_key"}
+    @client = OauthCli.new(opt)
+    
+    assert_equal "http://api.bbc.com", @client.options[:host]
+    assert_equal "http://test.domain", @client.options[:auth_host]
+    assert_equal "https://test.domain", @client.options[:reg_host]
+  end  
+end

data/test/test_oauthc.rb

@@ -0,0 +1,19 @@
+require 'helper'
+
+class TestOauthCli < Test::Unit::TestCase 
+  
+  def setup
+    @oauthc = File.dirname(File.dirname(__FILE__)) + "/bin/oauthc"
+  end
+  
+  def test_should_show_help
+    output = `#{@oauthc}`
+    assert output =~ /Usage: oauthc/
+  end
+  
+  def test_should_show_error_on_profile
+    output = `#{@oauthc} -p=unknown`
+    assert output =~ /Profile unknown not found/
+  end
+  
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - rngtng - Tobias Bielohlawek
@@ -34,8 +34,8 @@ cert_chain:
   I5mOkC+DmQeKRCyukHoWnysL5IyK+l7JEPymkOlNWkl006u5rNu/d7LJJW19+ZvC
   -----END CERTIFICATE-----
 
-date: 2010-04-20 00:00:00 +02:00
-default_executable: 
+date: 2010-04-23 00:00:00 +02:00
+default_executable: oauthc
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: highline
@@ -79,6 +79,18 @@ dependencies:
         version: 0.3.6
   type: :runtime
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: A simple CLI client to test your oauth API easily
 email: tobi @nospam@ rngtng.com
 executables: 
@@ -96,9 +108,11 @@ files:
 - README.rdoc
 - Rakefile
 - bin/oauthc
-- init.rb
 - lib/oauth_cli.rb
 - oauth-cli.gemspec
+- test/helper.rb
+- test/test_oauth_cli.rb
+- test/test_oauthc.rb
 has_rdoc: true
 homepage: http://github.com/rngtng/oauth-cli
 licenses: []
@@ -135,5 +149,6 @@ rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A simple CLI client to test your oauth API easily
-test_files: []
-
+test_files: 
+- test/test_oauth_cli.rb
+- test/test_oauthc.rb

data/init.rb

@@ -1 +0,0 @@
-require 'oauth_cli'