clavem 1.0.3 → 1.1.0

data/doc/method_list.html

@@ -111,7 +111,7 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Clavem/Authorizer.html#localizer-instance_method" title="Clavem::Authorizer#localizer (method)">#localizer</a></span>
+    <span class='object_link'><a href="Clavem/Authorizer.html#localize-instance_method" title="Clavem::Authorizer#localize (method)">#localize</a></span>
     
       <small>Clavem::Authorizer</small>
     
@@ -119,7 +119,7 @@
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Clavem/Authorizer.html#port-instance_method" title="Clavem::Authorizer#port (method)">#port</a></span>
+    <span class='object_link'><a href="Clavem/Authorizer.html#localizer-instance_method" title="Clavem::Authorizer#localizer (method)">#localizer</a></span>
     
       <small>Clavem::Authorizer</small>
     
@@ -127,7 +127,7 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Clavem/Authorizer.html#response_handler-instance_method" title="Clavem::Authorizer#response_handler (method)">#response_handler</a></span>
+    <span class='object_link'><a href="Clavem/Authorizer.html#port-instance_method" title="Clavem::Authorizer#port (method)">#port</a></span>
     
       <small>Clavem::Authorizer</small>
     
@@ -135,7 +135,7 @@
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Clavem/Authorizer.html#status-instance_method" title="Clavem::Authorizer#status (method)">#status</a></span>
+    <span class='object_link'><a href="Clavem/Authorizer.html#response_handler-instance_method" title="Clavem::Authorizer#response_handler (method)">#response_handler</a></span>
     
       <small>Clavem::Authorizer</small>
     
@@ -143,7 +143,7 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Clavem/Authorizer.html#template-instance_method" title="Clavem::Authorizer#template (method)">#template</a></span>
+    <span class='object_link'><a href="Clavem/Authorizer.html#status-instance_method" title="Clavem::Authorizer#status (method)">#status</a></span>
     
       <small>Clavem::Authorizer</small>
     
@@ -151,7 +151,7 @@
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Clavem/Authorizer.html#timeout-instance_method" title="Clavem::Authorizer#timeout (method)">#timeout</a></span>
+    <span class='object_link'><a href="Clavem/Authorizer.html#template-instance_method" title="Clavem::Authorizer#template (method)">#template</a></span>
     
       <small>Clavem::Authorizer</small>
     
@@ -159,7 +159,7 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Clavem/Authorizer.html#title-instance_method" title="Clavem::Authorizer#title (method)">#title</a></span>
+    <span class='object_link'><a href="Clavem/Authorizer.html#timeout-instance_method" title="Clavem::Authorizer#timeout (method)">#timeout</a></span>
     
       <small>Clavem::Authorizer</small>
     
@@ -167,7 +167,7 @@
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Clavem/Authorizer.html#token-instance_method" title="Clavem::Authorizer#token (method)">#token</a></span>
+    <span class='object_link'><a href="Clavem/Authorizer.html#title-instance_method" title="Clavem::Authorizer#title (method)">#title</a></span>
     
       <small>Clavem::Authorizer</small>
     
@@ -175,6 +175,14 @@
   
 
   <li class="r1 ">
+    <span class='object_link'><a href="Clavem/Authorizer.html#token-instance_method" title="Clavem::Authorizer#token (method)">#token</a></span>
+    
+      <small>Clavem::Authorizer</small>
+    
+  </li>
+  
+
+  <li class="r2 ">
     <span class='object_link'><a href="Clavem/Authorizer.html#url-instance_method" title="Clavem::Authorizer#url (method)">#url</a></span>
     
       <small>Clavem::Authorizer</small>

data/doc/top-level-namespace.html

@@ -6,7 +6,7 @@
 <title>
   Top Level Namespace
   
-    &mdash; Documentation by YARD 0.8.3
+    &mdash; Documentation by YARD 0.8.4.1
   
 </title>
 
@@ -103,9 +103,9 @@
 </div>
 
     <div id="footer">
-  Generated on Sun Jan 27 17:32:23 2013 by
+  Generated on Fri Feb  8 11:54:02 2013 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.3 (ruby-1.9.3).
+  0.8.4.1 (ruby-1.9.3).
 </div>
 
   </body>

data/lib/clavem.rb

@@ -10,6 +10,4 @@ require "webrick"
 require "erb"
 
 require "clavem/version" if !defined?(Clavem::Version)
-require "clavem/authorizer"
-
-R18n.from_env(Pathname.new(File.dirname(__FILE__)).to_s + "/../locales/")
+require "clavem/authorizer"

data/lib/clavem/authorizer.rb

@@ -25,17 +25,28 @@ module Clavem
 
   # A class to handle oAuth authorizations.
   #
-  # @attr [String] url The URL where to send the user to start authorization..
-  # @attr [String] ip The IP address on which listening for replies. Default is `127.0.0.1`.
-  # @attr [Fixnum] port The port on which listening for replies. Default is `2501`.
-  # @attr [String] command The command to open the URL. `{{URL}}` is replaced with the specified URL. Default is `open "{{URL}}"`.
-  # @attr [String] title The title for response template. Default is `Clavem Authorization`.
-  # @attr [String] template Alternative template to show progress in user's browser.
-  # @attr [Fixnum] timeout The amount of milliseconds to wait for response from the remote endpoint before returning a failure. Default is `0`, which means *disabled*.
-  # @attr [Proc] response_handler A Ruby block to handle response and check for success. @see {#default_response_handler}.
-  # @attr [String] token The token obtained by the remote endpoint.
-  # @attr [Symbol] token The status of the request. Can be `:success`, `:denied`, `:failure` and `:waiting`.
-  # @attr [R18N::Translation] localizer A localizer object.
+  # @attribute url
+  #   @return [String] The URL where to send the user to start authorization..
+  # @attribute ip
+  #   @return [String] The IP address on which listening for replies. Default is `127.0.0.1`.
+  # @attribute port
+  #   @return [Fixnum] The port on which listening for replies. Default is `2501`.
+  # @attribute command
+  #   @return [String] The command to open the URL. `{{URL}}` is replaced with the specified URL. Default is `open "{{URL}}"`.
+  # @attribute title
+  #   @return [String] The title for response template. Default is `Clavem Authorization`.
+  # @attribute template
+  #   @return [String] Alternative template to show progress in user's browser.
+  # @attribute timeout
+  #   @return [Fixnum] The amount of milliseconds 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. @see {#default_response_handler}.
+  # @attribute token
+  #   @return [String] The token obtained by the remote endpoint.
+  # @attribute token
+  #   @return [Symbol] The status of the request. Can be `:success`, `:denied`, `:failure` and `:waiting`.
+  # @attribute localizer
+  #   @return [R18N::Translation] A localizer object.
   class Authorizer
     include R18n::Helpers
     attr_accessor :url
@@ -78,6 +89,8 @@ module Clavem
     # @param response_handler [Proc] A Ruby block to handle response and check for success. See {#default_response_handler}.
     # @return [Authorizer] The new authorizer.
     def initialize(ip = "127.0.0.1", port = 2501, command = nil, title = nil, template = nil, timeout = 0, &response_handler)
+      @i18n = self.localize
+
       @ip = ip.ensure_string
       @port = port.to_integer
       @command = command.ensure_string
@@ -91,7 +104,6 @@ module Clavem
       @token = nil
       @status = :waiting
       @compiled_template ||= ::ERB.new(@template)
-      @i18n = t
       @timeout_expired = false
       @timeout_thread = nil
 
@@ -122,7 +134,7 @@ module Clavem
         raise t
       rescue => e
         @status = :failure
-        raise Clavem::Exceptions::Failure.new("Cannot handle response: #{e.to_s}")
+        raise Clavem::Exceptions::Failure.new(@i18n.errors.response_failure(e.to_s))
       ensure
         cleanup
       end
@@ -148,13 +160,22 @@ module Clavem
       request.query['oauth_token'].ensure_string
     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
+    end
+
     private
       # sanitize_arguments
       def sanitize_arguments
         @ip = "127.0.0.1" if @ip.blank?
         @port = 2501 if @port.to_integer < 1
         @command = "open \"{{URL}}\"" if @command.blank?
-        @title = "Clavem Authorization" if @title.blank?
+        @title = @i18n.default_title if @title.blank?
         @template = File.read(File.dirname(__FILE__) + "/template.html.erb") if @template.blank?
         @timeout = 0 if @timeout < 0
       end
@@ -165,7 +186,7 @@ module Clavem
         begin
           Kernel.system(@command.gsub("{{URL}}", @url.ensure_string))
         rescue => e
-          raise Clavem::Exceptions::Failure.new("Cannot open URL #{@url}: #{e.to_s}")
+          raise Clavem::Exceptions::Failure.new(@i18n.errors.open_failure(@url.ensure_string, e.to_s))
         end
       end
 
@@ -187,7 +208,7 @@ module Clavem
 
       # Prepare the webserver for handling the response.
       def setup_webserver
-        @server = ::WEBrick::HTTPServer.new(BindAddress: @ip, Port: @port, Logger: WEBrick::Log.new("/dev/null"), AccessLog: [nil, nil])
+        @server = ::WEBrick::HTTPServer.new(:BindAddress => @ip, :Port => @port, :Logger => WEBrick::Log.new("/dev/null"), :AccessLog => [nil, nil])
         @server.mount_proc("/"){ |request, response| dispatch_request(request, response) }
       end
 

data/lib/clavem/template.html.erb

@@ -17,8 +17,8 @@
       <br/>
       <div class="alert alert-<%= @status == :success ? "success" : "error" %>">
         <h4><%= @title %></h4>
-        <h1><%= @i18n.send(@status == :success ? :header_success : :header_failure) %></h1>
-        <p><%= @i18n.close_message %></p>
+        <h1><%= @i18n.template.send(@status == :success ? :header_success : :header_failure) %></h1>
+        <p><%= @i18n.template.close_message %></p>
       </div>
     </div>
   </body>

data/lib/clavem/version.rb

@@ -13,10 +13,10 @@ module Clavem
     MAJOR = 1
 
     # The minor version.
-    MINOR = 0
+    MINOR = 1
 
     # The patch version.
-    PATCH = 3
+    PATCH = 0
 
     # The current version of clavem.
     STRING = [MAJOR, MINOR, PATCH].compact.join(".")

data/locales/en.yml

@@ -3,7 +3,14 @@
 # This file is part of the clavem gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
 # Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
 #
+
 ---
-header_success: "Authentication succeded!"
-header_failure: "Authentication failed!"
-close_message: "This window should close immediately. Alternatively you can close it by <a href=\"javascript:close_window();\">clicking here</a>."
+  clavem:
+    default_title: "Clavem Authorization"
+    errors:
+      response_failure: "Cannot handle response: %1"
+      open_failure: "Cannot open URL %1: %2"
+    template:
+      header_success: "Authentication succeded!"
+      header_failure: "Authentication failed!"
+      close_message: "This window should close immediately. Alternatively you can close it by <a href=\"javascript:close_window();\">clicking here</a>."

data/locales/it.yml

@@ -3,7 +3,14 @@
 # This file is part of the clavem gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
 # Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
 #
+
 ---
-header_success: "Autenticazione riuscita!"
-header_failure: "Autenticazione fallita!"
-close_message: "Questa finestra dovrebbe chiudersi immediatamente. Alternativamente puoi chiuderla <a href=\"javascript:close_window();\">cliccando qui</a>."
+  clavem:
+    default_title: Autorizzazione Clavem
+    errors:
+      response_failure: "Impossibile gestire una risposta: %1"
+      open_failure: "Impossible aprire l'URL %1: %2"
+    template:
+      header_success: "Autenticazione riuscita!"
+      header_failure: "Autenticazione fallita!"
+      close_message: "Questa finestra dovrebbe chiudersi immediatamente. Alternativamente puoi chiuderla <a href=\"javascript:close_window();\">cliccando qui</a>."

data/spec/clavem/authorizer_spec.rb

@@ -174,6 +174,25 @@ describe Clavem::Authorizer do
     end
   end
 
+  describe ".localize" do
+    it "should set the right locale path" do
+      expect(instance.instance_variable_get(:@i18n_locales_path)).to eq(File.absolute_path(::Pathname.new(File.dirname(__FILE__)).to_s + "/../../locales/"))
+      instance.localize
+    end
+
+    it "should set using English if called without arguments" do
+      authorizer = ::Clavem::Authorizer.new
+      R18n::I18n.should_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
+      R18n::I18n.should_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
+
   # PRIVATE
   describe "#open_endpoint" do
     it("should call system with the right command") do
@@ -224,7 +243,6 @@ describe Clavem::Authorizer do
 
       thread = authorizer.instance_variable_get(:@timeout_thread)
       expect(thread).to be_a(Thread)
-      expect(thread.stop?).to be_true
       expect(authorizer.instance_variable_get(:@timeout_expired)).to be_true
     end
   end

data/spec/coverage_helper.rb

@@ -5,17 +5,14 @@
 #
 
 require "pathname"
+require "simplecov"
 
-if ENV["CLAVEM_COVERAGE"] then
-  require "simplecov"  
+SimpleCov.start do
   root = Pathname.new(File.dirname(__FILE__)) + ".."
 
-  SimpleCov.start do
-    add_filter do |src_file|
-      path = Pathname.new(src_file.filename).relative_path_from(root).to_s
-      
-      # TODO: Add exclusions here
-      path !~ /^(bin|lib)/
-    end
+  add_filter do |src_file|
+    path = Pathname.new(src_file.filename).relative_path_from(root).to_s
+
+    path !~ /^(bin|lib)/
   end
 end

data/spec/spec_helper.rb

@@ -5,7 +5,6 @@
 #
 
 require "rubygems"
-require "coverage_helper"
 require "bundler/setup"
 require "clavem"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clavem
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,40 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-28 00:00:00.000000000 Z
+date: 2013-02-08 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: r18n-desktop
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.1.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.1.3
-- !ruby/object:Gem::Dependency
-  name: lazier
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.7
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.7
 - !ruby/object:Gem::Dependency
   name: mamertes
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 2.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 2.0.3
 - !ruby/object:Gem::Dependency
   name: webrick
   requirement: !ruby/object:Gem::Requirement
@@ -75,118 +43,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.3.1
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.12.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.12.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 10.0.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 10.0.3
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.7.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.7.1
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.9.11.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.9.11.4
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.8.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.8.3
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.2.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.2.2
-- !ruby/object:Gem::Dependency
-  name: github-markup
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.7.5
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.7.5
 description: A local callback server for oAuth web-flow.
 email:
 - shogun_panda@me.com
@@ -196,6 +52,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis-gemfile
 - .travis.yml
 - .yardopts
 - Gemfile
@@ -203,7 +60,6 @@ files:
 - Rakefile
 - bin/clavem
 - clavem.gemspec
-- clavem.yml
 - doc/Clavem.html
 - doc/Clavem/Authorizer.html
 - doc/Clavem/Exceptions.html
@@ -220,6 +76,7 @@ files:
 - doc/file_list.html
 - doc/frames.html
 - doc/index.html
+- doc/index.html.save
 - doc/js/app.js
 - doc/js/full_list.js
 - doc/js/jquery.js
@@ -235,7 +92,7 @@ files:
 - spec/coverage_helper.rb
 - spec/spec_helper.rb
 - test_server.rb
-homepage: http://github.com/ShogunPanda/clavem
+homepage: http://sw.cow.tc/clavem
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -246,16 +103,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4208330408621251444
 requirements: []
 rubyforge_project: clavem
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: A local callback server for oAuth web-flow.