clavem 1.2.2 → 1.3.0

data/doc/top-level-namespace.html

@@ -6,13 +6,13 @@
 <title>
   Top Level Namespace
   
-    &mdash; Documentation by YARD 0.8.5.2
+    &mdash; Documentation by YARD 0.8.6.2
   
 </title>
 
-  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
 
-  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
 
 <script type="text/javascript" charset="utf-8">
   hasFrames = window.top.frames.main ? true : false;
@@ -103,9 +103,9 @@
 </div>
 
     <div id="footer">
-  Generated on Sat Apr 13 12:17:41 2013 by
+  Generated on Sun Jul 14 19:41:23 2013 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.5.2 (ruby-1.9.3).
+  0.8.6.2 (ruby-1.9.3).
 </div>
 
   </body>

data/lib/clavem/authorizer.rb

@@ -27,8 +27,8 @@ module Clavem
   #
   # @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 host
+  #   @return [String] The host address on which listening for replies. Default is `localhost`.
   # @attribute port
   #   @return [Fixnum] The port on which listening for replies. Default is `2501`.
   # @attribute command
@@ -50,7 +50,7 @@ module Clavem
   class Authorizer
     include R18n::Helpers
     attr_accessor :url
-    attr_accessor :ip
+    attr_accessor :host
     attr_accessor :port
     attr_accessor :command
     attr_accessor :title
@@ -63,7 +63,7 @@ module Clavem
 
     # Returns a unique (singleton) instance of the authorizer.
     #
-    # @param ip [String] The IP address on which listening for replies. Default is `127.0.0.1`.
+    # @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 `2501`.
     # @param command [String|nil] The command to open the URL. `{{URL}}` is replaced with the specified URL. Default is `open "{{URL}}"`.
     # @param title [String|nil] The title for response template. Default is `Clavem Authorization`
@@ -72,15 +72,15 @@ module Clavem
     # @param response_handler [Proc] A Ruby block to handle response and check for success. See {#default_response_handler}.
     # @param force [Boolean] If to force recreation of the instance.
     # @return [Authorizer] The unique (singleton) instance of the authorizer.
-    def self.instance(ip = "127.0.0.1", port = 2501, command = nil, title = nil, template = nil, timeout = 0, force = false, &response_handler)
+    def self.instance(host = "localhost", port = 2501, command = nil, title = nil, template = nil, timeout = 0, force = false, &response_handler)
       @instance = nil if force
-      @instance ||= Clavem::Authorizer.new(ip, port, command, title, template, timeout, &response_handler)
+      @instance ||= Clavem::Authorizer.new(host, port, command, title, template, timeout, &response_handler)
       @instance
     end
 
     # Creates a new authorizer.
     #
-    # @param ip [String] The IP address on which listening for replies. Default is `127.0.0.1`.
+    # @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 `2501`.
     # @param command [String|nil] The command to open the URL. `{{URL}}` is replaced with the specified URL. Default is `open "{{URL}}"`.
     # @param title [String|nil] The title for response template. Default is `Clavem Authorization`
@@ -88,10 +88,10 @@ module Clavem
     # @param timeout [Fixnum] The amount of milliseconds 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 {#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)
+    def initialize(host = "localhost", port = 2501, command = nil, title = nil, template = nil, timeout = 0, &response_handler)
       @i18n = self.localize
 
-      @ip = ip.ensure_string
+      @host = host.ensure_string
       @port = port.to_integer
       @command = command.ensure_string
       @title = title.ensure_string
@@ -147,7 +147,7 @@ module Clavem
     #
     # @return [String] The callback_url for this authorizer.
     def callback_url
-      "http://#{ip}:#{port}/"
+      "http://#{host}:#{port}/"
     end
 
     # Handles a response from the remote endpoint.
@@ -172,7 +172,7 @@ module Clavem
     private
       # sanitize_arguments
       def sanitize_arguments
-        @ip = "127.0.0.1" if @ip.blank?
+        @host = "localhost" if @host.blank?
         @port = 2501 if @port.to_integer < 1
         @command = "open \"{{URL}}\"" if @command.blank?
         @title = @i18n.default_title if @title.blank?
@@ -208,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: @host, Port: @port, Logger: WEBrick::Log.new("/dev/null"), AccessLog: [nil, nil])
         @server.mount_proc("/"){ |request, response| dispatch_request(request, response) }
       end
 
@@ -217,7 +217,7 @@ module Clavem
       # @param [WEBrick::HTTPRequest] request The request that the remote endpoint made to notify authorization status.
       # @param [WEBrick::HTTPResponse] response The request to send to the browser.
       def dispatch_request(request, response)
-        @token = @response_handler ? @response_handler.call(self, request, response) : self.default_response_handler(self, request, response)
+        @token = @response_handler ? @response_handler.call(self, request, response) : default_response_handler(self, request, response)
 
         if @status == :waiting then
           if @token.present? then

data/lib/clavem/version.rb

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

data/spec/clavem/authorizer_spec.rb

@@ -40,27 +40,27 @@ describe Clavem::Authorizer do
 
   describe ".instance" do
     it("should call .new with the passed arguments") do
-      ::Clavem::Authorizer.should_receive(:new).with("IP", "PORT", "COMMAND", "TITLE", "TEMPLATE", "TIMEOUT")
-      ::Clavem::Authorizer.instance("IP", "PORT", "COMMAND", "TITLE", "TEMPLATE", "TIMEOUT")
+      ::Clavem::Authorizer.should_receive(:new).with("HOST", "PORT", "COMMAND", "TITLE", "TEMPLATE", "TIMEOUT")
+      ::Clavem::Authorizer.instance("HOST", "PORT", "COMMAND", "TITLE", "TEMPLATE", "TIMEOUT")
     end
 
     it("should return the same instance") do
-      ::Clavem::Authorizer.stub(:new) do Time.now end
+      ::Clavem::Authorizer.stub(:new) { Time.now }
       authorizer = ::Clavem::Authorizer.instance("FIRST")
       expect(::Clavem::Authorizer.instance("SECOND")).to be(authorizer)
     end
 
     it("should return a new instance if requested to") do
-      ::Clavem::Authorizer.stub(:new) do Time.now end
+      ::Clavem::Authorizer.stub(:new) { Time.now }
       authorizer = ::Clavem::Authorizer.instance("FIRST")
-      expect(::Clavem::Authorizer.instance("IP", "PORT", "COMMAND", "TITLE", "TEMPLATE", "TIMEOUT", true)).not_to be(authorizer)
+      expect(::Clavem::Authorizer.instance("HOST", "PORT", "COMMAND", "TITLE", "TEMPLATE", "TIMEOUT", true)).not_to be(authorizer)
     end
   end
 
   describe "#initialize" do
     it("should handle default arguments") do
       authorizer = ::Clavem::Authorizer.new
-      expect(authorizer.ip).to eq("127.0.0.1")
+      expect(authorizer.host).to eq("localhost")
       expect(authorizer.port).to eq(2501)
       expect(authorizer.command).to eq("open \"{{URL}}\"")
       expect(authorizer.title).to eq("Clavem Authorization")
@@ -70,8 +70,8 @@ describe Clavem::Authorizer do
     end
 
     it("should assign arguments") do
-      authorizer = ::Clavem::Authorizer.new("IP", 2511, "COMMAND", "TITLE", "TEMPLATE", 2) do end
-      expect(authorizer.ip).to eq("IP")
+      authorizer = ::Clavem::Authorizer.new("HOST", 2511, "COMMAND", "TITLE", "TEMPLATE", 2) do end
+      expect(authorizer.host).to eq("HOST")
       expect(authorizer.port).to eq(2511)
       expect(authorizer.command).to eq("COMMAND")
       expect(authorizer.title).to eq("TITLE")
@@ -157,7 +157,7 @@ describe Clavem::Authorizer do
 
   describe "#callback_url" do
     it("should return the correct callback") do
-      expect(::Clavem::Authorizer.new.callback_url).to eq("http://127.0.0.1:2501/")
+      expect(::Clavem::Authorizer.new.callback_url).to eq("http://localhost:2501/")
       expect(::Clavem::Authorizer.new("10.0.0.1", "80").callback_url).to eq("http://10.0.0.1:80/")
     end
   end
@@ -201,7 +201,7 @@ describe Clavem::Authorizer do
       instance.send(:open_endpoint)
 
       Kernel.should_receive(:system).with("COMMAND")
-      ::Clavem::Authorizer.new("IP", "PORT", "COMMAND").send(:open_endpoint)
+      ::Clavem::Authorizer.new("HOST", "PORT", "COMMAND").send(:open_endpoint)
     end
 
     it("should raise exception in case of failures") do
@@ -223,7 +223,7 @@ describe Clavem::Authorizer do
   describe "#setup_timeout_handling" do
     it("should not set a timeout handler by default") do
       authorizer = ::Clavem::Authorizer.new
-      authorizer.stub(:open_endpoint) do end
+      authorizer.stub(:open_endpoint)
       authorizer.stub(:setup_webserver) do authorizer.instance_variable_set(:@server, ::ClavemDummyServer.new) end
       authorizer.authorize("URL")
       expect(authorizer.instance_variable_get(:@timeout_handler)).to be_nil
@@ -236,7 +236,7 @@ describe Clavem::Authorizer do
       server = ::ClavemDummyServer.new
       server.stub(:start) do sleep(1) end
 
-      authorizer = ::Clavem::Authorizer.new("IP", "PORT", "COMMAND", "TITLE", "TEMPLATE", 500)
+      authorizer = ::Clavem::Authorizer.new("HOST", "PORT", "COMMAND", "TITLE", "TEMPLATE", 500)
       authorizer.stub(:open_endpoint) do end
       authorizer.stub(:setup_webserver) do authorizer.instance_variable_set(:@server, server) end
       expect { authorizer.authorize("URL") }.to raise_error(::Clavem::Exceptions::Timeout)
@@ -260,7 +260,7 @@ describe Clavem::Authorizer do
     it "should setup a single request handler on /" do
       server = ::ClavemDummyServer.new
       ::WEBrick::HTTPServer.stub(:new).and_return(server)
-      authorizer = ::Clavem::Authorizer.new("IP", "PORT")
+      authorizer = ::Clavem::Authorizer.new("HOST", "PORT")
       server.should_receive(:mount_proc).with("/")
       authorizer.send(:setup_webserver)
     end
@@ -324,7 +324,7 @@ describe Clavem::Authorizer do
       server = ::ClavemDummyServer.new
       server.stub(:start) do sleep(1) end
 
-      authorizer = ::Clavem::Authorizer.new("IP", "PORT", "COMMAND", "TITLE", "TEMPLATE")
+      authorizer = ::Clavem::Authorizer.new("HOST", "PORT", "COMMAND", "TITLE", "TEMPLATE")
       authorizer.stub(:open_endpoint) do end
       authorizer.stub(:setup_webserver) do authorizer.instance_variable_set(:@server, server) end
       authorizer.authorize("URL")
@@ -342,7 +342,7 @@ describe Clavem::Authorizer do
       server = ::ClavemDummyServer.new
       server.stub(:start) do sleep(1) end
 
-      authorizer = ::Clavem::Authorizer.new("IP", "PORT", "COMMAND", "TITLE", "TEMPLATE", 5000)
+      authorizer = ::Clavem::Authorizer.new("HOST", "PORT", "COMMAND", "TITLE", "TEMPLATE", 5000)
       authorizer.send(:setup_timeout_handling)
       thread = authorizer.instance_variable_get(:@timeout_thread)
       thread.should_receive(:exit)

data/spec/coverage_helper.rb

@@ -6,6 +6,9 @@
 
 require "pathname"
 require "simplecov"
+require "coveralls"
+
+Coveralls.wear!
 
 SimpleCov.start do
   root = Pathname.new(File.dirname(__FILE__)) + ".."

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clavem
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-13 00:00:00.000000000 Z
+date: 2013-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mamertes
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: webrick
   requirement: !ruby/object:Gem::Requirement
@@ -112,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2223468996882033968
+      hash: 747595586087603511
 requirements: []
 rubyforge_project: clavem
 rubygems_version: 1.8.25