bitid 0.0.2 → 0.0.3

data/README.md

@@ -28,7 +28,15 @@ bitid = Bitid.new(nonce:@nonce, callback:@callback)
 ```
 
 `nonce` is an random string associated with the user's session id.
-`callback` is the url where the wallet will post the challenge's signature.
+`callback` is the url without the scheme where the wallet will post the challenge's signature.
+
+One example of callback could be `www.site.com/callback`. A callback cannot have parameters. By
+default the POST call will be done using `https`. If you need to tell the wallet to POST on
+`http` then you need to add `unsecure:true`.
+
+```
+bitid = Bitid.new(nonce:@nonce, callback:@callback, unsecure:true)
+```
 
 Once the `Bitid` object is initialized, you have access to the following methods :
 
@@ -42,11 +50,19 @@ This is the uri which will trigger the wallet when clicked (or scanned as QRcode
 bitid://bitid-demo.herokuapp.com/callback?x=987f20277c015ce7
 ```
 
+If you added `unsecure:true` when initializing the object then uri will be like :
+
+```
+bitid://bitid-demo.herokuapp.com/callback?x=987f20277c015ce7&u=1
+```
+
+To get the uri as QRcode :
+
 ```
 bitid.qrcode
 ```
 
-The same uri, but on QRcode format (this is actualy an URL pointing to the QRcode image).
+This is actualy an URL pointing to the QRcode image.
 
 ### Verification
 

data/lib/bitid.rb

@@ -6,14 +6,16 @@ class Bitid
 
   SCHEME = 'bitid'
   PARAM_NONCE = 'x'
+  PARAM_UNSECURE = 'u'
 
-  attr_accessor :nonce, :callback, :signature, :uri
+  attr_accessor :nonce, :callback, :signature, :uri, :unsecure
 
   def initialize hash={}
     @nonce = hash[:nonce]
     @callback = URI(hash[:callback])
     @signature = hash[:signature]
     @address = hash[:address]
+    @unsecure = hash[:unsecure]
     @uri = hash[:uri].nil? ? build_uri : URI(hash[:uri])
   end
 
@@ -48,7 +50,11 @@ class Bitid
   def build_uri
     uri = @callback
     uri.scheme = SCHEME
-    uri.query = URI.encode_www_form({PARAM_NONCE => @nonce})
+    params = {PARAM_NONCE => @nonce}
+    if @unsecure
+      params = params.merge({PARAM_UNSECURE => 1})
+    end
+    uri.query = URI.encode_www_form(params)
     uri
   end
 end

data/lib/bitid/version.rb

@@ -1,3 +1,3 @@
 module Bitid
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/test_bitid.rb

@@ -34,7 +34,13 @@ class TestBitid < Test::Unit::TestCase
   def test_build_uri
     bitid = Bitid.new(nonce:@nonce, callback:@callback)
 
-    assert_match /\Abitid\:\/\/localhost\:3000\/callback\?x=/, bitid.uri
+    assert_match /\Abitid\:\/\/localhost\:3000\/callback\?x=[a-z0-9]+\Z/, bitid.uri
+  end
+
+  def test_build_uri_with_unsecure_param
+    bitid = Bitid.new(nonce:@nonce, callback:@callback, unsecure:true)
+
+    assert_match /\Abitid\:\/\/localhost\:3000\/callback\?x=[a-z0-9]+&u=1\Z/, bitid.uri
   end
 
   def test_verify_uri

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitid
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -88,12 +88,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 690211457
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 690211457
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25