httpalooza 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 374ae028d634e1fafe7d735fb4ee2c06b1a82ba0
-  data.tar.gz: 1bd12e35c2ddfee45dbf1e67613240f97aad7f01
+  metadata.gz: 015fd22c665878d26dcb1513a726bbef678dd5a0
+  data.tar.gz: 96d5562f0f346c9b08b2459d07e93058caa34609
 SHA512:
-  metadata.gz: 4e9bb8b68aed888612724d4fe23874da1ed9d7b28a80a529fbfaef653a65b903514f89bf215501ee10138107fbdd63ad962f7d00b2107d830910d6df3c804765
-  data.tar.gz: ac36cf9de5924cb4b2bd4354d330f8ced3dcbd60ab0bff2169179bbbb244a706fb46661754fae3bb6391e3a352ce02bf5116904719d701a2886e1c8238cca861
+  metadata.gz: 5dacbfe38f88bbf6ceb9b725784a76b7fcaf04a1581e9dc7cf08a439babb29b3e541352292519e8e8dfd8d55e20b5fb717dad9a102479c45fe0dcc1954f7feef
+  data.tar.gz: 8360c36ddf32eb93dd13cd43e33bd70c74cc387a011ec01bb7a351bb382e13fc699ec6581d061efe244aaab4017cb82c04fc60beff115bd6f07a4246927c49cb

data/.travis.yml

@@ -1,3 +1,7 @@
 language: ruby
 rvm:
+  - 2.2.2
   - 2.0.0
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-2.1.1

data/Rakefile

@@ -1,2 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/httpalooza.rb

@@ -19,6 +19,9 @@ module HTTPalooza
   class Error < StandardError; end
   class NotImplementedError < Error; end
 
+  # Starts an HTTPalooza session.
+  #
+  # @return [HTTPalooza::Lineup] the new Lineup
   def self.invite
     Lineup.new
   end

data/lib/httpalooza/api.rb

@@ -1,21 +1,56 @@
 module HTTPalooza
   module API
+    # Peform an HTTP GET request with the assembled Lineup.
+    #
+    # @param [String] url the URL to request.
+    # options [Hash] the request options
+    # @option options [Hash] :headers request headers
+    # @option options [Hash] :params URL parameters
+    # @option options [String] :payload the request body
     def get(url, options = {}, &block)
       run! Request.new(url, :get, options.slice(:headers, :params, :payload), &block)
     end
 
+    # Peform an HTTP POST request with the assembled Lineup.
+    #
+    # @param [String] url the URL to request.
+    # options [Hash] the request options
+    # @option options [Hash] :headers request headers
+    # @option options [Hash] :params URL parameters
+    # @option options [String] :payload the request body
     def post(url, options = {}, &block)
       run! Request.new(url, :post, options.slice(:headers, :params, :payload), &block)
     end
 
+    # Peform an HTTP PUT request with the assembled Lineup.
+    #
+    # @param [String] url the URL to request.
+    # options [Hash] the request options
+    # @option options [Hash] :headers request headers
+    # @option options [Hash] :params URL parameters
+    # @option options [String] :payload the request body
     def put(url, options = {}, &block)
       run! Request.new(url, :put, options.slice(:headers, :params, :payload), &block)
     end
 
+    # Peform an HTTP DELETE request with the assembled Lineup.
+    #
+    # @param [String] url the URL to request.
+    # options [Hash] the request options
+    # @option options [Hash] :headers request headers
+    # @option options [Hash] :params URL parameters
+    # @option options [String] :payload the request body
     def delete(url, options = {}, &block)
       run! Request.new(url, :delete, options.slice(:headers, :params, :payload), &block)
     end
 
+    # Peform an HTTP HEAD request with the assembled Lineup.
+    #
+    # @param [String] url the URL to request.
+    # options [Hash] the request options
+    # @option options [Hash] :headers request headers
+    # @option options [Hash] :params URL parameters
+    # @option options [String] :payload the request body
     def head(url, options = {}, &block)
       run! Request.new(url, :head, options.slice(:headers, :params, :payload), &block)
     end

data/lib/httpalooza/lineup.rb

@@ -1,4 +1,16 @@
 module HTTPalooza
+  # A Lineup assembles a set of Players to perform HTTP requests.
+  #
+  # @example Perform a request with curb
+  #   lineup = HTTPalooza::Lineup.new.with_curb
+  #   response = lineup.get('http://httpbin.org/')
+  #   response[:curb] #=> Get the response from Curb
+  #
+  # @example Performing multiple requests
+  #   lineup = HTTPalooza::Lineup.new.with_curb.and_unirest
+  #   lineup.get('http://httpbin.org/')
+  #   response[:curb] #=> Get the response from Curb
+  #   response[:unirest] #=> Get the response from Unirest
   class Lineup
     include API
 
@@ -17,6 +29,7 @@ module HTTPalooza
       end
     end
 
+    # Return a Lineup with all available Players
     def everyone
       players.merge(Players.available)
       self

data/lib/httpalooza/players.rb

@@ -3,6 +3,9 @@ module HTTPalooza
     class << self
       attr_reader :available
 
+      # @!attribute [r] available
+      #   @return [Set] the available Players
+
       def add(klass)
         @available ||= Set.new
 

data/lib/httpalooza/players/base.rb

@@ -1,9 +1,18 @@
 module HTTPalooza
   module Players
+    # Superclass for Player implementations
+    # @abstract
     class Base
       class << self
         attr_reader :name, :dependencies
 
+        # Create a new player and require any depenencies.
+        #
+        # @example
+        #   introducing! :selenium, %w[ selenium-webdriver ]
+        #
+        # @param [Symbol] name the name of the player
+        # @param [Array] dependencies a list of dependencies require in order to use this player
         def introducing!(name, dependencies = [])
           @name = name.to_sym
           @dependencies = dependencies

data/lib/httpalooza/request.rb

@@ -1,9 +1,28 @@
 module HTTPalooza
+  # Request presents a standard interface for describing an HTTP request that Players can translate into the underlying library's representation.
   class Request
     STANDARD_METHODS = [:get, :post, :put, :patch, :delete, :options, :head]
 
     attr_reader :url, :method, :params, :payload, :headers
+    # @!attribute [r] url
+    #    @return [String] the URL to request
+    # @!attribute [r] method
+    #   @return [Symbol] the HTTP method
+    # @!attribute [r] params
+    #   @return [Hash] the URL parameters
+    # @!attribute [r] payload
+    #   @return [String] the request body
+    # @!attribute [r] headers
+    #   @return [Hash] the request headers
 
+    # Instantiate a Request.
+    #
+    # @param [String] url the URL to request
+    # @param [Symbol] method the HTTP method
+    # @param [Hash] options additional options
+    # @option options [Hash] :params the URL parameters
+    # @option options [Hash] :headers the request headers
+    # @option options [String] :payload the request payload
     def initialize(url, method, options = {})
       @url = url
       @method = method
@@ -14,6 +33,7 @@ module HTTPalooza
       normalize_url!
     end
 
+    # @return [Boolean] whether or not the URL is SSL
     def ssl?
       !!(url.to_s =~ /^https/)
     end

data/lib/httpalooza/response.rb

@@ -1,18 +1,29 @@
 module HTTPalooza
+  # Response represents a unified interface for the various Player's responses.
   class Response
     AwesomeResponseCodes = 200..299
 
+    # @!attribute code
+    #   @return [Fixnum] the HTTP status code
+    # @!attribute body
+    #   @return [String] the HTTP response body
     attr_accessor :code, :body
 
+    # Create a new Response.
+    #
+    # @param [Fixnum] code the HTTP status code. Should be between 100 and 599.
+    # @param [String] body the HTTP response body.
     def initialize(code, body)
       @code = code.to_i
       @body = body
     end
 
+    # @return [Boolean] whether or not the response code was awesome.
     def awesome?
       AwesomeResponseCodes.include?(code)
     end
 
+    # @return [Boolean] whether or not the response code was not awesome.
     def not_awesome?
       !awesome?
     end

data/lib/httpalooza/version.rb

@@ -1,3 +1,3 @@
 module HTTPalooza
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: httpalooza
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Quin Hoxie