hoick 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a45c81b44157ce9e833bda8f0b4a0d8822043f0
-  data.tar.gz: 5dd7e6c5da5a8ed72684f9db9481c06e728112ef
+  metadata.gz: 0003e566cb04c2c3704564ddfbbbf643f4574322
+  data.tar.gz: efbd89eb6c6b7fbe3a2fd12bd6d8f32faf0340b9
 SHA512:
-  metadata.gz: 16036cba8cd39cda4dd6e7e43ca3cea2dedd7e6efbccc1627978f71f5b93e80c35e495229a34a1d4b0afb89919c257072af195684673e1564a8b0225171a4f64
-  data.tar.gz: 655d76ada1d8c7b125f201a6d06e679d430181cf96489b439b4650570ce0c9740cbd3beb0f75da11663ea669121494da24b1cc58c897dadedbc73f7c450c9909
+  metadata.gz: d58fdcddc91db51bc7d06be0407af0df00f376bf4daa695a72c2db36fd81b5e42b9cddb19dc516f6326052a83d21a84fde7461b1b4de1b458c2611eed9a731d5
+  data.tar.gz: 222734633bae1b63c7e9e1ffe9079d4d76b43a2612e7c480c52691755b449e752b324383d566c8efac2154ce22dbade0d71a6b538ec36ec2ac054ceb3fc41749

data/README.md

@@ -1,24 +1,32 @@
 # Hoick
 
-TODO: Write a gem description
+Hoick is a command-line HTTP client.  It's intended mainly as a tool for testing RESTful APIs, but you can use for something else, if you really want to.
+
+Hoick is designed to be simple yet useful, and to play nicely in a Unix command pipeline.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Hoick is distributed as a Ruby gem, installable using:
 
-    gem 'hoick'
+    $ gem install hoick
 
-And then execute:
+## Usage
 
-    $ bundle
+Hoick has subcommands modelled on HTTP verbs.  
 
-Or install it yourself as:
+### GET
 
-    $ gem install hoick
+To fetch a resource, use GET.  The response body will be printed to STDOUT. 
 
-## Usage
+If you're interested in response headers too, add the "`-h`" flag.  Add the "`--follow`" flag if you wish to follow redirects.
+
+### PUT and POST
+
+The "PUT" subcommand uploads data to a specified URL.  By default, the payload is read from STDIN, but you can specify the "`-F`" option to read it from a file, instead.
+
+Hoick guesses a "Content-Type" from the file-name.  If a type cannot be guessed, or if the payload is sourced from STDIN, binary data ("application/octet-stream") is assumed.  Either way, the default can be overridden with "`-T`" (which can be either a file extension, or a full MIME-type string).
 
-TODO: Write usage instructions here
+The "POST" subcommand works in a similar way.
 
 ## Contributing
 
@@ -26,4 +34,4 @@ TODO: Write usage instructions here
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Submit a Pull Request

data/hoick.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Hoick::VERSION
   spec.authors       = ["Mike Williams"]
   spec.email         = ["mdub@dogbiscuit.org"]
-  spec.description   = %q{A command-line HTTP client}
   spec.summary       = %q{A command-line HTTP client}
+  spec.description   = File.read("README.md").split("\n\n")[1]
   spec.homepage      = "https://github.com/mdub/hoick"
   spec.license       = "MIT"
 

data/lib/hoick/command.rb

@@ -31,28 +31,43 @@ module Hoick
 
     option ["--debug"], :flag, "debug"
 
+    def follow_redirects?
+      false
+    end
+
     subcommand ["get", "GET"], "HTTP GET" do
 
-      option ["--follow"], :flag, "follow redirects"
+      option ["--follow"], :flag, "follow redirects", :attribute_name => :follow_redirects
 
       declare_url_parameter
 
       def execute
-        get_with_redirects do |response|
-          display_response(response)
-        end
+        get(full_url, &method(:display_response))
       end
 
-      def get_with_redirects(&callback)
-        with_http_connection do |http, uri|
-          http.request_get(uri.request_uri) do |response|
-            if follow? && response.kind_of?(Net::HTTPRedirection)
-              get_with_redirects(response['location'], &callback)
-            else
-              callback.call(response)
-            end
+      private
+
+      def get(uri, &callback)
+        http_request("GET", uri) do |response|
+          if follow_redirects? && response.kind_of?(Net::HTTPRedirection)
+            raise Redirected, response['location']
           end
+          callback.call(response)
+        end
+      rescue Redirected => e
+        uri = URI(e.location)
+        retry
+      end
+
+      class Redirected < StandardError
+
+        def initialize(location)
+          @location = location
+          super("Redirected to #{location}")
         end
+
+        attr_reader :location
+
       end
 
     end
@@ -98,15 +113,7 @@ module Hoick
       declare_url_parameter
 
       def execute
-        content = payload
-        with_http_connection do |http, uri|
-          post = Net::HTTP::Post.new(uri.request_uri)
-          post["Content-Type"] = content_type
-          post.body = content
-          http.request(post) do |response|
-            display_response(response)
-          end
-        end
+        http_request("POST", full_url, payload, content_type, &method(:display_response))
       end
 
     end
@@ -118,22 +125,14 @@ module Hoick
       declare_url_parameter
 
       def execute
-        content = payload
-        with_http_connection do |http, uri|
-          put = Net::HTTP::Put.new(uri.request_uri)
-          put["Content-Type"] = content_type
-          put.body = content
-          http.request(put) do |response|
-            display_response(response)
-          end
-        end
+        http_request("PUT", full_url, payload, content_type, &method(:display_response))
       end
 
     end
 
     private
 
-    def uri
+    def full_url
       if base_url
         base_url + url
       else
@@ -141,11 +140,37 @@ module Hoick
       end
     end
 
-    def with_http_connection
+    def http_request(method, uri, content = nil, content_type = nil, &callback)
+      request = build_request(method, uri, content, content_type)
+      with_http_connection(uri) do |http|
+        http.request(request) do |response|
+          if follow_redirects? && response.kind_of?(Net::HTTPRedirection)
+            raise Redirected, response['location']
+          end
+          callback.call(response)
+        end
+      end
+    rescue Redirected => e
+      uri = URI(e.location)
+      retry
+    end
+
+    def build_request(method, uri, content, content_type)
+      request_class = Net::HTTP.const_get(method.to_s.capitalize)
+      request = request_class.new(uri.request_uri)
+      if content
+        request["Content-Type"] = content_type
+        request.body = content
+      end
+      request
+    end
+
+    def with_http_connection(uri)
       http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = (uri.scheme == "https")
       http.set_debug_output($stderr) if debug?
       http.start do
-        yield http, uri
+        yield http
       end
     end
 

data/lib/hoick/version.rb

@@ -1,3 +1,3 @@
 module Hoick
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hoick
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Mike Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-01 00:00:00.000000000 Z
+date: 2013-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -24,7 +24,9 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.22'
-description: A command-line HTTP client
+description: Hoick is a command-line HTTP client.  It's intended mainly as a tool
+  for testing RESTful APIs, but you can use for something else, if you really want
+  to.
 email:
 - mdub@dogbiscuit.org
 executables: