fire-and-forget 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# FireAndForget
+
+
+
+## 0.1.0 First version

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fire-and-forget.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matt Aimonetti
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,80 @@
+# Fire and Forget HTTP client
+
+Using this gem is probably a very bad idea in at least 98% of the cases
+I can think of. Think of a it as a HTTP client that doesn't care about
+the response and doesn't care about basically anything besides sending
+its payload to a server. An alternative name for this client is
+"scumbag-HTTP-client".
+
+So, unless you are really sure you want to use this lib, you're probably
+better off looking at the hundreds other Ruby HTTP libraries.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fire-and-forget', :require => 'fire/forget'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fire-and-forget
+
+## Usage
+
+```ruby
+FAF.post "http://example.com", {:foo => 'bar'}, {"X-Custom" => true}
+```
+In the example above, the request will be sent as a JSON request and the
+body (a Ruby hash) will be converted to json if `to_json` is available on
+the object (otherwise `to_s` will be used).
+
+```ruby
+FAF.post "http://example.com", "{\"language\": {\"created_at\": \"2010/11/23 19:47:05 +0000\",\"updated_at\": \"2010/11/23 19:47:05 +0000\",\"active\": true, \"code\": \"en\", \"id\":37}}"
+```
+
+Would send the request passing the JSON string as the body, strings
+aren't converted when passed as the request body.
+
+Sometimes, you might want to debug the response or potentially slow down
+the application code. You can pass a block to do that:
+
+```ruby
+FAF.post "http://example.com", {:foo => 'bar'} do |socket|
+  sleep(0.02)
+end
+```
+
+or 
+
+```ruby
+FAF.post "http://example.com", {:foo => 'bar'} do |socket|
+  while output = socket.gets
+    print output
+  end
+end
+```
+
+This will not "forget" about the response, but instead wait for data to
+come down the socket so we can print.
+
+Currently, FAF only supports basic options, no
+authentication unless you pass all the details via the headers.
+
+Once the request is sent, the socket is closed which might or might not
+please the server receiving the request (you might want to use a
+block/sleep
+to slow down the closing of the socket if your proxy/cache doesn't like
+that FAF closes the connection right away.
+
+
+## Contributing
+
+1. Fork it
+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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/fire-and-forget.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fire/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fire-and-forget"
+  spec.version       = FireAndForget::VERSION
+  spec.authors       = ["Matt Aimonetti"]
+  spec.email         = ["mattaimonetti@gmail.com"]
+  spec.description   = %q{Allows developers to fire HTTP requests and not worry about the response (only the initial connection is verified).}
+  spec.summary       = %q{For whenever you need to push data to an endpoint but don't care about the response (or its status).}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", ">= 1.2"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_runtime_dependency "json"
+end

data/lib/fire/forget.rb

@@ -0,0 +1,34 @@
+require "fire/version"
+require 'fire/request'
+
+module FireAndForget
+  def self.get(url, headers={}, &block)
+    Request.new(:method => :get, :url => url, :headers => headers, :callback => block).execute
+  end
+
+  def self.post(url, payload, headers={}, &block)
+    Request.new(:method => :post, :url => url, :payload => payload, :headers => headers, :callback => block).execute
+  end
+
+  def self.patch(url, payload, headers={}, &block)
+    Request.new(:method => :patch, :url => url, :payload => payload, :headers => headers, :callback => block).execute
+  end
+
+  def self.put(url, payload, headers={}, &block)
+    Request.new(:method => :put, :url => url, :payload => payload, :headers => headers, :callback => block).execute
+  end
+
+  def self.delete(url, headers={}, &block)
+    Request.new(:method => :delete, :url => url, :headers => headers, :callback => block).execute
+  end
+
+  def self.head(url, headers={}, &block)
+    Request.new(:method => :head, :url => url, :headers => headers, :callback => block).execute
+  end
+
+  def self.options(url, headers={}, &block)
+    Request.new(:method => :options, :url => url, :headers => headers, :callback => block).execute
+  end
+end
+
+FAF = FireAndForget

data/lib/fire/request.rb

@@ -0,0 +1,96 @@
+require 'cgi'
+require 'socket'
+require 'uri'
+begin
+  require 'json' 
+rescue LoadError
+  puts "The json lib wasn't available, payload objects won't be automatically converted to json."
+end
+
+module FireAndForget
+  class Request
+    attr_reader :method, :url, :content_type, :payload, :headers, :callback
+
+    def initialize(args)
+      @method = args[:method] || raise(ArgumentError.new("must pass :method"))
+      @headers = args[:headers] || {}
+      raise ArgumentError, ":headers should be nil or a Hash" unless (@headers.respond_to?(:keys) && @headers.respond_to?(:each))
+      @content_type = args[:content_type] || headers['Content-Type'] || "application/json"
+      @headers = {'Content-Type' => @content_type}.merge(headers)
+      if args[:url]
+        @url = args[:url]
+      else
+        raise ArgumentError, "must pass :url"
+      end
+      @callback = args[:callback]
+      @payload = args[:payload]
+      @args = args
+    end
+
+    def execute
+      uri = URI.parse(url)
+      req = []
+      req << "#{method.respond_to?(:upcase) ? method.upcase : method.to_s.upcase} #{uri.request_uri} HTTP/1.0"
+      if uri.port != 80
+        req << "Host: #{uri.host}:#{uri.port}"
+      else
+        req << "Host: #{uri.host}"
+      end
+      req << "User-Agent: FAF #{FireAndForget::VERSION}"
+      req << "Accept: */*"
+      processed_headers.each do |part|
+        req << part
+      end
+      req << "Content-Length: #{body_length}"
+
+      socket = TCPSocket.open(uri.host, uri.port)
+      req.each do |req_part|
+        socket.puts(req_part + "\r\n")
+      end
+      #puts (req << body).inspect
+      socket.puts "\r\n"
+      socket.puts body
+      # For debugging purposes you can pass a block to read the socket or sleep for a bit.
+      # You can also set a callback when creating the instance and it will be called passing the socket.
+      if callback
+        callback.call(socket)
+      elsif block_given?
+        yield(socket)
+      end
+      ensure
+      socket.close if socket
+    end
+
+    def body
+      if @body
+        @body
+      else
+        if payload.nil?
+          @body = ""
+        elsif payload.is_a?(String)
+          @body = payload
+        elsif payload.respond_to?(:to_json)
+          @body = payload.to_json
+        else
+          @body = ""
+        end
+      end
+    end
+
+    def body_length
+      body ? body.bytesize : 0
+    end
+
+    def processed_headers
+      chunks = []
+      headers.each do |key, value|
+        if key.is_a? Symbol
+          key = key.to_s.split(/_/).map { |w| w.capitalize }.join('-')
+        end
+        chunks << "#{key}: #{value.to_s}"
+      end
+      chunks
+    end
+
+  end
+end

data/lib/fire/version.rb

@@ -0,0 +1,3 @@
+module FireAndForget
+  VERSION = "0.1.0"
+end

data/spec/request_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe FireAndForget::Request do
+  describe "#initialize" do
+
+    def new_req(args)
+      FireAndForget::Request.new(args)
+    end
+
+    def min_valid_args
+      {:method => :get, :url => "http://matt.aimonetti.net/"}
+    end
+
+    it "requires a method argument" do
+     lambda{ new_req({}) }.should raise_error(ArgumentError, "must pass :method")
+    end
+
+    it "requires a url argument" do
+     lambda{ new_req(:method => :get) }.should raise_error(ArgumentError, "must pass :url")
+    end
+
+    it "requires both a method and url" do
+      lambda{ new_req(:method => :get, :url => "http://google.com") }.should_not raise_error
+    end
+
+    it "takes custom headers" do
+      req = new_req(min_valid_args.merge({:headers => {"X-Request-Id" => 42}}))
+      req.headers["X-Request-Id"].should eq(42)
+    end
+
+    it "has default headers" do
+      req = new_req(min_valid_args)
+      req.headers.should_not be_nil
+      req.headers.should_not be_empty
+    end
+
+    describe "content type" do
+
+      it "defaults to json" do
+        req = new_req(min_valid_args)
+        req.headers['Content-Type'].should eq("application/json")
+      end
+
+       it "can be set via argument" do
+        req = new_req(min_valid_args.merge(:content_type => 'text/xml'))
+        req.content_type.should eq('text/xml')
+        req.headers['Content-Type'].should eq('text/xml')
+       end
+
+       it "can be set via headers" do
+        req = new_req(min_valid_args.merge(:headers => {'Content-Type' => 'text/xml'}))
+        req.content_type.should eq('text/xml')
+        req.headers['Content-Type'].should eq('text/xml')
+      end
+
+    end
+
+    describe "body" do
+
+      it "is extracted from the payload as-is, if passed as a string" do
+        text = "this is a test"
+        req = new_req(min_valid_args.merge(:payload => text))
+        req.body.should eq(text)
+      end
+
+      it "becomes an empty string if passed as nil" do
+        req = new_req(min_valid_args)
+        req.body.should eq("")
+      end
+
+      it "is converted to json if it's not a string or nil" do
+        payload = {:foo => :bar}
+        req = new_req(min_valid_args.merge(:payload => payload))
+        req.body.should eq(payload.to_json)
+      end
+    end
+
+    describe "converted headers" do
+      it "are represented as an array of strings" do
+        req = new_req(min_valid_args)
+        req.processed_headers.each do |header_line|
+          header_line.is_a?(String).should be_true
+          header_line.should match(/.*?:\s.+/)
+        end
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$: << File.expand_path(File.dirname(__FILE__), '../lib')
+require 'fire/forget'

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: fire-and-forget
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Matt Aimonetti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows developers to fire HTTP requests and not worry about the response
+  (only the initial connection is verified).
+email:
+- mattaimonetti@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fire-and-forget.gemspec
+- lib/fire/forget.rb
+- lib/fire/request.rb
+- lib/fire/version.rb
+- spec/request_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3818509771490622433
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3818509771490622433
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: For whenever you need to push data to an endpoint but don't care about the
+  response (or its status).
+test_files:
+- spec/request_spec.rb
+- spec/spec_helper.rb