rquest 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 127855095b8f26517572c264644b4fcdafd9b927
+  data.tar.gz: 53e386a7b6697c74d5b1cf970cd1f3e1b6da3195
+SHA512:
+  metadata.gz: 692f78864dcb4bbdfe0d32b6a0436e006a2fc83b904e224b1c73ad59555e6df3dd439988c24102711c75e90263e38df4ea1f46ae98dfe66f3dc15625cbad183d
+  data.tar.gz: 84104f4df5815766e12d21035f752a99c753586bc356162618696d8ade49cfbff59364a2dec7571e1342d45e0604806462427ef16bb6732c8f87f551d22a4b73

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,18 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+	# watch /lib/ files
+	watch(%r{^lib/(.+).rb$}) do |m|
+		"spec/#{m[1]}_spec.rb"
+	end
+
+	watch(%r{^lib/rquest/(.+).rb$}) do |m|
+		"spec/#{m[1]}_spec.rb"
+	end
+
+	# watch /spec/ files
+	watch(%r{^spec/(.+).rb$}) do |m|
+		"spec/#{m[1]}.rb"
+	end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 The Tyrel Corporation
+
+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,85 @@
+# Rquest
+
+A helper library to easily define restful web requests in ruby.
+
+Bassically I am tiered of constantly relooking up NET HTTP blog post to try and remember how to say override the default headers or attatch a file as a multipart post request. Also there are things about the ruby request generation process I felt I could improve such as, autodetecting the need for ssl from the URI and providing a clean DSL for request definition. As well as cleaner file attatchment.
+
+RQuest makes it easy to build request and gives you full control over every aspect of the request. I modeled it after the chrome extension postman. Everything you can do with postman you can do with RQuest and it follows the same intuitive work flow.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rquest'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rquest
+
+## Simple GET Request
+
+Its basic setup involves setting the uri and action. Its send method will execute the rquest and return the body. You can access the full request object and the response time if you need them.
+
+```ruby
+rquest = RQuest.new({verb: :get, uri: "https://google.com"})
+response_body = rquest.send
+response_time = rquest.response_time
+full_request_object = rquest.response
+```
+
+You can easily combine query params with the uri and the settings hash
+
+```ruby
+rquest = RQuest.new({verb: :get, uri: "https://google.com?q=testing", q_params: {token: "foo"}})
+```
+
+This will result in a request with a URI of http://google.com?q=testing&token=foo behind the sceens
+
+## Auto SSL
+Any uri with https will set use_ssl on the request object automatically. No more.
+
+```ruby
+https.use_ssl = true
+```
+
+## Form data POST/PUT/PATCH/DELETE/OPTIONS Requests
+
+All controlled from the same settings hash with the payload key
+
+```ruby
+rquest = RQuest.new({verb: :get, uri: "https://google.com", payload: {a_field: "stuff", another_field: "more stuff"} })
+rquest.send
+```
+
+Alright the best part for last
+
+## Auto multipart forum
+
+Just pass file objects into the files key and everything will be handled for you. It will automatically switch to multipart and detect mime types!
+
+```ruby
+f1 = File.open("path/to/file.txt")
+f2 = File.open("path/to/file.jpg")
+rquest = RQuest.new({verb: :get, uri: "https://google.com", payload: {a_field: "stuff", another_field: "more stuff"}, files: {file_field_1: f1, file_field_2: f2} })
+rquest.send
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rquest/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+end
+
+task :default => :spec
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rquest"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rquest.rb

@@ -0,0 +1,38 @@
+require "rquest/version"
+require 'net/http/post/multipart'
+require 'mimemagic'
+require 'benchmark'
+require "rquest/requestor"
+
+module Rquest
+	class << self
+		def new( settings )
+			Requestor.new( settings )
+		end
+
+		def client_class_for_verb( verb, use_multipart=false )
+			v = verb.to_s.capitalize
+			unless use_multipart
+				Object.const_get("Net::HTTP::#{v}")
+			else
+				Object.const_get("Net::HTTP::#{v}::Multipart")
+			end
+		end
+	end
+end
+
+class Hash
+	def to_q_param_string
+		self.inject([]){|r,(k,v)| r.push( "#{k}=#{v}" )}.join("&")
+	end
+end
+
+class String
+	def to_q_param_hash
+		self.split("&").inject({}) do |hash, key_value|
+			key, value = key_value.split("=")
+			hash[key.to_sym] = value
+			hash
+		end
+	end
+end

data/lib/rquest/requestor.rb

@@ -0,0 +1,83 @@
+module Rquest
+	class Requestor
+		attr_reader :response, :response_time
+		def initialize( settings={} )
+			@settings = settings
+			apply_default_settings
+			@verb = settings[:verb].to_sym
+			merge_string_and_hash_params
+			@uri = URI::parse( @settings[:uri] )
+			@headers = @settings[:headers]
+			initialize_http_client
+			set_headers
+			set_body
+		end
+
+		def send
+			@response_time = Benchmark.realtime do
+				@response = @http_client.request(@http_request_client)
+			end
+			@response.body
+		end
+
+		def uri_path
+			@uri.path.empty? ? "/" : @uri.path
+		end
+
+		def apply_default_settings
+			@settings[:verb] ||= :get
+			@settings[:q_params] ||= {}
+			@settings[:headers] ||= {}
+			@settings[:payload] ||= {}
+			setup_files unless @settings[:files].nil?
+		end
+
+		def setup_files
+			old_files = @settings.delete(:files)
+			new_files = {}
+			old_files.each do |field_name, file|
+				extname = File.extname(file)
+				mime_type = (extname == "") ? "text/plain" : MimeMagic.by_extension(extname).type
+				new_files[field_name] = UploadIO.new( file, mime_type, File.basename(file) )
+			end
+			@settings[:files] = new_files
+		end
+
+		def merge_string_and_hash_params
+			url, string_params = @settings[:uri].split("?")
+			string_params ||= ""
+			hash_of_string_params = string_params.to_q_param_hash
+			final_params_hash = hash_of_string_params.merge( @settings[:q_params] )
+			@settings[:uri] = [url, final_params_hash.to_q_param_string].join("?")
+		end
+
+		def q_params
+			q = @uri.query
+			q ||= ""
+			q.to_q_param_hash
+		end
+
+		def initialize_http_client
+			@http_client = Net::HTTP.new( @uri.host, @uri.port )
+			@http_client.use_ssl = true if @uri.scheme == "https"
+			klass = Rquest::client_class_for_verb( @verb )
+			@http_request_client = klass.send(:new, uri_path)
+		end
+
+		def set_headers
+			@headers.each do |key, value|
+				@http_request_client[key.to_s] = value.to_s
+			end
+		end
+
+		def set_body
+			if @settings[:files].nil?
+				@http_request_client.set_form_data( @settings[:payload] )
+			else
+				klass = Rquest::client_class_for_verb( @verb, true )
+				multi_part_params = @settings[:payload].merge( @settings[:files] )
+				@http_request_client = klass.send(:new, @uri.path, multi_part_params)
+			end
+		end
+	end
+end

data/lib/rquest/version.rb

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

data/rquest.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rquest/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rquest"
+  spec.version       = Rquest::VERSION
+  spec.authors       = ["The Tyrel Corporation"]
+  spec.email         = ["cloud.tycorp@gmail.com"]
+
+  if spec.respond_to?(:metadata)
+  end
+
+  spec.summary       = %q{A helper library to easily define restful web requests in ruby. It wraps NET::HTTP in an intuitive work flow modeled off of the Postman Chrome extension.}
+  spec.description   = %q{RQuest makes it easy to build request and gives you full control over every aspect of the request. I modeled it after the chrome extension postman. Everything you can do with postman you can do with RQuest and it follows the same intuitive work flow.}
+  spec.homepage      = "https://github.com/thetyrelcorporation/rquest"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+	spec.add_development_dependency "rspec"
+	spec.add_development_dependency "guard"
+	spec.add_development_dependency "guard-rspec"
+	spec.add_development_dependency "multipart-post"
+	spec.add_development_dependency  "mimemagic"
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: rquest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- The Tyrel Corporation
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mimemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: RQuest makes it easy to build request and gives you full control over
+  every aspect of the request. I modeled it after the chrome extension postman. Everything
+  you can do with postman you can do with RQuest and it follows the same intuitive
+  work flow.
+email:
+- cloud.tycorp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rquest.rb
+- lib/rquest/requestor.rb
+- lib/rquest/version.rb
+- rquest.gemspec
+homepage: https://github.com/thetyrelcorporation/rquest
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: A helper library to easily define restful web requests in ruby. It wraps
+  NET::HTTP in an intuitive work flow modeled off of the Postman Chrome extension.
+test_files: []
+has_rdoc: