clavem 2.0.0 → 2.1.0

data/doc/index.html

@@ -6,7 +6,7 @@
 <title>
   File: README
   
-    &mdash; Documentation by YARD 0.8.7
+    &mdash; Documentation by YARD 0.8.7.4
   
 </title>
 
@@ -17,7 +17,7 @@
 <script type="text/javascript" charset="utf-8">
   hasFrames = window.top.frames.main ? true : false;
   relpath = '';
-  framesUrl = "frames.html#!" + escape(window.location.href);
+  framesUrl = "frames.html#!file.README.html";
 </script>
 
 
@@ -67,7 +67,9 @@
 <a href="https://gemnasium.com/ShogunPanda/clavem"><img src="https://gemnasium.com/ShogunPanda/clavem.png?travis" alt="Dependency Status" /></a>
 <a href="http://travis-ci.org/ShogunPanda/clavem"><img src="https://secure.travis-ci.org/ShogunPanda/clavem.png?branch=master" alt="Build Status" /></a>
 <a href="https://codeclimate.com/github/ShogunPanda/clavem"><img src="https://codeclimate.com/github/ShogunPanda/clavem.png" alt="Code Climate" /></a>
-<a href="https://coveralls.io/r/ShogunPanda/clavem"><img src="https://coveralls.io/repos/ShogunPanda/clavem/badge.png" alt="Coverage Status" /></a></p>
+<a href="https://coveralls.io/r/ShogunPanda/clavem"><img src="https://coveralls.io/repos/ShogunPanda/clavem/badge.png" alt="Coverage Status" /></a>
+<a href="https://bitdeli.com/free" title="Bitdeli Badge"><img src="https://d2weczhvl823v0.cloudfront.net/ShogunPanda/clavem/trend.png" alt="Bitdeli Trend" /></a>
+&lt;iframe src="http://ghbtns.com/github-btn.html?user=ShogunPanda&amp;repo=clavem&amp;type=fork&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="135" height="20"&gt;&lt;/iframe&gt;</p>
 
 <p>A local callback server for oAuth web-flow.</p>
 
@@ -90,7 +92,7 @@ require “clavem”</p>
 
 <h1 id="get-the-token">Get the token</h1>
 <p># You can also handle callback parameter by yourself.
-# url += “?oauth_callback=#authorizerauthorizer.callback_url”
+# url += “?oauth_callback=” + authorizer.callback_url
 # authorizer.authorize(url, false)
 authorizer.authorize(url)</p>
 
@@ -133,9 +135,9 @@ end
 </div></div>
 
     <div id="footer">
-  Generated on Wed Aug 21 16:17:53 2013 by
+  Generated on Sun Apr  6 15:36:21 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7 (ruby-2.0.0).
+  0.8.7.4 (ruby-2.1.0).
 </div>
 
   </body>

data/doc/js/app.js

@@ -78,7 +78,12 @@ function framesInit() {
   if (hasFrames) {
     document.body.className = 'frames';
     $('#menu .noframes a').attr('href', document.location);
-    window.top.document.title = $('html head title').text();
+    try {
+      window.top.document.title = $('html head title').text();
+    } catch(error) {
+      // some browsers will not allow this when serving from file://
+      // but we don't want to stop the world.
+    }
   }
   else {
     $('#menu .noframes a').text('frames').attr('href', framesUrl);
@@ -211,4 +216,4 @@ $(linkSummaries);
 $(keyboardShortcuts);
 $(summaryToggle);
 $(fixOutsideWorldLinks);
-$(generateTOC);
+$(generateTOC);

data/doc/top-level-namespace.html

@@ -6,7 +6,7 @@
 <title>
   Top Level Namespace
   
-    &mdash; Documentation by YARD 0.8.7
+    &mdash; Documentation by YARD 0.8.7.4
   
 </title>
 
@@ -17,7 +17,7 @@
 <script type="text/javascript" charset="utf-8">
   hasFrames = window.top.frames.main ? true : false;
   relpath = '';
-  framesUrl = "frames.html#!" + escape(window.location.href);
+  framesUrl = "frames.html#!top-level-namespace.html";
 </script>
 
 
@@ -103,9 +103,9 @@
 </div>
 
     <div id="footer">
-  Generated on Wed Aug 21 16:17:53 2013 by
+  Generated on Sun Apr  6 15:36:21 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7 (ruby-2.0.0).
+  0.8.7.4 (ruby-2.1.0).
 </div>
 
   </body>

data/lib/clavem.rb

@@ -4,10 +4,8 @@
 # Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
 #
 
-require "r18n-desktop"
 require "lazier"
-require "eventmachine"
-require "evma_httpserver"
+require "addressable/uri"
 
 require "clavem/version" if !defined?(Clavem::Version)
 require "clavem/server"

data/lib/clavem/authorizer.rb

@@ -28,7 +28,8 @@ module Clavem
   # @attribute timeout
   #   @return [Fixnum] The amount of seconds to wait for response from the remote endpoint before returning a failure. Default is `0`, which means *disabled*.
   # @attribute response_handler
-  #   @return [Proc] A Ruby block to handle response and check for success. The block must accept a querystring hash (which all values are arrays) and return a token or `nil` if the authentication was denied.
+  #   @return [Proc] A Ruby block to handle response and check for success.
+  #     The block must accept a querystring hash (which all values are arrays) and return a token or `nil` if the authentication was denied.
   # @attribute token
   #   @return [String] The token obtained by the remote endpoint.
   # @attribute status
@@ -52,7 +53,8 @@ module Clavem
     # @param host [String] The host address on which listening for replies. Default is `localhost`.
     # @param port [Fixnum] The port on which listening for replies. Default is `7772`.
     # @param command [String|nil] The command to open the URL. `{{URL}}` is replaced with the specified URL. Default is `open "{{URL}}"`.
-    # @param timeout [Fixnum] The amount of seconds to wait for response from the remote endpoint before returning a failure. Default is `0`, which means *disabled*.
+    # @param timeout [Fixnum] The amount of seconds to wait for response from the remote endpoint before returning a failure.
+    #   Default is `0`, which means *disabled*.
     # @param response_handler [Proc] A Ruby block to handle response and check for success. See {#response_handler}.
     # @param force [Boolean] If to force recreation of the instance.
     # @return [Authorizer] The unique (singleton) instance of the authorizer.
@@ -67,7 +69,8 @@ module Clavem
     # @param host [String] The host address on which listening for replies. Default is `localhost`.
     # @param port [Fixnum] The port on which listening for replies. Default is `7772`.
     # @param command [String|nil] The command to open the URL. `{{URL}}` is replaced with the specified URL. Default is `open "{{URL}}"`.
-    # @param timeout [Fixnum] The amount of seconds to wait for response from the remote endpoint before returning a failure. Default is `0`, which means *disabled*.
+    # @param timeout [Fixnum] The amount of seconds to wait for response from the remote endpoint before returning a failure.
+    #   Default is `0`, which means *disabled*.
     # @param response_handler [Proc] A Ruby block to handle response and check for success. See {#response_handler}.
     # @return [Authorizer] The new authorizer.
     def initialize(host = "localhost", port = 7772, command = nil, timeout = 0, &response_handler)
@@ -90,8 +93,10 @@ module Clavem
     # @param append_callback [Boolean] If to append the callback to the url using `oauth_callback` parameter.
     # @return [Boolean] `true` if authorization succeeded, `false` otherwise.
     def authorize(url, append_callback = true)
-      url += "#{url.index("?") ? "&" : "?"}oauth_callback=#{callback_url}" if append_callback
-      @url = url
+      url = Addressable::URI.parse(url)
+      url.query_values = (url.query_values || {}).merge({oauth_callback: callback_url}) if append_callback
+
+      @url = url.to_s
       @status = :waiting
       @token = nil
 
@@ -110,13 +115,13 @@ module Clavem
     #
     # @return [String] The callback_url for this authorizer.
     def callback_url
-      "http://#{host}:#{port}/"
+      Addressable::URI.new(scheme: "http", host: host, port: port).to_s
     end
 
     # Returns the response handler for the authorizer.
     #
     def response_handler
-      @response_handler || Proc.new {|querystring| (querystring || {}).fetch("oauth_token", []).ensure_array.first }
+      @response_handler || Proc.new {|querystring| (querystring || {})["oauth_token"] }
     end
 
     # Set the current locale for messages.
@@ -177,21 +182,15 @@ module Clavem
 
       # Processes the authentication response.
       def process_response
-        # Signal handling
-        ["INT", "TERM", "KILL"].each {|signal|
-          Kernel.trap(signal){ EM.stop }
-        }
-
-        # Start eventmachine
-        EM.run do
-          EM.add_timer(@timeout){ handle_timeout } if @timeout > 0
-          EM.start_server(@host, @port, Clavem::Server, self)
-        end
-      end
+        begin
+          server = Thread.new do
+            Clavem::Server.new(self)
+          end
 
-      # Handle timeouts.
-      def handle_timeout
-        EM.stop
+          @timeout > 0 ? server.join(@timeout) : server.join
+        rescue Interrupt
+          raise Clavem::Exceptions::Failure.new(@i18n.errors.interrupted)
+        end
       end
   end
 end

data/lib/clavem/server.rb

@@ -6,17 +6,17 @@
 
 module Clavem
   # A class to handle oAuth callbacks on the browser via HTTP.
-  class Server < EM::Connection
-    include EM::HttpServer
-
+  class Server
     # The template to send to the browser.
     TEMPLATE = <<-EOTEMPLATE
 <html>
   <head>
     <title>Clavem</title>
-    <script type="text/javascript"> close_window = (function(){ window.open("", "_self", ""); window.close(); })(); </script>
+    <script type="text/javascript" charset="utf8">(function(){ window.open("", "_self", ""); window.close(); })();</script>
   </head>
-  <body><h4>%s</h4></body>
+  <body>
+    %s
+  </body>
 </html>
     EOTEMPLATE
 
@@ -25,12 +25,25 @@ module Clavem
     # @param authorizer [Authorizer] The authorizer of this server.
     def initialize(authorizer)
       @authorizer = authorizer
+
+      process_http_request
     end
 
     # Save the token and sends a response back to the user.
     def process_http_request
+      server = create_server
+      socket = server.accept
+
+      # Get the request
+      request = socket.gets.gsub(/^[A-Z]+\s(.+)\sHTTP.+$/, "\\1")
+      querystring = Addressable::URI.parse(("%s%s" % [@authorizer.callback_url, request]).strip).query_values
+
+      # Send the response and close the socket
+      send_response(socket)
+
       # Handle the token
-      token = @authorizer.response_handler.call(CGI::parse(@http_query_string))
+      token = @authorizer.response_handler.call(querystring)
+
       if token then
         @authorizer.token = token
         @authorizer.status = :succeeded
@@ -38,15 +51,28 @@ module Clavem
         @authorizer.status = :denied
       end
 
-      # Build the request
-      response = EM::DelegatedHttpResponse.new(self)
-      response.status = 200
-      response.content_type("text/html")
-      response.content = TEMPLATE % [@authorizer.i18n.template]
-      response.send_response
-
-      # Stop after serving the request.
-      EM.add_timer(0.1) { EM.stop }
+      server.close
     end
+
+    private
+      # Creates the server.
+      #
+      # @return [TCPServer] The TCP server
+      def create_server
+        server = TCPServer.new(@authorizer.host, @authorizer.port)
+        server.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
+        server.setsockopt(:SOCKET, :REUSEADDR, 1)
+        server
+      end
+
+      # Sends the response to the client.
+      #
+      # @param socket [TCPSocket] The socket to the client.
+      def send_response(socket)
+        response = TEMPLATE % [@authorizer.i18n.template]
+        socket.print(["HTTP/1.1 200 OK", "Content-Type: text/html; charset=utf-8", "Content-Length: #{response.bytesize}", "Connection: close"].join("\r\n"))
+        socket.print("\r\n\r\n" + response)
+        socket.close
+      end
   end
 end

data/lib/clavem/version.rb

@@ -13,7 +13,7 @@ module Clavem
     MAJOR = 2
 
     # The minor version.
-    MINOR = 0
+    MINOR = 1
 
     # The patch version.
     PATCH = 0

data/locales/en.yml

@@ -9,12 +9,14 @@
     errors:
       response_failure: "Cannot handle response: %1"
       open_failure: "Cannot open URL %1: %2"
+      interrupted: "Authentication interrupted by the user."
     template: "This window will close in few moments. If this doesn't happens you can close it by yourself, this won't cause any problem."
     application_description: "A local callback server for oAuth web-flow."
     application_help_url: "The URL where to send the user to start authorization."
     application_help_host: "The host address on which listening for the reply. Default is localhost."
     application_help_port: "The port on which listening for the reply. Default is 777`."
     application_help_command: "The command to open the URL. {{URL} is replaced with the specified URL. Default is 'open \"{{URL}}\"'."
+    application_help_no_callback: "Do not append the \"oauth_callback\" parameter to the URL."
     application_help_timeout: "The amount of seconds to wait for response from the remote endpoint before returning a failure."
     application_help_quiet: "Do not print anything but errors."
     application_meta_port: "PORT"
@@ -22,4 +24,4 @@
     cli_running: "Clavem is waiting for a response at URL {mark=bright}%1{/mark} ..."
     cli_obtaining: "Obtaining token from URL {mark=bright}%1{/mark}."
     cli_succeeded: "Obtained access token is: {mark=bright}%1{/mark}"
-    cli_failed: "No access token obtained."
+    cli_failed: "No access token obtained."

data/locales/it.yml

@@ -9,12 +9,14 @@
     errors:
       response_failure: "Impossibile gestire una risposta: %1"
       open_failure: "Impossible aprire l'URL %1: %2"
+      interrupted: "Autenticazione interrotta dall'utente."
     template: "Questa finestra si chiuderà in pochi momenti. Se non succede puoi chiuderla da solo, ciò non causerà alcun problema."
     application_description: "Un server callback locale per il web-flow oAuth."
     application_help_url: "L'URL dove mandare l'utente per iniziare l'autenticazione."
     application_help_host: "L'indirizzo host dove rimanere in ascolto per la risposta. Il default è localhost."
     application_help_port: "La porta dove rimanere in ascolto per la risposta. La porta di default è 7772."
     application_help_command: "Il comando per aprire l'URL. {{URL}} è sostituito con l'URL specificato. Il default è 'open \"{{URL}}\"'."
+    application_help_no_callback: "Non aggiungere il parametro \"oauth_callback\" all'URL."
     application_help_timeout: "Il numero di secondi da attendere per la risposta dall'endpoint remoto prima di ritornare un fallimento."
     application_help_quiet: "Non mostrare nulla tranne che gli errori."
     application_meta_port: "PORTA"

data/spec/clavem/authorizer_spec.rb

@@ -78,17 +78,17 @@ describe Clavem::Authorizer do
 
       expect(Kernel).to receive(:system).with("open \"URL?oauth_callback=CALLBACK\"")
       subject.authorize("URL")
-      expect(Kernel).to receive(:system).with("open \"URL?&oauth_callback=CALLBACK\"")
-      subject.authorize("URL?")
+      expect(Kernel).to receive(:system).with("open \"URL?a=b&oauth_callback=CALLBACK\"")
+      subject.authorize("URL?a=b")
       subject.command = "browse {{URL}}"
-      expect(Kernel).to receive(:system).with("browse URL?oauth_callback=CALLBACK")
-      subject.authorize("URL")
+      expect(Kernel).to receive(:system).with("browse URL")
+      subject.authorize("URL", false)
     end
 
     it "should start a server" do
       allow(subject).to receive(:perform_request)
       subject.timeout = 1
-      expect(EM).to receive(:start_server).with(subject.host, subject.port, Clavem::Server, subject)
+      expect(Clavem::Server).to receive(:new).with(subject)
       subject.authorize("URL")
     end
 
@@ -109,18 +109,25 @@ describe Clavem::Authorizer do
     end
 
     it "should handle timeouts" do
+      allow(Kernel).to receive(:system)
       allow(subject).to receive(:perform_request)
 
       subject.timeout = 1
-      expect(EM).to receive(:stop).and_call_original
       subject.authorize("URL")
     end
+
+    it "should handle interruptions" do
+      allow(Kernel).to receive(:system)
+      allow(Clavem::Server).to receive(:new).and_raise(Interrupt)
+      expect { subject.authorize("URL") }.to raise_error(Clavem::Exceptions::Failure)
+      expect(subject.failed?).to be_true
+    end
   end
 
   describe "#callback_url" do
     it "should return the correct callback" do
-      expect(::Clavem::Authorizer.new.callback_url).to eq("http://localhost:7772/")
-      expect(::Clavem::Authorizer.new("10.0.0.1", "80").callback_url).to eq("http://10.0.0.1:80/")
+      expect(::Clavem::Authorizer.new.callback_url).to eq("http://localhost:7772")
+      expect(::Clavem::Authorizer.new("10.0.0.1", "80").callback_url).to eq("http://10.0.0.1:80")
     end
   end
 
@@ -128,7 +135,6 @@ describe Clavem::Authorizer do
     it "should return the token as default implementation" do
       expect(subject.response_handler.call(nil)).to be_nil
       expect(subject.response_handler.call({"oauth_token" => "TOKEN"})).to eq("TOKEN")
-      expect(subject.response_handler.call({"oauth_token" => ["TOKEN 1", "TOKEN 2"]})).to eq("TOKEN 1")
     end
 
     it "should work as a getter" do

data/spec/clavem/server_spec.rb

@@ -9,30 +9,39 @@ require "spec_helper"
 describe Clavem::Server do
   let(:authorizer) { Clavem::Authorizer.new }
 
-  around(:each) do |example|
-    EM.run do
-      EM.start_server("localhost", 7772, Clavem::Server, authorizer)
-      EM.add_timer(0.1) do
-        @request = EventMachine::HttpRequest.new("http://localhost:7772/?#{example.metadata[:query]}").get
-        @request.callback { example.call }
-      end
-    end
-  end
-
   describe "#initialize", query: "oauth_token=TOKEN" do
     it "should save the authorizer" do
-      server = Clavem::Server.new("UNUSED", authorizer)
+      allow_any_instance_of(Clavem::Server).to receive(:process_http_request)
+      server = Clavem::Server.new(authorizer)
       expect(server.instance_variable_get(:@authorizer)).to be(authorizer)
     end
   end
 
   describe "#process_http_request" do
+    before(:each) do
+      allow(Kernel).to receive(:system)
+
+      socket = double(TCPSocket)
+      expect(socket).to receive(:gets).and_return("GET /?#{example.metadata[:query]} HTTP/1.1")
+      allow(socket).to receive(:print)
+      allow(socket).to receive(:close)
+
+      server = double(TCPServer)
+      expect(server).to receive(:accept).and_return(socket)
+      allow(server).to receive(:close)
+
+      allow_any_instance_of(Clavem::Server).to receive(:create_server).and_return(server)
+    end
+
     it "should save the token and report success", query: "oauth_token=TOKEN" do
+      authorizer.authorize("URL")
       expect(authorizer.succeeded?).to be_true
       expect(authorizer.token).to eq("TOKEN")
     end
 
-    it "should save the token and report failure", query: "notoken=TOKEN" do
+    it "should report failure", query: "notoken=TOKEN" do
+      authorizer.authorize("URL")
+
       expect(authorizer.denied?).to be_true
       expect(authorizer.token).to eq(nil)
     end

data/spec/spec_helper.rb

@@ -7,7 +7,6 @@
 require "rubygems"
 require "bundler/setup"
 require "clavem"
-require "em-http-request"
 
 RSpec.configure do |config|
   config.expect_with :rspec do |c|