prooflink_connect 0.0.15 → 0.0.16

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,18 @@
+bundler_args: --binstubs
+
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - ree
+
+script: "bundle exec rspec spec"
+
+notifications:
+  recipients:
+    - markmulder@gmail.com
+    - stephan@ka.ag
+
+branches:
+  only:
+    - master
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prooflink_connect (0.0.14)
+    prooflink_connect (0.0.16)
       activesupport
       httparty
       json
@@ -9,23 +9,23 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (3.0.9)
+    activesupport (3.0.10)
     addressable (2.2.6)
     crack (0.1.8)
     diff-lcs (1.1.2)
     httparty (0.7.8)
       crack (= 0.1.8)
     json (1.5.3)
-    rspec (2.4.0)
-      rspec-core (~> 2.4.0)
-      rspec-expectations (~> 2.4.0)
-      rspec-mocks (~> 2.4.0)
-    rspec-core (2.4.0)
-    rspec-expectations (2.4.0)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.4.0)
-    webmock (1.6.2)
-      addressable (>= 2.2.2)
+    rspec-mocks (2.6.0)
+    webmock (1.7.2)
+      addressable (~> 2.2, > 2.2.5)
       crack (>= 0.1.7)
 
 PLATFORMS

data/README.md

@@ -1,4 +1,5 @@
-# Prooflink Connect
+# Prooflink Connect [![Build Status](http://travis-ci.org/prooflink/prooflink_connect.png)](http://travis-ci.org/prooflink/prooflink_connect)
+
 =================
 
 Library to connect to the [prooflink](http://www.prooflink.com) identity service provider
@@ -25,4 +26,4 @@ Usage
 -----
 
 To make use of this gem you need an account on prooflink with an api key
-Adjust the prooflink configuration settings in your environment.rb:
+Adjust the prooflink configuration settings in your environment.rb:

data/lib/prooflink_connect/configuration.rb

@@ -6,14 +6,15 @@ module ProoflinkConnect
     @@defaults = {
       :provider_endpoint => "prooflink.com",
       :subdomain => "example",
-      :protocol => "https"
+      :protocol => "https",
+      :locale => "en"
     }
 
     def initialize
       @@defaults.each_pair{|k,v| self.send("#{k}=",v)}
     end
 
-    attr_accessor :provider_endpoint, :subdomain, :api_key, :protocol
+    attr_accessor :provider_endpoint, :subdomain, :api_key, :protocol, :locale
 
     def validate!
       raise InvalidConfigurationError if [:provider_endpoint, :subdomain, :api_key, :protocol].any?{|option|send(option).blank?}
@@ -26,4 +27,4 @@ module ProoflinkConnect
     class InvalidConfigurationError < ::StandardError
     end
   end
-end
+end

data/lib/prooflink_connect/invite.rb

@@ -1,5 +1,7 @@
 require 'httparty'
 require "active_support/core_ext/hash/keys"
+require "active_support/core_ext/hash/reverse_merge"
+require "json"
 
 class ProoflinkConnect::Invite
   attr_reader :configuration, :attributes
@@ -10,19 +12,32 @@ class ProoflinkConnect::Invite
     @configuration = configuration
   end
 
-  def save
+  def save(params = {})
+    return false if created?
+
     uri = configuration.base_uri + "/invites"
-    params = { "invite" => attributes, "api_key" =>  configuration.api_key, "locale" => locale || 'nl' }
+    params.reverse_merge! "invite" => attributes, "api_key" =>  configuration.api_key, "locale" => locale || 'nl'
+
     response = HTTParty.post(uri, :body => params)
 
-    if response.headers["status"] == "200"
+    if response.code == 200
       self.attributes.merge! JSON.parse(response.body)["entry"].stringify_keys
     end
 
-    return !attributes["id"].nil?
+    return created?
+  end
+
+  def url
+    attributes["invite_url"] if created?
   end
 
   def person
-    ProoflinkConnect::PortableContacts::Person.new(attributes)
+    @person ||= ProoflinkConnect::PortableContacts::Person.new(attributes)
+  end
+
+  private
+
+  def created?
+    !!attributes["id"]
   end
 end

data/lib/prooflink_connect/share.rb

@@ -2,12 +2,29 @@ require 'httparty'
 
 module ProoflinkConnect
   class Share
-    def self.post(transaction, message)
+    def self.post(transaction, message, position = nil)
       uri = ProoflinkConnect.config.base_uri + "/shares/post_share_transaction"
       api_key = ProoflinkConnect.config.api_key
       params = {"api_key" => api_key, "transaction" => transaction,
         "message" => message, "format" => "json"}
+      params["position"] = position if position
       response = HTTParty.post(uri, :body => params)
     end
+
+    def self.embedded(options = {}, config = ProoflinkConnect.config)
+      options = {
+        :width => "400px",
+        :height => "355px",
+        :locale => config.locale
+      }.merge(options)
+
+      src = "#{config.base_uri}/#{options[:locale]}/shares/embedded/new?message=#{options[:message]}"
+      src << "&position=#{CGI.escape(options[:position])}" if options[:position]
+      styling = "width: #{options[:width]}; height: #{options[:height]};"
+      styling << " border: 0; display: block;"
+      default_options = "frameborder='0' allowTransparency='true'"
+      html = "<iframe src='#{src}' style='#{styling}' #{default_options}></iframe>"
+      html.respond_to?(:html_safe) ? html.html_safe : html
+    end
   end
 end

data/lib/prooflink_connect/version.rb

@@ -1,3 +1,3 @@
 module ProoflinkConnect
-  VERSION = "0.0.15"
+  VERSION = "0.0.16"
 end

data/lib/prooflink_connect.rb

@@ -1,3 +1,5 @@
+require 'cgi'
+
 module ProoflinkConnect
   autoload :Configuration, "prooflink_connect/configuration"
   autoload :Assertion, "prooflink_connect/assertion"
@@ -15,18 +17,26 @@ module ProoflinkConnect
   end
 
   def self.embedded(options = {}, config = ProoflinkConnect.config)
+    # needed because you didn't have to use px explicitly in the old situation
+    [:width, :height].each do |dimension|
+      if options[dimension] && !options[dimension].include?("%")
+        options[dimension] << "px"
+      end
+    end
+
     options = {
       :subdomain => config.subdomain,
       :token_url => 'https://example.com/auth/callbacks',
       :forced_connect => '0',
       :embed_forms => '0',
-      :width => 520,
-      :height => 250}.merge(options)
+      :width => '520px',
+      :height => '250px'}.merge(options)
+
     domain_part = [options[:subdomain], config.provider_endpoint].compact.join(".")
     path_part = [options[:locale], 'authentications', 'embedded'].compact.join("/")
     query_part = "token_url=#{options[:token_url]}&forced_connect=#{options[:forced_connect]}&embed_forms=#{options[:embed_forms]}"
     frame_url = "#{config.protocol}://#{domain_part}/#{path_part}?#{query_part}"
-    html = "<iframe src='#{frame_url}' style='width: #{options[:width]}px; height: #{options[:height]}px; border: 0;display: block' frameborder='0' allowTransparency='true'></iframe>"
+    html = "<iframe src='#{frame_url}' style='width: #{options[:width]}; height: #{options[:height]}; border: 0; display: block;' frameborder='0' allowTransparency='true'></iframe>"
     html.respond_to?(:html_safe) ? html.html_safe : html
   end
 end

data/spec/prooflink_connect/configuration_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe ProoflinkConnect::Configuration do
+  it "provides defaults" do
+    ProoflinkConnect.config.base_uri.should == "https://example.prooflink.com"
+  end
+
+  it "returns correct url" do
+    ProoflinkConnect.configure do |config|
+      config.provider_endpoint = "local-prooflink.com"
+      config.subdomain = "testing"
+      config.protocol = "http"
+    end
+    ProoflinkConnect.config.base_uri.should == "http://testing.local-prooflink.com"
+  end
+
+  it "sets locale" do
+    ProoflinkConnect.configure do |config|
+      config.locale = "en"
+    end
+    ProoflinkConnect.config.locale.should == "en"
+  end
+end
+

data/spec/prooflink_connect/invite_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe ProoflinkConnect::Invite do
+  before do
+    reset_configuration
+  end
+
+  it "creates a Prooflink invite" do
+    attributes = {:email => 'newuser@prooflink.com'}
+
+    stub_request(:post, "https://example.prooflink.com/invites").
+      with(:body => "invite[email]=newuser%40prooflink.com&api_key=1234&locale=nl").
+      to_return(:status => 200, :body => {
+        "entry" => {
+          "name" => {},
+          "displayName" => "Prooflink",
+          "id" => "cg6a1Turx70NWzkkwrbGRDRvImY=\n",
+          "invite_url" => "url"
+        }
+      }.to_json, :headers => {})
+
+    invite = ProoflinkConnect::Invite.new(attributes)
+    invite.save.should == true
+    invite.save.should == false
+    invite.url.should == "url"
+  end
+
+  it "creates a Prooflink invite with custom parameters" do
+    attributes = {:email => 'newuser@prooflink.com'}
+    expected_parameters = {"locale"=>["nl"], "api_key"=>["4567"], "invite[email]"=>["newuser@prooflink.com"]}
+
+    stub_request(:post, "https://example.prooflink.com/invites").
+      with{|request| expected_parameters == CGI.parse(request.body)}.
+      to_return(:status => 200, :body => {
+        "entry" => {
+          "name" => {},
+          "displayName" => "Prooflink",
+          "id" => "cg6a1Turx70NWzkkwrbGRDRvImY=\n",
+          "invite_url" => "url"
+        }
+      }.to_json, :headers => {})
+
+    invite = ProoflinkConnect::Invite.new(attributes)
+    invite.save({"api_key" => "4567"}).should == true
+  end
+
+end
+

data/spec/prooflink_connect/share_spec.rb

@@ -2,15 +2,57 @@ require 'spec_helper'
 
 describe ProoflinkConnect::Share do
   before do
-    ProoflinkConnect.configure do |config|
-      config.api_key = "1234"
-    end
+    reset_configuration
   end
 
   it "posts a message to Prooflink" do
+    expected_parameters = {"format"=>["json"], "api_key"=>["1234"], "message"=>["This is pretty awesome"], "transaction"=>["pl2"]}
+    stub_request(:post, "https://example.prooflink.com/shares/post_share_transaction").
+      with{|request| expected_parameters == CGI.parse(request.body)}.
+      to_return(:status => 200, :body => "", :headers => {})
+    ProoflinkConnect::Share.post("pl2", "This is pretty awesome")
+  end
+
+  it "passes position parameters" do
+    expected_parameters = {"format"=>["json"], "api_key"=>["1234"], "message"=>["This is pretty awesome"], "transaction"=>["pl2"], "position" => ["frontpage"]}
     stub_request(:post, "https://example.prooflink.com/shares/post_share_transaction").
-      with(:body => "format=json&api_key=1234&message=This%20is%20pretty%20awesome&transaction=pl1").
+      with{|request| expected_parameters == CGI.parse(request.body)}.
       to_return(:status => 200, :body => "", :headers => {})
-    ProoflinkConnect::Share.post("pl1", "This is pretty awesome")
+    ProoflinkConnect::Share.post("pl2", "This is pretty awesome", "frontpage")
+  end
+
+  context "sharing iframe" do
+    it "generates necessary html" do
+      result = "<iframe src='https://example.prooflink.com/en/shares/embedded/new?message=placeholder' style='width: 400px; height: 355px; border: 0; display: block;' frameborder='0' allowTransparency='true'></iframe>"
+      ProoflinkConnect::Share.embedded(:message => "placeholder").should == result
+    end
+
+    it "allows setting width and height" do
+      result = "<iframe src='https://example.prooflink.com/en/shares/embedded/new?message=placeholder' style='width: 100%; height: 200px; border: 0; display: block;' frameborder='0' allowTransparency='true'></iframe>"
+      ProoflinkConnect::Share.embedded(:message => "placeholder", :width => "100%", :height => "200px").should == result
+    end
+
+    it "adds the position query param" do
+      result = "<iframe src='https://example.prooflink.com/en/shares/embedded/new?message=placeholder&position=spec' style='width: 400px; height: 355px; border: 0; display: block;' frameborder='0' allowTransparency='true'></iframe>"
+      ProoflinkConnect::Share.embedded(:message => "placeholder", :position => "spec").should == result
+    end
+
+    it "url encodes position" do
+      result = "<iframe src='https://example.prooflink.com/en/shares/embedded/new?message=placeholder&position=spec+with+spaces' style='width: 400px; height: 355px; border: 0; display: block;' frameborder='0' allowTransparency='true'></iframe>"
+      ProoflinkConnect::Share.embedded(:message => "placeholder", :position => "spec with spaces").should == result
+    end
+
+    it "uses correct locale" do
+      ProoflinkConnect.configure do |config|
+        config.locale = "nl"
+      end
+      result = "<iframe src='https://example.prooflink.com/nl/shares/embedded/new?message=placeholder' style='width: 400px; height: 355px; border: 0; display: block;' frameborder='0' allowTransparency='true'></iframe>"
+      ProoflinkConnect::Share.embedded(:message => "placeholder").should == result
+    end
+
+    it "allows passing in locale" do
+      result = "<iframe src='https://example.prooflink.com/nl/shares/embedded/new?message=placeholder' style='width: 400px; height: 355px; border: 0; display: block;' frameborder='0' allowTransparency='true'></iframe>"
+      ProoflinkConnect::Share.embedded(:message => "placeholder", :locale => "nl").should == result
+    end
   end
 end

data/spec/prooflink_connect_spec.rb

@@ -1,7 +1,28 @@
 require 'spec_helper'
 
 describe ProoflinkConnect do
-  it "should work" do
-    pending "tests are to come"
+  it "returns iframe html with defaults" do
+    result = "<iframe src='https://example.prooflink.com/authentications/embedded?token_url=https://example.com/auth/callbacks&forced_connect=0&embed_forms=0' style='width: 520px; height: 250px; border: 0; display: block;' frameborder='0' allowTransparency='true'></iframe>"
+    ProoflinkConnect.embedded.should == result
   end
-end
+
+  it "allows pixels or percentage for width" do
+    result = "<iframe src='https://example.prooflink.com/authentications/embedded?token_url=https://example.com/auth/callbacks&forced_connect=0&embed_forms=0' style='width: 100%; height: 250px; border: 0; display: block;' frameborder='0' allowTransparency='true'></iframe>"
+    ProoflinkConnect.embedded({:width => "100%"}).should == result
+  end
+
+  it "adds px to width if not given" do
+    result = "<iframe src='https://example.prooflink.com/authentications/embedded?token_url=https://example.com/auth/callbacks&forced_connect=0&embed_forms=0' style='width: 100px; height: 250px; border: 0; display: block;' frameborder='0' allowTransparency='true'></iframe>"
+    ProoflinkConnect.embedded({:width => "100"}).should == result
+  end
+
+  it "allows pixels or percentage for height" do
+    result = "<iframe src='https://example.prooflink.com/authentications/embedded?token_url=https://example.com/auth/callbacks&forced_connect=0&embed_forms=0' style='width: 520px; height: 100%; border: 0; display: block;' frameborder='0' allowTransparency='true'></iframe>"
+    ProoflinkConnect.embedded({:height => "100%"}).should == result
+  end
+
+  it "adds px to height if not given" do
+    result = "<iframe src='https://example.prooflink.com/authentications/embedded?token_url=https://example.com/auth/callbacks&forced_connect=0&embed_forms=0' style='width: 520px; height: 100px; border: 0; display: block;' frameborder='0' allowTransparency='true'></iframe>"
+    ProoflinkConnect.embedded({:height => "100"}).should == result
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,13 @@
 require File.expand_path('../../lib/prooflink_connect', __FILE__)
 require 'rspec'
 require 'webmock/rspec'
+
+def reset_configuration
+  ProoflinkConnect.configure do |config|
+    config.provider_endpoint = "prooflink.com"
+    config.subdomain = "example"
+    config.protocol = "https"
+    config.api_key = "1234"
+    config.locale = "en"
+  end
+end

metadata

@@ -1,122 +1,94 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: prooflink_connect
-version: !ruby/object:Gem::Version 
-  hash: 1
+version: !ruby/object:Gem::Version
+  version: 0.0.16
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 15
-  version: 0.0.15
 platform: ruby
-authors: 
+authors:
 - Chiel Wester
 - Jeroen Bulters
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-08 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-08-30 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2153535480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: httparty
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2153535480
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &2153534980 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2153534980
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2153534380 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2153534380
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2153533560 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *2153533560
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2153532900 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: webmock
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *2153532900
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &2153532120 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
+  prerelease: false
+  version_requirements: *2153532120
 description: Make a connection to the prooflink connect api for single sign on authentication
-email: 
+email:
 - chiel.wester@holder.nl
 - jeroen@bulte.rs
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -132,44 +104,33 @@ files:
 - lib/prooflink_connect/share_button.rb
 - lib/prooflink_connect/version.rb
 - prooflink_connect.gemspec
+- spec/prooflink_connect/configuration_spec.rb
+- spec/prooflink_connect/invite_spec.rb
 - spec/prooflink_connect/share_spec.rb
 - spec/prooflink_connect_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: https://github.com/prooflink/prooflink_connect
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: prooflink_connect
-rubygems_version: 1.6.2
+rubygems_version: 1.8.8
 signing_key: 
 specification_version: 3
 summary: Make a connection to the prooflink connect api
 test_files: []
-