mudbug 0.4.5.1

data/LICENSE.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/MANIFEST.txt

@@ -0,0 +1,8 @@
+README.md
+VERSION
+rakefile.rb
+MANIFEST.txt
+LICENSE.txt
+lib/mudbug.rb
+test/mudbug.rb
+examples/accepts_and_methods.rb

data/README.md

@@ -0,0 +1,98 @@
+Mudbug
+=======
+Mudbug is a JSON-oriented, thin wrapper around [rest-client](https://github.com/rest-client/rest-client)'s [RestClient::Resource](https://github.com/rest-client/rest-client#usage-activeresource-style)
+
+Features
+--------
+* *GET*, *POST*, *PUT*, or *DELETE* JSON payloads
+* Convenience
+* Do The Right Thing 80% of the time every time
+* Easy *Accept:* headers
+* Understand and fall back to basic Content-types if application/json is not provided
+* Fine-grained response handling using Mudbug#resource
+
+Quick Start
+-----------
+Initialize it with a host:
+
+    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"}
+
+    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):
+
+    mb = Mudbug.new 'google.com', max_redirects: 3
+
+Declare what you accept: (optional, default shown)
+
+    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 ... "
+
+[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
+
+    /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 '/'
+
+     /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.
+
+Here is the heart of the Mudbug's [response processing](https://github.com/rickhull/mudbug/blob/master/lib/mudbug.rb#L37):
+
+    # 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 },
+      },
+    }
+
+Funny, that
+-----------
+Mudbug works best with webservers that respect the *Accept:* request header and provide proper *Content-type:* response headers.
+
+[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

@@ -0,0 +1 @@
+0.4.5.1

data/examples/accepts_and_methods.rb

@@ -0,0 +1,61 @@
+# normally, just require 'mudbug', but this will use your local version
+# useful for development purposes
+#
+require_relative '../lib/mudbug'
+
+sites = %w{google.com yahoo.com microsoft.com amazon.com ibm.com reddit.com}
+accepts = [:json, :html, :text, :xml]
+http_methods = [:get, :post, :put, :delete]
+
+path = '/'
+
+unless ARGV.shift == 'skip'
+  puts
+  puts "Checking Accepts across sites"
+  puts "============================="
+  sites.each { |site|
+    b = Mudbug.new(site)
+    url = "http://#{site}#{path}"
+
+    accepts.each { |acp|
+      b.accept(acp)
+
+      print "GET #{url}  [#{acp}] "
+      b.get path
+      puts
+    }
+    puts
+  }
+
+  puts
+  puts
+end
+
+payload = { 'hi' => 'mom' }.to_json
+
+unless ARGV.shift == 'skip'
+  puts "Checking HTTP methods across sites"
+  puts "=================================="
+  puts "POST/PUT payload = #{payload.to_json}"
+  puts
+  sites.each { |site|
+    b = Mudbug.new(site)
+    url = "http://#{site}#{path}"
+
+    http_methods.each { |meth|
+      args = [meth, path]
+      args << payload if [:post, :put].include?(meth)
+
+      print "#{meth.to_s.upcase} #{url} "
+      begin
+        b.send(*args)
+        puts
+      rescue RuntimeError => e
+        puts "#{e} (#{e.class})"
+      end
+    }
+    puts
+  }
+end
+
+puts "DONE"

data/lib/mudbug.rb

@@ -0,0 +1,127 @@
+require 'rest-client'
+require 'json'
+
+class Mudbug
+  def self.version
+    vpath = File.join(File.dirname(__FILE__), '..', 'VERSION')
+    File.read(vpath).chomp
+  end
+
+  class StatusCodeError < RuntimeError; end
+
+  # 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 },
+    },
+  }
+
+  # map our internal symbols to HTTP content types
+  # assign q scores based on the parameter order
+  # construct the right side of the Accept: header
+  #
+  def self.accept_header(*types)
+    types.map.with_index { |t, i|
+      type = CONTENT[t] ? CONTENT[t][:type] : "application/#{t.to_s.downcase}"
+      quality = "q=" << sprintf("%0.1f", 1.0 - i*0.1)
+      i == 0 ? type : [type, quality].join(';')
+    }.join(', ')
+  end
+
+  # do stuff based on response's Content-type
+  #
+  def self.process(resp, accept = nil)
+    case resp.code
+    when 200..299
+      # 2xx, OK
+    else
+      warn "proceeding with HTTP Status Code #{resp.code}"
+    end
+
+    # do you even Content-type, bro?
+    ct = resp.headers[:content_type]
+    unless ct
+      warn "process NOOP -- no response Content-type"
+      return resp.body
+    end
+
+    # warn if we got Content-type we didn't ask for
+    ct, charset = ct.split(';').map { |s| s.strip }
+    warn "Asked for #{accept} but got #{ct}" if accept and !accept.include?(ct)
+
+    # process the response for known content types
+    CONTENT.each { |sym, hsh|
+      return hsh[:proc].call(resp.body) if ct == hsh[:type]
+    }
+
+    warn "process NOOP -- unrecognized Content-type: #{ct}"
+    return response.body
+  end
+
+  attr_reader :options
+  attr_accessor :host
+
+  def initialize(host, options = nil)
+    @host = host
+    @options = options || {}
+    accept :json, :html, :text
+  end
+
+  # Writes the Accept: header for you
+  # e.g.
+  # accept :json, :html  # Accept: application/json, text/html
+  # accept nil           # remove Accept: header
+  # Now adds q-scores automatically based on order
+  # Note: the hard work is done by the class method
+  #
+  def accept(*types)
+    types = types.first if types.first.is_a?(Array)
+    @options[:headers] ||= {}
+    return @options[:headers].delete(:accept) if types.first.nil?
+    @options[:headers][:accept] = self.class.accept_header(*types)
+  end
+
+  # use this method directly if you want finer-grained request and response
+  # handling
+  #
+  def resource(path, options = {})
+    path = "/#{path}" unless path[0,1] == '/'
+    url = "http://#{@host}#{path}"
+    options = @options.merge(options)
+
+    RestClient::Resource.new(url, options)
+  end
+
+  # no payload
+  #
+  [:get, :delete].each { |meth|
+    define_method(meth) { |path, options = {}|
+      res = resource(path, options)
+      self.class.process(res.send(meth), res.headers[:accept])
+    }
+  }
+
+  # (JSON) payload required
+  # if payload is a String, then assume it's already JSON
+  # otherwise apply #to_json to payload automatically.  Quack.
+  #
+  [:post, :put].each { |meth|
+    define_method(meth) { |path, payload, options={}|
+      payload = payload.to_json unless payload.is_a?(String)
+      res = resource(path, options)
+      self.class.process(res.send(meth, payload), res.heads[:accept])
+    }
+  }
+end

data/rakefile.rb

@@ -0,0 +1,122 @@
+require 'rubygems/package_task'
+
+PROJECT_ROOT = File.dirname(__FILE__)
+PROJECT_NAME = File.split(PROJECT_ROOT).last
+VERSION_FILE = File.join(PROJECT_ROOT, 'VERSION')
+MANIFEST_FILE = File.join(PROJECT_ROOT, 'MANIFEST.txt')
+
+def version
+  File.read(VERSION_FILE).chomp
+end
+
+def manifest
+  File.readlines(MANIFEST_FILE).map { |line| line.chomp }
+end
+
+task :version do
+  puts "#{PROJECT_NAME} #{version}"
+end
+
+task :manifest do
+  puts manifest.join("\n")
+end
+
+task :build do
+  spec = Gem::Specification.new do |s|
+    # Static assignments
+    s.name        = "mudbug"
+    s.summary     = "A thin layer over rest-client that returns JSON objects"
+    s.description = <<EOF
+* GET, POST, PUT, and DELETE JSON payloads
+* Simple Accept headers with automatic q-score weighting
+* Understand and fall back to basic Content-types if application/json is not available
+* Fine-grained response handling using Mudbug#resource
+* A winning combination of guts, salad, sea legs, and torpor will propel our fair spaceship beyond the pale shadow of any doubt that the inxorable result of our redoubled efforts will counfound any chance at snatching defeat from the jars of whiskey.
+EOF
+    s.authors     = ["Rick Hull"]
+    s.email       = "rick@cloudscaling.com"
+    s.homepage    = "http://github.com/rickhull/mudbug"
+    s.licenses    = ['LGPL']
+
+    # Dynamic assignments
+    s.files       = manifest
+    s.version     = version
+    s.date        = Time.now.strftime("%Y-%m-%d")
+
+    s.add_runtime_dependency  "rest-client", ["~> 1"]
+    s.add_runtime_dependency         "json", ["~> 1"]
+    s.add_development_dependency "minitest", [">= 0"]
+    s.add_development_dependency     "rake", [">= 0"]
+  end
+
+  # we're definining the task at runtime, rather than requiretime
+  # so that the gemspec will reflect any version bumping since requiretime
+  #
+  Gem::PackageTask.new(spec).define
+  Rake::Task["package"].invoke
+end
+
+# e.g. bump(:minor, '1.2.3') #=> '1.3.0'
+# only works for integers delimited by periods (dots)
+#
+def bump(position, version)
+  pos = [:major, :minor, :patch, :build].index(position) || position
+  places = version.split('.')
+  raise "bad position: #{pos} (for version #{version})" unless places[pos]
+  places.map.with_index { |place, i|
+    if i < pos
+      place
+    elsif i == pos
+      place.to_i + 1
+    else
+      0
+    end
+  }.join('.')
+end
+
+def write_version new_version
+  File.open(VERSION_FILE, 'w') { |f| f.write(new_version) }
+end
+
+[:major, :minor, :patch, :build].each { |v|
+  task "bump_#{v}" do
+    old_version = version
+    new_version = bump(v, old_version)
+    puts "bumping #{old_version}  to #{new_version}"
+    write_version new_version
+  end
+}
+task :bump => [:bump_patch]
+
+task :tag do
+  tagname = "v#{version}"
+  sh "git tag -a #{tagname} -m 'auto-tagged #{tagname} by Rake'"
+end
+
+task :release => [:bump_build, :tag, :publish]
+task :release_patch => [:bump_patch, :tag, :publish]
+task :release_minor => [:bump_minor, :tag, :publish]
+task :release_major => [:bump_major, :tag, :publish]
+
+task :verify_publish_credentials do
+  creds = '~/.gem/credentials'
+  fp = File.expand_path(creds)
+  raise "#{creds} does not exist" unless File.exists?(fp)
+  raise "can't read #{creds}" unless File.readable?(fp)
+end
+
+task :publish => [:verify_publish_credentials, :build] do
+  fragment = "-#{version}.gem"
+  pkg_dir = File.join(PROJECT_ROOT, 'pkg')
+  Dir.chdir(pkg_dir) {
+    candidates = Dir.glob "*#{fragment}"
+    case candidates.length
+    when 0
+      raise "could not find .gem matching #{fragment}"
+    when 1
+      sh "gem push #{candidates.first}"
+    else
+      raise "multiple candidates found matching #{fragment}"
+    end
+  }
+end

data/test/mudbug.rb

@@ -0,0 +1,10 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+
+require_relative '../lib/mudbug'
+
+describe "Rick" do
+  it "should be embarassed" do
+    flunk
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: mudbug
+version: !ruby/object:Gem::Version
+  version: 0.4.5.1
+  prerelease: 
+platform: ruby
+authors:
+- Rick Hull
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-04 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'
+- !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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: ! '* GET, POST, PUT, and DELETE JSON payloads
+
+  * Simple Accept headers with automatic q-score weighting
+
+  * Understand and fall back to basic Content-types if application/json is not available
+
+  * Fine-grained response handling using Mudbug#resource
+
+  * A winning combination of guts, salad, sea legs, and torpor will propel our fair
+  spaceship beyond the pale shadow of any doubt that the inxorable result of our redoubled
+  efforts will counfound any chance at snatching defeat from the jars of whiskey.
+
+'
+email: rick@cloudscaling.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- VERSION
+- rakefile.rb
+- MANIFEST.txt
+- LICENSE.txt
+- lib/mudbug.rb
+- test/mudbug.rb
+- examples/accepts_and_methods.rb
+homepage: http://github.com/rickhull/mudbug
+licenses:
+- LGPL
+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: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A thin layer over rest-client that returns JSON objects
+test_files: []