hyperquest 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 84e1f1d4d8832534efa9ad0c13c85beda3283f91
+  data.tar.gz: d695b4dd30b7db44ab381342273707166b79be1b
+SHA512:
+  metadata.gz: 3a7f6b23f300be6dc65b27dac9cf2718c84d26f2210d513c401d2ec24e11a52ef7f9594ea8d5bbd45bda4678f9daae1fcbe5dd8cf2a85bf67258c7f3d96d86c2
+  data.tar.gz: 989f0afd8adf03a94a14f8929dffea91c3137f58fa46be7e40478ad3e47c5d87565a0094fe4d990c06431e49ac4ef31660d8e89d5c25ac9914df01a13bc4f57a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+hyperquest.h
+hyperquest.so

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.2.1
+  - 2.2.2
+  - 2.2.3

data/.yardopts

@@ -0,0 +1,2 @@
+--markup-provider=redcarpet
+--markup=markdown

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.1.1 / 2015-09-05
+
+Changed return string to CString (instead of GoString) fixing [#1](https://github.com/berfarah/hyperquest/issues/1)

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hyperquest.gemspec
+gemspec
+
+group :test do
+  gem "rspec"
+  gem "simplecov", "~> 0.10", :require => false
+  gem "redcarpet"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Bernardo Farah
+
+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,60 @@
+# Hyperquest
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hyperquest'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hyperquest
+
+## Usage
+
+```ruby
+require "hyperquest"
+
+h = Hyperquest.get([url1, url2, url3])
+# => Hash<url1 => Response, url2 => Response, url3 => Response>
+
+h = Hyperquest.head([url1, url2, url3])
+# => Hash<url1 => Response, url2 => Response, url3 => Response>
+
+h[url1].uri
+# => "http://example.com"
+h[url1].content_length
+# => 2435
+h[url1].content_type
+# => "text/html; charset UTF-8"
+h[url1].body
+# => "<HTML..."
+h[url1].status
+# => 200
+h[url1].error
+# => ""
+h[url1].success?
+# => true
+h[url1].failed?
+# => false
+```
+
+## Development
+
+This gem is powered by [Go 1.5](https://golang.org/dl/)'s functionality of creating shared C libraries.
+
+If you're on a mac, you can also install Go with [homebrew](http://brew.sh): `brew install go`. Please remember to `bundle` first!
+
+## Contributing
+
+1. Fork it ( https://github.com/berfarah/hyperquest/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,12 @@
+require "bundler/gem_tasks"
+
+task :xbuild do
+  # [:darwin, :linux].each do |os|
+  #   sh "GOOS=#{os} GOARCH=amd64 go build -buildmode=c-shared -o ext/hyperquest-#{os}X86_64.so ext/hyperquest.go"
+  # end
+  sh "go build -buildmode=c-shared -o ext/hyperquest.so ext/hyperquest.go"
+end
+
+task :bench do
+  ruby "-Ilib examples/bench.rb"
+end

data/examples/bench.rb

@@ -0,0 +1,34 @@
+require "hyperquest"
+require "benchmark"
+
+urls = %w(
+  http://google.com
+  http://bernardo.me
+  http://ruby-lang.org
+  http://golang.org
+  http://news.ycombinator.com
+  http://atom.io
+  http://sublimetext.com
+  http://kapeli.com/dash
+  http://github.com
+)
+
+Benchmark.bmbm do |r|
+  [:head, :get].each do |m|
+    r.report("1 request") do
+      Hyperquest.public_send(m, urls.shuffle.take(1))
+    end
+
+    r.report("3 request") do
+      Hyperquest.public_send(m, urls.shuffle.take(3))
+    end
+
+    r.report("5 request") do
+      Hyperquest.public_send(m, urls.shuffle.take(5))
+    end
+
+    r.report("9 request") do
+      Hyperquest.public_send(m, urls.shuffle.take(9))
+    end
+  end
+end

data/examples/usage.rb

@@ -0,0 +1,24 @@
+require "hyperquest"
+
+h = Hyperquest.get([url1, url2, url3])
+# => Hash<url1 => Response, url2 => Response, url3 => Response>
+
+h = Hyperquest.head([url1, url2, url3])
+# => Hash<url1 => Response, url2 => Response, url3 => Response>
+
+h[url1].uri
+# => "http://example.com"
+h[url1].content_length
+# => 2435
+h[url1].content_type
+# => "text/html; charset UTF-8"
+h[url1].body
+# => "<HTML..."
+h[url1].status
+# => 200
+h[url1].error
+# => ""
+h[url1].success?
+# => true
+h[url1].failed?
+# => false

data/ext/Makefile

@@ -0,0 +1,18 @@
+check := $(shell go version)
+build:
+ifeq ($(OS),Windows_NT)
+	shell echo "Windows is currently not supported"
+	shell exit /b 1
+else
+ifneq (,$(findstring go1.5,$(check)))
+	@echo Running go 1.5
+	go build -buildmode=c-shared -o hyperquest.so hyperquest.go
+else
+	@echo Can't compile natively, instead downloading binary from github.
+	curl -L https://github.com/berfarah/hyperquest/releases/download/1.0.0/hyperquest-`uname -s`-`uname -m`.tar.gz | tar zx
+endif
+endif
+
+# These are required to install successfully
+clean:
+install:

data/ext/extconf.rb

@@ -0,0 +1,3 @@
+# Run our makefile since we're not using mkmf
+puts "Installing extension..."
+system("make")

data/ext/hyperquest.go

@@ -0,0 +1,81 @@
+package main
+
+import (
+	"C"
+	"encoding/json"
+	"io/ioutil"
+	"net/http"
+)
+
+type Response struct {
+	URI           string `json:"uri"`
+	ContentType   string `json:"content_type"`
+	ContentLength int64  `json:"content_length"`
+	Body          string `json:"body"`
+	Status        int    `json:"status"`
+	Err           string `json:"error"`
+}
+
+func request(data *C.char, req func(string) (*http.Response, error)) *C.char {
+	uris := []string{}
+	err := json.Unmarshal([]byte(C.GoString(data)), &uris)
+	if err != nil {
+		return C.CString(err.Error())
+	}
+
+	if len(uris) == 0 || (len(uris) == 1 && uris[0] == "") {
+		return C.CString("[]")
+	}
+
+	c := make(chan *Response)
+	for _, uri := range uris {
+		go func(u string) {
+			resp, err := req(u)
+			c <- readRequest(u, resp, err)
+		}(uri)
+	}
+
+	result := []*Response{}
+	for i := 0; i < len(uris); i++ {
+		result = append(result, <-c)
+	}
+
+	b, err := json.Marshal(result)
+	if err != nil {
+		return C.CString("{}")
+	}
+
+	return C.CString(string(b))
+}
+
+func readRequest(uri string, r *http.Response, err error) *Response {
+	if err != nil {
+		return &Response{URI: uri, Status: r.StatusCode, Err: err.Error()}
+	}
+	defer r.Body.Close()
+
+	body, err := ioutil.ReadAll(r.Body)
+	if err != nil {
+		return &Response{URI: uri, Status: r.StatusCode, Err: err.Error()}
+	}
+
+	return &Response{
+		URI:           uri,
+		ContentType:   r.Header.Get("Content-Type"),
+		ContentLength: r.ContentLength,
+		Body:          string(body),
+		Status:        r.StatusCode,
+	}
+}
+
+//export get
+func get(data *C.char) *C.char {
+	return request(data, http.Get)
+}
+
+//export head
+func head(data *C.char) *C.char {
+	return request(data, http.Head)
+}
+
+func main() {}

data/hyperquest.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "hyperquest"
+  spec.version       = "1.0.2"
+  spec.authors       = ["Bernardo Farah"]
+  spec.email         = ["ber@bernardo.me"]
+
+  spec.summary       = "A gem for asynchronous get requests, written in Go"
+  spec.description   = "Hyperquest allows you to do an unlimited amount of "\
+                       "HEAD or GET requests via a native extension."
+  spec.homepage      = "https://github.com/berfarah/hyperquest"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  spec.require_paths = ["lib"]
+  spec.extensions    = %w(ext/extconf.rb)
+
+  spec.add_dependency "ffi", "~> 1.9"
+  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/hyperquest.rb

@@ -0,0 +1,22 @@
+require "ffi"
+require "json"
+require "hyperquest/request"
+
+# {Hyperquest} is a library for doing asynchronous GET and HEAD requests.
+module Hyperquest
+  # Asynchronous get requests
+  #
+  # @param [Array[String]] uri URI to be requested
+  # @return [Hash<String => Response>] See {Response}
+  def self.get(uri)
+    Request.open(:get, uri)
+  end
+
+  # Asynchronous head request
+  #
+  # @param [Array[String]] uri URI to be requested
+  # @return [Hash<String => Response>] See {Response}
+  def self.head(uri)
+    Request.open(:head, uri)
+  end
+end

data/lib/hyperquest/request.rb

@@ -0,0 +1,29 @@
+require "json"
+require "hyperquest/response"
+
+module Hyperquest
+  # Dispatcher to Golang
+  #
+  # @api private
+  module Request
+    extend FFI::Library
+
+    ffi_lib File.expand_path("../../../ext/hyperquest.so", __FILE__)
+
+    # Does asynchronous get requests via a go extension
+    attach_function :get, [:string], :string
+    attach_function :head, [:string], :string
+
+    # Open a type of request via our extension
+    #
+    # @param [Symbol] type Valid options are get and head
+    # @param [Array<String>] uri Uri to be requested
+    # @return [Array<Response>] {Response}
+    def self.open(type, uri)
+      response = public_send(type, Array(uri).to_json)
+      JSON.parse(response).each_with_object({}) do |e, hash|
+        hash[e["uri"]] = Response.new(e)
+      end
+    end
+  end
+end

data/lib/hyperquest/response.rb

@@ -0,0 +1,48 @@
+require "ostruct"
+require "forwardable"
+
+module Hyperquest
+  # Hyperquest::Response is a wrapper for responses from hyperquest.go
+  class Response < OpenStruct
+    extend Forwardable
+
+    # Instantiated by {Request} - see {Request.open}
+    #
+    # @api private
+    # @param [Hash] hash Parsed JSON
+    # @return [Response]
+    def initialize(hash)
+      @response = OpenStruct.new(hash).freeze
+    end
+
+    # @!group Attributes
+    # @!attribute [r] uri
+    #   @return [String] Request url
+    # @!attribute [r] content_length
+    #   @return [Fixnum]
+    # @!attribute [r] content_type
+    #   @return [String]
+    # @!attribute [r] body
+    #   @return [String]
+    # @!attribute [r] status
+    #   @return [Fixnum]
+    # @!attribute [r] error
+    #   @return [String]
+    def_delegators :@response,
+                   :uri, :content_length, :content_type,
+                   :body, :status, :error
+
+    # Returns true if error is empty
+    # @return [Boolean]
+    def success?
+      error.empty?
+    end
+
+    # Returns true if error is not empty
+    # @return [Boolean]
+    def failed?
+      !success?
+    end
+    # @!endgroup
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: hyperquest
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Bernardo Farah
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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'
+description: Hyperquest allows you to do an unlimited amount of HEAD or GET requests
+  via a native extension.
+email:
+- ber@bernardo.me
+executables: []
+extensions:
+- ext/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/bench.rb
+- examples/usage.rb
+- ext/Makefile
+- ext/extconf.rb
+- ext/hyperquest.go
+- hyperquest.gemspec
+- lib/hyperquest.rb
+- lib/hyperquest/request.rb
+- lib/hyperquest/response.rb
+homepage: https://github.com/berfarah/hyperquest
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A gem for asynchronous get requests, written in Go
+test_files: []
+has_rdoc: