Merge pull request #1 from ably-forks/create-ably-fork

Create an Ably fork of the library
ably-forks · Apr 26, 2024 · c0362b0 · c0362b0
2 parents a94d6ed + 8e3ecd4
commit c0362b0
Show file tree

Hide file tree

Showing 43 changed files with 1,336 additions and 1,291 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -9,19 +9,11 @@ jobs:
     name: "RSpec / Ruby ${{ matrix.ruby }}"
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
-        ruby:
-          [
-            "2.3",
-            "2.4",
-            "2.5",
-            "2.6",
-            "2.7",
-            "3.0",
-            "3.1",
-            "3.2"
-          ]
+        ruby: ["2.3", "2.4", "2.5", "2.6", "2.7", "3.0", "3.1", "3.2", "3.3"]
     steps:
+      - run: sudo apt-get install libcurl4-openssl-dev
       - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
@@ -32,8 +24,9 @@ jobs:
     name: "RSpec / Ruby 2.2"
     runs-on: ubuntu-20.04
     steps:
+      - run: sudo apt-get install libcurl4-openssl-dev
       - uses: actions/checkout@v4
-        uses: ruby/setup-ruby@v1
+      - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.2
           bundler-cache: true

diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2011 Ilya Grigorik
+
+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.
diff --git a/README.md b/README.md
@@ -1,7 +1,9 @@
 # EM-HTTP-Request 
 
-[![Gem Version](https://badge.fury.io/rb/em-http-request.svg)](http://rubygems.org/gems/em-http-request)
-[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/igrigorik/em-http-request/ci.yml)](https://github.com/igrigorik/em-http-request/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/ably-em-http-request.svg)](http://rubygems.org/gems/ably-em-http-request)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/ably-forks/em-http-request/ci.yml)](https://github.com/ably-forks/em-http-request/actions/workflows/ci.yml)
+
+**Note:** This is Ably’s fork of https://github.com/igrigorik/em-http-request. We created it to fix a TLS-related issue in the original library, which seems to be no longer maintained. This fork exists to be used inside our [ably-ruby SDK](https://github.com/ably/ably-ruby). We have only made the changes required to be able to distribute this library as a separate gem; in particular, most of the documentation still refers to the original library. The constant names used in this fork have been changed so as not to clash with the original library.
 
 Async (EventMachine) HTTP client, with support for:
 
@@ -19,7 +21,7 @@ Async (EventMachine) HTTP client, with support for:
 
 ## Getting started
 
-    gem install em-http-request
+    gem install ably-em-http-request
 
 - Introductory [screencast](http://everburning.com/news/eventmachine-screencast-em-http-request)
 - [Issuing GET/POST/etc requests](https://github.com/igrigorik/em-http-request/wiki/Issuing-Requests)

diff --git a/em-http-request.gemspec → ably-em-http-request.gemspec b/em-http-request.gemspec → ably-em-http-request.gemspec
@@ -3,17 +3,16 @@ $:.push File.expand_path('../lib', __FILE__)
 require 'em-http/version'
 
 Gem::Specification.new do |s|
-  s.name        = 'em-http-request'
-  s.version     = EventMachine::HttpRequest::VERSION
+  s.name        = 'ably-em-http-request'
+  s.version     = EventMachine::AblyHttpRequest::HttpRequest::VERSION
 
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Ilya Grigorik"]
-  s.email       = ['ilya@igvita.com']
-  s.homepage    = 'http://github.com/igrigorik/em-http-request'
+  s.email       = ['lawrence.forooghian@ably.com', 'lewis@lmars.net', 'matt@ably.io']
+  s.homepage    = 'https://github.com/ably-forks/em-http-request'
   s.summary     = 'EventMachine based, async HTTP Request client'
   s.description = s.summary
   s.license     = 'MIT'
-  s.rubyforge_project = 'em-http-request'
 
   s.add_dependency 'addressable', '>= 2.3.4'
   s.add_dependency 'cookiejar', '!= 0.3.1'

diff --git a/benchmarks/clients.rb b/benchmarks/clients.rb
@@ -30,7 +30,7 @@
         error = 0
 
         n.times do
-          http = EventMachine::HttpRequest.new(url).get
+          http = EventMachine::AblyHttpRequest::HttpRequest.new(url).get
 
           http.callback {
             count += 1
@@ -57,7 +57,7 @@
         count = 0
         error = 0
 
-        conn = EventMachine::HttpRequest.new(url)
+        conn = EventMachine::AblyHttpRequest::HttpRequest.new(url)
 
         n.times do
           http = conn.get :keepalive => true

diff --git a/benchmarks/em-excon.rb b/benchmarks/em-excon.rb
@@ -21,7 +21,7 @@
         error = 0
         n.times do
           EM.next_tick do
-            http = EventMachine::HttpRequest.new(url, :connect_timeout => 1).get
+            http = EventMachine::AblyHttpRequest::HttpRequest.new(url, :connect_timeout => 1).get
 
             http.callback {
               count += 1
@@ -48,7 +48,7 @@
       EventMachine.run {
         count = 0
         error = 0
-        conn = EventMachine::HttpRequest.new(url)
+        conn = EventMachine::AblyHttpRequest::HttpRequest.new(url)
 
         n.times do
           http = conn.get :keepalive => true

diff --git a/examples/digest_auth/client.rb b/examples/digest_auth/client.rb
@@ -10,12 +10,12 @@
 
 EM.run do
 
-  conn_handshake = EM::HttpRequest.new('http://localhost:3000')
+  conn_handshake = EM::AblyHttpRequest::HttpRequest.new('http://localhost:3000')
   http_handshake = conn_handshake.get
 
   http_handshake.callback do
-    conn = EM::HttpRequest.new('http://localhost:3000')
-    conn.use EM::Middleware::DigestAuth, http_handshake.response_header['WWW_AUTHENTICATE'], digest_config
+    conn = EM::AblyHttpRequest::HttpRequest.new('http://localhost:3000')
+    conn.use EM::AblyHttpRequest::Middleware::DigestAuth, http_handshake.response_header['WWW_AUTHENTICATE'], digest_config
     http = conn.get
     http.callback do
       puts http.response

diff --git a/examples/fetch.rb b/examples/fetch.rb
@@ -12,7 +12,7 @@
 
 EM.run do
   urls.each do |url|
-    http = EM::HttpRequest.new(url).get
+    http = EM::AblyHttpRequest::HttpRequest.new(url).get
     http.callback {
       puts "#{url}\n#{http.response_header.status} - #{http.response.length} bytes\n"
       puts http.response

diff --git a/examples/fibered-http.rb b/examples/fibered-http.rb
@@ -9,7 +9,7 @@
 
 def async_fetch(url)
   f = Fiber.current
-  http = EventMachine::HttpRequest.new(url, :connect_timeout => 10, :inactivity_timeout => 20).get
+  http = EventMachine::AblyHttpRequest::HttpRequest.new(url, :connect_timeout => 10, :inactivity_timeout => 20).get
 
   http.callback { f.resume(http) }
   http.errback  { f.resume(http) }

diff --git a/examples/multi.rb b/examples/multi.rb
@@ -4,15 +4,15 @@
 require 'em-http'
 
 EventMachine.run {
-  multi = EventMachine::MultiRequest.new
+  multi = EventMachine::AblyHttpRequest::MultiRequest.new
 
   reqs = [
     'http://google.com/',
     'http://google.ca:81/'
   ]
 
   reqs.each_with_index do |url, idx|
-    http = EventMachine::HttpRequest.new(url, :connect_timeout => 1)
+    http = EventMachine::AblyHttpRequest::HttpRequest.new(url, :connect_timeout => 1)
     req = http.get
     multi.add idx, req
   end

diff --git a/examples/oauth-tweet.rb b/examples/oauth-tweet.rb
@@ -15,11 +15,11 @@
 
 EM.run do
   # automatically parse the JSON response into a Ruby object
-  EventMachine::HttpRequest.use EventMachine::Middleware::JSONResponse
+  EventMachine::AblyHttpRequest::HttpRequest.use EventMachine::AblyHttpRequest::Middleware::JSONResponse
 
   # sign the request with OAuth credentials
-  conn = EventMachine::HttpRequest.new('http://api.twitter.com/1/statuses/home_timeline.json')
-  conn.use EventMachine::Middleware::OAuth, OAuthConfig
+  conn = EventMachine::AblyHttpRequest::HttpRequest.new('http://api.twitter.com/1/statuses/home_timeline.json')
+  conn.use EventMachine::AblyHttpRequest::Middleware::OAuth, OAuthConfig
 
   http = conn.get
   http.callback do

diff --git a/examples/socks5.rb b/examples/socks5.rb
@@ -7,7 +7,7 @@
   # ssh -D 8000 some_remote_machine
 
   connection_options = {:proxy => {:host => '127.0.0.1', :port => 8000, :type => :socks5}}
-  http = EM::HttpRequest.new('http://igvita.com/', connection_options).get :redirects => 2
+  http = EM::AblyHttpRequest::HttpRequest.new('http://igvita.com/', connection_options).get :redirects => 2
 
   http.callback {
     puts "#{http.response_header.status} - #{http.response.length} bytes\n"