wadl 0.2.3 → 0.2.4

data/README

@@ -2,7 +2,7 @@
 
 == VERSION
 
-This documentation refers to wadl version 0.2.3
+This documentation refers to wadl version 0.2.4
 
 
 == DESCRIPTION

data/Rakefile

@@ -11,7 +11,7 @@ begin
       :authors      => ['Leonard Richardson', 'Jens Wille'],
       :email        => ['leonardr@segfault.org', 'jens.wille@uni-koeln.de'],
       :homepage     => :blackwinter,
-      :dependencies => %w[rest-open-uri mime-types]
+      :dependencies => %w[rest-open-uri mime-types] << ['ruby-nuggets', '>= 0.7.3']
     }
   }}
 rescue LoadError => err

data/bin/wadl

@@ -27,9 +27,4 @@
 #++
 
 require 'wadl/cli'
-
-begin
-  WADL::CLI.execute(ARGV, STDIN, STDOUT, STDERR)
-rescue ArgumentError => err
-  abort err
-end
+WADL::CLI.execute

data/lib/wadl/cli.rb

@@ -24,11 +24,9 @@
 ###############################################################################
 #++
 
-require 'optparse'
-require 'yaml'
 require 'cgi'
-require 'highline'
 require 'stringio'
+require 'nuggets/util/cli'
 require 'wadl'
 
 begin
@@ -39,18 +37,7 @@ end
 
 module WADL
 
-  class CLI
-
-    USAGE = "Usage: #{$0} [-h|--help] [options] <resource-path> [-- arguments]"
-
-    DEFAULTS = {
-      :config            => 'config.yaml',
-      :method            => 'GET',
-      :user              => ENV['USER'] || '',
-      :request_token_url => '%s/oauth/request_token',
-      :access_token_url  => '%s/oauth/access_token',
-      :authorize_url     => '%s/oauth/authorize'
-    }
+  class CLI < ::Util::CLI
 
     OPTION_RE          = %r{\A--?(.+?)(?:=(.+))?\z}
     RESOURCE_PATH_RE   = %r{[. /]}
@@ -58,35 +45,37 @@ module WADL
     ARRAY_SUFFIX_RE    = %r{\[\]\z}
     HASH_SUFFIX_RE     = %r{\[(.+)\]\z}
 
-    def self.execute(*args)
-      new.execute(*args)
-    end
-
-    attr_reader :options, :config, :defaults
-    attr_reader :stdin, :stdout, :stderr
-    attr_reader :resource_path, :opts
+    class << self
 
-    def initialize(defaults = DEFAULTS)
-      @defaults = defaults
+      def usage(*)
+        "#{super} <resource-path> [-- arguments]"
+      end
 
-      reset
+      def defaults
+        super.merge(
+          :config            => 'config.yaml',
+          :method            => 'GET',
+          :user              => ENV['USER'] || '',
+          :request_token_url => '%s/oauth/request_token',
+          :access_token_url  => '%s/oauth/access_token',
+          :authorize_url     => '%s/oauth/authorize'
+        )
+      end
 
-      # prevent backtrace on ^C
-      trap(:INT) { exit 130 }
     end
 
-    def execute(arguments = [], *inouterr)
-      reset(*inouterr)
-
-      abort USAGE if arguments.empty?
-      parse_options(arguments, defaults)
+    attr_reader :resource_path, :opts
 
-      abort YAML.dump(options), 0, stdout if options.delete(:dump_config)
+    def run(arguments)
+      if options.delete(:dump_config)
+        stdout.puts(YAML.dump(options))
+        exit
+      end
 
       parse_arguments(arguments)
-      abort USAGE if resource_path.empty?
+      quit if resource_path.empty?
 
-      abort "WADL location is required! (Specify with '--wadl' or see '--help')" unless options[:wadl]
+      quit "WADL location is required! (Specify with '--wadl' or see '--help')" unless options[:wadl]
       options[:wadl] %= options[:base_url] if options[:base_url]
 
       if debug = options[:debug]
@@ -109,7 +98,7 @@ module WADL
     def resource
       @resource ||= begin
         path = [options[:api_base], *resource_path].compact.join('/').split(RESOURCE_PATH_RE)
-        path.inject(api) { |m, n| m.send(:find_resource_by_path, n) } or abort "Resource not found: #{path.join('/')}"
+        path.inject(api) { |m, n| m.send(:find_resource_by_path, n) } or quit "Resource not found: #{path.join('/')}"
       end
     end
 
@@ -121,29 +110,15 @@ module WADL
     end
 
     def reset(stdin = STDIN, stdout = STDOUT, stderr = STDERR)
-      @stdin, @stdout, @stderr = stdin, stdout, stderr
+      super
       @api = @resource = @auth_resource = nil
-      @options, @config = {}, {}
     end
 
     private
 
-    def ask(question, &block)
-      HighLine.new(stdin, stdout).ask(question, &block)
-    end
-
-    def abort(msg = nil, status = 1, output = stderr)
-      output.puts msg if msg
-      exit status
-    end
-
-    def parse_options(arguments, defaults)
-      option_parser(defaults).parse!(arguments)
-
-      config_file = options[:config] || defaults[:config]
-      @config = YAML.load_file(config_file) if File.readable?(config_file)
-
-      [config, defaults].each { |hash| hash.each { |key, value| options[key] ||= value } }
+    def parse_options(arguments)
+      quit if arguments.empty?
+      super
     end
 
     def parse_arguments(arguments)
@@ -208,7 +183,7 @@ module WADL
       user, pass = options.values_at(:user, :password)
       pass ||= ask("Password for user #{user}: ") { |q| q.echo = false }
 
-      abort 'USER and PASSWORD required' unless user && pass
+      quit 'USER and PASSWORD required' unless user && pass
 
       resource.with_basic_auth(user, pass)
     end
@@ -217,11 +192,11 @@ module WADL
       consumer_key, consumer_secret = options.values_at(:consumer_key, :consumer_secret)
       access_token, token_secret    = options.values_at(:token, :secret)
 
-      abort "CONSUMER KEY and SECRET required" unless consumer_key && consumer_secret
+      quit "CONSUMER KEY and SECRET required" unless consumer_key && consumer_secret
 
       unless access_token && token_secret
         access_token, token_secret = oauthorize(consumer_key, consumer_secret)
-        abort 'Authorization failed!?' unless access_token && token_secret
+        quit 'Authorization failed!?' unless access_token && token_secret
       end
 
       resource.with_oauth(consumer_key, consumer_secret, access_token, token_secret)
@@ -263,127 +238,115 @@ module WADL
       [access_token, token_secret]
     end
 
-    def option_parser(defaults)
-      OptionParser.new { |opts|
-        opts.banner = USAGE
-
-        opts.separator ''
-        opts.separator 'Options:'
-
-        opts.on('-c', '--config YAML', "Config file [Default: #{defaults[:config]}#{' (currently not present)' unless File.readable?(defaults[:config])}]") { |config|
-          options[:config] = config
-        }
-
-        opts.separator ''
-
-        opts.on('-w', '--wadl FILE_OR_URL', "Path or URL to WADL file [Required]") { |wadl|
-          options[:wadl] = wadl
-        }
-
-        opts.on('-m', '--method METHOD', "Request method [Default: #{defaults[:method]}]") { |method|
-          options[:method] = method.upcase
-        }
+    def opts(opts)
+      opts.on('-c', '--config YAML', "Config file [Default: #{defaults[:config]}#{' (currently not present)' unless File.readable?(defaults[:config])}]") { |config|
+        options[:config] = config
+      }
 
-        opts.on('-a', '--api-base PATH', "Base path for API") { |api_base|
-          options[:api_base] = api_base
-        }
+      opts.separator ''
 
-        opts.on('-q', '--query QUERY', "Query string to pass to request") { |query|
-          options[:query] = parse_query(query)
-        }
+      opts.on('-w', '--wadl FILE_OR_URL', "Path or URL to WADL file [Required]") { |wadl|
+        options[:wadl] = wadl
+      }
 
-        opts.separator ''
+      opts.on('-m', '--method METHOD', "Request method [Default: #{defaults[:method]}]") { |method|
+        options[:method] = method.upcase
+      }
 
-        opts.on('--skip-auth', "Skip any authentication") {
-          options[:skip_auth] = true
-        }
+      opts.on('-a', '--api-base PATH', "Base path for API") { |api_base|
+        options[:api_base] = api_base
+      }
 
-        opts.separator ''
-        opts.separator 'Basic Auth options:'
+      opts.on('-q', '--query QUERY', "Query string to pass to request") { |query|
+        options[:query] = parse_query(query)
+      }
 
-        opts.on('-B', '--basic', "Perform Basic Auth") {
-          options[:basic] = true
-        }
+      opts.separator ''
 
-        opts.separator ''
+      opts.on('--skip-auth', "Skip any authentication") {
+        options[:skip_auth] = true
+      }
 
-        opts.on('--user USER', "User name") { |user|
-          options[:user] = user
-        }
+      opts.separator ''
+      opts.separator 'Basic Auth options:'
 
-        opts.on('--password PASSWORD', "Password for user") { |password|
-          options[:password] = password
-        }
+      opts.on('-B', '--basic', "Perform Basic Auth") {
+        options[:basic] = true
+      }
 
-        opts.separator ''
-        opts.separator 'OAuth options:'
+      opts.separator ''
 
-        opts.on('-O', '--oauth', "Perform OAuth") {
-          options[:oauth] = true
-        }
+      opts.on('--user USER', "User name") { |user|
+        options[:user] = user
+      }
 
-        opts.separator ''
+      opts.on('--password PASSWORD', "Password for user") { |password|
+        options[:password] = password
+      }
 
-        opts.on('--consumer-key KEY', "Consumer key to use") { |consumer_key|
-          options[:consumer_key] = consumer_key
-        }
+      opts.separator ''
+      opts.separator 'OAuth options:'
 
-        opts.on('--consumer-secret SECRET', "Consumer secret to use") { |consumer_secret|
-          options[:consumer_secret] = consumer_secret
-        }
+      opts.on('-O', '--oauth', "Perform OAuth") {
+        options[:oauth] = true
+      }
 
-        opts.separator ''
+      opts.separator ''
 
-        opts.on('--token TOKEN', "Access token to use") { |token|
-          options[:token] = token
-        }
+      opts.on('--consumer-key KEY', "Consumer key to use") { |consumer_key|
+        options[:consumer_key] = consumer_key
+      }
 
-        opts.on('--secret SECRET', "Token secret to use") { |secret|
-          options[:secret] = secret
-        }
+      opts.on('--consumer-secret SECRET', "Consumer secret to use") { |consumer_secret|
+        options[:consumer_secret] = consumer_secret
+      }
 
-        opts.separator ''
+      opts.separator ''
 
-        opts.on('-b', '--base-url URL', "Base URL [Default: \"dirname\" of WADL]") { |base_url|
-          options[:base_url] = base_url
-        }
+      opts.on('--token TOKEN', "Access token to use") { |token|
+        options[:token] = token
+      }
 
-        opts.on('--request-token-url URL', "Request token URL [Default: #{defaults[:request_token_url] % 'BASE_URL'}]") { |request_token_url|
-          options[:request_token_url] = request_token_url
-        }
+      opts.on('--secret SECRET', "Token secret to use") { |secret|
+        options[:secret] = secret
+      }
 
-        opts.on('--access-token-url URL', "Access token URL [Default: #{defaults[:access_token_url] % 'BASE_URL'}]") { |access_token_url|
-          options[:access_token_url] = access_token_url
-        }
+      opts.separator ''
 
-        opts.on('--authorize-url URL', "Authorize URL [Default: #{defaults[:authorize_url] % 'BASE_URL'}]") { |authorize_url|
-          options[:authorize_url] = authorize_url
-        }
+      opts.on('-b', '--base-url URL', "Base URL [Default: \"dirname\" of WADL]") { |base_url|
+        options[:base_url] = base_url
+      }
 
-        opts.separator ''
-        opts.separator 'Generic options:'
+      opts.on('--request-token-url URL', "Request token URL [Default: #{defaults[:request_token_url] % 'BASE_URL'}]") { |request_token_url|
+        options[:request_token_url] = request_token_url
+      }
 
-        opts.on('-h', '--help', 'Print this help message and exit') {
-          abort opts.to_s
-        }
+      opts.on('--access-token-url URL', "Access token URL [Default: #{defaults[:access_token_url] % 'BASE_URL'}]") { |access_token_url|
+        options[:access_token_url] = access_token_url
+      }
 
-        opts.on('--version', 'Print program version and exit') {
-          abort "#{File.basename($0)} v#{WADL::VERSION}"
-        }
+      opts.on('--authorize-url URL', "Authorize URL [Default: #{defaults[:authorize_url] % 'BASE_URL'}]") { |authorize_url|
+        options[:authorize_url] = authorize_url
+      }
+    end
 
-        opts.on('-d', '--debug [LEVEL]', Integer, "Enable debugging output") { |level|
-          options[:debug] = level || true
-        }
+    def generic_opts(opts)
+      super
 
-        opts.on('-D', '--dump-config', "Dump config and exit") {
-          options[:dump_config] = true
-        }
+      opts.on('-d', '--debug [LEVEL]', Integer, 'Enable debugging output') { |level|
+        options[:debug] = level || true
+      }
 
-        opts.separator ''
-        opts.separator "PATH may be separated by any of #{RESOURCE_PATH_RE.source}."
+      opts.on('-D', '--dump-config', 'Dump config and exit') {
+        options[:dump_config] = true
       }
     end
 
+    def post_opts(opts)
+      opts.separator ''
+      opts.separator "PATH may be separated by any of #{RESOURCE_PATH_RE.source}."
+    end
+
   end
 
 end

data/lib/wadl/resource.rb

@@ -138,19 +138,25 @@ module WADL
     def find_method_by_id(id)
       id = id.to_s
       each_http_method { |m| return m if m.dereference.id == id }
+      nil
     end
 
     def find_method_by_http_method(action)
       action = action.to_s.downcase
       each_http_method { |m| return m if m.dereference.name.downcase == action }
+      nil
     end
 
     # Methods for reading or writing this resource
-    def self.define_http_methods(klass = self, methods = %w[get post put delete])
+    def self.define_http_methods(klass = self, methods = %w[head get post put delete])
       methods.each { |method|
         klass.class_eval <<-EOT, __FILE__, __LINE__ + 1
           def #{method}(*args, &block)
-            find_method_by_http_method(:#{method}).call(self, *args, &block)
+            if method = find_method_by_http_method(:#{method})
+              method.call(self, *args, &block)
+            else
+              raise ArgumentError, 'Method not allowed ("#{method}")'
+            end
           end
         EOT
       }

data/lib/wadl/version.rb

@@ -4,7 +4,7 @@ module WADL
 
     MAJOR = 0
     MINOR = 2
-    TINY  = 3
+    TINY  = 4
 
     class << self
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: wadl
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 2
-  - 3
-  version: 0.2.3
+  - 4
+  version: 0.2.4
 platform: ruby
 authors: 
 - Leonard Richardson
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-29 00:00:00 Z
+date: 2011-07-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rest-open-uri
@@ -46,6 +46,22 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ruby-nuggets
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 7
+        - 3
+        version: 0.7.3
+  type: :runtime
+  version_requirements: *id003
 description: Ruby client for the Web Application Description Language.
 email: 
 - leonardr@segfault.org
@@ -109,10 +125,10 @@ post_install_message:
 rdoc_options: 
 - --charset
 - UTF-8
-- --title
-- wadl Application documentation (v0.2.3)
 - --main
 - README
+- --title
+- wadl Application documentation (v0.2.4)
 - --line-numbers
 - --all
 require_paths: 
@@ -138,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Ruby client for the Web Application Description Language.