wadl 0.2.8 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09edcf1ce635ec8148e28aab9b7d912bd7858b25
-  data.tar.gz: 04206b57c6fee54444eb16c0d0cee770b331fdfe
+  metadata.gz: 502bdfe2423d3d6020d35cfd788adcdb5711af80
+  data.tar.gz: 8e38d68bc3a3574ed72cc86c4146ad964135925d
 SHA512:
-  metadata.gz: 8e3be1528667417365e6396db2d312533cbaaeadf1cae215b6d9859ded081b4aa19861ea6304dc8189a53fd34cc474d5f68d75d282be53395101b2afed5fd931
-  data.tar.gz: 33f00a807e7199aadf88118ac7c2d21944d08eddadd26c7c8da5a7adb4bc64bbf8b5f5cc93e8b4919b323913407868fd063664d1c7cce5228921725b4e1c946e
+  metadata.gz: 60ed00a1f22ed3d648900ae3a56b7470bf985b15d9811f250a0c45154305c4e2b8671477a5cf5bf98d50d0ae6908f5736ad61799082d29db01f471ce3b3568d2
+  data.tar.gz: 2f2acd870930374c2f3a8986478106cb06f4c7795392ca71a05717882abda265813dc80073be744f79c6899e175257de2a348d414ca0e3df5fe20f340dd91fe3

data/README

@@ -2,7 +2,7 @@
 
 == VERSION
 
-This documentation refers to wadl version 0.2.8
+This documentation refers to wadl version 0.3.0
 
 
 == DESCRIPTION
@@ -44,12 +44,12 @@ The 20060802 WADL standard is almost entirely supported. However,
 
 == LINKS
 
-<b></b>
-Homepage::      http://www.crummy.com/software/wadl.rb
-WADL::          http://wadl.java.net
-Documentation:: http://blackwinter.github.com/wadl
-Source code::   http://github.com/blackwinter/wadl
-RubyGem::       http://rubygems.org/gems/wadl
+Homepage::           http://www.crummy.com/software/wadl.rb
+WADL Specification:: https://wadl.java.net
+Documentation::      https://blackwinter.github.com/wadl
+Source code::        https://github.com/blackwinter/wadl
+RubyGem::            https://rubygems.org/gems/wadl
+Travis CI::          https://travis-ci.org/blackwinter/wadl
 
 
 == AUTHORS
@@ -61,7 +61,7 @@ RubyGem::       http://rubygems.org/gems/wadl
 == LICENSE AND COPYRIGHT
 
 Copyright (C) 2006-2008 Leonard Richardson
-Copyright (C) 2010-2013 Jens Wille
+Copyright (C) 2010-2014 Jens Wille
 
 wadl is free software: you can redistribute it and/or modify it under
 the terms of the GNU Affero General Public License as published by the

data/Rakefile

@@ -1,18 +1,25 @@
-require File.expand_path(%q{../lib/wadl/version}, __FILE__)
+require_relative 'lib/wadl/version'
 
 begin
   require 'hen'
 
   Hen.lay! {{
-    :gem => {
-      :name         => %q{wadl},
-      :version      => WADL::VERSION,
-      :summary      => %q{Ruby client for the Web Application Description Language.},
-      :authors      => ['Leonard Richardson', 'Jens Wille'],
-      :email        => ['leonardr@segfault.org', 'jens.wille@gmail.com'],
-      :license      => %q{AGPL-3.0},
-      :homepage     => :blackwinter,
-      :dependencies => %w[rest-open-uri mime-types] << ['ruby-nuggets', '>= 0.7.3']
+    gem: {
+      name:         %q{wadl},
+      version:      WADL::VERSION,
+      summary:      %q{Super cheap Ruby WADL client.},
+      description:  %q{Ruby client for the Web Application Description Language.},
+      authors:      ['Leonard Richardson', 'Jens Wille'],
+      email:        'jens.wille@gmail.com',
+      license:      %q{AGPL-3.0},
+      homepage:     :blackwinter,
+      dependencies: {
+        'cyclops'    => ['~> 0.0', '>= 0.0.4'],
+        'mime-types' => '~> 2.4',
+        'safe_yaml'  => '~> 1.0'
+      },
+
+      required_ruby_version: '>= 1.9.3'
     }
   }}
 rescue LoadError => err

data/lib/wadl.rb

@@ -4,7 +4,7 @@
 # wadl -- Super cheap Ruby WADL client                                        #
 #                                                                             #
 # Copyright (C) 2006-2008 Leonard Richardson                                  #
-# Copyright (C) 2010-2013 Jens Wille                                          #
+# Copyright (C) 2010-2014 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Leonard Richardson <leonardr@segfault.org> (Original author)            #
@@ -26,7 +26,7 @@
 ###############################################################################
 #++
 
-require 'wadl/version'
+require_relative 'wadl/version'
 
 module WADL
 
@@ -38,6 +38,8 @@ module WADL
   autoload :Fault,                   'wadl/fault'
   autoload :HasDocs,                 'wadl/has_docs'
   autoload :HTTPMethod,              'wadl/http_method'
+  autoload :HTTPRequest,             'wadl/http_request'
+  autoload :HTTPResponse,            'wadl/http_response'
   autoload :Link,                    'wadl/link'
   autoload :Option,                  'wadl/option'
   autoload :Param,                   'wadl/param'
@@ -54,4 +56,17 @@ module WADL
   autoload :URIParts,                'wadl/uri_parts'
   autoload :XMLRepresentation,       'wadl/xml_representation'
 
+  class << self
+
+    def require_oauth(lib)
+      require "oauth/#{lib}"
+    rescue LoadError => err
+      define_singleton_method(__method__) { |*| }  # only warn once
+      warn "For OAuth support, install the `oauth' library. (#{err})"
+    end
+
+    private :require_oauth
+
+  end
+
 end

data/lib/wadl/address.rb

@@ -4,7 +4,7 @@
 # A component of wadl, the super cheap Ruby WADL client.                      #
 #                                                                             #
 # Copyright (C) 2006-2008 Leonard Richardson                                  #
-# Copyright (C) 2010-2013 Jens Wille                                          #
+# Copyright (C) 2010-2014 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Leonard Richardson <leonardr@segfault.org> (Original author)            #
@@ -26,8 +26,6 @@
 ###############################################################################
 #++
 
-require 'wadl'
-
 module WADL
 
   # The Address class keeps track of the user's path through a resource

data/lib/wadl/application.rb

@@ -4,7 +4,7 @@
 # A component of wadl, the super cheap Ruby WADL client.                      #
 #                                                                             #
 # Copyright (C) 2006-2008 Leonard Richardson                                  #
-# Copyright (C) 2010-2013 Jens Wille                                          #
+# Copyright (C) 2010-2014 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Leonard Richardson <leonardr@segfault.org> (Original author)            #
@@ -27,7 +27,6 @@
 #++
 
 require 'rexml/document'
-require 'wadl'
 
 module WADL
 

data/lib/wadl/cheap_schema.rb

@@ -4,7 +4,7 @@
 # A component of wadl, the super cheap Ruby WADL client.                      #
 #                                                                             #
 # Copyright (C) 2006-2008 Leonard Richardson                                  #
-# Copyright (C) 2010-2013 Jens Wille                                          #
+# Copyright (C) 2010-2014 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Leonard Richardson <leonardr@segfault.org> (Original author)            #
@@ -26,8 +26,6 @@
 ###############################################################################
 #++
 
-require 'wadl'
-
 module WADL
 
   # A cheap way of defining an XML schema as Ruby classes and then parsing
@@ -389,8 +387,3 @@ module WADL
   end
 
 end
-
-# Simple backport for Ruby <= 1.8.5
-class Object  # :nodoc:
-  def instance_variable_defined?(sym); instance_eval("defined?(#{sym})"); end
-end unless Object.method_defined?(:instance_variable_defined?)

data/lib/wadl/cli.rb

@@ -3,7 +3,7 @@
 #                                                                             #
 # A component of wadl, the super cheap Ruby WADL client.                      #
 #                                                                             #
-# Copyright (C) 2010-2013 Jens Wille                                          #
+# Copyright (C) 2010-2014 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Jens Wille <jens.wille@gmail.com>                                       #
@@ -25,19 +25,16 @@
 #++
 
 require 'cgi'
+require 'cyclops'
+require 'open-uri'
 require 'stringio'
-require 'nuggets/util/cli'
 require 'wadl'
 
-begin
-  require 'oauth/cli'
-rescue LoadError
-  warn "For OAuth support, install the `oauth' library."
-end
-
 module WADL
 
-  class CLI < ::Util::CLI
+  require_oauth :cli
+
+  class CLI < Cyclops
 
     OPTION_RE          = %r{\A--?(.+?)(?:=(.+))?\z}
     RESOURCE_PATH_RE   = %r{[. /]}
@@ -53,12 +50,12 @@ module WADL
 
       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'
+          config:            'config.yaml',
+          method:            HTTPRequest::DEFAULT_METHOD.upcase,
+          user:              ENV['USER'] || '',
+          request_token_url: '%s/oauth/request_token',
+          access_token_url:  '%s/oauth/access_token',
+          authorize_url:     '%s/oauth/authorize'
         )
       end
 
@@ -85,20 +82,23 @@ module WADL
         stderr.puts api       if debug >= 2
       end
 
-      response = auth_resource.send(options[:method].downcase, :query => query)
+      response = auth_resource.send(options[:method].downcase, query: query)
 
       stderr.puts response.code.join(' ')
       stdout.puts response.representation unless response.code.first =~ /\A[45]/
     end
 
     def api
-      @api ||= WADL::Application.from_wadl(open(options[:wadl]))
+      @api ||= Application.from_wadl(open(options[:wadl]))
     end
 
     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 quit "Resource not found: #{path.join('/')}"
+        path = [options[:api_base], *resource_path].compact.join('/')
+        path = path.sub(/\A\//, '').split(RESOURCE_PATH_RE)
+
+        path.inject(api) { |m, n| m.send(:find_resource_by_path, n) or
+          quit "Resource not found: #{path.join('/')}: #{n}" }
       end
     end
 
@@ -123,7 +123,8 @@ module WADL
 
     def parse_arguments(arguments)
       @resource_path, @query, skip_next = [], {}, false
-      query.update(options[:query]) if options[:query]
+
+      parse_query
 
       arguments.each_with_index { |arg, index|
         if skip_next
@@ -148,14 +149,12 @@ module WADL
       }
     end
 
-    def parse_query(query_string)
-      params = {}
+    def parse_query
+      return unless query_string = options[:query]
 
       query_string.split(QUERY_SEPARATOR_RE).each { |pair|
-        add_param(params, *pair.split('=', 2).map { |v| CGI.unescape(v) })
+        add_param(query, *pair.split('=', 2).map { |v| CGI.unescape(v) })
       }
-
-      params
     end
 
     def add_param(params, key, value)
@@ -183,7 +182,7 @@ module WADL
 
     def basic_auth_resource
       user, pass = options.values_at(:user, :password)
-      pass ||= ask("Password for user #{user}: ") { |q| q.echo = false }
+      pass ||= askpass("Password for user #{user}: ")
 
       quit 'USER and PASSWORD required' unless user && pass
 
@@ -241,111 +240,77 @@ module WADL
     end
 
     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.separator ''
+      opts.option(:wadl__FILE_OR_URL,
+                  'Path or URL to WADL file [Required]')
 
-      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
-      }
+      opts.option(:method__METHOD,
+                  "Request method [Default: #{defaults[:method]}]",
+                  &:upcase!)
 
-      opts.on('-a', '--api-base PATH', "Base path for API") { |api_base|
-        options[:api_base] = api_base
-      }
+      opts.option(:api_base__PATH, 'Base path for API')
 
-      opts.on('-q', '--query QUERY', "Query string to pass to request") { |query|
-        options[:query] = parse_query(query)
-      }
+      opts.option(:query__QUERY, 'Query string to pass to request')
 
-      opts.separator ''
+      opts.separator
 
-      opts.on('--skip-auth', "Skip any authentication") {
-        options[:skip_auth] = true
-      }
+      opts.switch('skip_auth', 'Skip any authentication')
 
-      opts.separator ''
+      opts.separator
       opts.separator 'Basic Auth options:'
 
-      opts.on('-B', '--basic', "Perform Basic Auth") {
-        options[:basic] = true
-      }
+      opts.switch(:basic, :B, 'Perform Basic Auth')
 
-      opts.separator ''
+      opts.separator
 
-      opts.on('--user USER', "User name") { |user|
-        options[:user] = user
-      }
+      opts.option('user__USER', 'User name')
 
-      opts.on('--password PASSWORD', "Password for user") { |password|
-        options[:password] = password
-      }
+      opts.option('password__PASSWORD', 'Password for user')
 
-      opts.separator ''
+      opts.separator
       opts.separator 'OAuth options:'
 
-      opts.on('-O', '--oauth', "Perform OAuth") {
-        options[:oauth] = true
-      }
+      opts.switch(:oauth, :O, 'Perform OAuth')
 
-      opts.separator ''
+      opts.separator
 
-      opts.on('--consumer-key KEY', "Consumer key to use") { |consumer_key|
-        options[:consumer_key] = consumer_key
-      }
+      opts.option('consumer_key__KEY', 'Consumer key to use')
 
-      opts.on('--consumer-secret SECRET', "Consumer secret to use") { |consumer_secret|
-        options[:consumer_secret] = consumer_secret
-      }
+      opts.option('consumer_secret__SECRET', 'Consumer secret to use')
 
-      opts.separator ''
+      opts.separator
 
-      opts.on('--token TOKEN', "Access token to use") { |token|
-        options[:token] = token
-      }
+      opts.option('token__TOKEN', 'Access token to use')
 
-      opts.on('--secret SECRET', "Token secret to use") { |secret|
-        options[:secret] = secret
-      }
+      opts.option('secret__SECRET', 'Token secret to use')
 
-      opts.separator ''
+      opts.separator
 
-      opts.on('-b', '--base-url URL', "Base URL [Default: \"dirname\" of WADL]") { |base_url|
-        options[:base_url] = base_url
-      }
+      opts.option(:base_url__URL, 'Base URL [Default: "dirname" of WADL]')
 
-      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.option('request_token_url__URL',
+                  "Request token URL [Default: #{defaults[:request_token_url] % 'BASE_URL'}]")
 
-      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.option('access_token_url__URL',
+                  "Access token URL [Default: #{defaults[:access_token_url] % 'BASE_URL'}]")
 
-      opts.on('--authorize-url URL', "Authorize URL [Default: #{defaults[:authorize_url] % 'BASE_URL'}]") { |authorize_url|
-        options[:authorize_url] = authorize_url
-      }
+      opts.option('authorize_url__URL',
+                  "Authorize URL [Default: #{defaults[:authorize_url] % 'BASE_URL'}]")
     end
 
     def generic_opts(opts)
-      super
-
-      opts.on('-d', '--debug [LEVEL]', Integer, 'Enable debugging output') { |level|
+      opts.option(:debug__LEVEL?, Integer, 'Enable debugging output') { |level|
         options[:debug] = level || true
       }
 
-      opts.on('-D', '--dump-config', 'Dump config and exit') {
-        options[:dump_config] = true
-      }
+      opts.switch(:dump_config, :D, 'Dump config and exit')
+
+      opts.separator
+
+      super
     end
 
     def post_opts(opts)
-      opts.separator ''
+      opts.separator
       opts.separator "PATH may be separated by any of #{RESOURCE_PATH_RE.source}."
     end