RubyGems - mudbug - Versions diffs - 0.6.0.1 → 0.7.0.1 - Mend

mudbug 0.6.0.1 → 0.7.0.1

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 (8) hide show

data/MANIFEST.txt CHANGED Viewed

@@ -8,3 +8,4 @@ lib/mudbug.rb
 lib/mb_config.rb
 test/mudbug.rb
 examples/accepts_and_methods.rb
+bin/mb

data/README.md CHANGED Viewed

@@ -19,82 +19,105 @@ Install the gem:
 Or, if using bundler, add to your Gemfile:
-    gem 'mudbug', '~> 0'
+    gem 'mudbug', '~> 0.6'
 Quick Start
 -----------
 Initialize it with a host:
-    require 'mudbug'
-    mb = Mudbug.new 'ip.jsontest.com'
+```ruby
+require 'mudbug'
+mb = Mudbug.new 'ip.jsontest.com'
+```
 The convenience methods *#get*, *#post*, *#put*, or *#delete* return the response body.  If the response has a *Content-type:* **application/json** header, then JSON parsing will be automatically performed on the response body, with the resulting object returned.
-    response = mb.get '/'
-    # => {"ip"=>"12.34.56.78"}
+```ruby
+response = mb.get '/'
+# => {"ip"=>"12.34.56.78"}
-    response.class
-    # => Hash
+response.class
+# => Hash
+```
 Usage
 -----
 You can pass through persistent [options to rest-client](https://github.com/rest-client/rest-client/blob/master/lib/restclient/request.rb):
-    require 'mudbug'
-    mb = Mudbug.new 'google.com', max_redirects: 3
+```ruby
+require 'mudbug'
+mb = Mudbug.new 'google.com', max_redirects: 3
+```
 Declare what you accept: (optional, default shown)
-    mb.accept :json, :html, :text
+```ruby
+mb.accept :json, :html, :text
+```
 You can pass through per-request [options to rest-client](https://github.com/rest-client/rest-client/blob/master/lib/restclient/request.rb)
-    mb.get '/', max_redirects: 3
-    # => "<!doctype html><html ... <head><meta content=\"Search the world's information ... "
+```ruby
+mb.get '/', max_redirects: 3
+# => "<!doctype html><html ... <head><meta content=\"Search the world's information ... "
+```
 [RestClient exceptions](https://github.com/rest-client/rest-client/blob/master/lib/restclient/exceptions.rb) will be passed through.  POST and PUT payloads will be sent as strings.  Non-string payloads will be converted to JSON by calling #to_json.
-    mb = Mudbug.new 'plus.google.com'
-    mb.post '/', { 'hi' => 'mom' }, max_redirects: 3
+```ruby
+mb = Mudbug.new 'plus.google.com'
+mb.post '/', { 'hi' => 'mom' }, max_redirects: 3
-    /path/to/lib/restclient/abstract_response.rb:48:in `return!': 405 Method Not Allowed (RestClient::MethodNotAllowed)
+# /path/to/lib/restclient/abstract_response.rb:48:in `return!': 405 Method Not Allowed (RestClient::MethodNotAllowed)
-    # lawyer up
-    # hit gym
-    Mudbug.new('facebook.com').delete '/'
+# lawyer up
+# hit gym
+Mudbug.new('facebook.com').delete '/'
-     /path/to/lib/restclient/abstract_response.rb:39:in `return!': 301 Moved Permanently (RestClient::MovedPermanently)
+# /path/to/lib/restclient/abstract_response.rb:39:in `return!': 301 Moved Permanently (RestClient::MovedPermanently)
+```
 Digging Deeper
 --------------
 Call Mudbug#resource directly for finer-grained response handling:
-    resp = Mudbug.new('google.com').resource('/').get
-    # check resp.code
-    # check resp.headers
-    # process resp.body
-    # etc.
+```ruby
+resp = Mudbug.new('google.com').resource('/').get
+# check resp.code
+# check resp.headers
+# process resp.body
+# etc.
+```
 Here is the heart of Mudbug's [response processing](https://github.com/rickhull/mudbug/blob/master/lib/mudbug.rb#L45):
-    # this structure declares what we support in the request Accept: header
-    # and defines automatic processing of the response based on the
-    # response Content-type: header
-    #
-    CONTENT = {
-      json: {
-        type: 'application/json',
-        proc: proc { |text| JSON.parse(text, symobolize_names: true) },
-      },
-      html: {
-        type: 'text/html',
-        proc: proc { |text| text },
-      },
-      text: {
-        type: 'text/plain',
-        proc: proc { |text| text },
-      },
-    }
+```ruby
+# this structure declares what we support in the request Accept: header
+# and defines automatic processing of the response based on the
+# response Content-type: header
+#
+CONTENT = {
+  json: {
+    type: 'application/json',
+    proc: proc { |text| JSON.parse(text, symobolize_names: true) },
+  },
+  html: {
+    type: 'text/html',
+    proc: proc { |text| text },
+  },
+  text: {
+    type: 'text/plain',
+    proc: proc { |text| text },
+  },
+}
+```
+Careful with that axe, Eugene.
+Examples
+--------
+* accepts_and_methods [sample script](https://github.com/rickhull/mudbug/blob/master/examples/accepts_and_methods.rb)
+* accepts_and_methods [sample output](https://github.com/rickhull/mudbug/blob/master/examples/accepts_and_methods.txt)
 Funny, that
 -----------
@@ -103,8 +126,3 @@ Mudbug works best with webservers that respect the *Accept:* request header and
 [RFC 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html)
 > If no Accept header field is present, then it is assumed that the client accepts all media types. If an Accept header field is present, and if the server cannot send a response which is acceptable according to the combined Accept field value, then the server SHOULD send a 406 (not acceptable) response.
-Examples
---------
-* accepts_and_methods [sample script](https://github.com/rickhull/mudbug/blob/master/examples/accepts_and_methods.rb)
-* accepts_and_methods [sample output](https://github.com/rickhull/mudbug/blob/master/examples/accepts_and_methods.txt)

data/VERSION CHANGED Viewed

	@@ -1 +1 @@
1	- 0.6.0.1
1	+ 0.7.0.1

data/bin/mb CHANGED Viewed

@@ -1,8 +1,10 @@
 #!/usr/bin/env ruby
+require 'mb_config'
 def usage(msg = nil)
   puts "ERROR: #{msg}" if msg
-  puts <<USAGE
+  puts <<EOF
 USAGE:
   mb [get|delete] [PATH]         - GET or DELETE PATH
   mb [post|put] [PATH] -         - POST or PUT payload (STDIN) to PATH
@@ -12,10 +14,11 @@ USAGE:
   mb payload [-]                 - Set (from STDIN) or display payload config
   mb config                      - Display current config
-  * A host must be configured for mb to operate
-  * method, path, and payload, if configured, can be omitted as CLI arguments
-  * accept is optional; valid values include json, html, text
-USAGE
+  * A `host` must be configured for mb to operate
+  * `method`, `path`, and `payload`, if configured, are not required arguments
+  * Set a config item to nil in order to remove it
+  * `accept` is optional; valid values include json, html, text
+EOF
   puts
   puts "CONFIG: #{MbConfig.dump}"
@@ -27,8 +30,6 @@ def conclude(msg)
   exit 0
 end
-require 'mb_config'
 #
 # Config section: handle commands that manipulate MbConfig
 # Should exit in all cases with conclude()
@@ -96,9 +97,7 @@ if cfg_cmd
       end
     when 1
       # did they provide a quoted or CSV list? or pseudo-symbols with colons?
-      accepts = accepts.first.split(/[ ,:]+/).map { |s|
-        s.empty? ? nil : s
-      }.compact
+      accepts = accepts.first.split(/[ ,:]+/).select { |s| !s.empty? }
     else
       accepts.map! { |s| s.gsub %r{[ ,:]+}, '' }
     end
@@ -112,87 +111,69 @@ if cfg_cmd
 end
 #
-# Done with manipulating MbConfig
-#
-#
-# Stage 2: create Mudbug based on MbConfig and command line options
+# OK, we're not manipulating MbConfig
+# Create Mudbug, determine method and path - from MbConfig and cmd line args
 #
 # set the host, always from MbConfig
+#
 usage "no host is set" unless MbConfig['host']
 mb = Mudbug.new MbConfig['host']
 mb.accept MbConfig['accept'].map(&:to_sym) if MbConfig['accept']
 # set the method, possibly from CLI args
-meth_cmd = ARGV.first
-case meth_cmd
-when 'get', 'post', 'put', 'delete', 'del'
-  ARGV.shift # confirmed meth_cmd, go ahead and shift
-  method = meth_cmd
+#
+case ARGV.first
+when 'get', 'post', 'put', 'delete'# , 'patch'   # Soon(tm)
+  method = ARGV.shift
 else
   method = MbConfig['method'] or usage "no method provided"
 end
 # set the path, possibly from CLI args
-path_cmd = ARGV.first
-case path_cmd
+#
+case ARGV.first
 when %r{^\/} # starts with a slash
-  ARGV.shift # confirmed path_cmd, go ahead and shift
-  path = path_cmd
+  path = ARGV.shift
 else
   path = MbConfig['path'] or usage "no path provided"
 end
+# determine method
+# gather payload as required
+# create args for sending the request
 #
-# no payload yet; run GET and DELETE
-#
 case method
-when 'get'
-  begin
-    data = mb.get path
-  rescue RuntimeError => e
-    puts "#{e} - #{e.class}"
-    exit 1
-  end
-  conclude JSON.pretty_generate data
-when 'del', 'delete'
-  begin
-    data = mb.delete path
-  rescue RuntimeError => e
-    puts "#{e} - #{e.class}"
-    exit 1
-  end
-  conclude JSON.pretty_generate data
+when 'get', 'delete'
+  args = [method, path]
 when 'post', 'put', 'patch'
-  # do nothing for now
+  # get payload
+  case ARGV.first
+  when nil
+    payload = MbConfig['payload'] or usage "no payload provided"
+  when '-'
+    begin
+      payload = JSON.parse $stdin.read
+    rescue
+      usage "could not parse payload:\n#{payload.inspect}"
+    end
+  end
+  args = [method, path, payload]
 else
   usage "Bad HTTP method #{method}"
 end
-# to get here, we must be doing POST, PUT, or PATCH
-# we need a payload
-payload = ARGV.first
-case payload
-when nil
-  payload = MbConfig['payload'] or usage "no payload provided"
-when '-'
-  payload = $stdin.read
-  begin
-    JSON.parse payload
-  rescue
-    usage "could not parse payload:\n#{payload.inspect}"
-  end
-end
+#
+# finally!
+#
 begin
-  data = mb.send(method, path, payload)
+  data = mb.send(*args)
 rescue RuntimeError => e
   puts "#{e} - #{e.class}"
   exit 1
 end
-conclude JSON.pretty_generate data
+data = JSON.pretty_generate data unless data.is_a? String
+conclude data

data/lib/mb_config.rb CHANGED Viewed

@@ -26,16 +26,21 @@ module MbConfig
   #
   def self.load
     reset unless File.exists?(FILE)
+    rescues = 0
     begin
       File.open(FILE, 'r') { |f|
         CFG.merge! JSON.parse f.read
       }
     rescue JSON::ParserError => e
+      rescues += 1
       puts "#{e} (#{e.class})"
-      puts "Resetting #{FILE}"
-      reset
-      # recursion; depends on .reset writing parseable JSON to stop
-      load
+      if rescues < 2
+        puts "Resetting #{FILE}"
+        reset
+        retry
+      end
+      Mudbug.lager.fatal { "MbConfig.load failed!" }
+      raise e
     end
   end

data/lib/mudbug.rb CHANGED Viewed

@@ -84,8 +84,6 @@ class Mudbug
   attr_accessor :host
   def initialize(host, options = {})
-    # note, not yet logging at instance layer
-    # @lager = self.class.lager
     @host = host
     @options = options
     accept :json, :html, :text
@@ -107,10 +105,18 @@ class Mudbug
   # use this method directly if you want finer-grained request and response
   # handling
+  # supports /path/to/res, path/to/res, http://host.com/path/to/res
   #
   def resource(path, options = {})
-    path = "/#{path}" unless path[0,1] == '/'
-    RestClient::Resource.new "http://#{@host}#{path}", @options.merge(options)
+    uri = URI.parse(path)
+    if uri.host # a full URL was passed in
+      @host = uri.host
+      url = uri.to_s
+    else
+      path = "/#{path}" unless path[0,1] == '/'
+      url = "http://#{@host}#{path}"
+    end
+    RestClient::Resource.new url, @options.merge(options)
   end
   # no payload

metadata CHANGED Viewed

@@ -1,85 +1,96 @@
 --- !ruby/object:Gem::Specification
 name: mudbug
 version: !ruby/object:Gem::Version
-  version: 0.6.0.1
+  version: 0.7.0.1
+  prerelease:
 platform: ruby
 authors:
 - Rick Hull
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-07-12 00:00:00.000000000 Z
+date: 2013-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1'
+  type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1'
-  type: :runtime
-  prerelease: false
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1'
+  type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1'
-  type: :runtime
-  prerelease: false
 - !ruby/object:Gem::Dependency
   name: lager
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0.2'
+  type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0.2'
-  type: :runtime
-  prerelease: false
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
 - !ruby/object:Gem::Dependency
   name: buildar
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.4'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.4'
-  type: :development
-  prerelease: false
 description: GET, POST, PUT, and DELETE JSON payloads. Easy Accept headers. Fine-grained
   response handling using Mudbug#resource.
 email:
@@ -102,25 +113,26 @@ files:
 homepage: http://github.com/rickhull/mudbug
 licenses:
 - LGPL
-metadata: {}
 post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.0.3
+rubygems_version: 1.8.23
 signing_key:
-specification_version: 4
+specification_version: 3
 summary: This hardy creature consumes JSON / REST APIs
 test_files: []

checksums.yaml DELETED Viewed

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YmI3NzE0NGE5MmVjZGQ5NDgwNzRmZmZjOTdkNjVmMGQ1NGJjYmRkZQ==
-  data.tar.gz: !binary |-
-    MDQ5NGFhZTVkZTEyMzU4NjVjY2Y3NjI0YjAyNjEzNDEyNDdhNzdhMw==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    MTAwMzFjZThlNWFkMTczNzM5YTFhMDQ2M2UxNzg3ZGU3OGE5MjYxMjYyYTNl
-    ZDIwMGU3MmNhMGQzOWFlNWY4NzdmMDBmZTFhNWZiZjM2YmRiNDk3NWI2OTI1
-    OWFhNDJlNWQwNGQwYjAyNTdhMDJmN2E1NjdiMTkzMmIwNDgzODc=
-  data.tar.gz: !binary |-
-    MjMyZTljZTNjMzMzM2M3YzhhNThiYjhmNDM1MTM0NTY2ZWMzZGY2N2NjMWVh
-    YjM3N2QyYjYxOTMyNDcyY2JiMTBhYTY5MTlmOWE3NDBmMGE1OTUzZjM5ZjMx
-    ZTJmMzMyMTI3MGYwMDc3NzlhMTczM2Y0ZDhlOTI2YzYxYWFkNDc=