infobip-twofactor 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41581f09d3bbc3d26820c141227e9d8918c1c532
-  data.tar.gz: 1bdc983a1d8a0a7c6ed496317fc70cbf4d0f4a4a
+  metadata.gz: 56411b5a553e4bcc955e3abec3ed2df44288b9fc
+  data.tar.gz: a061f0e44d3817e056da19acd18afe88f4924171
 SHA512:
-  metadata.gz: 524e8b3d13211a654befaaba03f8e8c072dc4f3cb04ae3ed54991876aa8182f7fb3a7b98cccd7173e6c6774cc84fd6e5af09a9a24795d7a0afaacdc7d25072cb
-  data.tar.gz: 61aec90ac96c3a2bc041e2588810b1ca1060e4cae061615ecfe721ed67c99c72485d381691eaf859a8cd34b26fc649a6889ffceb1f3d341638b5e450b172ce9e
+  metadata.gz: 0044a5643747128a98f1c7168dabe980c78af53da75eca534f5c7800735e1dc25589657a8cd1c49a8045f03eba833b3520f05f288081c94c06e3dc15993b0625
+  data.tar.gz: d3ba9d5131c5206bcbe1aa1251ca05a9d5a02f4fd8f492c5779309738560c7ef482720f57b6e7ba19f019d5754f28bc62e26c0f35b887f17c166c2ea1532874c

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - ruby
+  - 2.1.2
+
+notifications:
+  email:
+    recipients:
+      - knx@digitalheads.pl
+    on_failure: change
+    on_success: never

data/README.md

@@ -1,3 +1,7 @@
+[![Build Status](https://travis-ci.org/visualitypl/infobip-twofactor.svg?branch=master)](https://travis-ci.org/visualitypl/infobip-twofactor.svg?branch=master)
+
+[![Gem Version](https://badge.fury.io/rb/infobip-twofactor.svg)](http://badge.fury.io/rb/infobip-twofactor)
+
 # Infobip::Twofactor
 
 Simple wrapper gem for Infobip two factor authentication service
@@ -22,17 +26,17 @@ Or install it yourself as:
 
 ```ruby
 require 'infobip/twofactor'
-@twofactor = Infobip::Twofactor::API.new("username", "password", "http://oneapi-test.infobip.com/2fa/1")
+@twofactor = Infobip::Twofactor::API.new("username", "password", "http://oneapi-test.infobip.com/2fa/1", "message_id", "application_id")
 
- => #<Infobip::Twofactor::API:0x007fcce1e7efe0 @authorization_string="aXBwZG9rOjRAU2tLMipf", @auth=#<Crib::API:0x007fcce1e7ee78 @_agent=<Sawyer::Agent http://oneapi-test.infobip.com/2fa/1>, @_last_response=#<Sawyer::Response: 200 @rels={} @data="\"d02f4d9a2d9fb5a70b827819823254b8-9d48e592-db4a-4a70-95f0-59b5a49f48d4\"">>, @api_key="d02f4d9a2d9fb5a70b827819823254b8-9d48e592-db4a-4a70-95f0-59b5a49f4edd4", @api=#<Crib::API:0x007fcce1f8c0b8 @_agent=<Sawyer::Agent http://oneapi-test.infobip.com/2fa/1>>>
+ => #<Infobip::Twofactor::API:0x007fcce1e7efe0 @authorization_string="aXBwZ4r3rOjRA34tLMipf", @auth=#<Crib::API:0x007fcce1e7ee78 @_agent=<Sawyer::Agent http://oneapi-test.infobip.com/2fa/1>, @_last_response=#<Sawyer::Response: 200 @rels={} @data="\"d02f4d9a2d9fb5a70b827819823254b8-9d48e592-db4a-4a70-95f0-59b3449f48d4\"">>, @api_key="d02f4d9a2d9fb5a723827819823254b8-9d48e592-db4a-4a70-95f0-59b5a49f4edd4", @api=#<Crib::API:0x007fcce1f8c0b8 @_agent=<Sawyer::Agent http://oneapi-test.infobip.com/2fa/1>>>
 
-@twofactor.send_pin("application_id","message_id", "phone")
+@twofactor.send_pin("phone")
 
- => {:pinId=>"C2390DD39E0E1E39252D34BE796885FD", :to=>"48790409242", :ncStatus=>"NC_DESTINATION_UNKNOWN", :smsStatus=>"MESSAGE_SENT"}
+ => {:pinId=>"C2390DD39E0E1E39252D34BE796885FD", :to=>"48738288288", :ncStatus=>"NC_DESTINATION_UNKNOWN", :smsStatus=>"MESSAGE_SENT"}
 
-@twofactor.verify_pin("C2390DD39E0E1E39252D34BE796885FD", "pin")
+@twofactor.verify_pin("pin")
 
- => {:pinId=>"C2390DD39E0E1EA9252D34BE796885FD", :msisdn=>"48790809242", :verified=>true, :attemptsRemaining=>0}
+ => {:pinId=>"C2390DD39E0E1EA9252D34BE796885FD", :msisdn=>"48738288288", :verified=>true, :attemptsRemaining=>0}
 
 ```
 

data/lib/infobip/twofactor/api.rb

@@ -6,12 +6,17 @@ module Infobip
     class API
 
       attr_reader :api_key
-      # attr_reader :api
-      # attr_reader :auth
+      attr_reader :pin_id
+      attr_reader :application_id
+      attr_reader :message_id
 
-      def initialize(username, password, url)
+      def initialize(username, password, url, message_id, application_id)
+        raise "Missing message_id" unless message_id
+        raise "Missing application_id" unless application_id
         #send auth reqest
         @authorization_string = Base64.strict_encode64("#{username}:#{password}")
+        @message_id = message_id
+        @application_id = application_id
 
         @auth = Crib.api(url) do |http|
           http.headers[:authorization] =  "Basic #{@authorization_string}"
@@ -27,12 +32,23 @@ module Infobip
       end
 
 
-      def send_pin(application_id, message_id, phone)
-        @api.pin._post(applicationId: application_id, messageId: message_id, to: phone)
+      def send_pin(phone)
+        raise "Missing phone number" unless phone
+        raise "Missing message_id" unless @message_id
+        raise "Missing application_id" unless @application_id
+        response = @api.pin._post(applicationId: @application_id, messageId: @message_id, to: phone)
+        raise "Malformed two factor API response - no sms status field" unless (response.respond_to?(:smsStatus))
+        raise "Malformed two factor API response - no pin Id field" unless (response.respond_to?(:pinId))
+        raise "SMS not sent" unless (response.smsStatus == "MESSAGE_SENT")
+        @pin_id = response[:pinId]
+        response
       end
 
-      def verify_pin(pin_id, pin)
-        @api.pin(pin_id).verify._post(pin: pin)
+      def verify_pin(pin)
+        raise "Missing pin id" unless @pin_id
+        response = @api.pin(@pin_id).verify._post(pin: pin)
+        raise "Malformed two factor API response - no verified field" unless (response.respond_to?(:verified))
+        response
       end
 
     end

data/lib/infobip/twofactor/version.rb

@@ -1,5 +1,5 @@
 module Infobip
   module Twofactor
-    VERSION = "0.0.1"
+    VERSION = "1.0.0"
   end
 end

data/spec/support/fakeweb_api_responses.rb

@@ -2,10 +2,61 @@ def api_key_response_body
   "\"fc6112a4559b5b44dafe5a943771b53b-020887ca-c56d-42c4-80b0-33a16ea23610\""
 end
 
-def api_send_pin_response_body
-  '{pinId: "2B29B71922B37D3C93F8CEBB85B9E3CF", to: "48790809242", ncStatus: "NC_DESTINATION_UNKNOWN", smsStatus: "MESSAGE_SENT"}'
+def api_send_pin_response
+  %q{HTTP/1.1 200 OK
+Server: Apache-Coyote/1.1
+Access-Control-Allow-Origin: *
+Access-Control-Allow-Methods: GET, POST, PUT, PATCH, DELETE, COPY, HEAD, OPTIONS, LINK, UNLINK, PURGE
+Access-Control-Allow-Headers: Authorization, Content-Type
+Content-Type: application/json;charset=UTF-8
+Content-Length: 126
+Date: Wed, 21 Jan 2015 13:58:15 GMT
+Connection: close
+
+{"pinId":"2B29B71922B37D3C93F8CEBB85B9E3CF","to":"48790809242","ncStatus":"NC_DESTINATION_UNKNOWN","smsStatus":"MESSAGE_SENT"}
+}
+end
+
+def api_verify_pin_response
+%q{HTTP/1.1 200 OK
+Server: Apache-Coyote/1.1
+Access-Control-Allow-Origin: *
+Access-Control-Allow-Methods: GET, POST, PUT, PATCH, DELETE, COPY, HEAD, OPTIONS, LINK, UNLINK, PURGE
+Access-Control-Allow-Headers: Authorization, Content-Type
+Content-Type: application/json;charset=UTF-8
+Content-Length: 105
+Date: Wed, 21 Jan 2015 14:06:38 GMT
+Connection: close
+
+{"pinId":"2B29B71922B37D3C93F8CEBB85B9E3CF","msisdn":"48790809242","verified":true,"attemptsRemaining":0}
+}
 end
 
-def api_verify_pin_response_body
-  '{pinId: "0099939F5D1FC903B8A8A3990E452892",msisdn: "48790809242", verified: "true", attemptsRemaining: "0"}'
+def api_verify_pin_failed_response
+%q{HTTP/1.1 200 OK
+Server: Apache-Coyote/1.1
+Access-Control-Allow-Origin: *
+Access-Control-Allow-Methods: GET, POST, PUT, PATCH, DELETE, COPY, HEAD, OPTIONS, LINK, UNLINK, PURGE
+Access-Control-Allow-Headers: Authorization, Content-Type
+Content-Type: application/json;charset=UTF-8
+Content-Length: 129
+Date: Wed, 21 Jan 2015 14:06:38 GMT
+Connection: close
+
+{"pinId":"1129B71922B37D3C93F8CEBB85B9E3CF","msisdn":"48790809242","verified":false,"attemptsRemaining":2}
+}
+end
+
+def error_response
+%q{HTTP/1.1 400 Bad Request
+Server: Apache-Coyote/1.1
+Access-Control-Allow-Origin: *
+Access-Control-Allow-Methods: GET, POST, PUT, PATCH, DELETE, COPY, HEAD, OPTIONS, LINK, UNLINK, PURGE
+Access-Control-Allow-Headers: Authorization, Content-Type
+Content-Length: 96
+Date: Thu, 22 Jan 2015 16:14:27 GMT
+Connection: close
+
+{"requestError":{"serviceException":{"messageId":"INVALID_ARGUMENT","text":"Invalid argument"}}}
+}
 end

data/spec/twofactor_api_spec.rb

@@ -8,41 +8,49 @@ describe Infobip::Twofactor::API do
 
   before do
     @configuration = YAML.load_file("configuration.yml")
+
     FakeWeb.register_uri(:post, "http://ippdok:4%40SkK2*_@oneapi-test.infobip.com/2fa/1/api-key",  status: ["200", "OK"], body: api_key_response_body)
-    FakeWeb.register_uri(:post, "http://oneapi-test.infobip.com/2fa/1/pin",  status: ["200", "OK"], body: api_send_pin_response_body)
-    FakeWeb.register_uri(:post, "http://oneapi-test.infobip.com/2fa/1/pin/C6634467BFDB5E0BDCC1408B5315E84A/verify", status: ["200", "OK"], body: api_verify_pin_response_body)
-    @twofactor = Infobip::Twofactor::API.new(@configuration["username"], @configuration["password"], @configuration["url"])
+    FakeWeb.register_uri(:post, "http://oneapi-test.infobip.com/2fa/1/pin",  response: api_send_pin_response)
+    FakeWeb.register_uri(:post, "http://oneapi-test.infobip.com/2fa/1/pin/2B29B71922B37D3C93F8CEBB85B9E3CF/verify", response: api_verify_pin_response)
+
+    @twofactor = Infobip::Twofactor::API.new(@configuration["username"], @configuration["password"], @configuration["url"], @configuration["message_id"], @configuration["application_id"])
   end
 
   subject { @twofactor }
 
   it "should return valid api key" do
-    expect(@twofactor.api_key.class).to eq String
-    expect(@twofactor.api_key.length).to eq 69
+    expect(subject.api_key.class).to eq String
+    expect(subject.api_key.length).to eq 69
   end
 
   it "should create a valid Send PIN request, given valid params" do
-    response = @twofactor.send_pin(@configuration["application_id"], @configuration["message_id"], "48790809242")
-    if response.class == String
-      response_hash = eval(response)
-    else
-      response_hash = response
-    end
-    expect(response_hash[:smsStatus]).to eq "MESSAGE_SENT"
+    response = subject.send_pin("48790809242")
+    expect(response[:smsStatus]).to eq "MESSAGE_SENT"
+  end
+
+  it "should store pin_id value" do
+    response = subject.send_pin("48790809242")
+    expect(subject.pin_id).to eq "2B29B71922B37D3C93F8CEBB85B9E3CF"
   end
 
   it "should create a valid Verify PIN request, given valid params" do
-    response = @twofactor.verify_pin("C6634467BFDB5E0BDCC1408B5315E84A", "1234")
-    if response.class == String
-      response_hash = eval(response)
-    else
-      response_hash = response
-    end
-    expect(response_hash[:verified]).to eq "true"
+    response = subject.send_pin("48790809242")
+    response = subject.verify_pin("1234")
+    expect(response[:verified]).to eq true
   end
 
-end
+  context "error handling" do
+
+    it "new should raise an error when missing params"
 
+    it "send pin should raise an error when missing params"
+
+    it "verify pin should raise an error when missing params"
+
+    it "should raise an error when received invalid response"
+
+    it "should raise an error when received error object"
+
+  end
 
-#      FakeWeb.register_uri(:post, "https://apitest.authorize.net/xml/v1/request.api",  status: ["200", "OK"], body: successful_purchase_response)
- #     request = Hash.from_xml(FakeWeb.last_request.body.gsub("\n", ""))["createTransactionRequest"]["transactionRequest"]
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: infobip-twofactor
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - knx
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-20 00:00:00.000000000 Z
+date: 2015-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: crib
@@ -159,6 +159,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE