clavem 2.1.0 → 2.2.0

data/doc/top-level-namespace.html

@@ -6,7 +6,7 @@
 <title>
   Top Level Namespace
   
-    &mdash; Documentation by YARD 0.8.7.4
+    &mdash; Documentation by YARD 0.8.7.6
   
 </title>
 
@@ -103,9 +103,9 @@
 </div>
 
     <div id="footer">
-  Generated on Sun Apr  6 15:36:21 2014 by
+  Generated on Wed Mar 30 10:47:20 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.4 (ruby-2.1.0).
+  0.8.7.6 (ruby-2.3.0).
 </div>
 
   </body>

data/lib/clavem.rb

@@ -4,9 +4,11 @@
 # Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
 #
 
-require "lazier"
 require "addressable/uri"
+require "socket"
+require "lazier"
+require "bovem/i18n"
 
-require "clavem/version" if !defined?(Clavem::Version)
+require "clavem/version" unless defined?(Clavem::Version)
 require "clavem/server"
-require "clavem/authorizer"
+require "clavem/authorizer"

data/lib/clavem/authorizer.rb

@@ -34,10 +34,9 @@ module Clavem
   #   @return [String] The token obtained by the remote endpoint.
   # @attribute status
   #   @return [Symbol] The status of the request. Can be `:succeeded`, `:denied`, `:failed` and `:waiting`.
-  # @attribute :i18n
-  #   @return [R18N::Translation] A localizer object.
+  # @attribute [r] :i18n
+  #   @return [Bovem::I18n] A localizer object.
   class Authorizer
-    include R18n::Helpers
     attr_accessor :url
     attr_accessor :host
     attr_accessor :port
@@ -46,7 +45,7 @@ module Clavem
     attr_accessor :response_handler
     attr_accessor :token
     attr_accessor :status
-    attr_accessor :i18n
+    attr_reader :i18n
 
     # Returns a unique (singleton) instance of the authorizer.
     #
@@ -58,9 +57,9 @@ module Clavem
     # @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.
-    def self.instance(host = "localhost", port = 7772, command = nil, timeout = 0, force = false, &response_handler)
+    def self.instance(host: "localhost", port: 7772, command: nil, timeout: 0, force: false, &response_handler)
       @instance = nil if force
-      @instance ||= Clavem::Authorizer.new(host, port, command, timeout, &response_handler)
+      @instance ||= Clavem::Authorizer.new(host: host, port: port, command: command, timeout: timeout, &response_handler)
       @instance
     end
 
@@ -73,8 +72,8 @@ module Clavem
     #   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)
-      @i18n = self.localize
+    def initialize(host: "localhost", port: 7772, command: nil, timeout: 0, &response_handler)
+      @i18n = Bovem::I18n.new(root: "clavem.errors", path: ::Pathname.new(::File.dirname(__FILE__)).to_s + "/../../locales/")
       @host = host.ensure_string
       @port = port.to_integer
       @command = command.ensure_string
@@ -105,7 +104,7 @@ module Clavem
         process_response
       rescue => e
         @status = :failed
-        raise Clavem::Exceptions::Failure.new(@i18n.errors.response_failure(e.to_s))
+        raise(Clavem::Exceptions::Failure, @i18n.response_failure(e.to_s))
       end
 
       succeeded?
@@ -121,16 +120,7 @@ module Clavem
     # Returns the response handler for the authorizer.
     #
     def response_handler
-      @response_handler || Proc.new {|querystring| (querystring || {})["oauth_token"] }
-    end
-
-    # Set the current locale for messages.
-    #
-    # @param locale [String] The new locale. Default is the current system locale.
-    # @return [R18n::Translation] The new translations object.
-    def localize(locale = nil)
-      @i18n_locales_path ||= ::File.absolute_path(::Pathname.new(::File.dirname(__FILE__)).to_s + "/../../locales/")
-      R18n::I18n.new([locale || :en, ENV["LANG"], R18n::I18n.system_locale].compact, @i18n_locales_path).t.clavem
+      @response_handler || ->(querystring) { (querystring || {})["oauth_token"] }
     end
 
     # Checks if authentication succeeded.
@@ -162,35 +152,32 @@ module Clavem
     end
 
     private
-      # sanitize_arguments
-      def sanitize_arguments
-        @host = "localhost" if @host.blank?
-        @port = 7772 if @port.to_integer < 1
-        @command = "open \"{{URL}}\"" if @command.blank?
-        @timeout = 0 if @timeout < 0
-      end
 
-      # Performs the authentication request.
-      def perform_request
-        # Open the oAuth endpoint into the browser
-        begin
-          Kernel.system(@command.gsub("{{URL}}", @url.ensure_string))
-        rescue => e
-          raise Clavem::Exceptions::Failure.new(@i18n.errors.open_failure(@url.ensure_string, e.to_s))
-        end
-      end
+    # :nodoc:
+    def sanitize_arguments
+      @host = "localhost" if @host.blank?
+      @port = 7772 if @port.to_integer < 1
+      @command = "open \"{{URL}}\"" if @command.blank?
+      @timeout = 0 if @timeout < 0
+    end
+
+    # :nodoc:
+    def perform_request
+      # Open the oAuth endpoint into the browser
+      Kernel.system(@command.gsub("{{URL}}", @url.ensure_string))
+    rescue => e
+      raise(Clavem::Exceptions::Failure, @i18n.open_failure(@url.ensure_string, e.to_s))
+    end
 
-      # Processes the authentication response.
-      def process_response
-        begin
-          server = Thread.new do
-            Clavem::Server.new(self)
-          end
-
-          @timeout > 0 ? server.join(@timeout) : server.join
-        rescue Interrupt
-          raise Clavem::Exceptions::Failure.new(@i18n.errors.interrupted)
-        end
+    # :nodoc:
+    def process_response
+      server = Thread.new do
+        Clavem::Server.new(self)
       end
+
+      @timeout > 0 ? server.join(@timeout) : server.join
+    rescue Interrupt
+      raise(Clavem::Exceptions::Failure, @i18n.interrupted)
+    end
   end
-end
+end

data/lib/clavem/server.rb

@@ -8,23 +8,24 @@ module Clavem
   # A class to handle oAuth callbacks on the browser via HTTP.
   class Server
     # The template to send to the browser.
-    TEMPLATE = <<-EOTEMPLATE
-<html>
-  <head>
-    <title>Clavem</title>
-    <script type="text/javascript" charset="utf8">(function(){ window.open("", "_self", ""); window.close(); })();</script>
-  </head>
-  <body>
-    %s
-  </body>
-</html>
+    TEMPLATE = <<~EOTEMPLATE
+      <html>
+        <head>
+          <title>Clavem</title>
+        </head>
+        <body>
+          %s
+        </body>
+      </html>
     EOTEMPLATE
+      .freeze
 
     # Creates a new server.
     #
     # @param authorizer [Authorizer] The authorizer of this server.
     def initialize(authorizer)
       @authorizer = authorizer
+      @i18n = Bovem::I18n.new(root: "clavem", path: ::Pathname.new(::File.dirname(__FILE__)).to_s + "/../../locales/")
 
       process_http_request
     end
@@ -44,35 +45,36 @@ module Clavem
       # Handle the token
       token = @authorizer.response_handler.call(querystring)
 
-      if token then
-        @authorizer.token = token
-        @authorizer.status = :succeeded
-      else
-        @authorizer.status = :denied
-      end
-
+      update_authorizer(token)
       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
+    # :nodoc:
+    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
+
+    # :nodoc:
+    def send_response(socket)
+      response = TEMPLATE % [@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
+
+    # :nodoc:
+    def update_authorizer(token)
+      if token
+        @authorizer.token = token
+        @authorizer.status = :succeeded
+      else
+        @authorizer.status = :denied
       end
+    end
   end
-end
+end

data/lib/clavem/version.rb

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

data/locales/en.yml

@@ -5,12 +5,13 @@
 #
 
 ---
+en:
   clavem:
     errors:
-      response_failure: "Cannot handle response: %1"
-      open_failure: "Cannot open URL %1: %2"
+      response_failure: "Cannot handle response: %s"
+      open_failure: "Cannot open URL %s: %s"
       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."
+    template: "The authentication process on the URL has ended. You can now close this window and continue in the console."
     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."
@@ -21,7 +22,7 @@
     application_help_quiet: "Do not print anything but errors."
     application_meta_port: "PORT"
     application_meta_command: "COMMAND"
-    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_running: "Clavem is waiting for a response at URL {mark=bright}%s{/mark} ..."
+    cli_obtaining: "Obtaining token from URL {mark=bright}%s{/mark}."
+    cli_succeeded: "Obtained access token is: {mark=bright}%s{/mark}"
     cli_failed: "No access token obtained."

data/locales/it.yml

@@ -5,12 +5,13 @@
 #
 
 ---
+it:
   clavem:
     errors:
-      response_failure: "Impossibile gestire una risposta: %1"
-      open_failure: "Impossible aprire l'URL %1: %2"
+      response_failure: "Impossibile gestire una risposta: %s"
+      open_failure: "Impossible aprire l'URL %s: %s"
       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."
+    template: "Il processo di autenticazione sull'URL si è concluso. Puoi ora chiudere questa finestra e continuare nel terminale."
     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."
@@ -21,7 +22,7 @@
     application_help_quiet: "Non mostrare nulla tranne che gli errori."
     application_meta_port: "PORTA"
     application_meta_command: "COMANDO"
-    cli_running: "Clavem è in attesa di una risposta all'URL {mark=bright}%1{/mark} ..."
-    cli_obtaining: "Ottengo il token dall'URL {mark=bright}%1{/mark}."
-    cli_succeeded: "Il token di accesso ottenuto è: {mark=bright}%1{/mark}"
+    cli_running: "Clavem è in attesa di una risposta all'URL {mark=bright}%s{/mark} ..."
+    cli_obtaining: "Ottengo il token dall'URL {mark=bright}%s{/mark}."
+    cli_succeeded: "Il token di accesso ottenuto è: {mark=bright}%s{/mark}"
     cli_failed: "Nessun token di accesso ottenuto."

data/spec/clavem/authorizer_spec.rb

@@ -11,20 +11,20 @@ describe Clavem::Authorizer do
 
   describe ".instance" do
     it "should call .new with the passed arguments" do
-      expect(::Clavem::Authorizer).to receive(:new).with("HOST", "PORT", "COMMAND", "TIMEOUT")
-      ::Clavem::Authorizer.instance("HOST", "PORT", "COMMAND", "TIMEOUT")
+      expect(::Clavem::Authorizer).to receive(:new).with(host: "HOST", port: "PORT", command: "COMMAND", timeout: "TIMEOUT")
+      ::Clavem::Authorizer.instance(host: "HOST", port: "PORT", command: "COMMAND", timeout: "TIMEOUT")
     end
 
     it "should return the same instance" do
       allow(::Clavem::Authorizer).to receive(:new) { Time.now }
-      authorizer = ::Clavem::Authorizer.instance("FIRST")
-      expect(::Clavem::Authorizer.instance("SECOND")).to be(authorizer)
+      authorizer = ::Clavem::Authorizer.instance(host: "FIRST")
+      expect(::Clavem::Authorizer.instance(host: "SECOND")).to be(authorizer)
     end
 
     it "should return a new instance if requested to" do
       allow(::Clavem::Authorizer).to receive(:new) { Time.now }
-      authorizer = ::Clavem::Authorizer.instance("FIRST")
-      expect(::Clavem::Authorizer.instance("HOST", "PORT", "COMMAND", "TIMEOUT", true)).not_to be(authorizer)
+      authorizer = ::Clavem::Authorizer.instance(host: "FIRST")
+      expect(::Clavem::Authorizer.instance(host: "HOST", port: "PORT", command: "COMMAND", timeout: "TIMEOUT", force: true)).not_to be(authorizer)
     end
   end
 
@@ -39,7 +39,7 @@ describe Clavem::Authorizer do
     end
 
     it "should assign arguments" do
-      authorizer = ::Clavem::Authorizer.new("HOST", 7773, "COMMAND", 2) do end
+      authorizer = ::Clavem::Authorizer.new(host: "HOST", port: 7773, command: "COMMAND", timeout: 2) do end
       expect(authorizer.host).to eq("HOST")
       expect(authorizer.port).to eq(7773)
       expect(authorizer.command).to eq("COMMAND")
@@ -48,7 +48,7 @@ describe Clavem::Authorizer do
     end
 
     it "should correct wrong arguments" do
-      authorizer = ::Clavem::Authorizer.new("IP", -10, "", -1)
+      authorizer = ::Clavem::Authorizer.new(host: "IP", port: -10, command: "", timeout: -1)
       expect(authorizer.port).to eq(7772)
       expect(authorizer.timeout).to eq(0)
     end
@@ -69,7 +69,7 @@ describe Clavem::Authorizer do
       allow(subject).to receive(:perform_request)
       allow(subject).to receive(:process_response)
       subject.authorize("URL")
-      expect(subject.waiting?).to be_true
+      expect(subject.waiting?).to be_truthy
     end
 
     it "should make a request" do
@@ -96,16 +96,16 @@ describe Clavem::Authorizer do
       allow(subject).to receive(:perform_request)
 
       allow(subject).to receive(:process_response) { subject.status = :succeeded }
-      expect(subject.authorize("URL")).to be_true
+      expect(subject.authorize("URL")).to be_truthy
 
       allow(subject).to receive(:process_response) { subject.status = :failed }
-      expect(subject.authorize("URL")).to be_false
+      expect(subject.authorize("URL")).to be_falsey
     end
 
     it "should handle errors" do
       allow(Kernel).to receive(:system).and_raise(RuntimeError.new)
       expect { subject.authorize("URL") }.to raise_error(Clavem::Exceptions::Failure)
-      expect(subject.failed?).to be_true
+      expect(subject.failed?).to be_truthy
     end
 
     it "should handle timeouts" do
@@ -120,14 +120,14 @@ describe Clavem::Authorizer 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
+      expect(subject.failed?).to be_truthy
     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(host: "10.0.0.1", port: "80").callback_url).to eq("http://10.0.0.1:80")
     end
   end
 
@@ -143,58 +143,39 @@ describe Clavem::Authorizer do
     end
   end
 
-  describe ".localize" do
-    it "should set the right locale path" do
-      expect(subject.instance_variable_get(:@i18n_locales_path)).to eq(File.absolute_path(::Pathname.new(File.dirname(__FILE__)).to_s + "/../../locales/"))
-      subject.localize
-    end
-
-    it "should set using English if called without arguments" do
-      authorizer = ::Clavem::Authorizer.new
-      expect(R18n::I18n).to receive(:new).with([:en, ENV["LANG"], R18n::I18n.system_locale].compact, File.absolute_path(::Pathname.new(File.dirname(__FILE__)).to_s + "/../../locales/")).and_call_original
-      authorizer.localize
-    end
-
-    it "should set the requested locale" do
-      authorizer = ::Clavem::Authorizer.new
-      expect(R18n::I18n).to receive(:new).with([:it, ENV["LANG"], R18n::I18n.system_locale].compact, File.absolute_path(::Pathname.new(File.dirname(__FILE__)).to_s + "/../../locales/")).and_call_original
-      authorizer.localize(:it)
-    end
-  end
-
   describe "#succeeded?" do
     it "should return the correct status" do
       subject.status = :other
-      expect(subject.succeeded?).to be_false
+      expect(subject.succeeded?).to be_falsey
       subject.status = :succeeded
-      expect(subject.succeeded?).to be_true
+      expect(subject.succeeded?).to be_truthy
     end
   end
 
   describe "#denied?" do
     it "should return the correct status" do
       subject.status = :other
-      expect(subject.denied?).to be_false
+      expect(subject.denied?).to be_falsey
       subject.status = :denied
-      expect(subject.denied?).to be_true
+      expect(subject.denied?).to be_truthy
     end
   end
 
   describe "#failed?" do
     it "should return the correct status" do
       subject.status = :other
-      expect(subject.failed?).to be_false
+      expect(subject.failed?).to be_falsey
       subject.status = :failed
-      expect(subject.failed?).to be_true
+      expect(subject.failed?).to be_truthy
     end
   end
 
   describe "#waiting?" do
     it "should return the correct status" do
       subject.status = :other
-      expect(subject.waiting?).to be_false
+      expect(subject.waiting?).to be_falsey
       subject.status = :waiting
-      expect(subject.waiting?).to be_true
+      expect(subject.waiting?).to be_truthy
     end
   end
 end